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

Name

Type

Description

Example

faceImg

String

The captured face image in Base64 format. This field is returned if you set IsReturnImage to Y in the request and the face scan is completed.

Base64 format

faceAttack

String

Indicates whether a liveness attack was detected on the captured face.

• Y: An attack was detected.

• N: Not applicable

N

docVideoUrl

String

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

faceAge

String

The predicted reference age based on the face image. This field may not be returned if the prediction fails.

30

faceGender

String

The predicted gender based on the face image. This field may not be returned if the prediction fails.

• M: Male

• F: Female

M

faceAttackScore

Double

The probability of a spoofing attack predicted by the facial recognition algorithm. A higher score indicates a higher probability of a spoofing attack.

The value ranges from 0 to 100.

80

guardRiskScore

Double

The probability of device risk predicted by the Face-Guard algorithm. A higher score indicates a higher device risk.

The value ranges from 0 to 100.

90

faceComparisonScore

Double

The score of the face comparison. This field is returned only when the authentication includes a verification pattern.

The value ranges from 0 to 100. The default system threshold is 90. You can also customize the decision as needed.

90

faceRegistrationResult

String

Indicates whether the face registration was successful.

• 1: Successful

• 0: Failed

1

faceRegistrationID

String

The ID of the face registration.

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

f5a9219aefd6*******c84c8f0ca592a

duplicateFace

String

Information about duplicate faces.

If a duplicate face is retrieved, the ID of the corresponding face in the face database is returned.

[
  {
    "faceGroupCode": "sg7****uzt",
    "faceId": "f5a921*******9e792ec84c8f0ca592a"
  }
]