/liveness

Perform a standalone liveness check against an image

Endpoint

https://be.progeny.tech/api/v2/liveness

Purpose

Allows you 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

curl 'https://be.progeny.tech/api/v2/liveness/'
-H 'Authorization: Bearer <access_token>'
-F image=@<image_name>

Path parameters

Parameter

Required

Type

Comments

image

Yes

string

The file path to an image of the user's face in PNG, JPEG, or JPG file format

Successful response

Response

Description

"liveness": true/false

true - the uploaded image represents a live human being as opposed to a fake representation

false - the uploaded image represents a fake representation as opposed to a live human being

Unsuccessful response

Response

Description

Resolution

Bad POST

A required parameter is missing from the request or invalid parameter syntax

Check the request to make sure the image is present in the request

Check the syntax against the sample response

FACE_TOO_CLOSE

The subject's face is too close to the camera

Increase the distance between subject and camera

FACE_NOT_FOUND

A face or facial landmarks cannot be detected

See the section on images

FACE_TOO_SMALL

The face is not big enough for processing

See the section on images Face size should be no lower than 224 pixels

FACE_ANGLE_TOO_LARGE

Face pitch and yaw angle too large

See the section on images

Pitch and yaw angle should be between -25 and 25 degrees

FAILED_TO_READ_IMAGE

File decoding error

See the section on images

Image should be in PNG, JPEG, or JPG file format