Methods

  • get - PSC 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"
        },
        "ceased": "boolean",
        "ceased_on": "date",
        "country_of_residence": "string",
        "date_of_birth": {
            "day": "integer",
            "month": "integer",
            "year": "integer"
        },
        "description": "string",
        "etag": "string",
        "identification": {
            "country_registered": "string",
            "legal_authority": "string",
            "legal_form": "string",
            "place_registered": "string",
            "registration_number": "string"
        },
        "kind": "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"
    },
    "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 PSC resource data.

data.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.

data.address.address_line_1 string

The first line of the address.

data.address.address_line_2 string

The second line of the address.

Optional
data.address.care_of string

Care of name.

Optional
data.address.country string

The country. For example, UK.

Optional
data.address.locality string

The locality. For example London.

Optional
data.address.po_box string

The post-officer box number.

Optional
data.address.postal_code string

The postal code. For example CF14 3UZ.

data.address.premises string

The property name or number.

data.address.region string

The region. For example Surrey.

Optional
data.ceased boolean

Presence of that indicator means the super secure person status is ceased

Optional
data.ceased_on date

The date that Companies House was notified about the cessation of this person with significant control.

Optional
data.country_of_residence string

The country of residence of the person with significant control.

Optional
data.date_of_birth object

The date of birth of the person with significant control.

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.description string

Description of the super secure legal statement

Possible values are:

  • super-secure-persons-with-significant-control
Optional
data.etag string

The ETag of the resource.

data.identification object Optional
data.identification.country_registered string

The country or state the corporate entity with significant control is registered in.

Optional
data.identification.legal_authority string

The legal authority supervising the corporate entity or legal person with significant control.

data.identification.legal_form string

The legal form of the corporate entity or legal person with significant control as defined by its country of registration.

data.identification.place_registered string

The place the corporate entity with significant control is registered.

Optional
data.identification.registration_number string

The registration number of the corporate entity with significant control.

Optional
data.kind string

Possible values are:

  • individual-person-with-significant-control
  • corporate-entity-person-with-significant-control
  • legal-person-with-significant-control
  • super-secure-person-with-significant-control
Optional
data.links object

A set of URLs related to the resource, including self.

data.links.self string

The URL of the resource.

data.links.statement string

The URL of the statement linked to this person with significant control.

Optional
data.name string

Name of the person with significant control.

data.name_elements object

A document encapsulating the separate elements of a person with significant control's name.

Optional
data.name_elements.forename string

The forename of the person with significant control.

Optional
data.name_elements.other_forenames string

Other forenames of the person with significant control.

Optional
data.name_elements.surname string

The surname of the person with significant control.

data.name_elements.title string

Title of the person with significant control.

Optional
data.nationality string

The nationality of the person with significant control.

Optional
data.natures_of_control[] array of string

Indicates the nature of control the person with significant control holds. For enumeration descriptions see description section in the enumeration mappings file.

data.notified_on date

The date that Companies House was notified about this person with significant control.

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.