---
updatedAt: 2026-03-17T12:24:26.000Z
agentTools:
  projectIndex: https://devcenter.certiface.io/llms.txt
---

# 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]()

<br />

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

```http
 POST /certiface/risk-detection
```

***

## Ambientes

| 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

<Callout icon="❗️" theme="error">
  **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:
</Callout>

```http
POST /certiface/risk-detection
```

***

## Parâ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.

```json
{
  "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 |

<Callout icon="📌" theme="default">
  **Interpretação do campo `consta_restricao`**

  | Valor | Significado                  |
  | ----- | ---------------------------- |
  | false | Nenhuma restrição encontrada |
  | true  | Restrição encontrada na base |
</Callout>

***

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

***

<br />