Download a Company Document
Find out what you can do with our API...
Using a company number and image key obtained from the company_details method you can download a scan of a company document.
The company_document_download method provides a PDF which is a scan of a company document that has been filed with Companies House.
Types of documents available include: annual returns, annual accounts, change of director's details, change of name certificate and several more.
To view a list of these documents, and optionally select from that list, use the
company_details method with
the show_filing option set to true.
Mandatory Parameters
| Name | Description |
|---|---|
api_key or javascript_key |
Use your API key if invoking server-side. If invoking from the browser via JavaScript, generate a JavaScript key using the javascript_key method. |
| company_number | The Companies House company number. |
| image_key | The image key as returned by the filing history. |
Optional Parameters
| Name | Description |
|---|---|
| client | You can optionally include an identifier for your final client or user. This is logged in your usage log and you will be able to view your usage statistics by client. |
| output | Set to json for a JSON response; the default response is XML.
Not applicable to the SOAP API. |
| callback | When using JSON, specify a JSONP wrapper in which the JSON response is to be wrapped. |
Returned Values
The XML response is contained within a <company_document_download_res> element.
| Name | Description |
|---|---|
| status | Returns ok if the operation has succeeded, or error if an
error has occurred; Returns the error_code for error details. |
| error_code | Returns the error code when the status is error. See below for error codes. |
| t2a_version_number | The current API version number. |
| credit_used | The number of credits used in order to execute the request. |
| mode | Returns normal or test when executed in the
free test mode. |
| web_address | The full URL of an http download which will allow your final client (or you, on their behalf) to download the PDF presentation of the document. |
Error Codes
See the common error codes. There are no errors which are specific to this method.
Free Test Mode
When operating in the free test mode errors are returned if mandatory parameters are missing, or it returns a dummy data response, in an identical format to a real response.
Note that the mode is returned as test when the method is operating in the free test mode.
Example XML Response
<?xml version="1.0"?> <company_document_download_res > <mode>normal</mode> <t2a_version_number>1.0.0</t2a_version_number> <status>ok</status> <web_address>https://t2a.co/rest?pdf=qdohLhdshAA0001039139S9AJ</web_address> </company_document_download_res >