GetCompanyDetails - CompaniesHouse • Data8 Web Services API Documentation

GetCompanyDetails

Retrieves the full details of a company from a company registration number

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.

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/CompaniesHouse/GetCompanyDetails.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/CompaniesHouse/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/companieshouse.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.
companynumber	companynumber The company registration number to get the full details 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.

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.
Result	Result A `CompaniesHouseResult` structure with the following fields holding the details of the requested company: `CompanyName` - the full company name as registered on Companies House `CompanyNumber` - the company registration number `HasInconsistencies` - populated where the company record has been marked up as having inconsistencies. `RegAddress_CareOfName` - where the registered office address is indicated as 'Care of' this will be output along with any data held in 'Supplied Company Name' (max 100 characters); Where there is no 'Care of' or 'Supplied company Name' data present 'c/o' will be suppressed and return blank. `RegAddress_POBox` - where the registered office address is indicated that PO Box data is present this will be output (max 10 characters) `RegAddress_AddressLine1` to `RegAddress_AddressLine6` - contains the registered address for the company `CompanyCategory` - the category of the company (Public Limited Company, Private Limited Company etc.) `CompanyStatus` - the status of the company (Active, Dissolved etc.) `CountryOfOrigin` - the country of origin `RegistrationDate` - only supplied for companies which are NOT 0, SC, SE and ES prefixes `DissolutionDate` - only supplied for dissolved companies which are incorporated in England, Wales or Scotland `IncorporationDate` - only supplied for companies which are incorporated in England, Wales or Scotland `ClosureDate` - only supplied for companies which are NOT incorporated in England, Wales or Scotland `Accounts_AccountRefDate` - the date of the last submitted accounts `Accounts_NextDueDate` - the date of the next due accounts `Accounts_Overdue` - a flag to indicate whether the next accounts are overdue `Accounts_LastMadeUpDate` - the Last Made Up date for the accounts `Accounts_AccountCategory` - the type of accounts filed `Accounts_DocumentsAvail` - details whether accounts are available `Returns_NextDueDate` - the date of the next due returns `Returns_LastMadeUpDate` - the Last Made Up date for the returns `Returns_DocumentsAvail` - details whether accounts are available `Mortgages_MortgageInd` - 3 possible values of 'No', 'LT300' (less than 300) and 'GE300' (greater than or equal to 300) `Mortgages_NumMortgageCharges` - total number of charges registered against the company `Mortgages_NumMortgageOutstanding` - total number of outstanding charges registered against the company `Mortgages_NumPartSatisfied` - total number of part-satisfied charges registered against the company `Mortgages_NumSatisfied` - total number of satisfied charges registered against the company `SICCode1` to `SICCode4` - details any SIC codes registered against the company `LastFullMembersDate` - the last full members date `LastBulkShareDate` - the last bulk share date `WeededDate` - only supplied where applicable. Indicates the date on which the Microfiche has been weeded `HasUKEstablishment` - 0 = No, 1 = Yes - indicates that an overseas company has registered a UK establishment name and address with Companies House (previously referred to as "Branch") `HasAppointments` - 0 = No, 1 = Yes - indicates that a company has company appointment details registered at Companies House `InLiquidation` - 0 = No, 1 = Yes - indicates that at some point during the company's life insolvency proceedings have taken place `LimitedPartnerships_NumberGenPartners` - only supplied where applicable (for LP and SL companies) `LimitedPartnerships_NumberLimPartners` - only supplied where applicable (for LP and SL companies)

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.

Result

A CompaniesHouseResult structure with the following fields holding the details of the requested company:

