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

# 尼日利亚国民身份证（NIMC）核验 API

> Didit提供尼日利亚国民身份证（NIMC）权威数据库核验，基于其身份基础设施。按次计费，起价$0.20，无合同、无最低消费。

核验数据与国家身份数据库比对。Didit 通过 `POST /v3/database-validation/` 提供此服务，帮助您将提交的数据与权威来源进行核验，并获得标准化的匹配结果。

## 覆盖范围

* **覆盖率：** \~ 100%
* **国家/地区：** 尼日利亚
* **服务 ID：** `nga_national_id`
* **数据领域：** 身份
* **类别：** NationalIDRegistry

## 输入参数

| 字段 | 必填 | 示例 |
| - | -: | - |
| `first_name` | 是 | `John` |
| `last_name` | 是 | `Doe` |
| `national_id` | 是 | `11111111111` |
| `date_of_birth` | 否 | `1990-01-01` |
| `vendor_data` | 否 | `user-1234` |

* **必填输入：** `first_name`、`last_name`、`national_id`
* **可选输入：** `date_of_birth`、`vendor_data`
* **同意：** 无需
* **工作流可用性：** 可在工作流中使用
* **覆盖率：** \~ 100%
* **价格：** 每次成功查询 \$0.20

并非此服务接受的每份证件都包含用于查询的标识符。如果未能从证件中提取该标识符，核验将记录为**不适用**，不会查询数据库，也不收费。对部分国家而言，这种情况占真实用户的相当大比例。为覆盖这些用户，您还需从问卷答案、Document AI 提取字段，或创建会话时发送的值中收集该标识符，并将其映射到数据库核验步骤。

## 请求体参数

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

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

示例：`NGA`

**services** `string` *required* (default: nga\_national\_id)

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

示例：`nga_national_id`

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

需要校验的名字。

示例：`John`

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

需要校验的姓氏。

示例：`Doe`

**national\_id** `string` *required* (default: 11111111111)

此服务使用的国民身份号码。

示例：`11111111111`

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

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

示例：`1990-01-01`

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

您为该用户提供的稳定用户标识，例如您内部的用户 ID。Didit 用它将独立核验关联到同一终端用户，以减少重复检测的干扰。

示例：`user-1234`

## 输入规则与校验说明

* `first_name` 必须匹配 `[A-Za-zÀ-ÖØ-öø-ÿ .'-]+`。
* `national_id` 只能包含数字。发送请求前，请删除空格、连字符和标点符号。
* `national_id` 的长度必须恰好为 11 个字符。

## 如何调用

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=NGA" \
  -F "services=nga_national_id" \
  -F "vendor_data=user-1234" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "national_id=11111111111"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="NGA",
    services=["nga_national_id"],
    first_name="John",
    last_name="Doe",
    national_id="11111111111",
    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: "NGA",
  services: ["nga_national_id"],
  first_name: "John",
  last_name: "Doe",
  national_id: "11111111111",
  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: "NGA",
	Services:     didit.Some([]string{"nga_national_id"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	NationalID:   didit.String("11111111111"),
	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("NGA")
        .services(List.of("nga_national_id"))
        .firstName("John")
        .lastName("Doe")
        .nationalId("11111111111")
        .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' => 'NGA',
    'services' => ['nga_national_id'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'national_id' => '11111111111',
    '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: "NGA",
  services: ["nga_national_id"],
  first_name: "John",
  last_name: "Doe",
  national_id: "11111111111",
  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 = "NGA",
    Services = new string[] { "nga_national_id" },
    FirstName = "John",
    LastName = "Doe",
    NationalId = "11111111111",
    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": "NGA",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "nga_national_id",
      "service_name": "Nigeria National ID (NIMC)",
      "source_data": {
        "first_name": "John",
        "full_name": "John Doe",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "name_match_score": "1.000"
      },
      "validation": {
        "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": "NGA",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "nga_national_id",
      "service_name": "Nigeria National ID (NIMC)",
      "source_data": {
        "first_name": "John",
        "full_name": "John Doe",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "name_match_score": "1.000"
      },
      "validation": {
        "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": "NGA",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "nga_national_id",
      "service_name": "Nigeria National ID (NIMC)",
      "source_data": {
        "full_name": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "full_name": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返回数据

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

* `first_name`
* `full_name`
* `identification_number`
* `last_name`
* `name_match_score`

## 定价与 SLA

只有当 Didit 从核验来源收到确定性结果时，尼日利亚国家身份（NIMC）查询才会计费。

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

## 延伸阅读

* [尼日利亚数据库核验概览](https://docs.didit.me/api-reference/database-validation/nigeria.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.