Pular para o conteúdo principal

Registro de rosto (1:1)

A partir das versões Android v6.0.0 e iOS v7.0.0 das SDKs de Face Recognition, a utilização do número de documento não realiza mais um registro de rosto diretamente pela SDK.

Para realizar o registro de rosto (para posterior validação 1:1), é necessário utilizar os endpoints específicos da API de Face Recognition descritos nesta página.

Endpoints disponíveis​

Os recursos de registro de rosto estão expostos nas seguintes rotas:

MétodoEndpointDescrição
POST/face_recognition/registrationCria um novo registro de rosto
GET/face_recognition/registration/{registration_key}Recupera registro pela chave
GET/face_recognition/registration/document_number/{document_number}Recupera registro pelo número do documento

URL base (produção): https://api.caas.qitech.app
URL base (sandbox): https://api.sandbox.caas.qitech.app

Criação de um registro (POST)​

Para cadastrar o rosto de um cliente, envie uma requisição POST para:

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

O corpo da requisição deve conter o número do documento e a imagem do rosto, de uma das duas formas abaixo.

Opção 1: imagem via image_key (extraída da SDK)​

Utilize o image_key retornado pela SDK após a captura do rosto.

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

Opção 2: imagem em Base64​

Envie a imagem diretamente em Base64 (sem cabeçalhos ou metadados adicionais).

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

Campos do request​

nometipodescrição
document_numberstringNúmero do documento (ex.: CPF) do cliente
image_keystringChave da imagem retornada pela SDK (UUID). Use ou image_key ou image
imagestringImagem do rosto em Base64. Use ou image ou image_key
informação

É obrigatório enviar apenas um dos campos de imagem: image_key ou image. Não envie os dois no mesmo request.

Após o envio com sucesso, a API retorna apenas a chave do registro de rosto:

Response Body
{
    "registration_key": "chave_do_registro_do_rosto"
}

Recuperação de registro por chave (GET)​

Para obter a chave de um registro pela sua chave única:

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

Substitua {registration_key} pelo identificador retornado na criação do registro.

Response Body:

{
    "registration_key": "chave_do_registro_do_rosto"
}

Recuperação de registro por documento (GET)​

Para obter a chave de um registro pelo número do documento:

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

Substitua {document_number} pelo número do documento do cliente (ex.: CPF).

Response Body:

{
    "registration_key": "chave_do_registro_do_rosto"
}