Esta API realiza uma verificação facial vinculada a um documento (somente CPF) informado na requisição. A partir da imagem enviada em Base64, o serviço executa uma validação biométrica e retorna informações sobre o resultado da comparação, incluindo o status da análise, o código de validação, o nível de similaridade e indicadores de aprovação. Também são devolvidos dados operacionais da consulta, como horário, protocolo e código de resposta. Ela é útil para processos que exigem confirmação de identidade, prevenção a fraudes, onboarding digital e validação segura de usuários em fluxos de alto risco.
TABELA DE CAMPOS PARA REQUISIÇÃO
| Campo | Descrição | Formato | Obrigatório (Sim / Não) |
|---|---|---|---|
| IdConsulta | Identificador da consulta | string | Sim |
| CpfCnpj | Documento CPF | string | Sim |
| Nome | Nome completo | string | Não |
| DataNascimento | Data de nascimento | string | Não |
| Base64Face | Imagem facial codificada | string | Não |
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 da consulta. | string |
| LOGON | Código do usuário. | string |
| IDCONSULTA | Identificador único da consulta. | string |
| RESPOSTA | Bloco principal com os dados da resposta. | object |
| CODIGO | Código de status da resposta. | string |
| VALIDACAO_BIOMETRICA_FACIAL | Bloco com os dados da validação biométrica. | object |
| DOCUMENTO | Documento analisado na validação. | string |
| CODIGO_BIOMETRICO | Código do resultado biométrico. | string |
| DESCRICAO_STATUS | Descrição do status da validação. | string |
| APROVADO | Indica se a validação foi aprovada. | string |
| CONHECIDO | Indica se o rosto é reconhecido na base. | string |
| PROTOCOLO | Protocolo da transação biométrica. | string |
| SCORE_BIOMETRICO | Índice de similaridade biológica. | string |
REQUISITOS DA IMAGEM PARA VALIDAÇÃO FACIAL
Para que a validação biométrica facial seja processada corretamente, a imagem enviada deve atender aos seguintes requisitos técnicos:
• Resolução mínima: VGA ou superior (mínimo de 640×480 pixels).
• Tamanho máximo do arquivo: A imagem deve possuir menos de 1 MB.
• Formato obrigatório: Apenas imagens nos formatos JPG ou JPEG são aceitas.
O não atendimento a qualquer um desses critérios pode resultar em falha na validação biométrica ou retorno de código indicando qualidade insuficiente da imagem.
TABELA DE CÓDIGOS BIOMÉTRICOS
| Código | Descrição |
|---|---|
| 201 | Cadastro com sucesso. |
| 202 | Cadastro com pendencia. |
| 203 | Certificacao positiva. |
| 204 | Certificacao negativa. |
| 401 | Falha na qualidade da imagem/face. |
| 402 | Cadastro desabilitado. |
| 500 | Erro interno. |
| 501 | Falha ao cadastrar. |