Certiface Risk Detection
O Certiface Risk Detection é um novo endpoint destinado à verificação de restrições associadas a um usuário a partir do envio de Selfie e CPF.
Sumário
- Visão Geral
- Endpoint
- Ambientes
- Autenticação
- Parâmetros da Requisição
- Estrutura da Resposta
- Códigos de Retorno
Visão Geral
O serviço realiza a consulta de similares restritos e retorna exclusivamente um valor booleano indicando a presença ou ausência de restrição.
0 – Nada consta
1 – Possui restrição
A integração mantém compatibilidade com o padrão já utilizado no Certiface WS, permitindo reaproveitamento do fluxo atual de autenticação e tratamento de erros.
Endpoint
POST /certiface/risk-detectionAmbientes
| Ambiente | URL |
|---|---|
| Homologação (HML) | https://hml.certiface.com.br/CertiFaceWS/rs/certiface/risk-detection |
| Produção (PROD) | https://www.certiface.com.br/CertiFaceWS/rs/certiface/risk-detection |
Autenticação
Atenção especial ao cabeçalho da requisição, header Authorization:
• Este header é composto do login do usuário, hash de autorização e data/hora de expiração (separados pelo caractere “;”). • A data e hora de expiração são retornados pelo método Autorização. • O hash de autorização deve ser gerado utilizando o algoritmo SHA256 a partir do tipo do método (POST) + URL + data_e_hora_de_expiração como texto base e o token criptográfico gerado no método Autorização como chave. • Durante o processo de criação da chave é necessário alterar o método para cada endpoint utilizado:
POST /certiface/risk-detectionParâmetros da Requisição
O endpoint recebe:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cpf | string | Sim | CPF do usuário (apenas números) |
| selfie | file/base64 | Sim | Imagem da selfie do usuário |
| nome | string | Opcional | nome do usuário |
| nascimento | string | Opcional | data de nascimento |
Estrutura da Resposta
A resposta retorna um objeto contendo o resultado da análise.
{
"certifaceID": {
"codigo": 200,
"consta_restricao": false,
"protocolo": "10260001638300"
}
}Campos
| Campo | Tipo | Descrição |
|---|---|---|
| codigo | integer | Código de retorno da operação |
| consta_restricao | boolean | Indica se foi encontrada restrição |
| protocolo | string | Identificador da transação para rastreabilidade |
Interpretação do campo
consta_restricao
Valor Significado false Nenhuma restrição encontrada true Restrição encontrada na base
Códigos de Retorno
| Código | Descrição |
|---|---|
| 200 | Transação efetuada com sucesso |
| 401 | Erro de imagem recusada (face não encontrada ou erro de qualidade da imagem) |
| 501 | Erro interno, falha ao processar transação |
Updated about 16 hours ago
