Developer API Suite

insolvencyCasesStream resource

Methods

  • get - Insolvency cases stream

Resource

{
    "data": {
        "cases": [
            {
                "dates": [
                    {
                        "date": "date",
                        "type": "string"
                    }
                ],
                "links": {
                    "charge": "string"
                },
                "notes": [
                    "string"
                ],
                "number": "string",
                "practitioners": [
                    {
                        "address": [
                            {
                                "address_line_1": "string",
                                "address_line_2": "string",
                                "country": "string",
                                "locality": "string",
                                "postal_code": "string",
                                "region": "string"
                            }
                        ],
                        "appointed_on": "date",
                        "ceased_to_act_on": "date",
                        "name": "string",
                        "role": "string"
                    }
                ],
                "type": "string"
            }
        ],
        "etag": "string",
        "status": "string"
    },
    "event": {
        "fields_changed": [
            "string"
        ],
        "published_at": "date-time",
        "timepoint": "integer",
        "type": "string"
    },
    "resource_id": "string",
    "resource_kind": "string",
    "resource_uri": "string"
}

Properties

Name Type Description Additional
data object

The company insolvency resource data. May be absent for 'deleted' event types.

 Optional
data.cases[] array

List of insolvency cases.
data.cases[].dates[] array

The dates specific to the case.
data.cases[].dates[].date date

The case date, described by date_type.
data.cases[].dates[].type string

Describes what date is represented by the associated date element. For enumeration descriptions see insolvency_case_date_type section in the enumeration mappings.

Possible values are:

  • instrumented-on
  • administration-started-on
  • administration-discharged-on
  • administration-ended-on
  • concluded-winding-up-on
  • petitioned-on
  • ordered-to-wind-up-on
  • due-to-be-dissolved-on
  • case-end-on
  • wound-up-on
  • voluntary-arrangement-started-on
  • voluntary-arrangement-ended-on
  • moratorium-started-on
  • moratorium-ended-on
  • declaration-solvent-on
data.cases[].links object

The practitioners for the case.

 Optional
data.cases[].links.charge string

The link to the charge this case is lodged against.

 Optional
data.cases[].notes[] array of string

The dates specific to the case.

 Optional
data.cases[].number string

The case number.

 Optional
data.cases[].practitioners[] array

The practitioners for the case.
data.cases[].practitioners[].address[] array

The practitioners' address.
data.cases[].practitioners[].address[].address_line_1 string

The first line of the address.
data.cases[].practitioners[].address[].address_line_2 string

The second line of the address.

 Optional
data.cases[].practitioners[].address[].country string

The country.

 Optional
data.cases[].practitioners[].address[].locality string

The locality. For example London.

 Optional
data.cases[].practitioners[].address[].postal_code string

The postal code. For example CF14 3UZ.

 Optional
data.cases[].practitioners[].address[].region string

The region. For example Surrey.

 Optional
data.cases[].practitioners[].appointed_on date

The date the practitioner was appointed on.

 Optional
data.cases[].practitioners[].ceased_to_act_on date

The date the practitioner ceased to act for the case.

 Optional
data.cases[].practitioners[].name string

The name of the practitioner.
data.cases[].practitioners[].role string

The type of role.

Possible values are:

  • final-liquidator
  • receiver
  • receiver-manager
  • proposed-liquidator
  • provisional-liquidator
  • administrative-receiver
  • practitioner
  • interim-liquidator
 Optional
data.cases[].type string

The type of case. For enumeration descriptions see insolvency_case_type section in the enumeration mappings.

Possible values are:

  • compulsory-liquidation
  • creditors-voluntary-liquidation
  • members-voluntary-liquidation
  • in-administration
  • corporate-voluntary-arrangement
  • corporate-voluntary-arrangement-moratorium
  • administration-order
  • receiver-manager
  • administrative-receiver
  • receivership
  • foreign-insolvency
  • moratorium
data.etag string

The ETag of the resource.
data.status string

Company insolvency status details

Possible values are:

  • administration-order
  • administrative-receiver
  • in-administration
  • liquidation
  • live-receiver-manager-on-at-least-one-charge
  • receivership
  • receiver-manager
  • voluntary-arrangement
  • voluntary-arrangement-receivership
 Optional
event object

Link to the related resource

 Read only.
event.fields_changed[] array of string

Array of fields that have been changed by this event. Nested fields are referenced by dot notation e.g. links.document_metadata

 Optional, read only.
event.published_at date-time

The date and time the data notification was raised in the format of yyyy-MM-dd'T'HH:mm:ss for example: 2024-09-04T10:52:22

 Read only.
event.timepoint integer

The point-in-time identifier for this stream document. Use to re-establish a connection to the stream at this point.

 Read only.
event.type string

The type of event denoted by this stream document.

Possible values are:

  • changed
  • deleted
 Read only.
resource_id string

The ID of the resource.

 Read only.
resource_kind string

The type of resource contained within the stream document.

Possible values are:

  • company-profile#company-profile
  • filing-history#filing-history
 Read only.
resource_uri string

The URI of the resource.

 Read only.
Built by Companies House