Retrieve Company House Report
/api/v2/company_house_report/{api_reference}
operationId: company_house_report_show
Live: https://gdapi.globaldata.net.au/api/v2/company_house_report/{api_reference} · Sandbox: https://sandbox-gdapi.globaldata.net.au/api/v2/company_house_report/{api_reference}
Polls the status of a UK Companies House report that was previously queued via POST /company_house_report. Provide the api_reference returned from the original request to determine whether the report is ready, download the JSON payload, or stream a PDF copy. This retrieval call is not billable and can be repeated until the report is ready.
Response Behaviour
- While the report is still compiling, the API responds with HTTP
202. Keep polling with an exponential backoff. - Once ready, the endpoint returns HTTP
200with the full JSON report. - Append
?pdf=trueto stream a formatted PDF copy of the same report. Whenpdf=true, the response body is a PDF (application/pdf) instead of JSON. - The service polls upstream data for up to 30 seconds; if no report is available at that point you will receive a
202response. Continue polling with the sameapi_reference.
Sandbox Usage
The sandbox dataset is deterministic and does not use live data. First request a report for one of the sandbox company numbers via POST /company_house_report, then poll this endpoint with the returned api_reference.
Note: The company 55667788 (DELAYED REPORT LTD) will return HTTP 202 on the first poll to simulate asynchronous processing. Subsequent polls will return the report.
Path parameters
| Field | Description |
|---|---|
api_referencerequired |
string (uuid) The API reference (UUID) returned when the report was queued via |
Query parameters
| Field | Description |
|---|---|
pdf |
boolean When set to |
Responses
Report is ready. Returns JSON by default or a PDF when pdf=true.
application/json
application/pdf
| Field | Description |
|---|---|
message |
string Always |
function |
string Name of the API function that handled the request. |
api_reference |
string (uuid) Audit reference for this retrieval call (not the original queue reference). |
report |
object Full UK Companies House company report. The top-level fields come from the Companies House company profile endpoint. Additional sections ( |
report. |
string The registered name of the company. |
report. |
string The Companies House company number. |
report. |
string The current status of the company (e.g. |
report. |
string Additional detail about the company status, if any. |
report. |
string The type of company (e.g. |
report. |
string The company subtype, if applicable. |
report. |
string (date) The date the company was created/incorporated. |
report. |
string (date) The date the company was dissolved or ceased. Present only for dissolved/ceased companies. |
report. |
string The jurisdiction the company is registered in (e.g. |
report. |
object The company's registered office address. |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
boolean Whether the registered office address is in dispute. |
report. |
object (dynamic) Accounting information including reference dates and the last/next filing periods. |
report. |
object (dynamic) Annual return information (pre-2016 companies). |
report. |
boolean Whether the company can currently file with Companies House. |
report. |
object (dynamic) Confirmation statement due dates and status. |
report. |
string Corporate annotation text, if any. |
report. |
string The registration number of an external company. |
report. |
object (dynamic) Details of a foreign company, if applicable. |
report. |
object (dynamic) Details of a branch company, if applicable. |
report. |
boolean Indicates partial data availability. |
report. |
array of objects List of previous names the company has used. |
report. |
string |
report. |
string (date) |
report. |
string (date) |
report. |
object (dynamic) The service address, if different from the registered office. |
report. |
array of objects Standard Industrial Classification codes expanded with descriptions. |
report. |
string The SIC code. |
report. |
string Human-readable description of the SIC code. |
report. |
integer Count of super-secure managing officers, if any. |
report. |
boolean Whether the registered office address has been flagged as undeliverable. |
report. |
string (date-time) ISO 8601 UTC timestamp indicating when the report was generated. |
report. |
array of objects Array of officers (directors, secretaries, etc.) associated with the company. Active officers (no |
report. |
string The unique officer identifier within Companies House. |
report. |
string The officer's name in |
report. |
string The role held (e.g. |
report. |
string (date) The date the officer was appointed. |
report. |
string (date) The date the officer resigned. Absent for active officers. |
report. |
string (date) Present when |
report. |
boolean Whether the appointment pre-dates 1992 records. |
report. |
string Date of birth truncated to year and month ( |
report. |
string The officer's nationality. |
report. |
string The officer's country of residence. |
report. |
string The officer's occupation. |
report. |
string Internal Companies House person number. |
report. |
object (dynamic) The correspondence address of the officer. |
report. |
array of objects Previous names for the officer. |
report. |
string |
report. |
string |
report. |
object Identification details for corporate officers. |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
string |
report. |
object (dynamic) Identity verification information, if available. |
report. |
object (dynamic) Contact details for corporate managing officers. |
report. |
object (dynamic) Principal office address for corporate managing officers. |
report. |
string Responsibilities of a managing officer. |
report. |
object The company's filing history. Only present when the company has filings at Companies House. Up to 200 most recent filings are returned. |
report. |
integer The total number of filings for this company. |
report. |
integer The number of filings included in this response (capped at 200). |
report. |
array of objects Array of individual filing records. |
report. |
string Unique transaction identifier for this filing. |
report. |
string Document identifier that can be used with the Company House Document endpoint to download the filing as a PDF. |
report. |
string (date) The date of the filing. |
report. |
string The type code of the filing (e.g. |
report. |
string The category of filing (e.g. |
report. |
string Sub-category of the filing (e.g. |
report. |
string Human-readable description of the filing. |
report. |
integer Number of pages in the document. |
report. |
string Barcode identifier for the filing. |
report. |
boolean Whether the filing was submitted on paper. |
report. |
array of objects Annotations associated with the filing. |
report. |
array of objects Related filings associated with this filing. |
report. |
array of objects Resolution details, if applicable. |
report. |
array of objects Array of persons with significant control (PSCs) over the company. Only present when the company has PSC records at Companies House. |
report. |
string The type of PSC (e.g. |
report. |
string The name of the individual or entity. |
report. |
object (dynamic) The correspondence address of the PSC. |
report. |
string Date of birth truncated to year and month ( |
report. |
string Country of residence. Only for individuals. |
report. |
string Nationality of the PSC. |
report. |
array of strings List of natures of control held (e.g. |
report. |
object (dynamic) Identification details for corporate entity PSCs. |
report. |
object (dynamic) Broken-down name components for individual PSCs. |
report. |
string (date) The date the PSC was notified. |
report. |
boolean Whether the PSC has ceased. |
report. |
string (date) The date the PSC ceased, if applicable. |
report. |
boolean Whether the PSC is sanctioned. |
report. |
string Description of the PSC entry. |
report. |
object (dynamic) Principal office address for legal person/corporate entity PSCs. |
Also available as a PDF (application/pdf)
Report is still being prepared (returned when no data is available after the 30-second polling window).
application/json
| Field | Description |
|---|---|
message |
string Status message indicating the report is not ready yet. |
No report was found for the provided api_reference, or it belongs to another account/environment.
application/json
| Field | Description |
|---|---|
message |
string Error message describing that the record could not be located. |