GetCompanyDetails
Retrieves the full details of a company from a company registration number
To connect to this service you'll need to use one of these endpoints:
Description
Returns the full information from the Companies House database regarding the company number requested.
If the company number is not known, the FindCompanyByNameAndAddress
or FindCompanyByNameOrPostcode
methods can be used to find it.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
companynumber | companynumber The company registration number to get the full details 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 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
|
---|---|
Result | Result A
|