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

  1. Visão Geral
  2. Endpoint
  3. Ambientes
  4. Autenticação
  5. Parâmetros da Requisição
  6. Estrutura da Resposta
  7. 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-detection

Ambientes


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-detection

Parâmetros da Requisição

O endpoint recebe:

CampoTipoObrigatórioDescrição
cpfstringSimCPF do usuário (apenas números)
selfiefile/base64SimImagem da selfie do usuário
nomestringOpcionalnome do usuário
nascimentostringOpcionaldata 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

CampoTipoDescrição
codigointegerCódigo de retorno da operação
consta_restricaobooleanIndica se foi encontrada restrição
protocolostringIdentificador da transação para rastreabilidade
📌

Interpretação do campo consta_restricao

ValorSignificado
falseNenhuma restrição encontrada
trueRestrição encontrada na base

Códigos de Retorno

CódigoDescrição
200Transação efetuada com sucesso
401Erro de imagem recusada (face não encontrada ou erro de qualidade da imagem)
501Erro interno, falha ao processar transação