API Docs

Create Face

Use this to record face data and vectors.

POST /api/face

Payload

{
    "external_id": "yourID",
    "name":"John Doe",
    "url_face":"https://fg.losimg/face.jpg"
    "base64_face":"iVBORw0KGgoAAAANSUhEU..."
}

external_id: Your unique ID varchar *
base64_face: Base64 processed image base64 *
url_face: Image URL URL
name / email / phone / document / company / company_document / country / city / address (All fields are varchar)

ATTENTION: The {url_face} field will only be mandatory if the {base64_face} field has not been submitted. It is the customer's choice.

201 Response

[
    {
        "reference_id": "OerdBon6i123q4k8",
        "message": "Face created"
    },
    {
        "reference_id": "CGTzBon6ijG7q4k1",
        "message": "Face created"
    }
]

ATTENTION: The {reference_id} field is unique and should be used to UPDATE and DELETE registered faces.

403 Response - The external_id field is unique per project.

{
    "message": "EXTERNAL ID already registered previously"
}

403 Response - You have reached the limit of registered faces for your subscription.

{
    "message": "Limit of faces reached"
}

403 Response - There are no faces in the image sent.

{
    "message": "Face not detected"
}

400 Response - Any other validation error.

{
    "message": "Validation errors"
}