ID Mobile — Billing

Support DQE
Support DQE
  • Updated

Use this endpoint to retrieve a billing statement or proof of address from the operator, with user consent. The process involves two steps: initiate the consent request, then retrieve the document.

Related ID Mobile documentation:

Step 1 — Initiate consent request

GET request

https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode={MODE}&name={NAME}&code_name={CODE_NAME}&licence={LICENCE_CODE}&scope=billing&redirect_uri={URL_REDIRECT}

Replace the values in braces with your own information:

Parameter Description Mandatory/Optional
SERVER_ADDRESS Address of the DQE server that will process the data. Mandatory
licence Number assigned to you as your licence code. Mandatory
number Phone number. Mandatory
token Token retrieved through authentication. Mandatory
mode 2: authentication by code. Mandatory
name Partner name in the DQE Software database, usually your company name. Mandatory
code_name Optional field containing a code associated with name. Optional
scope Static value. Must be billing for this scope. Mandatory
redirect_uri Redirection URL. DQE adds the session token and status to the redirect. Optional

POST request

https://{SERVER_ADDRESS}/IDMOBILE/

Add the following parameters in the request body using x-www-form-urlencoded:

Parameter Description Mandatory/Optional
licence Number assigned to you as your licence code. Mandatory
number Phone number. Mandatory
token Token retrieved through authentication. Mandatory
mode 2: authentication by code. Mandatory
name Partner name in the DQE database, usually your company name. Mandatory
code_name Optional field containing a code associated with name. Optional
scope Static value. Must be billing for this scope. Mandatory
redirect_uri Redirection URL. DQE adds the session token and status to the redirect. Optional

Response

Success

Key Description Type
status success: information was successfully retrieved. STRING
scope billing STRING
billing Proof of address in Base64 encoding. STRING

Example:

{
  "status": "success",
  "scope": "billing",
  "billing": "N0YXJ0eHJlZgo0OTg2MQolJUVPRgoKLS1ZS0xJNTYpPUlSeFdNUzEoYXJpOWI/UklzLkRXZ1dwUF9FLS0K"
}

Pending

Key Description Type
status pending: DQE is waiting for the operator response. STRING
scope billing STRING

Example:

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

Error

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.

Step 2 — Retrieve billing document

GET request

https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=client_idmobile
Parameter Description Mandatory/Optional
SERVER_ADDRESS Address of the DQE server that will process the data. Mandatory
Licence Number assigned to you as your licence code. Mandatory
token Token retrieved through authentication. Mandatory
scope Static value. Must be client_idmobile for this scope. Mandatory

POST request

https://{SERVER_ADDRESS}/GET/

Add the following parameters in the request body using x-www-form-urlencoded:

Parameter Description Mandatory/Optional
Licence Number assigned to you as your licence code. Mandatory
token Token retrieved through authentication. Mandatory
scope Static value. Must be client_idmobile for this scope. Mandatory

Response

Success

Key Description Type
status success: document was successfully retrieved. STRING
scope billing STRING
billing Proof of address in Base64 encoding. STRING

Example:

{
  "status": "success",
  "scope": "billing",
  "billing": "N0YXJ0eHJlZgo0OTg2MQolJUVPRgoKLS1ZS0xJNTYpPUlSeFdNUzEoYXJpOWI/UklzLkRXZ1dwUF9FLS0K"
}

Pending

Key Description Type
status pending: DQE is waiting for the operator response. STRING
scope billing STRING

Error

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"
}

Was this article helpful?

0 out of 0 found this helpful