> ## 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 のアイデンティティ基盤を通じて、グローバルなアイデンティティネットワークを照会するAPIです。1回$0.20からの従量課金で、契約不要、最低利用額もありません。

グローバルなリスクインサイトネットワークを通じて、メールアドレスと電話番号のいずれかまたは両方から、人物情報（氏名、生年月日、住所、電話番号、メールアドレス、国民ID）と氏名一致スコアを特定します。リクエストごとに課金されます。Diditはこのサービスを`POST /v3/database-validation/`で提供しており、送信したデータを連携先のアイデンティティネットワークと照合して、正規化された一致結果を受け取れます。これはサードパーティのエンリッチメントネットワークであり、政府の公式登録簿ではありません。その結果を一次情報源による検証として提示しないでください。

## 対象範囲

* **対象範囲：** 50+の市場
* **国：** グローバル
* **サービスID：** `glb_identity_enrichment`
* **データドメイン：** アイデンティティ
* **カテゴリ：** IdentityEnrichment

## 入力

| フィールド | 必須 | 例 |
| - | -: | - |
| `email` | いいえ | `john.doe@example.com` |
| `phone` | いいえ | `+15550101000` |
| `first_name` | いいえ | `John` |
| `last_name` | いいえ | `Doe` |
| `full_name` | いいえ | `John Doe` |
| `country_of_residence` | いいえ | `US` |
| `vendor_data` | いいえ | `user-1234` |

* **必須の入力：** なし
* **任意の入力：** `email`、`phone`、`first_name`、`last_name`、`full_name`、`country_of_residence`、`vendor_data`
* **同意：** 必須
* **ワークフローでの利用：** スタンドアロンAPIのみ
* **対象範囲：** 50+の市場
* **料金：** 成功したクエリ1件あたり\$0.20

このサービスは、ワークフロー内のデータベース検証ステップとしては提供されていません。これはチェックを実行できる場所の制限であり、送信できる内容の制限ではありません。スタンドアロンAPIを呼び出し、入力を直接指定してください。

## ボディパラメーター

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

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

例：`GLB`

**services** `string` *required* (default: glb\_identity\_enrichment)

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

例：`glb_identity_enrichment`

**consent** `boolean` *required* (default: true)

このサービスに対するエンドユーザーの明示的な同意です。

例：`true`

**email** `string` (default: [john.doe@example.com](mailto:john.doe@example.com))

メールアドレスです。

例：`john.doe@example.com`

**phone** `string` (default: +15550101000)

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

例：`+15550101000`

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

検証する名です。

例：`John`

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

検証する姓です。

例：`Doe`

**full\_name** `string`

検証する法的な氏名です。

例：`John Doe`

**country\_of\_residence** `string` (default: US)

居住国を表すISO 3166-1 alpha-2コードです（任意）。本人情報の検索対象を絞り込むためにのみ使用されます。

例：`US`

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

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

例：`user-1234`

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

* `email`または`phone`の少なくとも一方を指定してください。これらが検索キーです。どちらも含まないリクエストはエンリッチメント検索を実行できず、ソースでの検索前に拒否されます（課金されません）。
* 名前がわかる場合は必ず追加してください。ソースはその名前に基づいて検索をスコアリングします。`first_name`と`last_name`を送信してください。これらはレスポンスの`validation`マップが比較するフィールドです。`full_name`のみを送信したリクエストもソースによってスコアリングされますが、`validation`は空になり、トップレベルの`match_type`はnullで返されます。
* `country_of_residence`は、検索対象を絞り込むために使用されるISO 3166-1 alpha-2コードです。
* 完了した検索はすべて課金されます。人物が1人も特定されなかった場合（`persons_found: 0`）も含みます。無料になるのは、検索前に拒否されたリクエスト（`email`と`phone`のどちらも指定されていないもの）のみです。

