curl -X POST "https://verification.didit.me/v3/database-validation/" \
-H "x-api-key: YOUR_API_KEY" \
-F "issuing_state=ZAF" \
-F "services=zaf_refugee" \
-F "vendor_data=user-1234" \
-F "refugee_file_number=RF123456"
{
"request_id": "req_01H…",
"status": "Approved",
"issuing_state": "ZAF",
"match_type": "full_match",
"validations": [
{
"outcome_code": "MATCH",
"service_id": "zaf_refugee",
"service_name": "South Africa - Refugee File Verification",
"source_data": {},
"validation": {
"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_refugee",
"service_name": "South Africa - Refugee File Verification",
"source_data": {
"identification_number": "NO_MATCH"
},
"validation": {
"identification_number": "no_match"
}
}
]
}
🇿🇦 南アフリカ
南アフリカ 難民ファイル認証API
南アフリカの難民ファイルを、Didit経由で南アフリカの公的データベースに照会して認証します。1回あたり$1.28からの従量課金で、契約不要、最低利用額もありません。
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_refugee" \
-F "vendor_data=user-1234" \
-F "refugee_file_number=RF123456"
{
"request_id": "req_01H…",
"status": "Approved",
"issuing_state": "ZAF",
"match_type": "full_match",
"validations": [
{
"outcome_code": "MATCH",
"service_id": "zaf_refugee",
"service_name": "South Africa - Refugee File Verification",
"source_data": {},
"validation": {
"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_refugee",
"service_name": "South Africa - Refugee File Verification",
"source_data": {
"identification_number": "NO_MATCH"
},
"validation": {
"identification_number": "no_match"
}
}
]
}
難民ファイル番号を、南アフリカのDepartment of Home Affairsが管理する難民登録簿と照合します。Diditはこのサービスを
POST /v3/database-validation/で提供しており、送信されたデータを公式の情報源と照合して、正規化された照合結果を受け取ることができます。
対応範囲
- 対応範囲: -
- 国: 南アフリカ
- サービスID:
zaf_refugee - データ領域: 本人情報
- カテゴリ: 政府
入力
| フィールド | 必須 | 例 |
|---|---|---|
refugee_file_number | はい | RF123456 |
phone_number | いいえ | +15550101000 |
email | いいえ | john.doe@example.com |
vendor_data | いいえ | user-1234 |
- 必須入力:
refugee_file_number - 任意入力:
phone_number、email、vendor_data - 同意: 不要
- ワークフローでの利用: フィールドマッピングを設定すればワークフローで利用可能
- 対応範囲: -
- 料金: 成功したクエリ1件あたり$1.28
refugee_file_numberは本人確認書類に記載されていないため、どのステップも単独ではこの値を生成しません。アンケートの回答、Document AIの抽出フィールド、またはセッション作成時に送信する値からこの値を取得し、データベース検証ステップでマッピングしてください。マッピングされるまで、ワークフローエディターはこのサービスを無効として表示し、不足している入力を示します。実行時に入力が不足している場合はクエリの前にチェックがスキップされるため、照会できなかったデータベースに対して課金されることはありません。
ボディパラメーター
string
デフォルト:"ZAF"
必須
このデータベースサービスのISO 3166-1 alpha-3国コードです。例:
ZAFstring
デフォルト:"zaf_refugee"
必須
このサービスIDを含む配列です。サービスを固定することで、リクエストの対象をこのデータベースだけに限定できます。例:
zaf_refugeestring
デフォルト:"RF123456"
必須
このデータベースサービスで必要となる
refugee_file_numberの値です。例:RF123456string
このデータベースサービスで必要となる
phone_numberの値です。例:+15550101000string
メールアドレスです。例:
john.doe@example.comstring
デフォルト:"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_refugee" \
-F "vendor_data=user-1234" \
-F "refugee_file_number=RF123456"
成功した呼び出しはすべて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_refugee",
"service_name": "South Africa - Refugee File Verification",
"source_data": {},
"validation": {
"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_refugee",
"service_name": "South Africa - Refugee File Verification",
"source_data": {
"identification_number": "NO_MATCH"
},
"validation": {
"identification_number": "no_match"
}
}
]
}
返却されるデータ
source_dataに含まれる具体的なフィールドは、登録簿が返す内容によって異なります。zaf_refugeeの生成例では、現在次の正規化された形式が記載されています。
- 登録簿のレスポンスによって異なります。
料金とSLA
南アフリカ - 難民ファイル番号検証のクエリは、Diditが検証元から確定した結果を受け取った場合にのみ課金されます。- 1回の呼び出しあたりの料金: $1.28 USD。
- 請求: 成功したクエリ1件ごと。登録簿に接続できない場合、必須フィールドが不足している場合、またはリクエストが情報源に到達する前に拒否された場合は課金されません。
- レイテンシ: 通常、p95は2秒未満。
- 可用性: Didit側で四半期あたり99.9%。下流の情報源の可用性は国やデータセットによって異なります。
関連情報
最終更新日 2026年11月1日