ID Verification:CheckResult

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.

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:

• Y: The image data needs to be returned in the response.

• N: The image data does not need to be returned in the response.

By default, the value of N is used.

Y

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: pass.

• N: fail.

Y

Result.SubCode

String

Authentication result sub code.

200

Result.ExtIdInfo

String

Optional. JSON string of ​ExtIdInfo. Detailed information about identity document recognition. For more information, see ​ExtIdInfo.

{
 "ocrIdInfo": {
 "expiryDate": "",
 "originOfIssue": "公安部出入境管理局",
 "englishName": "LI SI",
 "sex": "男",
 "name": "李四",
 "idNumber": "H11111112",
 "issueDate": "2013-01-02",
 "birthDate": "1990-02-21"
 },
 "ocrIdPassed": "N",
 "spoofInfo": {
 "spoofResult": "Y",
 "spoofType": [
 "SCREEN_REMARK"
 ]
 }
}

HTTP Status Code

Code

Message

200

Success

The request has succeeded.

400

MissingParameter

The parameter is missing.

400

InvalidParameter

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 Real ID.

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, please submit a ticket for help.

SubCode

Whether billing

Message

200

Yes

pass.

212

Yes

The result of certificate anti-counterfeiting detection indicates tampering, screen recapture or photo copy are detected.

Field name

Data type

Description

Example

ocrIdPassed

String

Whether the identity document recognition process runs successfully. Valid values:

• Y: pass.

• N: fail.

N

idImage

String

The identity document image, in base64 format. 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.

base64

ocrIdInfo

String

Document OCR identification information, Json string, see the "OCR extraction field" column for details on the content format.

{
 "expiryDate": "",
 "originOfIssue": "公安部出入境管理局",
 "englishName": "LI SI",
 "sex": "男",
 "name": "李四",
 "idNumber": "H11111112",
 "issueDate": "2013-01-02",
 "birthDate": "1990-02-21"
 }

spoofInfo

String

Spoofing check results of Identity document and corresponding types. Valid values:

• spoofResult:

  • Y: failed the authenticity check.

  • N: pass.

• spoofType:

  • SCREEN_REMARK: screen recapture.

  • PHOTO_COPY: Copy, not original document.

  • TAMPER: PS tampering.

{
 "spoofResult": "Y",
 "spoofType": [
 "SCREEN_REMARK"
 ]
}

ocrIdEditInfo

String

OCR guest editing information, Json string, for detailed information on content format, please refer to the "OCR Extraction Fields" column. Only when the customer completes ocr editing and certification is passed will there be return.

{
 "expiryDate": "2026-01-02",
 "originOfIssue": "公安部出入境管理局",
 "englishName": "ZHANG SAN",
 "sex": "男",
 "name": "张三",
 "idNumber": "H11111115",
 "issueDate": "2013-01-02",
 "birthDate": "1990-02-21"
 }

Field name

Data type

Description

name

String​

Chinese Name.

englishName

String​

English Name.

nameCode

String​

Telex code, which is corresponding to the Chinese name.

sex

String

Gender. Valid values:

• M (male)

• F (female).

birthDate

String​

Date of birth.​

idNumber

String​

ID number.

currentIssueDate

String​

Date of latest registration.

firstIssueDate

String​

Month and year of first registration.

isPermanent

String​

Whether it is a permanent residence identity card. Valid values:

• Y (permanent)

• N (non-permanent).

symbols

String​

Symbols below the date of Birth. Such as "***AZ".

Field name

Data type

Description

name

String​

Chinese Name.

englishName

String​

English Name.

sex

String

Gender.

birthDate

String​

Date of birth.

idNumber

String​

ID number.

issueDate

String

Date of issuance.

expiryDate

String​

Date of expiry.

placeOfIssue

String​

Place of issue.

originOfIssue

String​

Authority for issue.

Field name

Data type

Description

name

String​

Chinese Name.

englishName

String​

English Name.

sex

String​

Gender.

birthDate

String​

Date of birth.

idNumber

String​

ID number.

issueDate

String​

Date of Issuance.

expiryDate

String​

Date of Expiry.

originOfIssue

String​

Authority for issue.

Field name

Data type

Description

surname

String​

Surname.

givenname​

String​

Given name.​

sex

String​

Gender.

birthDate

String​

Date of birth.

passportNo​

String​

Passport number.

nationality​

String​

Country.

expiryDate

String​

Date of Expiry.

countryCode​

String​

Country Code.

Field name​

Data type​

Description​

surnameCN

String​

Chinese surname.

givennameCN

String​

Chinese given name.​

surname

String​

Surname.

givenname​

String​

Given name.​

sex

String​

Gender.

birthDate

String​

Date of birth.

idNumber

String​

ID number.

expiryDate

String​

Date of Expiry.

placeOfBirth

String​

Code for place of birth. Such as "AS".

Field name

Data type

Description

name

String​

Chinese Name.

englishName

String​

English Name.​

sex

String​

Gender.

birthDate

String​

Date of birth.

idNumber

String​

ID number.

issueDate

String​

Date of issuance.

expiryDate

String​

Date of expiry.

originOfIssue

String​

Authority for issue.

placeOfIssue

String​

Place of issue.