Validation

Para a execução da validação por reconhecimento facial de um cliente é necessário enviar uma foto de rosto junto do CPF de um cliente cadastrado.

A partir dai, o registro desse usuário será buscado no sistema para, então, realizar uma validação 1:1 entre uma foto do cliente guardada no banco de dados e a imagem enviada.

Definição do Objeto

Request Body

{
    "validation_key": "ee37510e-4dfe-4b9c-b1f4-667288de2190",
    "document_number": "123.456.789-00",
    "image": {
        "image_key": "f1c0d2e1-f950-4360-896d-36588e443fc9",
        "file_size": 47407,
        "width_px": 0,
        "height_px": 0,
        "created_at": "2020-07-29T18:40:57Z",
    },
    "registration": {
        "registration_key": "903dcb34-2970-4ddf-add5-87463ba51d99",
        "registration_status": "authentic",
        "registration_date": "2020-07-29T18:40:57Z"
        },
    "similarity_ratio": "99",
    "validation_result": "pass",
    "validation_date": "2020-07-29T18:40:57Z"
}   

Todas as validações de cliente através de reconhecimento facial gerarão um objeto Validation. Caso desejado, este objeto poderá ser recuperado futuramente através do endpoint apropriado.

nome	tipo	descrição
validation_key	string	Chave do objeto Validation
document_number	string	CPF do cliente
image	image	Objeto que carrega as propriedades da imagem enviada na validação
registration	registration	Objeto que carrega as propriedades do registro que está sendo usado como referência na validação
similarity_ratio	integer	Razão de similaridade entre a imagem cadastrada e a imagem enviada
validation_result	string	Resultado da análise 1:1 realizada
validation_date	datetime	Data de realização da validação por reconhecimento facial em UTC

Criação de Validation

Request Body: Envio simultâneo de imagem (Base64)

{
    "document_number": "123.456.789-00",
    "image": "base_64_image_code",
}

Request Body: Envio antecipado da imagem

{
    "document_number": "123.456.789-00",
    "image_key": "f1c0d2e1-f950-4360-896d-36588e443fc9",
}

Assim como no cadastro, também são aceitos dois formatos de JSON, um contendo o Base64 da imagem e outro contendo a image_key recebida no momento do envio da imagem pelo endpoint /image.

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

Após o envio, será retornado um objeto JSON contendo o resultado da análise juntamente da UUID que aponta para a imagem que foi enviada.

Atenção - Ao efetuar o envio simultâneo da imagem com a realização da validação por reconhecimento facial, esta será submetida aos mesmos testes de qualidade executados quando a imagem é enviada pelo endpoint /image. Assim, a imagem enviada está sujeita as mesmas regras descritas na sessão Imagem desta documentação.

Dinamica dos Status - validation_result

Após executada a análise será enviada o resultado da análise sob a flag validation_result. Os resultados possíveis são:

Resultado	Descrição
match	Foto enviada corresponde ao usuário cadastrado
mismatch	Foto enviada não corresponde ao usuário cadastrado

Recuperação de objeto

Response Body

{
    "validation_key": "ee37510e-4dfe-4b9c-b1f4-667288de2190",
    "document_number": "123.456.789-00",
    "validation_image": {
        "image_key": "f1c0d2e1-f950-4360-896d-36588e443fc9",
        "file_size": 47407,
        "width_px": 0,
        "height_px": 0,
        "created_at": "2020-07-29T18:40:57Z",
    },
    "registration": {
        "registration_key": "903dcb34-2970-4ddf-add5-87463ba51d99",
        "registration_status": "authentic",
        "registration_date": "2020-07-29T18:40:57Z"
        },
    "similarity_ratio": "99",
    "validation_result": "pass",
    "validation_date": "2020-07-29T18:40:57Z"
}   

Em qualquer momento os dados de uma validação poderão ser recuperados através de uma requisição GET ao endpoint:

https://api.caas.qitech.app/face_recognition/validation/{validation_key}