API Docs

Search Face

Search for registered faces by imagem.

POST /api/face/search

Payload

{
    "match_threshold": 75,
    "url_face":"https://fg.losimg/face.jpg"
    "base64_face":"iVBORw0KGgoAAAANSUhEU..."
}

match_threshold: integer *
base64_face: Base64 processed image base64 *
url_face: Image URL URL

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

200 Response

[
    {
        "reference_id": "s98U4V00OG80tE1p",
        "external_id": "yourID_1",
        "name": "John Doe",
        "email": null,
        "phone": null,
        "document": null,
        "company": null,
        "company_document": null,
        "country": null,
        "city": null,
        "address": null,
        "confidence": 99.9998779296875
    },
    {
        "reference_id": "79LXS44Nw4Jq5RBD",
        "external_id": "yourID_2",
        "name": "John Doe Son",
        "email": null,
        "phone": null,
        "document": null,
        "company": null,
        "company_document": null,
        "country": null,
        "city": null,
        "address": null,
        "confidence": 99.9998779296875
    }
]

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

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

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

{
    "message": "Error - Face Not Detected"
}

404 Response - No matching faces found.

{
    "message": "No matching faces found."
}