Utilisez ce point de terminaison pour récupérer les informations de l'utilisateur (nom, date de naissance, e-mail, adresse postale) enregistrées auprès de l'opérateur, avec le consentement de l'utilisateur. Le processus se déroule en deux étapes : lancer la demande de consentement, puis récupérer les données.
Documentation ID Mobile associée :
Étape 1 — Lancer la demande de consentement
Requête GET
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}
Remplacez les valeurs entre accolades par vos propres informations :
| Paramètre | Description | Obligatoire/Optionnel |
|---|---|---|
| SERVER_ADDRESS | Adresse du serveur DQE qui traitera les données. | Obligatoire |
| licence | Numéro qui vous a été attribué comme code de licence. | Obligatoire |
| number | Numéro de téléphone. | Obligatoire |
| token | Token récupéré lors de l'authentification. | Obligatoire |
| mode |
2 : authentification par code. |
Obligatoire |
| name | Nom du partenaire dans la base de données DQE Software, généralement le nom de votre entreprise. | Obligatoire |
| code_name | Champ optionnel contenant un code associé à name. |
Optionnel |
| scope | Valeur statique. Doit être formfilling pour ce scope. |
Obligatoire |
| redirect_uri | URL de redirection. DQE ajoute le token de session et le statut à la redirection. | Optionnel |
Requête POST
https://{SERVER_ADDRESS}/IDMOBILE/
Ajoutez les paramètres suivants dans le corps de la requête en utilisant x-www-form-urlencoded :
| Paramètre | Description | Obligatoire/Optionnel |
|---|---|---|
| licence | Numéro qui vous a été attribué comme code de licence. | Obligatoire |
| number | Numéro de téléphone. | Obligatoire |
| token | Token récupéré lors de l'authentification. | Obligatoire |
| mode |
2 : authentification par code. |
Obligatoire |
| name | Nom du partenaire dans la base de données DQE Software, généralement le nom de votre entreprise. | Obligatoire |
| code_name | Champ optionnel contenant un code associé à name. |
Optionnel |
| scope | Valeur statique. Doit être formfilling pour ce scope. |
Obligatoire |
| redirect_uri | URL de redirection. DQE ajoute le token de session et le statut à la redirection. | Optionnel |
Réponse
Succès
| Clé | Description | Type |
|---|---|---|
| status | success |
STRING |
| operator | Opérateur. | STRING |
| url | URL de l'API de l'opérateur. | STRING |
Exemple :
{
"status": "success",
"operator": "Orange",
"url": "https://api.operator/openidconnect/fr"
}
Erreur
| ID d'erreur | Type d'erreur | Description |
|---|---|---|
| 01 | invalid request | La requête n'est pas valide. |
| 02 | invalid licence key | La licence n'est pas valide. |
| 04 | invalid scope | Le scope n'est pas valide. |
| 05 | missing or empty parameter (user_infos) for this scope | Un paramètre est manquant pour le scope demandé. |
| 06 | bad parameter format (user_infos) is not a valid JSON | Le paramètre user_infos n'est pas un JSON valide. |
| 07 | missing mandatory key in user informations (phone) | La clé phone est obligatoire dans le paramètre user_infos pour cet opérateur. |
| 09 | ineligible phone number | Le numéro de téléphone n'est pas éligible à la solution. |
| 10 | invalid phone number | Le numéro de téléphone n'existe pas. |
| 11 | phone number is empty | Le numéro de téléphone est vide. |
| 12 | phone check failed | La vérification auprès de l'opérateur a échoué. |
| 13 | operator [Operator Name] not found | L'opérateur n'a pas pu être trouvé. |
| 14 | operator [Operator Name] not authorized for this licence | Votre licence n'est pas autorisée pour cet opérateur. |
| 15 | operator [Operator Name] not supported yet | La solution n'est pas encore disponible pour cet opérateur. |
| 16 | operator [Operator Name] unreachable | L'opérateur n'a pas pu être contacté. |
| 17 | scope not supported by this operator [Operator Name] yet | Ce scope n'est pas pris en charge par l'opérateur. |
| 30 | invalid or expired token | Le token a expiré. |
Étape 2 — Récupérer les données utilisateur
Requête GET
https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=formfilling
| Paramètre | Description | Obligatoire/Optionnel |
|---|---|---|
| SERVER_ADDRESS | Adresse du serveur DQE qui traitera les données. | Obligatoire |
| Licence | Numéro qui vous a été attribué comme code de licence. | Obligatoire |
| token | Token récupéré lors de l'authentification. | Obligatoire |
| scope | Valeur statique. Doit être formfilling pour ce scope. |
Obligatoire |
Requête POST
https://{SERVER_ADDRESS}/GET/
Ajoutez les paramètres suivants dans le corps de la requête en utilisant x-www-form-urlencoded :
| Paramètre | Description | Obligatoire/Optionnel |
|---|---|---|
| Licence | Numéro qui vous a été attribué comme code de licence. | Obligatoire |
| token | Token récupéré lors de l'authentification. | Obligatoire |
| scope | Valeur statique. Doit être formfilling pour ce scope. |
Obligatoire |
Réponse
Succès
L'API renvoie un objet JSON contenant les clés suivantes :
| Clé | Description | Type |
|---|---|---|
| status |
success : les informations ont été récupérées avec succès. |
STRING |
| scope | Contient le scope envoyé précédemment. | STRING |
| code_name | Contient le code name envoyé précédemment. | STRING |
| formfilling | Objet contenant les données utilisateur récupérées. Voir le tableau des clés ci-dessous. | JSON OBJECT |
Clés de l'objet formfilling :
| Clé | Description | Type |
|---|---|---|
| phone_number | Numéro de téléphone. | STRING(10) |
| family_name | Nom de famille. | STRING |
| name | Prénom et nom. | STRING |
| locale | Langue maternelle. | STRING(3) |
| gender | Genre : M pour masculin, F pour féminin. |
STRING |
| updated_at | Date de la dernière mise à jour des informations. | DATE |
| birthdate | Date de naissance. | DATE |
| birthplace | Département de naissance. | STRING |
| given_name | Prénom. | STRING |
| address | Objet adresse postale. Clés : country, postal_code, formatted, street_address, number, locality. |
JSON OBJECT |
| Adresse e-mail complète. | STRING | |
| email_domain | Domaine de l'adresse e-mail. | STRING |
| email_account | Identifiant de l'adresse e-mail. | STRING |
| subscriber_msisdn | Numéro de téléphone utilisé pour la souscription du contrat. | STRING(10) |
| sub | Identifiant du client dans la base de données de l'opérateur. | STRING |
Exemple :
{
"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": ""
}
}
En attente
| Clé | Description | Type |
|---|---|---|
| status |
pending : DQE attend la réponse de l'opérateur. |
STRING |
| scope | Contient formfilling et/ou matching. |
STRING |
Exemple :
{
"status": "pending",
"scope": "formfilling"
}
Erreur
| ID d'erreur | Type d'erreur | Description |
|---|---|---|
| 01 | invalid request | La requête n'est pas valide. |
| 02 | invalid licence key | La licence n'est pas valide. |
| 04 | invalid scope | Le scope n'est pas valide. |
| 18 | failed to retrieve data from operator | Aucune donnée n'a été reçue après validation de l'OTP. |
| 20 | OTP incorrect | La validation OTP n'a pas été effectuée. |
| 21 | access denied | La validation OTP a été refusée. |
| 30 | invalid or expired token | Le token a expiré. |
| 99 | internal server error | Erreur serveur. |
Exemple :
{
"status": "error",
"error_type": "internal server error",
"error_id": "99"
}