ID Verification:Initialize

Parameter

Type

Required

Description

Example

ProductCode

String

Yes

The product solution to use. Set the value to ID_OCR.

ID_OCR

MerchantBizId

String

Yes

A unique business identifier that you define to help track and troubleshoot issues. It can be a combination of letters and digits up to 32 characters long. Ensure that this ID is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

Yes

MerchantUserId

String

Yes

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

123456789

ReturnUrl

String

No

The URL to which the user is redirected after the verification process completes.

https://www.alibabacloud.com

DocType

String

Yes

The document type, identified by a unique 8-digit code. For a list of supported document types, see the Document types table below.

01000000

SceneCode

String

No

A custom ID for the verification scenario. You can use this ID to search for related records in the ID Verification console. It can contain up to 10 characters, including letters, digits, and underscores (_).

1234567890

IdSpoof

String

No

Specifies whether to enable document anti-spoofing detection. Valid values:

• Y: Enables the feature.

• N: Disables the feature. (Default)

Y

IdThreshold

String

No

0

ShowAlbumIcon

String

No

Specifies whether to display an icon for uploading a document from the photo album during the OCR process. Valid values:

• 1: yes (Default)

• 0: no

1

ShowOcrResult

String

No

Specifies whether to display the OCR result page. Valid values:

• 1: yes (Default)

• 0: no

1

ShowGuidePage

String

No

Specifies whether to display the guide page. Valid values:

• 1: yes (Default)

• 0: no

1

CallbackUrl

String

No

CallbackToken

String

No

A security token that you generate to prevent replay attacks and data tampering.

If you set this parameter, the CallbackToken is included in the request sent to your callback URL.

NMjvQanQgplBSaEI0sL********

LanguageConfig

String

No

{
  "languageContent": {****},
  "ocrResultContent": {****},
  "supportedLanguage": [****],
  "titleTranslate": {****},
}

StyleConfig

String

No

{
  "guidepage:": {****}, 
  "ocrPage": {****},
  "ocrResultPage": [****],
  "facePage": {****},
}

EditOcrResult

String

No

Specifies whether users can edit the information on the OCR result page. Valid values:

• 1: yes (Default)

• 0: no

0

DocType

Document

01000000

Passport (Global)

00000006

Hong Kong Permanent Identity Card (2003 version)

00000008

Hong Kong Permanent Identity Card (2018 version)

00000007

Exit-entry Permit for Travelling to and from Hong Kong and Macao

00000009

Mainland Travel Permit for Hong Kong and Macao Residents

000000011

Macao SAR Permanent Resident Identity Card

000000012

Mainland Travel Permit for Taiwan Residents

00000001

Second-generation resident ID card for the Chinese mainland

Parameter

Type

Description

Example

HTTP status code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

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

Code

String

The response code.

Success

Message

String

A detailed description of the response code.

success

Result.TransactionId

String

hksb7ba1b28130d24e015d6********

Result.TransactionUrl

String

The URL for the web-based verification flow. After the process completes, the user is redirected to the URL specified in the ReturnUrl parameter.

https://www.alibabacloud.com/index.html?clientcfg=****

Result.Protocol

String