Developer API Suite

companyProfileStream resource

Methods

  • get - Basic company information stream

Resource

{
    "data": {
        "accounts": {
            "accounting_reference_date": {
                "day": "integer",
                "month": "integer"
            },
            "last_accounts": {
                "made_up_to": "date",
                "period_end_on": "date",
                "period_start_on": "date",
                "type": {}
            },
            "next_accounts": {
                "due_on": "date",
                "overdue": "boolean",
                "period_end_on": "date",
                "period_start_on": "date"
            },
            "next_due": "date",
            "next_made_up_to": "date",
            "overdue": "boolean"
        },
        "annual_return": {
            "last_made_up_to": "date",
            "next_due": "date",
            "next_made_up_to": "date",
            "overdue": "boolean"
        },
        "branch_company_details": {
            "business_activity": "string",
            "parent_company_name": "string",
            "parent_company_number": "string"
        },
        "can_file": "boolean",
        "company_name": "string",
        "company_number": "string",
        "company_status": "string",
        "company_status_detail": "string",
        "confirmation_statement": {
            "last_made_up_to": "date",
            "next_due": "date",
            "next_made_up_to": "date",
            "overdue": "boolean"
        },
        "corporate_annotation": [
            {
                "created_on": "date",
                "description": "string",
                "type": "string"
            }
        ],
        "date_of_cessation": "date",
        "date_of_creation": "date",
        "etag": "string",
        "external_registration_number": "string",
        "foreign_company_details": {
            "accounting_requirement": {
                "foreign_account_type": "string",
                "terms_of_account_publication": "string"
            },
            "accounts": {
                "account_period_from:": {
                    "day": "integer",
                    "month": "integer"
                },
                "account_period_to": {
                    "day": "integer",
                    "month": "integer"
                },
                "must_file_within": {
                    "months": "integer"
                }
            },
            "business_activity": "string",
            "company_type": "string",
            "governed_by": "string",
            "is_a_credit_finance_institution": "boolean",
            "originating_registry": {
                "country": "string",
                "name": "string"
            },
            "registration_number": "string"
        },
        "has_been_liquidated": "boolean",
        "has_charges": "boolean",
        "has_insolvency_history": "boolean",
        "is_community_interest_company": "boolean",
        "jurisdiction": "string",
        "last_full_members_list_date": "date",
        "links": {
            "charges": "string",
            "exemptions": "string",
            "filing_history": "string",
            "insolvency": "string",
            "officers": "string",
            "overseas": "string",
            "persons_with_significant_control": "string",
            "persons_with_significant_control_statements": "string",
            "registers": "string",
            "self": "string",
            "uk-establishments": "string"
        },
        "partial_data_available": "string",
        "previous_company_names": [
            {
                "ceased_on": "date",
                "effective_from": "date",
                "name": "string"
            }
        ],
        "registered_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"
        },
        "registered_office_is_in_dispute": "boolean",
        "service_address": {
            "address_line_1": "string",
            "address_line_2": "string",
            "care_of": "string",
            "country": "string",
            "locality": "string",
            "po_box": "string",
            "postal_code": "string",
            "region": "string"
        },
        "sic_codes": [
            "string"
        ],
        "subtype": "string",
        "super_secure_managing_officer_count": "integer",
        "type": "string",
        "undeliverable_registered_office_address": "boolean"
    },
    "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 profile resource data. May be absent for 'deleted' event types.

 Optional
data.accounts object

Company accounts information.

 Optional
data.accounts.accounting_reference_date object

The Accounting Reference Date (ARD) of the company.
data.accounts.accounting_reference_date.day integer

The Accounting Reference Date (ARD) day.
data.accounts.accounting_reference_date.month integer

The Accounting Reference Date (ARD) month.
data.accounts.last_accounts object

The last company accounts filed.

 Optional
data.accounts.last_accounts.made_up_to date

Deprecated. Please use accounts.last_accounts.period_end_on
data.accounts.last_accounts.period_end_on date

The last day of the most recently filed accounting period.

 Optional
