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

# 南非国民身份证（DHA）验证 API

> 通过 Didit 查询南非权威数据库中的国民身份证（DHA）信息。起价 $1.34，按次付费，无需合约，无最低消费。

根据南非内政部（Department of Home Affairs，DHA）的登记库核验输入数据。Didit 通过 `POST /v3/database-validation/` 提供此服务，使您能够将提交的数据与权威数据源进行比对，并获得标准化的匹配结果。

## 覆盖范围

* **覆盖率：** \~ 100%
* **国家/地区：** 南非
* **服务 ID：** `zaf_africa_national_id`
* **数据领域：** 身份
* **类别：** NationalIDRegistry

## 输入项

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

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

## 请求体参数

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

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

示例：`ZAF`

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

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

示例：`zaf_africa_national_id`

**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`

**national\_id** `string` *required* (default: SAMPLE-NID-12345)

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

示例：`SAMPLE-NID-12345`

**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=ZAF" \
  -F "services=zaf_africa_national_id" \
  -F "vendor_data=user-1234" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F "national_id=SAMPLE-NID-12345"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="ZAF",
    services=["zaf_africa_national_id"],
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    national_id="SAMPLE-NID-12345",
    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: "ZAF",
  services: ["zaf_africa_national_id"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  national_id: "SAMPLE-NID-12345",
  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: "ZAF",
	Services:     didit.Some([]string{"zaf_africa_national_id"}),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	DateOfBirth:  didit.String("1990-01-01"),
	NationalID:   didit.String("SAMPLE-NID-12345"),
	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("ZAF")
        .services(List.of("zaf_africa_national_id"))
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .nationalId("SAMPLE-NID-12345")
        .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' => 'ZAF',
    'services' => ['zaf_africa_national_id'],
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'national_id' => 'SAMPLE-NID-12345',
    '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: "ZAF",
  services: ["zaf_africa_national_id"],
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  national_id: "SAMPLE-NID-12345",
  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 = "ZAF",
    Services = new string[] { "zaf_africa_national_id" },
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    NationalId = "SAMPLE-NID-12345",
    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": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_africa_national_id",
      "service_name": "South Africa National ID (DHA)",
      "source_data": {
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "marital_status": "sample_value"
      },
      "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": "ZAF",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "zaf_africa_national_id",
      "service_name": "South Africa National ID (DHA)",
      "source_data": {
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "marital_status": "sample_value"
      },
      "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": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_africa_national_id",
      "service_name": "South Africa National ID (DHA)",
      "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"
      }
    }
  ]
}
```

**`DOCUMENT_NOT_FOUND`**：所提交的证件号码在登记库中没有对应记录。

```json 200 OK — DOCUMENT_NOT_FOUND theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "DOCUMENT_NOT_FOUND",
      "service_id": "zaf_africa_national_id",
      "service_name": "South Africa National ID (DHA)",
      "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` 中实际返回的字段取决于登记库的返回内容。`zaf_africa_national_id` 的自动生成示例目前记录了以下标准化结构：

* `first_name`
* `identification_number`
* `last_name`
* `marital_status`

## 定价与 SLA

南非国民身份证（DHA）查询仅在 Didit 从核验数据源收到确定性结果时计费。

* **单次调用价格：** \$1.34 美元。
* **计费方式：** 按每次成功查询计费。若登记库无法访问、缺少必填字段，或请求在到达数据源之前被拒绝，则不收费。
* **延迟：** 典型 p95 小于 2 秒。
* **可用性：** Didit 方面每季度为 99.9%；下游数据源的可用性因国家/地区和数据集而异。

## 延伸阅读

* [南非数据库核验概览](https://docs.didit.me/api-reference/database-validation/south-africa.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.