> ## 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.

# Afrique du Sud : API de vérification de dossier réfugié

> Vérification de fichier de réfugié en Afrique du Sud via Didit : consultation de la base officielle. À partir de $1.28 par appel, sans contrat ni minimum.

Vérifie un numéro de dossier de réfugié auprès du registre des réfugiés du ministère de l'Intérieur sud-africain (Department of Home Affairs). Didit expose ce service via `POST /v3/database-validation/` afin que vous puissiez comparer les données soumises à la source de référence et recevoir des résultats de correspondance normalisés.

## Couverture

* **Couverture :** —
* **Pays :** Afrique du Sud
* **ID du service :** `zaf_refugee`
* **Domaine de données :** Identité
* **Catégorie :** Gouvernement

## Entrées

| Champ | Obligatoire | Exemple |
| - | -: | - |
| `refugee_file_number` | Oui | `RF123456` |
| `phone_number` | Non | `+15550101000` |
| `email` | Non | `john.doe@example.com` |
| `vendor_data` | Non | `user-1234` |

* **Entrées obligatoires :** `refugee_file_number`
* **Entrées facultatives :** `phone_number`, `email`, `vendor_data`
* **Consentement :** non requis
* **Disponibilité dans le workflow :** disponible dans un workflow avec mappage des champs
* **Couverture :** —
* **Prix :** \$1.28 par requête réussie

Dans un workflow, `refugee_file_number` ne figure pas sur un document d'identité, donc aucune étape ne le produit à elle seule. Collectez-le à partir d'une réponse à un Questionnaire, d'un champ extrait par Document AI ou d'une valeur que vous envoyez lors de la création de la session, puis mappez-le sur l'étape Validation en base de données. Tant qu'il n'est pas mappé, l'éditeur de workflow affiche ce service comme désactivé et indique l'entrée manquante. Au moment de l'exécution, une entrée manquante entraîne l'omission de la vérification avant toute requête, de sorte que vous n'êtes jamais facturé pour une base de données qui n'a pas pu être interrogée.

## Paramètres du corps de la requête

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

Code pays ISO 3166-1 alpha-3 de ce service de base de données.

Exemple : `ZAF`

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

Tableau contenant l'ID de ce service. Épingler le service limite la requête à cette base de données précise.

Exemple : `zaf_refugee`

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

Valeur de `refugee_file_number` requise par ce service de base de données.

Exemple : `RF123456`

**phone\_number** `string`

Valeur de `phone_number` requise par ce service de base de données.

Exemple : `+15550101000`

**email** `string`

Adresse e-mail.

Exemple : `john.doe@example.com`

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

Votre référence utilisateur stable pour cette personne, par exemple votre identifiant interne. Didit l'utilise pour relier les vérifications autonomes au même utilisateur final et réduire le bruit de la détection des doublons.

Exemple : `user-1234`

## Règles de saisie et notes de validation

* Envoyez les champs listés ci-dessus exactement tels qu'ils ont été saisis par l'utilisateur ou extraits du document.
* Didit valide les champs obligatoires avant d'interroger la base de données. Les requêtes rejetées avant la recherche dans la source ne sont pas facturées.

## Comment l'appeler

```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"
```

Chaque appel réussi renvoie HTTP `200`. Le champ **`outcome_code`** indique ce qui s'est réellement passé, en distinguant par exemple une véritable non-correspondance biométrique (`BIOMETRIC_NO_MATCH`) d'un selfie qui n'a pas pu être lu (`BIOMETRIC_IMAGE_UNUSABLE`). Le `status` affiché est le statut par défaut de la fonctionnalité ; vos [actions de correspondance partielle / d'absence de correspondance](https://docs.didit.me/fr/core-technology/database-validation/database-validation-warnings.md) configurées peuvent le remplacer.

**`MATCH`** : le registre a confirmé l'identité et chaque champ vérifié correspond.

```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`** : le registre n'a renvoyé aucune correspondance pour les données soumises.

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

## Données renvoyées

Les champs exacts exposés dans `source_data` dépendent de ce que renvoie le registre. L'exemple généré pour `zaf_refugee` documente actuellement cette structure normalisée :

* Varie selon la réponse du registre.

## Tarifs et SLA

Les requêtes de vérification de dossier de réfugié en Afrique du Sud ne sont facturées que lorsque Didit reçoit un résultat concluant de la source de validation.

* **Prix par appel :** \$1.28 USD.
* **Facturation :** par requête réussie. Vous n'êtes pas facturé lorsque le registre est injoignable, lorsque des champs obligatoires manquent ou lorsque la requête est rejetée avant d'atteindre la source.
* **Latence :** p95 typique \< 2 s.
* **Disponibilité :** 99.9% par trimestre côté Didit ; la disponibilité de la source en aval varie selon le pays et le jeu de données.

## Pour aller plus loin

* [Vue d'ensemble de la validation en base de données en Afrique du Sud](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Vue d'ensemble de la validation en base de données](https://docs.didit.me/fr/core-technology/database-validation/overview.md)
* [Codes de résultat](https://docs.didit.me/fr/core-technology/database-validation/database-validation-outcome-codes.md)


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