> ## 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：联系方式查询（ID 匹配）

> Didit 提供南非 Contactability Lookup（联系方式查询），通过南非权威数据库完成核验。按次计费，起价 $0.35，无合约、无最低消费。

返回与南非个人关联的已知电话号码、电子邮件和地址。Didit 通过 `POST /v3/database-validation/` 提供此服务，帮助您将提交的数据与权威来源进行比对，并获得标准化的匹配结果。

## 覆盖范围

* **覆盖范围：** —
* **国家/地区：** 南非
* **服务 ID：** `zaf_contactability`
* **数据领域：** 电信
* **类别：** 电信

## 输入

| 字段 | 必填 | 示例 |
| - | -: | - |
| `national_id` | 是 | `SAMPLE-NID-12345` |
| `vendor_data` | 否 | `user-1234` |

* **必填输入：** `national_id`
* **可选输入：** `vendor_data`
* **同意：** 必需
* **工作流可用性：** 可在工作流中使用
* **覆盖范围：** —
* **价格：** 每次成功查询 \$0.35

## 请求体参数

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

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

示例：`ZAF`

**services** `string` *required* (default: zaf\_contactability)

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

示例：`zaf_contactability`

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

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

示例：`true`

**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_contactability" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -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_contactability"],
    consent=True,
    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_contactability"],
  consent: true,
  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_contactability"}),
	Consent:      didit.Bool(true),
	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.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_contactability"))
        .consent(true)
        .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_contactability'],
    'consent' => true,
    '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_contactability"],
  consent: true,
  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_contactability" },
    Consent = true,
    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_contactability",
      "service_name": "South Africa - Contactability Lookup",
      "source_data": {
        "contact_email": "alex.sample@example.com",
        "contact_phone_numbers": "+15550101000",
        "date_of_birth": "1990-01-01",
        "deceased": "sample_value",
        "first_name": "John",
        "gender": "M",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "phone_history_count": "+15550101000"
      },
      "validation": {
        "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_contactability",
      "service_name": "South Africa - Contactability Lookup",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返回数据

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

* `contact_email`
* `contact_phone_numbers`
* `date_of_birth`
* `deceased`
* `first_name`
* `gender`
* `identification_number`
* `last_name`
* `phone_history_count`

## 定价与 SLA

南非 - 联系方式查询仅在 Didit 从验证来源收到明确结果时计费。

* **单次调用价格：** \$0.35 USD。
* **计费方式：** 按每次成功查询计费。若登记机构无法访问、缺少必填字段，或请求在到达数据源之前被拒绝，则不收取费用。
* **延迟：** 典型 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.