Error Handling

What to expect from us

All errors from returned from the API should have the same base response body. You can expect the following response body properties:

  • ErrorCode - Find a list of available error codes here
  • DeveloperErrorMessage - A more detailed error message on why the error occured
  • ErrorId - A unique Id that can be provided to API Support if in need of assistance

Here's an example of how the response of a unauthorized request looks like.

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

  ErrorCode: 4005,
  DeveloperErrorMessage: "AuthorizationException - Authorization has been denied for this request.",
  ErrorId: "1c296026-489d-434c-b7e9-70401278a086"


Internal Server Errors

If you encounter a Internal Server Error as response, you will still get this generic response body. In this case, use the ErrorId and contact [email protected].