Smile - Verify 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/verify/checkResult
  • API Description: Used to retrieve the result of the biometric verification process.

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 Verify Initialize API.

"G000000001FSE2025052300000001218988****"

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"

}

verifyResult

String

Yes

Verification result.

  • Success: Verification successful.
  • Failure: Verification failed.

"Success"

extFaceInfo

ExtFaceInfo

No

Liveness detection and face compare information. This field is returned only when verificationType is face.

{

"faceAttack": false,

"score": 90.1

}

verificationType

String

Yes

Biometric verification type.

  • palm: Palm recognition
  • face: Face recognition

"palm"

userId

String

Yes

User ID.

"test_yyt_1"

twoFaInfo

String

No

Secondary authentication information input during enrollment.

"11111111111"

verifyTwoFaInfo

String

No

Input for secondary verification.

"11111111111"

ExtFaceInfo

Field Name

Data Type

Always Returned

Description

Example

score

double

No

Face compare score. A higher score indicates a higher similarity.

90.1

faceAttack

Boolean

No

Whether a face attack (such as photo or video forgery) is detected.

  • true: Face attack detected.
  • false: No face attack detected.

false

similarUserList

List<SimilarUserInfo>

No

List of similar user information. This field is returned only when multiMatchControl is set to AUTO_FAIL or AUTO_PASS.

  • AUTO_PASS: The list contains a single element for the user with the highest matching score. The twoFaInfo and verifyTwoFaInfo fields contain that user's 2FA data.
  • AUTO_FAIL: The list contains N elements (N ≥ 1), sorted by matching score in descending order. The twoFaInfo and verifyTwoFaInfo fields are returned as empty strings.

See the response sample below.

SimilarUserInfo

Field Name

Data Type

Always Returned

Description

Example

userId

String

Yes

The User ID of the similar user.

"1008612"

score

double

Yes

Face match score.

0.9210667412936551

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 Verify CheckResult API.

resultCode

resultStatus

Description

SUCCESS

S

The API call is successful.

INVALID_ARGUMENT

F

Input parameters are invalid. For more information about which parameter is invalid, check the returned resultMessage.

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 resultMessage.

Sample

Request Sample

copy
{
    "bizId": "2017839040588699",
    "transactionId": "G000000001FSE2025052300000001218988****"
}

Response Sample

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "extFaceInfo": {
        "faceAttack": false, 
        "score": 90.1, 
        "similarUserList": [
            {
                "score": 0.9210667412936551, 
                "userId": "1008612"
            }, 
            {
                "score": 0.8980509100376135, 
                "userId": "1008673"
            }
        ]
    }, 
    "verificationType": "palm", 
    "verifyTwoFaInfo": "11111111111", 
    "twoFaInfo": "11111111111", 
    "userId": "test_yyt_1", 
    "verifyResult": "Success"
}