Progeny Docs
Search…
/authorize
Authorize an additional image against a user already registered in our database

Endpoint

1
https://be.progeny.tech/api/v2/authorize
Copied!

Purpose

Allows you to authorize an additional image against a user already registered in our database, performing both a liveness and likeness check. In this way, 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.
If successful, the response will include the user's universally unique identifier uuid .

Sample request

1
curl 'https://be.progeny.tech/api/v2/authorize/'
2
-H 'Authorization: Bearer <access_token>'
3
-F image=@<image_name>
4
-F uuid=<uuid>
Copied!

Path parameters

Parameter
Required
Type
Comments
uuid
Yes
string
The universally unique identifier of the registered user you want to authorize the image against
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
"authorize" : true/false
true - the uploaded image matches the image held against the registered user
false - the uploaded image doesn't match the image held against the registered user

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 uuidand image parameters are present in the request
Check the syntax against the sample response
Bad params
The request did not include one of uuid or remote_user_id or the user does not exist in our database
Ensure the request includes a valid uuid
Bad face
The image in the request does not contain a face, contains a partial face, or the liveness probability is too low
See the section on images

Last modified 1yr ago
Copy link
Contents