All Products
Search
Document Center

ID Verification:CheckResult

Last Updated:Sep 17, 2025

This topic describes how to call the CheckResult API operation to query authentication results.

Description

  • API operation: CheckResult

  • Request method: POST

  • Description: After you receive a callback notification, you can call this API operation on the server to retrieve the authentication status and data.

    Important

    The ID Verification service stores results for 30 days by default. After this period, the results are automatically deleted. You must query the authentication results within 30 days after the authentication is complete.

  • QPS limit: The API has a dedicated queries per second (QPS) limit. For more information, see QPS limits for ID Verification server-side API operations.

  • Endpoint:

    Note

    The internal network is used for communication between Alibaba Cloud products in the same region. If your server is deployed in an Alibaba Cloud region, you can use the internal endpoint to access the ID Verification service. This provides more secure and stable network communication.

    China (Hong Kong)

    • Internet: cloudauth-intl.cn-hongkong.aliyuncs.com

    • Internal: cloudauth-intl-vpc.cn-hongkong.aliyuncs.com

Debug and integrate online

Note

Before you start debugging and integration, ensure that you read the Use OpenAPI Explorer to debug and integrate server-side APIs document to understand how to call APIs in OpenAPI Explorer and obtain SDKs and their code.

You can run this API operation in OpenAPI Explorer to debug it. You can also generate SDK code examples for this operation.

Request parameters

Name

Type

Required

Description

Example

MerchantBizId

String

Yes

A unique business identifier that you customize. Use it to track and troubleshoot issues later. The identifier can be a combination of letters and digits up to 32 characters long. Make sure the identifier is unique.

Note

Alibaba Cloud servers do not check if this value is unique. For better tracking, we strongly recommend that you make this field unique.

e0c34a77f5ac40a5aa5e6ed20c35****

TransactionId

String

Yes

The unique identifier for the entire authentication flow. You must obtain this value by calling the Initialize API operation.

Important

To avoid tampering threats, you must use the TransactionId stored on your server from the Initialize API operation call. We do not recommend using the TransactionId from the client-side callback.

hksb7ba1b28130d24e015d6********

IsReturnImage

String

No

Specifies whether to return the authentication image data.

  • Y: Required

  • N: No (default)

Y

Response parameters

Name

Type

Description

Example

HTTP status code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

130A2C10-B9EE-4D84-88E3-5384FF03****

Code

String

Back to Code.

Success

Message

String

A detailed description of the response code.

success

Result.Passed

String

The final authentication result. Valid values:

  • Y: Passed

  • N: Failed

Y

Result.SubCode

String

A description of the authentication result. For more information, see ResultObject.SubCode error codes.

200

Result.ExtFaceInfo

String

Information about the face liveness verification result. For the JSON format, see the example on the right. For more information, see ExtFaceInfo.

{
  "faceAttack": "N",
  "faceImg": "/9j/4AAQSkZJRgABAQAAAQqviV6oa...",
  "faceQuality": 95.45,
  "faceOcclusion": "N",
   "docVideoUrl": "https://aliyun-cloudauth.oss-aliyuncs.com/******.webm" 
}

ExtFaceInfo

Name

Type

Description

Example

faceImg

String

The captured face image in the Base64 format. This parameter is returned if you set isReturnImage=Y in the request and the face scanning process is completed.

Base64-encoded image

faceAttack

String

Indicates whether a liveness attack was detected during face capture.

Valid values:

  • Y: An attack was detected.

  • N: No attack was detected.

N

faceQuality

Double

The quality score of the face image. The score ranges from 0 to 100.

99.99

faceOcclusion

String

Indicates whether the face is occluded. Valid values:

  • Y: The face is occluded.

  • N: The face is not occluded.

N

docVideoUrl

String

The download URL of the evidence in Object Storage Service (OSS).

Note
  • The validity period for the URL of the evidence video is 15 minutes.

  • You can repeatedly query and obtain the evidence video within 30 minutes after the verification is complete. After 30 minutes, the system automatically deletes the video file and the video file cannot be restored. Download and save the video within the validity period.

https://aliyun-cloudauth.oss-aliyuncs.com/******.webm

faceAge

String

The predicted age of the individual based on the face image. If the prediction fails, this parameter is not returned.

30

faceGender

String

The predicted gender of the individual based on the face image. If the prediction fails, this parameter is not returned. Valid values:

  • M: Male

  • F: Female

M

faceAttackScore

Double

The probability of a fake face attack predicted by the facial recognition algorithm. A higher score indicates a higher probability of a fake face.

The score ranges from 0 to 100.

80

guardRiskScore

Double

The probability of device risk predicted by the face guard algorithm. A higher score indicates a higher device risk.

The score ranges from 0 to 100.

90

Return code

HTTP status code

Code

Message description

200

Success

Request successful.

400

MissingParameter

Parameter cannot be empty.

InvalidParameter

Invalid parameter.

TransactionIdInvalid

Invalid Transaction ID.

403

Forbidden.RAMUserAccessDenied

You need to grant the RAM user the AliyunAntCloudAuthFullAccess permission. For more information, see Authorize RAM users to access the service.

Forbidden.AccountAccessDenied

Ensure that you have activated ID verification and your account has no overdue payment.

Throttling.Api

API request is blocked due to throttling.

404

ProcessNotCompleted

The entire authentication process is not completed.

500

InternalError

Internal system error. Provide feedback to engineers for troubleshooting.

ResultObject.SubCode error codes

Error code

Is authentication record billed

Description and suggested reasons

200

Yes

Authentication passed.

205

Yes

Liveness detection indicates risk.

206

Yes

Business policy restriction.

Note

When safe mode is enabled, security checks are performed on the authentication device and environment. If risks are detected, the authentication result will fail. You can remind users to uninstall any multiple-instance, clone, virtual environment software or plugins on their device, restore the device to its initial secure state, and try again.