Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to figure out what has gone wrong.

Before reaching out to support with an error, please carefully check the status codes, and error types.

Status codes

Here is a list of the different categories of status codes returned by the Protocol API. Use these to understand if a request was successful.

Name
2xx
Type
Description
A 2xx status code indicates a successful response.
Name
4xx
Type
Description
A 4xx status code indicates a client error.
Name
5xx
Type
Description
A 5xx status code indicates a server error.

Error types

Whenever a request is unsuccessful, the Concured API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

Here is a list of the error types supported by the Concured API.

Name
api_error
Type
Description
This means that there was an error in the API.
Name
invalid_request
Type
Description
This means that an error was made in the request.

Error response

  {
    "type": "api_error",
    "code": 503,
    "message": "Service Unavailable"
  }

Error response

  {
    "type": "invalid_request",
    "code": 401,
    "message": "UNAUTHENTICATED: Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API."
  }

Error response

  {
    "type": "invalid_request",
    "code": 422,
    "detail": [{
        "loc": [ "body", "client_id"],
        "msg": "field required",
        "type": "value_error.missing"
    }]
  }