GetImageReport - BusinessInformation • Data8 Web Services API Documentation

GetImageReport

Requests a scanned copy of a document submitted to Companies House

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.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/BusinessInformation/GetImageReport.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/BusinessInformation/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/businessinformation.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
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 `GetAvailableImageReports` method
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

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.

Name	Description
Common Options
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.
Service Specific Options
Country	Country The 2-character code of the country to search for businesses in. The allowed countries will vary depending on your subscription. Common values include `UK` for United Kingdom and `IE` for Ireland.

Results

This method returns an object containing the following fields:

Name Description

Status

Name	Description
Status	Status Indicates whether the method call was successful, or if some error occurred. If the `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

Indicates whether the method call was successful, or if some error occurred. If the 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

The URL at which the report can be accessed

Credit Usage

Requests to this method do not consume credits, but you must have some BusinessInformation credits available.

Sample Code

Request Format

{
  "number": "04773536",
  "companyName": "DATA8 LTD",
  "identifer": "",
  "options": {
    "Country": "UK"
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Url": "https://webservices.data-8.co.uk/businessinformationimagedocument.ashx?key=Zh4ulMrQR4Ik7SBXErDOJo4Rc%2bZ1Xdeywhb75E7gh4UmVGqwnAjMDa2gOp48w%2bRFLfDEkF0tOZQ25auzDe6Ht5KP%2foFqAz9it9dI2ZgAhfzCOnHK3u5qkiHjUoh1fULhyDt55EZ4Q4IWEax%2bkld%2b8Q"
}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/BusinessInformation/GetImageReport.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.