Smile - Unenroll API

2026-08-11 08:14

Important Notice:

All request and response parameters are strictly subject to the official API documentation.
The API response may contain fields not defined in the documentation. These fields are for internal debugging purposes only and are not guaranteed to be stable or compatible. Do not rely on these fields in production environments. ZOLOZ reserves the right to modify or remove these fields at any time without prior notice.

Overview

API URL: /api/v1/zoloz/smile/unenroll
API Description: Used to delete a user's enrolled biometric information. After successful deletion, the user will not be able to use the deleted biometric feature for identity verification.

Request Parameters

Field Name

Data Type

Max Length

Required

Default Value

Description

Example

bizId

String

Yes

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

Note: ZOLOZ does not validate the uniqueness of this value; the merchant side must ensure the uniqueness of the business ID.

"2017839040588699"

userId

String

Yes

The user ID to be deleted. Used to specify the user whose enrollment information needs to be removed. This value must match the userId used during enrollment.

"123456abcd"

Response Parameters

Field Name	Data Type	Always Returned	Description	Example
result	Result	Yes	The API request result, which contains the result status, result code, and result message.	{ "resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success" }
transactionId	String	No	The transaction ID returned for this deletion. Note: The system will only return the `transactionId` after the transaction enters the processing stage. If an error occurs before the transaction begins processing, the system will not return a `transactionId`. This includes, but is not limited to, the following situations: Invalid request parameters, such as incorrect input format or missing required parameters. The request fails to reach the server successfully, such as due to network issues or gateway failures. The request is denied due to system rate limiting.	"G000000001FSE2025052300000001218988****"
unEnrollResult	String	No	Unenrollment result. `Success`: Unenrollment successful. `Failure`: Unenrollment failed.	"Success"

Sample

Request Sample

copy
{
    "bizId": "2017839040588699", 
    "userId": "123456abcd"
}

Response Sample

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "transactionId": "G000000001FSE2025052300000001218988****", 
    "unEnrollResult": "Success"
}