> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# CPF Brasil: correspondência facial (Datavalid) API

> Consulta em base de dados oficial do Brasil com correspondência facial via Didit. A partir de $0.45 por chamada, sem contratos nem mínimos.

SERPRO Datavalid v4 pf-facial: valida o CPF (obrigatório) junto da Receita Federal e compara a selfie ao vivo (obrigatória) com o retrato da CNH guardado na Senatran. Opcionalmente, verifica o nome e a data de nascimento. A Didit disponibiliza este serviço através de `POST /v3/database-validation/`, para que possa confrontar os dados submetidos com a fonte oficial e receber resultados de correspondência normalizados. Formato de entrada: `tax_number` aceita o CPF brasileiro (exatamente 11 dígitos).

## Cobertura

* **Cobertura:** \~50%
* **País:** Brasil
* **ID do serviço:** `bra_cpf_facial`
* **Domínio de dados:** Biométrico
* **Categoria:** NationalIDRegistry

Cerca de 50% dos adultos brasileiros: a etapa de correspondência facial depende do retrato da CNH guardado na Senatran, por isso só podem ser comparados os titulares de CNH.

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `tax_number` | Sim | `11111111111` |
| `selfie` | Sim | `@./selfie.jpg` |
| `first_name` | Não | `John` |
| `last_name` | Não | `Doe` |
| `date_of_birth` | Não | `1990-01-01` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `tax_number`, `selfie`
* **Entradas opcionais:** `first_name`, `last_name`, `date_of_birth`, `vendor_data`
* **Consentimento:** obrigatório
* **Disponibilidade no fluxo:** disponível no fluxo
* **Cobertura:** \~50%
* **Preço:** \$0.45 por consulta bem-sucedida

## Parâmetros do corpo

**issuing\_state** `string` *required* (default: BRA)

Código de país ISO 3166-1 alpha-3 para este serviço de base de dados.

Exemplo: `BRA`

**services** `string` *required* (default: bra\_cpf\_facial)

Matriz que contém o ID deste serviço. Fixar o serviço mantém o pedido limitado a esta base de dados exata.

Exemplo: `bra_cpf_facial`

**consent** `boolean` *required* (default: true)

Consentimento explícito do utilizador final para este serviço.

Exemplo: `true`

**tax\_number** `string` *required* (default: 11111111111)

Número de identificação fiscal.

Exemplo: `11111111111`

**selfie** `file` *required*

Ficheiro de imagem da selfie a carregar para a validação biométrica em base de dados. Formatos aceites: JPEG, PNG ou WebP.

Exemplo: `@./selfie.jpg`

**first\_name** `string`

Nome próprio a validar.

Exemplo: `John`

**last\_name** `string`

Apelido a validar.

Exemplo: `Doe`

**date\_of\_birth** `string`

Data de nascimento no formato `YYYY-MM-DD`.

Exemplo: `1990-01-01`

**vendor\_data** `string` (default: user-1234)

A sua referência estável de utilizador para esta pessoa, como o ID interno do seu utilizador. A Didit usa-a para associar verificações independentes ao mesmo utilizador final e reduzir o ruído na deteção de duplicados.

Exemplo: `user-1234`

## Regras de entrada e notas de validação

* CPF brasileiro (exatamente 11 dígitos)
* `tax_number` deve conter apenas dígitos; remova espaços, hífens e pontuação antes de enviar o pedido.
* `tax_number` deve ter exatamente 11 caracteres.

## Como chamar

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=BRA" \
  -F "services=bra_cpf_facial" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "tax_number=11111111111" \
  -F "selfie=@./selfie.jpg"
