FindBusinesses - BusinessInformation • Data8 Web Services API Documentation

FindBusinesses

Gets summary information on companies matching a name or address search.

Description

Supply a company registration number, name or postcode to retrieve basic information on any matching companies. The company registration number included in the results can then be used to obtain full detailed information from the other methods in 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/FindBusinesses.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 search for. This would normally be left blank as you would call this method in order to find a company registration number.
name	name The company name to search for. Fuzzy matching is used so this does not need to be exact. Leave this as `null` or `""` to find all companies in the `postcode`
address	address This parameter is currently not supported, leave as `null`
postcode	postcode The postcode to search for companies in. Leave as `null` or `""` to search only by `name`
telno	telno This parameter is not currently supported, leave as `null`
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
CleanAddresses	CleanAddresses Indicates whether or not the addresses returned should be cleaned versions, or the original raw addresses
IncludeNonLtd	IncludeNonLtd Indicates whether or not to include Non Limited businesses in your search.
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.
ActiveOnly	ActiveOnly Indicates if only currently active companies should be included in the search results, so any dissolved companies will be excluded.

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.
Businesses	Businesses An array of basic business details which match the search criteria. Each item in the array has the following fields: `Name` - the full name of the company `Address` - the registered address of the company `CompanyNumber` - the company registration number `LastAccountsFiled` - the date of the last accounts filed by the company `TradingAddress` - the main trading address of the company

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.

Businesses

An array of basic business details which match the search criteria. Each item in the array has the following fields:

Name - the full name of the company
Address - the registered address of the company
CompanyNumber - the company registration number
LastAccountsFiled - the date of the last accounts filed by the company
TradingAddress - the main trading address of the company

Credit Usage

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

Sample Code

Request Format

{
  "number": "",
  "name": "Data8",
  "address": "",
  "postcode": "",
  "telno": "",
  "options": {
    "CleanAddresses": true,
    "IncludeNonLtd": true,
    "Country": "UK",
    "ActiveOnly": true
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Businesses": [
    {
      "Name": "DATA8 LIMITED",
      "Address": {
        "Address": {
          "Lines": [
            "Data8 Limited",
            "C/O Allen Accountancy",
            "Unit 13",
            "Gwenfro Units",
            "WREXHAM",
            "Clwyd",
            "LL13 7YP"
          ]
        },
        "RawAddress": {
          "Organisation": "DATA8 LIMITED",
          "Department": "C/O ALLEN ACCOUNTANCY",
          "AddressKey": 0,
          "OrganisationKey": 0,
          "BuildingNumber": 0,
          "SubBuildingName": "UNIT 13",
          "BuildingName": "GWENFRO UNITS",
          "DependentThoroughfareName": "",
          "ThoroughfareName": "",
          "DoubleDependentLocality": "",
          "DependentLocality": "",
          "Locality": "WREXHAM",
          "Postcode": "LL137YP",
          "Dps": "",
          "PoBox": "",
          "PostalCounty": "CLWYD"
        }
      },
      "CompanyNumber": "04773536",
      "LastAccountsFiled": "2018-03-31T00:00:00",
      "TradingAddress": {
        "Address": {
          "Lines": [
            "Data8 Limited",
            "C/O Allen Accountancy",
            "Unit 13",
            "Gwenfro Units",
            "WREXHAM",
            "Clwyd",
            "LL13 7YP"
          ]
        },
        "RawAddress": {
          "Organisation": "DATA8 LIMITED",
          "Department": "C/O ALLEN ACCOUNTANCY",
          "AddressKey": 0,
          "OrganisationKey": 0,
          "BuildingNumber": 0,
          "SubBuildingName": "UNIT 13",
          "BuildingName": "GWENFRO UNITS",
          "DependentThoroughfareName": "",
          "ThoroughfareName": "",
          "DoubleDependentLocality": "",
          "DependentLocality": "",
          "Locality": "WREXHAM",
          "Postcode": "LL137YP",
          "Dps": "",
          "PoBox": "",
          "PostalCounty": "CLWYD"
        }
      }
    }
  ]
}

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