> ## 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の本人確認基盤で、ブラジルの居住情報を公的データベースと照合して検証します。従量課金で1回$0.59から。契約不要、最低利用額なし。

選挙人登録の統合データベースと照合して検証します。Diditはこのサービスを`POST /v3/database-validation/`で提供しており、送信されたデータを信頼できる情報源と照合し、正規化された照合結果を受け取ることができます。

## 対象範囲

* **対象範囲：** \~ 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%
* **料金：** 照会成功1件あたり\$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`は郵便番号です。
* 住所ベースのデータベースサービスでは、少なくとも住所と郵便番号が必要です。情報源への照会前に拒否されたリクエストには料金は発生しません。

## 呼び出し方法

```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/ja/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`**:識別番号は見つかりましたが、1つ以上の個人情報フィールド(通常は氏名または生年月日)が完全には一致しませんでした。

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

ブラジルの住所照会は、Diditが検証元から確定結果を受け取った場合にのみ課金されます。

* **呼び出し1件あたりの料金:**\$0.59 USD。
* **請求:**成功した照会ごとに課金されます。レジストリに接続できない場合、必須フィールドが不足している場合、またはリクエストが検証元に到達する前に拒否された場合は課金されません。
* **レイテンシ:**通常、p95で2秒未満です。
* **可用性:**Didit側で四半期あたり99.9%。接続先の検証元の可用性は国やデータセットによって異なります。

## 関連情報

* [ブラジルのデータベース検証の概要](https://docs.didit.me/api-reference/database-validation/brazil.md)
* [データベース検証の概要](https://docs.didit.me/ja/core-technology/database-validation/overview.md)
* [結果コード](https://docs.didit.me/ja/core-technology/database-validation/database-validation-outcome-codes.md)


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