> ## 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`
* **同意：** 必須
* **ワークフローでの利用：** 利用可能
* **対象範囲：** -
* **料金：** 成功したクエリ1件あたり\$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/ja/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が検証元から確定的な結果を受け取った場合にのみ課金されます。

* **呼び出し1回あたりの料金：** \$8.00 USD。
* **請求：** 成功したクエリ1件あたり。登録機関に接続できない場合、必須フィールドが不足している場合、またはリクエストが情報源に到達する前に拒否された場合は課金されません。
* **レイテンシー：** p95で通常2秒未満。
* **可用性：** Didit側で四半期あたり99.9%。下流の情報源の可用性は国やデータセットによって異なります。

## 関連情報

* [南アフリカのデータベース検証の概要](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [データベース検証の概要](https://docs.didit.me/ja/core-technology/database-validation/overview.md)
* [結果コード](https://docs.didit.me/ja/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.