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

# Verifikasi Residensial Brasil API: Pencocokan Identitas

> Validasi database Brasil otoritatif lewat infrastruktur identitas Didit. Bayar per panggilan mulai $0.59, tanpa kontrak dan tanpa minimum.

Memverifikasi data terhadap basis data gabungan pendaftaran pemilih. Didit menyediakan layanan ini melalui `POST /v3/database-validation/` agar Anda dapat memverifikasi data yang dikirim terhadap sumber otoritatif dan menerima hasil kecocokan yang dinormalisasi. Format input: `tax_number` menerima CPF Brasil (tepat 11 digit).

## Cakupan

* **Cakupan:** \~ 95%
* **Negara:** Brasil
* **ID layanan:** `bra_residential`
* **Domain data:** Alamat
* **Kategori:** Residensial

## Input

| Kolom | Wajib | Contoh |
| - | -: | - |
| `first_name` | Ya | `John` |
| `last_name` | Ya | `Doe` |
| `date_of_birth` | Ya | `1990-01-01` |
| `address.street_1` | Ya | `123 Sample Street` |
| `address.postal_code` | Ya | `10001` |
| `tax_number` | Ya | `11111111111` |
| `address.street_2` | Tidak | `Unit 4` |
| `address.city` | Tidak | `Sample City` |
| `address.region` | Tidak | `Sample State` |
| `vendor_data` | Tidak | `user-1234` |

* **Input wajib:** `first_name`, `last_name`, `date_of_birth`, `address.street_1`, `address.postal_code`, `tax_number`
* **Input opsional:** `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Persetujuan:** Tidak diperlukan
* **Ketersediaan alur kerja:** Tersedia dalam alur kerja
* **Cakupan:** \~ 95%
* **Harga:** \$0.59 per kueri yang berhasil

Tidak setiap dokumen yang diterima layanan ini memuat pengenal yang digunakan untuk kueri. Jika pengenal tidak diekstrak dari dokumen, pemeriksaan dicatat sebagai **tidak berlaku**. Dalam kondisi ini tidak ada basis data yang dikueri dan Anda tidak dikenai biaya. Untuk beberapa negara, kondisi ini mencakup porsi besar pengguna nyata. Untuk menjangkau mereka, kumpulkan juga pengenal tersebut dari jawaban Kuesioner, kolom ekstraksi Document AI, atau nilai yang Anda kirim saat membuat sesi, lalu petakan pada langkah Validasi Database.

## Parameter isi

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

Kode negara ISO 3166-1 alpha-3 untuk layanan basis data ini.

Contoh: `BRA`

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

Array yang berisi ID layanan ini. Mengunci layanan membuat permintaan hanya berlaku untuk basis data yang tepat ini.

Contoh: `bra_residential`

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

Nama depan yang akan divalidasi.

Contoh: `John`

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

Nama belakang yang akan divalidasi.

Contoh: `Doe`

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

Tanggal lahir dalam format `YYYY-MM-DD`.

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

Objek alamat tempat tinggal yang terstruktur. Gunakan `street_1`, `street_2`, `city`, `region`, `postal_code`, dan `country`. String alamat lengkap versi lama masih diterima, tetapi tidak disarankan.

Contoh: `{"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)

Nomor identifikasi pajak atau fiskal.

Contoh: `11111111111`

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

Referensi pengguna yang stabil untuk orang ini, misalnya ID pengguna internal Anda. Didit menggunakannya untuk menautkan pemeriksaan mandiri ke pengguna akhir yang sama dan mengurangi gangguan akibat deteksi duplikat.

Contoh: `user-1234`

## Aturan input & catatan validasi

* CPF Brasil (tepat 11 digit)
* `tax_number` hanya boleh berisi digit; hapus spasi, tanda hubung, dan tanda baca sebelum mengirim permintaan.
* `tax_number` harus tepat 11 karakter.
* Untuk layanan alamat, kirim kolom alamat terstruktur alih-alih satu string `address` bila memungkinkan.
* `address.street_1` adalah alamat jalan, termasuk nomor dan jenis jalan.
* `address.street_2` adalah apartemen, unit, gedung, lantai, atau baris alamat tambahan. Kirim hanya jika Anda memilikinya.
* `address.city` adalah kota, kecamatan, distrik, lokalitas, atau lingkungan.
* `address.region` adalah provinsi, negara bagian, wilayah, atau kota kecil.
* `address.postal_code` adalah kode pos.
* Layanan basis data berbasis alamat memerlukan minimal alamat jalan dan kode pos; permintaan yang ditolak sebelum pencarian sumber tidak dikenai biaya.

## Cara memanggil

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

Setiap panggilan yang berhasil mengembalikan HTTP `200`. Kolom **`outcome_code`** menunjukkan apa yang sebenarnya terjadi, misalnya membedakan ketidakcocokan biometrik yang nyata (`BIOMETRIC_NO_MATCH`) dari swafoto yang tidak dapat dibaca (`BIOMETRIC_IMAGE_UNUSABLE`). `status` yang ditampilkan adalah status fitur default. [Tindakan Partial Match dan No Match](https://docs.didit.me/id/core-technology/database-validation/database-validation-warnings.md) yang Anda konfigurasi dapat menggantinya.

**`MATCH`**: Registri mengonfirmasi identitas dan setiap kolom yang diperiksa cocok.

```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`**: Nomor identifikasi ditemukan, tetapi satu atau lebih kolom data pribadi (biasanya nama atau tanggal lahir) tidak sepenuhnya cocok.

```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`**: Registri tidak mengembalikan kecocokan untuk data yang dikirim.

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

## Data yang dikembalikan

Kolom yang muncul di `source_data` bergantung pada apa yang dikembalikan registri. Contoh yang dihasilkan untuk `bra_residential` saat ini mendokumentasikan bentuk ternormalisasi berikut:

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

## Harga & SLA

Kueri Brazil Residential hanya ditagihkan ketika Didit menerima hasil yang konklusif dari sumber validasi.

* **Harga per panggilan:** \$0.59 USD.
* **Penagihan:** per kueri yang berhasil. Anda tidak dikenakan biaya ketika registri tidak dapat dijangkau, ketika kolom yang wajib tidak ada, atau ketika permintaan ditolak sebelum mencapai sumber.
* **Latensi:** p95 tipikal di bawah 2 s.
* **Ketersediaan:** 99.9% per kuartal di sisi Didit. Ketersediaan sumber hilir bervariasi menurut negara dan dataset.

## Lanjutkan membaca

* [Ikhtisar Validasi Database Brasil](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [Ikhtisar Validasi Database](https://docs.didit.me/id/core-technology/database-validation/overview.md)
* [Kode hasil](https://docs.didit.me/id/core-technology/database-validation/database-validation-outcome-codes.md)


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