GetAvailableImageReports - BusinessInformation • Data8 Web Services API Documentation

GetAvailableImageReports

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

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.

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

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

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

Credit Usage

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

Sample Code

Request Format

{
  "number": "04773536",
  "options": {
    "Country": "UK"
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Reports": [
    {
      "Identifier": "MzIyODQ1NDM5NWFkaXF6a2N4",
      "Name": "CS01",
      "Description": "**Confirmation statement** made on 2019-02-16 with no updates",
      "MimeType": "application/pdf",
      "Date": "2019-03-04T00:00:00"
    },
    {
      "Identifier": "MzIyMDg4NTI5N2FkaXF6a2N4",
      "Name": "AA",
      "Description": "**Unaudited abridged accounts** made up to 2018-03-31",
      "MimeType": "application/pdf",
      "Date": "2018-11-30T00:00:00"
    },
    {
      "Identifier": "MzE5NzkzMzcxNGFkaXF6a2N4",
      "Name": "CS01",
      "Description": "**Confirmation statement** made on 2018-02-16 with updates",
      "MimeType": "application/pdf",
      "Date": "2018-02-16T00:00:00"
    },
    {
      "Identifier": "MzE5NDExOTM0M2FkaXF6a2N4",
      "Name": "AA",
      "Description": "**Unaudited abridged accounts** made up to 2017-03-31",
      "MimeType": "application/pdf",
      "Date": "2017-12-31T00:00:00"
    },
    {
      "Identifier": "MzE5MTk0MDAxNmFkaXF6a2N4",
      "Name": "CS01",
      "Description": "**Confirmation statement** made on 2017-10-27 with no updates",
      "MimeType": "application/pdf",
      "Date": "2017-12-05T00:00:00"
    },
    {
      "Identifier": "MzE3NDgzOTM5MWFkaXF6a2N4",
      "Name": "MR04",
      "Description": "**Satisfaction of charge** 1 in full",
      "MimeType": "application/pdf",
      "Date": "2017-05-02T00:00:00"
    },
    {
      "Identifier": "MzE2NDU5MTg0N2FkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption small company accounts** made up to 2016-03-31",
      "MimeType": "application/pdf",
      "Date": "2016-12-16T00:00:00"
    },
    {
      "Identifier": "MzE2MzE2NjM3M2FkaXF6a2N4",
      "Name": "CS01",
      "Description": "**Confirmation statement** made on 2016-10-27 with updates",
      "MimeType": "application/pdf",
      "Date": "2016-11-30T00:00:00"
    },
    {
      "Identifier": "MzEzMzg5NzI2N2FkaXF6a2N4",
      "Name": "AR01",
      "Description": "**Annual return** made up to 2015-10-27 with full list of shareholders",
      "MimeType": "application/pdf",
      "Date": "2015-10-27T00:00:00"
    },
    {
      "Identifier": "MzEzMzY2NDk1NGFkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption full accounts** made up to 2015-03-31",
      "MimeType": "application/pdf",
      "Date": "2015-10-23T00:00:00"
    },
    {
      "Identifier": "MzEyNTMwNjM0OWFkaXF6a2N4",
      "Name": "AR01",
      "Description": "**Annual return** made up to 2015-05-21 with full list of shareholders",
      "MimeType": "application/pdf",
      "Date": "2015-06-17T00:00:00"
    },
    {
      "Identifier": "MzExODA3MjI5MmFkaXF6a2N4",
      "Name": "SH01",
      "Description": "**Statement of capital following an allotment of shares** on 2014-03-31",
      "MimeType": "application/pdf",
      "Date": "2015-02-25T00:00:00"
    },
    {
      "Identifier": "MzExMjM2Mzc0N2FkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption small company accounts** made up to 2014-03-31",
      "MimeType": "application/pdf",
      "Date": "2014-11-28T00:00:00"
    },
    {
      "Identifier": "MzEwMjAyMzc3NmFkaXF6a2N4",
      "Name": "AR01",
      "Description": "**Annual return** made up to 2014-05-21 with full list of shareholders",
      "MimeType": "application/pdf",
      "Date": "2014-06-17T00:00:00"
    },
    {
      "Identifier": "MzA4OTczNzcyMGFkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption small company accounts** made up to 2013-03-31",
      "MimeType": "application/pdf",
      "Date": "2013-11-29T00:00:00"
    },
    {
      "Identifier": "MzA4MTIzMjcyNGFkaXF6a2N4",
      "Name": "AR01",
      "Description": "**Annual return** made up to 2013-05-21 with full list of shareholders",
      "MimeType": "application/pdf",
      "Date": "2013-07-09T00:00:00"
    },
    {
      "Identifier": "MzA2NTgxNzExOWFkaXF6a2N4",
      "Name": "AP01",
      "Description": "**Appointment** of Mr Mark Edward Carrington as a director",
      "MimeType": "application/pdf",
      "Date": "2012-10-15T00:00:00"
    },
    {
      "Identifier": "MzA2MDk4Nzg4NWFkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption small company accounts** made up to 2012-03-31",
      "MimeType": "application/pdf",
      "Date": "2012-07-18T00:00:00"
    },
    {
      "Identifier": "MzA1OTcxMDY3NmFkaXF6a2N4",
      "Name": "AR01",
      "Description": "**Annual return** made up to 2012-05-21 with full list of shareholders",
      "MimeType": "application/pdf",
      "Date": "2012-06-25T00:00:00"
    },
    {
      "Identifier": "MzA0ODc3MzY0NmFkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption small company accounts** made up to 2011-03-31",
      "MimeType": "application/pdf",
      "Date": "2011-12-09T00:00:00"
    },
    {
      "Identifier": "MzAzODEwNTUyNGFkaXF6a2N4",
      "Name": "AR01",
      "Description": "**Annual return** made up to 2011-05-21 with full list of shareholders",
      "MimeType": "application/pdf",
      "Date": "2011-06-01T00:00:00"
    },
    {
      "Identifier": "MzAyOTU4MDk0NWFkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption small company accounts** made up to 2010-03-31",
      "MimeType": "application/pdf",
      "Date": "2010-12-31T00:00:00"
    },
    {
      "Identifier": "MzAxNzA0MTQ2OWFkaXF6a2N4",
      "Name": "AR01",
      "Description": "**Annual return** made up to 2010-05-21 with full list of shareholders",
      "MimeType": "application/pdf",
      "Date": "2010-06-07T00:00:00"
    },
    {
      "Identifier": "MzAwNzQ4NzcyOWFkaXF6a2N4",
      "Name": "AA",
      "Description": "**Total exemption small company accounts** made up to 2009-03-31",
      "MimeType": "application/pdf",
      "Date": "2010-01-20T00:00:00"
    },
    {
      "Identifier": "MjAzOTIwOTk4NmFkaXF6a2N4",
      "Name": "287",
      "Description": "legacy",
      "MimeType": "application/pdf",
      "Date": "2009-08-14T00:00:00"
    }
  ]
}

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/GetAvailableImageReports.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.