- get - Advanced search for a company
{
"etag": "string",
"hits": "string",
"items": [
{
"company_name": "string",
"company_number": "string",
"company_status": "string",
"company_subtype": "string",
"company_type": "string",
"date_of_cessation": "date",
"date_of_creation": "date",
"kind": "string",
"links": {
"company_profile": "string"
},
"registered_office_address": {
"address_line_1": "string",
"address_line_2": "string",
"country": "string",
"locality": "string",
"postal_code": "string",
"region": "string"
},
"sic_codes": [
"string"
]
}
],
"kind": "string",
"top_hit": {
"company_name": "string",
"company_number": "string",
"company_status": "string",
"company_subtype": "string",
"company_type": "string",
"date_of_cessation": "date",
"date_of_creation": "date",
"kind": "string",
"links": {
"company_profile": "string"
},
"registered_office_address": {
"address_line_1": "string",
"address_line_2": "string",
"country": "string",
"locality": "string",
"postal_code": "string",
"region": "string"
},
"sic_codes": [
"string"
]
}
}
| Name |
Type |
Description |
Additional |
|
etag
|
string |
|
Optional
|
|
hits
|
string |
The number of matches found using advanced search
|
|
|
items[]
|
array |
|
|
|
items[].company_name
|
string |
The company name associated with the company
|
|
|
items[].company_number
|
string |
The company number of the company
|
|
|
items[].company_status
|
string |
The status of the company.
For enumeration descriptions see company_status section in the enumeration mappings
Possible values are:
active
dissolved
open
closed
converted-closed
receivership
administration
liquidation
insolvency-proceedings
voluntary-arrangement
registered
removed
|
|
|
items[].company_subtype
|
string |
The subtype of the company.
For enumeration descriptions see company_subtype section in the enumeration mappings
Possible values are:
community-interest-company
private-fund-limited-partnership
|
Optional
|
|
items[].company_type
|
string |
The type of the company.
For enumeration descriptions see company_type section in the enumeration mappings
Possible values are:
private-unlimited
ltd
plc
old-public-company
private-limited-guarant-nsc-limited-exemption
limited-partnership
private-limited-guarant-nsc
converted-or-closed
private-unlimited-nsc
private-limited-shares-section-30-exemption
protected-cell-company
assurance-company
oversea-company
eeig
icvc-securities
icvc-warrant
icvc-umbrella
registered-society-non-jurisdictional
industrial-and-provident-society
northern-ireland
northern-ireland-other
royal-charter
investment-company-with-variable-capital
unregistered-company
llp
other
european-public-limited-liability-company-se
uk-establishment
scottish-partnership
charitable-incorporated-organisation
scottish-charitable-incorporated-organisation
further-education-or-sixth-form-college-corporation
registered-overseas-entity
|
|
|
items[].date_of_cessation
|
date |
The date that the company was dissolved
|
Optional
|
|
items[].date_of_creation
|
date |
The date that the company was incorporated
|
|
|
items[].kind
|
string |
The type of search result
Possible values are:
|
|
|
items[].links
|
object |
The link to the company
|
Optional
|
|
items[].links.company_profile
|
string |
The link to the company
|
Optional
|
|
items[].registered_office_address
|
object |
This will only appear if there are ROA details in the company record
|
Optional
|
|
items[].registered_office_address.address_line_1
|
string |
The first line of the address e.g Crown Way
|
Optional
|
|
items[].registered_office_address.address_line_2
|
string |
The second line of the address
|
Optional
|
|
items[].registered_office_address.country
|
string |
The country.
Possible values are:
Wales
England
Scotland
Great Britain
Not specified
United Kingdom
Northern Ireland
|
Optional
|
|
items[].registered_office_address.locality
|
string |
The town associated to the ROA e.g Cardiff
|
Optional
|
|
items[].registered_office_address.postal_code
|
string |
The postal code e.g CF14 3UZ
|
Optional
|
|
items[].registered_office_address.region
|
string |
The region e.g Surrey.
|
Optional
|
|
items[].sic_codes[]
|
array of string |
SIC codes for this company
|
Optional
|
|
kind
|
string |
Possible values are:
|
|
|
top_hit
|
object |
|
|
|
top_hit.company_name
|
string |
The company name associated with the company
|
|
|
top_hit.company_number
|
string |
The company number of the company
|
|
|
top_hit.company_status
|
string |
The status of the company.
For enumeration descriptions see company_status section in the enumeration mappings
Possible values are:
active
dissolved
open
closed
converted-closed
receivership
administration
liquidation
insolvency-proceedings
voluntary-arrangement
registered
removed
|
|
|
top_hit.company_subtype
|
string |
The subtype of the company.
For enumeration descriptions see company_subtype section in the enumeration mappings
Possible values are:
community-interest-company
private-fund-limited-partnership
|
Optional
|
|
top_hit.company_type
|
string |
The type of the company.
For enumeration descriptions see company_type section in the enumeration mappings
Possible values are:
private-unlimited
ltd
plc
old-public-company
private-limited-guarant-nsc-limited-exemption
limited-partnership
private-limited-guarant-nsc
converted-or-closed
private-unlimited-nsc
private-limited-shares-section-30-exemption
protected-cell-company
assurance-company
oversea-company
eeig
icvc-securities
icvc-warrant
icvc-umbrella
registered-society-non-jurisdictional
industrial-and-provident-society
northern-ireland
northern-ireland-other
royal-charter
investment-company-with-variable-capital
unregistered-company
llp
other
european-public-limited-liability-company-se
uk-establishment
scottish-partnership
charitable-incorporated-organisation
scottish-charitable-incorporated-organisation
further-education-or-sixth-form-college-corporation
registered-overseas-entity
|
|
|
top_hit.date_of_cessation
|
date |
The date that the company was dissolved
|
Optional
|
|
top_hit.date_of_creation
|
date |
The date that the company was incorporated
|
|
|
top_hit.kind
|
string |
The type of search result
Possible values are:
|
|
|
top_hit.links
|
object |
The link to the company
|
Optional
|
|
top_hit.links.company_profile
|
string |
The link to the company
|
Optional
|
|
top_hit.registered_office_address
|
object |
This will only appear if there are ROA details in the company record
|
Optional
|
|
top_hit.registered_office_address.address_line_1
|
string |
The first line of the address e.g Crown Way
|
Optional
|
|
top_hit.registered_office_address.address_line_2
|
string |
The second line of the address
|
Optional
|
|
top_hit.registered_office_address.country
|
string |
The country.
Possible values are:
Wales
England
Scotland
Great Britain
Not specified
United Kingdom
Northern Ireland
|
Optional
|
|
top_hit.registered_office_address.locality
|
string |
The town associated to the ROA e.g Cardiff
|
Optional
|
|
top_hit.registered_office_address.postal_code
|
string |
The postal code e.g CF14 3UZ
|
Optional
|
|
top_hit.registered_office_address.region
|
string |
The region e.g Surrey.
|
Optional
|
|
top_hit.sic_codes[]
|
array of string |
SIC codes for this company
|
Optional
|