curl -X POST "https://verification.didit.me/v3/database-validation/" \
-H "x-api-key: YOUR_API_KEY" \
-F "issuing_state=ZAF" \
-F "services=zaf_contactability" \
-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_contactability"],
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_contactability"],
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_contactability"}),
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_contactability"))
.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_contactability'],
'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_contactability"],
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_contactability" },
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_contactability",
"service_name": "South Africa - Contactability Lookup",
"source_data": {
"contact_email": "alex.sample@example.com",
"contact_phone_numbers": "+15550101000",
"date_of_birth": "1990-01-01",
"deceased": "sample_value",
"first_name": "John",
"gender": "M",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"phone_history_count": "+15550101000"
},
"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_contactability",
"service_name": "South Africa - Contactability Lookup",
"source_data": {
"identification_number": "NO_MATCH"
},
"validation": {
"identification_number": "no_match"
}
}
]
}
🇿🇦 África do Sul
API de contactabilidade na África do Sul: ID Match
Validação em base de dados oficial da África do Sul via Didit. Pagamento por chamada a partir de $0.35, 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_contactability" \
-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_contactability"],
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_contactability"],
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_contactability"}),
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_contactability"))
.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_contactability'],
'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_contactability"],
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_contactability" },
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_contactability",
"service_name": "South Africa - Contactability Lookup",
"source_data": {
"contact_email": "alex.sample@example.com",
"contact_phone_numbers": "+15550101000",
"date_of_birth": "1990-01-01",
"deceased": "sample_value",
"first_name": "John",
"gender": "M",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"phone_history_count": "+15550101000"
},
"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_contactability",
"service_name": "South Africa - Contactability Lookup",
"source_data": {
"identification_number": "NO_MATCH"
},
"validation": {
"identification_number": "no_match"
}
}
]
}
Devolve números de telefone, endereços de e-mail e moradas conhecidos associados a uma pessoa singular sul-africana. A Didit disponibiliza este serviço através de
POST /v3/database-validation/, para que possa verificar os dados enviados face à fonte oficial e receber resultados de correspondência normalizados.
Cobertura
- Cobertura: —
- País: África do Sul
- ID do serviço:
zaf_contactability - Domínio de dados: Telecomunicações
- Categoria: Telecomunicações
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 fluxo: disponível no fluxo
- Cobertura: —
- Preço: $0.35 por consulta bem-sucedida
Parâmetros do corpo
string
padrão:"ZAF"
obrigatório
Código de país ISO 3166-1 alfa-3 deste serviço de base de dados.Exemplo:
ZAFstring
padrão:"zaf_contactability"
obrigatório
Array que contém o ID deste serviço. Fixar o serviço mantém o pedido limitado a esta base de dados exata.Exemplo:
zaf_contactabilityboolean
padrão:"true"
obrigatório
Consentimento explícito do utilizador final para este serviço.Exemplo:
truestring
padrão:"SAMPLE-NID-12345"
obrigatório
Número de identificação nacional para este serviço.Exemplo:
SAMPLE-NID-12345string
padrão:"user-1234"
A sua referência estável de utilizador para esta pessoa, como o ID interno do utilizador. A Didit usa-a para associar verificações independentes ao mesmo utilizador final e reduzir o ruído da deteção de duplicados.Exemplo:
user-1234Regras de entrada e notas de validação
- Envie os campos indicados acima exatamente como foram recolhidos do utilizador ou do documento.
- A Didit valida os campos obrigatórios antes de chamar a base de dados. Os pedidos rejeitados antes da consulta à fonte não são cobrados.
Como fazer a chamada
curl -X POST "https://verification.didit.me/v3/database-validation/" \
-H "x-api-key: YOUR_API_KEY" \
-F "issuing_state=ZAF" \
-F "services=zaf_contactability" \
-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_contactability"],
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_contactability"],
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_contactability"}),
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_contactability"))
.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_contactability'],
'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_contactability"],
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_contactability" },
Consent = true,
NationalId = "SAMPLE-NID-12345",
VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
Todas as chamadas bem-sucedidas devolvem HTTP 200. O campo outcome_code indica o que realmente aconteceu, distinguindo, por exemplo, uma discordância biométrica real (BIOMETRIC_NO_MATCH) de uma selfie que não pôde ser lida (BIOMETRIC_IMAGE_UNUSABLE). O status apresentado é o estado predefinido da funcionalidade; as ações de correspondência parcial e de sem correspondência que tiver configuradas podem substituí-lo.MATCH — O registo 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_contactability",
"service_name": "South Africa - Contactability Lookup",
"source_data": {
"contact_email": "alex.sample@example.com",
"contact_phone_numbers": "+15550101000",
"date_of_birth": "1990-01-01",
"deceased": "sample_value",
"first_name": "John",
"gender": "M",
"identification_number": "SAMPLE-ID-12345",
"last_name": "Doe",
"phone_history_count": "+15550101000"
},
"validation": {
"identification_number": "full_match"
}
}
]
}
NO_MATCH — O registo não devolveu qualquer 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_contactability",
"service_name": "South Africa - Contactability Lookup",
"source_data": {
"identification_number": "NO_MATCH"
},
"validation": {
"identification_number": "no_match"
}
}
]
}
Dados devolvidos
Os campos exatos apresentados emsource_data dependem do que o registo devolve. O exemplo gerado para zaf_contactability documenta atualmente esta estrutura normalizada:
contact_emailcontact_phone_numbersdate_of_birthdeceasedfirst_namegenderidentification_numberlast_namephone_history_count
Preços e SLAs
As consultas de pesquisa de contactabilidade da África do Sul só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.- Preço por chamada: $0.35 USD.
- Faturação: por consulta bem-sucedida. Não é cobrada quando o registo não está acessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
- Latência: p95 típico < 2 s.
- Disponibilidade: 99.9% por trimestre do lado da Didit; a disponibilidade das fontes a jusante varia consoante o país e o conjunto de dados.
Continuar a ler
Última modificação em 7 de novembro de 2026