ID Verification:Initialize

Name

Type

Required

Description

Example

ProductCode

String

Yes

The product solution to be integrated. Valid value: FACE_VERIFY.

FACE_VERIFY

SceneCode

String

No

The custom verification scenario ID that you can use to query related records in the console. The ID can be a combination of letters, digits, and underscores. The ID can be up to 10 characters in length.

1234567890

MerchantBizId

String

Yes

The custom business ID that is used to locate and troubleshoot issues. The ID can be a combination of letters and digits. The ID can be up to 32 characters in length. Make sure that the ID is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

Yes

The environment parameters of MetaInfo. You must obtain the parameters using the client SDK. For more information, see Android integration.

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

MerchantUserId

String

Yes

The custom user ID or other identifier that can identify a specific user, such as a mobile phone number or an email address. We strongly recommend that you desensitize the value of this parameter in advance, for example, by hashing the value.

123456789

FacePictureBase64

String

No

The Base64-encoded image. If you choose to use FacePictureBase64 to pass in the facial image, check the size of the image and avoid uploading an excessively large image.

/9j/4AAQSkZJRgABAQAASASBC****

FacePictureUrl

String

No

The URL of the facial image. The URL must be accessible over the Internet and start with HTTP or HTTPS.

https://cn-shanghai-aliyun-cloudauth-****.oss-cn-shanghai.aliyuncs.com/verify/****.jpeg

SecurityLevel

String

No

02

Model

String

No

PHOTINUS_LIVENESS

DocVideo

String

No

N

CallbackUrl

String

No

The callback URL for verification results. The default request method for callbacks is GET. 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 you set this parameter, the CallbackToken field is included in the callback request to the CallbackUrl.

NMjvQanQgplBSaEI0sL86WnQplB

AppQualityCheck

String

No

Specifies whether to enable strict facial quality detection.

• Y: Enable (default)

• N: Disable

N

Name

Type

Description

Example

HTTP Status Code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The ID of the request.

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

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********