Documentation

FaceDetail

FaceDetail

Field

Description

faceResult

string:PASS or FAIL

faceImageFar

string,The far image of the face collected in the liveness detection.

When returnImageType is URL, this value is a link that will be expired in 1 day; if the link is expired ,you need to re query this endpoint to get a new link.

When returnImageType is Base64, this value is a Base64 encoded string of image bytes. Refer to livenessFlowCategory.

faceImageFarTime

long, The far image capture timestamp ( milliseconds)

faceImageNear

string,The near image of the face collected in the liveness detection.

When returnImageType is URL, this value is a link that will be expired in 1 day; if the link is expired ,you need to re query this endpoint to get a new link.

When returnImageType is Base64, this value is a Base64 encoded string of image bytes.
Refer to livenessFlowCategory.

faceImageNearTime

long, The near image capture timestamp ( milliseconds)

silentImage

string,The silent image of the face collected in the liveness detection.

When returnImageType is URL, this value is a link that will be expired in 1 day; if the link is expired ,you need to re query this endpoint to get a new link.

When returnImageType is Base64, this value is a Base64 encoded string of image bytes.
Refer to livenessFlowCategory.

silentImageTime

long, The silent image capture timestamp ( milliseconds)

auditImageUrl

string,The zip file that contains multi audit images. this link will be expired in 1 day; Tf the link is expired ,you need to re query this endpoint to get a new link.

faceLivenessScore

number,The score is for anti-spoofing, ranging from [0,100], less than 50 means it might be an attack.

livenessAttackType

number,the attachType when faceLivenessScore is less than 50.
Refer to livenessAttackType.

livenessType

string, the livenessType that is used in liveness. Refer to Liveness Type List.

livenessFlowCategory

string, the category of the capture flow that is used in liveness. the capture flow is under the livenessType. Refer to livenessFlowCategory.

faceSimilarityScore

number,Face similarity rate between the document image and liveness, the rate value is always between the number 0-100. less than 70 means the two faces may not be similar.

**Note: ** for Liveness Detection, it always return null .

eventDetails

array, Event details.

faceResult

Value

Description

PASS

**IDV/FA: **faceLivenessScore >= 50 and faceSimilarityScore >= 70.

**LD: **faceLivenessScore >= 50.

FAIL

**IDV/FA: **faceLivenessScore < 50 or faceSimilarityScore < 70.

**LD: **faceLivenessScore < 50.

livenessAttackType

ValueDescription
nullNot Attack. (Only when faceLivenessScore >= 50)
1Presentation Attack. (Only possible when faceLivenessScore < 50)
2Injection Attack. (Only possible when faceLivenessScore < 50)
3Unsure Attack. (Only possible when faceLivenessScore < 50)

eventDetails

ValueDescription
eventstring,Event name.
resultstring,Event result.
createTimestamplong,Millisecond timestamp.