Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. 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 and do some rudimentary debugging (before contacting support).

Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Oblic support.

Status codes

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

Name
2xx
Description
A 2xx status code indicates a successful response.
Name
4xx
Description
A 4xx status code indicates a client error — this means it's a you problem.
Name
5xx
Description
A 5xx status code indicates a server error — you won't be seeing these.

Error response structure

Whenever a request is unsuccessful, the Oblic API will return an error response with a consistent structure. The response includes a status field set to "error", a data field set to null, and an errors array containing one or more error objects.

Each error object in the errors array contains:

Name
cd
Description
A machine-readable error code identifying the specific error type (e.g., "NOT_AUTHENTICATED", "INVALID_REQUEST", "RESOURCE_NOT_FOUND").
Name
message
Description
A human-readable message describing what went wrong and potentially how to fix it.

Error response

{
  "status": "error",
  "data": null,
  "errors": [
    {
      "cd": "NOT_AUTHENTICATED",
      "message": "User not found"
    }
  ]
}