CompanyName - the full company name as registered on Companies House
CompanyNumber - the company registration number
HasInconsistencies - populated where the company record has been marked up as having inconsistencies.
RegAddress_CareOfName - where the registered office address is indicated as 'Care of' this will be output along with any data held in 'Supplied Company Name' (max 100 characters); Where there is no 'Care of' or 'Supplied company Name' data present 'c/o' will be suppressed and return blank.
RegAddress_POBox - where the registered office address is indicated that PO Box data is present this will be output (max 10 characters)
RegAddress_AddressLine1 to RegAddress_AddressLine6 - contains the registered address for the company
CompanyCategory - the category of the company (Public Limited Company, Private Limited Company etc.)
CompanyStatus - the status of the company (Active, Dissolved etc.)
CountryOfOrigin - the country of origin
RegistrationDate - only supplied for companies which are NOT 0, SC, SE and ES prefixes
DissolutionDate - only supplied for dissolved companies which are incorporated in England, Wales or Scotland
IncorporationDate - only supplied for companies which are incorporated in England, Wales or Scotland
ClosureDate - only supplied for companies which are NOT incorporated in England, Wales or Scotland
Accounts_AccountRefDate - the date of the last submitted accounts
Accounts_NextDueDate - the date of the next due accounts
Accounts_Overdue - a flag to indicate whether the next accounts are overdue
Accounts_LastMadeUpDate - the Last Made Up date for the accounts
Accounts_AccountCategory - the type of accounts filed
Accounts_DocumentsAvail - details whether accounts are available
Returns_NextDueDate - the date of the next due returns
Returns_LastMadeUpDate - the Last Made Up date for the returns
Returns_DocumentsAvail - details whether accounts are available
Mortgages_MortgageInd - 3 possible values of 'No', 'LT300' (less than 300) and 'GE300' (greater than or equal to 300)
Mortgages_NumMortgageCharges - total number of charges registered against the company
Mortgages_NumMortgageOutstanding - total number of outstanding charges registered against the company
Mortgages_NumPartSatisfied - total number of part-satisfied charges registered against the company
Mortgages_NumSatisfied - total number of satisfied charges registered against the company
SICCode1 to SICCode4 - details any SIC codes registered against the company
LastFullMembersDate - the last full members date
LastBulkShareDate - the last bulk share date
WeededDate - only supplied where applicable. Indicates the date on which the Microfiche has been weeded
HasUKEstablishment - 0 = No, 1 = Yes - indicates that an overseas company has registered a UK establishment name and address with Companies House (previously referred to as "Branch")
HasAppointments - 0 = No, 1 = Yes - indicates that a company has company appointment details registered at Companies House
InLiquidation - 0 = No, 1 = Yes - indicates that at some point during the company's life insolvency proceedings have taken place
LimitedPartnerships_NumberGenPartners - only supplied where applicable (for LP and SL companies)
LimitedPartnerships_NumberLimPartners - only supplied where applicable (for LP and SL companies)

Credit Usage

Each request to this method consumes 1 CompaniesHouse credit.

Sample Code

Request Format

{
  "companynumber": "04773536",
  "options": {}
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Result": {
    "CompanyName": "DATA8 LIMITED",
    "CompanyNumber": "04773536",
    "HasInconsistencies": "",
    "RegAddress_CareOfName": "",
    "RegAddress_POBox": "",
    "RegAddress_AddressLine1": "C/O ALLEN ACCOUNTANCY UNIT 13 GWENFRO UNITS",
    "RegAddress_AddressLine2": "WREXHAM TECHNOLOGY PARK",
    "RegAddress_AddressLine3": "WREXHAM",
    "RegAddress_AddressLine4": "CLWYD",
    "RegAddress_AddressLine5": "LL13 7YP",
    "RegAddress_AddressLine6": "",
    "CompanyCategory": "Private Limited Company",
    "CompanyStatus": "Active",
    "CountryOfOrigin": "United Kingdom",
    "RegistrationDate": "",
    "DissolutionDate": "",
    "IncorporationDate": "21/05/2003 00:00:00",
    "ClosureDate": "",
    "Accounts_AccountRefDate": "31-03",
    "Accounts_NextDueDate": "31/12/2019 00:00:00",
    "Accounts_Overdue": "NO",
    "Accounts_LastMadeUpDate": "31/03/2018 00:00:00",
    "Accounts_AccountCategory": "UNAUDITED ABRIDGED",
    "Accounts_DocumentsAvail": "True",
    "Returns_NextDueDate": "24/11/2016 00:00:00",
    "Returns_Overdue": "OVERDUE",
    "Returns_LastMadeUpDate": "27/10/2015 00:00:00",
    "Returns_DocumentAvail": "True",
    "Mortgages_MortgageInd": "",
    "Mortgages_NumMortgageCharges": "",
    "Mortgages_NumMortgageOutstanding": "",
    "Mortgages_NumPartSatisfied": "",
    "Mortgages_NumSatisfied": "",
    "SICCode1": "62090 - Other information technology service activities",
    "SICCode2": "",
    "SICCode3": "",
    "SICCode4": "",
    "LastFullMembersDate": "27/10/2015 00:00:00",
    "LastBulkShareDate": "",
    "WeededDate": "",
    "HasUKEstablishment": "False",
    "HasAppointments": "True",
    "InLiquidation": "False",
    "LimitedPartnerships_NumberGenPartners": "",
    "LimitedPartnerships_NumberLimPartners": ""
  }
}

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

Parameter	Value
Parameters
companynumber	companynumber
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 5 Try It Now!