Use this endpoint to generate an IDMobile access token. The token is required to call all other IDMobile scope endpoints.
Related ID Mobile documentation:
GET request
https://{SERVER_ADDRESS}/ACCESS_TOKEN/?client_secret={CLIENT_SECRET}&grant_type=client_idmobile&licence={LICENCE_CODE}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 |
| client_secret | Passphrase provided by the customer. | Mandatory |
| grant_type | Static value. Must be client_idmobile. |
Mandatory |
POST request
https://{SERVER_ADDRESS}/ACCESS_TOKEN/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 |
| client_secret | Passphrase provided by the customer. | Mandatory |
| grant_type | Static value. Must be client_idmobile. |
Mandatory |
Response
Success
The API returns a JSON object containing the following keys:
| Key | Description | Type |
|---|---|---|
| access_token | Temporary token used to call IDMobile services. | STRING |
| token_type |
Bearer: the authorised token type. |
STRING |
| expires_in | Token validity period, in seconds. | STRING |
| refresh_token | Token used to extend your session. | STRING |
Example:
{
"access_token": "TK948869a6f873adb622enhoaGeVY2iRaptqlmpplGeWZA",
"token_type": "Bearer",
"expires_in": "300",
"refresh_token": "*TK9bdd05f8e9d3c905834bdeqaUlGFll2iRaplll29mZmtkZQ"
}Error
| Error type | Request example | Response |
|---|---|---|
Missing licence parameter |
https://{SERVER_ADDRESS}/ACCESS_TOKEN/?client_secret=abcd&grant_type=client_idmobile |
400 Error (Invalid Request) |
Empty licence parameter |
https://{SERVER_ADDRESS}/ACCESS_TOKEN/?client_secret=abcd&grant_type=client_idmobile&licence= |
400 Error (Invalid Request) |
Incorrect licence value |
https://{SERVER_ADDRESS}/ACCESS_TOKEN/?client_secret=abcd&grant_type=client_idmobile&licence={INCORRECT_LICENCE_CODE} |
400 Error (Invalid Client) |
Missing or empty client_secret
|
https://{SERVER_ADDRESS}/ACCESS_TOKEN/?grant_type=client_idmobile&licence={LICENCE_CODE} |
400 Error (Invalid Request) |
Missing or incorrect grant_type
|
https://{SERVER_ADDRESS}/ACCESS_TOKEN/?client_secret=abcd&licence={LICENCE_CODE} |
400 Error (Invalid Request) |
| Parameter typo | https://{SERVER_ADDRESS}/ACCESS_TOKEN/?client_scret=abcd&grant_type=client_idmobile&licence={LICENCE_CODE} |
500 Error |