Streaming API: officersStream

Methods

get - Officers stream

Resource

{
    "data": {
        "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"
        },
        "appointed_before": "string",
        "appointed_on": "date",
        "contact_details": {
            "contact_name": "string"
        },
        "country_of_residence": "string",
        "date_of_birth": {
            "day": "integer",
            "month": "integer",
            "year": "integer"
        },
        "etag": "string",
        "former_names": [
            {
                "forenames": "string",
                "surname": "string"
            }
        ],
        "identification": {
            "identification_type": "string",
            "legal_authority": "string",
            "legal_form": "string",
            "place_registered": "string",
            "registration_number": "string"
        },
        "is_pre_1992_appointment": "boolean",
        "links": {
            "officer": {
                "appointments": "string"
            },
            "self": "string"
        },
        "name": "string",
        "nationality": "string",
        "occupation": "string",
        "officer_role": "string",
        "person_number": "string",
        "principal_office_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"
        },
        "resigned_on": "date",
        "responsibilities": "string"
    },
    "event": {
        "fields_changed": [
            "string"
        ],
        "published_at": "date-time",
        "timepoint": "integer",
        "type": "string"
    },
    "resource_id": "string",
    "resource_kind": "string",
    "resource_uri": "string"
}

Properties

Name	Type	Description	Additional
data	object	The company officer appointments resource data.
data.address	object	The correspondence address of the officer.	Optional
data.address.address_line_1	string	The first line of the address.	Optional
data.address.address_line_2	string	The second line of the address.	Optional
data.address.care_of	string	The care of name.	Optional
data.address.country	string	The country e.g. United Kingdom.	Optional
data.address.locality	string	The locality e.g. London.	Optional
data.address.po_box	string	The post-office box number.	Optional
data.address.postal_code	string	The postal code e.g. CF14 3UZ.	Optional
data.address.premises	string	The property name or number.	Optional
data.address.region	string	The region e.g. Surrey.	Optional
data.appointed_before	string	The date the officer was appointed before. Only present when the `is_pre_1992_appointment` attribute is `true`.	Optional
data.appointed_on	date	The date on which the officer was appointed. For the officer roles of `corporate-managing-officer` and `managing-officer` this is the date on which Companies House was notified about the officer.	Optional
data.contact_details	object	The contact at the `corporate-managing-officer` of a `registered-overseas-entity`.	Optional
data.contact_details.contact_name	string	The name of the contact.	Optional
data.country_of_residence	string	The officer's country of residence.	Optional
data.date_of_birth	object	Details of director date of birth.	Optional
data.date_of_birth.day	integer	The day of the date of birth.	Optional
data.date_of_birth.month	integer	The month of date of birth.
data.date_of_birth.year	integer	The year of date of birth.
data.etag	string	The Etag of the resource	Optional
data.former_names[]	array	Former names for the officer.	Optional
data.former_names[].forenames	string	Former forenames of the officer.	Optional
data.former_names[].surname	string	Former surnames of the officer.	Optional
data.identification	object	Only one from `eea`, `non-eea`, `uk-limited-company`, `other-corporate-body-or-firm` or `registered-overseas-entity-corporate-managing-officer` can be supplied, not multiples of them.	Optional
data.identification.identification_type	string	The officer's identity type Possible values are: `eea` `non-eea` `uk-limited-company` `other-corporate-body-or-firm` `registered-overseas-entity-corporate-managing-officer`	Optional
data.identification.legal_authority	string	The legal authority supervising the company.	Optional
data.identification.legal_form	string	The legal form of the company as defined by its country of registration.	Optional
data.identification.place_registered	string	Place registered.	Optional
data.identification.registration_number	string	Company registration number.	Optional
data.is_pre_1992_appointment	boolean	Indicator representing if the officer was appointed before their appointment date.	Optional
data.links	object	Links to other resources associated with this officer list item.
data.links.officer	object	Links to other officer resources associated with this officer list item.
data.links.officer.appointments	string	Link to the officer appointment resource that this appointment is associated with.
data.links.self	string	Link to this individual company officer appointment resource.
data.name	string	Corporate or natural officer name.
data.nationality	string	The officer's nationality.	Optional
data.occupation	string	The officer's job title.	Optional
data.officer_role	string	Possible values are: `cic-manager` `corporate-director` `corporate-llp-designated-member` `corporate-llp-member` `corporate-manager-of-an-eeig` `corporate-managing-officer` `corporate-member-of-a-management-organ` `corporate-member-of-a-supervisory-organ` `corporate-member-of-an-administrative-organ` `corporate-nominee-director` `corporate-nominee-secretary` `corporate-secretary` `director` `general-partner-in-a-limited-partnership` `judicial-factor` `limited-partner-in-a-limited-partnership` `llp-designated-member` `llp-member` `manager-of-an-eeig` `managing-officer` `member-of-a-management-organ` `member-of-a-supervisory-organ` `member-of-an-administrative-organ` `nominee-director` `nominee-secretary` `person-authorised-to-accept` `person-authorised-to-represent` `person-authorised-to-represent-and-accept` `receiver-and-manager` `secretary`
data.person_number	string	Unique person identifier as displayed in bulk products 195, 198, 208, 209 and 216.	Optional
data.principal_office_address	object	The principal/registered office address of a `corporate-managing-officer` of a `registered-overseas-entity`.	Optional
data.principal_office_address.address_line_1	string	The first line of the address.	Optional
data.principal_office_address.address_line_2	string	The second line of the address.	Optional
data.principal_office_address.care_of	string	The care of name.	Optional
data.principal_office_address.country	string	The country e.g. United Kingdom.	Optional
data.principal_office_address.locality	string	The locality e.g. London.	Optional
data.principal_office_address.po_box	string	The post-office box number.	Optional
data.principal_office_address.postal_code	string	The postal code e.g. CF14 3UZ.	Optional
data.principal_office_address.premises	string	The property name or number.	Optional
data.principal_office_address.region	string	The region e.g. Surrey.	Optional
data.resigned_on	date	The date the officer was resigned. For the officer roles of `corporate-managing-officer` and `managing-officer` this is the date on which Companies House was notified about the officers cessation.	Optional
data.responsibilities	string	The responsibilities of the managing officer of a `registered-overseas-entity`.	Optional
event	object	Link to the related resource	Read only.
event.fields_changed[]	array of string	Array of fields that have been changed by this event. Nested fields are referenced by dot notation e.g. `links.document_metadata`	Optional, read only.
event.published_at	date-time	The date and time the data notification was raised	Read only.
event.timepoint	integer	The point-in-time identifier for this stream document. Use to re-establish a connection to the stream at this point.	Read only.
event.type	string	The type of event denoted by this stream document. Possible values are: `changed` `deleted`	Read only.
resource_id	string	The ID of the resource.	Read only.
resource_kind	string	The type of resource contained within the stream document. Possible values are: `company-profile#company-profile` `filing-history#filing-history`	Read only.
resource_uri	string	The URI of the resource.	Read only.

officersStream resource

Methods

Resource

Properties