ID Verification:Initialize

Name

Type

Required

Description

Example

ProductCode

String

Yes

The product solution to be integrated. Valid value:

eKYC: Use the eKYC product solution. Your users need to complete the entire process of document verification and liveness detection.

eKYC

SceneCode

String

No

Your custom verification scene ID, which is used to query related records by entering this scene ID in the console. The ID can be a combination of letters, digits, or underscores with a length of 10 characters.

1234567890

MerchantBizId

String

Yes

Your custom unique business identifier, which is used to locate and troubleshoot issues later. It can be a combination of letters and digits with a length of 32 characters. Make sure it is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

Yes

The MetaInfo environment parameters, which need to be obtained through the client SDK. For more information, see the corresponding client integration documentation.

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

Your custom user ID, or other identifiers that can identify specific users, such as phone numbers or email addresses. We strongly recommend that you pre-mask the value of this field, such as by hashing the value.

123456789

IdSpoof

String

No

Specifies whether to enable document tamper-proofing detection:

• Y: Enable

• N: Disable (default)

Y

DocType

String

Yes

document type. You can specify an 8-digit value to uniquely identify a document type. For more information, see the table below.

01000000

Authorize

String

No

Specifies whether to enable official database identity verification:

• T: Enable

• F: Disable (default)

F

SecurityLevel

String

No

02

IdThreshold

String

No

0

Model

String

No

PHOTINUS_LIVENESS

DocVideo

String

No

N

CallbackUrl

String

No

The callback URL for verification results. The default callback request method is GET, and the callback URL must start with https. After the verification is complete, the system sends callback requests to the callback URL and automatically adds the following fields to the callback requests:

• transactionId

• passed

• code

• subcode

https://www.aliyun.com?callbackToken=100000****&transactionId=shaxxxx&passed=Y&subCode=200

CallbackToken

String

No

The security token that is used for anti-duplication and anti-tampering verification. You can specify a custom value.

If this value is set, the CallbackToken field will be included in the CallbackUrl callback.

NMjvQanQgplBSaEI0sL86WnQplB

AppQualityCheck

String

No

Specifies whether to enable strict face quality detection.

• Y (default): Enable

• N: Disable

N

DocPageConfig

String

No

JSON string array format:

OCR_ID_BACK: Collect the back page

OCR_ID_BACK

ShowGuidePage

String

No

Specifies whether to display the guide page:

• 1 (default): Display

• 0: Do not display

1

DocScanMode

String

No

OCR document scanning mode:

• shoot (default): Take photo

• scan: Scan

• auto: Automatic switchover between photo/scan

shoot

DocType

Corresponding document

01000000

Global passport

00000006

Hong Kong Identity Card (2003 version)

00000008

Hong Kong Identity Card (2018 version)

00000007

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

00000009

Mainland Travel Permits for Hong Kong and Macao Residents

000000011

Macao Identity Card

000000012

Mainland Travel Permit for Taiwan Residents

00000001

Second-generation resident ID card of mainland China

Name

Type

Description

Example

HTTP Status Code

Integer

HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

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

Code

String

The return code. For more information about return codes, see Return codes and messages.

success

Message

String

The response message of the request.

success

Result.TransactionId

String

hksb7ba1b28130d24e015d6********