CompanySearch resource

Methods

• Search company - Search companies

Resource Representation

{
   "etag" : "string",
   "items" : [
      {
         "address" : {
            "address_line_1" : "string",
            "address_line_2" : "string",
            "care_of" : "string",
            "country" : "string",
            "locality" : "string",
            "po_box" : "string",
            "postal_code" : "string",
            "region" : "string"
         },
         "address_snippet" : "string",
         "company_number" : "string",
         "company_status" : "enum",
         "company_type" : "enum",
         "date_of_cessation" : "date",
         "date_of_creation" : "date",
         "description" : "string",
         "description_identifier" : [
            "integer"
         ],
         "external_registration_number" : "string",
         "kind" : "string",
         "links" : {
            "self" : "string"
         },
         "matches" : {
            "address_snippet" : [
               "integer"
            ],
            "snippet" : [
               "integer"
            ],
            "title" : [
               "integer"
            ]
         },
         "snippet" : "string",
         "title" : "string"
      }
   ],
   "items_per_page" : "integer",
   "kind" : "string",
   "start_index" : "integer",
   "total_results" : "integer"
}

Parameter Name	Type	Description	Additional
etag	string	The ETag of the resource.	Optional.
items[]	list	The results of the completed search.	Optional.
items[].address	object	The address of the company's registered office.
items[].address.address_line_1	string	The first line of the address.
items[].address.address_line_2	string	The second line of the address.	Optional.
items[].address.care_of	string	The care of name.	Optional.
items[].address.country	string	The country. Possible values are: Wales England Scotland Great Britain Not specified United Kingdom Northern Ireland	Optional.
items[].address.locality	string	The locality e.g London.	Optional.
items[].address.po_box	string	The post-office box number.	Optional.
items[].address.postal_code	string	The postal code e.g CF14 3UZ.	Optional.
items[].address.region	string	The region e.g Surrey.	Optional.
items[].address_snippet	string	A single line address. This will be the address that matched within the indexed document, or the primary address otherwise (as returned by the address member).
items[].company_number	string	The company registration / incorporation number of the company.
items[].company_status	enum	The company status. Possible values are: active dissolved liquidation receivership administration voluntary-arrangement converted-closed insolvency-proceedings
items[].company_type	enum	The company type. 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 industrial-and-provident-society northern-ireland northern-ireland-other llp royal-charter investment-company-with-variable-capital unregistered-company llp other european-public-limited-liability-company-se scottish-partnership charitable-incorporated-organisation scottish-charitable-incorporated-organisation further-education-or-sixth-form-college-corporation
items[].date_of_cessation	date	The date the company ended.	Optional.
items[].date_of_creation	date	The date the company was created.	Optional.
items[].description	string	The result description.	Optional.
items[].description_identifier	Array	An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations	Optional.
items[].external_registration_number	string	The number given by an external registration body.	Optional.
items[].kind	string	The type of search result. Possible values are: searchresult#company
items[].links	object	The URL of the search result.
items[].links.self	string	The URL of the resource being returned by the search item.
items[].matches	object	A list of members and arrays of character offset, defining substrings that matched the search terms.	Optional.
items[].matches.address_snippet	Array	An array of character offset into the address_snippet string. These always occur in pairs, and define the start and end of substrings in the member address_snippet that matched the search terms.	Optional.
items[].matches.snippet	Array	An array of character offset into the snippet string. These always occur in pairs, and define the start and end of substrings in the member snippet that matched the search terms. The first character of the string is index 1.	Optional.
items[].matches.title	Array	An array of character offset into the title string. These always occur in pairs, and define the start and end of substrings in the member title that matched the search terms. The first character of the string is index 1.	Optional.
items[].snippet	string	Summary information for the result, showing additional details that have matched. In the case of companies, this would be previous company names.	Optional.
items[].title	string	The title of the search result.
items_per_page	integer	The number of search items returned per page.	Optional.
kind	string	The type of search response returned. Possible values are: search#companies	Optional.
start_index	integer	The index into the entire result set that this result page starts.	Optional.
total_results	integer	The number of further search results available for the current search.	Optional.