list resource

Methods

  • list - List the company persons with significant control

Resource Representation

{
   "active_count" : "integer",
   "ceased_count" : "integer",
   "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",
            "premises" : "string",
            "region" : "string"
         },
         "ceased_on" : "date",
         "country_of_residence" : "string",
         "date_of_birth" : {
            "day" : "integer",
            "month" : "integer",
            "year" : "integer"
         },
         "etag" : "string",
         "links" : {
            "self" : "string",
            "statement" : "string"
         },
         "name" : "string",
         "name_elements" : {
            "forename" : "string",
            "other_forenames" : "string",
            "surname" : "string",
            "title" : "string"
         },
         "nationality" : "string",
         "natures_of_control" : [
            "string"
         ],
         "notified_on" : "date"
      }
   ],
   "items_per_page" : "integer",
   "kind" : "string",
   "links" : {
      "persons_with_significant_control_statements_list" : "string",
      "self" : "string"
   },
   "start_index" : "integer",
   "total_results" : "integer"
}
Parameter NameTypeDescriptionAdditional
active_count integer The number of active persons with significant control in this result set.
ceased_count integer The number of ceased persons with significant control in this result set.
etag string The ETag of the resource.
items[] list The list of persons with significant control.
items[].address object The service address of the person with significant control. If given, this address will be shown on the public record instead of the residential address.
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 Care of name. Optional.
items[].address.country string The country. For example, UK. Optional.
items[].address.locality string The locality. For example London. Optional.
items[].address.po_box string The post-officer box number. Optional.
items[].address.postal_code string The postal code. For example CF14 3UZ.
items[].address.premises string The property name or number.
items[].address.region string The region. For example Surrey. Optional.
items[].ceased_on date The date that Companies House was notified about the cessation of this person with significant control. Optional.
items[].country_of_residence string The country of residence of the person with significant control. Optional.
items[].date_of_birth object The date of birth of the person with significant control. Optional. The day field will only be returned when properly authenticated.
items[].date_of_birth.day integer The day of the date of birth. Optional.
items[].date_of_birth.month integer The month of date of birth.
items[].date_of_birth.year integer The year of date of birth.
items[].etag string The ETag of the resource.
items[].links object A set of URLs related to the resource, including self.
items[].links.self string The URL of the resource.
items[].links.statement string The URL of the statement linked to this person with significant control. Optional.
items[].name string Name of the person with significant control.
items[].name_elements object A document encapsulating the seperate elements of a person with significant control's name. Optional. Mandatory for an individual person with significant control.
items[].name_elements.forename string The forename of the person with significant control. Optional.
items[].name_elements.other_forenames string Other forenames of the person with significant control. Optional.
items[].name_elements.surname string The surname of the person with significant control.
items[].name_elements.title string Title of the person with significant control. Optional.
items[].nationality string The nationality of the person with significant control. Optional.
items[].natures_of_control Array Indicates the nature of control the person with significant control holds.

For enumeration descriptions see description section in the enumeration mappings file.
items[].notified_on date The date that Companies House was notified about this person with significant control.
items_per_page integer The number of persons with significant control to return per page.
kind string Possible values are:
  • persons-with-significant-control#list
links object A set of URLs related to the resource, including self.
links.persons_with_significant_control_statements_list string The URL of the persons with significant control statements list resource. Optional.
links.self string The URL of the resource.
start_index integer The offset into the entire result set that this page starts.
total_results integer The total number of persons with significant control in this result set.