Face Authentication Check
To run a Face Authentication Check, you must create a check with
type set to face_authentication_check.This check can only be performed on a client of type
person. Furthermore, the provided client must have been enrolled previously.Attribute | Type | Description |
clientId | string | The ID of the client associated with this check. (Required) |
livePhotoId | string | The ID of the live photo. (Required) |
cURL
Node.js
Python
PHP
.NET
curl -X POST https://api.complycube.com/v1/checks \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"CLIENT_ID",
"livePhotoId":"LIVE_PHOTO_ID",
"type": "face_authentication_check"
}'
const check = await complycube.check.create("CLIENT_ID", {
livePhotoId: "LIVE_PHOTO_ID",
type: "face_authentication_check"
});
check = cc_api.check.create('CLIENT_ID',
'face_authentication_check',
livePhotoId='LIVE_PHOTO_ID')
$result = $ccapi->checks()->create('CLIENT_ID',
['type' => 'face_authentication_check',
'livePhotoId' => 'LIVE_PHOTO_ID']);
var checkRequest = new CheckRequest
{
clientId = "CLIENT_ID",
livePhotoId = "LIVE_PHOTO_ID",
type = "face_authentication_check"
};
var check = await checkApi.CreateAsync(checkRequest);
The
result object is only returned when the status of the check is complete . It has two components - outcome and breakdown.The outcome attribute represents the overall check result. Returned values include:
- 1.
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. - 2.
attention: Indicates the face on the live photo does not match any of the client's previously enrolled faces, hence requiring attention.
The breakdown comprises the following objects:
The face authentication results. It has the following constituents:
facialSimilarity: 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.
{
"id": "6231d54079f59b1530fc76e3",
"entityName": "John Doe",
"type": "face_authentication_check",
"clientId": "6230d4ab58ed4a434afbf2cc",
"livePhotoId": "6231d137095afa000955ffc2",
"status": "complete",
"result": {
"outcome": "clear",
"breakdown": {
"faceAuthentication": {
"facialSimilarity": "clear",
"breakdown": {
"facesMatched": [
{
"livePhotoId": "6230d4f928e6ae00091747f9",
"facialSimilarityScore": 100
}
],
"enrolledFaces": {
"livePhotoIds": [
"6230d4f928e6ae00091747f9",
"6230d4f928e6ae00091747fa"
]
}
}
}
}
},
"updatedAt": "2022-03-01T12:17:06.046Z",
"createdAt": "2022-03-01T12:17:04.809Z"
}
Last modified 2mo ago