Datenbankvalidierung Südafrika: Flüchtlingsakten-API

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

Prüft eine Flüchtlingsaktennummer anhand des Flüchtlingsregisters des südafrikanischen Department of Home Affairs. Didit stellt diesen Dienst über POST /v3/database-validation/ bereit, damit Sie die übermittelten Daten mit der maßgeblichen Quelle abgleichen und normalisierte Übereinstimmungsergebnisse erhalten können.

Abdeckung

Abdeckung: —
Land: Südafrika
Dienst-ID: zaf_refugee
Datenbereich: Identität
Kategorie: Behörde

Eingaben

Feld	Pflicht	Beispiel
`refugee_file_number`	Ja	`RF123456`
`phone_number`	Nein	`+15550101000`
`email`	Nein	`john.doe@example.com`
`vendor_data`	Nein	`user-1234`

Pflichtfelder: refugee_file_number
Optionale Felder: phone_number, email, vendor_data
Einwilligung: Nicht erforderlich
Verfügbarkeit im Workflow: Im Workflow mit Feldzuordnung verfügbar
Abdeckung: —
Preis: $1.28 pro erfolgreicher Abfrage

In einem Workflow wird refugee_file_number nicht auf einem Ausweisdokument aufgedruckt, daher erzeugt kein Schritt sie von selbst. Erfassen Sie sie über eine Antwort auf einen Fragebogen, ein Extraktionsfeld von Document AI oder einen Wert, den Sie beim Erstellen der Sitzung übergeben, und ordnen Sie sie dem Schritt Database Validation zu. Solange das Feld nicht zugeordnet ist, zeigt der Workflow-Editor diesen Dienst als deaktiviert an und nennt das fehlende Eingabefeld. Zur Laufzeit wird die Prüfung bei einem fehlenden Feld vor jeder Abfrage übersprungen, sodass Ihnen nie eine Datenbankabfrage in Rechnung gestellt wird, die nicht durchgeführt werden konnte.

Body-Parameter

string

Standard:"ZAF"

erforderlich

ISO 3166-1 alpha-3-Ländercode für diesen Datenbankdienst.Beispiel: ZAF

string

Standard:"zaf_refugee"

erforderlich

Array mit der ID dieses Dienstes. Durch das Festlegen des Dienstes bleibt die Anfrage auf genau diese Datenbank beschränkt.Beispiel: zaf_refugee

string

Standard:"RF123456"

erforderlich

Für diesen Datenbankdienst erforderlicher Wert refugee_file_number.Beispiel: RF123456

string

Für diesen Datenbankdienst erforderlicher Wert phone_number.Beispiel: +15550101000

string

E-Mail-Adresse.Beispiel: john.doe@example.com

string

Standard:"user-1234"

Ihre stabile Benutzerreferenz für diese Person, etwa Ihre interne Benutzer-ID. Didit verwendet sie, um eigenständige Prüfungen demselben Endbenutzer zuzuordnen und Rauschen bei der Dublettenerkennung zu reduzieren.Beispiel: user-1234

Eingaberegeln und Validierungshinweise

Senden Sie die oben aufgeführten Felder genau so, wie sie vom Benutzer oder aus dem Dokument erfasst wurden.
Didit prüft Pflichtfelder, bevor die Datenbank aufgerufen wird. Anfragen, die vor der Quellenabfrage abgelehnt werden, werden nicht berechnet.

So rufen Sie es auf

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"

Jeder erfolgreiche Aufruf gibt HTTP 200 zurück. Das Feld outcome_code zeigt an, was tatsächlich passiert ist, und unterscheidet zum Beispiel eine echte biometrische Nichtübereinstimmung (BIOMETRIC_NO_MATCH) von einem Selfie, das nicht gelesen werden konnte (BIOMETRIC_IMAGE_UNUSABLE). Der angezeigte status ist der Standardstatus der Funktion; Ihre konfigurierten Aktionen für Teilübereinstimmung / Keine Übereinstimmung können ihn überschreiben.

MATCH — Das Register hat die Identität bestätigt, und jedes geprüfte Feld stimmt überein.

{
  "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 — Das Register hat für die übermittelten Daten keine Übereinstimmung zurückgegeben.

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

Zurückgegebene Daten

Welche Felder genau in source_data erscheinen, hängt von der Antwort des Registers ab. Das generierte Beispiel für zaf_refugee dokumentiert derzeit folgende normalisierte Struktur:

Variiert je nach Antwort des Registers.

Preise & SLAs

Abfragen zur Flüchtlingsaktenverifizierung in Südafrika werden nur berechnet, wenn Didit ein eindeutiges Ergebnis von der Validierungsquelle erhält.

Preis pro Aufruf: $1.28 USD.
Abrechnung: pro erfolgreicher Abfrage. Ihnen wird nichts berechnet, wenn das Register nicht erreichbar ist, Pflichtfelder fehlen oder die Anfrage abgelehnt wird, bevor sie die Quelle erreicht.
Latenz: typischer p95-Wert unter 2 s.
Verfügbarkeit: 99.9% pro Quartal auf Seiten von Didit; die Verfügbarkeit der nachgelagerten Quelle variiert je nach Land und Datensatz.

Weiterlesen

Zuletzt geändert am 7. November 2026

​Abdeckung

​Eingaben

​Body-Parameter

​Eingaberegeln und Validierungshinweise

​So rufen Sie es auf

​Zurückgegebene Daten

​Preise & SLAs

​Weiterlesen

Abdeckung

Eingaben

Body-Parameter

Eingaberegeln und Validierungshinweise

So rufen Sie es auf

Zurückgegebene Daten

Preise & SLAs

Weiterlesen