> ## 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 加拿大住宅数据库核验：基于其身份基础设施提供权威核验服务，按次调用计费，起价 $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%
* **价格：** 每次成功查询 \$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/zh/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`**：一个或多个本服务比对的字段未完全匹配。在本示例中，`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

只有当 Didit 从验证来源收到明确结果时，才会对加拿大住宅查询计费。

* **单次调用价格：** \$0.42 USD。
* **计费方式：** 按每次成功查询计费。如果注册机构无法访问、缺少必填字段，或请求在到达来源前即被拒绝，则不收费。
* **延迟：** 典型 p95 小于 2 秒。
* **可用性：** Didit 一侧每季度 99.9%；下游来源的可用性因国家/地区和数据集而异。

## 继续阅读

* [加拿大数据库核验概览](https://docs.didit.me/api-reference/database-validation/canada.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.