data.accounts.last_accounts.period_start_on date

The first day of the most recently filed accounting period.

 Optional
data.accounts.last_accounts.type object

The type of the last company accounts filed.
For enumeration descriptions see account_type section in the enumeration mappings.

Possible values are:

  • null
  • full
  • small
  • medium
  • group
  • dormant
  • interim
  • initial
  • total-exemption-full
  • total-exemption-small
  • partial-exemption
  • audit-exemption-subsidiary
  • filing-exemption-subsidiary
  • micro-entity
  • no-accounts-type-available
  • audited-abridged
  • unaudited-abridged
data.accounts.next_accounts object

The next company accounts filed.

 Optional
data.accounts.next_accounts.due_on date

The date the next company accounts are due

 Optional
data.accounts.next_accounts.overdue boolean

Flag indicating if the company accounts are overdue.

 Optional
data.accounts.next_accounts.period_end_on date

The last day of the next accounting period to be filed.

 Optional
data.accounts.next_accounts.period_start_on date

The first day of the next accounting period to be filed.

 Optional
data.accounts.next_due date

Deprecated. Please use accounts.next_accounts.due_on

 Optional
data.accounts.next_made_up_to date

Deprecated. Please use accounts.next_accounts.period_end_on
data.accounts.overdue boolean

Deprecated. Please use accounts.next_accounts.overdue
data.annual_return object

Annual return information. This member is only returned if a confirmation statement has not be filed.

 Optional
data.annual_return.last_made_up_to date

The date the last annual return was made up to.

 Optional
data.annual_return.next_due date

The date the next annual return is due. This member will only be returned if a confirmation statement has not been filed and the date is before 28th July 2016, otherwise refer to confirmation_statement.next_due

 Optional
data.annual_return.next_made_up_to date

The date the next annual return should be made up to. This member will only be returned if a confirmation statement has not been filed and the date is before 30th July 2016, otherwise refer to confirmation_statement.next_made_up_to

 Optional
data.annual_return.overdue boolean

Flag indicating if the annual return is overdue.

 Optional
data.branch_company_details object

UK branch of a foreign company.

 Optional
data.branch_company_details.business_activity string

Type of business undertaken by the UK establishment.

 Optional
data.branch_company_details.parent_company_name string

Parent company name.

 Optional
data.branch_company_details.parent_company_number string

Parent company number.

 Optional
data.can_file boolean

Flag indicating whether this company can file.
data.company_name string

The name of the company.
data.company_number string

The number of the company.
data.company_status string

The status of the company.
For enumeration descriptions see company_status section in the enumeration mappings

Possible values are:

  • active
  • dissolved
  • liquidation
  • receivership
  • administration
  • voluntary-arrangement
  • converted-closed
  • insolvency-proceedings
  • registered
  • removed
  • closed
  • open
 Optional
data.company_status_detail string

Extra details about the status of the company.
For enumeration descriptions see company_status_detail section in the enumeration mappings.

Possible values are:

  • transferred-from-uk
  • active-proposal-to-strike-off
  • petition-to-restore-dissolved
  • transformed-to-se
  • converted-to-plc
 Optional
data.confirmation_statement object

Confirmation statement information (N.B. refers to the Annual Statement where type is registered-overseas-entity)

 Optional
data.confirmation_statement.last_made_up_to date

The date to which the company last made a confirmation statement.

 Optional
data.confirmation_statement.next_due date

The date by which the next confimation statement must be received.
data.confirmation_statement.next_made_up_to date

The date to which the company must next make a confirmation statement.
data.confirmation_statement.overdue boolean

Flag indicating if the confirmation statement is overdue

 Optional
data.corporate_annotation[] array

A corporate level message published by Companies House about a company, or situations affecting the company, or its information.

 Optional
data.corporate_annotation[].created_on date

The date on which the corporate annotation was created.
data.corporate_annotation[].description string

The details of a corporate annotation which has a corporate_annotation.type of “other”.

 Optional
data.corporate_annotation[].type string

