ID Verification:InitializeV2

Integration method

Scenarios

Initialization API response

Request parameters

App SDK

Authenticating in a native Android or iOS app

TransactionId, Protocol

Common parameters + App-specific parameters

Web SDK

Mobile H5 or PC browser authentication

TransactionId, TransactionUrl, and Protocol

Common parameters + Web SDK-specific parameters

Field

Type

Required

Note

Example value

ProductCode

String

Yes

Product solution identifier. Value:

eKYC_PRO. The user must complete ID document verification and liveness detection.

eKYC_PRO

SceneCode

String

No

A custom ID for the authentication scenario. Use this ID to retrieve records from the console. The ID can be a 10-character string that consists of letters, numbers, and underscores.

1234567890

MerchantBizId

String

Yes

A unique business identifier for the merchant, used to identify and troubleshoot issues. The identifier is a 32-character string of letters and numbers. The server-side does not validate the uniqueness of this ID. The merchant must ensure that the ID is unique.

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 identifier, or another recognizable user identifier, such as a mobile phone number or email address. We recommend that you desensitize or hash this field.

123456789

IdThreshold

String

No

2

IdSpoof

String

No

OCR anti-spoofing detection:

• Y: Enable (default)

• N: Disable

You can view the output result in CheckResult at Result.ExtIdInfo.ocrIdInfoData.{page}.spoofInfo.

Y

OcrValueStandard

String

No

OCR configuration: Specifies whether to return standardized OCR fields:

• 0: No (default)

• 1: Yes

The output is returned in the Result.ExtIdInfo.ocrStandardData field of CheckResult.

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 for the certificate capture page:

• 01: Portrait side (default)

• 01,02: Portrait side and back side

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

Model

String

No

Liveness detection type:

• SILENT: Silent (Supported by Naive SDK 1.3.6 and later)

• LIVENESS: Blink (default)

• PHOTINUS_LIVENESS: Blink and color flash (Not supported in PC mode)

• TEMPLATE: Custom liveness detection action (Not supported by Web SDK. Supported by Naive SDK 1.3.6 and later.)

PHOTINUS_LIVENESS

DocVideo

String

No

N

FaceAttributeCheck

String

No

N

ShowGuidePage

String

No

UI configuration: Show guide page:

• 1: Show (default)

• 0: Do not show

PC mode does not support this configuration.

Supported in Native SDK version 1.2.8 and above.

1

CallbackUrl

String

No

CallbackToken

String

No

A custom security token for the merchant. Once set, this token is returned unchanged with the CallbackUrl for anti-replay and tamper-proofing verification.

NMjvQanQgplBSaEI0sL********

Security level

String

No

02

Authorize

String

No

T

Mobile

String

Conditionally required

An Indonesian mobile number in the format of +62 followed by 9 to 11 digits. This parameter is required if Authorize=T and an Indonesian data source is used.

+6281293671234

Email

String

Conditionally required

User mailbox. Required when Authorize=T and the Indonesia data source is used.

a*@gmail.com

Field

Type

Required

Description

Example value

AppQualityCheck

String

No

[Face Scan Configuration] Specifies whether to enable strict face quality detection.

• Y: Yes (default)

• N: No

Supported only in Native SDK v1.2.5 and later. The face quality detection module must be integrated.

N

TemplateConfig

String

Conditionally required

01,02,07

TemplateType

String

Conditionally required

Seq

NeedMultiFaceCheck

String

No

Y

DocScanMode

String

No

[OCR Configuration] The OCR certificate scan mode.

• shoot: Take a photo.

• scan: Scan automatically.

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

Supported only in Native SDK v1.2.8 and later. The automatic scanning component must be integrated.

shoot

Field

Type

Required

Note

Example value

LanguageConfig

String

No

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

StyleConfig

String

No

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

ShowAlbumIcon

String

No

OCR configuration: Specifies whether to show the option to upload from an album during the OCR step:

• 1: Show (default)

• 0: Do not show

1

ShowOcrResult

String

No

OCR configuration: Controls whether to show the detection result page for the OCR step:

• 1: Show (default)

• 0: Do not show

1

EditOcrResult

String

No

OCR configuration: Specifies whether users can edit OCR recognition results:

• 1: Allow (default)

• 0: Disallow

1

ReturnUrl

String

Conditionally required

The URL to redirect to after authentication. This is optional for the iframe embedded pattern. Provide this URL for page redirect scenarios that do not use an iframe.

https://www.alibabacloud.com

ProcedurePriority

String

No

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

• url: Supports fallback. The page displays the authentication URL. Users can copy the URL and open it in a different browser to continue authentication. (Default)

• keep: Does not support fallback. An error reason is returned, and the authentication flow ends. This option is not supported on PCs. Recommended for webpages embedded in an app.

URL

Field

App SDK

Web SDK

Note

RequestId / Code / Message

Yes

Yes

General response information.

Result.TransactionId

Yes

Yes

This is the unique identifier for the authentication flow, a field for billing statistics, and a request parameter for the CheckResult operation. Attach this identifier to the merchant business ID and store it only on the server-side.

Result.Protocol

Yes

Yes

Standard authentication and encryption protocol. Pass this through to the client SDK. The Web SDK requires this field for iframe embedding.

Result.TransactionUrl

No

Yes

The Web SDK authentication URL. After authentication, it redirects to the ReturnUrl. This URL cannot be modified and can be accessed only once. You must complete the authentication within 30 minutes of obtaining the URL or TransactionId.