/authenticate_face

Authorize an additional image against a user already registered in our database

Endpoint

https://be.progeny.tech/api/v3/services/authenticate_face/

Purpose

Allows you to connect to the Liveness and Face Compare services, using the providers configured in the Progeny Console, to authenticate an image of a person's face against the UUID of an already registered image in our database, performing both a liveness and likeness check.

Connecting to both services means we can determine whether the image is of a live human being and additionally that the image represents a likeness of the person already registered.

Please refer to the section on images for guidance before posting. For the best results, we recommend a maximum height of 1080px.

Sample request and response

Get a task Id

POST https://be.progeny.tech/api/v3/services/authenticate_face/

Request Body

Name	Type	Description
image*	String	The file path to an image of the user's face in PNG, JPEG, or JPG file format
uuid*	String	The universally unique identifier of the registered user you want to authorize the image against. See /register_face
extend_data	String	Set to true to retrieve the original response from the 3rd-party providers of Liveness and Face Compare services

400: Bad Request Bad request

{
    "image": [
        "The submitted data was not a file. Check the encoding type on the form."
    ],
    "uuid": [
        "This field is required."
    ]
}

200: OK Success

{
    "id": "d48eac86-228e-4933-a01d-279886a9c6b5"
}

Authorize an additional image

GET https://be.progeny.tech/api/v3/services/task/?id={{task_id}}

Path Parameters

Name	Type	Description
id*	String	The task Id you obtained from your POST request

200: OK Success

{
    "id": 2172,
    "status": "SUCCESS",
    "result": {
        "status": 200,
        "data": {
            "authentication": {
                "result": true,
                "data": {
                    "matchScore": "20.0",
                    "scorePercent": "100.0"
                }
            },
            "liveness": {
                "data": {
                    "score": 2.5943651,
                    "quality": 0.8175214,
                    "probability": 0.930498
                },
                "result": true
            }
        }
    }
}