API de verificação de arquivo de refugiado: Á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 registro de refugiados do Department of Home Affairs da África do Sul. A Didit disponibiliza este serviço por meio de POST /v3/database-validation/, para que você verifique os dados enviados na fonte oficial e receba 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 obrigatório
Disponibilidade no fluxo de verificação (workflow): Disponível no fluxo com mapeamento de campos
Cobertura: —
Preço: $1.28 por consulta bem-sucedida

Em um fluxo, o refugee_file_number não vem impresso em um documento de identidade, então nenhuma etapa o produz sozinha. Colete-o a partir de uma resposta de Questionário, de um campo extraído pelo Document AI ou de um valor que você envia ao criar a sessão, e mapeie-o na etapa de Validação de banco de dados. Enquanto ele não estiver mapeado, o editor de fluxos mostra este serviço desativado e indica a entrada que falta; em tempo de execução, uma entrada ausente faz com que a verificação seja ignorada antes de qualquer consulta, então você nunca é cobrado por um banco de dados que não pôde ser consultado.

Parâmetros do corpo

string

padrão:"ZAF"

obrigatório

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

string

padrão:"zaf_refugee"

obrigatório

Array que contém o ID deste serviço. Fixar o serviço mantém o escopo da requisição limitado a este banco de dados específico.Exemplo: zaf_refugee

string

padrão:"RF123456"

obrigatório

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

string

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

string

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

string

padrão:"user-1234"

Sua referência estável de usuário para esta pessoa, como o seu ID de usuário interno. A Didit a usa para vincular verificações avulsas ao mesmo usuário final e reduzir o ruído na detecção de duplicatas.Exemplo: user-1234

Regras de entrada e observações 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 consultar o banco de dados. Requisições rejeitadas antes da consulta à fonte de dados 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_refugee" \
  -F "vendor_data=user-1234" \
  -F "refugee_file_number=RF123456"

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 Partial Match / No Match 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_refugee",
      "service_name": "South Africa - Refugee File Verification",
      "source_data": {},
      "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_refugee",
      "service_name": "South Africa - Refugee File Verification",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}

Dados retornados

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

Varia conforme a resposta do registro.

Preços e SLAs

As consultas de Verificação de número de processo de refugiado da África do Sul são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

Preço por chamada: $1.28 USD.
Faturamento: por consulta bem-sucedida. Você não é cobrado quando o registro está inacessí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 do lado 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

​Cobertura

​Entradas

​Parâmetros do corpo

​Regras de entrada e observações de validação

​Como chamar

​Dados retornados

​Preços e SLAs

​Continue lendo

Cobertura

Entradas

Parâmetros do corpo

Regras de entrada e observações de validação

Como chamar

Dados retornados

Preços e SLAs

Continue lendo