Home/Documentation/Guides

Insolvency API guide

Errors

Every error code, what it means and what to do.

Every code

StatusCodeWhat to do

400bad_requestA value is wrong, such as a date in another format. The message says which.

401unauthorizedThe key is missing, wrong or no longer valid.

403upgrade_requiredYour plan does not include this. The answer names the plan that does.

404not_foundNo record with that id. An empty list is never a 404.

422unknown_parameterA parameter this endpoint does not take. The answer lists the ones it does.

429rate_limitedToo many calls in one minute. Wait for the seconds in Retry-After.

429quota_exceededYour calls for the day or month are used. The answer says when they reset.

500server_errorOur side. It is logged; try again in a minute, and see the Status page.

The code is fixed forever, so your program can test it. The message is for people and may be reworded.

The shape

Every error has the same shape. A refusal for your plan adds plan, the plan that would answer.

An errorCopy

{
  "error": {
    "code": "upgrade_required",
    "message": "This endpoint needs the Intel plan or above. See https://insolvencyapi.com/pricing",
    "plan": "intel",
    "docs": "https://insolvencyapi.com/documentation/errors"
  }
}