Streaming API: disqualifiedOfficersStream

Methods

get - Disqualified officers stream

Resource

{
    "data": {
        "company_number": "string",
        "country_of_registration": "string",
        "date_of_birth": "date",
        "disqualifications": [
            {
                "address": {
                    "address_line_1": "string",
                    "address_line_2": "string",
                    "country": "string",
                    "locality": "string",
                    "postal_code": "string",
                    "premises": "string",
                    "region": "string"
                },
                "case_identifier": "string",
                "company_names": [
                    "string"
                ],
                "court_name": "string",
                "disqualification_type": "string",
                "disqualified_from": "date",
                "disqualified_until": "date",
                "heard_on": "date",
                "last_variation": [
                    {
                        "case_identifier": "string",
                        "court_name": "string",
                        "varied_on": "date"
                    }
                ],
                "reason": {
                    "act": "string",
                    "article": "string",
                    "description_identifier": "string",
                    "section": "string"
                },
                "undertaken_on": "date"
            }
        ],
        "etag": "string",
        "forename": "string",
        "honours": "string",
        "kind": "string",
        "links": {
            "self": "string"
        },
        "name": "string",
        "nationality": "string",
        "other_forenames": "string",
        "permissions_to_act": [
            {
                "company_names": [
                    "string"
                ],
                "court_name": "string",
                "expires_on": "date",
                "granted_on": "date"
            }
        ],
        "person_number": "string",
        "surname": "string",
        "title": "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 disqualified officers resource data. May be absent for 'deleted' event types.	Optional
data.company_number	string	The registration number of the corporate disqualified officer.	Optional
data.country_of_registration	string	The country in which the corporate disqualified officer was registered.	Optional
data.date_of_birth	date	The disqualified officer's date of birth.	Optional
data.disqualifications[]	array	The officer's disqualifications.
data.disqualifications[].address	object	The address of the disqualified officer as provided by the disqualifying authority.
data.disqualifications[].address.address_line_1	string	The first line of the address.	Optional
data.disqualifications[].address.address_line_2	string	The second line of the address.	Optional
data.disqualifications[].address.country	string	The country. For example, UK.	Optional
data.disqualifications[].address.locality	string	The locality. For example London.	Optional
data.disqualifications[].address.postal_code	string	The postal code. For example CF14 3UZ.	Optional
data.disqualifications[].address.premises	string	The property name or number.	Optional
data.disqualifications[].address.region	string	The region. For example Surrey.	Optional
data.disqualifications[].case_identifier	string	The case identifier of the disqualification.	Optional
data.disqualifications[].company_names[]	array of string	The companies in which the misconduct took place.	Optional
data.disqualifications[].court_name	string	The name of the court that handled the disqualification case.	Optional
data.disqualifications[].disqualification_type	string	An enumeration type that provides the disqualifying authority that handled the disqualification case. For enumeration descriptions see `disqualification_type` section in the enumeration mappings
data.disqualifications[].disqualified_from	date	The date that the disqualification starts.
data.disqualifications[].disqualified_until	date	The date that the disqualification ends.
data.disqualifications[].heard_on	date	The date the disqualification hearing was on.	Optional
data.disqualifications[].last_variation[]	array	The latest variation made to the disqualification.	Optional
data.disqualifications[].last_variation[].case_identifier	string	The case identifier of the variation.	Optional
data.disqualifications[].last_variation[].court_name	string	The name of the court that handled the variation case.	Optional
data.disqualifications[].last_variation[].varied_on	date	The date the variation was made against the disqualification.	Optional
data.disqualifications[].reason	object	The reason for the disqualification.
data.disqualifications[].reason.act	string	An enumeration type that provides the law under which the disqualification was made. For enumeration descriptions see `act` section in the enumeration mappings
data.disqualifications[].reason.article	string	The article of the act under which the disqualification was made. Only applicable if `reason.act` is `company-directors-disqualification-northern-ireland-order-2002`.	Optional
data.disqualifications[].reason.description_identifier	string	An enumeration type that provides the description for the reason of disqualification. For enumeration descriptions see `description_identifier` section in the enumeration mappings
data.disqualifications[].reason.section	string	The section of the act under which the disqualification was made. Only applicable if `reason.act` is `company-directors-disqualification-act-1986` or `sanctions-anti-money-laundering-act-2018`.	Optional
data.disqualifications[].undertaken_on	date	The date the disqualification undertaking was agreed on.	Optional
data.etag	string	The ETag of the resource.
data.forename	string	The forename of the disqualified officer.	Optional
data.honours	string	The honours that the disqualified officer has.	Optional
data.kind	string	Possible values are: `corporate-disqualification` `natural-disqualification`
data.links	object	Links to other resources associated with this officer disqualification resource.
data.links.self	string	Link to this disqualification resource.
data.name	string	The name of the corporate disqualified officer.	Optional
data.nationality	string	The nationality of the disqualified officer.	Optional
data.other_forenames	string	The other forenames of the disqualified officer.	Optional
data.permissions_to_act[]	array	Permissions that the disqualified officer has to act outside of their disqualification.	Optional
data.permissions_to_act[].company_names[]	array of string	The companies for which the disqualified officer has permission to act.	Optional
data.permissions_to_act[].court_name	string	The name of the court that granted the permission to act.	Optional
data.permissions_to_act[].expires_on	date	The date that the permission ends.
data.permissions_to_act[].granted_on	date	The date that the permission starts.
data.person_number	string	The disqualified officer's person number.	Optional
data.surname	string	The surname of the disqualified officer.	Optional
data.title	string	The title of the disqualified officer.	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 in the format of `yyyy-MM-dd'T'HH:mm:ss` for example: `2024-09-04T10:52:22`	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.

disqualifiedOfficersStream resource

Methods

Resource

Properties