FindBusinesses
Gets summary information on companies matching a name or address search.
To connect to this service you'll need to use one of these endpoints:
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.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
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 |
address | address This parameter is currently not supported, leave as |
postcode | postcode The postcode to search for companies in. Leave as |
telno | telno This parameter is not currently supported, leave as |
options | options |
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 |
Service-Specific Options | |
Name | Description |
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. |
Results
This method returns an object containing the following fields:
Status |
Status 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:
|