Smile - Enroll CheckResult API
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/v1a/zoloz/smile/enroll/checkResult
- API Description: Used to request a result about the SDK-based face or palm capture process running status and other corresponding results.
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" |
transactionId | String | 64 | Yes | - | The transaction ID returned by the Enroll Initialize API. | "G000000001FSE2025052300000001218988****" |
Response Parameters
Field Name | Data Type | Always Returned | Description | Example |
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" |
extFaceInfo | No | enrolled facial information. This field is returned only when | { "faceAttack": false } | |
verificationType | String | Yes | Biometric verification type.
| "palm" |
userId | String | Yes | User ID. | "test_yyt_1" |
twoFaInfo | String | No | Secondary verification information. | "11111111111" |
ExtEnrollFaceInfo
Field Name | Data Type | Always Returned | Description | Example |
faceAttack | Boolean | No | Whether a face attack is detected.
| false |
Result
Common error codes
For the full list of common error codes, see the Common error codes section in the Error handling topic.
API-specific error codes
The following table shows the possible error codes that are specific for the Smile Enroll CheckResult API.
resultCode | resultStatus | Description |
SUCCESS | S | The API call is successful. |
PROCESSING | F | Still processing. |
VERIFY_FAIL | F | Biometric verification info validation failed. |
NO_ACCOUNT_FOUND | F | No enrolled user information is found. |
MULTIPLE_ACCOUNT_FOUND | F | Multiple biometric records are detected. |
LIMIT_EXCEEDED | F | The maximum number of attempts has been exceeded. |
SYSTEM_ERROR | F | Internal system error. For error details, check the returned |
Sample
Request Sample
{
"bizId": "2017839040588699",
"transactionId": "G000000001FSE2025052300000001218988****"
}Response Sample
{
"result": {
"resultStatus": "S",
"resultCode": "SUCCESS",
"resultMessage": "Success"
},
"extFaceInfo": {
"faceAttack": false
},
"verificationType": "palm",
"twoFaInfo": "11111111111",
"userId": "test_yyt_1",
"enrollResult": "Success"
}