The type of corporate annotation.
For enumeration descriptions see corporate_annotation_type section in the enumeration mappings.
data.date_of_cessation date

The date which the company was converted/closed, dissolved or removed. Please refer to company status to determine which.

 Optional
data.date_of_creation date

The date when the company was created.

 Optional
data.etag string

The ETag of the resource.

 Optional
data.external_registration_number string

The number given by an external registration body.

 Optional
data.foreign_company_details object

Foreign company details.

 Optional
data.foreign_company_details.accounting_requirement object

Accounts requirement.

 Optional
data.foreign_company_details.accounting_requirement.foreign_account_type string

Type of accounting requirement that applies.
For enumeration descriptions see foreign_account_type section in the enumeration mappings.

Possible values are:

  • accounting-requirements-of-originating-country-apply
  • accounting-requirements-of-originating-country-do-not-apply
 Optional
data.foreign_company_details.accounting_requirement.terms_of_account_publication string

Describes how the publication date is derived.
For enumeration descriptions see terms_of_account_publication section in the enumeration mappings.

Possible values are:

  • accounts-publication-date-supplied-by-company
  • accounting-publication-date-does-not-need-to-be-supplied-by-company
  • accounting-reference-date-allocated-by-companies-house
 Optional
data.foreign_company_details.accounts object

Foreign company account information.

 Optional
data.foreign_company_details.accounts.account_period_from: object

Date account period starts under parent law.

 Optional
data.foreign_company_details.accounts.account_period_from:.day integer

Day on which accounting period starts under parent law.

 Optional
data.foreign_company_details.accounts.account_period_from:.month integer

Month in which accounting period starts under parent law.

 Optional
data.foreign_company_details.accounts.account_period_to object

Date account period ends under parent law.

 Optional
data.foreign_company_details.accounts.account_period_to.day integer

Day on which accounting period ends under parent law.

 Optional
data.foreign_company_details.accounts.account_period_to.month integer

Month in which accounting period ends under parent law.

 Optional
data.foreign_company_details.accounts.must_file_within object

Time allowed from period end for disclosure of accounts under parent law.

 Optional
data.foreign_company_details.accounts.must_file_within.months integer

Number of months within which to file.

 Optional
data.foreign_company_details.business_activity string

Type of business undertaken by the company.

 Optional
data.foreign_company_details.company_type string

Legal form of the company in the country of incorporation.

 Optional
data.foreign_company_details.governed_by string

Law governing the company in country of incorporation.

 Optional
data.foreign_company_details.is_a_credit_finance_institution boolean

Is it a financial or credit institution.

 Optional
data.foreign_company_details.originating_registry object

Company origin informations

 Optional
data.foreign_company_details.originating_registry.country string

Country in which company was incorporated.

 Optional
data.foreign_company_details.originating_registry.name string

Identity of register in country of incorporation.

 Optional
data.foreign_company_details.registration_number string

Registration number in company of incorporation.

 Optional
data.has_been_liquidated boolean

Deprecated. Please use links.insolvency

 Optional
data.has_charges boolean

Deprecated. Please use links.charges

 Optional
data.has_insolvency_history boolean

Deprecated. Please use links.insolvency

 Optional
data.is_community_interest_company boolean

Deprecated. Please use subtype

 Optional
data.jurisdiction string

The jurisdiction specifies the political body responsible for the company.

Possible values are:

  • england-wales
  • wales
  • scotland
  • northern-ireland
  • european-union
  • united-kingdom
  • england
  • noneu
 Optional
data.last_full_members_list_date date

The date of last full members list update.

 Optional
data.links object

A set of URLs related to the resource, including self.
data.links.charges string

The URL of the company's charges list resource.

 Optional
data.links.exemptions string

The URL of the company's exemptions list resource.

 Optional
data.links.filing_history string

The URL of the company's filing history list resource.

 Optional
data.links.insolvency string

The URL of the company's insolvency list resource.

 Optional
data.links.officers string

The URL of the company's officer list resource.

 Optional
data.links.overseas string

The URL of the overseas details resource for this company.

 Optional
