Verwenden Sie diesen Endpunkt, um zu prüfen, ob die in der Anfrage gesendete Telefonnummer mit der anfragenden Nummer übereinstimmt. Der Vorgang umfasst zwei Schritte: Verifizierungsanfrage starten und anschließend das Ergebnis abrufen.
Zugehörige ID-Mobile-Dokumentation:
Schritt 1: Verifizierung anfordern
Anfrage
GET und POST werden beide unterstützt. Dadurch wird eine Zustimmungsseite geöffnet, die der Endnutzer akzeptieren muss, bevor das Ergebnis in Schritt 2 abgerufen werden kann.
Codebeispiele
Zustimmungslink für Number Verify anfordern
Fügen Sie die folgenden Parameter mit Content-Type: application/x-www-form-urlencoded in den Request-Body ein:
Codebeispiele
Zustimmungslink für Number Verify anfordern
Parameter
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Adresse des DQE-Servers, der die Daten verarbeitet. | Pflicht |
| licence | Ihnen zugewiesene Nummer als Lizenzcode. | Pflicht |
| number | Telefonnummer. | Pflicht |
| token | Durch Authentifizierung abgerufenes Token. | Pflicht |
| mode | Statischer Wert. Muss 2 sein. |
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 |
numVerify kann in einer einzigen Anfrage mit info (Telefonnummer-Zusatzinformationen) kombiniert werden, z. B. scope=numVerify,info. Siehe die info-Felder unten.info-Zusatzfelder — werden zusätzlich zu den eigenen Feldern dieses Endpunkts zurückgegeben, wenn info in scope enthalten ist:
| Feld | Beschreibung | Beispiel |
|---|---|---|
| telorigine | Telefonnummer in der Anfrage. | 0600000000 |
| tel | Telefonnummer, formatiert. | +33600000000 |
| geolocation | Geografische Lage der Telefonnummer. | FRANCE |
| operator | Aktueller Betreiber der Telefonnummer, falls vorhanden. | ORANGE |
| oldoperator | Vorheriger Betreiber der Telefonnummer. | SFR |
| ported | Gibt an, ob die Telefonnummer portiert wurde, falls vorhanden. | Y |
| type | Art der Telefonnummer. | MOBILE |
| iderror | Fehlercode der Prüfung (0 oder 1). |
1 |
Antwort
Bei Erfolg gibt die API ein JSON-Objekt mit der dem Endnutzer anzuzeigenden URL der Zustimmungsseite zurück.
| Key | Description | Type |
|---|---|---|
| status | success |
String |
| operator | Betreiber. | String |
| url | URL der Betreiber-API. | String |
Antwortbeispiel
Beispiel für eine erfolgreiche Antwort
Fehler
user_infos und dessen Schlüssel phone, die zu anderen Scopes gehören (z. B. Matching without OTP) — die eigene Anfrage von Number Verify enthält solche Felder nicht, daher werden diese Codes bei einem Standardaufruf von Number Verify normalerweise nicht ausgelöst.| Fehler-ID | Fehlertyp | Beispielanfrage | Antwort |
|---|---|---|---|
| 01 | invalid request |
https://{SERVER_ADDRESS}/IDMOBILE/?token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerifyBeispiel: fehlender Parameter
number. |
{"status": "error", "error_id": "01", "error_type": "invalid request"} |
| 02 | invalid licence key | https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={INCORRECT_LICENCE_CODE}&scope=numVerify |
{"status": "error", "error_id": "02", "error_type": "invalid licence key"} |
| 04 | invalid scope | https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=wrongScope |
{"status": "error", "error_id": "04", "error_type": "invalid scope"} |
| 05 | missing or empty parameter (user_infos) for this scope |
Wird durch die eigenen Parameter von Number Verify nicht ausgelöst Dieser Code stammt aus einer Validierungsebene, die für alle ID-Mobile-Scopes gemeinsam genutzt wird, und bezieht sich auf die Felder
user_infos/phone, die von anderen Scopes verwendet werden (z. B. Matching without OTP). Number Verify hat keinen solchen Parameter. |
{"status": "error", "error_id": "05", "error_type": "missing or empty parameter (user_infos) for this scope"} |
| 06 | bad parameter format (user_infos) is not a valid JSON |
Wird durch die eigenen Parameter von Number Verify nicht ausgelöst Dieser Code stammt aus einer Validierungsebene, die für alle ID-Mobile-Scopes gemeinsam genutzt wird, und bezieht sich auf die Felder
user_infos/phone, die von anderen Scopes verwendet werden (z. B. Matching without OTP). Number Verify hat keinen solchen Parameter. |
{"status": "error", "error_id": "06", "error_type": "bad parameter format (user_infos) is not a valid JSON"} |
| 07 | missing mandatory key in user informations (phone) |
Wird durch die eigenen Parameter von Number Verify nicht ausgelöst Dieser Code stammt aus einer Validierungsebene, die für alle ID-Mobile-Scopes gemeinsam genutzt wird, und bezieht sich auf die Felder
user_infos/phone, die von anderen Scopes verwendet werden (z. B. Matching without OTP). Number Verify hat keinen solchen Parameter. |
{"status": "error", "error_id": "07", "error_type": "missing mandatory key in user informations (phone)"} |
| 09 | ineligible phone number | https://{SERVER_ADDRESS}/IDMOBILE/?number={INELIGIBLE_NUMBER}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerify |
{"status": "error", "error_id": "09", "error_type": "ineligible phone number"} |
| 10 | invalid phone number | https://{SERVER_ADDRESS}/IDMOBILE/?number={INVALID_NUMBER}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerify |
{"status": "error", "error_id": "10", "error_type": "invalid phone number"} |
| 11 | phone number is empty | https://{SERVER_ADDRESS}/IDMOBILE/?number=&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerify |
{"status": "error", "error_id": "11", "error_type": "phone number is empty"} |
| 12 | phone check failed |
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerifyBedingung auf Betreiberseite — eine syntaktisch gültige Anfrage kann hier trotzdem fehlschlagen.
|
{"status": "error", "error_id": "12", "error_type": "phone check failed"} |
| 13 | operator [Operator Name] not found |
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerifyBedingung auf Betreiberseite.
|
{"status": "error", "error_id": "13", "error_type": "operator [Operator Name] not found"} |
| 14 | operator [Operator Name] not authorized for this licence |
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerifyBedingung auf Betreiberseite — Ihre Lizenz ist für diesen Betreiber nicht autorisiert.
|
{"status": "error", "error_id": "14", "error_type": "operator [Operator Name] not authorized for this licence"} |
| 15 | operator [Operator Name] not supported yet |
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerifyBedingung auf Betreiberseite.
|
{"status": "error", "error_id": "15", "error_type": "operator [Operator Name] not supported yet"} |
| 16 | operator [Operator Name] unreachable |
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerifyBedingung auf Betreiberseite.
|
{"status": "error", "error_id": "16", "error_type": "operator [Operator Name] unreachable"} |
| 17 | scope not supported by this operator [Operator Name] yet |
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerifyBedingung auf Betreiberseite.
|
{"status": "error", "error_id": "17", "error_type": "scope not supported by this operator [Operator Name] yet"} |
| 30 | invalid or expired token | https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={EXPIRED_TOKEN}&mode=2&name={NAME}&licence={LICENCE_CODE}&scope=numVerify |
{"status": "error", "error_id": "30", "error_type": "invalid or expired token"} |
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.
Konsole öffnen
Sobald der Endnutzer die Zustimmungsseite aus Schritt 1 akzeptiert (oder abgelehnt) hat, rufen Sie diesen Endpunkt auf, um das Verifizierungsergebnis abzurufen.
Schritt 2: Ergebnis abrufen
Anfrage
GET und POST werden beide unterstützt.
Codebeispiele
Number-Verify-Ergebnis abrufen
Fügen Sie die folgenden Parameter mit Content-Type: application/x-www-form-urlencoded in den Request-Body ein:
Codebeispiele
Number-Verify-Ergebnis abrufen
Parameter
| Parameter | Description | Mand / Opt |
|---|---|---|
| SERVER_ADDRESS | Adresse des DQE-Servers, der die Daten verarbeitet. | Pflicht |
| Licence | Ihnen zugewiesene Nummer als Lizenzcode. | Pflicht |
| token | Durch Authentifizierung abgerufenes Token. | Pflicht |
| scope | Statischer Wert. Muss für diesen Scope numVerify sein. |
Pflicht |
Antwort
Erfolg
| Key | Description | Type |
|---|---|---|
| status |
success: Die Informationen wurden erfolgreich abgerufen. |
String |
| scope | Enthält den zuvor gesendeten Scope. | String |
| numVerify | Immer true, wenn dieser Schlüssel vorhanden ist — er bestätigt, dass die Telefonnummer übereinstimmt. Eine nicht übereinstimmende Telefonnummer wird in einer erfolgreichen Antwort nie als numVerify: false zurückgegeben; stattdessen wird Fehler 20 zurückgegeben (siehe Fehler unten). |
Boolean |
Ausstehend
Wird zurückgegeben, während DQE noch auf die Antwort des Betreibers wartet — fragen Sie Schritt 2 nach einer kurzen Verzögerung erneut ab.
| Key | Description | Type |
|---|---|---|
| status |
pending: DQE wartet auf die Antwort des Betreibers. |
String |
| scope | Enthält numVerify. |
String |
Antwortbeispiel
Beispiel für eine erfolgreiche Antwort
Beispiel für eine ausstehende Antwort
Fehler
| Fehler-ID | Fehlertyp | Beispielanfrage | Antwort |
|---|---|---|---|
| 01 | invalid request |
https://{SERVER_ADDRESS}/GET/?Licence={LICENCE_CODE}&scope=numVerifyBeispiel: fehlender Parameter
token. |
{"status": "error", "error_id": "01", "error_type": "invalid request"} |
| 02 | invalid licence key | https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={INCORRECT_LICENCE_CODE}&scope=numVerify |
{"status": "error", "error_id": "02", "error_type": "invalid licence key"} |
| 04 | invalid scope | https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=wrongScope |
{"status": "error", "error_id": "04", "error_type": "invalid scope"} |
| 18 | failed to retrieve data from operator |
https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=numVerifyNach der OTP-Validierung wurden keine Daten empfangen.
|
{"status": "error", "error_id": "18", "error_type": "failed to retrieve data from operator"} |
| 20 | Not the same phone number between the phone in the request |
https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=numVerifyDie in der Anfrage gesendete Telefonnummer stimmt nicht mit der anfragenden Nummer überein — dies entspricht einem
numVerify: false-Ergebnis, das als Fehler statt als erfolgreiche Antwort zurückgegeben wird. |
{"status": "error", "error_id": "20", "error_type": "Not the same phone number between the phone in the request"} |
| 21 | access denied |
https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=numVerifyDie OTP-Validierung wurde abgelehnt.
|
{"status": "error", "error_id": "21", "error_type": "access denied"} |
| 30 | invalid or expired token | https://{SERVER_ADDRESS}/GET/?token={EXPIRED_TOKEN}&Licence={LICENCE_CODE}&scope=numVerify |
{"status": "error", "error_id": "30", "error_type": "invalid or expired token"} |
| 99 | internal server error |
https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=numVerifyServerfehler.
|
{"status": "error", "error_id": "99", "error_type": "internal server error"} |
Beispiel für eine Fehlerantwort
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.