> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/caf-api-pt-br/api-core/transaction-details/services/facial-biometrics.md).

# Biometria facial

Comparação da foto enviada com a foto em bases oficiais.

**Seção**: `officialData`

**Parâmetro obrigatório:** `cpf`\
**Arquivos obrigatórios:** `selfie ou imagem de documento contendo uma foto`

{% tabs %}
{% tab title="Esquema" %}

| Atributo      | Tipo   | Descrição                                                              |
| ------------- | ------ | ---------------------------------------------------------------------- |
| código        | String | Código de resposta                                                     |
| confiança     | Número | Percentual de similaridade da face do documento com a base oficial     |
| probabilidade | String | Probabilidade de autenticidade da face do documento com a base oficial |
| {% endtab %}  |        |                                                                        |

{% tab title="Exemplo" %}

```json
{
  "officialData": {
    "code": "01",
    "confidence": 0.9600528478622437,
    "probability": "Altíssima probabilidade"
  }
}
```

{% endtab %}

{% tab title="Valores possíveis" %}
**`código`**

| Código | Descrição                                                                                                                       |
| ------ | ------------------------------------------------------------------------------------------------------------------------------- |
| `01`   | Sucesso (comparação realizada). `confiança`, `confidenceStatus` e `probabilidade` são retornados apenas quando `código` é `01`. |
| `02`   | Atributo obrigatório não informado (ex.: CPF ausente)                                                                           |
| `03`   | Imagem/fonte não aplicável ao provedor (ex.: o provedor aceita apenas selfie)                                                   |
| `04`   | Face não encontrada nas bases oficiais do provedor                                                                              |
| `05`   | Erro de qualidade/tamanho da imagem ou falha na chamada ("face not found")                                                      |
| `06`   | CPF inválido (validado pelo próprio provedor)                                                                                   |
| `07`   | Erro genérico / falha na consulta (valor padrão)                                                                                |

**`probabilidade`**

Retornado apenas quando `código` é `01`.

| Valor (resposta da API)  | Descrição                |
| ------------------------ | ------------------------ |
| Baixíssima probabilidade | Baixíssima probabilidade |
| Baixa probabilidade      | Baixa probabilidade      |
| Média probabilidade      | Média probabilidade      |
| Alta probabilidade       | Alta probabilidade       |
| Altíssima probabilidade  | Altíssima probabilidade  |
| {% endtab %}             |                          |

{% tab title="Regras de Validação" %}

| Regra                                | Descrição                                                                                                                     |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| documento\_governamental\_disponivel | Verifica se o documento está disponível na base do Governo.                                                                   |
| documento\_governamental\_aprovado   | Verifica a autenticidade do documento na base do Governo.                                                                     |
| revisao\_manual\_de\_liveness        | Esta regra envia a selfie para verificação manual anti-spoofing.                                                              |
| biometria\_aprovada                  | Verifica se a similaridade da selfie encontrada na base está abaixo do limiar de confiança configurado no template do perfil. |
| {% endtab %}                         |                                                                                                                               |
| {% endtabs %}                        |                                                                                                                               |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.caf.io/caf-api/caf-api-pt-br/api-core/transaction-details/services/facial-biometrics.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.