ID Verification:Initialize

Name

Type

Required

Description

Example

ProductCode

String

Yes

The product plan to use. Set the value to:

eKYC_PRO: This plan requires your users to complete the entire process of document recognition and liveness detection.

eKYC_PRO

SceneCode

String

No

A custom verification scenario ID. You can use this ID to query related records in the console. The ID can be a combination of up to 10 letters, digits, and underscores.

1234567890

MerchantBizId

String

Yes

A custom unique business ID used for troubleshooting. The ID can be a combination of up to 32 letters and digits. Make sure that the ID is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

Yes

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 the value of this field in advance, for example, by hashing the value.

123456789

Model

String

No

PHOTINUS_LIVENESS

DocType

String

Yes

The document type.

For a list of supported document codes, see the Document type table. For details about the Optical Character Recognition (OCR) return fields for each document type, see the Document OCR field table.

GLB03001

SecurityLevel

String

No

02

IdThreshold

String

No

0

IdSpoof

String

No

Specifies whether to enable the document anti-spoofing feature:

• Y: Enable

• N: Disable (default)

Y

DocVideo

String

No

N

CallbackUrl

String

No

CallbackToken

String

No

A security token that you generate for anti-replay and tamper-proofing checks.

If you set this parameter, the CallbackToken field is included in the CallbackUrl webhook.

NMjvQanQgplBSaEI0sL********

AppQualityCheck

String

No

Specifies whether to enable strict quality detection for faces.

• Y: Enable (default)

• N: Disable

N

Pages

String

No

The page collection configuration. Use a comma (,) to separate multiple pages. Valid values:

• 01: The portrait side of the document (default).

• 01,02: The portrait and back sides of the document.

  Note

  Only some certificate types support multi-page collection. For details, see Certificate types.

01

ShowGuidePage

String

No

Specifies whether to display the guide page:

• 1: Display (default)

• 0: Do not display

1

LanguageConfig

String

No

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

StyleConfig

String

No

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

ReturnUrl

String

No

The target address to which the user is redirected from the business page.

https://www.alibabacloud.com

ShowBlbumIcon

String

No

In the document OCR step, specifies whether to display the album upload entry:

• 1: Display (default)

• 0: Do not display

1

ShowOcrResult

String

No

In the document OCR step, specifies whether to display the recognition result page:

• 1: Display (default)

• 0: Do not display

1

ProcedurePriority

String

No

When a compatibility issue occurs during verification on a mobile H5 page, specifies whether to allow a degraded processing method to be displayed.

• url: Supports degradation. The verification URL is displayed on the page. The user can copy the URL to open it or switch to another browser to continue the verification (default).

• keep: Does not support degradation. The error cause is returned directly, and the verification process ends.

url

EditOcrResult

String

No

Specifies whether users can edit information on the OCR recognition result page.

• 1: Supported

• 0: Not supported (default)

0

Authorize

String

No

T

Mobile

String

No

An Indonesian phone number. Must start with +62 followed by 9–11 digits. This parameter takes effect only when Authorize=T.

+6281293671234

Name

Type

Description

Example

HTTP status code

Integer

The HTTP status code.

200

HTTP body

RequestId

String

The request ID.

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

Code

String

Return codes.

Success

Message

String

The detailed description of the return code.

success

Result.TransactionId

String

hksb7ba1b28130d24e015d6********

Result.TransactionUrl

String

The web verification URL. After verification, the user is redirected to the ReturnUrl specified in the request.

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

Result.Protocol

String