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"
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)
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);
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)
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
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());
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
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));
{
"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"
}
}
]
}
{
"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"
}
}
]
}
🇿🇦 África do Sul
API de recuperação de foto do DHA da África do Sul
Consulta à base oficial do DHA da África do Sul com recuperação de foto via Didit. A partir de $1.34 por chamada, sem contratos nem mínimos.
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_dha_photo" \
-F "vendor_data=user-1234" \
-F "consent=true" \
-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_dha_photo"],
consent=True,
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_dha_photo"],
consent: true,
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_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)
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
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());
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
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));
{
"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"
}
}
]
}
{
"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"
}
}
]
}
Recupera a fotografia registrada no Department of Home Affairs para um número de identidade sul-africano. A Didit disponibiliza este serviço por meio de
POST /v3/database-validation/ para que você possa comparar os dados enviados com a fonte oficial e receber resultados de correspondência normalizados.
Cobertura
- Cobertura: —
- País: África do Sul
- ID do serviço:
zaf_dha_photo - Domínio de dados: Biométrico
- Categoria: Governo
Entradas
| Campo | Obrigatório | Exemplo |
|---|---|---|
national_id | Sim | SAMPLE-NID-12345 |
vendor_data | Não | user-1234 |
- Entradas obrigatórias:
national_id - Entradas opcionais:
vendor_data - Consentimento: Obrigatório
- Disponibilidade no workflow: Disponível no fluxo
- Cobertura: —
- Preço: $1.34 por consulta bem-sucedida
Parâmetros do corpo
string
padrão:"ZAF"
obrigatório
Código de país ISO 3166-1 alpha-3 para este serviço de banco de dados.Exemplo:
ZAFstring
padrão:"zaf_dha_photo"
obrigatório
Array que contém este ID de serviço. Fixar o serviço mantém o escopo da requisição limitado a este banco de dados específico.Exemplo:
zaf_dha_photoboolean
padrão:"true"
obrigatório
Consentimento explícito do usuário final para este serviço.Exemplo:
truestring
padrão:"SAMPLE-NID-12345"
obrigatório
Número de identidade nacional para este serviço.Exemplo:
SAMPLE-NID-12345string
padrão:"user-1234"
Sua referência estável de usuário para esta pessoa, como o seu ID interno de usuário. A Didit a utiliza para vincular verificações avulsas ao mesmo usuário final e reduzir o ruído na detecção de duplicatas.Exemplo:
user-1234Regras de entrada e notas de validação
- Envie os campos listados acima exatamente como foram capturados do usuário ou do documento.
- A Didit valida os campos obrigatórios antes de chamar o banco de dados. Requisições rejeitadas antes da consulta à fonte não são cobradas.
Como chamar
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"
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)
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);
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)
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
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());
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
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));
Toda chamada bem-sucedida retorna HTTP 200. O campo outcome_code informa o que de fato aconteceu, distinguindo, por exemplo, uma divergência biométrica real (BIOMETRIC_NO_MATCH) de uma selfie que não pôde ser lida (BIOMETRIC_IMAGE_UNUSABLE). O status exibido é o status padrão do recurso; as ações de correspondência parcial / sem correspondência que você configurou podem substituí-lo.MATCH: o registro confirmou a identidade e todos os campos verificados corresponderam.{
"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: o registro não retornou nenhuma correspondência para os dados enviados.{
"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"
}
}
]
}
Dados retornados
Os campos exatos apresentados emsource_data dependem do que o registro retorna. O exemplo gerado para zaf_dha_photo documenta atualmente esta estrutura normalizada:
birth_place_country_codedeceasedfirst_nameid_blockedidentification_numberlast_namemarital_statuson_hanis_biometric_registeron_national_population_registerphoto_base64smart_card_issuedtransaction_number
Preços e SLAs
As consultas de África do Sul - DHA Photo Retrieval são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.- Preço por chamada: $1.34 USD.
- Faturamento: por consulta bem-sucedida. Você não é cobrado quando o registro está indisponível, quando faltam campos obrigatórios ou quando a requisição é rejeitada antes de chegar à fonte.
- Latência: p95 típico < 2 s.
- Disponibilidade: 99.9% por trimestre por parte da Didit; a disponibilidade da fonte externa varia conforme o país e o conjunto de dados.
Continue lendo
Última modificação em 1 de novembro de 2026