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

# API de validation en base de données Brésil (résidentiel)

> Validation en base de données officielle au Brésil avec Brazil Residential de Didit. Paiement à l'appel dès $0.59, sans contrat ni minimum.

Vérifie les données par rapport à une base de données combinée des inscriptions électorales. Didit expose ce service via `POST /v3/database-validation/` afin de vérifier les données soumises auprès de la source faisant autorité et de recevoir des résultats de correspondance normalisés. Format de saisie : `tax_number` accepte le CPF brésilien (exactement 11 chiffres).

## Couverture

* **Couverture :** \~ 95%
* **Pays :** Brésil
* **ID du service :** `bra_residential`
* **Domaine de données :** Adresse
* **Catégorie :** Résidentielle

## Données d'entrée

| Champ | Obligatoire | Exemple |
| - | -: | - |
| `first_name` | Oui | `John` |
| `last_name` | Oui | `Doe` |
| `date_of_birth` | Oui | `1990-01-01` |
| `address.street_1` | Oui | `123 Sample Street` |
| `address.postal_code` | Oui | `10001` |
| `tax_number` | Oui | `11111111111` |
| `address.street_2` | Non | `Unit 4` |
| `address.city` | Non | `Sample City` |
| `address.region` | Non | `Sample State` |
| `vendor_data` | Non | `user-1234` |

