Skip to the content

GetImageReport

Requests a scanned copy of a document submitted to Companies House

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/GetImageReport.json

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

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

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
Url

Url

The URL at which the report can be accessed

Live Demo

number
companyName
identifer
options No options are currently supported by this method
Credits Remaining Today: 5

Sample Code

Start a Free 30 Day Trial Today

Start a free trial today