> ## 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コール$1.34から、契約不要・最低利用額なし。

南アフリカのID番号に対応する、Department of Home Affairsに登録された顔写真を取得します。Diditはこのサービスを`POST /v3/database-validation/`で提供しており、送信されたデータを公的な情報源と照合し、正規化された照合結果を受け取ることができます。

## 対象範囲

* **対象範囲：** -
* **国：** 南アフリカ
* **サービスID：** `zaf_dha_photo`
* **データ領域：** 生体情報
* **カテゴリ：** 政府機関

## 入力

| フィールド | 必須 | 例 |
| - | -: | - |
| `national_id` | はい | `SAMPLE-NID-12345` |
| `vendor_data` | いいえ | `user-1234` |

* **必須の入力：** `national_id`
* **任意の入力：** `vendor_data`
* **同意：** 必須
* **ワークフローでの利用：** ワークフローで利用可能
* **対象範囲：** -
* **料金：** 成功したクエリ1件あたり\$1.34

## ボディパラメーター

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

このデータベースサービスのISO 3166-1 alpha-3国コードです。

例：`ZAF`

**services** `string` *required* (default: zaf\_dha\_photo)

このサービスIDを含む配列です。サービスを固定することで、リクエストの対象をこのデータベースのみに限定できます。

例：`zaf_dha_photo`

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

このサービスに対するエンドユーザーの明示的な同意です。

例：`true`

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

このサービスで使用する国民ID番号です。

例：`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_dha_photo" \
  -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_dha_photo"],
    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_dha_photo"],
  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_dha_photo"}),
	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_dha_photo"))
        .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_dha_photo'],
    '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_dha_photo"],
  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_dha_photo" },
    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/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_dha_photo",
      "service_name": "South Africa - DHA Photo Retrieval",
      "source_data": {
        "birth_place_country_code": "sample_value",
        "deceased": "sample_value",
        "first_name": "John",
        "id_blocked": false,
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "marital_status": "sample_value",
        "on_hanis_biometric_register": "sample_value",
        "on_national_population_register": "sample_value",
        "photo_base64": "sample_value",
        "smart_card_issued": "sample_value",
        "transaction_number": "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_dha_photo",
      "service_name": "South Africa - DHA Photo Retrieval",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返されるデータ

`source_data`に含まれる具体的なフィールドは、登録機関が返す内容によって異なります。`zaf_dha_photo`の生成済みサンプルでは、現在以下の正規化された形式が記載されています。

* `birth_place_country_code`
* `deceased`
* `first_name`
* `id_blocked`
* `identification_number`
* `last_name`
* `marital_status`
* `on_hanis_biometric_register`
* `on_national_population_register`
* `photo_base64`
* `smart_card_issued`
* `transaction_number`

## 料金とSLA

South Africa - DHA Photo Retrievalのクエリは、Diditが検証元から確定的な結果を受け取った場合にのみ課金されます。

* **1回あたりの料金：** \$1.34 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.