* **Données obligatoires :** `first_name`, `last_name`, `date_of_birth`, `address.street_1`, `address.postal_code`, `tax_number`
* **Données facultatives :** `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Consentement :** Non requis
* **Disponibilité dans le workflow :** Disponible dans le workflow
* **Couverture :** \~ 95%
* **Prix :** \$0.59 par requête réussie

Tous les documents acceptés par ce service ne contiennent pas l'identifiant par lequel il interroge la base. Lorsque cet identifiant n'est pas extrait du document, la vérification est enregistrée comme **non applicable** : aucune base de données n'est interrogée et vous n'êtes pas facturé. Pour certains pays, cela concerne une part importante des utilisateurs réels. Pour les couvrir, collectez aussi cet identifiant à partir d'une réponse à un Questionnaire, d'un champ d'extraction Document AI, ou d'une valeur que vous envoyez lors de la création de la session, puis mappez-le à l'étape de validation en base de données.

## Paramètres du corps de requête

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

Code pays ISO 3166-1 alpha-3 de ce service de base de données.

Exemple : `BRA`

**services** `string` *required* (default: bra\_residential)

Tableau contenant l'ID de ce service. Fixer le service limite la requête à cette base de données précise.

Exemple : `bra_residential`

**first\_name** `string` *required* (default: John)

Prénom à valider.

Exemple : `John`

**last\_name** `string` *required* (default: Doe)

Nom de famille à valider.

Exemple : `Doe`

**date\_of\_birth** `string` *required* (default: 1990-01-01)

Date de naissance au format `YYYY-MM-DD`.

Exemple : `1990-01-01`

**address** `object` *required* (default: \{"street\_1":"123 Sample Street","street\_2":"Unit 4","city":"Sample City","region":"Sample State","postal\_code":"10001","country":"US"})

Objet d'adresse résidentielle structuré. Utilisez `street_1`, `street_2`, `city`, `region`, `postal_code` et `country`. Une chaîne d'adresse complète au format ancien est toujours acceptée, mais déconseillée.

Exemple : `{"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}`

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

Numéro d'identification fiscale.

Exemple : `11111111111`

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

Votre référence utilisateur stable pour cette personne, par exemple votre identifiant utilisateur interne. Didit l'utilise pour relier les vérifications autonomes au même utilisateur final et réduire le bruit des détections de doublons.

Exemple : `user-1234`

## Règles de saisie et notes de validation

* CPF brésilien (exactement 11 chiffres)
* `tax_number` ne doit contenir que des chiffres ; supprimez les espaces, les tirets et la ponctuation avant d'envoyer la requête.
* `tax_number` doit comporter exactement 11 caractères.
* Pour les services fondés sur l'adresse, envoyez les champs d'adresse structurés plutôt qu'une chaîne `address` unique, lorsque c'est possible.
* `address.street_1` correspond à l'adresse de rue, y compris le numéro et le type de voie.
* `address.street_2` correspond à l'appartement, à l'unité, au bâtiment, à l'étage ou à toute ligne d'adresse supplémentaire. Ne l'envoyez que si vous la possédez.
* `address.city` correspond à la ville, à la banlieue, au district, à la localité ou au quartier.
* `address.region` correspond à l'État, à la province, à la région ou à la ville.
* `address.postal_code` correspond au code postal.
* Les services de base de données fondés sur l'adresse exigent au moins l'adresse de rue et le code postal ; les requêtes rejetées avant la consultation de la source ne sont pas facturées.

## Comment l'appeler

```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_residential" \
  -F "vendor_data=user-1234" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F 'address={"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}' \
  -F "tax_number=11111111111"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="BRA",
    services=["bra_residential"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    tax_number="11111111111",
    address={"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"},
    vendor_data="user-1234",
)
print(result)
```

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

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

const result = await didit.databaseValidation.validate({
  issuing_state: "BRA",
  services: ["bra_residential"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  tax_number: "11111111111",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  vendor_data: "user-1234",
});
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_residential"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	TaxNumber:    didit.String("11111111111"),
	Address:      didit.Some[any](map[string]any{"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"}),
	VendorData:   didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.time.LocalDate;
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_residential"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .taxNumber("11111111111")
        .address(DatabaseValidationValidateParams.Address.ofVariant1(DatabaseValidationValidateParams.Address.Variant1.builder()
                .street1("123 Sample Street")
                .street2("Unit 4")
                .city("Sample City")
                .region("Sample State")
                .postalCode("10001")
                .country("US")
                .build()))
        .vendorData("user-1234")
        .build());
System.out.println(result);
```

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

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'BRA',
    'services' => ['bra_residential'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'tax_number' => '11111111111',
    'address' => ['street_1' => '123 Sample Street', 'street_2' => 'Unit 4', 'city' => 'Sample City', 'region' => 'Sample State', 'postal_code' => '10001', 'country' => 'US'],
    'vendor_data' => 'user-1234',
]);
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_residential"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  tax_number: "11111111111",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  vendor_data: "user-1234"
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Collections.Generic;
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_residential" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    TaxNumber = "11111111111",
    Address = new Dictionary<string, object> { ["street_1"] = "123 Sample Street", ["street_2"] = "Unit 4", ["city"] = "Sample City", ["region"] = "Sample State", ["postal_code"] = "10001", ["country"] = "US" },
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Chaque appel réussi renvoie un code HTTP `200`. Le champ **`outcome_code`** indique ce qui s'est réellement passé, en distinguant par exemple une véritable non-correspondance biométrique (`BIOMETRIC_NO_MATCH`) d'un selfie impossible à lire (`BIOMETRIC_IMAGE_UNUSABLE`). Le `status` affiché est le statut par défaut de la fonctionnalité ; vos [actions « Partial Match » et « No Match » configurées](https://docs.didit.me/fr/core-technology/database-validation/database-validation-warnings.md) peuvent le remplacer.

**`MATCH`** : le registre a confirmé l'identité et chaque champ vérifié correspond.

```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_residential",
      "service_name": "Brazil Residential",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "date_of_birth": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`** : le numéro d'identification a été trouvé, mais un ou plusieurs champs personnels (généralement le nom ou la date de naissance) ne correspondent pas entièrement.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "BRA",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "bra_residential",
      "service_name": "Brazil Residential",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "date_of_birth": "full_match",
        "full_name": "no_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`** : le registre n'a renvoyé aucune correspondance pour les données soumises.

```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_residential",
      "service_name": "Brazil Residential",
      "source_data": {
        "address": "NO_MATCH",
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "address": "no_match",
        "date_of_birth": "no_match",
        "full_name": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Données renvoyées

Les champs exacts présents dans `source_data` dépendent de ce que renvoie le registre. L'exemple généré pour `bra_residential` documente actuellement cette structure normalisée :

* `address`
* `date_of_birth`
* `first_name`
* `identification_number`
* `last_name`

## Tarifs et SLA

Les requêtes Brazil Residential ne sont facturées que lorsque Didit reçoit un résultat concluant de la source de validation.

* **Prix par appel :** \$0.59 USD.
* **Facturation :** par requête réussie. Vous n'êtes pas facturé lorsque le registre est injoignable, lorsque des champs obligatoires sont manquants, ou lorsque la requête est rejetée avant d'atteindre la source.
* **Latence :** p95 typique \< 2 s.
* **Disponibilité :** 99.9% par trimestre côté Didit ; la disponibilité de la source en aval varie selon le pays et le jeu de données.

## Pour aller plus loin

* [Vue d'ensemble de la validation en base de données au Brésil](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [Vue d'ensemble de la validation en base de données](https://docs.didit.me/fr/core-technology/database-validation/overview.md)
* [Codes de résultat](https://docs.didit.me/fr/core-technology/database-validation/database-validation-outcome-codes.md)


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