Developer API Suite

filingHistoryStream resource

Methods

  • get - Company filing history stream

Resource

{
    "data": {
        "annotations": [
            {
                "annotation": "string",
                "date": "date",
                "description": "string"
            }
        ],
        "associated_filings": [
            {
                "date": "date",
                "description": "string",
                "type": "string"
            }
        ],
        "barcode": "string",
        "category": "string",
        "date": "date",
        "description": "string",
        "links": {
            "document_metadata": "string",
            "self": "string"
        },
        "pages": "integer",
        "paper_filed": "boolean",
        "resolutions": [
            {
                "category": "string",
                "description": "string",
                "document_id": "string",
                "receive_date": "date",
                "subcategory": "string",
                "type": "string"
            }
        ],
        "subcategory": "string",
        "transaction_id": "string",
        "type": "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 filing history resource data. May be absent for 'deleted' event types.

 Optional
data.annotations[] array

Annotations for the filing

 Optional
data.annotations[].annotation string

The annotation text.

 Optional
data.annotations[].date date

The date the annotation was added.
data.annotations[].description string

A description of the annotation. For enumeration descriptions see description section in the enumeration mappings file.
data.associated_filings[] array

Any filings associated with the current item

 Optional
data.associated_filings[].date date

The date the associated filing was processed.
data.associated_filings[].description string

A description of the associated filing. For enumeration descriptions see description section in the enumeration mappings file.
data.associated_filings[].type string

The type of the associated filing.
data.barcode string

The barcode of the document.

 Optional
data.category string

The category of the document filed.

Possible values are:

  • accounts
  • address
  • annual-return
  • capital
  • change-of-name
  • incorporation
  • liquidation
  • miscellaneous
  • mortgage
  • officers
  • resolution
data.date date

The date the filing was processed.
data.description string

A description of the filing. For enumeration descriptions see description section in the enumeration mappings file.
data.links object

Links to other resources associated with this filing history item.

 Optional
data.links.document_metadata string

Link to the document metadata associated with this filing history item. See the Document API documentation for more details.

 Optional
data.links.self string

Link to this filing history item.

 Optional
data.pages integer

Number of pages within the PDF document (links.document_metadata)

 Optional
data.paper_filed boolean

If true, indicates this is a paper filing.

 Optional
data.resolutions[] array

Resolutions for the filing

 Optional
data.resolutions[].category string

The category of the resolution filed.

Possible values are:

  • miscellaneous
data.resolutions[].description string

A description of the associated filing. For enumeration descriptions see description section in the enumeration mappings file.
data.resolutions[].document_id string

The document id of the resolution.

 Optional
data.resolutions[].receive_date date

The date the resolution was processed.
data.resolutions[].subcategory string

The sub-category of the document filed.

Possible values are:

  • resolution
data.resolutions[].type string

The type of the associated filing.
data.subcategory string

The sub-category of the document filed.

Possible values are:

  • resolution
 Optional
data.transaction_id string

The transaction ID of the filing.
data.type string

The type of filing.
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