Error Codes

When a request to an endpoint fails, an HTTP status is returned. For all HTTP methods (except DELETE) a list of errors is returned in the body.


400 Bad Request

HTTP Status: 400

Description: Bad request errors are documented in each API’s reference documentation. For example, each endpoints in the Provisioning API v0 documentation has a 400 Bad request section in red under Responses.

Bad request 400 in ReDoc


401 Unauthorized

HTTP Status : 401

Description: Error 401 will be returned if the OAuth 2.0 token is not provided in the request or is invalid. Refer to Getting Started for an explanation of how the Acquisio APIs are secured.

{
  "errors": [
    {
      "message": "Required OAuth credentials not provided. Make sure your API invocation call has a header: \"Authorization: Bearer ACCESS_TOKEN\""
    }
  ]
}

403 Forbidden

HTTP Status : 403

Description: Error 403 will be returned if the access to a resource is forbidden or if the Client Application is not allowed to use the API.

{
  "errors": [
    {
      "message": "Access failure for API: /provisioning/v0, version: v0 status: (900908) - Resource forbidden"
    }
  ]
}

404 Not Found

HTTP Status: 404

Description: The url refers to a resource that does not exists.

Common causes of a 404 error:

{
  "errors": [
    {
      "message": "No matching resource found for given API Request"
    }
  ]
}

429 Too Many Requests

HTTP Status: 429

Description: The client application is throttled because the maximum number of requests within a time period has been reached.


500 Internal Server Error

HTTP Status: 500

Description: A unexpected error happened that caused the request to fail.


503 Service Unavailable

HTTP Status: 503

Description: The API is temporarily unavailable.

Warning: When the status code is 503, the response body might not be the regular JSON error payload. An HTML page with the content-type “text/html” might also be returned instead.