> ## 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 жилого адреса

> Didit: авторитетная проверка по базам данных Бразилии через инфраструктуру Didit. Оплата за вызов от $0.59, без контрактов и минимальных объёмов.

Проверяет данные по объединённой базе избирательных реестров. Didit предоставляет этот сервис через `POST /v3/database-validation/`, чтобы вы могли сверить переданные данные с авторитетным источником и получить нормализованные результаты сопоставления. Формат ввода: `tax_number` принимает бразильский CPF (ровно 11 цифр).

## Покрытие

* **Покрытие:** \~ 95%
* **Страна:** Бразилия
* **ID сервиса:** `bra_residential`
* **Домен данных:** Адрес
* **Категория:** Жилая

## Входные данные

| Поле | Обязательное | Пример |
| - | -: | - |
| `first_name` | Да | `John` |
| `last_name` | Да | `Doe` |
| `date_of_birth` | Да | `1990-01-01` |
| `address.street_1` | Да | `123 Sample Street` |
| `address.postal_code` | Да | `10001` |
| `tax_number` | Да | `11111111111` |
| `address.street_2` | Нет | `Unit 4` |
| `address.city` | Нет | `Sample City` |
| `address.region` | Нет | `Sample State` |
| `vendor_data` | Нет | `user-1234` |

* **Обязательные входные данные:** `first_name`, `last_name`, `date_of_birth`, `address.street_1`, `address.postal_code`, `tax_number`
* **Необязательные входные данные:** `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Согласие:** Не требуется
* **Доступность в сценарии:** Доступно в сценарии
* **Покрытие:** \~ 95%
* **Цена:** \$0.59 за успешный запрос

Не каждый документ, который принимает этот сервис, содержит идентификатор, по которому выполняется запрос. Если идентификатор не извлечён из документа, проверка отмечается как **не применимо**: база данных не запрашивается, и с вас не взимается плата. Для некоторых стран такая ситуация касается значительной доли реальных пользователей. Чтобы охватить таких пользователей, также получайте идентификатор из ответа в Анкетах, из поля извлечения Document AI или из значения, которое вы передаёте при создании сессии, и сопоставляйте его на шаге проверки по базам данных.

## Параметры тела запроса

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

Код страны ISO 3166-1 alpha-3 для этого сервиса базы данных.

Пример: `BRA`

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

Массив, содержащий этот ID сервиса. Закрепление сервиса ограничивает запрос именно этой базой данных.

Пример: `bra_residential`

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

Имя для проверки.

Пример: `John`

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

Фамилия для проверки.

Пример: `Doe`

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

Дата рождения в формате `YYYY-MM-DD`.

Пример: `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"})

Структурированный объект адреса места жительства. Используйте `street_1`, `street_2`, `city`, `region`, `postal_code` и `country`. Полная строка адреса в устаревшем формате по-прежнему принимается, но не рекомендуется.

Пример: `{"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)

Налоговый или фискальный идентификационный номер.

Пример: `11111111111`

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

Ваш постоянный идентификатор пользователя, например внутренний ID пользователя. Didit использует его, чтобы связывать отдельные проверки с одним и тем же конечным пользователем и уменьшать количество ложных срабатываний при поиске дубликатов.

Пример: `user-1234`

## Правила ввода и примечания по валидации

* Бразильский CPF (ровно 11 цифр)
* `tax_number` должен содержать только цифры: перед отправкой запроса удалите пробелы, дефисы и знаки препинания.
* Длина `tax_number` должна составлять ровно 11 символов.
* Для сервисов, работающих с адресами, по возможности отправляйте структурированные поля адреса вместо одной строки `address`.
* `address.street_1` означает улицу, включая номер дома и тип улицы.
* `address.street_2` означает квартиру, блок, корпус, этаж или дополнительную строку адреса. Отправляйте её, только если она у вас есть.
* `address.city` означает город, пригород, район, населённый пункт или микрорайон.
* `address.region` означает штат, провинцию, регион или город.
* `address.postal_code` означает почтовый индекс.
* Сервисы баз данных на основе адреса требуют как минимум адрес улицы и почтовый индекс. Запросы, отклонённые до обращения к источнику, не тарифицируются.

## Как вызвать API

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

Каждый успешный вызов возвращает HTTP `200`. Поле **`outcome_code`** показывает, что произошло на самом деле: например, отличает реальное несовпадение биометрии (`BIOMETRIC_NO_MATCH`) от селфи, которое не удалось прочитать (`BIOMETRIC_IMAGE_UNUSABLE`). Показанный `status` — это статус функции по умолчанию. Настроенные вами [действия для частичного совпадения и отсутствия совпадения](https://docs.didit.me/ru/core-technology/database-validation/database-validation-warnings.md) могут его переопределить.

**`MATCH`** — Реестр подтвердил личность, и все проверяемые поля совпали.

```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`** — Идентификационный номер найден, но одно или несколько личных полей (обычно имя или дата рождения) совпали не полностью.

```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`** — Реестр не вернул совпадений по переданным данным.

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

## Возвращаемые данные

Точный набор полей в `source_data` зависит от того, что возвращает реестр. Сгенерированный пример для `bra_residential` сейчас документирует такую нормализованную структуру:

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

## Цены и SLA

Запросы Brazil Residential оплачиваются только тогда, когда Didit получает окончательный результат от источника проверки.

* **Цена за вызов:** \$0.59 USD.
* **Биллинг:** за каждый успешный запрос. Плата не взимается, если реестр недоступен, если не заполнены обязательные поля или если запрос отклонён до обращения к источнику.
* **Задержка:** типичный p95 \< 2 с.
* **Доступность:** 99.9% за квартал со стороны Didit. Доступность нижестоящего источника зависит от страны и набора данных.

## Продолжить чтение

* [Обзор проверки по базам данных для Бразилии](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [Обзор проверки по базам данных](https://docs.didit.me/ru/core-technology/database-validation/overview.md)
* [Коды результатов](https://docs.didit.me/ru/core-technology/database-validation/database-validation-outcome-codes.md)


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