ZOLOZZOLOZDOCS

unenroll

POST /api/v1/zoloz/connect/unenroll

The ZOLOZ Connect unenroll API is used to unenroll all face images and facial features obtained during the enrollment process of one user. After unenrollment, the user will not be able to use Connect's initialize API for identity verification, unless re-enrollment is performed.

Structure

Request parameters

Field name

Data type

Max Length

Description

bizId

String

32

Required. A unique business ID for tracing purpose. 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.

userId

String

64

Required. The userId to be deleted, which passed in during the enroll process.

Response parameters

Field name

Data type

Description

result

Result

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

transactionId

String

Optional. A unique transaction ID that is generated by the ZOLOZ server for the liveness check process.

Note: When an error occurs during the process, for example, an invalid argument, no transaction ID will be returned.

Result

Result process logic

For different request results, different actions will be performed. See the following for details:

  • If the value of the result.resultStatus is S, the ZOLOZ Connect unenroll API is invoked successfully and a unique transaction ID is returned.
  • If the value of the result.resultStatus is F, the invocation of the ZOLOZ Connect unenroll API has failed. Check the error code and its message for more information about the possible reasons why.
  • If the value of the result.resultStatus is U, it means that some problems were encountered during the unenrollment process, and face images or facial features were not completely deleted. In this case, please consult ZOLOZ.

Common result codes

For the full list of common result codes, see the Common error codes section in the Error handling topic.

API-specific result codes

The following table shows the possible result codes that are specific for this API.

resultCode

resultStatus

Description

SUCCESS

S

The API call is successful.

DELETE_REFERENCE_SOURCE_FAILED

U

Some problems were encountered. Face images or facial features were not completely deleted. For more information about the error details, check the result message or the related log.

INVALID_ARGUMENT

F

Input parameters are invalid. For more information about which parameter is invalid, check the result message or the related log.

USER_ALREADY_UNENROLLED

F

User already unenrolled and cannot unenroll again.

USER_NOT_EXIST

F

User does not exist, nothing to delete.

SYSTEM_ERROR

F

Other system errors. For more information about the error details, check the result message that is returned and the related log.

Sample

Request sample

copy
{
  "bizId": "test-bizId",
  "userId": "test-userId"
}

Response sample

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