data.links.persons_with_significant_control string

The URL of the persons with significant control list resource.

 Optional
data.links.persons_with_significant_control_statements string

The URL of the persons with significant control statements list resource.

 Optional
data.links.registers string

The URL of the registers resource for this company

 Optional
data.links.self string

The URL of the resource.
data.links.uk-establishments string

The URL of the uk establishments list resource for this company.

 Optional
data.partial_data_available string

Returned if Companies House is not the primary source of data for this company. For enumeration descriptions see partial_data_available section in the enumeration mappings (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml).

Possible values are:

  • full-data-available-from-financial-conduct-authority
  • full-data-available-from-department-of-the-economy
  • full-data-available-from-the-company
 Optional
data.previous_company_names[] array

The previous names of this company.

 Optional
data.previous_company_names[].ceased_on date

The date on which the company name ceased.
data.previous_company_names[].effective_from date

The date from which the company name was effective.
data.previous_company_names[].name string

The previous company name
data.registered_office_address object

The address of the company's registered office.

 Optional
data.registered_office_address.address_line_1 string

The first line of the address.

 Optional
data.registered_office_address.address_line_2 string

The second line of the address.

 Optional
data.registered_office_address.care_of string

The care of name.

 Optional
data.registered_office_address.country string

The country.

Possible values are:

  • Wales
  • England
  • Scotland
  • Great Britain
  • Not specified
  • United Kingdom
  • Northern Ireland
 Optional
data.registered_office_address.locality string

The locality e.g London.

 Optional
data.registered_office_address.po_box string

The post-office box number.

 Optional
data.registered_office_address.postal_code string

The postal code e.g CF14 3UZ.

 Optional
data.registered_office_address.premises string

The property name or number.

 Optional
data.registered_office_address.region string

The region e.g Surrey.

 Optional
data.registered_office_is_in_dispute boolean

Flag indicating registered office address as been replaced.

 Optional
data.service_address object

The correspondence address of a Registered overseas entity

 Optional
data.service_address.address_line_1 string

The first line of the address.

 Optional
data.service_address.address_line_2 string

The second line of the address.

 Optional
data.service_address.care_of string

The care of name.

 Optional
data.service_address.country string

The country e.g. United Kingdom.

 Optional
data.service_address.locality string

The locality e.g London.

 Optional
data.service_address.po_box string

The post-office box number.

 Optional
data.service_address.postal_code string

The postal code e.g CF14 3UZ.

 Optional
data.service_address.region string

The region e.g Surrey.

 Optional
data.sic_codes[] array of string

SIC codes for this company.

 Optional
data.subtype string

The subtype of the company. Possible values are:

Possible values are:

  • community-interest-company
  • private-fund-limited-partnership
 Optional
data.super_secure_managing_officer_count integer

The total count of super secure managing officers for a registered-overseas-entity.

 Optional
data.type string

The type of the company.
For enumeration descriptions see company_type section in the enumeration mappings

Possible values are:

  • private-unlimited
  • ltd
  • plc
  • old-public-company
  • private-limited-guarant-nsc-limited-exemption
  • limited-partnership
  • private-limited-guarant-nsc
  • converted-or-closed
  • private-unlimited-nsc
  • private-limited-shares-section-30-exemption
  • protected-cell-company
  • assurance-company
  • oversea-company
  • eeig
  • icvc-securities
  • icvc-warrant
  • icvc-umbrella
  • registered-society-non-jurisdictional
  • industrial-and-provident-society
  • northern-ireland
  • northern-ireland-other
  • royal-charter
  • investment-company-with-variable-capital
  • unregistered-company
  • llp
  • other
  • european-public-limited-liability-company-se
  • uk-establishment
  • scottish-partnership
  • charitable-incorporated-organisation
  • scottish-charitable-incorporated-organisation
  • further-education-or-sixth-form-college-corporation
  • registered-overseas-entity
data.undeliverable_registered_office_address boolean

Flag indicating whether post can be delivered to the registered office.

 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.
Built by Companies House