ID Check API — Ein Identitätsdokument verifizieren

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um die Identität einer Person zu verifizieren, indem Adresse, Name, Geburtsdatum, E-Mail und Telefonnummer mit der DQE-Datenbank abgeglichen werden.

Verwandte ID-Check-Dokumentation:

GET-Anfrage

Endpunkt

GET https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE}&Version=2

Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen.

Parameter Beschreibung Pflicht
SERVER_ADDRESS Adresse des DQE-Servers, der die Anfrage verarbeitet. Ja
LICENCE_CODE Ihr DQE-Lizenzcode. Ja
ADDRESS Hausnummer und Straßenname. Ja
POSTAL_CODE Postleitzahl. Ja
CITY Stadtname. Ja
NAME Nachname der zu verifizierenden Person. Ja
FIRST_NAME Vorname der zu verifizierenden Person. Ja
DATE Geburtsdatum im Format YYYY-MM-DD. Ja
EMAIL Zu verifizierende E-Mail-Adresse. Ja
PHONE Zu verifizierende Telefonnummer. Ja
Version=2 Gibt Informationen zum Lizenzstatus zurück. Nein

POST-Anfrage

Endpunkt

POST https://{SERVER_ADDRESS}/SEARCH/

Senden Sie die folgenden Parameter in einem Anfragetext mittels x-www-form-urlencoded.

Parameter Beschreibung Pflicht
Licence Ihr DQE-Lizenzcode. Ja
Address Hausnummer und Straßenname. Ja
PostalCode Postleitzahl. Ja
City Stadtname. Ja
LastName Nachname der zu verifizierenden Person. Ja
FirstName Vorname der zu verifizierenden Person. Ja
BirthDate Geburtsdatum im Format YYYY-MM-DD. Ja
Email Zu verifizierende E-Mail-Adresse. Ja
Phone Zu verifizierende Telefonnummer. Ja
Version Gibt bei der Einstellung 2 Informationen zum Lizenzstatus zurück. Nein

Antwort

Erfolgsantwort

Die JSON-Antwort enthält ein einzelnes Objekt DATA1 mit folgenden Schlüsseln:

Schlüssel Mögliche Werte Beschreibung Typ
Check_FirstName E, S, P, D, ? Ergebnis der Vornamen-Verifizierung. STRING(1)
Check_BirthDate Siehe Geburtsdatum-Codes unten. Ergebnis der Geburtsdatum-Verifizierung. STRING(3)
Check_Number True, False Gibt an, ob die Hausnummer mit der Datenbank übereinstimmt. STRING(5)
HOUSEHOLDID - Eindeutige Kennung in der Datenbank. STRING(30)
FirstName_Dist - Anzahl der unterschiedlichen Zeichen zwischen dem übermittelten Vornamen und dem Datenbankwert. STRING(2)
LastName_Dist - Anzahl der unterschiedlichen Zeichen zwischen dem übermittelten Nachnamen und dem Datenbankwert. STRING(2)
Result FOUND, NOT FOUND Gibt an, ob der Haushalt anhand von Adress-, E-Mail- oder Telefondaten gefunden wurde. STRING(9)
Check_Email E, D, ? Ergebnis der E-Mail-Verifizierung. STRING(1)
Check_LastName E, S, P, D, ? Ergebnis der Nachnamen-Verifizierung. STRING(1)
Check_City E, S, P, N, D, ? Ergebnis der Stadt-Verifizierung. STRING(1)
Check_PostalCode E, N, D, ? Ergebnis der Postleitzahl-Verifizierung. STRING(1)
Check_Phone E, D, ? Ergebnis der Telefon-Verifizierung. STRING(1)
Check_Address E, S, P, N, D, ? Ergebnis der Adress-Verifizierung. STRING(1)

Werte des allgemeinen Vergleichscodes:

Code Beschreibung
? Das Feld wurde nicht angegeben, ist nicht verfügbar, oder das abonnierte Produkt erlaubt diese Prüfung nicht.
E Der Wert in der Datenbank ist mit dem in der Anfrage angegebenen Wert strikt identisch.
S Der Wert in der Datenbank liegt nahe am in der Anfrage angegebenen Wert, bis zu 10 % Abweichung.
P Der Wert in der Datenbank weicht recht stark vom in der Anfrage angegebenen Wert ab, bis zu 25 % Abweichung.
N Für Adresse und Stadt: Der Wert weicht stark vom Anfragewert ab, bis zu 35 % Abweichung. Für Postleitzahl: Die ersten 3 Ziffern stimmen überein.
D Der Wert in der Datenbank unterscheidet sich vollständig vom in der Anfrage angegebenen Wert.

Vergleichscodes für das Geburtsdatum:

Code Beschreibung
000 Jahr, Monat und Tag sind identisch.
001 Jahr und Monat sind identisch, aber der Tag ist unterschiedlich.
010 Jahr und Tag sind identisch, aber der Monat ist unterschiedlich.
100 Monat und Tag sind identisch, aber das Jahr ist unterschiedlich.
011 Das Jahr ist identisch, aber Monat und Tag sind unterschiedlich.
101 Der Monat ist identisch, aber Jahr und Tag sind unterschiedlich.
110 Der Tag ist identisch, aber Jahr und Monat sind unterschiedlich.
111 Jahr, Monat und Tag sind unterschiedlich.
--- In der Datenbank ist kein Datum verfügbar.

Beispiel:

{
  "DATA1": {
    "Check_FirstName": "E",
    "Check_BirthDate": "000",
    "Check_Number": "True",
    "HOUSEHOLDID": "3678263863104901575",
    "FirstName_Dist": "0",
    "LastName_Dist": "0",
    "Result": "FOUND",
    "Check_Email": "D",
    "Check_LastName": "E",
    "Check_City": "E",
    "Check_Address": "E",
    "Check_PostalCode": "E",
    "Check_Phone": "D"
  }
}

Fehlerantwort

{
  "status": 400,
  "message": "Missing parameters",
  "details": "Address",
  "error": "bad request"
}
Fehlerfall HTTP-Status Meldung Beispiel für Details
Fehlende, leere oder falsche Lizenz 401 Your licence is not allowed to cover this functionality Leerer oder falscher Lizenzcode.
Fehlender oder leerer Parameter Address 400 Missing parameters Address
Fehlender oder leerer Parameter PostalCode 400 Missing parameters PostalCode
Fehlender oder leerer Parameter LastName 400 Missing parameters LastName
Tippfehler in einem Parameter 400 Missing parameters Name des fehlenden erwarteten Parameters.

Swagger-Dokumentation

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich