All Products
Search
Document Center

ID Verification:CheckResult

Last Updated:Nov 26, 2024

This topic describes how to call the CheckResult operation to query the result of a verification request based on electronic Know Your Customer (eKYC).

Usage notes

Operation name: CheckResult.

Endpoint: cloudauth-intl.cn-hongkong.aliyuncs.com.

Request method: HTTPS POST.

Operation description: After you receive a callback notification, you can call this operation to obtain the status and result of your verification request from ID Verification.

Request parameters

Parameter

Type

Required

Description

Example

MerchantBizId

String

Yes

The custom unique identifier of your business, which is used for troubleshooting. You can specify a custom value that is 32 characters in length and contains letters and digits. Make sure that the value is unique.

Note

ID Verification does not check the uniqueness of the value. For tracing purposes, we recommend that you specify a unique value.

e0c34a77f5ac40a5aa5e6ed20c35****

TransactionId

String

Yes

The unique identifier of the verification process. You can call the Initialize operation to obtain the value.

hksb7ba1b28130d24e015d694361bee4

IsReturnImage

String

No

Specifies whether to return the images that are used for verification. Valid values:

  • Y

  • N (default)

Y

Response parameters

Parameter

Type

Description

Example

HTTP Status Code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

130A2C10-B9EE-4D84-88E3-5384FF039795

Code

String

The code that is returned for the request. For more information, see the Codes and message descriptions section in this topic.

Success

Message

String

The message that is returned for the request.

success

Result.Passed

String

Indicates whether your customer passed the verification. Valid values:

  • Y

  • N

Y

Result.SubCode

String

The code that corresponds to the verification result. For more information, see Codes of ResultObject.SubCode.

200

Result.ExtFaceInfo

String

The result of face liveness verification. The value is in the JSON format. For more information, see ExtFaceInfo.

{

"faceAttack": "N",

"faceComparisonScore": 99.99,

"faceImg": Base64 format,

"facePassed": "Y",

"faceQuality": 95.45,

"faceOcclusion": "N"

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

}

Result.ExtIdInfo

String

The result of document recognition.

The value is in the JSON format. For more information, see ExtIdInfo.

{

"ocrIdInfo": {

"expiryDate": "",

"originOfIssue": "National Immigration Administration",

"englishName": "LI SI",

"sex": "Male",

"name": "Bob",

"idNumber": "H11111112",

"issueDate": "2013-01-02",

"birthDate": "1990-02-21"

},

"ocrIdPassed": "N",

"spoofInfo": {

"spoofResult": "Y",

"spoofType": [

"SCREEN_REMARK"

]

}

}

ExtFaceInfo

Parameter

Type

Description

Example

facePassed

String

Indicates whether the customer passed the face liveness verification. Valid values:

  • Y

  • N

Y

faceComparisonScore

Double

The score of comparison between the collected face and document face. Valid values: 0 to 100.

99.99

faceImg

String

The Base64-encoded image of the collected face. If you set the isReturnImage parameter to Y in your request and the face scan is complete, this parameter is returned.

Base64-encoded image

faceAttack

String

Indicates whether the collected face is used to launch a liveness attack. Valid values: Y and N.

N

faceQuality

Double

The quality score of the collected face. Valid values: 0 to 100.

99.99

faceOcclusion

String

Indicates whether the face is blocked during collection. Valid values: Y and N.

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 and the video 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 in the face image. This parameter is not returned if the prediction fails.

30

faceGender

String

The predicted gender of the individual in the face image. This parameter is not returned if the prediction fails. Valid values:

  • M

  • F

M

ExtIdInfo

Parameter

Type

Description

Example

ocrIdPassed

String

Indicates whether the customer passed the document recognition. Document recognition also refers to document optical character recognition (OCR). Valid values:

  • Y

  • N

N

idImage

String

The Base64-encoded image of the document. If you set the isReturnImage parameter to Y in your request and the document recognition is complete, this parameter is returned.

Base64-encoded image

ocrIdInfo

String

The fields that are returned by document verification.

Note

If the document recognition failed, this parameter is empty.

{

"expiryDate": "",

"originOfIssue": "National Immigration Administration",

"englishName": "LI SI",

"sex": "Male",

"name": "Bob",

"idNumber": "H11111112",

"issueDate": "2013-01-02",

"birthDate": "1990-02-21"

}

spoofInfo

String

The result of anti-counterfeiting detection, including the risk identification result and risk type.

  • Valid values of spoofResult:

    • Y: risky

    • N: risk-free

  • Valid values of spoofType:

    • SCREEN_REMARK: photos

    • PHOTO_COPY: copies

    • TAMPER: documents that are tampered with

{

"spoofResult": "Y",

"spoofType": [

"SCREEN_REMARK"

]

}

ocrIdEditInfo

String

The information about the OCR field of the certificate that your customer submits after the customer re-edits the OCR result. You can contact your account manager to disable this feature.

