Skip to the content

GetAvailableImageReports

Gets a list of documents for which a scanned copy can be retrieved

Live Demo

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

WSDL
https://webservices.data-8.co.uk/businessinformation.asmx
JSON
https://webservices.data-8.co.uk/BusinessInformation/GetAvailableImageReports.json

Description

Scanned copies of original documents submitted to Companies House can be retrieved using the GetImageReport method.

Use this method to get a list of the reports that can be downloaded, then submit the Identifier of the required report as returned from the list to the GetImageReport method to access the report itself.

Parameters

The following parameters can be supplied to this method

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 company registration number to get the list of available reports for

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

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
Reports

Reports

A list of the reports that can be downloaded for the requested company. Each item in the list has the following properties:

Name Description
Identifier A unique identifier for the report. Pass this identifier to the GetImageReport method to get the report itself
Name The name/number of the type of report
Description A human-readable description of the type of report
MimeType The type of document that can be downloaded
Date The date at which the report was made

Live Demo

number
options
Name Value
Common Options

Sample Code

Start a Free 14 Day Trial Today

Register below to start a free trial of our services