Errors

All of the relevant errors that API might result upon different malformed requests or unexpected failure are documented here.

Token Expired

When the given authentication token, which is frequently used for user authentication and authorisation, has passed its predetermined expiration date or has been explicitly revoked by the server for security reasons, the server may issue a “Token Expired” error.

Note

To resolve this error please use the refresh token for new access token. Follow : Authorization for reference.

Status Code : 401

Error Response

{
"user_id": "not-set",
"request_from": "not-set",
"request_id": "not-set",
"trace_id": "not-set",
"title": "token expired",
"description": "token has expired"
}

Invalid Token

A server often issues a “Invalid Token” error when the provided authentication token is incorrect, tampered with, or does not match any legitimate token in the server’s records.

Note

This issue shouldn’t occur if you are using legitimate token. Incase you are getting this issue here are few things to verify.

• Bearer prefix is being passed on token

• The token has no trailing spaces

Incase issue persist, please request for new access token following Authorization section.

Status Code : 400

Error Response

{
"user_id": "not-set",
"request_from": "not-set",
"request_id": "not-set",
"trace_id": "not-set",
"title": "invalid token",
"description": "provided token is not valid"
}

Unauthorized Access

When a user or other entity tries to access a resource or carry out an action for which they do not have the required authorization or credentials, the server issues a “Unauthorized Access” error.

Note

Please verify that you have appropriate permission to perform requested action or access requested resource.

It is also good idea to validate that the token has been acquired with correct credentials if you have multiple user associated.

Status Code : 403

Error Response

{
"user_id": "not-set",
"request_from": "not-set",
"request_id": "not-set",
"trace_id": "not-set",
"title": "Unauthorized Access",
"description": <might vary based on request action>
}