Lấy thông tin Face Authen

Đọc trạng thái hồ sơ (profile) khuôn mặt của một người dùng. Dùng nó để kiểm tra xem người dùng đã đăng ký hay chưa trước khi bắt đầu một lần xác thực.

Endpoint

POST /v1/get_face_auth
Content-Type: application/json

{
  "user_id": "user_00000001"
}

Tham số:

Tham số	Kiểu	Bắt buộc	Mặc định	Mô tả
user_id	string	Có	—	User ID của khách hàng.

Trả về: GetFaceAuthResponse

Ví dụ request

curl -X POST \
  '<BASE_URL>/v1/get_face_auth' \
  -H 'Authorization: ATV <ACCESS_ID>:<SIGNATURE>' \
  -H 'X-TV-Timestamp: <TIMESTAMP>' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "user_00000001"
  }'

Response

{
  "data": {
    "status": "success",
    "request_id": "cfc7b8d5-f2e2-437b-80e5-d600dfad26e2",
    "face_auth": {
      "user_id": "user_00000001",
      "status": "VERIFIED"
    }
  },
  "errors": [],
  "success": true,
  "code": 0,
  "message": "Success"
}

Trường	Kiểu	Mô tả
data.status	string	success hoặc failure — liệu bản thân việc tra cứu có thành công hay không.
data.request_id	string	Request ID; cung cấp cho CAKE Support khi cần kiểm tra log.
data.face_auth.user_id	string	User ID mà hồ sơ thuộc về.
data.face_auth.status	string	Trạng thái hồ sơ, ví dụ VERIFIED.

data.status báo cáo về việc tra cứu; data.face_auth.status báo cáo về hồ sơ. Một lần tra cứu thành công trên một hồ sơ không dùng được vẫn trả về data.status: "success".

Lỗi

Mã	Thông báo
2001010	Không tìm thấy Access ID.
401100	Bạn không được phép thực hiện hành động này.
4001000	Tham số đầu vào vi phạm một ràng buộc.
4001001	Header X-TV-Timestamp đã hết hạn, cần một cái mới hơn.
4041001	Không tìm thấy người dùng.
5001000	Xảy ra lỗi không mong đợi trong quá trình xử lý request.

Mã	Mô tả
access_id_not_found	Không tìm thấy Access ID.
access_denied_exception	Bạn không được phép thực hiện hành động này.
invalid_parameter_exception	Tham số đầu vào vi phạm một ràng buộc.
request_time_too_skewed	Header X-TV-Timestamp đã hết hạn, cần một cái mới hơn.
user_not_found_exception	Không tìm thấy người dùng.
internal_server_error	Xảy ra lỗi không mong đợi trong quá trình xử lý request.

Bước tiếp theo

• Đăng ký khuôn mặt — đăng ký một người dùng chưa có hồ sơ
• Xác minh Face Authen — xác thực một người dùng đã đăng ký