ID Verification:DocOcr

Parameter

Type

Required

Description

Example

ProductCode

String

Yes

Set to ID_OCR_MIN in this mode.

ID_OCR_MIN

MerchantBizId

String

Yes

A unique business ID for tracing purpose. For example, the sequence ID from the merchant's business-related database.

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

String

Yes

Merchant user ID, or other identifiers that can be used to identify a specific user, for example, mobile phone number, email address and so on. It is strongly recommended to pre-desensitize the value of the userId field, for example, by hashing the value.

123456789

IdOcrPictureBase64

String

No

Front image of ID card, binary stream base64 encoding.

base64

IdOcrPictureUrl

String

No

The HTTPS or HTTP address of the image of the front side of ID card.

https://***

DocType

String

Yes

Document type, consisting of 8 digits, with mapping detailed in the table below.

00000006

Ocr

String

Yes

Whether to enable the information extraction of the identity documents. The following values are supported:

• T: Indicates the information extraction via OCR technology is enabled.

• F: Indicates the information extraction via OCR technology is disabled.

By default, the value of T is used.

T

IdFaceQuality

String

No

Whether to return the quality check result of the input profile image. The following values are supported:

• T: Indicates the quality score of profile image need to return.

• F: Indicates the quality score of profile image does not to return.

By default, the value of F is used.

F

Spoof

String

No

Whether to enable anti-spoofing detection of the identity documents. The following values are supported:

• T: Indicates that anti-spoofing check is enabled.

• F: Indicates that anti-spoofing check is disabled.

By default, the value of F is used.

F

DocType

CertType

01000000

Passport for all countries

00000006

HKID 2003 version (Hong Kong Identity Card)

00000008

HKID 2018 version (Hong Kong Identity Card)

00000007

China Exit-Entry Permit for Travelling to and from Hong Kong and Macao

00000009

China Mainland Travel Permit for Hong Kong and Macao Residents

000000011

Macau Identity Card

000000012

China Mainland Travel Permit for Taiwan Residents

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.TransactionId

String

A unique transaction ID that is generated by the Alibaba Cloud server for the identity proofing process.

hksf3e9312e119b15549d26b5b68e40e

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.

{
 "idFaceQualityScore": 98.0
 "ocrIdInfo": {
 "expiryDate": "",
 "originOfIssue": "公安部出入境管理局",
 "englishName": "LI SI",
 "sex": "男",
 "name": "李四",
 "idNumber": "H11111112",
 "issueDate": "2013-01-02",
 "birthDate": "1990-02-21"
 },
 "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.

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.

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.

211

Yes

Low quality or incomplete document. Documents are low-quality or partially visible so that no definitive conclusions can be made.

212

Yes

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

213

Yes

No ID detected. The required type of ID can not be detected.

Field name

Data type

Description

Example

ocrIdInfo

String

Optional. Specified only when the value of the Ocr field in the request is set to T. Document OCR identification information. Json string. See the "OCR extraction field" column for details on the content format.

{ "expiryDate": "2024-04-20",
"placeOfIssue": "广东",
"englishName": "ZHENGJIAN,YANGBEN",
"originOfIssue": "公安部出入境管理局",
"sex": "女", "name": "证件样本",
"idNumber": "C00000000",
"issueDate": "2014-04-21",
"birthDate": "1981-08-03" 
}

idFaceQualityScore

Double

Optional. The quality score of the input profile image. Specified only when the value of the IdFaceQuality field in the request is set to T. The value of this field is between 0 and 100.

99.95

spoofInfo

String

Optional. Specified only when the value of the Spoofing field in the request is set to T.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.

{"spoofInfo": {"spoofResult":"Y","spoofType": ["SCREEN_REMARK","PHOTO_COPY","TAMPER"]}}

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.