This page describes the response returned by the IDMobile Formfilling retrieval endpoint.
Related IDMobile Formfilling documentation:
- ID Mobile introduction
- Formfill Consent response
- Formfill Retrieval GET request
- Formfill Retrieval POST request
- IDMobile Formfilling Swagger documentation
Formfilling retrieval success response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
success: indicates that the information was successfully retrieved. |
STRING |
| scope | Contains the scope previously sent. | STRING |
| code_name | Contains the code name previously sent. | STRING |
| formfilling | Returned if formfilling was sent in the scope field. Contains all the keys described in the table below. |
JSON OBJECT |
Elements of the formfilling key if the requested scope includes formfilling:
| Key | Description | Format |
|---|---|---|
| phone_number | Phone number. | STRING(10) |
| family_name | Last name. | STRING |
| name | First name and last name. | STRING |
| locale | Native language. | STRING(3) |
| gender | Gender: M for male and F for female. |
STRING |
| updated_at | Date of the last information update. | DATE |
| birthdate | Birth date. | DATE |
| birthplace | Birth department. | STRING |
| given_name | First name. | STRING |
| address | Contains all the keys described in the following table. | JSON OBJECT |
| Complete email. | STRING | |
| email_domain | Email domain. | STRING |
| email_account | Email username. | STRING |
| subscriber_msisdn | Phone number used for the contract subscription. | STRING(10) |
| sub | Customer identifier in the operator database. | STRING |
Elements of the address key:
| Key | Description | Format |
|---|---|---|
| country | Country of the address in full. | STRING |
| postal_code | Postal code. | STRING(8) |
| formatted | Complete postal address. \n and \r correspond to line breaks. |
STRING |
| street_address | Street type and street name. | STRING(38) |
| number | Street number. | STRING |
| locality | City. | STRING(38) |
Example:
{
"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": ""
}
}Formfilling retrieval pending response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
pending: indicates that DQE is waiting for the operator response. |
STRING |
| scope | Contains formfilling and/or matching. |
STRING |
Example:
{
"status": "pending",
"scope": "formfilling"
}Formfilling retrieval error response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
error: indicates that the request failed. |
STRING |
| error_type | Error label. Details are provided in the table below. | STRING |
| error_id | Error code. Details are provided in the table below. | STRING(2) |
Error code details:
| Error ID | Error type | Description |
|---|---|---|
| 01 | invalid request | The request is not valid. |
| 02 | invalid licence key | The licence is not valid. |
| 04 | invalid scope | Invalid scope. |
| 18 | failed to retrieve data from operator | No data was received after OTP validation. |
| 20 | OTP incorrect | OTP validation was not completed. |
| 21 | access denied | OTP validation was declined. |
| 30 | invalid or expired token | The token has expired. |
| 99 | internal server error | Server error. |
Example:
{
"status": "error",
"error_type": "internal server error",
"error_id": "99"
}Related to