ID Verification:CheckResult

Name

Type

Required

Description

Example

MerchantBizId

String

Yes

A unique identifier that you define for your business. Use it to locate and troubleshoot issues later. The value must be a combination of up to 32 letters and digits. Ensure uniqueness.

e0c34a77f5ac40a5aa5e6ed20c35****

TransactionId

String

Yes

hksb7ba1b28130d24e015d6********

IsReturnImage

String

No

Specify whether to return authentication images:

• Y: Required

• N: No (default)

Y

Name

Type

Description

Example

HTTP Status Code

Integer

The HTTP status code.

200

HTTP Body

RequestId

String

The request ID.

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

Code

String

Return to Code.

Success

Message

String

A detailed description of the returned code.

success

Result.Passed

String

The final authentication result. Valid values:

• Y: Passed

• N: Failed

Y

Result.SubCode

String

A description of the authentication result. For more information, see ResultObject.SubCode error codes.

200

Result.ExtFaceInfo

String

Results related to face liveness verification. For the JSON format, see the example on the right. For more information, see ExtFaceInfo.

{
  "faceAttack": "N",
  "faceImg": "/9j/4AAQSkZJRgABAQAAAQqviV6oakp8...",
  "docVideoUrl": "https://aliyun-cloudauth.oss-aliyuncs.com/******.webm" 
}

Parameter

Type

Description

Example value

faceImg

String

The captured face image in Base64 format. This field is returned if the isReturnImage=Y parameter is set in the API request and the face scanning process completes successfully.

Base64 format

faceAttack

String

Indicates whether a liveness attack was detected. Valid values:

• Y: Attack detected

• N: No attack detected

N

docVideoUrl

String

https://aliyun-cloudauth.oss-aliyuncs.com/******.webm

faceAge

String

The estimated age of the person. This field is omitted if the prediction fails.

30

faceGender

String

The predicted gender based on the face image. This field is omitted if the prediction fails. Valid values:

• M: Male

• F: Female

M

faceAttackScore

Double

The likelihood of a fake face attack, predicted by the face recognition algorithm. A higher score indicates a greater likelihood of such an attack.

The value ranges from 0 to 100.

80

guardRiskScore

Double

The likelihood of device risk, predicted by the Face Guard algorithm. A higher score indicates greater device risk.

The value ranges from 0 to 100.

90

faceComparisonScore

Double

The face comparison score. This field is returned only when verification mode is used.

The score ranges from 0 to 100. The system's default threshold is 90, but you can implement custom logic based on your business needs.

90

faceRegistrationResult

String

Indicates whether the face registration was successful. Valid values:

• 1: Success

• 0: Failure

1

faceRegistrationID

String

The face registration ID.

This field is returned only if automatic registration is enabled and the face registration is successful.

f5a9219aefd6*******c84c8f0ca592a

duplicateFace

String

Information about any duplicate faces detected.

If a duplicate face is found, this field contains the corresponding face ID, user ID, and comparison score from the face database.

[
  {
    "faceGroupCode": "sg7****uzt",
    "faceId": "f5a921*******9e792ec84c8f0ca592a"
    "merchantUserId":"face0005",
    "score":93.26
  }
]

deviceToken

String

The deviceToken for the Device Assistant. This field is returned when you fully integrate the Device Assistant module with the SDK. You can use this token to query the Device Assistant's server-side APIs to get device risk details.

• Device Assistant is a paid service. For more information, see product billing.

• This token is valid for 7 days and is not unique.

e0c34a77f5ac40a5aa5e6ed20c35****