```

```python Python theme={null}
from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="BRA",
    services=["bra_cpf_facial"],
    consent=True,
    tax_number="11111111111",
    vendor_data="user-1234",
    selfie=open("selfie.jpg", "rb"),
)
print(result)
```

```javascript Node.js theme={null}
import Didit, { fileFromPath } from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "BRA",
  services: ["bra_cpf_facial"],
  consent: true,
  tax_number: "11111111111",
  vendor_data: "user-1234",
  selfie: await fileFromPath("selfie.jpg"),
});
console.log(result);
```

```go Go theme={null}
ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{
	IssuingState: "BRA",
	Services:     didit.Some([]string{"bra_cpf_facial"}),
	Consent:      didit.Bool(true),
	TaxNumber:    didit.String("11111111111"),
	VendorData:   didit.String("user-1234"),
	Selfie:       didit.Some(didit.FileFromPath("selfie.jpg")),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.nio.file.Path;
import java.util.List;
import me.didit.Didit;
import me.didit.types.DatabaseValidationValidateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()
        .issuingState("BRA")
        .services(List.of("bra_cpf_facial"))
        .consent(true)
        .taxNumber("11111111111")
        .vendorData("user-1234")
        .selfie(Path.of("selfie.jpg"))
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'BRA',
    'services' => ['bra_cpf_facial'],
    'consent' => true,
    'tax_number' => '11111111111',
    'vendor_data' => 'user-1234',
    'selfie' => File::fromPath('selfie.jpg'),
]);
print_r($result->toArray());
```

```ruby Ruby theme={null}
require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.database_validation.validate(
  issuing_state: "BRA",
  services: ["bra_cpf_facial"],
  consent: true,
  tax_number: "11111111111",
  vendor_data: "user-1234",
  selfie: Pathname("selfie.jpg")
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "BRA",
    Services = new string[] { "bra_cpf_facial" },
    Consent = true,
    TaxNumber = "11111111111",
    VendorData = "user-1234",
    Selfie = FileUpload.FromPath("selfie.jpg"),
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Cada chamada bem-sucedida devolve HTTP `200`. O campo **`outcome_code`** indica o que aconteceu de facto, distinguindo, por exemplo, uma discrepância biométrica real (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` apresentado é o estado predefinido da funcionalidade; as suas [ações configuradas para Correspondência parcial e Sem correspondência](https://docs.didit.me/pt/core-technology/database-validation/database-validation-warnings.md) podem substituí-lo.

**`MATCH`**: O registo confirmou a identidade e todos os campos verificados correspondem.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "bra_cpf_facial",
      "service_name": "Brazil - CPF + face match (Datavalid)",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "face_match_probability": "Altíssima probabilidade",
        "face_match_score": "0.990",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "name_match_score": "1.000",
        "verifications": {
          "identification_number": true
        }
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: O registo não devolveu qualquer correspondência para os dados submetidos.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "BRA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "bra_cpf_facial",
      "service_name": "Brazil - CPF + face match (Datavalid)",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`BIOMETRIC_NO_MATCH`**: A pontuação de correspondência facial ficou abaixo do limiar de aceitação; a selfie não é da mesma pessoa que a fotografia do registo.

```json 200 OK — BIOMETRIC_NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "BRA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_NO_MATCH",
      "service_id": "bra_cpf_facial",
      "service_name": "Brazil - CPF + face match (Datavalid)",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`BIOMETRIC_IMAGE_UNUSABLE`**: A selfie não pôde ser processada (vazia, sem rosto, de qualidade insuficiente, ou o registo não a conseguiu ler). Peça ao utilizador que tire uma nova selfie.

```json 200 OK — BIOMETRIC_IMAGE_UNUSABLE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "BRA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_IMAGE_UNUSABLE",
      "service_id": "bra_cpf_facial",
      "service_name": "Brazil - CPF + face match (Datavalid)",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`INCONCLUSIVE`**: O registo confirmou o CPF (e o nome e a data de nascimento que enviou), mas não foi possível comparar o rosto: não existe fotografia de referência associada a este CPF, ou a selfie não pôde ser utilizada (rosto não encontrado, tamanho de imagem incorreto, qualidade insuficiente ou mais de um rosto). Os campos confirmados mantêm-se em `validation`, pelo que `match_type` os reflete, mas a verificação facial obrigatória fica por resolver e o processo é enviado para revisão. Peça uma nova selfie ou recorra à verificação de documento para pessoas sem fotografia registada.

```json 200 OK — INCONCLUSIVE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "BRA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "INCONCLUSIVE",
      "service_id": "bra_cpf_facial",
      "service_name": "Brazil - CPF + face match (Datavalid)",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "name_match_score": "1.000"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
```

## Dados devolvidos

Os campos exatos apresentados em `source_data` dependem do que o registo devolver. O exemplo gerado para `bra_cpf_facial` documenta atualmente esta forma normalizada:

* `date_of_birth`
* `first_name`
* `identification_number`
* `last_name`
* `name_match_score`

## Preços e SLAs

Brasil: as consultas de CPF + correspondência facial (Datavalid) são faturadas apenas quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.45 USD.
* **Faturação:** por consulta bem-sucedida. Não é cobrado quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
* **Latência:** p95 típico \< 2 s.
* **Disponibilidade:** 99.9% por trimestre do lado da Didit; a disponibilidade das fontes a jusante varia consoante o país e o conjunto de dados.

## Sobre esta fonte

Esta é a fonte oficial do governo: o [SERPRO](https://www.serpro.gov.br) Datavalid, operado pelo serviço federal brasileiro de processamento de dados. O CPF é verificado junto da Receita Federal, e a selfie é comparada com o retrato associado a essa pessoa na Senatran, o registo nacional de cartas de condução.

Como o retrato provém do registo da CNH (carta de condução), só as pessoas que possuem uma CNH têm uma imagem facial registada. É isso que limita a cobertura a cerca de 50% da população adulta: os dados são oficiais, mas não estão disponíveis para todos os brasileiros que nunca tiveram carta de condução.

**Precisa de uma cobertura mais ampla?** Use a [BRA - Unico IDCloud (CPF + selfie)](https://docs.didit.me/pt/api-reference/database-validation/brazil/unico-idcloud.md). Chega a cerca de 96% dos adultos brasileiros através do registo biométrico privado da Unico, e custa \$0.20, contra \$0.45 aqui. Escolha o Datavalid quando precisar especificamente do registo governamental como fonte de referência; escolha o IDCloud quando precisar de verificar todos.

## Continuar a ler

* [Visão geral da validação de base de dados no Brasil](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [Visão geral da validação de base de dados](https://docs.didit.me/pt/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/pt/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.