> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Verificació de refugiats a Sud-àfrica amb API

> Verificació de refugiats a Sud-àfrica amb Didit: consulta de bases de dades oficials. Des de $1.28 per trucada, sense contractes ni mínims.

Verifica un número d'expedient de refugiat davant del registre de refugiats del Department of Home Affairs de Sud-àfrica. Didit ofereix aquest servei mitjançant `POST /v3/database-validation/` perquè pugueu verificar les dades enviades amb la font oficial i rebre resultats de coincidència normalitzats.

## Cobertura

* **Cobertura:** —
* **País:** Sud-àfrica
* **ID del servei:** `zaf_refugee`
* **Àmbit de dades:** Identitat
* **Categoria:** Govern

## Entrades

| Camp | Obligatori | Exemple |
| - | -: | - |
| `refugee_file_number` | Sí | `RF123456` |
| `phone_number` | No | `+15550101000` |
| `email` | No | `john.doe@example.com` |
| `vendor_data` | No | `user-1234` |

* **Entrades obligatòries:** `refugee_file_number`
* **Entrades opcionals:** `phone_number`, `email`, `vendor_data`
* **Consentiment:** No cal
* **Disponibilitat al flux de treball:** Disponible al flux de treball amb mapatge de camps
* **Cobertura:** —
* **Preu:** \$1.28 per consulta satisfactòria

En un flux de treball, `refugee_file_number` no s'imprimeix en cap document d'identitat, de manera que cap pas no el genera per si sol. Recolliu-lo a partir d'una resposta d'un qüestionari, d'un camp d'extracció de Document AI o d'un valor que envieu en crear la sessió, i mapeu-lo al pas de Validació en bases de dades. Mentre no estigui mapejat, l'editor del flux de treball mostra aquest servei desactivat i indica quina entrada falta. En temps d'execució, una entrada que falti fa que la comprovació s'omet abans de cap consulta, de manera que mai no us cobren per una base de dades que no s'ha pogut consultar.

## Paràmetres del cos

**issuing\_state** `string` *required* (default: ZAF)

Codi de país ISO 3166-1 alpha-3 d'aquest servei de base de dades.

Exemple: `ZAF`

**services** `string` *required* (default: zaf\_refugee)

Matriu que conté l'ID d'aquest servei. Fixar el servei limita la sol·licitud a aquesta base de dades concreta.

Exemple: `zaf_refugee`

**refugee\_file\_number** `string` *required* (default: RF123456)

Valor de `refugee_file_number` que requereix aquest servei de base de dades.

Exemple: `RF123456`

**phone\_number** `string`

Valor de `phone_number` que requereix aquest servei de base de dades.

Exemple: `+15550101000`

**email** `string`

Adreça de correu electrònic.

Exemple: `john.doe@example.com`

**vendor\_data** `string` (default: user-1234)

La vostra referència estable per a aquesta persona, com ara el vostre ID d'usuari intern. Didit l'utilitza per vincular les verificacions independents amb el mateix usuari final i reduir el soroll de la detecció de duplicats.

Exemple: `user-1234`

## Regles d'entrada i notes de validació

* Envieu els camps indicats anteriorment exactament tal com s'han capturat de l'usuari o del document.
* Didit valida els camps obligatoris abans de cridar la base de dades. Les sol·licituds rebutjades abans de la consulta a la font no es cobren.

## Com fer la crida

```bash cURL theme={null}
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 crida satisfactòria retorna HTTP `200`. El camp **`outcome_code`** us indica què ha passat realment, i distingeix, per exemple, una discrepància biomètrica real (`BIOMETRIC_NO_MATCH`) d'una selfie que no s'ha pogut llegir (`BIOMETRIC_IMAGE_UNUSABLE`). L'`status` que es mostra és l'estat predeterminat de la funcionalitat; les vostres [accions de coincidència parcial / sense coincidència configurades](https://docs.didit.me/ca/core-technology/database-validation/database-validation-warnings.md) poden substituir-lo.

**`MATCH`**: el registre ha confirmat la identitat i tots els camps comprovats han coincidit.

```json 200 OK — MATCH theme={null}
{
  "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 registre no ha retornat cap coincidència per a les dades enviades.

```json 200 OK — NO_MATCH theme={null}
{
  "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"
      }
    }
  ]
}
```

## Dades retornades

Els camps exactes que apareixen a `source_data` depenen del que retorni el registre. L'exemple generat per a `zaf_refugee` documenta actualment aquesta estructura normalitzada:

* Varia segons la resposta del registre.

## Preus i SLA

Les consultes de Verificació de fitxer de refugiat de Sud-àfrica només es facturen quan Didit rep un resultat concloent de la font de validació.

* **Preu per crida:** \$1.28 USD.
* **Facturació:** per consulta satisfactòria. No es cobra quan el registre no és accessible, quan falten camps obligatoris o quan la sol·licitud es rebutja abans d'arribar a la font.
* **Latència:** p95 típica \< 2 s.
* **Disponibilitat:** 99.9% per trimestre per part de Didit; la disponibilitat de la font externa varia segons el país i el conjunt de dades.

## Continuar llegint

* [Visió general de la validació en bases de dades de Sud-àfrica](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Visió general de la validació en bases de dades](https://docs.didit.me/ca/core-technology/database-validation/overview.md)
* [Codis de resultat](https://docs.didit.me/ca/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.