ID Verification:FACE_LIVENESS_MIN

Name

Type

Required

Description

Example

ProductCode

String

Yes

The product solution to use. Set the value to FACE_LIVENESS_MIN to use the passive liveness detection API.

FACE_LIVENESS_MIN

SceneCode

String

No

A custom authentication scenario ID. You can use this ID to query related records in the console. The ID can be up to 10 characters in length and can contain letters, digits, and underscores (_).

1234567890

MerchantBizId

String

Yes

A custom unique business identifier. You can use this identifier to track and troubleshoot issues. The identifier can be up to 32 characters in length and can contain letters and digits. Make sure the identifier is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

String

Yes

A custom user ID or another identifier for a specific user, such as a mobile number or email address. For security, desensitize this value in advance, for example, by hashing it.

123456789

FacePictureBase64

String

Yes

The Base64-encoded image. If you use this parameter to pass the facial image, check the image size. Do not pass an oversized image.

base64

FacePictureUrl

String

Yes

The URL of the portrait image. The URL must be an HTTP or HTTPS link accessible over the Internet.

https://***

FaceQuality

String

No

Specifies whether to return the facial image quality score. The default value is F.

• T: Return.

• F: does not return the score.

F

Crop

String

No

Specifies whether to allow cropping of the facial image. The default value is F.

• T: Allow

• F: Forbidden

F

Occlusion

String

No

Specifies whether to enable occlusion detection. The default value is F.

• T: On.

• F: Disabled

F

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

Result.TransactionId

String

The unique ID for the entire authentication process.

hksb7ba1b28130d24e015d694361****

Code

String

The response code.

Success

Message

String

A detailed description of the response code.

Success

Result.Passed

String

The authentication result. Valid values:

• Y: The authentication is passed.

• N: The authentication is not passed.

Y

Result.SubCode

String

The code that corresponds to the verification result. For more information, see ResultObject.SubCode error codes.

200

Result.ExtFaceInfo

String

The results of the passive liveness detection. The value is in the JSON format. For more information, see ExtFaceInfo.

{
 "faceAttack": "N",
 "faceQualityScore": 88.62,
 "faceOcclusionResult": "N"
}