ZOLOZZOLOZDOCS

query enroll

Overview

  • API URL: /api/v1/zoloz/connect/queryEnrollStatus
  • API Description: Used to check the face enrollment status for users.

Structure

Request parameters

Field name

Data type

Max length

Default Value

Description

Example value

bizId

String

32

-

Required. A unique business ID for tracing purposes. For example, the sequence ID from the merchant's business-related database.

Note: The ZOLOZ server does not perform uniqueness check on the value of this field. For better tracking, it is strongly recommended to enable the merchant server to guarantee the uniqueness of the business ID. 

"201783904058****"

userId

String

64

-

Required. Merchant user ID, or other identifiers that can be used to identify a specific user. For example, mobile phone number, email address and so on. It is strongly recommended to pre-desensitize the value of the userId field; for example, by hashing the value. 

"123456abcd"

Response parameters

Field name

Data type

Description

Example value

result

Result

Required. The API request result, which contains information about the result of the API request, such as status and error codes. 

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

Result

Field name

Data type

Description

Example value

resultStatus

String

Required. Result status. Possible values and their meanings are as below:

  • S: Success
  • F: Failure

"S"

resultCode

String

Result codes:

  • SUCCESS: The user's face is enrolled.
  • NOT_ENROLLED: The user's face is not enrolled.
  • INVALID_ARGUMENT: The input parameters are invalid.
  • SYSTEM_ERROR: Other internal error.

"SUCCESS"

resultMessage

String

Required. Result message.

"success"

Sample

Request Sample

copy
{
    "bizId": "201783904058****", 
    "userId": "123456abcd"
}

Response Sample

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }
}