Validação de base de dados: refugiados, África do Sul

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"
      }
    }
  ]
}

POST

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"
      }
    }
  ]
}

Verifica um número de processo de refugiado no registo de refugiados do Department of Home Affairs da África do Sul. A Didit disponibiliza este serviço através de POST /v3/database-validation/, para que possa validar os dados submetidos contra a fonte oficial e receber resultados de correspondência normalizados.

Cobertura

Cobertura: —
País: África do Sul
ID do serviço: zaf_refugee
Domínio de dados: Identidade
Categoria: Governo

Entradas

Campo	Obrigatório	Exemplo
`refugee_file_number`	Sim	`RF123456`
`phone_number`	Não	`+15550101000`
`email`	Não	`john.doe@example.com`
`vendor_data`	Não	`user-1234`

Entradas obrigatórias: refugee_file_number
Entradas opcionais: phone_number, email, vendor_data
Consentimento: Não é necessário
Disponibilidade no fluxo: Disponível em fluxo com mapeamento de campos
Cobertura: —
Preço: $1.28 por consulta bem-sucedida

Num fluxo, refugee_file_number não vem impresso num documento de identidade, por isso nenhum passo o produz por si só. Recolha-o a partir de uma resposta de Questionário, de um campo de extração do Document AI ou de um valor que envia ao criar a sessão, e mapeie-o no passo de Validação de base de dados. Enquanto não estiver mapeado, o editor de fluxos mostra este serviço desativado e indica a entrada em falta. Em execução, uma entrada em falta significa que a verificação é ignorada antes de qualquer consulta, pelo que nunca lhe é cobrado qualquer valor por uma base de dados que não pôde ser consultada.

Parâmetros do corpo

string

padrão:"ZAF"

obrigatório

Código de país ISO 3166-1 alpha-3 deste serviço de base de dados.Exemplo: ZAF

string

padrão:"zaf_refugee"

obrigatório

Matriz 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_refugee

string

padrão:"RF123456"

obrigatório

Valor de refugee_file_number exigido por este serviço de base de dados.Exemplo: RF123456

string

Valor de phone_number exigido por este serviço de base de dados.Exemplo: +15550101000

string

Endereço de e-mail.Exemplo: john.doe@example.com

string

padrão:"user-1234"

A sua referência estável de utilizador para esta pessoa, como o seu ID interno de utilizador. A Didit usa-a para associar verificações autónomas ao mesmo utilizador final e reduzir o ruído na deteção de duplicados.Exemplo: user-1234

Regras 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_refugee" \
  -F "vendor_data=user-1234" \
  -F "refugee_file_number=RF123456"

Cada chamada bem-sucedida devolve HTTP 200. O campo outcome_code indica o que realmente aconteceu, distinguindo, por exemplo, uma verdadeira falta de correspondência biométrica (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 suas ações de correspondência parcial / sem correspondência 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_refugee",
      "service_name": "South Africa - Refugee File Verification",
      "source_data": {},
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}

NO_MATCH — O registo não devolveu qualquer correspondência para os dados submetidos.

{
  "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"
      }
    }
  ]
}

Dados devolvidos

Os campos exatos apresentados em source_data dependem do que o registo devolve. O exemplo gerado para zaf_refugee documenta atualmente esta estrutura normalizada:

Varia consoante a resposta do registo.

Preços e SLAs

As consultas de Verificação de ficheiro de refugiado da África do Sul são faturadas apenas quando a Didit recebe um resultado conclusivo da fonte de validação.

Preço por chamada: $1.28 USD.
Faturação: por consulta bem-sucedida. Não é cobrado quando o registo está inacessí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 da fonte a jusante varia consoante o país e o conjunto de dados.

Continue a ler

Última modificação em 7 de novembro de 2026

​Cobertura

​Entradas

​Parâmetros do corpo

​Regras de entrada e notas de validação

​Como fazer a chamada

​Dados devolvidos

​Preços e SLAs

​Continue a ler

Cobertura

Entradas

Parâmetros do corpo

Regras de entrada e notas de validação

Como fazer a chamada

Dados devolvidos

Preços e SLAs

Continue a ler