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.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"
}
}
]
}
根据南非内政部难民登记库核验难民档案编号。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.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.28 USD。
- 计费方式: 按每次成功查询计费。当登记库无法访问、缺少必填字段,或请求在到达数据源之前被拒绝时,您不会被收费。
- 延迟: 典型 p95 < 2 s。
- 可用性: Didit 侧每季度 99.9%;下游数据源的可用性因国家/地区和数据集而异。
继续阅读
最后修改于 2026年11月7日