Utilice este endpoint para recuperar la información del usuario (nombre, fecha de nacimiento, correo electrónico, dirección postal) registrada en el operador, con el consentimiento del usuario. El proceso consta de dos pasos: iniciar la solicitud de consentimiento y, a continuación, recuperar los datos.
Documentación relacionada de ID Mobile:
Paso 1 — Iniciar la solicitud de consentimiento
Solicitud 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}
Sustituya los valores entre llaves por su propia información:
| Parámetro | Descripción | Obligatorio/Opcional |
|---|---|---|
| SERVER_ADDRESS | Dirección del servidor de DQE que procesará los datos. | Obligatorio |
| licence | Número que se le asigna como código de licencia. | Obligatorio |
| number | Número de teléfono. | Obligatorio |
| token | Token obtenido mediante autenticación. | Obligatorio |
| mode |
2: autenticación por código. |
Obligatorio |
| name | Nombre del partner en la base de datos de DQE Software, normalmente el nombre de su empresa. | Obligatorio |
| code_name | Campo opcional que contiene un código asociado a name. |
Opcional |
| scope | Valor estático. Debe ser formfilling para este scope. |
Obligatorio |
| redirect_uri | URL de redirección. DQE añade el token de sesión y el estado a la redirección. | Opcional |
Solicitud POST
https://{SERVER_ADDRESS}/IDMOBILE/
Añada los siguientes parámetros en el cuerpo de la solicitud usando x-www-form-urlencoded:
| Parámetro | Descripción | Obligatorio/Opcional |
|---|---|---|
| licence | Número que se le asigna como código de licencia. | Obligatorio |
| number | Número de teléfono. | Obligatorio |
| token | Token obtenido mediante autenticación. | Obligatorio |
| mode |
2: autenticación por código. |
Obligatorio |
| name | Nombre del partner en la base de datos de DQE Software, normalmente el nombre de su empresa. | Obligatorio |
| code_name | Campo opcional que contiene un código asociado a name. |
Opcional |
| scope | Valor estático. Debe ser formfilling para este scope. |
Obligatorio |
| redirect_uri | URL de redirección. DQE añade el token de sesión y el estado a la redirección. | Opcional |
Respuesta
Éxito
| Clave | Descripción | Tipo |
|---|---|---|
| status | success |
STRING |
| operator | Operador. | STRING |
| url | URL de la API del operador. | STRING |
Ejemplo:
{
"status": "success",
"operator": "Orange",
"url": "https://api.operator/openidconnect/fr"
}
Error
| Error ID | Error type | Descripción |
|---|---|---|
| 01 | invalid request | La solicitud no es válida. |
| 02 | invalid licence key | La licencia no es válida. |
| 04 | invalid scope | Scope no válido. |
| 05 | missing or empty parameter (user_infos) for this scope | Falta un parámetro para el scope solicitado. |
| 06 | bad parameter format (user_infos) is not a valid JSON | El parámetro user_infos no es un JSON válido. |
| 07 | missing mandatory key in user informations (phone) | La clave phone es obligatoria en el parámetro user_infos para este operador. |
| 09 | ineligible phone number | El número de teléfono no es elegible para la solución. |
| 10 | invalid phone number | El número de teléfono no existe. |
| 11 | phone number is empty | El número de teléfono está vacío. |
| 12 | phone check failed | La verificación del operador ha fallado. |
| 13 | operator [Operator Name] not found | No se ha podido encontrar el operador. |
| 14 | operator [Operator Name] not authorized for this licence | Su licencia no está autorizada para este operador. |
| 15 | operator [Operator Name] not supported yet | La solución aún no está disponible para este operador. |
| 16 | operator [Operator Name] unreachable | No se ha podido contactar con el operador. |
| 17 | scope not supported by this operator [Operator Name] yet | Este scope aún no es compatible con el operador. |
| 30 | invalid or expired token | El token ha caducado. |
Paso 2 — Recuperar los datos del usuario
Solicitud GET
https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=formfilling
| Parámetro | Descripción | Obligatorio/Opcional |
|---|---|---|
| SERVER_ADDRESS | Dirección del servidor de DQE que procesará los datos. | Obligatorio |
| Licence | Número que se le asigna como código de licencia. | Obligatorio |
| token | Token obtenido mediante autenticación. | Obligatorio |
| scope | Valor estático. Debe ser formfilling para este scope. |
Obligatorio |
Solicitud POST
https://{SERVER_ADDRESS}/GET/
Añada los siguientes parámetros en el cuerpo de la solicitud usando x-www-form-urlencoded:
| Parámetro | Descripción | Obligatorio/Opcional |
|---|---|---|
| Licence | Número que se le asigna como código de licencia. | Obligatorio |
| token | Token obtenido mediante autenticación. | Obligatorio |
| scope | Valor estático. Debe ser formfilling para este scope. |
Obligatorio |
Respuesta
Éxito
La API devuelve un objeto JSON con las siguientes claves:
| Clave | Descripción | Tipo |
|---|---|---|
| status |
success: la información se recuperó correctamente. |
STRING |
| scope | Contiene el scope enviado previamente. | STRING |
| code_name | Contiene el code name enviado previamente. | STRING |
| formfilling | Objeto que contiene los datos del usuario recuperados. Consulte la tabla de claves a continuación. | JSON OBJECT |
Claves dentro del objeto formfilling:
| Clave | Descripción | Tipo |
|---|---|---|
| phone_number | Número de teléfono. | STRING(10) |
| family_name | Apellido. | STRING |
| name | Nombre y apellido. | STRING |
| locale | Idioma nativo. | STRING(3) |
| gender | Sexo: M para hombre, F para mujer. |
STRING |
| updated_at | Fecha de la última actualización de la información. | DATE |
| birthdate | Fecha de nacimiento. | DATE |
| birthplace | Departamento de nacimiento. | STRING |
| given_name | Nombre. | STRING |
| address | Objeto de dirección postal. Claves: country, postal_code, formatted, street_address, number, locality. |
JSON OBJECT |
| Dirección de correo electrónico completa. | STRING | |
| email_domain | Dominio del correo electrónico. | STRING |
| email_account | Nombre de usuario del correo electrónico. | STRING |
| subscriber_msisdn | Número de teléfono usado para la suscripción del contrato. | STRING(10) |
| sub | Identificador del cliente en la base de datos del operador. | STRING |
Ejemplo:
{
"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": ""
}
}
Pendiente
| Clave | Descripción | Tipo |
|---|---|---|
| status |
pending: DQE está esperando la respuesta del operador. |
STRING |
| scope | Contiene formfilling y/o matching. |
STRING |
Ejemplo:
{
"status": "pending",
"scope": "formfilling"
}
Error
| Error ID | Error type | Descripción |
|---|---|---|
| 01 | invalid request | La solicitud no es válida. |
| 02 | invalid licence key | La licencia no es válida. |
| 04 | invalid scope | Scope no válido. |
| 18 | failed to retrieve data from operator | No se recibieron datos tras la validación del OTP. |
| 20 | OTP incorrect | La validación del OTP no se completó. |
| 21 | access denied | La validación del OTP fue rechazada. |
| 30 | invalid or expired token | El token ha caducado. |
| 99 | internal server error | Error del servidor. |
Ejemplo:
{
"status": "error",
"error_type": "internal server error",
"error_id": "99"
}