Verwenden Sie diesen Endpunkt, um vom Nutzer übermittelte Daten mit den Daten des Betreibers zu vergleichen, ohne dass eine Zustimmung des Nutzers (OTP) erforderlich ist. Für jedes Feld wird ein Ähnlichkeitswert zurückgegeben.
Verwandte ID-Mobile-Dokumentation:
GET-Anfrage
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode={MODE}&name={NAME}&code_name={CODE_NAME}&licence={LICENCE_CODE}&user_infos={INFORMATION}&scope=matching_notp&redirect_uri={URL_REDIRECT}&country={COUNTRY}Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen:
| Parameter | Beschreibung | Pflicht/Optional |
|---|---|---|
| SERVER_ADDRESS | Adresse des DQE-Servers, der die Daten verarbeitet. | Pflicht |
| licence | Ihnen als Lizenzcode zugewiesene Nummer. | Pflicht |
| number | Telefonnummer. | Pflicht |
| token | Über die Authentifizierung abgerufenes Token. | Pflicht |
| mode |
2: Authentifizierung per Code. |
Pflicht |
| name | Partnername in der DQE-Software-Datenbank, in der Regel Ihr Firmenname. | Pflicht |
| code_name | Optionales Feld mit einem name zugeordneten Code. |
Optional |
| user_infos | JSON-Objekt mit den zu vergleichenden Kundeninformationen. Siehe die Tabelle der user_infos-Schlüssel unten. Erforderlich, wenn der Scope matching_notp ist. |
Optional |
| scope | Statischer Wert. Muss für diesen Scope matching_notp sein. |
Pflicht |
| redirect_uri | Weiterleitungs-URL. DQE fügt der Weiterleitung das Sitzungstoken und den Status hinzu. | Optional |
| country | Nur für internationales Matching without OTP verwenden. Erwarteter Wert: ISO-2-Buchstaben-Ländercode. | Optional |
user_infos-Schlüssel — jeder Schlüssel muss vorhanden sein, auch wenn kein Wert angegeben wird:
| Schlüssel | Beschreibung |
|---|---|
street_address |
Straßentyp und -name. |
postal_code |
Postleitzahl. |
locality |
Stadt. |
country |
Vollständiger Ländername. |
birthdate |
Geburtsdatum im Format YYYY-MM-DD. |
email |
E-Mail-Adresse. |
lastname |
Nachname. |
maiden_name |
Geburtsname (Mädchenname). |
gender |
Geschlecht: M oder F. |
firstname |
Vorname. |
phone |
Telefonnummer. |
number |
Hausnummer. |
POST-Anfrage
https://{SERVER_ADDRESS}/IDMOBILE/Fügen Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu:
| Parameter | Beschreibung | Pflicht/Optional |
|---|---|---|
| licence | Ihnen als Lizenzcode zugewiesene Nummer. | Pflicht |
| number | Telefonnummer. | Pflicht |
| token | Über die Authentifizierung abgerufenes Token. | Pflicht |
| mode |
2: Authentifizierung per Code. |
Pflicht |
| name | Partnername in der DQE-Software-Datenbank, in der Regel Ihr Firmenname. | Pflicht |
| code_name | Optionales Feld mit einem name zugeordneten Code. |
Optional |
| user_infos | JSON-Objekt mit den zu vergleichenden Kundeninformationen. Erforderlich, wenn der Scope matching_notp ist. |
Optional |
| scope | Statischer Wert. Muss für diesen Scope matching_notp sein. |
Pflicht |
| redirect_uri | Weiterleitungs-URL. DQE fügt der Weiterleitung das Sitzungstoken und den Status hinzu. | Optional |
| country | Nur für internationales Matching without OTP verwenden. Erwarteter Wert: ISO-2-Buchstaben-Ländercode. | Optional |
Antwort
Erfolg — direkte Identifizierung
Die API gibt ein JSON-Objekt mit einem Ähnlichkeitswert für jedes Feld zurück:
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| family_name | Ähnlichkeitswert für den Nachnamen. | NUMBER |
| gender | Ähnlichkeitswert für die Anrede. | NUMBER |
| birthdate | Ähnlichkeitswert für das Geburtsdatum. | NUMBER |
| given_name | Ähnlichkeitswert für den Vornamen. | NUMBER |
| address | Objekt mit Ähnlichkeitswerten für die Adresse. Schlüssel: country, postal_code, street_address, locality. |
JSON OBJECT |
| Ähnlichkeitswert für die E-Mail-Adresse. | NUMBER |
Beispiel:
{
"family_name": 1.0,
"gender": "",
"birthdate": 1.0,
"given_name": 1.0,
"address": {
"country": 1.0,
"postal_code": 0.78,
"street_address": 0.56,
"locality": 0.44
},
"email": 1.0
}Fehler
Die API gibt ein JSON-Objekt mit den folgenden Schlüsseln zurück:
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| status | error |
STRING |
| error_type | Fehlerbezeichnung. Details finden Sie in der Tabelle unten. | STRING |
| error_id | Fehlercode. Details finden Sie in der Tabelle unten. | STRING(2) |
Details zu den Fehlercodes:
| Fehler-ID | Fehlertyp | Beschreibung |
|---|---|---|
| 01 | invalid request | Die Anfrage ist ungültig. |
| 02 | invalid licence key | Die Lizenz ist ungültig. |
| 04 | invalid scope | Ungültiger Scope. |
| 05 | missing or empty parameter (user_infos) for this scope | Für den angeforderten Scope fehlt ein Parameter. |
| 06 | bad parameter format (user_infos) is not a valid JSON | Der Parameter user_infos ist kein gültiges JSON. |
| 07 | missing mandatory key in user informations (phone) | Der Schlüssel phone ist im Parameter user_infos für diesen Betreiber erforderlich. |
| 09 | ineligible phone number | Die Telefonnummer ist für die Lösung nicht berechtigt. |
| 10 | invalid phone number | Die Telefonnummer existiert nicht. |
| 11 | phone number is empty | Die Telefonnummer ist leer. |
| 12 | phone check failed | Die Betreiberprüfung ist fehlgeschlagen. |
| 13 | operator [Operator Name] not found | Der Betreiber konnte nicht gefunden werden. |
| 14 | operator [Operator Name] not authorized for this licence | Ihre Lizenz ist für diesen Betreiber nicht autorisiert. |
| 15 | operator [Operator Name] not supported yet | Die Lösung ist für diesen Betreiber noch nicht verfügbar. |
| 16 | operator [Operator Name] unreachable | Der Betreiber konnte nicht kontaktiert werden. |
| 17 | scope not supported by this operator [Operator Name] yet | Dieser Scope wird vom Betreiber nicht unterstützt. |
| 30 | invalid or expired token | Das Token ist abgelaufen. |
Beispiel:
{
"status": "error",
"error_type": "invalid phone number",
"error_id": "10"
}