/register_face

Create a new user in our database

Endpoint

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

Purpose

Allows you to connect to the Liveness service, using the provider configured in the Progeny Console, to register a face image in database.

If the image passes the liveness check, the result is a UUID.

If the image does not contain a face, only contains a partial face, or if the quality of the image is too low, we will return an error code, for example FACE_TOO_SMALL . See our image requirements above for more information.

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/register_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
extend_data	Boolean	Set to true to retrieve the original response from the 3rd-party provider of the Liveness service

200: OK Success

{
    "id": "58bf8a18-b10b-409d-91d6-fdd358408dff"
}

400: Bad Request Image is missing or not in the correct format

    "image": [
        "The submitted data was not a file. Check the encoding type on the form."
    ]
}

Get UUID

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": 2170,
    "status": "SUCCESS",
    "result": {
        "status": 200,
        "data": {
            "uuid": "d3da2b7a-b062-11ec-b3b9-0242ac190002"
        }
    }
}

400: Bad Request Image does not meet requirements

{
    "id": 2165,
    "status": "SUCCESS",
    "result": {
        "data": {
            "liveness": {
                "result": false,
                "error": "Interpupillary distance is too small",
                "error_code": "FACE_TOO_SMALL"
            }
        },
        "status": 400,
        "issues": {
            "FACE_TOO_SMALL": "Interpupillary distance is too small"
        }
    }
}