This topic describes how to use CheckResult API to request a result about the identity proofing process running status and other corresponding results.
Interface description
Interface name: CheckResult.
Service address: cloudauth-intl.cn-hongkong.aliyuncs.com.
Request method: HTTPS POST.
Interface description: When your client receives the SDK callback notification, you can obtain the result of the identity proofing process through this interface on the server.
Request parameters
Parameter | Type | Required | Description | Example |
MerchantBizId | String | Yes | A unique business ID for tracing purpose. For example, the sequence ID from the merchant's business-related database. Note The Alibaba Cloud server does not perform uniqueness check on the value of this field. For better tracking, it is strongly recommended to enable the merchant server to guarantee the uniqueness of the business ID. | e0c34a77f5ac40a5aa5e6ed20c35 |
TransactionId | String | Yes | Required. The unique transaction ID that is returned in the response of Initialize API. | hksb7ba1b28130d24e015d694361bee4 |
IsReturnImage | String | No | A flag that specifies whether the image data needs to be returned in the response. The following values are supported:
By default, the value of N is used. | Y |
Response parameters
Field name | Data type | Description | Example | |
HTTP Status Code | Integer | The HTTP status code. | 200 | |
HTTP Body | RequestId | String | The unique ID of the request, which can be used to locate issues. | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
Code | String | Return code. For the full list of codes, see Codes and Messages. | Success | |
Message | String | Response detailed message. | Success | |
Result.Passed | String | Certification result. Possible values and their meanings are as below:
| Y | |
Result.SubCode | String | Authentication result sub code | 200 | |
Result.ExtFaceInfo | String | Detailed application face information. Only available when result.resultStatus is S. Refer to the table below for details. Optional. JSON string of ExtFaceInfo. Detailed information about face verification. This field is only available when the value of the result.resultStatus field is set S. For more information, see ExtFaceInfo. |
| |
Codes and Messages
HTTP Status Code | Code | Message |
200 | Success | The request has succeeded. |
400 | MissingParameter | Bad request. The parameter is missing. |
400 | InvalidParameter | Bad request. The parameter is invalid. |
400 | TransactionIdInvalid | Transaction id is invalid. |
403 | Forbidden.RAMUserAccessDenied | Grant AliyunAntCloudAuthFullAccess permission to the RAM user. For more information, see Authorize a RAM user to access ID Verification. |
403 | Forbidden.AccountAccessDenied | The account is unauthorized, overdue, deactivated, or disabled. |
403 | Throttling.Api | Request was denied due to api flow control. |
404 | ProcessNotCompleted | The identity proofing process is not completed. |
500 | InternalError | The error message returned because a temporary server error occurs. We recommend that you try again. If the error code persists, submit a ticket. |
SubCode
SubCode | Whether billing | Message |
200 | Yes | pass. |
204 | Yes | The authentication failed. Similarity score is lower than threshold. Possible reasons: not the same person or the quality of the face selfie image is too low. |
205 | Yes | The authentication failed. Spoofing behavior is detected. |
ExtFaceInfo
The following table shows the fields that can be specified in the ExtFaceInfo data model.
Field name | Data type | Description | Example |
facePassed | String | The face result of the identity verification. Possible values and their meanings are as below:
| Y |
faceComparisonScore | Double | Specifies the score that indicates a result of comparing the live face (selfie) against the face recognized from the identity document. Required if the face verification process runs successfully. The value of this field is in the range of 0~100. | 99.99 |
faceImg | String | The face selfie image, which is encoded in base64. This field is specified only when the value of the isReturnImage field in the request is set to Y and the whole eKYC process runs successfully. | /9j/4AAQSkZJRgABAQAAAQqviV6oakp8Kp04EARv7024vNJU21CiDMnl7VUvanCVLkhRkRv0qEUQHcI1JVjaord3SdKpEUY8kagoDFA3CdKgsTRYMdQm4bCT7HpVUQppyCMij7d2U5HlTrxnvkEgDWBg/tQQsPY8+lGIcChn3qnSVIXB9KMYeCkg5+dCrVl4pONunI0a4BdWpSiNaMo/iqlK8CTRds+UOA8udB…… |
backupFaceImg | String | Back up facial selfie images with base64 encoding. This field will only be specified when the isReturnImage field in the request is set to Y, configured to upload 2 photos, and the entire eKYC process runs successfully. | /9j/4DYHFKRgABAQAAAQqviV6oakp8Kp04EARv7024vNJU21CiDMnl7VUvanCVLkhRkRv0qEUQHcI1JVjaord3SdKpEUY8kagoDFA3CdKgsTRYMdQm4bCT7HpVUQppyCMij7d2U5HlTrxnvkEgDWBg/tQQsPY8+lGIcChn3qnSVIXB9KMYeCkg5+dCrVl4pONunI0a4BdWpSiNaMo/iqlK8CTRds+UOA7odG…… |
faceAttack | String | Specifies whether the face selfie image is detected as a fake face attack by using the face liveness check algorithm. If the image is a fake face attack, the value of Y is returned; otherwise, the value of N is returned. | N |
faceQuality | Double | Specify a score that represents the result of the real face quality score. If the facial verification process runs successfully, it is mandatory. The value of this field is between 0 and 100. | 99.99 |
faceOcclusion | String | The results of occlusion detection. If the facial verification process runs successfully, it is mandatory. The value of this field is Y (occluded)/N (unobstructed). | N |