Retrieves an NFC identity verification result. Call this operation from your server after receiving a callback notification
API reference
Operation name: CheckResult
Request method: HTTPS POST
Description: When the server-side receives a callback indicating that authentication is complete, call this API to retrieve the corresponding authentication status and information. This callback is sent when the client result code is 1001 or 1002. For more information, see Native SDK client result codes and sub-codes.
ImportantThe ID Verification service stores verification results for 30 days by default. Please retrieve them within this period, as they are automatically deleted afterward.
QPS limit: Each API has its own QPS limit. For more information, see QPS limits of ID Verification server-side APIs.
Service endpoints:
NoteBenefits of internal network access: An internal network is a private communication network connecting Alibaba Cloud products within the same region. If your application server is deployed in the same region, use the internal endpoint to access the ID Verification service for enhanced security and stability.
Optimizing overseas access: Overseas network environments can be complex. Refer to Optimize server network latency to tune your integration and reduce network latency and request failures.
Asia Pacific SE 1 (Singapore)
Public endpoint:
cloudauth-intl.ap-southeast-1.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
Asia Pacific SE 5 (Jakarta)
Public endpoint:
cloudauth-intl.ap-southeast-5.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
China (Hong Kong)
Public endpoint:
cloudauth-intl.cn-hongkong.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
Asia Pacific SE 3 (Kuala Lumpur)
Public endpoint:
cloudauth-intl.ap-southeast-3.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com
Online Debugging and Integration
Before debugging and integration, read the Use OpenAPI document to learn how to call APIs on the OpenAPI platform and obtain the SDK.
You can directly run this operation in OpenAPI Explorer to test it and generate SDK code examples for this operation.SDK code examples.
Request parameters
Name | Type | Required | Description | Example Value |
MerchantBizId | String | Yes | A unique business identifier for troubleshooting. Up to 32 alphanumeric characters. Ensure uniqueness across your business. Note Alibaba Cloud does not validate uniqueness. Ensure uniqueness for traceability. | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | Yes | The unique authentication identifier returned by a successful init API call. To prevent tampering, always retrieve this value from your server-side storage and do not trust the value sent from the client-side. | hksb7ba1b28130d24e015d6******** |
IsReturnImage | String | No | Whether to return the verification image:
| Y |
Response parameters
Name | Type | Description | Example | |
HTTP Status Code | Integer | HTTP status code | 200 | |
HTTP Body | RequestId | String | Request ID | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | Return code: For more information, see Server-side HTTP status codes. | Success | |
Message | String | Detailed description of the return code. | success | |
Result.Passed | String | Final verification result:
| Y | |
Result.SubCode | String | Verification result description. SubCode error codes for ResultObject. | 200 | |
Result.ExtIdInfo | String | NFC-read document information. | | |
SubCode error codes for ResultObject
Subcode is returned based on different product solutions or integration methods. For details, refer to the following table.
Applicable solution | Error code | Is authentication record billed | Description and suggested reasons |
General | 200 | Yes | Authentication passed. |
| 211 | Yes | The quality or resolution of the certificate image does not meet requirements, or the image itself is incomplete. Ensure the photo of the certificate's portrait side is clear, has normal exposure, is complete without occlusion, and has no significant angle deviation. |
| 212 | Yes | Certificate anti-counterfeiting detection indicates risk. There may be high-risk operations such as rephotographing, tampering, or photocopying. |
| 213 | Yes | The specified certificate type was not detected (recognition mode) or the certificate type could not be identified (classification mode). We recommend uploading a clear, complete certificate image with normal angle. |
ExtIdInfo
Name | Type | Description | Example |
nfcIdImage | String | Base64-encoded face photo read from the document via NFC. Returned only when isReturnImage is Y and verification succeeds. | base64 |
nfcIdInfo | String | Document fields read via NFC. Supports global passports only. Field details are in the following table. |
e-passport
This document type reads the Machine-Readable Zone (MRZ) of ICAO-compliant e-Passports. Extracting a standard set of fields ensures compatibility across passports from different countries, which often have varying formats.
Parameter | Type | Description |
surname | String | Surname in Latin script from the MRZ. |
givenname | String | Given name in Latin script from the MRZ. |
sex | String | Sex, returned as |
birthDate | String | Date of birth, in |
passportNo | String | Passport number |
nationality | String | Nationality, represented by a 3-letter country code. |
expiryDate | String | Expiry date, in |
countryCode | String | Country code of the issuing authority. (3-letter country code) |