Errors

On API errors we return standard HTTP Status Codes. On success, we return either 200 or 201 status codes.

HTTP error status codes all methods return

• 400, 401, 403, 404, 405

• 500, 502, 503

Error response format

Error response format is the following (error response always has 2 mandatory fields):

{
  "error": enum,        // API error type
  "message": string     // human-readable exception description
}

In some cases response may contain an optional “details” fields:

{
  "error": enum,        // specific API error code
  "message": string,    // human-readable exception description
  "field": string,      
  "value": string | number | boolean | null
}

General possible errors for ALL methods

Some API methods may return specific errors which are not listed below. You can find them in method's detailed documentation.

HTTP status code	API error code	Description
400	BAD_REQUEST	Invalid JSON body or headers does not contain all required fields
400	VALIDATION_ERROR	Invalid field types or values. The error contains an additional “details” field with the specified field and its value
401	INVALID_API_KEY	Invalid user API key identifier
401	INVALID_TENANT_API_KEY	Invalid tenant API key identifier
401	INVALID_SIGNATURE	Failed to verify request signature
403	ACCESS_DENIED	Lack of permissions to perform some actions. Or request from an unknown IP address, or API disabled on our side
404	NOT_FOUND	Request to non-existent API endpoint
405	METHOD_NOT_ALLOWED	Wrong request method used