Smile - Enroll 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/enroll
API Description: Used to enroll pre-captured user face images to the ZOLOZ system. After successful enrollment, users can use the enrolled face for identity verification.

Request Parameters

Field Name	Data Type	Max Length	Required	Default Value	Description	Example
bizId	String	32	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"
twoFaInfo	String	32	Yes	-	Two-factor authentication information. Phone number: Must comply with the length specified by the policy and contain only digits. General information: Can be customized by the merchant and cannot be changed after configuration.	"11111111"
userId	String	64	Yes	-	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"
imageContent	String	5MB	Yes	-	The face image to be enrolled, encoded in Base64 format.	"/9j/4AAQSkZJRgABAQAAlgCWAAD/4QCARXhpZgA"

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" }
enrollResult	String	Yes	Enrollment result. `Success`: Enrollment successful. `Failure`: Enrollment failed.	"Success"
transactionId	String	No	The unique transaction ID generated for this enrollment. 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.	"G000000001FSE2025070100000001308203****"

Sample

Request Sample

copy
{
    "bizId": "2017839040588699", 
    "twoFaInfo": "11111111", 
    "userId": "123456abcd", 
    "imageContent": "/9j/4AAQSkZJRgABAQAAlgCWAAD/4QCARXhpZgA"
}

Response Sample

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "enrollResult": "Success", 
    "transactionId": "G000000001FSE2025070100000001308203****"
}