Verwenden Sie diesen Endpunkt, um zu überprüfen, ob die in der Anfrage gesendete Telefonnummer mit der Nummer übereinstimmt, von der die Anfrage ausgeht. Der Ablauf umfasst zwei Schritte: die Verifizierungsanfrage initiieren und anschließend das Ergebnis abrufen.
Verwandte ID-Mobile-Dokumentation:
Schritt 1 — Verifizierungsanfrage initiieren
GET-Anfrage
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&name={NAME}&licence={LICENCE_CODE}&scope=numVerify&redirect_uri={URL_REDIRECT}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 |
| name | Partnername in der DQE-Datenbank, in der Regel Ihr Firmenname. | Pflicht |
| scope | Statischer Wert. Muss für diesen Scope numVerify sein. |
Pflicht |
| redirect_uri | Weiterleitungs-URL. DQE fügt der Weiterleitung das Sitzungstoken und den Status hinzu. | Optional |
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 |
| name | Partnername in der DQE-Datenbank, in der Regel Ihr Firmenname. | Pflicht |
| scope | Statischer Wert. Muss für diesen Scope numVerify sein. |
Pflicht |
| redirect_uri | Weiterleitungs-URL. DQE fügt der Weiterleitung das Sitzungstoken und den Status hinzu. | Optional |
Antwort
Erfolg
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| status | success |
STRING |
| operator | Betreiber. | STRING |
| url | URL der Betreiber-API. | STRING |
Beispiel:
{
"status": "success",
"operator": "SFR",
"url": "htt***fr.fr/api/a**l8ET6UMbsaG0AOm5FsakgyKu*"
}Fehler
| 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. |
Schritt 2 — Verifizierungsergebnis abrufen
GET-Anfrage
https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=numVerify| Parameter | Beschreibung | Pflicht/Optional |
|---|---|---|
| SERVER_ADDRESS | Adresse des DQE-Servers, der die Daten verarbeitet. | Pflicht |
| Licence | Ihnen als Lizenzcode zugewiesene Nummer. | Pflicht |
| token | Über die Authentifizierung abgerufenes Token. | Pflicht |
| scope | Statischer Wert. Muss für diesen Scope numVerify sein. |
Pflicht |
POST-Anfrage
https://{SERVER_ADDRESS}/GET/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 |
| token | Über die Authentifizierung abgerufenes Token. | Pflicht |
| scope | Statischer Wert. Muss für diesen Scope numVerify sein. |
Pflicht |
Antwort
Erfolg
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| status |
success: Informationen wurden erfolgreich abgerufen. |
STRING |
| scope | Enthält den zuvor gesendeten Scope. | STRING |
| numVerify |
true, wenn die Telefonnummernverifizierung erfolgreich ist. |
BOOLEAN |
Beispiel:
{
"status": "success",
"scope": "numVerify",
"numVerify": true
}Ausstehend
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| status |
pending: DQE wartet auf die Antwort des Betreibers. |
STRING |
| scope | Enthält numVerify. |
STRING |
Beispiel:
{
"status": "pending",
"scope": "numVerify"
}Fehler
| 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. |
| 18 | failed to retrieve data from operator | Nach der OTP-Validierung wurden keine Daten empfangen. |
| 20 | Not the same phone number between the phone in the request | Die OTP-Validierung wurde nicht abgeschlossen. |
| 21 | access denied | Die OTP-Validierung wurde abgelehnt. |
| 30 | invalid or expired token | Das Token ist abgelaufen. |
| 99 | internal server error | Serverfehler. |
Beispiel:
{
"status": "error",
"error_id": "20",
"error_type": "OTP process failed"
}