GetImageReport
Requests a scanned copy of a document submitted to Companies House
To connect to this service you'll need to use one of these endpoints:
Description
After retrieving a list of available scanned documents for a company using the GetAvailableImageReports method, the identified for the required report can be submitted to this method. This method will then return the URL from which the scanned document can be retrieved.
Access to these documents is usually charged as an additional per-use fee on top of access to the rest of this service.
Parameters
The following parameters can be supplied to this method
| username |
username apikey-, e.g.
apikey-ABCD-1234-EFGH-5678
|
|---|---|
| password |
password |
| number | number The registration number of the company to get a report for |
| companyName | companyName The name of the company to get a report for |
| identifier | identifier The identifier of the report to download, taken from the results of the |
Advanced Options
The following options can be specified as part of the option parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
| Common Options | |
|---|---|
| Name | Description |
| ApplicationName | ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard |
Results
This method returns an object containing the following fields:
| Status |
Status Success field is true, the other results described below can be used to get the results of the method.
If Success is false, some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
|---|---|
| Url | Url The URL at which the report can be accessed |