The following table summarises the error codes that may be returned when attempting to verify and exchange an OT token, or validate a long-term access token.
| Error Code | Code Designation | Code Explanation |
|---|---|---|
400 |
Bad Request |
This error occurs when at least one required field is not specified. |
403 |
Forbidden |
Error cases: CH_CLIENT_AUTH_FAILURE occurs when access has been denied to the broker’s backend, e.g., when an invalid password is passed in API call 4.1. or an invalid crmApiToken is passed in API calls 4.2-4.4. CH_INSUFFICIENT_PERMISSIONS occurs when at least one brokerName contained in the specified brokerCrmName lacks access rights because it is listed in manager.disabledBrokerName. |
404 |
Not Found |
This error occurs in the following cases: - The OT token ( code) passed in the request body of API call 4.2 is not found by the broker’s backend.- The long-term access token ( accessToken) passed in the request body of API call 4.3 is not found by the broker’s backend.- The user identifier ( userId) passed in the request body of API call 4.4 is not found by the broker’s backend. |
410 |
Gone |
CID_TOKEN_EXPIRED occurs when an expired token is used to access the broker’s backend. |
417 |
Expectation Failed |
CID_NON_EXISTED_TOKEN occurs when an invalid token is used to access the broker’s backend. |