> ## 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.42からの従量課金で、契約不要、最低利用額もありません。

入力データを携帯電話事業者の電話番号データと照合して検証します。代理店への申請が必要です。Diditはこのサービスを`POST /v3/database-validation/`で提供しているため、送信されたデータを信頼できる情報源と照合し、正規化された照合結果を受け取ることができます。

## カバレッジ

* **カバレッジ:** 約90%
* **国:** カナダ
* **サービスID:** `can_residential`
* **データドメイン:** 住所
* **カテゴリ:** 住宅

## 入力

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

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

## ボディパラメーター

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

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

例：`CAN`

**services** `string` *required* (default: can\_residential)

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

例：`can_residential`

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

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

例：`true`

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

検証する名です。

例：`John`

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

検証する姓です。

例：`Doe`

**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` *required* (default: +15550101000)

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

例：`+15550101000`

**date\_of\_birth** `string`

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

例：`1990-01-01`

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

この人物に対して一貫して使用する貴社のユーザー参照値です。たとえば、社内のユーザーIDを使用します。Diditはこれを使って単独のチェックを同一のエンドユーザーに紐づけ、重複検知のノイズを減らします。

例：`user-1234`

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

* 住所サービスでは、可能な限り単一の`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=CAN" \
  -F "services=can_residential" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F 'address={"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}' \
  -F "phone=+15550101000"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="CAN",
    services=["can_residential"],
    consent=True,
    first_name="John",
    last_name="Doe",
    address={"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"},
    phone="+15550101000",
    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: "CAN",
  services: ["can_residential"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  phone: "+15550101000",
  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: "CAN",
	Services:     didit.Some([]string{"can_residential"}),
	Consent:      didit.Bool(true),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	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"}),
	Phone:        didit.String("+15550101000"),
	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("CAN")
        .services(List.of("can_residential"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .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()))
        .phone("+15550101000")
        .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' => 'CAN',
    'services' => ['can_residential'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'address' => ['street_1' => '123 Sample Street', 'street_2' => 'Unit 4', 'city' => 'Sample City', 'region' => 'Sample State', 'postal_code' => '10001', 'country' => 'US'],
    'phone' => '+15550101000',
    '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: "CAN",
  services: ["can_residential"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  phone: "+15550101000",
  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 = "CAN",
    Services = new string[] { "can_residential" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    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" },
    Phone = "+15550101000",
    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": "CAN",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "can_residential",
      "service_name": "Canada Residential",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}
```

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

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "CAN",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "can_residential",
      "service_name": "Canada Residential",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

**`NO_MATCH`**：送信されたデータに対し、登録機関から一致する結果は返されませんでした。

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "CAN",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "can_residential",
      "service_name": "Canada Residential",
      "source_data": {
        "address": "NO_MATCH",
        "full_name": "NO_MATCH"
      },
      "validation": {
        "address": "no_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

## 返却データ

`source_data`に含まれるフィールドは、登記機関が返す内容によって異なります。`can_residential`の生成例では、現在次の正規化された形式が記載されています。

* `address`
* `date_of_birth`
* `first_name`
* `last_name`

## 料金とSLA

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

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

## 関連ドキュメント

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