Document Center

All Products

Document Center

:CheckResult

Last Updated:May 22, 2024

This topic describes how to call the CheckResult operation to query the verification result of an eKYC process.

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 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. 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 eKYC 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. 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 HTTP status codes and messages.	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: passed. P: pending. The status is subsequently updated to Y or N. Note We recommend that you call this operation to query the latest verification result after receiving the callback notification. N: failed.	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,` `"extraFaceImg": [Base64 format],` `"faceImg": "Base64 format",` `"facePassed": "Y",` `"faceQuality": 95.45,` `"faceOcclusion": "N"` `}`
	Result.ExtIdInfo	String	The result of document recognition. The value is in the JSON format. For more information, see ExtIdInfo.	`{` `"ocrIdInfo": {` `"firstName": "LONG",` `"lastName": "",` `"countryCode": "CHN",` `"docType": "01560001",` `"dateOfBirth": "2002-08-04",` `"idNumber": "410************19"` `},` `"idImage": "Base64 format",` `"ocrIdPassed": "N",` `"spoofInfo": {` `"spoofResult": "Y"},` `"extLabel":{"OTHERS"}` `}`

HTTP status codes and messages

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.
401	OcrFail	The document is unreadable.
403	Forbidden.RAMUserAccessDenied	The RAM user is not granted the required permission AliyunAntCloudAuthFullAccess. 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.
204	Yes	The customer failed the verification because the similarity of the document face and live face is low.
205	Yes	The customer failed the verification because the customer failed liveness detection. If the operations were performed by the customer, you can notify the customer to retry liveness detection.
212	Yes	The customer failed the verification because the customer failed anti-counterfeiting detection on documents. You can notify the customer to use the original document for anti-counterfeiting detection.

ExtFaceInfo

Parameter	Type	Description	Example
facePassed	String	Indicates whether the customer passes 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 specify isReturnImage=Y in your request and the face scan is complete, this parameter is returned.	Base64-encoded image
extraFaceImg	String	If you want to obtain more face images used in the verification process, contact your account manager. If you specify isReturnImage=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

ExtIdInfo

Parameter	Type	Description	Example
ocrIdPassed	String	Indicates whether the customer passes 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 specify isReturnImage=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 recognition. For more information, see Fields returned by document recognition. Note The OCR result may be returned after a specific latency. If the document recognition failed, this parameter will be empty.	`{` `"firstName": "LONG",` `"lastName": "",` `"countryCode": "CHN",` `"docType": "01560001",` `"dateOfBirth": "2002-08-04",` `"idNumber": "410************19"` `}`
spoofInfo	String	The result of anti-counterfeiting detection. Valid values of spoofResult: Y: risky N: risk-free Note The result of anti-counterfeiting detection may be returned after a specific latency.	`{` `"spoofResult": "Y",` `}`
extLabel	String	Specifies the error details related to the document.	`{` `"UNQUALIFIED_DOC_IMAGE", "OTHERS"` `}`

Fields returned by document recognition

ID cards

Chinese mainland

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The ID card number.
dateOfBirth	String	The date of birth in the yyyy-MM-dd format.
validUntil	String	The expiration date in the yyyy-MM-dd format.

Hong Kong (China)

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The ID card number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Macao (China)

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The ID card number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Taiwan (China)

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The ID card number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Japan

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The ID card number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Republic of Korea

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The ID card number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Russia

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
middleName	String	The middle name.
idNumber	String	The ID card number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Türkiye

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
middleName	String	The middle name.
idNumber	String	The ID card number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String,	The expiration date.

Passports

Chinese mainland

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
middleName	String	The middle name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth in the yyyy-MM-dd format.
validUntil	String	The expiration date in the yyyy-MM-dd format.

Hong Kong (China)

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Macao (China)

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Japan

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Republic of Korea

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Russia

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
middleName	String	The middle name.
idNumber	String	The passport number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Türkiye

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Singapore

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Indonesia

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Malaysia

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Thailand

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Vietnam

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

United States

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
middleName	String	The middle name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

United Kingdom

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

India

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

France

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Germany

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The passport number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Driver licenses

China

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The driver license number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Japan

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The driver license number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Republic of Korea

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
idNumber	String	The driver license number.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Russia

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
middleName	String	The middle name.
idNumber	String	The driver license number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.

Türkiye

Field	Data type	Description
firstName	String	The first name.
lastName	String	The last name.
middleName	String	The middle name.
idNumber	String	The driver license number.
issueDate	String	The issuance date.
dateOfBirth	String	The date of birth.
validUntil	String	The expiration date.