ID Verification:ID_OCR_MIN

Parameter

Type

Required

Description

Example

ProductCode

String

Yes

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

ID_OCR_MIN

SceneCode

String

No

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

1234567890

MerchantBizId

String

Yes

A custom unique business ID for tracking and troubleshooting. The ID can be a string of up to 32 letters and digits. Ensure this ID is unique for each request.

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

String

Yes

A custom user identifier, such as a phone number or email address. We strongly recommend masking this value before submission, for example, by using hashing.

123456789

IdOcrPictureBase64

String

No. Select one of the three upload methods.

The base64-encoded image of the ID document. If you use this method, verify the image size to avoid exceeding the data transfer limit.

base64

IdOcrPictureUrl

String

The publicly accessible HTTP or HTTPS URL of the ID document image.

https://***

IdOcrPictureFile

InputStream

The file stream of the ID document image.

For integration instructions, see Special scenario: File upload with the Advance interface.

DocType

String

Yes

The document type, specified as an 8-digit unique identifier. For more information, see Document types.

01000000

Spoof

String

No

[OCR Configuration] Specifies whether to enable the anti-spoofing feature.

• T: Enables the anti-spoofing feature. (Default)

• F: Disables the anti-spoofing feature.

F

IdThreshold

String

No

3

CardSide

String

No

[OCR Configuration] The side of the ID document to recognize. Defaults to the portrait side.

• OCR_ID_FACE: The portrait side. (Default)

• OCR_ID_NATIONAL_EMBLEM: The national emblem side.

OCR_ID_NATIONAL_EMBLEM

Parameter

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

The response code. For more information, see Server-side HTTP 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 Result.SubCode error codes.

200

Result.ExtIdInfo

String

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

{
  "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"
    ]
  }
}

Error code

Billed

Description and suggestions

200

Yes

Authentication passed.

211

Yes

[Document solution] The image quality or resolution does not meet the requirements, or the image is incomplete. Ensure the document image is clear, properly exposed, complete, unobstructed, and correctly oriented.

212

Yes

[Document solution] Document anti-spoofing detection has detected a risk. Possible causes include screen recapture, tampering, or photocopying.

213

Yes

[Document solution] The specified document type was not detected (in specified document recognition mode), or the document type could not be identified (in automatic classification mode).

Provide a clear, complete, and correctly oriented document image.