Home/Documentation/Reference

Insolvency API reference

Vocabulary

Every country, procedure, notice step, case status, sector and driver, with its label in plain English.

Every plan

The call

Every country, procedure, notice step, case status and sector, with its label in plain English.

GEThttps://api.insolvencyapi.com/v1/vocabulary

Try it

Your keyGet a free key

Kept in this browser and filled in on every documentation page.

Calls the API from this browser with your key.

curl PHP Python JavaScriptCopy

Code, built from the form

The answer

Parameters

This endpoint takes no parameters.

What comes back

One record in data, with these fields. Paging and counts are in meta; see Pagination.

FieldTypeWhat it holds

countrieslistcode, label, held_as and whether notices are held.

procedureslistcode and label.

notice_stepslistcode and label.

case_statuseslistcode and label.

sectorslistcode (A to U) and label: the sections UK SIC 2007 and French NAF rev. 2 share.

driverslistcode and label: who started a case, for /v1/stats/drivers.

An example answer

A real answer from this morning’s data, made by the call Try it opens on.

Example answerCopy

{
  "data": {
    "countries": [
      {
        "code": "gb",
        "label": "United Kingdom",
        "held_as": "cases",
        "notices": true
      },
      {
        "code": "fr",
        "label": "France",
        "held_as": "cases",
        "notices": true
      },
      {
        "code": "at",
        "label": "Austria",
        "held_as": "cases",
        "notices": false
      }
    ],
    "procedures": [
      {
        "code": "compulsory_liquidation",
        "label": "Compulsory liquidation (winding up by the court)"
      },
      {
        "code": "creditors_voluntary_liquidation",
        "label": "Creditors' voluntary liquidation"
      },
      {
        "code": "members_voluntary_liquidation",
        "label": "Members' voluntary liquidation"
      }
    ],
    "notice_steps": [
      {
        "code": "petition_filed",
        "label": "Winding-up petition filed"
      },
      {
        "code": "petition_served",
        "label": "Winding-up petition served"
      },
      {
        "code": "petition_dismissed",
        "label": "Winding-up petition dismissed"
      }
    ],
    "case_statuses": [
      {
        "code": "petition",
        "label": "A petition is pending"
      },
      {
        "code": "open",
        "label": "Proceedings are open"
      },
      {
        "code": "closing",
        "label": "Final steps under way"
      }
    ],
    "sectors": [
      {
        "code": "A",
        "label": "Agriculture, forestry and fishing"
      },
      {
        "code": "B",
        "label": "Mining and quarrying"
      },
      {
        "code": "C",
        "label": "Manufacturing"
      }
    ],
    "drivers": [
      {
        "code": "directors_resolution",
        "label": "The directors and shareholders decided to wind up (creditors' voluntary liquidation)"
      },
      {
        "code": "tax_authority_petition",
        "label": "Wound up by the court on a petition from the tax authority"
      },
      {
        "code": "public_interest_petition",
        "label": "Wound up by the court on a public interest petition from the government"
      }
    ]
  },
  "meta": {}
}

Errors it can return

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.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.

Good to know

The same words are used for every country. Fetch the list once and keep it; it only grows.