## 呼び出し方法

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=GLB" \
  -F "services=glb_identity_enrichment" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "email=john.doe@example.com" \
  -F "phone=+15550101000" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "country_of_residence=US"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="GLB",
    services=["glb_identity_enrichment"],
    consent=True,
    first_name="John",
    last_name="Doe",
    phone="+15550101000",
    email="john.doe@example.com",
    country_of_residence="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: "GLB",
  services: ["glb_identity_enrichment"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  phone: "+15550101000",
  email: "john.doe@example.com",
  country_of_residence: "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:       "GLB",
	Services:           didit.Some([]string{"glb_identity_enrichment"}),
	Consent:            didit.Bool(true),
	FirstName:          didit.String("John"),
	LastName:           didit.String("Doe"),
	Phone:              didit.String("+15550101000"),
	Email:              didit.String("john.doe@example.com"),
	CountryOfResidence: didit.String("US"),
	VendorData:         didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
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("GLB")
        .services(List.of("glb_identity_enrichment"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .phone("+15550101000")
        .email("john.doe@example.com")
        .countryOfResidence("US")
        .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' => 'GLB',
    'services' => ['glb_identity_enrichment'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'phone' => '+15550101000',
    'email' => 'john.doe@example.com',
    'country_of_residence' => '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: "GLB",
  services: ["glb_identity_enrichment"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  phone: "+15550101000",
  email: "john.doe@example.com",
  country_of_residence: "US",
  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 = "GLB",
    Services = new string[] { "glb_identity_enrichment" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    Phone = "+15550101000",
    Email = "john.doe@example.com",
    CountryOfResidence = "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": "GLB",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "first_name": "John",
        "last_name": "Doe",
        "persons_found": 1
      },
      "validation": {
        "full_name": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**：メールアドレスまたは電話番号から人物が特定されましたが、最も一致度の高い候補の氏名は、送信した氏名と部分的にしか一致していません。

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "GLB",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "first_name": "John",
        "last_name": "Dow",
        "persons_found": 1
      },
      "validation": {
        "full_name": "partial_match"
      }
    }
  ]
}
```

**`NO_MATCH`**：メールアドレスまたは電話番号から人物が特定されましたが、最も一致度の高い候補の氏名は、送信した氏名と一致していません。

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "GLB",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "first_name": "Jane",
        "last_name": "Roe",
        "persons_found": 1
      },
      "validation": {
        "full_name": "no_match"
      }
    }
  ]
}
```

**`INCONCLUSIVE`**：メールアドレスまたは電話番号から人物が特定されましたが、氏名のスコアが返されませんでした。たとえば、リクエストに氏名が含まれていなかった場合です。何も判定されないため、`validation`は空、`match_type`はnullとなり、チェックはレビューに回されます。スコア付きの結果を得るには`first_name`と`last_name`を送信してください。`validation`の比較で参照されるのはこれらのフィールドです。`full_name`のみを含むリクエストでは、スコア付きの`outcome_code`は返されますが、`validation`は空のままです。

```json 200 OK — INCONCLUSIVE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "GLB",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "INCONCLUSIVE",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "persons_found": 1
      },
      "validation": {}
    }
  ]
}
```

**`DOCUMENT_NOT_FOUND`**：メールアドレスまたは電話番号から人物が特定されませんでした(`persons_found: 0`)。比較する氏名がないため、`validation`は空、`match_type`はnullとなります。この結果は確定的に不一致となり、不一致時のアクションに従って処理されます。この照会にも料金が発生します。

```json 200 OK — DOCUMENT_NOT_FOUND theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "GLB",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "DOCUMENT_NOT_FOUND",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "persons_found": 0
      },
      "validation": {}
    }
  ]
}
```

## 返却データ

`source_data`に含まれる具体的なフィールドは、登録機関から返される内容によって異なります。`glb_identity_enrichment`の生成されたサンプルでは、現在次の正規化された形式が記載されています。

* `first_name`
* `last_name`
* `persons_found`

## 料金とSLA

Global - Identity Enrichmentの照会は、Diditが検証ソースから確定的な結果を受け取った場合にのみ課金されます。

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

## 関連情報

* [グローバルデータベース検証の概要](https://docs.didit.me/ja/getting-started/database-validation-pricing.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.