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

# Validació en bases de dades del Brasil: API residencial

> Validació residencial autoritzada al Brasil amb la infraestructura d'identitat de Didit. Des de $0.59 per crida, sense contractes ni mínims.

Verifica contra una base de dades combinada de registres electorals. Didit ofereix aquest servei a través de `POST /v3/database-validation/` perquè puguis verificar les dades enviades contra la font autoritzada i rebre resultats de coincidència normalitzats. Format d'entrada: `tax_number` accepta el CPF brasiler (exactament 11 dígits).

## Cobertura

* **Cobertura:** \~ 95%
* **País:** Brasil
* **ID del servei:** `bra_residential`
* **Domini de dades:** Adreça
* **Categoria:** Residencial

## Entrades

| Camp | Obligatori | Exemple |
| - | -: | - |
| `first_name` | Sí | `John` |
| `last_name` | Sí | `Doe` |
| `date_of_birth` | Sí | `1990-01-01` |
| `address.street_1` | Sí | `123 Sample Street` |
| `address.postal_code` | Sí | `10001` |
| `tax_number` | Sí | `11111111111` |
| `address.street_2` | No | `Unit 4` |
| `address.city` | No | `Sample City` |
| `address.region` | No | `Sample State` |
| `vendor_data` | No | `user-1234` |

* **Entrades obligatòries:** `first_name`, `last_name`, `date_of_birth`, `address.street_1`, `address.postal_code`, `tax_number`
* **Entrades opcionals:** `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Consentiment:** No cal.
* **Disponibilitat al flux de treball:** Disponible en el flux de treball
* **Cobertura:** \~ 95%
* **Preu:** \$0.59 per consulta satisfactòria

No tots els documents que accepta aquest servei contenen l'identificador amb què es consulta. Quan l'identificador no s'extreu del document, la comprovació es registra com a **no aplicable** - no es consulta cap base de dades i no se't cobra -, cosa que en alguns països representa una part important dels usuaris reals. Per cobrir-los, recull també l'identificador d'una resposta d'un qüestionari, d'un camp d'extracció de Document AI o d'un valor que enviïs en crear la sessió, i assigna'l al pas de Validació en bases de dades.

## Paràmetres del cos

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

Codi de país ISO 3166-1 alpha-3 d'aquest servei de bases de dades.

Exemple: `BRA`

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

Matriu que conté aquest ID de servei. Fixar el servei manté la sol·licitud limitada a aquesta base de dades exacta.

Exemple: `bra_residential`

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

Nom de pila a validar.

Exemple: `John`

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

Cognom a validar.

Exemple: `Doe`

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

Data de naixement en 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"})

Objecte d'adreça residencial estructurat. Utilitza `street_1`, `street_2`, `city`, `region`, `postal_code` i `country`. Encara s'accepta una cadena d'adreça completa antiga, però no es recomana.

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)

Número d'identificació fiscal o tributària.

Exemple: `11111111111`

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

La teva referència estable d'usuari per a aquesta persona, com ara el teu ID d'usuari intern. Didit l'utilitza per vincular les comprovacions independents al mateix usuari final i reduir el soroll en la detecció de duplicats.

Exemple: `user-1234`

## Regles d'entrada i notes de validació

* CPF brasiler (exactament 11 dígits)
* `tax_number` ha de contenir només dígits; elimina espais, guions i signes de puntuació abans d'enviar la sol·licitud.
* `tax_number` ha de tenir exactament 11 caràcters.
* Per als serveis basats en adreces, envia els camps d'adreça estructurats en lloc d'una sola cadena `address` sempre que sigui possible.
* `address.street_1` és l'adreça del carrer, incloent-hi el número i el tipus de via.
* `address.street_2` és el pis, la porta, l'edifici, la planta o una línia d'adreça addicional. Envia-la només quan la tinguis.
* `address.city` és la ciutat, el barri, el districte, la localitat o el veïnat.
* `address.region` és l'estat, la província, la regió o la població.
* `address.postal_code` és el codi postal.
* Els serveis de bases de dades basats en adreces requereixen com a mínim l'adreça del carrer i el codi postal; les sol·licituds rebutjades abans de la consulta a la font no es cobren.

## How to call it

```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));
```

Cada crida satisfactòria retorna HTTP `200`. El camp **`outcome_code`** indica què ha passat realment, i distingeix, per exemple, una discordança biomètrica real (`BIOMETRIC_NO_MATCH`) d'una selfie que no s'ha pogut llegir (`BIOMETRIC_IMAGE_UNUSABLE`). L'`status` que es mostra és l'estat per defecte de la funcionalitat; les teves [accions de Partial Match / No Match](https://docs.didit.me/ca/core-technology/database-validation/database-validation-warnings.md) configurades el poden substituir.

**`MATCH`** — El registre ha confirmat la identitat i tots els camps comprovats coincideixen.

```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`** — S'ha trobat el número d'identificació, però un o més camps personals (normalment el nom o la data de naixement) no coincideixen completament.

```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`** — El registre no ha retornat cap coincidència per a les dades enviades.

```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"
      }
    }
  ]
}
```

## Dades retornades

Els camps exactes que apareixen a `source_data` depenen del que retorni el registre. L'exemple generat per a `bra_residential` documenta actualment aquesta estructura normalitzada:

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

## Preus i SLA

Les consultes de Brazil Residential només es facturen quan Didit rep un resultat concloent de la font de validació.

* **Preu per crida:** \$0.59 USD.
* **Facturació:** per consulta satisfactòria. No se't cobra quan el registre no és accessible, quan falten camps obligatoris o quan la sol·licitud es rebutja abans d'arribar a la font.
* **Latència:** p95 habitual \< 2 s.
* **Disponibilitat:** 99.9% per trimestre per part de Didit; la disponibilitat de la font posterior varia segons el país i el conjunt de dades.

## Continua llegint

* [Visió general de la Validació en bases de dades del Brasil](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [Visió general de la Validació en bases de dades](https://docs.didit.me/ca/core-technology/database-validation/overview.md)
* [Codis de resultat](https://docs.didit.me/ca/core-technology/database-validation/database-validation-outcome-codes.md)


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