curl -X POST "https://verification.didit.me/v3/database-validation/" \
-H "x-api-key: YOUR_API_KEY" \
-F "issuing_state=ZAF" \
-F "services=zaf_africa_national_id" \
-F "vendor_data=user-1234" \
-F "first_name=John" \
-F "last_name=Doe" \
-F "date_of_birth=1990-01-01" \
-F "national_id=SAMPLE-NID-12345"
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.database_validation.validate(
issuing_state="ZAF",
services=["zaf_africa_national_id"],
first_name="John",
last_name="Doe",
date_of_birth="1990-01-01",
national_id="SAMPLE-NID-12345",
vendor_data="user-1234",
)
print(result)
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_africa_national_id"],
first_name: "John",
last_name: "Doe",
date_of_birth: "1990-01-01",
national_id: "SAMPLE-NID-12345",
vendor_data: "user-1234",
});
console.log(result);
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_africa_national_id"}),
FirstName: didit.String("John"),
LastName: didit.String("Doe"),
DateOfBirth: didit.String("1990-01-01"),
NationalID: didit.String("SAMPLE-NID-12345"),
VendorData: didit.String("user-1234"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)
import java.time.LocalDate;
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_africa_national_id"))
.firstName("John")
.lastName("Doe")
.dateOfBirth(LocalDate.parse("1990-01-01"))
.nationalId("SAMPLE-NID-12345")
.vendorData("user-1234")
.build());
System.out.println(result);
<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->databaseValidation->validate([
'issuing_state' => 'ZAF',
'services' => ['zaf_africa_national_id'],
'first_name' => 'John',
'last_name' => 'Doe',
'date_of_birth' => '1990-01-01',
'national_id' => 'SAMPLE-NID-12345',
'vendor_data' => 'user-1234',
]);
print_r($result->toArray());
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.database_validation.validate(
issuing_state: "ZAF",
services: ["zaf_africa_national_id"],
first_name: "John",
last_name: "Doe",
date_of_birth: "1990-01-01",
national_id: "SAMPLE-NID-12345",
vendor_data: "user-1234"
)
puts result.to_h
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_africa_national_id" },
FirstName = "John",
LastName = "Doe",
DateOfBirth = "1990-01-01",
NationalId = "SAMPLE-NID-12345",
VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
{
"request_id": "req_01H…",
"status": "Approved",
"issuing_state": "ZAF",
"match_type": "full_match",
"validations": [
{
"outcome_code": "MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"first_name": "John",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"marital_status": "sample_value"
},
"validation": {
"date_of_birth": "full_match",
"full_name": "full_match",
"identification_number": "full_match"
}
}
]
}
{
"request_id": "req_01H…",
"status": "In Review",
"issuing_state": "ZAF",
"match_type": "partial_match",
"validations": [
{
"outcome_code": "PARTIAL_MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"first_name": "John",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"marital_status": "sample_value"
},
"validation": {
"date_of_birth": "full_match",
"full_name": "no_match",
"identification_number": "full_match"
}
}
]
}
{
"request_id": "req_01H…",
"status": "Declined",
"issuing_state": "ZAF",
"match_type": "no_match",
"validations": [
{
"outcome_code": "NO_MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"date_of_birth": "NO_MATCH",
"full_name": "NO_MATCH",
"identification_number": "NO_MATCH"
},
"validation": {
"date_of_birth": "no_match",
"full_name": "no_match",
"identification_number": "no_match"
}
}
]
}
{
"request_id": "req_01H…",
"status": "Declined",
"issuing_state": "ZAF",
"match_type": "no_match",
"validations": [
{
"outcome_code": "DOCUMENT_NOT_FOUND",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"date_of_birth": "NO_MATCH",
"full_name": "NO_MATCH",
"identification_number": "NO_MATCH"
},
"validation": {
"date_of_birth": "no_match",
"full_name": "no_match",
"identification_number": "no_match"
}
}
]
}
🇿🇦 南アフリカ
南アフリカ国民ID(DHA)照合API
南アフリカ国民ID(DHA):Didit経由で南アフリカの公的データベースを照会。1回$1.34からの従量課金、契約不要、最低利用額なし。
POST
/
v3
/
database-validation
/
curl -X POST "https://verification.didit.me/v3/database-validation/" \
-H "x-api-key: YOUR_API_KEY" \
-F "issuing_state=ZAF" \
-F "services=zaf_africa_national_id" \
-F "vendor_data=user-1234" \
-F "first_name=John" \
-F "last_name=Doe" \
-F "date_of_birth=1990-01-01" \
-F "national_id=SAMPLE-NID-12345"
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.database_validation.validate(
issuing_state="ZAF",
services=["zaf_africa_national_id"],
first_name="John",
last_name="Doe",
date_of_birth="1990-01-01",
national_id="SAMPLE-NID-12345",
vendor_data="user-1234",
)
print(result)
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_africa_national_id"],
first_name: "John",
last_name: "Doe",
date_of_birth: "1990-01-01",
national_id: "SAMPLE-NID-12345",
vendor_data: "user-1234",
});
console.log(result);
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_africa_national_id"}),
FirstName: didit.String("John"),
LastName: didit.String("Doe"),
DateOfBirth: didit.String("1990-01-01"),
NationalID: didit.String("SAMPLE-NID-12345"),
VendorData: didit.String("user-1234"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)
import java.time.LocalDate;
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_africa_national_id"))
.firstName("John")
.lastName("Doe")
.dateOfBirth(LocalDate.parse("1990-01-01"))
.nationalId("SAMPLE-NID-12345")
.vendorData("user-1234")
.build());
System.out.println(result);
<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->databaseValidation->validate([
'issuing_state' => 'ZAF',
'services' => ['zaf_africa_national_id'],
'first_name' => 'John',
'last_name' => 'Doe',
'date_of_birth' => '1990-01-01',
'national_id' => 'SAMPLE-NID-12345',
'vendor_data' => 'user-1234',
]);
print_r($result->toArray());
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.database_validation.validate(
issuing_state: "ZAF",
services: ["zaf_africa_national_id"],
first_name: "John",
last_name: "Doe",
date_of_birth: "1990-01-01",
national_id: "SAMPLE-NID-12345",
vendor_data: "user-1234"
)
puts result.to_h
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_africa_national_id" },
FirstName = "John",
LastName = "Doe",
DateOfBirth = "1990-01-01",
NationalId = "SAMPLE-NID-12345",
VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
{
"request_id": "req_01H…",
"status": "Approved",
"issuing_state": "ZAF",
"match_type": "full_match",
"validations": [
{
"outcome_code": "MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"first_name": "John",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"marital_status": "sample_value"
},
"validation": {
"date_of_birth": "full_match",
"full_name": "full_match",
"identification_number": "full_match"
}
}
]
}
{
"request_id": "req_01H…",
"status": "In Review",
"issuing_state": "ZAF",
"match_type": "partial_match",
"validations": [
{
"outcome_code": "PARTIAL_MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"first_name": "John",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"marital_status": "sample_value"
},
"validation": {
"date_of_birth": "full_match",
"full_name": "no_match",
"identification_number": "full_match"
}
}
]
}
{
"request_id": "req_01H…",
"status": "Declined",
"issuing_state": "ZAF",
"match_type": "no_match",
"validations": [
{
"outcome_code": "NO_MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"date_of_birth": "NO_MATCH",
"full_name": "NO_MATCH",
"identification_number": "NO_MATCH"
},
"validation": {
"date_of_birth": "no_match",
"full_name": "no_match",
"identification_number": "no_match"
}
}
]
}
{
"request_id": "req_01H…",
"status": "Declined",
"issuing_state": "ZAF",
"match_type": "no_match",
"validations": [
{
"outcome_code": "DOCUMENT_NOT_FOUND",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"date_of_birth": "NO_MATCH",
"full_name": "NO_MATCH",
"identification_number": "NO_MATCH"
},
"validation": {
"date_of_birth": "no_match",
"full_name": "no_match",
"identification_number": "no_match"
}
}
]
}
入力データを南アフリカのDepartment of Home Affairs(DHA)の登録簿と照合します。Diditはこのサービスを
POST /v3/database-validation/で提供しており、送信されたデータを公的な情報源と照合して、正規化された照合結果を受け取ることができます。
カバレッジ
- カバー率: 約100%
- 国: 南アフリカ
- サービスID:
zaf_africa_national_id - データドメイン: 本人情報
- カテゴリ: NationalIDRegistry
入力
| フィールド | 必須 | 例 |
|---|---|---|
first_name | はい | John |
last_name | はい | Doe |
date_of_birth | はい | 1990-01-01 |
national_id | はい | SAMPLE-NID-12345 |
vendor_data | いいえ | user-1234 |
- 必須の入力:
first_name、last_name、date_of_birth、national_id - 任意の入力:
vendor_data - 同意: 不要
- ワークフローでの利用: ワークフローで利用可能
- カバー率: 約100%
- 料金: 成功した照会1件あたり$1.34
ボディパラメーター
string
デフォルト:"ZAF"
必須
このデータベースサービスのISO 3166-1 alpha-3国コードです。例:
ZAFstring
デフォルト:"zaf_africa_national_id"
必須
このサービスIDを含む配列です。サービスを指定することで、リクエストの対象をこのデータベースに限定できます。例:
zaf_africa_national_idstring
デフォルト:"John"
必須
検証する名です。例:
Johnstring
デフォルト:"Doe"
必須
検証する姓です。例:
Doestring
デフォルト:"1990-01-01"
必須
YYYY-MM-DD形式の生年月日です。例:1990-01-01string
デフォルト:"SAMPLE-NID-12345"
必須
このサービスで使用する国民識別番号です。例:
SAMPLE-NID-12345string
デフォルト:"user-1234"
社内のユーザーIDなど、この人物に対する固定のユーザー参照値です。Diditはこれを使って単独のチェックを同じエンドユーザーに紐付け、重複検知のノイズを減らします。例:
user-1234入力ルールと検証に関する注意事項
- 上記のフィールドは、ユーザーまたは書類から取得したとおりに正確に送信してください。
- Diditはデータベースを照会する前に必須フィールドを検証します。情報源への照会前に却下されたリクエストには課金されません。
呼び出し方法
curl -X POST "https://verification.didit.me/v3/database-validation/" \
-H "x-api-key: YOUR_API_KEY" \
-F "issuing_state=ZAF" \
-F "services=zaf_africa_national_id" \
-F "vendor_data=user-1234" \
-F "first_name=John" \
-F "last_name=Doe" \
-F "date_of_birth=1990-01-01" \
-F "national_id=SAMPLE-NID-12345"
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.database_validation.validate(
issuing_state="ZAF",
services=["zaf_africa_national_id"],
first_name="John",
last_name="Doe",
date_of_birth="1990-01-01",
national_id="SAMPLE-NID-12345",
vendor_data="user-1234",
)
print(result)
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_africa_national_id"],
first_name: "John",
last_name: "Doe",
date_of_birth: "1990-01-01",
national_id: "SAMPLE-NID-12345",
vendor_data: "user-1234",
});
console.log(result);
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_africa_national_id"}),
FirstName: didit.String("John"),
LastName: didit.String("Doe"),
DateOfBirth: didit.String("1990-01-01"),
NationalID: didit.String("SAMPLE-NID-12345"),
VendorData: didit.String("user-1234"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)
import java.time.LocalDate;
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_africa_national_id"))
.firstName("John")
.lastName("Doe")
.dateOfBirth(LocalDate.parse("1990-01-01"))
.nationalId("SAMPLE-NID-12345")
.vendorData("user-1234")
.build());
System.out.println(result);
<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->databaseValidation->validate([
'issuing_state' => 'ZAF',
'services' => ['zaf_africa_national_id'],
'first_name' => 'John',
'last_name' => 'Doe',
'date_of_birth' => '1990-01-01',
'national_id' => 'SAMPLE-NID-12345',
'vendor_data' => 'user-1234',
]);
print_r($result->toArray());
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.database_validation.validate(
issuing_state: "ZAF",
services: ["zaf_africa_national_id"],
first_name: "John",
last_name: "Doe",
date_of_birth: "1990-01-01",
national_id: "SAMPLE-NID-12345",
vendor_data: "user-1234"
)
puts result.to_h
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_africa_national_id" },
FirstName = "John",
LastName = "Doe",
DateOfBirth = "1990-01-01",
NationalId = "SAMPLE-NID-12345",
VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
成功した呼び出しはすべてHTTP 200を返します。実際に何が起きたかはoutcome_codeフィールドで判断できます。たとえば、実際の生体情報の不一致(BIOMETRIC_NO_MATCH)と、セルフィーを読み取れなかった場合(BIOMETRIC_IMAGE_UNUSABLE)を区別できます。表示されるstatusは機能のデフォルトのステータスであり、設定済みの部分一致/不一致時のアクションによって上書きされる場合があります。MATCH:登録簿が本人であることを確認し、照合したすべてのフィールドが一致しました。{
"request_id": "req_01H…",
"status": "Approved",
"issuing_state": "ZAF",
"match_type": "full_match",
"validations": [
{
"outcome_code": "MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"first_name": "John",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"marital_status": "sample_value"
},
"validation": {
"date_of_birth": "full_match",
"full_name": "full_match",
"identification_number": "full_match"
}
}
]
}
PARTIAL_MATCH:識別番号は見つかりましたが、1つ以上の個人情報フィールド(通常は氏名または生年月日)が完全には一致しませんでした。{
"request_id": "req_01H…",
"status": "In Review",
"issuing_state": "ZAF",
"match_type": "partial_match",
"validations": [
{
"outcome_code": "PARTIAL_MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"first_name": "John",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"marital_status": "sample_value"
},
"validation": {
"date_of_birth": "full_match",
"full_name": "no_match",
"identification_number": "full_match"
}
}
]
}
NO_MATCH:送信されたデータに一致するものが登録簿から返されませんでした。{
"request_id": "req_01H…",
"status": "Declined",
"issuing_state": "ZAF",
"match_type": "no_match",
"validations": [
{
"outcome_code": "NO_MATCH",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"date_of_birth": "NO_MATCH",
"full_name": "NO_MATCH",
"identification_number": "NO_MATCH"
},
"validation": {
"date_of_birth": "no_match",
"full_name": "no_match",
"identification_number": "no_match"
}
}
]
}
DOCUMENT_NOT_FOUND:送信された書類番号が登録簿のどの記録にも該当しません。{
"request_id": "req_01H…",
"status": "Declined",
"issuing_state": "ZAF",
"match_type": "no_match",
"validations": [
{
"outcome_code": "DOCUMENT_NOT_FOUND",
"service_id": "zaf_africa_national_id",
"service_name": "South Africa National ID (DHA)",
"source_data": {
"date_of_birth": "NO_MATCH",
"full_name": "NO_MATCH",
"identification_number": "NO_MATCH"
},
"validation": {
"date_of_birth": "no_match",
"full_name": "no_match",
"identification_number": "no_match"
}
}
]
}
返却されるデータ
source_dataに含まれる具体的なフィールドは、登録簿が返す内容によって異なります。zaf_africa_national_idの生成済みサンプルでは、現在次の正規化された形式が記載されています。
first_nameidentification_numberlast_namemarital_status
料金とSLA
南アフリカの国民ID(DHA)の照会は、Diditが検証元から確定的な結果を受け取った場合にのみ課金されます。- 呼び出し1件あたりの料金: $1.34 USD。
- 請求: 成功した照会ごとに課金されます。登録簿に接続できない場合、必須フィールドが欠けている場合、またはリクエストが情報源に到達する前に却下された場合は課金されません。
- レイテンシー: 通常、p95は2秒未満です。
- 可用性: Didit側で四半期あたり99.9%。下流の情報源の可用性は国とデータセットによって異なります。
関連情報
最終更新日 2026年11月1日