/face_liveness

Perform a standalone liveness check against an image

Endpoint

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

Purpose

Allows you to connect to the Liveness service, using the provider configured in the Progeny Console, to perform a standalone liveness check against an image. If the image parameter is missing from the request, we will return Bad POST.

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/face_liveness/

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": "f22a63b1-7d05-4bf1-9633-a623a2799c22"
}

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

{
    "image": [
        "No file was submitted."
    ]
}

Perform a standalone liveness check

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": 2182,
    "status": "SUCCESS",
    "result": {
        "data": {
            "liveness": {
                "data": {
                    "score": 2.5943651,
                    "quality": 0.8175214,
                    "probability": 0.930498
                },
                "result": true
            }
        },
        "status": 200
    }
}

400: Bad Request Image does not meet requirements

{
    "id": 2183,
    "status": "SUCCESS",
    "result": {
        "data": {
            "liveness": {
                "result": false,
                "error": "Absolute face size is too small",
                "error_code": "FACE_TOO_SMALL"
            },
            "issues": {
                "liveness": {
                    "FACE_TOO_SMALL": "Absolute face size is too small"
                }
            }
        },
        "status": 400
    }
}