Skip to main content

Face Registration (1:1)

As of Android v6.0.0 and iOS v7.0.0 of the Face Recognition SDKs, using the document number no longer performs face registration directly through the SDK.

To perform face registration (for subsequent 1:1 validation), you must use the specific endpoints of the Face Recognition API described on this page.

Available endpoints​

Face registration resources are exposed at the following routes:

MethodEndpointDescription
POST/face_recognition/registrationCreates a new face registration
GET/face_recognition/registration/{registration_key}Retrieves registration by key
GET/face_recognition/registration/document_number/{document_number}Retrieves registration by document number

Base URL (production): https://api.caas.qitech.app
Base URL (sandbox): https://api.sandbox.caas.qitech.app

Creating a registration (POST)​

To register a client's face, send a POST request to:

https://api.caas.qitech.app/face_recognition/registration

The request body must contain the document number and the face image in one of the two formats below.

Option 1: image via image_key (from the SDK)​

Use the image_key returned by the SDK after face capture.

Request Body – image_key
{
    "document_number": "DOCUMENT_NUMBER",
    "image_key": "<IMAGE_KEY_FROM_SDK>"
}

Option 2: image as Base64​

Send the image directly as Base64 (no headers or additional metadata).

Request Body – image (Base64)
{
    "document_number": "DOCUMENT_NUMBER",
    "image": "<IMAGE_BASE64>"
}

Request fields​

nametypedescription
document_numberstringClient's document number (e.g. CPF)
image_keystringImage key returned by the SDK (UUID). Use either image_key or image
imagestringFace image in Base64. Use either image or image_key
info

You must send only one of the image fields: image_key or image. Do not send both in the same request.

On success, the API returns only the face registration key:

Response Body
{
    "registration_key": "face_registration_key"
}

Retrieving registration by key (GET)​

To get the registration key by its unique key:

https://api.caas.qitech.app/face_recognition/registration/{registration_key}

Replace {registration_key} with the identifier returned when creating the registration.

Response Body:

{
    "registration_key": "face_registration_key"
}

Retrieving registration by document (GET)​

To get the registration key by document number:

https://api.caas.qitech.app/face_recognition/registration/document_number/{document_number}

Replace {document_number} with the client's document number (e.g. CPF).

Response Body:

{
    "registration_key": "face_registration_key"
}