ID Verification:CheckResult

Name

Type

Description

Example

ocrIdPassed

String

The final result of the ID document OCR phase. Valid values:

• Y: Passed

• N: Failed

N

idImage

String

The ID document OCR photo in Base64 format. This field is returned if you set the isReturnImage parameter to Y in the request and the ID document OCR process is successfully completed.

base64

ocrIdInfo

String

The field information from the ID document OCR. For more information, see OCR result fields.

{
 "expiryDate": "",
 "originOfIssue": "Exit and Entry Administration, Ministry of Public Security",
 "englishName": "LI SI",
 "sex": "Male",
 "name": "Li Si",
 "idNumber": "H11111112",
 "issueDate": "2013-01-02",
 "birthDate": "1990-02-21"
 }

spoofInfo

String

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

ocrIdEditInfo

String

The ID document OCR field information that the user submits after editing it on the OCR result page. This parameter is returned if the client is configured to enable the OCR result editing page (ShowOcrResult).

{
 "expiryDate": "2026-01-02",
 "originOfIssue": "Exit and Entry Administration, Ministry of Public Security",
 "englishName": "ZHANG SAN",
 "sex": "Male",
 "name": "Zhang San",
 "idNumber": "H11111115",
 "issueDate": "2013-01-02",
 "birthDate": "1990-02-21"
 }

idBackImage

String

The OCR photo of the back of the ID document, in Base64 format.

base64

ocrIdBackInfo

String

The OCR field information from the back of the ID document.

{
   "originOfIssue": "Tanghe County Public Security Bureau",
   "issueDate": "20230102",
   "expireDate": "20330102"
 }

spoofBackInfo

String

The result of the anti-spoofing check for the back of the ID document. The result includes the risk decision and risk type.

• spoofResult:

  • Y: A risk is detected.

  • N: Normal.

• spoofType:

  • SCREEN_REMARK: Screen recapture

  • PHOTO_COPY: Photocopy

  • TAMPER: PS tampering

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

HTTP status code

Code

Message

200

Success

Request successful.

400

MissingParameter

Parameter cannot be empty.

InvalidParameter

Invalid parameter.

TransactionIdInvalid

Invalid Transaction ID.

403

Forbidden.RAMUserAccessDenied

You need to grant the RAM user the AliyunAntCloudAuthFullAccess permission. For more information, see Authorize RAM users to access the service.

Forbidden.AccountAccessDenied

Ensure that you have activated ID verification and your account has no overdue payment.

Throttling.Api

API request is blocked due to throttling.

404

ProcessNotCompleted

The entire authentication process is not completed.

500

InternalError

Internal system error. Provide feedback to engineers for troubleshooting.

Applicable solution

Error code

Is authentication record billed

Description and suggested reasons

General

200

Yes

Authentication passed.

• ID_OCR pure server-side integration (DocOcr)

• ID_OCR_MAX

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.

• ID_OCR App (SDK) integration

• ID_OCR Web (SDK) integration

• ID_OCR_MAX

212

Yes

Certificate anti-counterfeiting detection indicates risk. There may be high-risk operations such as rephotographing, tampering, or photocopying.

• ID_OCR pure server-side integration (DocOcr)

• ID_OCR_MAX

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.

Field

Type

Description

name

String

Name

englishName

String

Name (English)

nameCode

String

Telecode for Chinese Name

sex

String

Sex. Valid values:

• M (Male)

• F (Female)

birthDate

String

Date of birth

idNumber

String

Identity card number

currentIssueDate

String

Date of registration

firstIssueDate

String

Month and year of first registration

isPermanent

String

Indicates whether it is a permanent identity card. Valid values:

• Y (Yes)

• N (No)

symbols

String

Symbol mark. Example: "**AZ".

Field

Type

Description

name

String

Name

englishName

String

Name (Pinyin)

sex

String

Sex

birthDate

String

Date of birth

idNumber

String

Certificate number

issueDate

String

Date of issue

expiryDate

String

Date of expiry

placeOfIssue

String

Place of issue

originOfIssue

String

Issuing authority

Field

Type

Description

name

String

Name

englishName

String

Name (English)

sex

String

Sex

birthDate

String

Date of birth

idNumber

String

Certificate number

issueDate

String

Date of issue

expiryDate

String

Date of expiry

originOfIssue

String

Issuing authority

Field

Type

Description

surname

String

Surname (in Latin script, based on MRZ recognition)

givenname

String

Given name (in Latin script, based on MRZ recognition)

sex

String

Sex (F or M)

birthDate

String

Date of birth (in yyyy-mm-dd format)

passportNo

String

Passport number

nationality

String

Nationality (3-digit country code)

expiryDate

String

Date of expiry (in yyyy-mm-dd format)

countryCode

String

Country code of the passport issuing authority (3-digit coun

Country code

Field

Type

Description

surnameCN

String

Surname (Chinese)

givennameCN

String

Given name (Chinese)

surname

String

Surname (English)

givenname

String

Given name (English)

sex

String

Sex

birthDate

String

Date of birth

idNumber

String

Certificate number

expiryDate

String

Date of expiry

placeOfBirth

String

Place of birth code. Example: "AS".

Field

Type

Description

name

String

Name

englishName

String

Name (Pinyin)

sex

String

Sex

birthDate

String

Date of birth

idNumber

String

Certificate number

issueDate

String

Date of issue

expiryDate

String

Date of expiry

originOfIssue

String

Issuing authority

placeOfIssue

String

Place of issue

Field

Type

Description

name

String

Name

sex

String

Sex

ethnicity

String

Ethnicity

birthDate

String

Date of birth

idNumber

String

ID card number

address

String

Address