> ## 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.

# DIA 新西兰护照核验 API

> Didit提供DIA新西兰护照数据库核验：通过其身份基础设施查询权威新西兰数据库，按次计费起价$1.67，无合同、无最低消费。

DIA 护照验证服务。Didit 通过 `POST /v3/database-validation/` 提供此服务，您可以将提交的数据与权威数据源进行比对，并获得标准化的匹配结果。

## 覆盖范围

* **覆盖范围：** 100%\*
* **国家/地区：** 新西兰
* **服务 ID：** `nzl_new_zealand_passport`
* **数据领域：** 证件
* **类别：** 护照

## 输入参数

| 字段 | 必填 | 示例 |
| - | -: | - |
| `first_name` | 是 | `John` |
| `last_name` | 是 | `Doe` |
| `date_of_birth` | 是 | `1990-01-01` |
| `passport_number` | 是 | `SAMPLE-PASS-12345` |
| `passport_expiration_date` | 是 | `1990-01-01` |
| `vendor_data` | 否 | `user-1234` |

* **必填输入：** `first_name`、`last_name`、`date_of_birth`、`passport_number`、`passport_expiration_date`
* **可选输入：** `vendor_data`
* **同意：** 必填
* **工作流可用性：** 可在工作流中使用
* **覆盖范围：** 100%\*
* **价格：** 每次成功查询 \$1.67

## 请求体参数

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

此数据库服务的 ISO 3166-1 alpha-3 国家/地区代码。

示例：`NZL`

**services** `string` *required* (default: nzl\_new\_zealand\_passport)

包含此服务 ID 的数组。固定此服务可将请求限定在该特定数据库内。

示例：`nzl_new_zealand_passport`

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

终端用户对此服务的明确同意。

示例：`true`

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

需要验证的名字。

示例：`John`

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

需要验证的姓氏。

示例：`Doe`

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

出生日期，格式为 `YYYY-MM-DD`。

示例：`1990-01-01`

**passport\_number** `string` *required* (default: SAMPLE-PASS-12345)

护照号码。

示例：`SAMPLE-PASS-12345`

**passport\_expiration\_date** `string` *required* (default: 1990-01-01)

护照到期日期，格式为 `YYYY-MM-DD`。

示例：`1990-01-01`

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

您为此用户设定的稳定用户标识，例如您的内部用户 ID。Didit 使用它将独立检查关联到同一终端用户，并减少重复检测的干扰。

示例：`user-1234`

## 输入规则与验证说明

* 按从用户或证件采集的原样发送上述字段。
* Didit 会在调用数据库之前验证必填字段。在查询数据源之前被拒绝的请求不收费。

## 调用方法

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=NZL" \
  -F "services=nzl_new_zealand_passport" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F "passport_number=SAMPLE-PASS-12345" \
  -F "passport_expiration_date=1990-01-01"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="NZL",
    services=["nzl_new_zealand_passport"],
    consent=True,
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    passport_number="SAMPLE-PASS-12345",
    passport_expiration_date="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: "NZL",
  services: ["nzl_new_zealand_passport"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  passport_number: "SAMPLE-PASS-12345",
  passport_expiration_date: "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:           "NZL",
	Services:               didit.Some([]string{"nzl_new_zealand_passport"}),
	Consent:                didit.Bool(true),
	FirstName:              didit.String("John"),
	LastName:               didit.String("Doe"),
	DateOfBirth:            didit.String("1990-01-01"),
	PassportNumber:         didit.String("SAMPLE-PASS-12345"),
	PassportExpirationDate: 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("NZL")
        .services(List.of("nzl_new_zealand_passport"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .passportNumber("SAMPLE-PASS-12345")
        .passportExpirationDate(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' => 'NZL',
    'services' => ['nzl_new_zealand_passport'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'passport_number' => 'SAMPLE-PASS-12345',
    'passport_expiration_date' => '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: "NZL",
  services: ["nzl_new_zealand_passport"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  passport_number: "SAMPLE-PASS-12345",
  passport_expiration_date: "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 = "NZL",
    Services = new string[] { "nzl_new_zealand_passport" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    PassportNumber = "SAMPLE-PASS-12345",
    PassportExpirationDate = "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": "NZL",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "nzl_new_zealand_passport",
      "service_name": "DIA - New Zealand Passport",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**：找到了证件号码，但一项或多项个人字段（通常是姓名或出生日期）未完全匹配。

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "NZL",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "nzl_new_zealand_passport",
      "service_name": "DIA - New Zealand Passport",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "no_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**：登记机构未返回与提交数据匹配的结果。

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "NZL",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "nzl_new_zealand_passport",
      "service_name": "DIA - New Zealand Passport",
      "source_data": {
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "date_of_birth": "no_match",
        "full_name": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返回数据

`source_data` 中实际返回的字段取决于登记机构返回的内容。`nzl_new_zealand_passport` 的生成示例目前记录了以下标准化结构：

* `date_of_birth`
* `first_name`
* `identification_number`
* `last_name`

## 定价与 SLA

DIA - New Zealand Passport 查询仅在 Didit 从验证数据源收到明确结果时计费。

* **单次调用价格：** \$1.67 USD。
* **计费：** 按每次成功查询计费。登记机构无法访问、缺少必填字段或请求在到达数据源之前被拒绝时，不收费。
* **延迟：** 典型 p95 \< 2 s。
* **可用性：** Didit 一侧每季度 99.9%；下游数据源的可用性因国家/地区和数据集而异。

## 延伸阅读

* [新西兰数据库核验概览](https://docs.didit.me/api-reference/database-validation/new-zealand.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.