> ## 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 verificación residencial de Brasil: identidad

> Valida datos residenciales en bases de datos oficiales de Brasil con Didit. Pago por llamada desde $0.59, sin contratos ni mínimos.

Verifica los datos contra una base de datos consolidada de registros electorales. Didit ofrece este servicio a través de `POST /v3/database-validation/` para que puedas verificar los datos enviados contra la fuente oficial y recibir resultados de coincidencia normalizados.

## Cobertura

* **Cobertura:** \~ 95%
* **País:** Brasil
* **ID del servicio:** `bra_residential`
* **Dominio de datos:** Dirección
* **Categoría:** Residencial

## Datos de entrada

| Campo | Obligatorio | Ejemplo |
| - | -: | - |
| `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` |

* **Datos obligatorios:** `first_name`, `last_name`, `date_of_birth`, `address.street_1`, `address.postal_code`, `tax_number`
* **Datos opcionales:** `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Consentimiento:** No es obligatorio
* **Disponibilidad en el flujo de verificación (workflow):** Disponible en el flujo
* **Cobertura:** \~ 95%
* **Precio:** \$0.59 por consulta exitosa

No todos los documentos que acepta este servicio contienen el identificador con el que se realiza la consulta. Cuando el identificador no se extrae del documento, la comprobación se registra como **no aplicable**: no se consulta ninguna base de datos y no se te cobra. En algunos países, esto afecta a una gran parte de los usuarios reales. Para cubrirlos, recoge también el identificador a partir de una respuesta de un Cuestionario, un campo de extracción de Document AI o un valor que envíes al crear la sesión, y asígnalo al paso de Validación de base de datos.

## Parámetros del cuerpo

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

Código de país ISO 3166-1 alfa-3 de este servicio de base de datos.

Ejemplo: `BRA`

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

Array que contiene el ID de este servicio. Fijar el servicio limita la solicitud a esta base de datos concreta.

Ejemplo: `bra_residential`

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

Nombre de pila que se va a validar.

Ejemplo: `John`

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

Apellido que se va a validar.

Ejemplo: `Doe`

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

Fecha de nacimiento en formato `YYYY-MM-DD`.

Ejemplo: `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"})

Objeto estructurado con la dirección residencial. Usa `street_1`, `street_2`, `city`, `region`, `postal_code` y `country`. Se sigue aceptando una cadena completa de dirección en el formato heredado, pero no se recomienda.

Ejemplo: `{"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 de identificación fiscal o tributaria.

Ejemplo: `11111111111`

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

Tu referencia estable de usuario para esta persona, como tu ID de usuario interno. Didit la usa para vincular las comprobaciones independientes al mismo usuario final y reducir el ruido en la detección de duplicados.

Ejemplo: `user-1234`

## Reglas de entrada y notas de validación

* CPF brasileño (exactamente 11 dígitos)
* `tax_number` debe contener solo dígitos; elimina los espacios, guiones y signos de puntuación antes de enviar la solicitud.
* `tax_number` debe tener exactamente 11 caracteres.
* Para los servicios de direcciones, envía los campos de dirección estructurados en lugar de una única cadena `address` siempre que sea posible.
* `address.street_1` es la dirección postal, incluidos el número y el tipo de vía.
* `address.street_2` es el apartamento, la unidad, el edificio, la planta o una línea adicional de la dirección. Envíalo solo cuando lo tengas.
* `address.city` es la ciudad, el suburbio, el distrito, la localidad o el barrio.
* `address.region` es el estado, la provincia, la región o la población.
* `address.postal_code` es el código postal.
* Los servicios de base de datos basados en la dirección requieren al menos la dirección de la calle y el código postal; las solicitudes rechazadas antes de realizar una consulta en la fuente no se cobran.

## Cómo invocarla

```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 llamada exitosa devuelve HTTP `200`. El campo **`outcome_code`** te indica qué ocurrió realmente; por ejemplo, distingue una falta de coincidencia biométrica real (`BIOMETRIC_NO_MATCH`) de una selfie que no se pudo leer (`BIOMETRIC_IMAGE_UNUSABLE`). El `status` que se muestra es el estado predeterminado de la función; las [acciones de coincidencia parcial y sin coincidencia](https://docs.didit.me/es/core-technology/database-validation/database-validation-warnings.md) que hayas configurado pueden sobrescribirlo.

**`MATCH`**: el registro confirmó la identidad y todos los campos comprobados coincidieron.

```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`**: se encontró el número de identificación, pero uno o más campos personales (normalmente el nombre o la fecha de nacimiento) no coincidieron por completo.

```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 registro no devolvió ninguna coincidencia para los datos enviados.

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

## Datos devueltos

Los campos exactos expuestos en `source_data` dependen de lo que devuelva el registro. El ejemplo generado para `bra_residential` documenta actualmente esta estructura normalizada:

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

## Precios y SLA

Las consultas residenciales de Brasil solo se facturan cuando Didit recibe un resultado concluyente de la fuente de validación.

* **Precio por llamada:** \$0.59 USD.
* **Facturación:** por consulta exitosa. No se te cobra cuando no se puede acceder al registro, cuando faltan campos obligatorios o cuando la solicitud se rechaza antes de llegar a la fuente.
* **Latencia:** p95 típico \< 2 s.
* **Disponibilidad:** 99.9% por trimestre por parte de Didit; la disponibilidad de la fuente externa varía según el país y el conjunto de datos.

## Continúa leyendo

* [Visión general de la validación de bases de datos de Brasil](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [Visión general de la validación de bases de datos](https://docs.didit.me/es/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/es/core-technology/database-validation/database-validation-outcome-codes.md)


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