Esta API retorna informações de biometria facial associadas a um CPF informado. A resposta indica a existência de registros na base da Receita Federal e da CNH, além de fornecer dados sobre vivacidade, probabilidade e similaridade do reconhecimento facial quando disponível. Em casos de erro, são retornados códigos e mensagens descritivas do motivo da falha. Essa consulta é essencial para validação de identidade, prevenção a fraudes, autenticação em processos digitais, auditorias de conformidade, concessão de crédito e contratação de serviços que exigem verificação biométrica confiável.
TABELA DE CAMPOS PARA REQUISIÇÃO
| Campo | Descrição | Formato | Obrigatório (Sim / Não) |
|---|---|---|---|
| IdConsulta | 544 | string | Sim |
| Cpf | Documento | string | Sim |
| Vivacidade | Vivacidade | boolean | Sim |
| FormatoImagem | Extensão | string | Sim |
| Base64 | String base64 | string | Sim |
TABELA DE CAMPOS DE RETORNO
| Campo | Descrição | Formato |
|---|---|---|
| CONSULTA | Bloco com metadados da consulta. | object |
| CODIGORESPOSTA | Código de identificação da consulta. | string |
| DATAHORA | Data e hora em que a consulta foi realizada. | string |
| LOGON | Identificação do usuário que realizou a consulta. | string |
| IDCONSULTA | Identificador único da consulta. | integer |
| RESPOSTA | Bloco principal com os dados da resposta. | object |
| CODIGO | Código de status da resposta (1 para sucesso, 3 para erro). | integer |
| BIOMETRIAFACIAL | Bloco com os dados de biometria facial retornados na consulta. | object |
| RFB_EXISTE | Indica se existem dados vinculados à Receita Federal. | boolean |
| CNH_EXISTE | Indica se existem dados vinculados à base da CNH. | boolean |
| RFB | Lista de registros encontrados na Receita Federal. | object |
| CNH | Bloco com informações da CNH, incluindo endereços. | object |
| ENDERECO | Lista de endereços vinculados à CNH. | object |
| BIOMETRIA_FACIAL | Bloco com os dados da biometria facial analisada. | object |
| VIVACIDADE | Resultado do teste de vivacidade da biometria facial. | string |
| DISPONIVEL | Indica se o recurso de biometria facial estava disponível no momento. | boolean |
| PROBABILIDADE | Grau de probabilidade atribuído ao resultado da análise. | string |
| SIMILARIDADE | Percentual de similaridade entre a imagem enviada e o registro da base. | number |
| CODE | Código de erro retornado quando ocorre falha no processo de biometria. | string |
| MSG | Mensagem descritiva do erro ocorrido na análise biométrica. | string |
REQUISITOS TÉCNICOS PARA UTILIZAÇÃO DA API
Para garantir resultados confiáveis na checagem de vivacidade usando a API Datavalid, as imagens enviadas devem seguir os padrões abaixo:
1. Formato e Resolução
- Imagens em JPG ou PNG.
- Resolução recomendada: 720p (1280x720).
2. Captura em Tempo Real
- A imagem deve ser capturada diretamente pela câmera do dispositivo.
- Não é permitido upload de arquivos ou uso de câmeras virtuais/emuladas.
3. Segurança no Dispositivo
- Android: utilizar Google Play Integrity API.
- iOS: utilizar Apple App Attest.
4. Posicionamento do Rosto
- Rosto centralizado na imagem.
- Nem muito próximo, nem muito distante da câmera.
5. Qualidade da Imagem
- Fundo uniforme e sem distrações.
- Imagem nítida, sem desfoque.
- Exposição equilibrada (nem muito clara nem muito escura).
- Sem obstruções como máscara, óculos escuros, reflexos, cabelo ou chapéu cobrindo o rosto.
- Evitar pixelização (não usar imagens redimensionadas ou de baixa qualidade).
Essas orientações seguem os critérios do padrão ISO/IEC 19794 e aumentam a confiabilidade da checagem de vivacidade.