Below is a list of all error messages which can be returned by the API:
| Error Message | Meaning |
|---|---|
You do not have access to the API. Your signature: XXXX | Your public key signature is not valid and authorised to access the API |
| Bad session token. | Your have sent a login token for impersonation auth, which is no longer valid or was never valid. |
| Trial expired, only login and logout endpoints supported | Your free trial of the service has expired |
| Subscription cancelled, only login and logout endpoints supported | Your subscription to the service has ended |
| Invalid file type for upload. The only supported file types are PDF, PNG, GIF and JPG | You sent an invalid file type to the upload endpoint. |
Storage exception: XXXX | The cloud storage facility returned an error when attempting to upload your file via the upload endpoint. You should retry the operation later. |
Invalid filter definition: XXXX | A filter field you have specified is invalid or malformed |
| Method XXXX not supported on endpoint YYYY | You called a method which was not supported, e.g. GET on the login endpoint, or POST on the auditlogs endpoint. |
| Endpoint XXXX does not exist | You called an invalid endpoint, e.g. "/3.0/doesntexist" |
| No fields specified for record deletion. This would delete ALL XXXX records for your company. Request aborted. | You specified a DELETE request without filters, that would delete all your data. |
| No fields specified for record updating. This would update ALL XXXX records for your company. Request aborted. | You specified a POST request without filters, that would update all your data. |
Field verification failed, invalid field XXXX | You specified an invalid field when attempting to update a record with a POST request. |
Malformed result ordering value: XXXX | You specified a malformed value within the X-API-Result-Order header |
| XXXX: YYYY | An internal SQL error occurred and has been returned via the API for your convenience. |
| DELETE not supported for companies endpoint at your level of access. | You attempted to delete a company, which is only supported with certain API settings granted upon request. |
| PUT not supported for companies endpoint at your level of access. | You attempted to add a company, which is only supported with certain API settings granted upon request. |
| GET not supported for login endpoint. | You attempted to use GET on the login endpoint |
| The only supported fields for the login endpoint are "username" and "password". | You sent fields to the login endpoint which were not valid |
| User is not active | You attempted to log in a user who's user account isn't currently active |
| User email is not confirmed | You attempted to log in a user who has not confirmed their identity |
| Authentication failed | You specified an invalid username or password |
| Can't authenticate: User has no password set. Set a password and try again." | You attempted to log in a user who has no password set |
| Login impersonation not supported at your access level | You attempted to use the login endpoint when your API account is not enabled for impersonation auth. |
| DELETE not supported for login endpoint. | You attempted to call DELETE on the login endpoint. Only POST is supported. |
| PUT not supported for login endpoint. | You attempted to call PUT on the login endpoint. Only POST is supported. |
| No user currently logged in | You called the logout endpoint, but there is no user session set via login or the HTTP headers |
| GET not supported for password endpoint. | You attempted to call GET on the login endpoint. Only POST is supported. |
| The only supported field for the password endpoint is "new_password". | You specified invalid fields to the password endpoint |
| DELETE not supported for password endpoint. | You attempted to call DELETE on the password endpoint. Only POST is supported. |
| PUT not supported for password endpoint. | You attempted to call PUT on the password endpoint. Only POST is supported. |
| GET not supported for password endpoint. | You attempted to call GET on the password endpoint. Only POST is supported. |
| The only supported field for the resetpassword endpoint is "new_password". | You specified invalid fields to the resetpassword endpoint |
| DELETE not supported for resetpassword endpoint. | You attempted to call DELETE on the resetpassword endpoint. Only POST is supported. |
| PUT not supported for resetpassword endpoint. | You attempted to call PUT on the resetpassword endpoint. Only POST is supported. |
| Non-existent file key, or file not associated with an asset at your company. | You attempted to call the upload endpoint with an invalid file identifier key or one where you do not own the file entry. |