> ## 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 Credit Bureau）权威数据库查询，通过 Didit 进行，按次计费，单次起价 $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%
* **价格：** 每次成功查询收费 \$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` 字符串，Didit 会在可能的情况下将其拆分为结构化地址元素；您也可以直接显式发送结构化字段。
* 美国社会安全号码或 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` 中的一项。仅包含姓名的请求会在查询提供方之前被拒绝，且不计费；`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` 为默认功能状态；您配置的[部分匹配 / 无匹配操作](https://docs.didit.me/zh/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 从验证数据源收到确定性结果时计费。

* **单次调用价格：** \$0.25 USD。
* **计费方式：** 按每次成功查询计费。当登记机构无法访问、缺少必填字段，或请求在到达数据源之前即被拒绝时，您无需付费。
* **延迟：** 典型 p95 低于 2 秒。
* **可用性：** Didit 侧每季度 99.9%；下游数据源的可用性因国家和数据集而异。

## 继续阅读

* [美国数据库核验概览](https://docs.didit.me/api-reference/database-validation/united-states.md)
* [数据库核验概览](https://docs.didit.me/zh/core-technology/database-validation/overview.md)
* [结果代码](https://docs.didit.me/zh/core-technology/database-validation/database-validation-outcome-codes.md)


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