Filing History

This endpoint links to Companies House, allowing you to view and retrieve documents in PDF format.

Retrieving Documents

In order to retrieve a document as a PDF from the filing history results, you should query the document link (relationships > document > links > related) but you must change the MIME Type in the header to application/pdf.

Example URL:

https://api2.redflagalert.net/v4/companies/01777777/filing-history/

JSON Structure:

{
	"data": [{
		"relationships": {
			"document": {
				"links": {
					"related": "https://api2.redflagalert.net/v4/documents/wW054GFYFWfdZYMIyIfTDank2njJSKJb35KaxwY9AeA/"
				}
			}
		},
		"attributes": {
			"category": "mortgage",
			"description": "mortgage-create-with-deed-with-charge-number",
			"links": {
				"self": "/company/01777777/filing-history/MzA5MTY0OTM4M2FkaXF6a2N4"
			},
			"barcode": "A2NMAXXV",
			"text_description": "Registration of a charge",
			"paper_filed": true,
			"description_values": {
				"charge_number": "017777770771"
			},
			"date": "2013-12-20",
			"type": "MR01",
			"pages": 6,
			"document_id": "wW054GFYFWfdZYMIyIfTDank2njJSKJb35KaxwY9AeA",
			"subcategory": "create"
		},
		"type": "filing_history",
		"id": "MzA5MTY0OTM4M2FkaXF6a2N4-A2NMAXXV",
		"links": {
			"self": "https://api2.redflagalert.net/v4/companies/01777777/filing-history/MzA5MTY0OTM4M2FkaXF6a2N4"
		}
	}],
	"links": {
		"self": "https://api2.redflagalert.net/v4/companies/01777777/filing-history/",
		"next": "https://api2.redflagalert.net/v4/companies/01777777/filing-history/?page%5Boffset%5D=2",
		"last": "https://api2.redflagalert.net/v4/companies/01777777/filing-history/?page%5Boffset%5D=32",
		"first": "https://api2.redflagalert.net/v4/companies/01777777/filing-history/?page%5Boffset%5D=1"
	}
}

Attributes

Field Key	Description	Notes
category	The category of the document filed.	Possible values are: accounts address annual-return capital change-of-name incorporation liquidation miscellaneous mortgage officers resolution
description	A description of the filing.	For enumeration descriptions see description section in the enumeration mappings.
links	Links to other resources associated with this filing history item.
barcode	The barcode of the document.
text_description	A text description of the filing.	For enumeration descriptions see description section in the enumeration mappings.
paper_filed	If true, indicates this is a paper filing.
description_values	The main description code
date	The date the associated filing was processed.
type	The type of the associated filing.
pages	Number of pages within the PDF document (links.document_metadata)
document_id	The document id of the resolution.
subcategory	The sub-category of the document filed.	Possible values are: resolution