API de verificación de refugiados en Sudáfrica

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 un número de expediente de refugiado en el registro de refugiados del Departamento de Asuntos Internos (Department of Home Affairs) de Sudáfrica. Didit ofrece este servicio a través de POST /v3/database-validation/ para que puedas verificar los datos enviados con la fuente oficial y recibir resultados de coincidencia normalizados.

Cobertura

Cobertura: —
País: Sudáfrica
ID del servicio: zaf_refugee
Dominio de datos: Identidad
Categoría: Gobierno

Datos de entrada

Campo	Obligatorio	Ejemplo
`refugee_file_number`	Sí	`RF123456`
`phone_number`	No	`+15550101000`
`email`	No	`john.doe@example.com`
`vendor_data`	No	`user-1234`

Datos de entrada obligatorios: refugee_file_number
Datos de entrada opcionales: phone_number, email, vendor_data
Consentimiento: No es necesario
Disponibilidad en el flujo de verificación (workflow): Disponible en el flujo con mapeo de campos
Cobertura: —
Precio: $1.28 por consulta exitosa

En un flujo, refugee_file_number no figura impreso en ningún documento de identidad, por lo que ningún paso lo genera por sí solo. Obtenlo de una respuesta de un Cuestionario, de un campo extraído con Document AI o de un valor que envíes al crear la sesión, y mapéalo en el paso de Validación de base de datos. Mientras no esté mapeado, el editor de flujos muestra este servicio desactivado e indica el dato de entrada que falta; durante la ejecución, si falta un dato de entrada, la comprobación se omite antes de realizar cualquier consulta, así que nunca se te factura por una base de datos que no se pudo consultar.

Parámetros del cuerpo

string

predeterminado:"ZAF"

requerido

Código de país ISO 3166-1 alfa-3 de este servicio de base de datos.Ejemplo: ZAF

string

predeterminado:"zaf_refugee"

requerido

Array que contiene el ID de este servicio. Fijar el servicio limita la solicitud a esta base de datos concreta.Ejemplo: zaf_refugee

string

predeterminado:"RF123456"

requerido

Valor de refugee_file_number que requiere este servicio de base de datos.Ejemplo: RF123456

string

Valor de phone_number que requiere este servicio de base de datos.Ejemplo: +15550101000

string

Dirección de correo electrónico.Ejemplo: john.doe@example.com

string

predeterminado:"user-1234"

Tu referencia estable de usuario para esta persona, como tu ID de usuario interno. Didit la usa para vincular las comprobaciones independientes al mismo usuario final y reducir el ruido en la detección de duplicados.Ejemplo: user-1234

Reglas de entrada y notas de validación

Envía los campos indicados arriba exactamente como se obtuvieron del usuario o del documento.
Didit valida los campos obligatorios antes de consultar la base de datos. Las solicitudes rechazadas antes de la consulta a la fuente no se cobran.

Cómo invocarlo

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 llamada exitosa devuelve HTTP 200. El campo outcome_code te indica qué ocurrió realmente; por ejemplo, distingue una falta de coincidencia biométrica real (BIOMETRIC_NO_MATCH) de una selfie que no se pudo leer (BIOMETRIC_IMAGE_UNUSABLE). El status que se muestra es el estado predeterminado de la función; las acciones de coincidencia parcial / sin coincidencia que hayas configurado pueden sobrescribirlo.

MATCH: el registro confirmó la identidad y todos los campos comprobados coincidieron.

{
  "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: el registro no devolvió ninguna coincidencia para los datos 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"
      }
    }
  ]
}

Datos devueltos

Los campos exactos que aparecen en source_data dependen de lo que devuelva el registro. El ejemplo generado para zaf_refugee documenta actualmente esta estructura normalizada:

Varía según la respuesta del registro.

Precios y SLA

Las consultas de Sudáfrica - Verificación de expediente de refugiado solo se facturan cuando Didit recibe un resultado concluyente de la fuente de validación.

Precio por llamada: $1.28 USD.
Facturación: por consulta exitosa. No se te cobra cuando el registro no está accesible, cuando faltan campos obligatorios o cuando la solicitud se rechaza antes de llegar a la fuente.
Latencia: p95 típico < 2 s.
Disponibilidad: 99.9% por trimestre por parte de Didit; la disponibilidad de la fuente externa varía según el país y el conjunto de datos.

Sigue leyendo

Última modificación el 1 de noviembre de 2026

​Cobertura

​Datos de entrada

​Parámetros del cuerpo

​Reglas de entrada y notas de validación

​Cómo invocarlo

​Datos devueltos

​Precios y SLA

​Sigue leyendo

Cobertura

Datos de entrada

Parámetros del cuerpo

Reglas de entrada y notas de validación

Cómo invocarlo

Datos devueltos

Precios y SLA

Sigue leyendo