type
set to face_authentication_check
.person
. Furthermore, the provided client must have been enrolled previously.clientId
string
livePhotoId
string
result
object is only returned when the status of the check is complete
. It has two components - outcome
and breakdown
.clear
: Indicates the face on the provided live photo matches one of the client's previously enrolled faces, and hence the client's face authentication is successful.attention
: Indicates the face on the live photo does not match any of the client's previously enrolled faces, hence requiring attention.faceAuthentication
objectfacialSimilarity
: Indicates whether the face on the live photo matches a client's enrolled face.breakdown
: Breakdown related to face authentication.facesMatched
: If the live photo matches an enrolled face, this attribute will be returned. It contains the following:livePhotoId
: The ID of the live photo corresponding to the enrolled face that matched. liveVideoId
: The ID of the live video corresponding to the enrolled face that matched.facialSimilarityScore
: Indicates the similarity level of the face on the live photo provided against the enrolled face. The score will be 100 for a perfect match.enrolledFaces
: This contains details about previously enrolled faces for a given client. It comprises of the following: livePhotoIds
: An array of live photo IDs used for enrolling the client's face.liveVideoIds
: An array of live video IDs used for enrolling the client's face.