> ## 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 提供南非权威数据库的人脸犯罪记录筛查，按次付费，起价 $8.00，无需合同，无最低消费。

根据已公布的刑事犯罪记录数据集对人脸图像进行筛查，以发现潜在匹配。Didit 通过 `POST /v3/database-validation/` 提供此服务，帮助您将提交的数据与权威数据源进行核验，并获得标准化的匹配结果。

## 覆盖范围

* **覆盖范围：** —
* **国家/地区：** 南非
* **服务 ID：** `zaf_criminal_face_screening`
* **数据领域：** 犯罪记录
* **类别：** 刑事

## 输入参数

| 字段 | 必填 | 示例 |
| - | -: | - |
| `selfie` | 是 | `@./selfie.jpg` |
| `score_level` | 否 | `standard` |
| `max_matches` | 否 | `10` |
| `vendor_data` | 否 | `user-1234` |

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

## 请求体参数

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

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

示例：`ZAF`

**services** `string` *required* (default: zaf\_criminal\_face\_screening)

包含此服务 ID 的数组。将服务固定后，可将请求限定到这个确切的数据库。

示例：`zaf_criminal_face_screening`

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

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

示例：`true`

**selfie** `file` *required*

用于生物识别数据库核验的自拍照图片文件。支持的格式：JPEG、PNG 或 WebP。

示例：`@./selfie.jpg`

**score\_level** `string`

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

示例：`standard`

**max\_matches** `string`

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

示例：`10`

**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_criminal_face_screening" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "selfie=@./selfie.jpg"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="ZAF",
    services=["zaf_criminal_face_screening"],
    consent=True,
    vendor_data="user-1234",
    selfie=open("selfie.jpg", "rb"),
)
print(result)
```

```javascript Node.js theme={null}
import Didit, { fileFromPath } from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "ZAF",
  services: ["zaf_criminal_face_screening"],
  consent: true,
  vendor_data: "user-1234",
  selfie: await fileFromPath("selfie.jpg"),
});
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_criminal_face_screening"}),
	Consent:      didit.Bool(true),
	VendorData:   didit.String("user-1234"),
	Selfie:       didit.Some(didit.FileFromPath("selfie.jpg")),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.nio.file.Path;
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_criminal_face_screening"))
        .consent(true)
        .vendorData("user-1234")
        .selfie(Path.of("selfie.jpg"))
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'ZAF',
    'services' => ['zaf_criminal_face_screening'],
    'consent' => true,
    'vendor_data' => 'user-1234',
    'selfie' => File::fromPath('selfie.jpg'),
]);
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_criminal_face_screening"],
  consent: true,
  vendor_data: "user-1234",
  selfie: Pathname("selfie.jpg")
)
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_criminal_face_screening" },
    Consent = true,
    VendorData = "user-1234",
    Selfie = FileUpload.FromPath("selfie.jpg"),
});
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_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "criminal_matches": "sample_value",
        "face_quality": "sample_value",
        "request_id": "SAMPLE-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_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`BIOMETRIC_NO_MATCH`**：人脸比对匹配分数低于接受阈值，即自拍照与登记机构照片不是同一人。

```json 200 OK — BIOMETRIC_NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_NO_MATCH",
      "service_id": "zaf_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

**`BIOMETRIC_IMAGE_UNUSABLE`**：无法处理自拍照（为空、未检测到人脸、质量过低，或登记机构无法读取）。请提示用户重新拍摄自拍照。

```json 200 OK — BIOMETRIC_IMAGE_UNUSABLE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "BIOMETRIC_IMAGE_UNUSABLE",
      "service_id": "zaf_criminal_face_screening",
      "service_name": "South Africa - Criminal Screening by Face",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返回数据

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

* `criminal_matches`
* `face_quality`
* `request_id`

## 定价与 SLA

南非 - 人脸刑事筛查查询仅在 Didit 从核验数据源收到确定结果时计费。

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