Face Retrieval Result

Cập nhật lần cuối:15/6/2026

API to get the face retrieval result of the uploaded images.

Request

• Endpoint: /v1/api/ekyc-verify/result/face-retrieval

• Method: POST

• Header

  Name	Type	Required	Description
  api_key	string	yes	The API key associated with your account to authenticate requests (for development, check the Credentials section).

• Parameters

  Name	Type	Required	Description
  session_id	string	yes	Current session ID.

Response

• Status: 200 OK

• Body: JSON

  {
    "code": 0,
    "message": "Successful",
    "data": "<ENCRYPTED_DATA_IN_BASE64>",
    "sign": "8f4642cdb4c555f9a6d5926f4df9b73e44da2e675512d65d44c0a212",
    "request_id": "12345678"
  }

  • Field “request_id”: Request's identifier, used for auditing later.

  • Field “data”: Decrypt the “data” field as described in the Decrypt response data section to get the JSON object with following fields.

    Name	Type	Description
    idnum_validation	json	Validation informations against idnumber in idcard. Format: {msg:<string>, status:<number>}
    face_validation	json	Validation informations against selfie face. This field does NOT appear if idnum_validation failed. Format: {msg:<string>, status:<number>}

  • Field “sign”: The “sign” field is created by encrypted data and a secret key, described in the Signature section.