VideoVerify - Checkresult API

2026-06-25 06:23

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/videoverify/checkresult
API Description: Used to retrieve the final verification result of a VideoVerify process.

Note: This API is idempotent. It can be queried after the SDK callback is completed. If the result is in a processing state, you can poll according to your business strategy.

Request Parameters

Field Name	Data Type	Max Length	Mandatory	Default Value	Description	Example Value
bizId	String	32	true	-	The merchant business ID that was passed when calling the initialize API.	"VV2026060500000001"
transactionId	String	64	true	-	The transaction ID that was returned after calling the initialize API.	"G006600016CN2019011400000000957252****"
isReturnImage	String	1	false	N	Specifies whether to return the face image data. Supported values: `Y`: The face image data needs to be returned in the response. `N`: The face image data does not need to be returned in the response.	"Y"

Response Parameters

Field Name	Data Type	Description	Example Value
result	Result	Required. The result of the API request, including the operation status, result code, and message.	{ "resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success" }
videoVerifyResult	String	Required. The overall result of VideoVerify. `Success`: VideoVerify detection passed. `Failure`: VideoVerify detection failed. It is recommended to reject or perform a manual review. `VoidTimeout`: No VideoVerify result was obtained; the process timed out. `InProcess`: Currently being collected. You can query again later.	"Success"
extInfo	ExtInfo	Detailed information about liveness detection, risk control, and VideoVerify. For more information, see ExtInfo. Note: Returned only when `result.resultCode` is `SUCCESS`.	{ "imageContent": "base64 image", "quality": "99.41563014552693", "qualityPassed": true, "willingRetryRecords": "{\"retryRecords\":[{\"status\":\"WRONG_ANSWER\",\"userInput\":\"test\",\"attemptNumber\":1},{\"status\":\"SUCCESS\",\"userInput\":\"I confirm\",\"attemptNumber\":2}]}", "willingVerifyVideo": "base64 video" }

ExtInfo

Field Name	Data Type	Description	Example Value
imageContent	String	Optional. The captured face image, which is encoded in base64. Returned only when `isReturnImage` is `Y`.	"base64 image"
quality	String	Optional. The quality score of the face image, the value of this field is in the range of 0-100. A higher score indicates better quality.	"99.41563014552693"
qualityPassed	Boolean	Required. Indicates whether the face quality detection passed. `true`: Passed `false`: Failed	true
willingVerifyVideo	String	Optional. The full video of the willing verification process (Base64 encoded), including the user's spoken voice.	"base64 video"
willingRetryRecords	String	Optional. The result of the willing verification in JSON string format, which needs to be parsed on the server side.	Refer to the Response Sample.

willingRetryRecords

Field Name	Data Type	Description
retryRecords	List<retryRecord>	Optional. Records for each attempt.

retryRecord

Field Name	Data Type	Description
status	String	Optional. The status of a single attempt. WRONG_ANSWER NO_RESPONSE SUCCESS FAIL
userInput	String	Optional. The text returned after speech recognition of the user's spoken content.
attemptNumber	int	Optional. The attempt number, starting from 1. The last attempt, whether successful or failed, is recorded.

Result

API-Common Result Codes

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

API-Specific Result Codes

The following table lists result codes specific to the VideoVerify Checkresult API.

resultCode	resultStatus	Description
SUCCESS	S	The API call is successful; collection and verification results are returned.
PROCESSING	S	Still being collected or processed. It is recommended to query again later.
INVALID_ARGUMENT	F	Input parameters are invalid. For more information about which parameter is invalid, check the result message.
UNUSABLE	F	The meta information returned by the SDK failed the usability detection; the user cannot use this function.
SYSTEM_ERROR	F	Internal system error. For details, please check the returned `resultMessage`.
LIMIT_EXCEEDED	F	The maximum number of attempts has been exceeded.

Sample

Request Sample

copy
{
    "bizId": "VV2026060500000001", 
    "transactionId": "G006600016CN2019011400000000957252****", 
    "isReturnImage": "Y"
}

Response Sample

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "videoVerifyResult": "Success", 
    "extInfo": {
        "imageContent": "base64 image", 
        "quality": "99.41563014552693", 
        "qualityPassed": true, 
        "willingRetryRecords": "{\"retryRecords\":[{\"status\":\"WRONG_ANSWER\",\"userInput\":\"test\",\"attemptNumber\":1},{\"status\":\"SUCCESS\",\"userInput\":\"I confirm\",\"attemptNumber\":2}]}", 
        "willingVerifyVideo": "base64 video"
    }
}