> ## 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.30，无合同、无最低消费。

根据南非欺诈防范服务（SAFPS）观察名单对个人进行筛查。Didit 通过 `POST /v3/database-validation/` 提供此服务，使您可以将提交的数据与权威来源进行核对，并获得标准化的匹配结果。

## 覆盖范围

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

## 输入

| 字段 | 是否必填 | 示例 |
| - | -: | - |
| `national_id` | 否 | `SAMPLE-NID-12345` |
| `bank_account_number` | 否 | `1234567890` |
| `phone_number` | 否 | `+15550101000` |
| `email` | 否 | `john.doe@example.com` |
| `vendor_data` | 否 | `user-1234` |

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

## 请求体参数

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

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

示例：`ZAF`

**services** `string` *required* (default: zaf\_fraud\_prevention)

包含此服务 ID 的数组。固定服务 ID 可使请求仅限于此确切数据库。

示例：`zaf_fraud_prevention`

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

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

示例：`true`

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

此服务的国民身份号码。

示例：`SAMPLE-NID-12345`

**bank\_account\_number** `string`

此数据库服务所需的 `bank_account_number` 值。

示例：`1234567890`

**phone\_number** `string`

此数据库服务所需的 `phone_number` 值。

示例：`+15550101000`

**email** `string`

电子邮箱地址。

示例：`john.doe@example.com`

**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_fraud_prevention" \
  -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_fraud_prevention"],
    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_fraud_prevention"],
  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_fraud_prevention"}),
	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_fraud_prevention"))
        .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_fraud_prevention'],
    '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_fraud_prevention"],
  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_fraud_prevention" },
    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_fraud_prevention",
      "service_name": "South Africa - Fraud Prevention Screening",
      "source_data": {
        "fraud_listings": "sample_value",
        "identification_number": "SAMPLE-ID-12345"
      },
      "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_fraud_prevention",
      "service_name": "South Africa - Fraud Prevention Screening",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返回数据

`source_data` 中实际返回的字段取决于注册表返回的内容。`zaf_fraud_prevention` 生成示例目前记录的标准化结构如下：

* `fraud_listings`
* `identification_number`

## 定价与 SLA

南非欺诈防范筛查查询仅在 Didit 从核验来源收到明确结果时计费。

* **单次调用价格：** \$0.30 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.