ID Mobile — Nutzerdaten mit Zustimmung abrufen

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um mit Zustimmung des Nutzers beim Betreiber registrierte Nutzerinformationen (Name, Geburtsdatum, E-Mail-Adresse, Postadresse) abzurufen. Der Ablauf umfasst zwei Schritte: die Zustimmungsanfrage initiieren und anschließend die Daten abrufen.

Verwandte ID-Mobile-Dokumentation:

Schritt 1 — Zustimmungsanfrage initiieren

GET-Anfrage

https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode={MODE}&name={NAME}&code_name={CODE_NAME}&licence={LICENCE_CODE}&scope=formfilling&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
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
scope Statischer Wert. Muss für diesen Scope formfilling 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
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
scope Statischer Wert. Muss für diesen Scope formfilling 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": "Orange",
  "url": "https://api.operator/openidconnect/fr"
}

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 — Nutzerdaten abrufen

GET-Anfrage

https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=formfilling
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 formfilling 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 formfilling sein. Pflicht

Antwort

Erfolg

Die API gibt ein JSON-Objekt mit den folgenden Schlüsseln zurück:

Schlüssel Beschreibung Typ
status success: Informationen wurden erfolgreich abgerufen. STRING
scope Enthält den zuvor gesendeten Scope. STRING
code_name Enthält den zuvor gesendeten Code-Namen. STRING
formfilling Objekt mit den abgerufenen Nutzerdaten. Siehe Schlüsseltabelle unten. JSON OBJECT

Schlüssel innerhalb des Objekts formfilling:

Schlüssel Beschreibung Typ
phone_number Telefonnummer. STRING(10)
family_name Nachname. STRING
name Vor- und Nachname. STRING
locale Muttersprache. STRING(3)
gender Geschlecht: M für männlich, F für weiblich. STRING
updated_at Datum der letzten Aktualisierung der Informationen. DATE
birthdate Geburtsdatum. DATE
birthplace Geburtsdepartement. STRING
given_name Vorname. STRING
address Postadress-Objekt. Schlüssel: country, postal_code, formatted, street_address, number, locality. JSON OBJECT
email Vollständige E-Mail-Adresse. STRING
email_domain E-Mail-Domain. STRING
email_account E-Mail-Benutzername. STRING
subscriber_msisdn Für den Vertragsabschluss verwendete Telefonnummer. STRING(10)
sub Kundenkennung in der Datenbank des Betreibers. STRING

Beispiel:

{
  "status": "success",
  "scope": "matching,formfilling",
  "code_name": "",
  "formfilling": {
    "phone_number": "",
    "family_name": "",
    "name": " -",
    "locale": "fr-FR",
    "gender": "M",
    "email_domain": ".com",
    "updated_at": "-08-09",
    "birthdate": "-08-30",
    "birthplace": "-08-30",
    "given_name": "",
    "address": {
      "locality": "",
      "country": "",
      "number": "",
      "formatted": "",
      "postal_code": "",
      "street_address": ""
    },
    "email_account": "",
    "email": "",
    "subscriber_msisdn": "",
    "sub": ""
  }
}

Ausstehend

Schlüssel Beschreibung Typ
status pending: DQE wartet auf die Antwort des Betreibers. STRING
scope Enthält formfilling und/oder matching. STRING

Beispiel:

{
  "status": "pending",
  "scope": "formfilling"
}

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 OTP incorrect 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_type": "internal server error",
  "error_id": "99"
}

Siehe auch

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich