> ## 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（United States Residential）

> 米国の信頼できるデータベースで居住者住所を照合するAPI。Diditの本人確認インフラ経由で提供。1回あたり$0.60からの従量課金で、契約や最低利用額はありません。

政府・公的記録、身元調査記録、公開されている職業プロフィールを集約したサービスです。Diditはこのサービスを`POST /v3/database-validation/`経由で提供しており、送信されたデータを信頼できる情報源と照合して、正規化された照合結果を受け取ることができます。

## カバー範囲

* **カバー範囲：** \~ 90%
* **国：** 米国
* **サービスID：** `usa_states_residential`
* **データドメイン：** 住所
* **カテゴリ：** 住宅

## 入力

| フィールド | 必須 | 例 |
| - | -: | - |
| `first_name` | はい | `John` |
| `last_name` | はい | `Doe` |
| `date_of_birth` | はい | `1990-01-01` |
| `address.street_1` | はい | `123 Sample Street` |
| `address.postal_code` | はい | `10001` |
| `phone` | いいえ | `+15550101000` |
| `ssn` | いいえ | `123456789` |
| `email` | いいえ | `john.doe@example.com` |
| `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`
* **任意の入力：** `phone`、`ssn`、`email`、`address.street_2`、`address.city`、`address.region`、`vendor_data`
* **同意：** 不要
* **ワークフローでの利用可否：** 利用可能
* **カバレッジ：** \~ 90%
* **料金：** 成功したクエリ1件あたり\$0.60

## ボディパラメーター

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

このデータベースサービスのISO 3166-1 alpha-3国コードです。

例：`USA`

**services** `string` *required* (default: usa\_states\_residential)

このサービスIDを含む配列です。サービスを固定することで、リクエストの対象をこのデータベースだけに限定できます。

例：`usa_states_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"}`

**phone** `string`

国際形式の電話番号です。

例：`+15550101000`

**ssn** `string`

このデータベースサービスで必要な`ssn`の値です。

例：`123456789`

**email** `string`

メールアドレスです。

例：`john.doe@example.com`

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

社内のユーザーIDなど、この人物を一貫して識別するためのユーザー参照です。Diditはこれを使って個別のチェックを同じエンドユーザーに紐付け、重複検出のノイズを減らします。

例：`user-1234`

## 入力ルールと検証に関する注意事項

* 2文字以上である必要があります
* 米国社会保障番号（9桁、ハイフンは任意）
* `ssn`は`(?:\d{9}|\d{3}-\d{2}-\d{4})`に一致する必要があります。
* `ssn`には、9桁すべてのSSN/ITINを送信してください（ハイフンは任意）。米国のCredit BureauおよびFinancial Servicesのチェックとは異なり、このサービスは下4桁の形式を受け付けません。
* 住所サービスでは、可能な限り単一の`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=USA" \
  -F "services=usa_states_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"}'
```

```python Python theme={null}
from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="USA",
    services=["usa_states_residential"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    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: "USA",
  services: ["usa_states_residential"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  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: "USA",
	Services:     didit.Some([]string{"usa_states_residential"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	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("USA")
        .services(List.of("usa_states_residential"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .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' => 'USA',
    'services' => ['usa_states_residential'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    '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: "USA",
  services: ["usa_states_residential"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  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 = "USA",
    Services = new string[] { "usa_states_residential" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    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`は機能のデフォルトのステータスであり、設定済みの[Partial Match / No Matchのアクション](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": "USA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "usa_states_residential",
      "service_name": "United States of America - United States Residential",
      "source_data": {
        "address": "123 Sample Street",
        "address_match_score": "1.000",
        "city": "Sample City",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "full_name": "John Doe",
        "last_name": "Doe",
        "name_match_score": "1.000",
        "postal_code": "10001",
        "state": "Sample State",
        "street": "sample_value",
        "verifications": {
          "address": true,
          "date_of_birth": true,
          "full_name": true
        }
      },
      "validation": {
        "address": "full_match",
        "date_of_birth": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**：このサービスが比較するフィールドのうち、1つ以上が完全には一致しませんでした。この例では、`full_name`は一致せず、`address`と`date_of_birth`は一致しました。

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "USA",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "usa_states_residential",
      "service_name": "United States of America - United States Residential",
      "source_data": {
        "address": "123 Sample Street",
        "address_match_score": "1.000",
        "city": "Sample City",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "full_name": "John Doe",
        "last_name": "Doe",
        "name_match_score": "1.000",
        "postal_code": "10001",
        "state": "Sample State",
        "street": "sample_value",
        "verifications": {
          "address": true,
          "date_of_birth": true,
          "full_name": false
        }
      },
      "validation": {
        "address": "full_match",
        "date_of_birth": "full_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

**`NO_MATCH`**：送信されたデータに対して、レジストリは一致を返しませんでした。

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "USA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "usa_states_residential",
      "service_name": "United States of America - United States Residential",
      "source_data": {
        "address": "NO_MATCH",
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH"
      },
      "validation": {
        "address": "no_match",
        "date_of_birth": "no_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

## 返されるデータ

`source_data`に含まれる具体的なフィールドは、レジストリが返す内容によって異なります。`usa_states_residential`の生成例では、現在、次の正規化された形式が記載されています。

* `address`
* `address_match_score`
* `city`
* `date_of_birth`
* `first_name`
* `full_name`
* `last_name`
* `name_match_score`
* `postal_code`
* `state`
* `street`

## 料金とSLA

United States of America - United States Residentialのクエリは、Diditが検証ソースから確定的な結果を受け取った場合にのみ課金されます。

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

## 関連情報

* [米国のデータベース検証の概要](https://docs.didit.me/api-reference/database-validation/united-states.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.