ID Verification:ID_OCR_MIN

Name

Type

Required

Description

Example

ProductCode

String

Yes

The product plan to use. Set the value to ID_OCR_MIN to use the ID document OCR API.

ID_OCR_MIN

SceneCode

String

No

A custom ID for the authentication scenario. You can use this ID to query related records in the console. The ID can be up to 10 characters in length and can contain letters, digits, and underscores (_).

1234567890

MerchantBizId

String

Yes

A custom unique business ID used to track and troubleshoot issues. The ID can be up to 32 characters in length and can contain letters and digits. Make sure that the ID is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

String

Yes

A custom user ID or another identifier for a specific user, such as a mobile phone number or email address. We strongly recommend that you desensitize this value in advance, for example, by hashing it.

123456789

IdOcrPictureBase64

String

Yes

The base64-encoded image of the portrait side of the ID document. If you choose to provide the ID document photo using IdOcrPictureBase64 (base64-encoded photo), check the photo size. Do not provide an oversized photo.

base64

IdOcrPictureUrl

String

Yes

The URL of the image of the portrait side of the ID document. The URL must be an HTTP or HTTPS link that is accessible over the Internet.

https://***

DocType

String

Yes

The type of the ID document. It is a unique identifier composed of 8 digits. For more information, see List of document types.

F

Ocr

String

Yes

Specifies whether to enable the OCR feature to automatically extract document information.

• T: Enable the OCR feature.

• F: Disable the OCR feature.

T

IdFaceQuality

String

No

Specifies whether to return the quality score of the face on the ID document. This feature is disabled by default.

• T: Return the face quality score.

• F: Do not return the face quality score.

F

Spoof

String

No

Specifies whether to enable the anti-spoofing feature for the ID document. This feature is disabled by default.

• T: Enable the anti-spoofing feature.

• F: Disable the anti-spoofing feature.

F

IdThreshold

String

No

3

CardSide

String

No

Specifies the side of the ID document. If you do not pass this parameter, the portrait side is used by default.

• OCR_ID_FACE (Default): Portrait side

• OCR_ID_NATIONAL_EMBLEM: National emblem side

OCR_ID_NATIONAL_EMBLEM

Name

Type

Description

Example

HTTP Status Code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

130A2C10-B9EE-4D84-88E3-5384FF039****

Result.TransactionId

String

The unique ID for the entire authentication process.

hksb7ba1b28130d24e015d694361b****

Code

String

Status codes.

Success

Message

String

A detailed description of the response code.

success

Result.Passed

String

The authentication result. Valid values:

• Y: Passed

• N: Failed

Y

Result.SubCode

String

A description of the authentication result. For more information, see ResultObject.SubCode error codes.

200

Result.ExtIdInfo

String

Information about the ID document recognition result. For the JSON format, see the example on the right. For more information, see ExtIdInfo.

{
  "idFaceQualityScore": 98.0,
  "ocrIdInfo": {
    "expiryDate": "",
    "originOfIssue": "Bureau of Exit and Entry Administration of the Ministry of Public Security",
    "englishName": "LI SI",
    "sex": "Male",
    "name": "Li Si",
    "idNumber": "H11111112",
    "issueDate": "2013-01-02",
    "birthDate": "1990-02-21"
  },
  "spoofInfo": {
    "spoofResult": "Y",
    "spoofType": [
      "SCREEN_REMARK"
    ]
  }
}