ID Verification:CheckResult

Name

Type

Required

Description

Example

MerchantBizId

String

Yes

A unique business identifier that you customize for troubleshooting. It can be a combination of letters and digits up to 32 characters long. Make sure this identifier is unique.

e0c34a77f5ac40a5aa5e6ed20c35****

TransactionId

String

Yes

hksb7ba1b28130d24e015d6********

IsReturnImage

String

No

Specifies whether to return the authentication image materials.

• Y (Yes): 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

Back to Code

Success

Message

String

The detailed description of the response code.

success

Result.Passed

String

The final authentication result. Valid values:

• Y: Pass

• N: The authentication is not passed.

Y

Result.SubCode

String

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

200

Result.ExtFaceInfo

String

The result information for 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=Y in the request and the face scan is completed.

Base64 format

faceAttack

String

Indicates whether the captured face is involved in a liveness attack.

• Y: Attack detected

• N: Not applicable

N

docVideoUrl

String

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

faceAge

String

The reference age predicted from the face. The prediction may fail and this value may not be returned.

30

faceGender

String

The gender predicted from the face image. The prediction may fail and this value may not be returned.

• 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.

Value range: 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.

Value range: 0 to 100.

90

faceRegistrationResult

String

Indicates whether the face registration was successful:

• 1: Success

• 0: Failure

1

faceRegistrationID

String

The face registration ID.

This is returned only if you enable automatic registration and the face registration is successful.

f5a9219aefd6*******c84c8f0ca592a

duplicateFace

String

Information about a duplicate face.

If a duplicate face is found during a search, the corresponding Face ID and User ID from the face database are returned.

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