Face Authentication Check

What kind of data I will get

The Face Authentication Check service provided by ComplyCube allows businesses to authenticate the identity of their users through advanced facial recognition technology. This service is designed to improve security and streamline the authentication process by matching a person's face against previously registered biometric data.

To utilize the Face Authentication Check, the customer must have successfully passed a check that required providing photo of the person.

One key advantage of the Face Authentication Check is that it does not require the customer to provide their ID again. The system utilizes the image captured during the initial Identity Check for comparison purposes.

Input

Field	Description	Type	Required
clientId	Id of the client that successfully passed other identity confirming check	string	Yes

Input Example

{
    "clientId": "6230d4ab58ed4a434afbf2cc"
}

Output

Attribute	Type	Description
id	String	Unique identifier for the main entity
entityName	String	Name of the entity being processed
type	String	Type of the operation (e.g., face_authentication_check)
clientId	String	Unique identifier for the client
livePhotoId	String	Identifier for the live photo used in the authentication
status	String	Current status of the process (e.g., complete)
result	Object	Object containing detailed result data
updatedAt	String	Timestamp of the last update
createdAt	String	Timestamp of when the entity was created

Result

Attribute	Type	Description
outcome	String	Final outcome of the authentication (e.g., clear)
breakdown	Object	Object containing a detailed breakdown of the result

Breakdown

Attribute	Type	Description
faceAuthentication	Object	Object containing face authentication and similarity information

FaceAuthentication

Attribute	Type	Description
facialSimilarity	String	Similarity status of the face (e.g., clear)
breakdown	Object	Object containing detailed information on matches

SubBreakdown

Attribute	Type	Description
facesMatched	Array<Object>	List of objects containing facial match info
enrolledFaces	Object	Object containing information about enrolled faces

FaceMatch

Attribute	Type	Description
livePhotoId	String	Identifier for the matched live photo
facialSimilarityScore	Integer	Score indicating the similarity of the face match

EnrolledFaces

Attribute	Type	Description
livePhotoIds	Array<String>	List of identifiers for the enrolled faces

Output Example

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