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

# Verifica file rifugiati Sudafrica - API

> Verifica dei file rifugiati in Sudafrica tramite Didit: ricerca su database ufficiale. A consumo da $1.28, senza contratti né minimi.

Verifica un numero di pratica per rifugiati rispetto al registro dei rifugiati del Dipartimento degli Affari Interni sudafricano. Didit espone questo servizio tramite `POST /v3/database-validation/`, così puoi verificare i dati inviati rispetto alla fonte ufficiale e ricevere risultati di corrispondenza normalizzati.

## Copertura

* **Copertura:** —
* **Paese:** Sudafrica
* **ID del servizio:** `zaf_refugee`
* **Dominio dei dati:** Identità
* **Categoria:** Governo

## Input

| Campo | Obbligatorio | Esempio |
| - | -: | - |
| `refugee_file_number` | Sì | `RF123456` |
| `phone_number` | No | `+15550101000` |
| `email` | No | `john.doe@example.com` |
| `vendor_data` | No | `user-1234` |

* **Input obbligatori:** `refugee_file_number`
* **Input facoltativi:** `phone_number`, `email`, `vendor_data`
* **Consenso:** Non richiesto
* **Disponibilità nel workflow:** Disponibile nel workflow con mappatura dei campi
* **Copertura:** —
* **Prezzo:** \$1.28 per query riuscita

In un workflow, `refugee_file_number` non è riportato su un documento di identità, quindi nessun passaggio lo produce autonomamente. Raccoglilo da una risposta del questionario, da un campo di estrazione di Document AI oppure da un valore che invii al momento della creazione della sessione, e mappalo nel passaggio Validazione su database. Finché non è mappato, l'editor del workflow mostra questo servizio come disabilitato e indica l'input mancante. In fase di esecuzione, un input mancante fa sì che il controllo venga saltato prima di qualsiasi interrogazione, quindi non ti viene mai addebitato un database che non è stato possibile interrogare.

## Parametri del corpo

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

Codice paese ISO 3166-1 alpha-3 per questo servizio di database.

Esempio: `ZAF`

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

Array che contiene l'ID di questo servizio. Il blocco del servizio limita la richiesta a questo specifico database.

Esempio: `zaf_refugee`

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

Valore di `refugee_file_number` richiesto da questo servizio di database.

Esempio: `RF123456`

**phone\_number** `string`

Valore di `phone_number` richiesto da questo servizio di database.

Esempio: `+15550101000`

**email** `string`

Indirizzo email.

Esempio: `john.doe@example.com`

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

Il tuo riferimento utente stabile per questa persona, ad esempio il tuo ID utente interno. Didit lo usa per collegare i controlli indipendenti allo stesso utente finale e ridurre il rumore dovuto ai duplicati.

Esempio: `user-1234`

## Regole di input e note di validazione

* Invia i campi elencati sopra esattamente come sono stati acquisiti dall'utente o dal documento.
* Didit valida i campi obbligatori prima di chiamare il database. Le richieste respinte prima della ricerca nella fonte non vengono addebitate.

## Come effettuare la chiamata

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

Ogni chiamata riuscita restituisce HTTP `200`. Il campo **`outcome_code`** indica che cosa è effettivamente accaduto, distinguendo ad esempio una vera mancata corrispondenza biometrica (`BIOMETRIC_NO_MATCH`) da un selfie che non è stato possibile leggere (`BIOMETRIC_IMAGE_UNUSABLE`). Lo `status` mostrato è lo stato predefinito della funzionalità. Le [azioni configurate per la corrispondenza parziale / la mancata corrispondenza](https://docs.didit.me/it/core-technology/database-validation/database-validation-warnings.md) possono sostituirlo.

**`MATCH`**: il registro ha confermato l'identità e tutti i campi verificati corrispondono.

```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`**: il registro non ha restituito alcuna corrispondenza per i dati inviati.

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

## Dati restituiti

I campi esatti esposti in `source_data` dipendono da ciò che restituisce il registro. L'esempio generato per `zaf_refugee` documenta attualmente questa struttura normalizzata:

* Varia in base alla risposta del registro.

## Prezzi e SLA

Le interrogazioni per la verifica del numero di pratica per rifugiati in Sudafrica vengono addebitate solo quando Didit riceve un risultato conclusivo dalla fonte di validazione.

* **Prezzo per chiamata:** \$1.28 USD.
* **Fatturazione:** per query riuscita. Non ti viene addebitato nulla quando il registro non è raggiungibile, quando mancano campi obbligatori o quando la richiesta viene respinta prima di raggiungere la fonte.
* **Latenza:** p95 tipico inferiore a 2 s.
* **Disponibilità:** 99.9% per trimestre da parte di Didit; la disponibilità della fonte a valle varia in base al paese e al dataset.

## Continua la lettura

* [Panoramica della Validazione su database per il Sudafrica](https://docs.didit.me/api-reference/database-validation/south-africa.md)
* [Panoramica della Validazione su database](https://docs.didit.me/it/core-technology/database-validation/overview.md)
* [Codici di esito](https://docs.didit.me/it/core-technology/database-validation/database-validation-outcome-codes.md)


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