This endpoint links to Companies House, allowing you to view and retrieve documents in PDF format.
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.
https://api2.redflagalert.net/v4/companies/01777777/filing-history/
{"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"}}
Field Key | Description | Notes |
| The category of the document filed. | Possible values are:
|
| A description of the filing. | For enumeration descriptions see |
| Links to other resources associated with this filing history item. | ​ |
| The barcode of the document. | ​ |
| A text description of the filing. | For enumeration descriptions see |
| If | ​ |
| The main description code | ​ |
| The date the associated filing was processed. | ​ |
| The type of the associated filing. | ​ |
| Number of pages within the PDF document (links.document_metadata) | ​ |
| The document id of the resolution. | ​ |
| The sub-category of the document filed. | Possible values are:
|