> ## 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.25からの従量課金で、契約不要・最低利用額なし。

クレジットヘッダーデータとその他のサービスを集約したサービスです。Diditはこのサービスを`POST /v3/database-validation/`で提供しており、送信されたデータを信頼できる情報源と照合し、正規化された照合結果を受け取ることができます。

## カバレッジ

* **カバレッジ：** 約90%
* **国：** 米国
* **サービスID：** `usa_states_credit_bureau`
* **データ領域：** 金融
* **カテゴリ：** CreditBureau

## 入力項目

| フィールド | 必須 | 例 |
| - | -: | - |
| `first_name` | はい | `John` |
| `last_name` | はい | `Doe` |
| `date_of_birth` | いいえ | `1990-01-01` |
| `address.street_1` | いいえ | `123 Sample Street` |
| `address.street_2` | いいえ | `Unit 4` |
| `address.city` | いいえ | `Sample City` |
| `address.region` | いいえ | `Sample State` |
| `address.postal_code` | いいえ | `10001` |
| `phone` | いいえ | `+15550101000` |
| `ssn` | いいえ | `123456789` |
| `email` | いいえ | `john.doe@example.com` |
| `vendor_data` | いいえ | `user-1234` |

* **必須の入力項目：** `first_name`、`last_name`
* **任意の入力項目：** `date_of_birth`、`address.street_1`、`address.street_2`、`address.city`、`address.region`、`address.postal_code`、`phone`、`ssn`、`email`、`vendor_data`
* **同意：** 不要
* **ワークフローでの利用：** ワークフローで利用可能
* **カバレッジ：** 約90%
* **料金：** 成功したクエリ1件あたり\$0.25

## ボディパラメーター

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

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

例：`USA`

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

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

例：`usa_states_credit_bureau`

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

検証する名です。

例：`John`

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

検証する姓です。

例：`Doe`

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

`YYYY-MM-DD`形式の生年月日です。

例：`1990-01-01`

**address** `object`

構造化された居住地の住所オブジェクトです。`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`

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

* このサービスでは`address`は任意です。完全な`address`文字列を1つ送信すると、Diditが可能な範囲で構造化された住所要素に分割します。構造化フィールドを明示的に送信することもできます。
* 米国の社会保障番号（SSN）またはITIN。9桁すべて（ハイフンは任意）、または下4桁のみ
* `ssn`は`(?:\d{9}|\d{3}-\d{2}-\d{4}|\d{4})`に一致する必要があります。
* `ssn`には、9桁すべてのSSN/ITIN（ハイフンは任意）か、その下4桁のみのいずれかを送信してください。
* 必須の`first_name`と`last_name`に加えて、`date_of_birth`、`address`、`phone`、`ssn`、`email`のうち少なくとも1つのフィールドを含めてください。氏名のみのリクエストはプロバイダーへの照会前に拒否されます（料金は発生しません）。最も信頼性の高い照合が得られるのは`date_of_birth`です。
* 住所サービスでは、可能な限り単一の`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_credit_bureau" \
  -F "vendor_data=user-1234" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01"
```

```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_credit_bureau"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    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_credit_bureau"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  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_credit_bureau"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	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_credit_bureau"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .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_credit_bureau'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    '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_credit_bureau"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  vendor_data: "user-1234"
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
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_credit_bureau" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    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_credit_bureau",
      "service_name": "United States of America - United States Credit Bureau",
      "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": {
          "full_name": true
        }
      },
      "validation": {
        "full_name": "full_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_credit_bureau",
      "service_name": "United States of America - United States Credit Bureau",
      "source_data": {
        "full_name": "NO_MATCH"
      },
      "validation": {
        "full_name": "no_match"
      }
    }
  ]
}
```

## 返されるデータ

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

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

## 料金とSLA

アメリカ合衆国 - 米国クレジットビューローへのクエリは、Diditが検証元から確定的な結果を受け取った場合にのみ課金されます。

* **呼び出し1件あたりの料金:** \$0.25 USD。
* **請求:** 成功したクエリ1件ごとに課金されます。レジストリに接続できない場合、必須フィールドが不足している場合、またはリクエストが検証元に到達する前に拒否された場合は課金されません。
* **レイテンシ:** 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.