{

"expiryDate": "2026-01-02",

"originOfIssue": "National Immigration Administration",

"englishName": "ZHANG SAN",

"sex": "Male",

"name": "Tom",

"idNumber": "H11111115",

"issueDate": "2013-01-02",

"birthDate": "1990-02-21"

}

Codes and message descriptions

HTTP status code

Code

Message description

200

Success

The request is successful.

400

MissingParameter

A required parameter is empty.

400

InvalidParameter

A parameter is set to an invalid value.

400

TransactionIdInvalid

The transaction ID is invalid.

403

Forbidden.RAMUserAccessDenied

The required policy AliyunAntCloudAuthFullAccess is not attached to the Resource Access Management (RAM) user. For more information, see Authorize a RAM user to access ID Verification - KYC (Global).

403

Forbidden.AccountAccessDenied

The account has overdue payments. We recommend that you top up your account and try again.

403

Throttling.Api

API throttling is triggered.

404

ProcessNotCompleted

The verification process is not complete.

500

InternalError

An internal error occurred. To troubleshoot the error, we recommend that you submit your feedback to engineers.

Codes of ResultObject.SubCode

Code

Billing required

Description and cause

200

Yes

The customer passed the verification.

201

Yes

The name does not match the ID card in the official database. The information about the customer is incorrect or fake. The customer can check the information and perform the verification again.

202

Yes

The information about the customer cannot be queried in the official database. We recommend that you reserve a manual review entry for manual review.

204

Yes

The live face does not match the document face. A possible reason is that the live person does not match the document or the quality of the live face is poor.

205

Yes

The results of liveness detection show risks.

206

Yes

The error occurs due to policy limits. If the security mode is enabled, security checks are performed on the environment information such as the verification device. If a possible risk is detected, the verification fails. You can perform the following steps to troubleshoot the issue:

  • Notify customers to uninstall the software or a plug-in from the device, such as software or a plug-in for multi-boxing, multi-user, and virtual environment, restore the security environment of the device system to the initial state, and try again.

207

Yes

The face does not match the face in the official database. A possible reason is that the faces belong to different persons or the quality of the face is poor.

209

Yes

An exception occurs in the authoritative comparison source.

212

Yes

The results of anti-counterfeiting detection on documents show risks, such as photos and copies of documents and documents that are tampered with.

Field returned by document recognition

ID cards (Hong Kong (China))

Note

2003 and 2018 versions of ID cards are supported.

Field

Type

Description

name

String

The name.

englishName

String

The name in English.

nameCode

String

The Chinese name code.

sex

String

The gender. Valid values:

  • M

  • F

birthDate

String

The date of birth.

idNumber

String

The ID card number.

currentIssueDate

String

The date of registration.

firstIssueDate

String

The month and year of first registration.

isPermanent

String

Indicates whether the ID card is a permanent ID card. Valid values:

  • Y

  • N

symbols

String

The remarks. Example: "***AZ".

Exit-entry Permit for Travelling to and from Hong Kong and Macao

Field

Type

Description

name

String

The name.

englishName

String

The name in pinyin.

sex

String

The gender.

birthDate

String

The date of birth.

idNumber

String

The ID card number.

issueDate

String

The issuance date.

expiryDate

String

The expiration date.

placeOfIssue

String

The issuance place.

originOfIssue

String

The issuance authority.

Mainland Travel Permit for Hong Kong and Macao Residents

Field

Type

Description

name

String

The name.

englishName

String

The name in English.

sex

String

The gender.

birthDate

String

The date of birth.

idNumber

String

The ID card number.

issueDate

String

The issuance date.

expiryDate

String

The expiration date.

originOfIssue

String

The issuance authority.

Passports (Global)

Field

Type

Description

surname

String

The last name.

givenname

String

The first name.

sex

String

The gender.

birthDate

String

The date of birth.

passportNo

String

The passport number.

nationality

String

The nationality.

expiryDate

String

The expiration date.

countryCode

String

The country code.

ID cards (Macao (China))

Field

Type

Description

surnameCN

String

The last name in Chinese.

givennameCN

String

The first name in Chinese.

surname

String

The last name in English.

givenname

String

The first name in English.

sex

String

The gender.

birthDate

String

The date of birth.

idNumber

String

The ID card number.

expiryDate

String

The expiration date.

placeOfBirth

String

The code of the birthplace. Example: "AS".

Mainland Travel Permit for Taiwan Residents

Field

Type

Description

name

String

The name.

englishName

String

The name in pinyin.

sex

String

The gender.

birthDate

String

The date of birth.

idNumber

String

The ID card number.

issueDate

String

The issuance date.

expiryDate

String

The expiration date.

originOfIssue

String

The issuance authority.

placeOfIssue

String

The issuance place.

ID cards for residents in the Chinese mainland

Field

Type

Description

name

String

The name.

sex

String

The gender.

ethnicity

String

The nationality.

birthDate

String

The birth date.

idNumber

String

The ID card number.

address

String

The address.

province

String

The province.

city

String

The city.