Streaming API: pscStatementsStream

Methods

get - PSC statements stream

Resource

{
    "data": {
        "ceased_on": "date",
        "etag": "string",
        "kind": "string",
        "linked_psc_name": "string",
        "links": {
            "person_with_significant_control": "string",
            "self": "string"
        },
        "notified_on": "date",
        "restrictions_notice_withdrawal_reason": "string",
        "statement": "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 PSC statements resource data.
data.ceased_on	date	The date that Companies House was notified about the cessation of this person with significant control.	Optional
data.etag	string	The ETag of the resource.
data.kind	string	Possible values are: `persons-with-significant-control-statement`
data.linked_psc_name	string	The name of the psc linked to this statement.	Optional
data.links	object	A set of URLs related to the resource, including self.
data.links.person_with_significant_control	string	The URL of the person with significant control linked to this statement.	Optional
data.links.self	string	The URL of the resource.
data.notified_on	date	The date that the person with significant control statement was processed by Companies House.
data.restrictions_notice_withdrawal_reason	string	The reason for the company withdrawing a `restrictions-notice-issued-to-psc` statement Possible values are: `restrictions-notice-withdrawn-by-court-order` `restrictions-notice-withdrawn-by-company` `restrictions-notice-withdrawn-by-lp` `restrictions-notice-withdrawn-by-court-order-lp` `restrictions-notice-withdrawn-by-partnership` `restrictions-notice-withdrawn-by-court-order-p`	Optional
data.statement	string	Indicates the type of statement filed. For enumeration descriptions see `statement_description` section in the enumeration mappings file. Possible values are: `no-individual-or-entity-with-signficant-control` `steps-to-find-psc-not-yet-completed` `psc-exists-but-not-identified` `psc-details-not-confirmed` `psc-contacted-but-no-response` `restrictions-notice-issued-to-psc` `psc-has-failed-to-confirm-changed-details` `no-individual-or-entity-with-signficant-control-partnership` `psc-exists-but-not-identified-partnership` `psc-details-not-confirmed-partnership` `steps-to-find-psc-not-yet-completed-partnership` `psc-contacted-but-no-response-partnership` `psc-has-failed-to-confirm-changed-details-partnership` `restrictions-notice-issued-to-psc-partnership` `all-beneficial-owners-identified` `no-beneficial-owner-identified` `at-least-one-beneficial-owner-unidentified` `information-not-provided-for-at-least-one-beneficial-owner` `at-least-one-beneficial-owner-unidentified-and-information-not-provided-for-at-least-one-beneficial-owner`
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.

pscStatementsStream resource

Methods

Resource

Properties