/register

Create a new user in our database

Endpoint

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

Purpose

Allows you to create a new user in our database. If the image is already bound to a registered user with a remote_user_id, the response is identical to the response returned for a new unregistered user.

For previously registered users, no database transactions occur.

If the image does not contain a face, only contains a partial face, or if the quality of the image is too low, the request will be unsuccessful, and we will return Bad face . 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

curl 'https://be.progeny.tech/api/v2/register/'
-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

"uuid": "b908e8e8-60e9-4c87-b8b7-b77198826bc6"

uuid for the registered user

"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 responses

Response

Description

Resolution

Bad POST

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

Check the request to make sure theimage parameter is present in the request

Check the syntax against the sample response

internal

An error was encountered during the facial recognition/liveness check

If the problem persists, please contact Progeny

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 above