> 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/connect/transactions/services/facial-biometrics.md).

# Biometria facial

Comparação da foto enviada com a foto nas 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 semelhança do rosto do documento com a base oficial       |
| probabilidade | String | Probabilidade de autenticidade do rosto 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 somente quando `código` é `01`. |
| `02`   | Atributo obrigatório não informado (ex.: CPF ausente)                                                                            |
| `03`   | Imagem/fonte não aplicável ao provedor (ex.: provedor aceita apenas selfie)                                                      |
| `04`   | Rosto não encontrado nos bancos de dados 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 somente quando `código` é `01`.

| Valor (resposta da API)  | Descrição                 |
| ------------------------ | ------------------------- |
| Baixíssima probabilidade | Probabilidade muito baixa |
| Baixa probabilidade      | Probabilidade baixa       |
| Probabilidade média      | Probabilidade média       |
| Alta probabilidade       | Probabilidade alta        |
| Altíssima probabilidade  | Probabilidade altíssima   |
| {% endtab %}             |                           |

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

| Regra                              | Descrição                                                                                                                   |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| documento governamental disponível | Verifica se o documento está disponível na base do Governo.                                                                 |
| documento governamental aprovado   | Verifica a autenticidade do documento com a base do Governo.                                                                |
| revisão manual do 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 limite de confiança configurado no modelo de 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.caf.io/caf-api/caf-api-pt-br/connect/transactions/services/facial-biometrics.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.