ID Verification:InitializeV2

Integration method

Scenario

Initialization API operation response

Request parameters

App SDK

Complete authentication within a native Android or iOS app.

TransactionId, Protocol

Common parameters + App-specific parameters

Web SDK

Authentication in a mobile H5 page or a PC browser.

TransactionId, TransactionUrl, Protocol

Common parameters + Web SDK-specific parameters

Field

Type

Required

Description

Example

ProductCode

String

Yes

The product plan ID. Set the value to:

ID_OCR_PRO. The user must complete certificate OCR.

ID_OCR_PRO

SceneCode

String

No

A custom authentication scenario ID. You can use this ID to search for 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 unique business ID for the merchant. This ID is used for troubleshooting. It can be up to 32 characters long and can contain letters and digits. The server-side does not verify the uniqueness of this ID. The merchant must ensure its uniqueness.

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

Yes

{
  "zimVer": "3.0.0",
  "appVersion": "1",
  "bioMetaInfo": "4.1.0:1150****,0",
  "appName": "com.aliyun.antcloudauth",
  "deviceType": "h5",
  "osVersion": "iOS 10.3.2",
  "apdidToken": "",
  "deviceModel": "iPhone9,1"
}

MerchantUserId

String

Yes

A custom user ID for the merchant, or another identifier such as a mobile phone number or email address. We recommend that you desensitize or hash this field in advance.

123456789

CallbackUrl

String

No

CallbackToken

String

No

A custom security token for the merchant. If you set this parameter, it will be returned with the CallbackUrl for anti-replay and tamper-proofing checks.

NMjvQanQgplBSaEI0sL********

IdThreshold

String

No

3

IdSpoof

String

No

[OCR configuration] Specifies whether to enable certificate anti-spoofing check:

• Y: Enabled (default)

• N: Disabled

To view the output, check Result.ExtIdInfo.ocrIdInfoData.{page}.spoofInfo in the CheckResult response.

N

OcrValueStandard

String

No

[OCR configuration] Specifies whether to return standardized OCR fields:

• 0: No (default).

• 1: Yes.

To view the output, check Result.ExtIdInfo.ocrStandardData in the CheckResult response.

0

DocType

String

Yes

[OCR Configuration] Supports the following three input methods:

1. Specify country/region: Pass in a three-letter country code. The system automatically retrieves supported document types within the specified scope and returns the specific document code upon successful recognition. Up to three codes can be specified, for example, CHN, HKG, and GLB, as the auto-classification scope. For three-letter country codes, see Country code abbreviations.

2. Specify country/region and document category: Pass in a three-letter country code and a two-digit document category code. The system automatically retrieves supported document types within the specified scope and returns the specific document code upon successful recognition. For document type codes, see Certificate type codes.

3. Specify exact document: Pass in the exact code of the specified document type, consisting of a three-letter country code and a five-digit document number. The system precisely identifies whether the document matches the expected type. For document type codes, see Certificate code.

Pages

String

No

[OCR configuration] The certificate pages to collect:

• 01: Front side (default)

• 01,02: Front and back sides

01

AutoDocPageConfig

String

No

[OCR Configuration] This parameter takes effect only when the DocType is set to a specific 'Country/Region Code' or 'Country/Region and Document Category'. By default, it captures only the front side of the document. To capture both the front and back for a specific document category (refer to Certificate type codes) or a precise document type (refer to Certificate code) of that country, you can configure this parameter accordingly. See the examples on the right for details.

This parameter is supported only by Native SDK 1.4.0 and later.

• Capture both the front and back of Malaysia's new national ID:

  {
    "MYS01002": "01,02"
  }

• Set the document category: 

  {
    "MYS01": "01,02"
  }

ShowGuidePage

String

No

[UI configuration] Specifies whether to show the guide page:

• 1: Show (default).

• 0: Do not show.

This configuration is not supported in PC browser mode. Supported in Native SDK version 1.2.8 and above.

1

Field

Type

Required

Description

Example

DocScanMode

String

No

[OCR configuration] The OCR certificate scanning mode:

• shoot: Take a photo.

• scan: Scan automatically.

• auto: Switch automatically between taking a photo and scanning.

This parameter is supported only by Native SDK 1.2.8 and later, and requires the automatic scanning component to be integrated.

shoot

Field

Type

Required

Description

Example

LanguageConfig

String

No

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

StyleConfig

String

No

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

ShowAlbumIcon

String

No

[OCR configuration] Specifies whether to show the album upload entry during the OCR step:

• 1: Show (default).

• 0: Do not show.

1

ShowOcrResult

String

No

[OCR configuration] Specifies whether to show the recognition result page during the OCR step:

• 1: Show (default).

• 0: Do not show.

1

EditOcrResult

String

No

[OCR configuration] Specifies whether to allow users to edit the OCR recognition result:

• 1: Allow (default).

• 0: Do not allow.

1

ReturnUrl

String

Conditionally required

The business redirect URL after authentication ends. This parameter is not required when using iframe embedding mode. It should be provided for non-iframe page redirection scenarios.

https://www.alibabacloud.com

ProcedurePriority

String

No

Specifies whether to allow a fallback method when a compatibility issue occurs during mobile H5 authentication.

• url: Fallback is supported. The page displays the authentication URL. The user can copy the URL to open it in another browser to continue authentication (default).

• keep: Fallback is not supported. The system directly returns the error cause and ends the authentication flow. This is not supported on PCs. We recommend setting this to keep for web pages embedded in an app.

url

Field

App SDK

Web SDK

Description

RequestId / Code / Message

Yes

Yes

Common response information.

Result.TransactionId

Yes

Yes

The unique ID for the authentication flow. This field is used for billing and as a request parameter for the CheckResult API operation. We recommend that you bind it with your business ID and store it only on the server-side.

Result.Protocol

Yes

Yes

The standard encrypted protocol for authentication. We recommend that you pass this through to the client SDK. The Web SDK iframe embedding method depends on this field.

Result.TransactionUrl

No

Yes

The Web SDK authentication URL. After authentication, the user is redirected to the ReturnUrl. Do not modify this URL. It can be accessed only once. The authentication must be completed within 30 minutes after you obtain the URL or TransactionId.