Skip to content

Instantly share code, notes, and snippets.

@Mearman

Mearman/companies-house.spec.json

Created January 12, 2025 16:54
Show Gist options
  • Save Mearman/8870e2ca21bbc6918f6917dd549d0c33 to your computer and use it in GitHub Desktop.
Save Mearman/8870e2ca21bbc6918f6917dd549d0c33 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
companies-house.spec.json
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Companies House Public Data API",
"description": "An API suite providing read only access to search and retrieve public company data"
},
"host": "api.company-information.service.gov.uk",
"schemes": [
"https",
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"api_key": []
}
],
"tags": [
{
"name": "registeredOfficeAddress",
"description": "Registered office address"
},
{
"name": "companyProfile",
"description": "Company profile"
},
{
"name": "search",
"description": "Search"
},
{
"name": "officers",
"description": "Officers"
},
{
"name": "registers",
"description": "Registers"
},
{
"name": "charges",
"description": "Charges"
},
{
"name": "filingHistory",
"description": "Filing history"
},
{
"name": "insolvency",
"description": "Insolvency"
},
{
"name": "exemptions",
"description": "Exemptions"
},
{
"name": "officerDisqualifications",
"description": "Officer disqualifications"
},
{
"name": "officerAppointments",
"description": "Officer appointments"
},
{
"name": "UKEstablishments",
"description": "UK Establishments"
},
{
"name": "personsWithSignificantControl",
"description": "Persons with significant control"
},
{
"name": "pscDiscrepancies",
"description": "PSC discrepancies"
}
],
"paths": {
"/company/{companyNumber}/registered-office-address": {
"get": {
"summary": "Registered Office Address",
"description": "Get the current address of a company",
"paramenpters": [
{
"name": "company_number",
"in": "path",
"description": "Company number for registered office address",
"required": true,
"type": "string"
}
],
"tags": [
"registeredOfficeAddress"
],
"security": [
{
"oauth2": [
"https://identity.company-information.service.gov.uk/user/profile.read",
"https://api.company-information.service.gov.uk/company/{company_number}/registered-office-address.update"
]
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/registeredOfficeAddress"
}
},
"401": {
"description": "Not authorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{companyNumber}": {
"get": {
"summary": "Company profile",
"description": "Get the basic company information",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the basic information to return.",
"required": true,
"type": "string"
}
],
"tags": [
"companyProfile"
],
"responses": {
"200": {
"description": "readCompanyProfile",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/companyProfile"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
},
"definitions": {
"accountingReferenceDate": {
"title": "accountingReferenceDate",
"type": "object",
"required": [
"day",
"month"
],
"properties": {
"day": {
"type": "integer",
"description": "The Accounting Reference Date (ARD) day."
},
"month": {
"type": "integer",
"description": "The Accounting Reference Date (ARD) month."
}
}
},
"accountsInformation": {
"title": "accountsInformation",
"type": "object",
"required": [
"overdue",
"next_made_up_to",
"accounting_reference_date"
],
"properties": {
"accounting_reference_date": {
"description": "The Accounting Reference Date (ARD) of the company.",
"type": "object",
"items": {
"$ref": "#/definitions/accountingReferenceDate"
}
},
"last_accounts": {
"description": "The last company accounts filed.",
"type": "object",
"items": {
"$ref": "#/definitions/lastAccounts"
}
},
"next_due": {
"description": "Deprecated. Please use accounts.next_accounts.due_on",
"type": "string",
"format": "date"
},
"next_made_up_to": {
"description": "Deprecated. Please use accounts.next_accounts.period_end_on",
"type": "string",
"format": "date"
},
"overdue": {
"type": "boolean",
"description": "Deprecated. Please use accounts.next_accounts.overdue"
},
"next_accounts": {
"description": "The next company accounts filed.",
"type": "object",
"items": {
"$ref": "#/definitions/nextAccounts"
}
}
}
},
"annualReturnInformation": {
"title": "annualReturnInformation",
"type": "object",
"properties": {
"last_made_up_to": {
"description": "The date the last annual return was made up to.",
"type": "string",
"format": "date"
},
"next_due": {
"description": "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`",
"type": "string",
"format": "date"
},
"next_made_up_to": {
"description": "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`",
"type": "string",
"format": "date"
},
"overdue": {
"description": "Flag indicating if the annual return is overdue.",
"type": "boolean"
}
}
},
"confirmationOfStatementInformation": {
"title": "confirmationOfStatementInformation",
"required": [
"next_made_up_to",
"next_due"
],
"properties": {
"last_made_up_to": {
"description": "The date to which the company last made a confirmation statement.",
"type": "string",
"format": "date"
},
"next_due": {
"description": "The date by which the next confimation statement must be received.",
"type": "string",
"format": "date"
},
"next_made_up_to": {
"description": "The date to which the company must next make a confirmation statement.",
"type": "string",
"format": "date"
},
"overdue": {
"description": "Flag indicating if the confirmation statement is overdue",
"type": "boolean"
}
}
},
"companyProfile": {
"title": "companyProfile",
"required": [
"company_name",
"company_number",
"type",
"can_file",
"links"
],
"properties": {
"accounts": {
"description": "Company accounts information.",
"items": {
"$ref": "#/definitions/accountsInformation"
},
"type": "object"
},
"annual_return": {
"description": "Annual return information. This member is only returned if a confirmation statement has not be filed.",
"items": {
"$ref": "#/definitions/annualReturnInformation"
},
"type": "object"
},
"can_file": {
"description": "Flag indicating whether this company can file.",
"type": "boolean"
},
"confirmation_statement": {
"description": "Confirmation statement information (N.B. refers to the Annual Statement where type is registered-overseas-entity)",
"items": {
"$ref": "#/definitions/confirmationOfStatementInformation"
},
"type": "object"
},
"company_name": {
"description": "The name of the company.",
"type": "string"
},
"jurisdiction": {
"description": "The jurisdiction specifies the political body responsible for the company.",
"type": "string",
"enum": [
"england-wales",
"wales",
"scotland",
"northern-ireland",
"european-union",
"united-kingdom",
"england",
"noneu"
]
},
"company_number": {
"description": "The number of the company.",
"type": "string"
},
"date_of_creation": {
"description": "The date when the company was created.",
"type": "string",
"format": "date"
},
"date_of_cessation": {
"description": "The date which the company was converted/closed, dissolved or removed. Please refer to company status to determine which.",
"type": "string",
"format": "date"
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"has_been_liquidated": {
"description": "Deprecated. Please use links.insolvency",
"type": "boolean"
},
"has_charges": {
"description": "Deprecated. Please use links.charges",
"type": "boolean"
},
"is_community_interest_company": {
"description": "Deprecated. Please use subtype",
"type": "boolean"
},
"subtype": {
"description": "The subtype of the company. Possible values are:",
"enum": [
"community-interest-company",
"private-fund-limited-partnership"
],
"type": "string"
},
"partial_data_available": {
"description": "Returned if Companies House is not the primary source of data for this company.\nFor enumeration descriptions see partial_data_available section in the enumeration mappings (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml).",
"enum": [
"full-data-available-from-financial-conduct-authority",
"full-data-available-from-department-of-the-economy",
"full-data-available-from-the-company"
],
"type": "string"
},
"external_registration_number": {
"description": "The number given by an external registration body.",
"type": "string"
},
"foreign_company_details": {
"description": "Foreign company details.",
"items": {
"$ref": "#/definitions/foreignCompanyDetails"
},
"type": "object"
},
"last_full_members_list_date": {
"description": "The date of last full members list update.",
"type": "string",
"format": "date"
},
"registered_office_address": {
"description": "The address of the company's registered office.",
"items": {
"$ref": "#/definitions/definitions-registeredOfficeAddress"
},
"type": "object"
},
"service_address": {
"description": "The correspondence address of a Registered overseas entity",
"items": {
"$ref": "#/definitions/serviceAddress"
},
"type": "object"
},
"super_secure_managing_officer_count": {
"description": "The total count of super secure managing officers for a `registered-overseas-entity`.",
"type": "integer"
},
"sic_codes": {
"description": "SIC codes for this company.",
"type": "array",
"items": {
"type": "string"
}
},
"previous_company_names": {
"description": "The previous names of this company.",
"items": {
"$ref": "#/definitions/previousCompanyNames"
},
"type": "array"
},
"corporate_annotation": {
"description": "A corporate level message published by Companies House about a company, or situations affecting the company, or its information.",
"items": {
"$ref": "#/definitions/corporateAnnotation"
},
"type": "array"
},
"company_status": {
"description": "The status of the company. \n For enumeration descriptions see `company_status` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml) ",
"type": "string",
"enum": [
"active",
"dissolved",
"liquidation",
"receivership",
"administration",
"voluntary-arrangement",
"converted-closed",
"insolvency-proceedings",
"registered",
"removed",
"closed",
"open"
]
},
"company_status_detail": {
"description": "Extra details about the status of the company. \n For enumeration descriptions see `company_status_detail` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"transferred-from-uk",
"active-proposal-to-strike-off",
"petition-to-restore-dissolved",
"transformed-to-se",
"converted-to-plc"
],
"type": "string"
},
"type": {
"description": "The type of the company. \n For enumeration descriptions see `company_type` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml) ",
"enum": [
"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"
],
"type": "string"
},
"has_insolvency_history": {
"description": "Deprecated. Please use links.insolvency",
"type": "boolean"
},
"undeliverable_registered_office_address": {
"description": "Flag indicating whether post can be delivered to the registered office.",
"type": "boolean"
},
"registered_office_is_in_dispute": {
"description": "Flag indicating registered office address as been replaced.",
"type": "boolean"
},
"branch_company_details": {
"description": "UK branch of a foreign company.",
"items": {
"$ref": "#/definitions/branchCompanyDetails"
}
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/linksType"
},
"type": "object"
}
}
},
"lastAccounts": {
"title": "lastAccounts",
"properties": {
"made_up_to": {
"type": "string",
"format": "date",
"description": "Deprecated. Please use accounts.last_accounts.period_end_on"
},
"period_end_on": {
"type": "string",
"format": "date",
"description": "The last day of the most recently filed accounting period."
},
"period_start_on": {
"type": "string",
"format": "date",
"description": "The first day of the most recently filed accounting period."
},
"type": {
"description": "The type of the last company accounts filed. \n For enumeration descriptions see `account_type` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"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"
]
}
},
"type": "string",
"required": [
"type",
"made_up_to"
]
},
"nextAccounts": {
"title": "nextAccounts",
"type": "object",
"properties": {
"due_on": {
"description": "The date the next company accounts are due",
"type": "string",
"format": "date"
},
"overdue": {
"description": "Flag indicating if the company accounts are overdue.",
"type": "boolean"
},
"period_end_on": {
"description": "The last day of the next accounting period to be filed.",
"type": "string",
"format": "date"
},
"period_start_on": {
"description": "The first day of the next accounting period to be filed.",
"type": "string",
"format": "date"
}
}
},
"foreignCompanyDetails": {
"title": "foreignCompanyDetails",
"properties": {
"originating_registry": {
"description": "Company origin informations",
"type": "object",
"items": {
"$ref": "#/definitions/originatingRegistry"
}
},
"registration_number": {
"description": "Registration number in company of incorporation.",
"type": "string"
},
"governed_by": {
"description": "Law governing the company in country of incorporation.",
"type": "string"
},
"company_type": {
"description": "Legal form of the company in the country of incorporation.",
"type": "string"
},
"is_a_credit_finance_institution": {
"description": "Is it a financial or credit institution.",
"type": "boolean"
},
"accounts": {
"description": "Foreign company account information.",
"items": {
"$ref": "#/definitions/accountInformation"
},
"type": "object"
},
"business_activity": {
"description": "Type of business undertaken by the company.",
"type": "string"
},
"accounting_requirement": {
"description": "Accounts requirement.",
"items": {
"$ref": "#/definitions/accountsRequired"
},
"type": "object"
}
}
},
"originatingRegistry": {
"title": "originatingRegistry",
"properties": {
"country": {
"description": "Country in which company was incorporated.",
"type": "string"
},
"name": {
"description": "Identity of register in country of incorporation.",
"type": "string"
}
}
},
"previousCompanyNames": {
"title": "previousCompanyNames",
"properties": {
"name": {
"description": "The previous company name",
"type": "string"
},
"effective_from": {
"description": "The date from which the company name was effective.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date on which the company name ceased.",
"type": "string",
"format": "date"
}
},
"required": [
"name",
"effective_from",
"ceased_on"
]
},
"corporateAnnotation": {
"title": "corporateAnnotation",
"properties": {
"created_on": {
"description": "The date on which the corporate annotation was created.",
"type": "string",
"format": "date"
},
"description": {
"description": "The details of a corporate annotation which has a corporate_annotation.type of “other”.",
"type": "string"
},
"type": {
"description": "The type of corporate annotation. \n For enumeration descriptions see `corporate_annotation_type` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"type": "string"
}
},
"required": [
"created_on",
"type"
]
},
"accountInformation": {
"title": "accountInformation",
"properties": {
"account_period_from:": {
"description": "Date account period starts under parent law.",
"items": {
"$ref": "#/definitions/accountPeriodFrom"
},
"type": "object"
},
"account_period_to": {
"description": "Date account period ends under parent law.",
"items": {
"$ref": "#/definitions/accountPeriodTo"
},
"type": "object"
},
"must_file_within": {
"description": "Time allowed from period end for disclosure of accounts under parent law.",
"items": {
"$ref": "#/definitions/fileWithin"
},
"type": "object"
}
}
},
"accountPeriodFrom": {
"title": "accountPeriodFrom",
"properties": {
"day": {
"description": "Day on which accounting period starts under parent law.",
"type": "integer"
},
"month": {
"description": "Month in which accounting period starts under parent law.",
"type": "integer"
}
}
},
"accountPeriodTo": {
"title": "accountPeriodTo",
"properties": {
"day": {
"description": "Day on which accounting period ends under parent law.",
"type": "integer"
},
"month": {
"description": "Month in which accounting period ends under parent law.",
"type": "integer"
}
}
},
"fileWithin": {
"title": "fileWithin",
"properties": {
"months": {
"description": "Number of months within which to file.",
"type": "integer"
}
}
},
"accountsRequired": {
"title": "accountsRequired",
"properties": {
"foreign_account_type": {
"description": "Type of accounting requirement that applies. \n For enumeration descriptions see `foreign_account_type` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"accounting-requirements-of-originating-country-apply",
"accounting-requirements-of-originating-country-do-not-apply"
],
"type": "string"
},
"terms_of_account_publication": {
"description": "Describes how the publication date is derived. \n For enumeration descriptions see `terms_of_account_publication` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"accounts-publication-date-supplied-by-company",
"accounting-publication-date-does-not-need-to-be-supplied-by-company",
"accounting-reference-date-allocated-by-companies-house"
],
"type": "string"
}
}
},
"registeredOfficeAddress": {
"title": "registeredOfficeAddress",
"properties": {
"care_of": {
"description": "The care of name.",
"type": "string"
},
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"country": {
"description": "The country.",
"enum": [
"Wales",
"England",
"Scotland",
"Great Britain",
"Not specified",
"United Kingdom",
"Northern Ireland"
],
"type": "string"
},
"locality": {
"description": "The locality e.g London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code e.g CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region e.g Surrey.",
"type": "string"
}
}
},
"serviceAddress": {
"title": "serviceAddress",
"properties": {
"care_of": {
"description": "The care of name.",
"type": "string"
},
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"country": {
"description": "The country e.g. United Kingdom.",
"type": "string"
},
"locality": {
"description": "The locality e.g London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code e.g CF14 3UZ.",
"type": "string"
},
"region": {
"description": "The region e.g Surrey.",
"type": "string"
}
}
},
"branchCompanyDetails": {
"title": "branchCompanyDetails",
"properties": {
"business_activity": {
"description": "Type of business undertaken by the UK establishment.",
"type": "string"
},
"parent_company_number": {
"description": "Parent company number.",
"type": "string"
},
"parent_company_name": {
"description": "Parent company name.",
"type": "string"
}
}
},
"linksType": {
"title": "linksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
},
"persons_with_significant_control": {
"description": "The URL of the persons with significant control list resource.",
"type": "string"
},
"persons_with_significant_control_statements": {
"description": "The URL of the persons with significant control statements list resource.",
"type": "string"
},
"registers": {
"description": "The URL of the registers resource for this company",
"type": "string"
},
"uk-establishments": {
"description": "The URL of the uk establishments list resource for this company.",
"type": "string"
},
"overseas": {
"description": "The URL of the overseas details resource for this company.",
"type": "string"
},
"officers": {
"description": "The URL of the company's officer list resource.",
"type": "string"
},
"insolvency": {
"description": "The URL of the company's insolvency list resource.",
"type": "string"
},
"filing_history": {
"description": "The URL of the company's filing history list resource.",
"type": "string"
},
"charges": {
"description": "The URL of the company's charges list resource.",
"type": "string"
},
"exemptions": {
"description": "The URL of the company's exemptions list resource.",
"type": "string"
}
}
}
}
},
"/search": {
"get": {
"summary": "Search All",
"description": "Search companies, officers and disqualified officers",
"x-operationName": "search all",
"tags": [
"search"
],
"parameters": [
{
"name": "q",
"in": "query",
"description": "The term being searched for.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of search results to return per page.",
"required": false,
"type": "integer"
},
{
"name": "start_index",
"in": "query",
"description": "The index of the first result item to return.",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Search all",
"schema": {
"$ref": "#/definitions/Search"
}
},
"401": {
"description": "Not authorised"
}
}
}
},
"/search/companies": {
"get": {
"summary": "Search companies",
"description": "Search company information",
"x-operationName": "search companies",
"tags": [
"search"
],
"parameters": [
{
"name": "q",
"in": "query",
"description": "The term being searched for.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of search results to return per page.",
"required": false,
"type": "integer"
},
{
"name": "start_index",
"in": "query",
"description": "The index of the first result item to return.",
"required": false,
"type": "integer"
},
{
"name": "restrictions",
"in": "query",
"description": "Enumerable options to restrict search results. Space separate multiple restriction options to combine functionality. For a \"company name availability\" search use \"active-companies legally-equivalent-company-name\" together.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Search company",
"schema": {
"$ref": "#/definitions/CompanySearch"
}
},
"401": {
"description": "Not authorised"
}
}
}
},
"/search/officers": {
"get": {
"summary": "Search company officers",
"description": "Search for officer information",
"x-operationName": "search officers",
"tags": [
"search"
],
"parameters": [
{
"name": "q",
"in": "query",
"description": "The term being searched for.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of search results to return per page.",
"required": false,
"type": "integer"
},
{
"name": "start_index",
"in": "query",
"description": "The index of the first result item to return.",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Search officer",
"schema": {
"$ref": "#/definitions/OfficerSearch"
}
},
"401": {
"description": "Not authorised"
}
}
}
},
"/search/disqualified-officers": {
"get": {
"summary": "Search disqualified officers",
"description": "Search for disqualified officer information",
"x-operationName": "search disqualified officers",
"tags": [
"search"
],
"parameters": [
{
"name": "q",
"in": "query",
"description": "The term being searched for.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of search results to return per page.",
"required": false,
"type": "integer"
},
{
"name": "start_index",
"in": "query",
"description": "The index of the first result item to return.",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Search all",
"schema": {
"$ref": "#/definitions/DisqualifiedOfficerSearch"
}
},
"401": {
"description": "Not authorised"
}
}
}
},
"/dissolved-search/companies": {
"get": {
"summary": "Search for a dissolved company",
"description": "Search for a dissolved company",
"x-operationName": "search dissolved companies",
"tags": [
"search"
],
"parameters": [
{
"name": "q",
"in": "query",
"description": "The company name being searched for",
"required": true,
"type": "string"
},
{
"name": "search_type",
"in": "query",
"description": "Determines type of search. Options are alphabetical, best-match, previous-name-dissolved",
"required": true,
"type": "string"
},
{
"name": "search_above",
"in": "query",
"description": "The ordered_alpha_key_with_id used for alphabetical paging",
"required": false,
"type": "string"
},
{
"name": "search_below",
"in": "query",
"description": "The ordered_alpha_key_with_id used for alphabetical paging",
"required": false,
"type": "string"
},
{
"name": "size",
"in": "query",
"description": "The maximum number of results matching the search term(s) to return with a range of 1 to 100",
"required": false,
"type": "string"
},
{
"name": "start_index",
"in": "query",
"description": "Used in best-match and previous-name-dissolved search-type",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of dissolved companies",
"schema": {
"$ref": "#/definitions/dissolvedCompanySearch"
}
},
"404": {
"description": "No companies found"
},
"422": {
"description": "Invalid size parameter, size must be greater than zero and not greater than 100"
}
}
}
},
"/alphabetical-search/companies": {
"get": {
"summary": "Search for a company",
"description": "Search for a company",
"x-operationName": "search companies alphabetically",
"tags": [
"search"
],
"parameters": [
{
"name": "q",
"in": "query",
"description": "The company name being searched for",
"required": true,
"type": "string"
},
{
"name": "search_above",
"in": "query",
"description": "The ordered_alpha_key_with_id used for paging",
"required": false,
"type": "string"
},
{
"name": "search_below",
"in": "query",
"description": "The ordered_alpha_key_with_id used for paging",
"required": false,
"type": "string"
},
{
"name": "size",
"in": "query",
"description": "The maximum number of results matching the search term(s) to return with a range of 1 to 100",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of companies",
"schema": {
"$ref": "#/definitions/alphabeticalCompanySearch"
}
},
"404": {
"description": "No companies found"
},
"422": {
"description": "Invalid size parameter, size must be greater than zero and not greater than 100"
}
}
}
},
"/advanced-search/companies": {
"get": {
"summary": "Advanced search for a company",
"description": "Advanced search for a company",
"x-operationName": "advanced company search",
"tags": [
"search"
],
"parameters": [
{
"name": "company_name_includes",
"in": "query",
"description": "The company name includes advanced search filter",
"required": false,
"type": "string"
},
{
"name": "company_name_excludes",
"in": "query",
"description": "The company name excludes advanced search filter",
"required": false,
"type": "string"
},
{
"name": "company_status",
"in": "query",
"description": "The company status advanced search filter. To search using multiple values, use a comma delimited list or multiple of the same key i.e. company_status=xxx&company_status=yyy",
"required": false,
"type": "list"
},
{
"name": "company_subtype",
"in": "query",
"description": "The company subtype advanced search filter. To search using multiple values, use a comma delimited list or multiple of the same key i.e. company_subtype=xxx&company_subtype=yyy",
"required": false,
"type": "string"
},
{
"name": "company_type",
"in": "query",
"description": "The company type advanced search filter. To search using multiple values, use a comma delimited list or multiple of the same key i.e. company_type=xxx&company_type=yyy",
"required": false,
"type": "list"
},
{
"name": "dissolved_from",
"in": "query",
"description": "The dissolved from date advanced search filter",
"required": false,
"type": "date"
},
{
"name": "dissolved_to",
"in": "query",
"description": "The dissolved to date advanced search filter",
"required": false,
"type": "date"
},
{
"name": "incorporated_from",
"in": "query",
"description": "The incorporated from date advanced search filter",
"required": false,
"type": "date"
},
{
"name": "incorporated_to",
"in": "query",
"description": "The incorporated to date advanced search filter",
"required": false,
"type": "date"
},
{
"name": "location",
"in": "query",
"description": "The location advanced search filter",
"required": false,
"type": "string"
},
{
"name": "sic_codes",
"in": "query",
"description": "The SIC codes advanced search filter. To search using multiple values, use a comma delimited list or multiple of the same key i.e. sic_codes=xxx&sic_codes=yyy",
"required": false,
"type": "list"
},
{
"name": "size",
"in": "query",
"description": "The maximum number of results matching the search term(s) to return with a range of 1 to 5000",
"required": false,
"type": "string"
},
{
"name": "start_index",
"in": "query",
"description": "The point at which results will start from i.e show search results from result 20 (used for paging)",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "A list of companies",
"schema": {
"$ref": "#/definitions/advancedCompanySearch"
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "No companies found"
}
}
}
},
"/company/{company_number}/officers": {
"get": {
"summary": "Company Officers",
"description": "List of all company officers",
"x-operationName": "list",
"tags": [
"officers"
],
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the officer list being requested.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of officers to return per page.",
"type": "integer"
},
{
"name": "register_type",
"in": "query",
"description": "The register_type determines which officer type is returned for the registers view.The register_type field will only work if registers_view is set to true",
"type": "string",
"enum": [
"directors",
"secretaries",
"llp-members"
]
},
{
"name": "register_view",
"in": "query",
"description": "Display register specific information. If given register is held at Companies House, registers_view set to true and correct register_type specified, only active officers will be returned. Those will also have full date of birth.Defaults to false",
"type": "string",
"enum": [
"true",
"false"
]
},
{
"name": "start_index",
"in": "query",
"description": "The offset into the entire result set that this page starts.",
"type": "integer"
},
{
"name": "order_by",
"in": "query",
"description": "The field by which to order the result set.",
"type": "string",
"enum": [
"appointed_on",
"resigned_on",
"surname"
]
}
],
"responses": {
"200": {
"description": "List the company officers",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/officerList"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/error"
}
},
"401": {
"description": "Unauthorised"
}
}
}
},
"/company/{company_number}/appointments/{appointment_id}": {
"get": {
"summary": "Get a company officer appointment",
"description": "Get details of an individual company officer appointment",
"tags": [
"officers"
],
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the officer list being requested.",
"required": true,
"type": "string"
},
{
"name": "appointment_id",
"in": "path",
"description": "The appointment id of the company officer appointment being requested.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Get a company officer appointment",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/officerSummary"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/error"
}
},
"401": {
"description": "Unauthorised"
}
}
}
},
"/company/{company_number}/registers": {
"get": {
"summary": "Company registers",
"tags": [
"registers"
],
"description": "Get the company registers information",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the register information to return.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "readCompanyRegister",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/companyRegister"
}
},
"401": {
"description": "Unauthorised"
}
}
},
"definitions": {
"companyRegister": {
"title": "companyRegister",
"type": "object",
"required": [
"links",
"company_number",
"kind",
"registers"
],
"properties": {
"links": {
"type": "object",
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/definitions-linksType"
}
},
"company_number": {
"type": "string",
"description": "The number of the company."
},
"kind": {
"enum": [
"registers"
],
"type": "string"
},
"registers": {
"description": "company registers information.",
"items": {
"$ref": "#/definitions/registers"
}
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
}
}
},
"registers": {
"title": "registers",
"description": "Registered company information",
"type": "object",
"required": [
"directors",
"secretaries",
"persons_with_significant_control",
"usual_residential_address",
"members"
],
"properties": {
"directors": {
"description": "List of registered company directors.",
"items": {
"$ref": "#/definitions/registerListDirectors"
}
},
"secretaries": {
"description": "List of registered company secretaries.",
"items": {
"$ref": "#/definitions/registerListSecretaries"
}
},
"persons_with_significant_control": {
"description": "List of registered company persons with significant control.",
"items": {
"$ref": "#/definitions/registerListPersonsWithSignificantControl"
}
},
"usual_residential_address": {
"description": "List of register addresses.",
"items": {
"$ref": "#/definitions/registerListUsualResidentialAddress"
}
},
"llp_usual_residential_address": {
"description": "List of register addresses.",
"items": {
"$ref": "#/definitions/registerListLLPUsualResidentialAddress"
}
},
"members": {
"description": "List of registered company members..",
"items": {
"$ref": "#/definitions/registerListMembers"
}
},
"llp_members": {
"description": "List of registered llp members.",
"items": {
"$ref": "#/definitions/registerListLLPMembers"
}
}
}
},
"registerListDirectors": {
"title": "registerListDirectors",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"directors"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksDirectorsRegister"
}
}
}
},
"registerListSecretaries": {
"title": "registerListSecretaries",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"secretaries"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksSecretaryRegister"
}
}
}
},
"registerListPersonsWithSignificantControl": {
"title": "registerListPersonsWithSignificantControl",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"persons-with-significant-control"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksPersonsWithSignificantControlRegister"
}
}
}
},
"registerListUsualResidentialAddress": {
"title": "registerListUsualResidentialAddress",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"usual-residential-address"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksListUsualResidentialAddress"
}
}
}
},
"registerListLLPUsualResidentialAddress": {
"title": "registerListLLPUsualResidentialAddress",
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"llp-usual-residential-address"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"items": {
"$ref": "#/definitions/linksListLLPUsualResidentialAddress"
},
"type": "object"
}
},
"required": [
"register_type",
"items"
]
},
"registerListMembers": {
"title": "registerListMembers",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"members"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksListMembers"
}
}
}
},
"registerListLLPMembers": {
"title": "registerListLLPMembers",
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"llp-members"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"items": {
"$ref": "#/definitions/linksListLLPMembers"
},
"type": "object"
}
},
"required": [
"register_type",
"items"
]
},
"registeredItems": {
"title": "registeredItems",
"required": [
"register_moved_to",
"moved_on",
"links"
],
"properties": {
"moved_on": {
"description": "The date registered on",
"type": "string",
"format": "date"
},
"register_moved_to": {
"description": "Location of registration",
"type": "string",
"enum": [
"public-register",
"registered-office",
"single-alternative-inspection-location",
"unspecified-location"
]
},
"links": {
"description": "A set of URLs related to the resource.",
"items": {
"$ref": "#/definitions/linksItems"
},
"type": "object"
}
}
},
"linksType": {
"title": "linksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
}
}
},
"linksItems": {
"title": "linksItems",
"required": [
"filing"
],
"properties": {
"filing": {
"description": "The URL of the transaction for the resource.",
"type": "string"
}
}
},
"linksDirectorsRegister": {
"title": "linksDirectorsRegister",
"properties": {
"directors_register": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"linksSecretaryRegister": {
"title": "linksSecretaryRegister",
"properties": {
"secretaries_register": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"linksPersonsWithSignificantControlRegister": {
"title": "linksPersonsWithSignificantControlRegister",
"properties": {
"persons_with_significant_control_register": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"linksListUsualResidentialAddress": {
"title": "linksListUsualResidentialAddress",
"properties": {
"usual_residential_address": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"linksListLLPUsualResidentialAddress": {
"title": "linksListLLPUsualResidentialAddress",
"properties": {
"llp_usual_residential_address": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"linksListMembers": {
"title": "linksListMembers",
"properties": {
"members": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"linksListLLPMembers": {
"title": "linksListLLPMembers",
"properties": {
"llp_members": {
"description": "The URL for the resource.",
"type": "string"
}
}
}
}
},
"/company/{company_number}/filing-history/{transaction_id}": {
"get": {
"summary": "filingHistoryItem resource",
"description": "Get the filing history item of a company",
"tags": [
"filingHistory"
],
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number that the single filing is required for.",
"required": true,
"type": "string"
},
{
"name": "transaction_id",
"in": "path",
"description": "The transaction id that the filing history is required for.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Filing history items resource returned",
"schema": {
"$ref": "#/definitions/filingHistoryItem"
}
},
"401": {
"description": "Unauthorised",
"schema": {
"$ref": "#/definitions/error"
}
},
"404": {
"description": "Filing history not available for this company"
}
}
}
},
"/company/{company_number}/filing-history": {
"get": {
"summary": "filingHistoryList resource",
"description": "Get the filing history list of a company",
"x-operationName": "list",
"tags": [
"filingHistory"
],
"parameters": [
{
"name": "category",
"in": "query",
"description": "One or more comma-separated categories to filter by (inclusive).",
"required": false,
"type": "string"
},
{
"name": "company_number",
"in": "path",
"description": "The company number that the filing history is required for.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of filing history items to return per page.",
"required": false,
"type": "integer"
},
{
"name": "start_index",
"in": "query",
"description": "The index into the entire result set that this result page starts.",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Filing history items resource returned",
"schema": {
"$ref": "#/definitions/filingHistoryList"
}
},
"401": {
"description": "Unauthorised",
"schema": {
"$ref": "#/definitions/error"
}
},
"404": {
"description": "Filing history not available for this company"
}
}
}
},
"/company/{company_number}/exemptions": {
"get": {
"description": "Company exemptions information",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number that the exemptions list is required for.",
"required": true,
"type": "string"
}
],
"tags": [
"exemptions"
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/companyExemptions"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
},
"definitions": {
"companyExemptions": {
"title": "companyExemptions",
"required": [
"links",
"kind",
"etag",
"exemptions"
],
"properties": {
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/exemptions_definitions-linksType"
},
"type": "array"
},
"kind": {
"type": "string",
"enum": [
"exemptions"
]
},
"etag": {
"type": "string",
"description": "The ETag of the resource."
},
"exemptions": {
"description": "Company exemptions information.",
"items": {
"$ref": "#/definitions/exemptions"
}
}
}
},
"exemptions": {
"description": "Exemptions information.",
"properties": {
"psc_exempt_as_trading_on_regulated_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on a regulated market other than the UK.",
"items": {
"$ref": "#/definitions/pscExemptAsTradingOnRegulatedMarketItem"
}
},
"psc_exempt_as_shares_admitted_on_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on a market listed in the Register of People with Significant Control Regulations 2016.",
"items": {
"$ref": "#/definitions/pscExemptAsSharesAdmittedOnMarketItem"
}
},
"psc_exempt_as_trading_on_uk_regulated_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on a UK regulated market.",
"items": {
"$ref": "#/definitions/pscExemptAsTradingOnUkRegualatedMarketItem"
}
},
"psc_exempt_as_trading_on_eu_regulated_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on an EU regulated market.",
"items": {
"$ref": "#/definitions/pscExemptAsTradingOnEuRegualatedMarketItem"
}
},
"disclosure_transparency_rules_chapter_five_applies": {
"description": "If present the company has been or is exempt from keeping a PSC register, because it is a DTR issuer and the shares are admitted to trading on a regulated market.",
"items": {
"$ref": "#/definitions/diclosureTransparencyRulesChapterFiveAppliesItem"
}
}
}
},
"pscExemptAsTradingOnRegulatedMarketItem": {
"properties": {
"items": {
"type": "array",
"description": "List of dates",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"type": "string",
"enum": [
"psc-exempt-as-trading-on-regulated-market"
]
}
},
"required": [
"exemption_type",
"items"
]
},
"pscExemptAsSharesAdmittedOnMarketItem": {
"required": [
"exemption_type",
"items"
],
"properties": {
"items": {
"description": "List of dates",
"type": "array",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"psc-exempt-as-shares-admitted-on-market"
],
"type": "string"
}
}
},
"pscExemptAsTradingOnUkRegualatedMarketItem": {
"required": [
"exemption_type",
"items"
],
"properties": {
"items": {
"description": "List of dates",
"type": "array",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"psc-exempt-as-trading-on-uk-regulated-market"
],
"type": "string"
}
}
},
"pscExemptAsTradingOnEuRegualatedMarketItem": {
"required": [
"exemption_type",
"items"
],
"properties": {
"items": {
"description": "List of dates",
"type": "array",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"psc-exempt-as-trading-on-eu-regulated-market"
],
"type": "string"
}
}
},
"diclosureTransparencyRulesChapterFiveAppliesItem": {
"properties": {
"items": {
"description": "List of exemption periods.",
"items": {
"$ref": "#/definitions/exemptionItem"
},
"type": "array"
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"disclosure-transparency-rules-chapter-five-applies"
],
"type": "string"
}
},
"required": [
"exemption_type",
"items"
]
},
"exemptionItem": {
"properties": {
"exempt_from": {
"description": "Exemption valid from.",
"type": "string",
"format": "date"
},
"exempt_to": {
"description": "Exemption valid to.",
"type": "string",
"format": "date"
}
},
"required": [
"exempt_from"
]
},
"linksType": {
"properties": {
"self": {
"description": "The URL of this resource.",
"type": "string"
}
},
"required": [
"self"
]
}
}
},
"/disqualified-officers/natural/{officer_id}": {
"get": {
"summary": "Get natural officers disqualifications",
"description": "Get a natural officer's disqualifications",
"x-operationName": "get natural officer",
"tags": [
"officerDisqualifications"
],
"parameters": [
{
"name": "officer_id",
"description": "The disqualified officer's id.",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Natural officer's disqualifications returned",
"schema": {
"$ref": "#/definitions/naturalDisqualification"
},
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/disqualified-officers/corporate/{officer_id}": {
"get": {
"summary": "Get a corporate officers disqualifications",
"description": "Get a corporate officer's disqualifications",
"x-operationName": "get corporate officer",
"tags": [
"officerDisqualifications"
],
"parameters": [
{
"description": "The disqualified officer id.",
"name": "officer_id",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Corporate officer's disqualifications returned",
"schema": {
"$ref": "#/definitions/corporateDisqualification"
},
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/officers/{officer_id}/appointments": {
"get": {
"summary": "Officer Appointment List",
"tags": [
"officerAppointments"
],
"x-operationName": "list",
"description": "List of all officer appointments",
"parameters": [
{
"name": "officer_id",
"in": "path",
"description": "The officer id of the appointment list being requested.",
"required": true,
"type": "string"
},
{
"name": "filter",
"in": "query",
"description": "Use “active” to return only active appointments.",
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of appointments to return per page.",
"type": "integer"
},
{
"name": "start_index",
"in": "query",
"description": "The first row of data to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the items_per_page parameter.",
"type": "integer"
}
],
"responses": {
"200": {
"description": "List the officer appointments",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/appointmentList"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Unauthorised"
}
}
},
"definitions": {
"appointmentList": {
"title": "appointmentList",
"properties": {
"date_of_birth": {
"description": "The officer's date of birth details.",
"items": {
"$ref": "#/definitions/definitions-dateOfBirth"
},
"type": "object"
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"is_corporate_officer": {
"description": "Indicator representing if the officer is a corporate body.",
"type": "boolean"
},
"items": {
"description": "The list of officer appointments.",
"type": "array",
"items": {
"$ref": "#/definitions/officerAppointmentSummary"
}
},
"items_per_page": {
"description": "The number of officer appointments to return per page.",
"type": "integer"
},
"kind": {
"enum": [
"personal-appointment"
],
"type": "string"
},
"links": {
"description": "Links to other resources associated with this officer appointment resource.",
"items": {
"$ref": "#/definitions/definitions-officerLinkTypes"
},
"type": "object"
},
"name": {
"description": "The corporate or natural officer name.",
"type": "string"
},
"start_index": {
"description": "The first row of data to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the `items_per_page` parameter.",
"type": "integer"
},
"total_results": {
"description": "The total number of officer appointments in this result set.",
"type": "integer"
}
},
"required": [
"etag",
"is_corporate_officer",
"items",
"items_per_page",
"kind",
"links",
"name",
"start_index",
"total_results"
]
},
"officerAppointmentSummary": {
"title": "officerAppointmentSummary",
"properties": {
"address": {
"description": "The correspondence address of the officer.",
"items": {
"$ref": "#/definitions/officerAppointmentList_definitions-address"
},
"type": "object"
},
"appointed_before": {
"description": "The date the officer was appointed before. Only present when the `is_pre_1992_appointment` attribute is `true`.",
"type": "string",
"format": "date"
},
"appointed_on": {
"description": "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.",
"type": "string",
"format": "date"
},
"appointed_to": {
"description": "The company information of the appointment.",
"items": {
"$ref": "#/definitions/appointedTo"
},
"type": "object"
},
"contact_details": {
"description": "The contact at the `corporate-managing-officer` of a `registered-overseas-entity`.",
"items": {
"$ref": "#/definitions/contactDetails"
},
"type": "object"
},
"name": {
"description": "The full name of the officer.",
"type": "string"
},
"country_of_residence": {
"description": "The officer's country of residence.",
"type": "string"
},
"former_names": {
"description": "Former names for the officer, if there are any.",
"items": {
"$ref": "#/definitions/formerNames"
},
"type": "array"
},
"identification": {
"description": "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.",
"items": {
"$ref": "#/definitions/corporateIdent"
},
"type": "object"
},
"is_pre_1992_appointment": {
"description": "Indicator representing if the officer was appointed before their appointment date.",
"type": "boolean"
},
"links": {
"description": "Links to other resources associated with this officer appointment item.",
"type": "object",
"items": {
"$ref": "#/definitions/appointmentLinkTypes"
}
},
"name_elements": {
"description": "A document encapsulating the separate elements of a natural officer's name.",
"type": "object",
"items": {
"$ref": "#/definitions/nameElements"
}
},
"nationality": {
"description": "The officer's nationality.",
"type": "string"
},
"occupation": {
"description": "The officer's occupation.",
"type": "string"
},
"officer_role": {
"enum": [
"cic-manager",
"corporate-director",
"corporate-llp-designated-member",
"corporate-llp-member",
"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",
"judicial-factor",
"llp-designated-member",
"llp-member",
"managing-officer",
"member-of-a-management-organ",
"member-of-a-supervisory-organ",
"member-of-an-administrative-organ",
"nominee-director",
"nominee-secretary",
"receiver-and-manager",
"secretary"
],
"type": "string"
},
"principal_office_address": {
"description": "The principal/registered office address of a `corporate-managing-officer` of a `registered-overseas-entity`.",
"items": {
"$ref": "#/definitions/officerAppointmentList_definitions-address"
},
"type": "object"
},
"resigned_on": {
"description": "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.",
"type": "string",
"format": "date"
},
"responsibilities": {
"description": "The responsibilities of the managing officer of a `registered-overseas-entity`.",
"type": "string"
}
},
"required": [
"appointed_to",
"links",
"name",
"officer_role"
]
},
"address": {
"title": "address",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"care_of": {
"description": "The care of name.",
"type": "string"
},
"country": {
"description": "The country. For example, UK.",
"type": "string"
},
"locality": {
"description": "The locality. For example London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code. For example CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region. For example Surrey.",
"type": "string"
}
}
},
"appointedTo": {
"title": "appointedTo",
"properties": {
"company_name": {
"description": "The name of the company the officer is acting for.",
"type": "string"
},
"company_number": {
"description": "The number of the company the officer is acting for.",
"type": "string"
},
"company_status": {
"description": "The status of the company the officer is acting for.",
"type": "string"
}
},
"required": [
"company_number"
]
},
"contactDetails": {
"title": "contactDetails",
"properties": {
"contact_name": {
"description": "The name of the contact.",
"type": "string"
}
}
},
"dateOfBirth": {
"title": "dateOfBirth",
"properties": {
"month": {
"description": "The month the officer was born in.",
"type": "integer"
},
"year": {
"description": "The year the officer was born in.",
"type": "integer"
}
},
"required": [
"month",
"year"
]
},
"formerNames": {
"title": "formerNames",
"properties": {
"forenames": {
"description": "Former forenames of the officer.",
"type": "string"
},
"surname": {
"description": "Former surnames of the officer.",
"type": "string"
}
}
},
"officerLinkTypes": {
"title": "officerLinkTypes",
"required": [
"self"
],
"properties": {
"self": {
"description": "Link to this officer appointment resource.",
"type": "string"
}
}
},
"appointmentLinkTypes": {
"title": "appointmentLinkTypes",
"required": [
"company"
],
"properties": {
"company": {
"description": "Link to the company profile resource that this appointment is associated with.",
"type": "string"
}
}
},
"corporateIdent": {
"title": "corporateIdent",
"properties": {
"identification_type": {
"description": "The officer's identity type",
"enum": [
"eea",
"non-eea",
"uk-limited-company",
"other-corporate-body-or-firm",
"registered-overseas-entity-corporate-managing-officer"
],
"type": "string"
},
"legal_authority": {
"description": "The legal authority supervising the company.",
"type": "string"
},
"legal_form": {
"description": "The legal form of the company as defined by its country of registration.",
"type": "string"
},
"place_registered": {
"description": "Place registered.",
"type": "string"
},
"registration_number": {
"description": "Company registration number.",
"type": "string"
}
}
},
"nameElements": {
"title": "nameElements",
"properties": {
"forename": {
"description": "The forename of the officer.",
"type": "string"
},
"title": {
"description": "Title of the officer.",
"type": "string"
},
"other_forenames": {
"description": "Other forenames of the officer.",
"type": "string"
},
"surname": {
"description": "The surname of the officer.",
"type": "string"
},
"honours": {
"description": "Honours an officer might have.",
"type": "string"
}
},
"required": [
"surname"
]
}
}
},
"/company/{company_number}/charges": {
"get": {
"summary": "Charges",
"description": "List of charges for a company.",
"x-operationName": "list",
"tags": [
"charges"
],
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number that the charge list is required for.",
"paramType": "path",
"required": true,
"type": "string"
},
{
"title": "items_per_page",
"description": "The number of charges to return per page.",
"type": "integer",
"paramType": "query",
"required": false
},
{
"title": "start_index",
"description": "The index into the entire result set that this result page starts.",
"type": "integer",
"paramType": "query",
"required": false
}
],
"responses": {
"200": {
"description": "Resource returned",
"schema": {
"$ref": "#/definitions/chargeList"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/charges/{charge_id}": {
"get": {
"description": "Individual charge information for company.",
"tags": [
"charges"
],
"parameters": [
{
"name": "company_number",
"description": "The company number that the charge is required for.",
"paramType": "path",
"required": true,
"type": "string"
},
{
"name": "charge_id",
"description": "The id of the charge details that are required.",
"paramType": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource returned",
"schema": {
"$ref": "#/definitions/chargeDetails"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/insolvency": {
"get": {
"description": "Company insolvency information",
"tags": [
"insolvency"
],
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the basic information to return.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Company insolvency resource returned",
"schema": {
"$ref": "#/definitions/companyInsolvency"
}
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/uk-establishments": {
"get": {
"summary": "Company UK Establishments",
"description": "List of uk-establishments companies",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "Company number",
"required": true,
"type": "string"
}
],
"tags": [
"UKEstablishments"
],
"responses": {
"200": {
"description": "Resource returned",
"schema": {
"$ref": "#/definitions/companyUKEstablishments"
}
},
"401": {
"description": "Unauthorised"
}
}
},
"definitions": {
"companyUKEstablishments": {
"title": "companyUKEstablishments",
"required": [
"etag",
"kind",
"items"
],
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the resource."
},
"kind": {
"type": "string",
"description": "UK Establishment companies.",
"enum": [
"ukestablishment-companies"
]
},
"links": {
"type": "object",
"description": "UK Establishment Resources related to this company.",
"items": {
"$ref": "#/definitions/self_links"
}
},
"items": {
"type": "array",
"description": "List of UK Establishment companies.",
"items": {
"$ref": "#/definitions/companyDetails"
}
}
}
},
"companyDetails": {
"title": "companyDetails",
"required": [
"company_number",
"company_name",
"company_status",
"links"
],
"properties": {
"company_number": {
"type": "string",
"description": "The number of the company."
},
"company_name": {
"type": "string",
"description": "The name of the company."
},
"company_status": {
"type": "string",
"description": "Company status."
},
"locality": {
"type": "string",
"description": "The locality e.g London."
},
"links": {
"description": "Resources related to this company.",
"type": "object",
"items": {
"$ref": "#/definitions/companyUKEstablishments_definitions-links"
}
}
}
},
"self_links": {
"title": "self_links",
"required": [
"self"
],
"properties": {
"self": {
"type": "string",
"description": "Link to this company."
}
}
},
"links": {
"title": "links",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"description": "The link to the company."
}
}
}
}
},
"/company/{company_number}/persons-with-significant-control": {
"get": {
"summary": "List the company persons with significant control",
"description": "List of all persons with significant control (not statements)",
"x-operationName": "list",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the persons with significant control list being requested.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The number of persons with significant control to return per page.",
"required": true,
"type": "string"
},
{
"name": "start_index",
"in": "query",
"description": "The offset into the entire result set that this page starts.",
"required": true,
"type": "string"
},
{
"name": "register_view",
"in": "query",
"description": "Display register specific information. If register is held at Companies House and register_view is set to true, only PSCs which are active or were terminated during election period are shown together with full dates of birth where available. Accepted values are: -`true` \n -`false` \n Defaults to false.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "readCompanyProfile",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/list"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/individual/{psc_id}": {
"get": {
"summary": "Get the individual person with significant control",
"description": "Get details of an individual person with significant control",
"x-operationName": "get individual",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the person with significant control details being requested.",
"required": true,
"type": "string"
},
{
"name": "psc_id",
"in": "path",
"description": "The id of the person with significant control details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "IndividualPSC resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/individual"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/individual-beneficial-owner/{psc_id}": {
"get": {
"summary": "Get the individual beneficial owner",
"description": "Get details of an individual beneficial owner",
"x-operationName": "get individual beneficial owner",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the beneficial owner details being requested.",
"required": true,
"type": "string"
},
{
"name": "psc_id",
"in": "path",
"description": "The id of the beneficial owner details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "IndividualBO resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/individualBeneficialOwner"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/corporate-entity/{psc_id}": {
"get": {
"summary": "Get the corporate entity with significant control",
"description": "Get details of a corporate entity with significant control",
"x-operationName": "get corporate entities",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the corporate entity with significant control details being requested.",
"required": true,
"type": "string"
},
{
"name": "psc_id",
"in": "path",
"description": "The id of the corporate entity with significant control details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "CorporateEntityPSC resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/corporateEntity"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/corporate-entity-beneficial-owner/{psc_id}": {
"get": {
"summary": "Get the corporate entity beneficial owner",
"description": "Get details of a corporate entity beneficial owner",
"x-operationName": "get corporate entity beneficial owner",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the corporate entity beneficial owner details being requested.",
"required": true,
"type": "string"
},
{
"name": "psc_id",
"in": "path",
"description": "The id of the corporate entity beneficial owner details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "CorporateEntityBO resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/corporateEntityBeneficialOwner"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/legal-person/{psc_id}": {
"get": {
"summary": "Get the legal person with significant control",
"description": "Get details of a legal person with significant control",
"x-operationName": "get legal persons",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the legal person with significant control details being requested.",
"required": true,
"type": "string"
},
{
"name": "psc_id",
"in": "path",
"description": "The id of the legal person with significant control details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "LegalPersonPSC resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/legalPerson"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/legal-person-beneficial-owner/{psc_id}": {
"get": {
"summary": "Get the legal person beneficial owner",
"description": "Get details of a legal person beneficial owner",
"x-operationName": "get legal person beneficial owner",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the legal person beneficial owner details being requested.",
"required": true,
"type": "string"
},
{
"name": "psc_id",
"in": "path",
"description": "The id of the legal person beneficial owner details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "LegalPersonBO resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/legalPersonBeneficialOwner"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control-statements": {
"get": {
"summary": "List the company persons with significant control statements",
"description": "List of all persons with significant control statements",
"x-operationName": "list statements",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the persons with significant control statements list being requested.",
"required": true,
"type": "string"
},
{
"name": "items_per_page",
"in": "query",
"description": "The id of the legal person with significant control details being requested.",
"required": true,
"type": "integer"
},
{
"name": "start_index",
"in": "query",
"description": "The offset into the entire result set that this page starts.",
"required": true,
"type": "integer"
},
{
"name": "register_view",
"in": "query",
"description": "Display register specific information. If register is held at Companies House and register_view is set to true, only statements which are active or were withdrawn during election period are shown. Accepted values are: -`true` \n -`false` \n Defaults to false.",
"required": true,
"type": "query"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "CompanyPSCStatements resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/statementList"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control-statements/{statement_id}": {
"get": {
"summary": "Get the person with significant control statement",
"description": "Get details of a person with significant control statement",
"x-operationName": "get statement",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the persons with significant control statements list being requested.",
"required": true,
"type": "string"
},
{
"name": "statement_id",
"in": "path",
"description": "The id of the person with significant control statement details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "PSCStatement resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/statement"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/super-secure/{super_secure_id}": {
"get": {
"summary": "Get the super secure person with significant control",
"description": "Get details of a super secure person with significant control",
"x-operationName": "get super secure person",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the super secure person with significant control details being requested.",
"required": true,
"type": "string"
},
{
"name": "super_secure_id",
"in": "path",
"description": "The id of the super secure person with significant control details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "SuperSecurePSC resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/superSecure"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
},
"/company/{company_number}/persons-with-significant-control/super-secure-beneficial-owner/{super_secure_id}": {
"get": {
"summary": "Get the super secure beneficial owner",
"description": "Get details of a super secure beneficial owner",
"x-operationName": "get super secure beneficial owner",
"parameters": [
{
"name": "company_number",
"in": "path",
"description": "The company number of the super secure beneficial owner details being requested.",
"required": true,
"type": "string"
},
{
"name": "super_secure_id",
"in": "path",
"description": "The id of the super secure beneficial owner details being requested.",
"required": true,
"type": "string"
}
],
"tags": [
"personsWithSignificantControl"
],
"responses": {
"200": {
"description": "SuperSecureBO resource returned",
"headers": {
"ETag": {
"description": "The ETag of the resource.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/superSecureBeneficialOwner"
}
},
"401": {
"description": "Unauthorised"
},
"404": {
"description": "Resource not found"
}
}
}
}
},
"definitions": {
"selfLink": {
"required": [
"self"
],
"properties": {
"self": {
"description": "URL to this resource.",
"readOnly": true,
"type": "string",
"format": "uri"
}
}
},
"registeredOfficeAddress": {
"title": "registeredOfficeAddress",
"type": "object",
"required": [
"premises",
"address_line_1",
"locality",
"country",
"accept_appropriate_office_address_statement"
],
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the resource.",
"readOnly": true
},
"kind": {
"type": "string",
"description": "The type of resource.",
"enum": [
"registered-office-address"
],
"readOnly": true
},
"links": {
"type": "object",
"description": "Links to the related resources",
"items": {
"$ref": "#/definitions/selfLink"
},
"readOnly": true
},
"premises": {
"type": "string",
"description": "The property name or number."
},
"address_line_1": {
"type": "string",
"description": "The first line of the address."
},
"address_line_2": {
"type": "string",
"description": "The second line of the address."
},
"locality": {
"type": "string",
"description": "The locality e.g London."
},
"region": {
"type": "string",
"description": "The region e.g Surrey."
},
"postal_code": {
"type": "string",
"description": "The postal code e.g CF14 3UZ."
},
"country": {
"type": "string",
"description": "The country.",
"enum": [
"England",
"Wales",
"Scotland",
"Northern Ireland",
"Great Britain",
"United Kingdom",
"Not specified"
]
},
"accept_appropriate_office_address_statement": {
"type": "boolean",
"description": "Setting this to true confirms that the new registered office address is an appropriate address as outlined in section 86(2) of the Companies Act 2006."
}
}
},
"accountingReferenceDate": {
"title": "accountingReferenceDate",
"type": "object",
"required": [
"day",
"month"
],
"properties": {
"day": {
"type": "integer",
"description": "The Accounting Reference Date (ARD) day."
},
"month": {
"type": "integer",
"description": "The Accounting Reference Date (ARD) month."
}
}
},
"lastAccounts": {
"title": "lastAccounts",
"properties": {
"made_up_to": {
"type": "string",
"format": "date",
"description": "Deprecated. Please use accounts.last_accounts.period_end_on"
},
"period_end_on": {
"type": "string",
"format": "date",
"description": "The last day of the most recently filed accounting period."
},
"period_start_on": {
"type": "string",
"format": "date",
"description": "The first day of the most recently filed accounting period."
},
"type": {
"description": "The type of the last company accounts filed. \n For enumeration descriptions see `account_type` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"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"
]
}
},
"type": "string",
"required": [
"type",
"made_up_to"
]
},
"nextAccounts": {
"title": "nextAccounts",
"type": "object",
"properties": {
"due_on": {
"description": "The date the next company accounts are due",
"type": "string",
"format": "date"
},
"overdue": {
"description": "Flag indicating if the company accounts are overdue.",
"type": "boolean"
},
"period_end_on": {
"description": "The last day of the next accounting period to be filed.",
"type": "string",
"format": "date"
},
"period_start_on": {
"description": "The first day of the next accounting period to be filed.",
"type": "string",
"format": "date"
}
}
},
"accountsInformation": {
"title": "accountsInformation",
"type": "object",
"required": [
"overdue",
"next_made_up_to",
"accounting_reference_date"
],
"properties": {
"accounting_reference_date": {
"description": "The Accounting Reference Date (ARD) of the company.",
"type": "object",
"items": {
"$ref": "#/definitions/accountingReferenceDate"
}
},
"last_accounts": {
"description": "The last company accounts filed.",
"type": "object",
"items": {
"$ref": "#/definitions/lastAccounts"
}
},
"next_due": {
"description": "Deprecated. Please use accounts.next_accounts.due_on",
"type": "string",
"format": "date"
},
"next_made_up_to": {
"description": "Deprecated. Please use accounts.next_accounts.period_end_on",
"type": "string",
"format": "date"
},
"overdue": {
"type": "boolean",
"description": "Deprecated. Please use accounts.next_accounts.overdue"
},
"next_accounts": {
"description": "The next company accounts filed.",
"type": "object",
"items": {
"$ref": "#/definitions/nextAccounts"
}
}
}
},
"annualReturnInformation": {
"title": "annualReturnInformation",
"type": "object",
"properties": {
"last_made_up_to": {
"description": "The date the last annual return was made up to.",
"type": "string",
"format": "date"
},
"next_due": {
"description": "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`",
"type": "string",
"format": "date"
},
"next_made_up_to": {
"description": "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`",
"type": "string",
"format": "date"
},
"overdue": {
"description": "Flag indicating if the annual return is overdue.",
"type": "boolean"
}
}
},
"confirmationOfStatementInformation": {
"title": "confirmationOfStatementInformation",
"required": [
"next_made_up_to",
"next_due"
],
"properties": {
"last_made_up_to": {
"description": "The date to which the company last made a confirmation statement.",
"type": "string",
"format": "date"
},
"next_due": {
"description": "The date by which the next confimation statement must be received.",
"type": "string",
"format": "date"
},
"next_made_up_to": {
"description": "The date to which the company must next make a confirmation statement.",
"type": "string",
"format": "date"
},
"overdue": {
"description": "Flag indicating if the confirmation statement is overdue",
"type": "boolean"
}
}
},
"originatingRegistry": {
"title": "originatingRegistry",
"properties": {
"country": {
"description": "Country in which company was incorporated.",
"type": "string"
},
"name": {
"description": "Identity of register in country of incorporation.",
"type": "string"
}
}
},
"accountPeriodFrom": {
"title": "accountPeriodFrom",
"properties": {
"day": {
"description": "Day on which accounting period starts under parent law.",
"type": "integer"
},
"month": {
"description": "Month in which accounting period starts under parent law.",
"type": "integer"
}
}
},
"accountPeriodTo": {
"title": "accountPeriodTo",
"properties": {
"day": {
"description": "Day on which accounting period ends under parent law.",
"type": "integer"
},
"month": {
"description": "Month in which accounting period ends under parent law.",
"type": "integer"
}
}
},
"fileWithin": {
"title": "fileWithin",
"properties": {
"months": {
"description": "Number of months within which to file.",
"type": "integer"
}
}
},
"accountInformation": {
"title": "accountInformation",
"properties": {
"account_period_from:": {
"description": "Date account period starts under parent law.",
"items": {
"$ref": "#/definitions/accountPeriodFrom"
},
"type": "object"
},
"account_period_to": {
"description": "Date account period ends under parent law.",
"items": {
"$ref": "#/definitions/accountPeriodTo"
},
"type": "object"
},
"must_file_within": {
"description": "Time allowed from period end for disclosure of accounts under parent law.",
"items": {
"$ref": "#/definitions/fileWithin"
},
"type": "object"
}
}
},
"accountsRequired": {
"title": "accountsRequired",
"properties": {
"foreign_account_type": {
"description": "Type of accounting requirement that applies. \n For enumeration descriptions see `foreign_account_type` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"accounting-requirements-of-originating-country-apply",
"accounting-requirements-of-originating-country-do-not-apply"
],
"type": "string"
},
"terms_of_account_publication": {
"description": "Describes how the publication date is derived. \n For enumeration descriptions see `terms_of_account_publication` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"accounts-publication-date-supplied-by-company",
"accounting-publication-date-does-not-need-to-be-supplied-by-company",
"accounting-reference-date-allocated-by-companies-house"
],
"type": "string"
}
}
},
"foreignCompanyDetails": {
"title": "foreignCompanyDetails",
"properties": {
"originating_registry": {
"description": "Company origin informations",
"type": "object",
"items": {
"$ref": "#/definitions/originatingRegistry"
}
},
"registration_number": {
"description": "Registration number in company of incorporation.",
"type": "string"
},
"governed_by": {
"description": "Law governing the company in country of incorporation.",
"type": "string"
},
"company_type": {
"description": "Legal form of the company in the country of incorporation.",
"type": "string"
},
"is_a_credit_finance_institution": {
"description": "Is it a financial or credit institution.",
"type": "boolean"
},
"accounts": {
"description": "Foreign company account information.",
"items": {
"$ref": "#/definitions/accountInformation"
},
"type": "object"
},
"business_activity": {
"description": "Type of business undertaken by the company.",
"type": "string"
},
"accounting_requirement": {
"description": "Accounts requirement.",
"items": {
"$ref": "#/definitions/accountsRequired"
},
"type": "object"
}
}
},
"definitions-registeredOfficeAddress": {
"title": "registeredOfficeAddress",
"properties": {
"care_of": {
"description": "The care of name.",
"type": "string"
},
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"country": {
"description": "The country.",
"enum": [
"Wales",
"England",
"Scotland",
"Great Britain",
"Not specified",
"United Kingdom",
"Northern Ireland"
],
"type": "string"
},
"locality": {
"description": "The locality e.g London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code e.g CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region e.g Surrey.",
"type": "string"
}
}
},
"serviceAddress": {
"title": "serviceAddress",
"properties": {
"care_of": {
"description": "The care of name.",
"type": "string"
},
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"country": {
"description": "The country e.g. United Kingdom.",
"type": "string"
},
"locality": {
"description": "The locality e.g London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code e.g CF14 3UZ.",
"type": "string"
},
"region": {
"description": "The region e.g Surrey.",
"type": "string"
}
}
},
"previousCompanyNames": {
"title": "previousCompanyNames",
"properties": {
"name": {
"description": "The previous company name",
"type": "string"
},
"effective_from": {
"description": "The date from which the company name was effective.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date on which the company name ceased.",
"type": "string",
"format": "date"
}
},
"required": [
"name",
"effective_from",
"ceased_on"
]
},
"corporateAnnotation": {
"title": "corporateAnnotation",
"properties": {
"created_on": {
"description": "The date on which the corporate annotation was created.",
"type": "string",
"format": "date"
},
"description": {
"description": "The details of a corporate annotation which has a corporate_annotation.type of “other”.",
"type": "string"
},
"type": {
"description": "The type of corporate annotation. \n For enumeration descriptions see `corporate_annotation_type` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"type": "string"
}
},
"required": [
"created_on",
"type"
]
},
"branchCompanyDetails": {
"title": "branchCompanyDetails",
"properties": {
"business_activity": {
"description": "Type of business undertaken by the UK establishment.",
"type": "string"
},
"parent_company_number": {
"description": "Parent company number.",
"type": "string"
},
"parent_company_name": {
"description": "Parent company name.",
"type": "string"
}
}
},
"linksType": {
"title": "linksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
},
"persons_with_significant_control": {
"description": "The URL of the persons with significant control list resource.",
"type": "string"
},
"persons_with_significant_control_statements": {
"description": "The URL of the persons with significant control statements list resource.",
"type": "string"
},
"registers": {
"description": "The URL of the registers resource for this company",
"type": "string"
},
"uk-establishments": {
"description": "The URL of the uk establishments list resource for this company.",
"type": "string"
},
"overseas": {
"description": "The URL of the overseas details resource for this company.",
"type": "string"
},
"officers": {
"description": "The URL of the company's officer list resource.",
"type": "string"
},
"insolvency": {
"description": "The URL of the company's insolvency list resource.",
"type": "string"
},
"filing_history": {
"description": "The URL of the company's filing history list resource.",
"type": "string"
},
"charges": {
"description": "The URL of the company's charges list resource.",
"type": "string"
},
"exemptions": {
"description": "The URL of the company's exemptions list resource.",
"type": "string"
}
}
},
"companyProfile": {
"title": "companyProfile",
"required": [
"company_name",
"company_number",
"type",
"can_file",
"links"
],
"properties": {
"accounts": {
"description": "Company accounts information.",
"items": {
"$ref": "#/definitions/accountsInformation"
},
"type": "object"
},
"annual_return": {
"description": "Annual return information. This member is only returned if a confirmation statement has not be filed.",
"items": {
"$ref": "#/definitions/annualReturnInformation"
},
"type": "object"
},
"can_file": {
"description": "Flag indicating whether this company can file.",
"type": "boolean"
},
"confirmation_statement": {
"description": "Confirmation statement information (N.B. refers to the Annual Statement where type is registered-overseas-entity)",
"items": {
"$ref": "#/definitions/confirmationOfStatementInformation"
},
"type": "object"
},
"company_name": {
"description": "The name of the company.",
"type": "string"
},
"jurisdiction": {
"description": "The jurisdiction specifies the political body responsible for the company.",
"type": "string",
"enum": [
"england-wales",
"wales",
"scotland",
"northern-ireland",
"european-union",
"united-kingdom",
"england",
"noneu"
]
},
"company_number": {
"description": "The number of the company.",
"type": "string"
},
"date_of_creation": {
"description": "The date when the company was created.",
"type": "string",
"format": "date"
},
"date_of_cessation": {
"description": "The date which the company was converted/closed, dissolved or removed. Please refer to company status to determine which.",
"type": "string",
"format": "date"
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"has_been_liquidated": {
"description": "Deprecated. Please use links.insolvency",
"type": "boolean"
},
"has_charges": {
"description": "Deprecated. Please use links.charges",
"type": "boolean"
},
"is_community_interest_company": {
"description": "Deprecated. Please use subtype",
"type": "boolean"
},
"subtype": {
"description": "The subtype of the company. Possible values are:",
"enum": [
"community-interest-company",
"private-fund-limited-partnership"
],
"type": "string"
},
"partial_data_available": {
"description": "Returned if Companies House is not the primary source of data for this company.\nFor enumeration descriptions see partial_data_available section in the enumeration mappings (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml).",
"enum": [
"full-data-available-from-financial-conduct-authority",
"full-data-available-from-department-of-the-economy",
"full-data-available-from-the-company"
],
"type": "string"
},
"external_registration_number": {
"description": "The number given by an external registration body.",
"type": "string"
},
"foreign_company_details": {
"description": "Foreign company details.",
"items": {
"$ref": "#/definitions/foreignCompanyDetails"
},
"type": "object"
},
"last_full_members_list_date": {
"description": "The date of last full members list update.",
"type": "string",
"format": "date"
},
"registered_office_address": {
"description": "The address of the company's registered office.",
"items": {
"$ref": "#/definitions/definitions-registeredOfficeAddress"
},
"type": "object"
},
"service_address": {
"description": "The correspondence address of a Registered overseas entity",
"items": {
"$ref": "#/definitions/serviceAddress"
},
"type": "object"
},
"super_secure_managing_officer_count": {
"description": "The total count of super secure managing officers for a `registered-overseas-entity`.",
"type": "integer"
},
"sic_codes": {
"description": "SIC codes for this company.",
"type": "array",
"items": {
"type": "string"
}
},
"previous_company_names": {
"description": "The previous names of this company.",
"items": {
"$ref": "#/definitions/previousCompanyNames"
},
"type": "array"
},
"corporate_annotation": {
"description": "A corporate level message published by Companies House about a company, or situations affecting the company, or its information.",
"items": {
"$ref": "#/definitions/corporateAnnotation"
},
"type": "array"
},
"company_status": {
"description": "The status of the company. \n For enumeration descriptions see `company_status` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml) ",
"type": "string",
"enum": [
"active",
"dissolved",
"liquidation",
"receivership",
"administration",
"voluntary-arrangement",
"converted-closed",
"insolvency-proceedings",
"registered",
"removed",
"closed",
"open"
]
},
"company_status_detail": {
"description": "Extra details about the status of the company. \n For enumeration descriptions see `company_status_detail` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml). ",
"enum": [
"transferred-from-uk",
"active-proposal-to-strike-off",
"petition-to-restore-dissolved",
"transformed-to-se",
"converted-to-plc"
],
"type": "string"
},
"type": {
"description": "The type of the company. \n For enumeration descriptions see `company_type` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml) ",
"enum": [
"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"
],
"type": "string"
},
"has_insolvency_history": {
"description": "Deprecated. Please use links.insolvency",
"type": "boolean"
},
"undeliverable_registered_office_address": {
"description": "Flag indicating whether post can be delivered to the registered office.",
"type": "boolean"
},
"registered_office_is_in_dispute": {
"description": "Flag indicating registered office address as been replaced.",
"type": "boolean"
},
"branch_company_details": {
"description": "UK branch of a foreign company.",
"items": {
"$ref": "#/definitions/branchCompanyDetails"
}
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/linksType"
},
"type": "object"
}
}
},
"CommonSearch": {
"properties": {
"total_results": {
"type": "integer",
"description": "The number of further search results available for the current search."
},
"start_index": {
"type": "integer",
"description": "The index into the entire result set that this result page starts."
},
"items_per_page": {
"type": "integer",
"description": "The number of search items returned per page."
},
"etag": {
"type": "string",
"description": "The ETag of the resource"
}
}
},
"LinksModel": {
"title": "LinksModel",
"properties": {
"self": {
"type": "string",
"description": "The URL of the resource being returned by the search item."
}
}
},
"MatchesModel": {
"title": "MatchesModel",
"properties": {
"title": {
"items": {
"type": "integer"
},
"type": "array",
"description": "An array of character offset into the `title` string. These always occur in pairs and define the start and end of substrings in the member `title` that matched the search terms. The first character of the string is index 1."
},
"snippet": {
"items": {
"type": "integer"
},
"type": "array",
"description": "An array of character offset into the `snippet` string. These always occur in pairs and define the start and end of substrings in the member `snippet` that matched the search terms. The first character of the string is index 1."
},
"address_snippet": {
"items": {
"type": "integer"
},
"type": "array",
"description": "An array of character offset into the `address_snippet` string. These always occur in pairs and define the start and end of substrings in the member `address_snippet` that matched the search terms."
}
}
},
"CommonSearchItems": {
"properties": {
"title": {
"type": "string",
"description": "The title of the search result."
},
"address_snippet": {
"type": "string",
"description": "A single line address. This will be the address that matched within the indexed document or the primary address otherwise (as returned by the `address` member)."
},
"links": {
"type": "object",
"description": "The URL of the search result.",
"items": {
"$ref": "#/definitions/LinksModel"
}
},
"description": {
"type": "string",
"description": "The result description."
},
"snippet": {
"type": "string",
"description": "Summary information for the result showing additional details that have matched."
},
"matches": {
"type": "object",
"description": "A list of members and arrays of character offset defining substrings that matched the search terms.",
"items": {
"$ref": "#/definitions/MatchesModel"
}
}
}
},
"search_definitions-registeredOfficeAddress": {
"title": "registeredOfficeAddress",
"required": [
"address_line_1"
],
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"country": {
"description": "The country.",
"enum": [
"Wales",
"England",
"Scotland",
"Great Britain",
"Not specified",
"United Kingdom",
"Northern Ireland"
],
"type": "string"
},
"locality": {
"description": "The locality e.g London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code e.g CF14 3UZ.",
"type": "string"
},
"care_of": {
"description": "The care of name.",
"type": "string"
},
"region": {
"description": "The region e.g Surrey.",
"type": "string"
}
}
},
"SearchItems": {
"title": "SearchItems",
"allOf": [
{
"$ref": "#/definitions/CommonSearchItems"
}
],
"required": [
"kind",
"title",
"address_snippet",
"links",
"address"
],
"properties": {
"kind": {
"type": "string",
"description": "The type of search result. Refer to the full resource descriptions [CompanySearch resource](api/docs/company/company_number/CompanySearch-resource.html) [OfficerSearch resource] (api/docs/company/company_number/OfficerSearch-resource.html) and [DisqualifiedOfficerSearch resource](api/docs/company/company_number/DisqualifiedOfficerSearch-resource.html) for the full list of members returned.",
"enum": [
"searchresults#company",
"searchresults#officer",
"searchresults#disqualified-officer"
]
},
"description_identifier": {
"items": {
"type": "string",
"enum": [
"incorporated-on",
"registered-on",
"formed-on",
"dissolved-on",
"converted-closed-on",
"closed-on",
"closed",
"first-uk-establishment-opened-on",
"opened-on",
"voluntary-arrangement",
"receivership",
"insolvency-proceedings",
"liquidation",
"administration",
"appointment-count",
"born-on",
"registered",
"removed"
]
},
"type": "array",
"description": "An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations"
},
"address": {
"description": "The address of the company's registered office.",
"type": "object",
"items": {
"$ref": "#/definitions/search_definitions-registeredOfficeAddress"
}
}
}
},
"Search": {
"title": "Search",
"allOf": [
{
"$ref": "#/definitions/CommonSearch"
}
],
"properties": {
"kind": {
"type": "string",
"description": "The type of search response returned.",
"enum": [
"search#all"
]
},
"items": {
"type": "array",
"description": "The results of the completed search. See `items.kind` for details of each specific result resource returned.,",
"items": {
"$ref": "#/definitions/SearchItems"
}
}
}
},
"CompanySearchItems": {
"title": "CompanySearchItems",
"allOf": [
{
"$ref": "#/definitions/CommonSearchItems"
}
],
"required": [
"kind",
"title",
"address_snippet",
"links",
"company_number",
"date_of_creation",
"company_type",
"company_status",
"address"
],
"properties": {
"kind": {
"type": "string",
"description": "The type of search result.",
"enum": [
"searchresults#company"
]
},
"description_identifier": {
"items": {
"type": "string",
"enum": [
"incorporated-on",
"registered-on",
"formed-on",
"dissolved-on",
"converted-closed-on",
"closed-on",
"closed",
"first-uk-establishment-opened-on",
"opened-on",
"voluntary-arrangement",
"receivership",
"insolvency-proceedings",
"liquidation",
"administration",
"registered",
"removed"
]
},
"type": "array",
"description": "An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations"
},
"company_number": {
"type": "string",
"description": "The company registration / incorporation number of the company."
},
"date_of_creation": {
"type": "string",
"format": "date",
"description": "The date the company was created."
},
"date_of_cessation": {
"type": "string",
"format": "date",
"description": "The date the company ended."
},
"company_type": {
"type": "string",
"enum": [
"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",
"assurance-company",
"oversea-company",
"eeig",
"icvc-securities",
"icvc-warrant",
"icvc-umbrella",
"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",
"registered-overseas-entity"
],
"description": "The company type."
},
"company_status": {
"type": "string",
"enum": [
"active",
"dissolved",
"liquidation",
"receivership",
"administration",
"voluntary-arrangement",
"converted-closed",
"insolvency-proceedings",
"registered",
"removed"
],
"description": "The company status."
},
"address": {
"description": "The address of the company's registered office.",
"type": "object",
"items": {
"$ref": "#/definitions/search_definitions-registeredOfficeAddress"
}
}
}
},
"CompanySearch": {
"title": "CompanySearch",
"allOf": [
{
"$ref": "#/definitions/CommonSearch"
}
],
"properties": {
"kind": {
"type": "string",
"description": "The type of search response returned.",
"enum": [
"search#companies"
]
},
"items": {
"type": "array",
"description": "The results of the completed search.",
"items": {
"$ref": "#/definitions/CompanySearchItems"
}
}
}
},
"OfficerDateOfBirth": {
"title": "OfficerDateOfBirth",
"required": [
"month",
"year"
],
"properties": {
"month": {
"description": "The month the officer was born in.",
"type": "integer"
},
"year": {
"description": "The year the officer was born in.",
"type": "integer"
}
}
},
"OfficerAddress": {
"title": "OfficerAddress",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"care_of": {
"description": "The care of name.",
"type": "string"
},
"country": {
"description": "The country. For example UK.",
"type": "string"
},
"locality": {
"description": "The locality. For example London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code. For example CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region. For example Surrey.",
"type": "string"
}
}
},
"OfficerSearchItems": {
"title": "OfficerSearchItems",
"allOf": [
{
"$ref": "#/definitions/CommonSearchItems"
}
],
"required": [
"appointment_count",
"description",
"kind",
"title",
"address_snippet",
"address"
],
"properties": {
"kind": {
"type": "string",
"description": "Describes the type of result returned.",
"enum": [
"searchresults#officer"
]
},
"date_of_birth": {
"description": "The officer date of birth details.",
"items": {
"$ref": "#/definitions/OfficerDateOfBirth"
}
},
"appointment_count": {
"type": "integer",
"description": "The total number of appointments the officer has."
},
"description_identifiers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"appointment-count",
"born-on"
]
},
"description": "An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations."
},
"address": {
"type": "object",
"description": "The service address of the officer.",
"items": {
"$ref": "#/definitions/OfficerAddress"
}
}
}
},
"OfficerSearch": {
"title": "OfficerSearch",
"allOf": [
{
"$ref": "#/definitions/CommonSearch"
}
],
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"description": "The type of response returned.",
"enum": [
"search#officers"
]
},
"items": {
"type": "array",
"description": "The results of the completed search.",
"items": {
"$ref": "#/definitions/OfficerSearchItems"
}
}
}
},
"DisqualifiedOfficerAddress": {
"title": "DisqualifiedOfficerAddress",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"country": {
"description": "The country. For example UK.",
"type": "string"
},
"locality": {
"description": "The locality. For example London.",
"type": "string"
},
"postal_code": {
"description": "The postal code. For example CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region. For example Surrey.",
"type": "string"
}
}
},
"DisqualifiedOfficerSearchItems": {
"title": "DisqualifiedOfficerSearchItems",
"allOf": [
{
"$ref": "#/definitions/CommonSearchItems"
}
],
"required": [
"kind",
"title",
"description",
"address",
"address_snippet"
],
"properties": {
"kind": {
"type": "string",
"description": "Describes the type of result returned.",
"enum": [
"searchresults#disqualified-officer"
]
},
"date_of_birth": {
"type": "string",
"format": "date",
"description": "The disqualified officer's date of birth."
},
"description_identifiers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"born-on"
]
},
"description": "An array of enumeration types that make up the search description. See search_descriptions_raw.yaml in api-enumerations."
},
"address": {
"type": "object",
"description": "The address of the disqualified officer as provided by the disqualifying authority.",
"items": {
"$ref": "#/definitions/DisqualifiedOfficerAddress"
}
}
}
},
"DisqualifiedOfficerSearch": {
"title": "DisqualifiedOfficerSearch",
"allOf": [
{
"$ref": "#/definitions/CommonSearch"
}
],
"required": [
"kind",
"total_results",
"start_index",
"items_per_page"
],
"properties": {
"kind": {
"type": "string",
"description": "The type of response returned.",
"enum": [
"search#disqualified-officers"
]
},
"items": {
"type": "array",
"description": "The results of the completed search.",
"items": {
"$ref": "#/definitions/DisqualifiedOfficerSearchItems"
}
}
}
},
"dissolved_company_registered_office_address": {
"title": "Registered Office Address",
"description": "This will only appear if there are ROA details in the company record",
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of the address e.g Crown Way"
},
"address_line_2": {
"type": "string",
"description": "The second line of the address"
},
"locality": {
"type": "string",
"description": "The town associated to the ROA e.g Cardiff"
},
"postal_code": {
"type": "string",
"description": "The postal code e.g CF14 3UZ"
}
}
},
"previous_company_name": {
"title": "Previous company name",
"properties": {
"company_number": {
"type": "string",
"description": "The company number of the dissolved company"
},
"ceased_on": {
"type": "string",
"format": "date",
"description": "The date that the company ceased being known under the company name"
},
"effective_from": {
"type": "string",
"format": "date",
"description": "The date that the company started being known under the company name"
},
"name": {
"type": "string",
"description": "The previous name of the company"
}
}
},
"dissolvedCompany": {
"title": "Dissolved company",
"required": [
"company_name",
"company_number",
"date_of_cessation",
"date_of_creation"
],
"properties": {
"company_name": {
"type": "string",
"description": "The company name associated with the dissolved company"
},
"company_number": {
"type": "string",
"description": "The company number of the dissolved company"
},
"company_status": {
"type": "string",
"description": "The status of the company"
},
"ordered_alpha_key_with_id": {
"type": "string",
"description": "The alphakey with it's id associated with the dissolved company"
},
"kind": {
"type": "string",
"enum": [
"search-results#dissolved-company"
],
"description": "The type of search result"
},
"date_of_cessation": {
"type": "string",
"format": "date",
"description": "The date that the company was dissolved"
},
"date_of_creation": {
"type": "string",
"format": "date",
"description": "The date that the company was incorporated"
},
"registered_office_address": {
"$ref": "#/definitions/dissolved_company_registered_office_address"
},
"previous_company_names": {
"type": "array",
"items": {
"$ref": "#/definitions/previous_company_name"
}
},
"matched_previous_company_name": {
"$ref": "#/definitions/previous_company_name"
}
}
},
"dissolvedCompanySearch": {
"title": "List of dissolved companies",
"type": "object",
"allOf": [
{
"properties": {
"etag": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/dissolvedCompany"
}
},
"kind": {
"type": "string",
"enum": [
"search#alphabetical-dissolved",
"search#dissolved",
"search#previous-name-dissolved"
]
},
"top_hit": {
"allOf": [
{
"$ref": "#/definitions/dissolvedCompany"
},
{
"description": "The best matching company in dissolved search results"
}
]
},
"hits": {
"type": "string",
"description": "The number of hits returned on a best-match or previous-company-names search"
}
}
}
]
},
"alphabeticalCompany": {
"title": "Alphabetical company",
"required": [
"company_name",
"company_number",
"company_status",
"company_type",
"links"
],
"properties": {
"company_name": {
"type": "string",
"description": "The company name associated with the company"
},
"company_number": {
"type": "string",
"description": "The company number of the company"
},
"company_status": {
"type": "string",
"description": "The status of the company"
},
"ordered_alpha_key_with_id": {
"type": "string",
"description": "The alphakey with it's id associated with the company"
},
"kind": {
"type": "string",
"enum": [
"search-results#alphabetical-search"
],
"description": "The type of search result"
},
"links": {
"type": "object",
"description": "The link to the company",
"properties": {
"company_profile": {
"type": "string",
"description": "The link to the company"
}
}
},
"company_type": {
"type": "string",
"description": "The type of company associated with the company"
}
}
},
"alphabeticalCompanySearch": {
"title": "List of companies",
"type": "object",
"allOf": [
{
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/alphabeticalCompany"
}
},
"kind": {
"type": "string",
"enum": [
"search#alphabetical-search",
"search#enhanced-search"
]
},
"top_hit": {
"allOf": [
{
"$ref": "#/definitions/alphabeticalCompany"
},
{
"description": "The best matching company in alphabetical search results"
}
]
}
}
}
]
},
"advanced_company_registered_office_address": {
"title": "Registered Office Address",
"description": "This will only appear if there are ROA details in the company record",
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of the address e.g Crown Way"
},
"address_line_2": {
"type": "string",
"description": "The second line of the address"
},
"locality": {
"type": "string",
"description": "The town associated to the ROA e.g Cardiff"
},
"postal_code": {
"type": "string",
"description": "The postal code e.g CF14 3UZ"
},
"region": {
"description": "The region e.g Surrey.",
"type": "string"
},
"country": {
"description": "The country.",
"enum": [
"Wales",
"England",
"Scotland",
"Great Britain",
"Not specified",
"United Kingdom",
"Northern Ireland"
],
"type": "string"
}
}
},
"advancedCompany": {
"title": "advancedCompany",
"required": [
"company_name",
"company_number",
"company_status",
"company_type",
"date_of_creation",
"kind"
],
"properties": {
"company_name": {
"type": "string",
"description": "The company name associated with the company"
},
"company_number": {
"type": "string",
"description": "The company number of the company"
},
"company_status": {
"description": "The status of the company. \n For enumeration descriptions see `company_status` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml) ",
"type": "string",
"enum": [
"active",
"dissolved",
"open",
"closed",
"converted-closed",
"receivership",
"administration",
"liquidation",
"insolvency-proceedings",
"voluntary-arrangement",
"registered",
"removed"
]
},
"company_type": {
"description": "The type of the company. \n For enumeration descriptions see `company_type` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml) ",
"enum": [
"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"
],
"type": "string"
},
"company_subtype": {
"description": "The subtype of the company. \n For enumeration descriptions see `company_subtype` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml)",
"type": "string",
"enum": [
"community-interest-company",
"private-fund-limited-partnership"
]
},
"kind": {
"type": "string",
"enum": [
"search-results#company"
],
"description": "The type of search result"
},
"links": {
"type": "object",
"description": "The link to the company",
"properties": {
"company_profile": {
"type": "string",
"description": "The link to the company"
}
}
},
"date_of_cessation": {
"type": "string",
"format": "date",
"description": "The date that the company was dissolved"
},
"date_of_creation": {
"type": "string",
"format": "date",
"description": "The date that the company was incorporated"
},
"registered_office_address": {
"$ref": "#/definitions/advanced_company_registered_office_address"
},
"sic_codes": {
"items": {
"type": "string"
},
"type": "array",
"description": "SIC codes for this company"
}
}
},
"advancedCompanySearch": {
"title": "A list of companies",
"type": "object",
"required": [
"top_hit",
"items",
"kind",
"hits"
],
"allOf": [
{
"properties": {
"etag": {
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedCompany"
}
},
"kind": {
"type": "string",
"enum": [
"search#advanced-search"
]
},
"top_hit": {
"allOf": [
{
"$ref": "#/definitions/advancedCompany"
},
{
"description": "The best matching company in an advanced search results"
}
]
},
"hits": {
"type": "string",
"description": "The number of matches found using advanced search"
}
}
}
]
},
"address": {
"title": "address",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"care_of": {
"description": "The care of name.",
"type": "string"
},
"country": {
"description": "The country e.g. United Kingdom.",
"type": "string"
},
"locality": {
"description": "The locality e.g. London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code e.g. CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region e.g. Surrey.",
"type": "string"
}
}
},
"contactDetails": {
"title": "contactDetails",
"properties": {
"contact_name": {
"description": "The name of the contact.",
"type": "string"
}
}
},
"dateOfBirth": {
"title": "dateOfBirth",
"properties": {
"day": {
"description": "The day of the date of birth.",
"type": "integer"
},
"month": {
"description": "The month of date of birth.",
"type": "integer"
},
"year": {
"description": "The year of date of birth.",
"type": "integer"
}
},
"required": [
"month",
"year"
]
},
"officerLinkTypes": {
"title": "officerLinkTypes",
"required": [
"appointments"
],
"properties": {
"appointments": {
"description": "Link to the officer appointment resource that this appointment is associated with.",
"type": "string"
}
}
},
"itemLinkTypes": {
"title": "itemLinkTypes",
"required": [
"self",
"officer"
],
"properties": {
"self": {
"description": "Link to this individual company officer appointment resource.",
"type": "string"
},
"officer": {
"description": "Links to other officer resources associated with this officer list item.",
"items": {
"$ref": "#/definitions/officerLinkTypes"
},
"type": "object"
}
}
},
"principalOfficeAddress": {
"title": "principalOfficeAddress",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"care_of": {
"description": "The care of name.",
"type": "string"
},
"country": {
"description": "The country e.g. United Kingdom.",
"type": "string"
},
"locality": {
"description": "The locality e.g. London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code e.g. CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region e.g. Surrey.",
"type": "string"
}
}
},
"formerNames": {
"title": "formerNames",
"properties": {
"forenames": {
"description": "Former forenames of the officer.",
"type": "string"
},
"surname": {
"description": "Former surnames of the officer.",
"type": "string"
}
}
},
"corporateIdent": {
"title": "corporateIdent",
"properties": {
"identification_type": {
"description": "The officer's identity type",
"enum": [
"eea",
"non-eea",
"uk-limited-company",
"other-corporate-body-or-firm",
"registered-overseas-entity-corporate-managing-officer"
],
"type": "string"
},
"legal_authority": {
"description": "The legal authority supervising the company.",
"type": "string"
},
"legal_form": {
"description": "The legal form of the company as defined by its country of registration.",
"type": "string"
},
"place_registered": {
"description": "Place registered.",
"type": "string"
},
"registration_number": {
"description": "Company registration number.",
"type": "string"
}
}
},
"officerSummary": {
"title": "officerSummary",
"properties": {
"address": {
"description": "The correspondence address of the officer.",
"items": {
"$ref": "#/definitions/address"
},
"type": "object"
},
"appointed_on": {
"description": "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.",
"type": "string",
"format": "date"
},
"contact_details": {
"description": "The contact at the `corporate-managing-officer` of a `registered-overseas-entity`.",
"items": {
"$ref": "#/definitions/contactDetails"
},
"type": "object"
},
"country_of_residence": {
"description": "The officer's country of residence.",
"type": "string"
},
"date_of_birth": {
"description": "Details of director date of birth.",
"items": {
"$ref": "#/definitions/dateOfBirth"
},
"type": "object"
},
"links": {
"description": "Links to other resources associated with this officer list item.",
"items": {
"$ref": "#/definitions/itemLinkTypes"
},
"type": "object"
},
"name": {
"description": "Corporate or natural officer name.",
"type": "string"
},
"nationality": {
"description": "The officer's nationality.",
"type": "string"
},
"occupation": {
"description": "The officer's job title.",
"type": "string"
},
"officer_role": {
"enum": [
"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"
],
"type": "string"
},
"person_number": {
"description": "Unique person identifier as displayed in bulk products 195, 198, 208, 209 and 216.",
"type": "string"
},
"principal_office_address": {
"description": "The principal/registered office address of a `corporate-managing-officer` of a `registered-overseas-entity`.",
"items": {
"$ref": "#/definitions/principalOfficeAddress"
},
"type": "object"
},
"resigned_on": {
"description": "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.",
"type": "string",
"format": "date"
},
"responsibilities": {
"description": "The responsibilities of the managing officer of a `registered-overseas-entity`.",
"type": "string"
},
"former_names": {
"description": "Former names for the officer.",
"items": {
"$ref": "#/definitions/formerNames"
},
"type": "array"
},
"identification": {
"description": "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.",
"items": {
"$ref": "#/definitions/corporateIdent"
},
"type": "object"
},
"appointed_before": {
"description": "The date the officer was appointed before. Only present when the <code>is_pre_1992_appointment</code> attribute is <code>true</code>.",
"type": "string"
},
"etag": {
"description": "The Etag of the resource",
"type": "string"
},
"is_pre_1992_appointment": {
"description": "Indicator representing if the officer was appointed before their appointment date.",
"type": "boolean"
}
},
"required": [
"links",
"name",
"officer_role"
]
},
"linkTypes": {
"title": "linkTypes",
"required": [
"self"
],
"properties": {
"self": {
"description": "Link to this officer list resource.",
"type": "string"
}
}
},
"officerList": {
"title": "officerList",
"properties": {
"active_count": {
"description": "The number of active officers in this result set.",
"type": "integer"
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"items": {
"description": "The list of officers.",
"items": {
"$ref": "#/definitions/officerSummary"
},
"type": "array"
},
"items_per_page": {
"description": "The number of officers to return per page.",
"type": "integer"
},
"kind": {
"enum": [
"officer-list"
],
"type": "string"
},
"links": {
"description": "Links to other resources associated with this officer list resource.",
"items": {
"$ref": "#/definitions/linkTypes"
},
"type": "object"
},
"resigned_count": {
"description": "The number of resigned officers in this result set.",
"type": "integer"
},
"start_index": {
"description": "The offset into the entire result set that this page starts.",
"type": "integer"
},
"total_results": {
"description": "The total number of officers in this result set.",
"type": "integer"
}
},
"required": [
"etag",
"items_per_page",
"kind",
"links",
"items",
"start_index",
"total_results",
"active_count",
"resigned_count"
]
},
"error_values": {
"title": "error_values",
"properties": {
"<argument>": {
"type": "string",
"description": "The element name and value pair required to complete the error description, will repeat as necessary."
}
}
},
"errorDetail": {
"title": "errorDetail",
"required": [
"type",
"error"
],
"properties": {
"type": {
"type": "string",
"description": "Type of error",
"enum": [
"ch:service",
"ch:validation"
]
},
"location_type": {
"type": "string",
"description": "Describes the type of location returned so that it may be parsed appropriately",
"enum": [
"json-path",
"query-parameter"
]
},
"location": {
"type": "string",
"description": "The location in the submitted request in which the error relates. This parameter is only provided when errors[].type is set to \"ch:validation\"."
},
"error": {
"type": "string",
"description": "The error being returned. See github for valid [enumeration types](https://github.com/companieshouse/api-enumerations/blob/develop/errors.yml)"
},
"error_values": {
"type": "array",
"description": "A collection of argument name and value pairs which, when substituted into the error string, provide the full description of the error. As many name/value pairs as necessary to complete the error description are returned. See <a href=\"\">example</a> above.",
"items": {
"$ref": "#/definitions/error_values"
}
}
}
},
"error": {
"title": "error",
"required": [
"errors"
],
"properties": {
"errors": {
"type": "array",
"description": "A list of errors found",
"items": {
"$ref": "#/definitions/errorDetail"
}
}
}
},
"definitions-linksType": {
"title": "linksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
}
}
},
"linksItems": {
"title": "linksItems",
"required": [
"filing"
],
"properties": {
"filing": {
"description": "The URL of the transaction for the resource.",
"type": "string"
}
}
},
"registeredItems": {
"title": "registeredItems",
"required": [
"register_moved_to",
"moved_on",
"links"
],
"properties": {
"moved_on": {
"description": "The date registered on",
"type": "string",
"format": "date"
},
"register_moved_to": {
"description": "Location of registration",
"type": "string",
"enum": [
"public-register",
"registered-office",
"single-alternative-inspection-location",
"unspecified-location"
]
},
"links": {
"description": "A set of URLs related to the resource.",
"items": {
"$ref": "#/definitions/linksItems"
},
"type": "object"
}
}
},
"linksDirectorsRegister": {
"title": "linksDirectorsRegister",
"properties": {
"directors_register": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"registerListDirectors": {
"title": "registerListDirectors",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"directors"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksDirectorsRegister"
}
}
}
},
"linksSecretaryRegister": {
"title": "linksSecretaryRegister",
"properties": {
"secretaries_register": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"registerListSecretaries": {
"title": "registerListSecretaries",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"secretaries"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksSecretaryRegister"
}
}
}
},
"linksPersonsWithSignificantControlRegister": {
"title": "linksPersonsWithSignificantControlRegister",
"properties": {
"persons_with_significant_control_register": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"registerListPersonsWithSignificantControl": {
"title": "registerListPersonsWithSignificantControl",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"persons-with-significant-control"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksPersonsWithSignificantControlRegister"
}
}
}
},
"linksListUsualResidentialAddress": {
"title": "linksListUsualResidentialAddress",
"properties": {
"usual_residential_address": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"registerListUsualResidentialAddress": {
"title": "registerListUsualResidentialAddress",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"usual-residential-address"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksListUsualResidentialAddress"
}
}
}
},
"linksListLLPUsualResidentialAddress": {
"title": "linksListLLPUsualResidentialAddress",
"properties": {
"llp_usual_residential_address": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"registerListLLPUsualResidentialAddress": {
"title": "registerListLLPUsualResidentialAddress",
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"llp-usual-residential-address"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"items": {
"$ref": "#/definitions/linksListLLPUsualResidentialAddress"
},
"type": "object"
}
},
"required": [
"register_type",
"items"
]
},
"linksListMembers": {
"title": "linksListMembers",
"properties": {
"members": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"registerListMembers": {
"title": "registerListMembers",
"required": [
"register_type",
"items"
],
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"members"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"type": "object",
"items": {
"$ref": "#/definitions/linksListMembers"
}
}
}
},
"linksListLLPMembers": {
"title": "linksListLLPMembers",
"properties": {
"llp_members": {
"description": "The URL for the resource.",
"type": "string"
}
}
},
"registerListLLPMembers": {
"title": "registerListLLPMembers",
"properties": {
"register_type": {
"description": "The register type.",
"enum": [
"llp-members"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/definitions/registeredItems"
},
"type": "array"
},
"links": {
"description": "A set of URLs related to the resource.",
"items": {
"$ref": "#/definitions/linksListLLPMembers"
},
"type": "object"
}
},
"required": [
"register_type",
"items"
]
},
"registers": {
"title": "registers",
"description": "Registered company information",
"type": "object",
"required": [
"directors",
"secretaries",
"persons_with_significant_control",
"usual_residential_address",
"members"
],
"properties": {
"directors": {
"description": "List of registered company directors.",
"items": {
"$ref": "#/definitions/registerListDirectors"
}
},
"secretaries": {
"description": "List of registered company secretaries.",
"items": {
"$ref": "#/definitions/registerListSecretaries"
}
},
"persons_with_significant_control": {
"description": "List of registered company persons with significant control.",
"items": {
"$ref": "#/definitions/registerListPersonsWithSignificantControl"
}
},
"usual_residential_address": {
"description": "List of register addresses.",
"items": {
"$ref": "#/definitions/registerListUsualResidentialAddress"
}
},
"llp_usual_residential_address": {
"description": "List of register addresses.",
"items": {
"$ref": "#/definitions/registerListLLPUsualResidentialAddress"
}
},
"members": {
"description": "List of registered company members..",
"items": {
"$ref": "#/definitions/registerListMembers"
}
},
"llp_members": {
"description": "List of registered llp members.",
"items": {
"$ref": "#/definitions/registerListLLPMembers"
}
}
}
},
"companyRegister": {
"title": "companyRegister",
"type": "object",
"required": [
"links",
"company_number",
"kind",
"registers"
],
"properties": {
"links": {
"type": "object",
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/definitions-linksType"
}
},
"company_number": {
"type": "string",
"description": "The number of the company."
},
"kind": {
"enum": [
"registers"
],
"type": "string"
},
"registers": {
"description": "company registers information.",
"items": {
"$ref": "#/definitions/registers"
}
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
}
}
},
"annotation": {
"title": "annotation",
"required": [
"date",
"description"
],
"properties": {
"annotation": {
"description": "The annotation text.",
"type": "string"
},
"date": {
"type": "string",
"format": "date",
"description": "The date the annotation was added."
},
"description": {
"type": "string",
"description": "A description of the annotation.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/filing_history_descriptions.yml) file."
}
}
},
"associatedFiling": {
"title": "associatedFiling",
"required": [
"date",
"description",
"type"
],
"properties": {
"date": {
"description": "The date the associated filing was processed.",
"type": "string",
"format": "date"
},
"description": {
"type": "string",
"description": "A description of the associated filing.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/filing_history_descriptions.yml) file."
},
"type": {
"description": "The type of the associated filing.",
"type": "string"
}
}
},
"filingHistoryItemLinks": {
"title": "filingHistoryItemLinks",
"properties": {
"self": {
"description": "Link to this filing history item.",
"type": "string"
},
"document_metadata": {
"description": "Link to the document metadata associated with this filing history item. See the Document API documentation for more details.",
"type": "string"
}
}
},
"resolution": {
"title": "resolution",
"required": [
"category",
"description",
"receive_date",
"subcategory",
"type"
],
"properties": {
"category": {
"description": "The category of the resolution filed.",
"enum": [
"miscellaneous"
],
"type": "string"
},
"description": {
"description": "A description of the associated filing.\n For enumeration descriptions see `description` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/filing_history_descriptions.yml) file.",
"type": "string"
},
"document_id": {
"description": "The document id of the resolution.",
"type": "string"
},
"receive_date": {
"description": "The date the resolution was processed.",
"type": "string",
"format": "date"
},
"subcategory": {
"description": "The sub-category of the document filed.",
"enum": [
"resolution"
],
"type": "string"
},
"type": {
"description": "The type of the associated filing.",
"type": "string"
}
}
},
"filingHistoryItem": {
"title": "filingHistoryItem",
"required": [
"category",
"date",
"description",
"type",
"transaction_id"
],
"properties": {
"annotations": {
"description": "Annotations for the filing",
"items": {
"$ref": "#/definitions/annotation"
},
"type": "array"
},
"associated_filings": {
"description": "Any filings associated with the current item",
"items": {
"$ref": "#/definitions/associatedFiling"
},
"type": "array"
},
"barcode": {
"description": "The barcode of the document.",
"type": "string"
},
"transaction_id": {
"description": "The transaction ID of the filing.",
"type": "string"
},
"category": {
"description": "The category of the document filed.",
"enum": [
"accounts",
"address",
"annual-return",
"capital",
"change-of-name",
"incorporation",
"liquidation",
"miscellaneous",
"mortgage",
"officers",
"resolution"
],
"type": "string"
},
"date": {
"description": "The date the filing was processed.",
"type": "string",
"format": "date"
},
"description": {
"description": "A description of the filing.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/filing_history_descriptions.yml) file.",
"type": "string"
},
"links": {
"description": "Links to other resources associated with this filing history item.",
"type": "object",
"items": {
"$ref": "#/definitions/filingHistoryItemLinks"
}
},
"pages": {
"description": "Number of pages within the PDF document (links.document_metadata)",
"type": "integer"
},
"paper_filed": {
"description": "If true, indicates this is a paper filing.",
"type": "boolean"
},
"resolutions": {
"description": "Resolutions for the filing",
"items": {
"$ref": "#/definitions/resolution"
},
"type": "array"
},
"subcategory": {
"description": "The sub-category of the document filed.",
"enum": [
"resolution"
],
"type": "string"
},
"type": {
"description": "The type of filing.",
"type": "string"
}
}
},
"filingHistoryList": {
"title": "filingHistoryList",
"required": [
"etag",
"items",
"items_per_page",
"kind",
"start_index",
"total_count"
],
"properties": {
"filing_history_status": {
"description": "The status of this filing history.",
"type": "string",
"enum": [
"filing-history-available"
]
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"items": {
"description": "The filing history items.",
"items": {
"$ref": "#/definitions/filingHistoryItem"
},
"type": "array"
},
"items_per_page": {
"description": "The number of filing history items returned per page.",
"type": "integer"
},
"kind": {
"description": "Indicates this resource is a filing history.",
"enum": [
"filing-history"
],
"type": "string"
},
"start_index": {
"description": "The index into the entire result set that this result page starts.",
"type": "integer"
},
"total_count": {
"description": "The total number of filing history items for this company.",
"type": "integer"
}
}
},
"exemptions_definitions-linksType": {
"properties": {
"self": {
"description": "The URL of this resource.",
"type": "string"
}
},
"required": [
"self"
]
},
"exemptionItem": {
"properties": {
"exempt_from": {
"description": "Exemption valid from.",
"type": "string",
"format": "date"
},
"exempt_to": {
"description": "Exemption valid to.",
"type": "string",
"format": "date"
}
},
"required": [
"exempt_from"
]
},
"pscExemptAsTradingOnRegulatedMarketItem": {
"properties": {
"items": {
"type": "array",
"description": "List of dates",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"type": "string",
"enum": [
"psc-exempt-as-trading-on-regulated-market"
]
}
},
"required": [
"exemption_type",
"items"
]
},
"pscExemptAsSharesAdmittedOnMarketItem": {
"required": [
"exemption_type",
"items"
],
"properties": {
"items": {
"description": "List of dates",
"type": "array",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"psc-exempt-as-shares-admitted-on-market"
],
"type": "string"
}
}
},
"pscExemptAsTradingOnUkRegualatedMarketItem": {
"required": [
"exemption_type",
"items"
],
"properties": {
"items": {
"description": "List of dates",
"type": "array",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"psc-exempt-as-trading-on-uk-regulated-market"
],
"type": "string"
}
}
},
"pscExemptAsTradingOnEuRegualatedMarketItem": {
"required": [
"exemption_type",
"items"
],
"properties": {
"items": {
"description": "List of dates",
"type": "array",
"items": {
"$ref": "#/definitions/exemptionItem"
}
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"psc-exempt-as-trading-on-eu-regulated-market"
],
"type": "string"
}
}
},
"diclosureTransparencyRulesChapterFiveAppliesItem": {
"properties": {
"items": {
"description": "List of exemption periods.",
"items": {
"$ref": "#/definitions/exemptionItem"
},
"type": "array"
},
"exemption_type": {
"description": "The exemption type.",
"enum": [
"disclosure-transparency-rules-chapter-five-applies"
],
"type": "string"
}
},
"required": [
"exemption_type",
"items"
]
},
"exemptions": {
"description": "Exemptions information.",
"properties": {
"psc_exempt_as_trading_on_regulated_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on a regulated market other than the UK.",
"items": {
"$ref": "#/definitions/pscExemptAsTradingOnRegulatedMarketItem"
}
},
"psc_exempt_as_shares_admitted_on_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on a market listed in the Register of People with Significant Control Regulations 2016.",
"items": {
"$ref": "#/definitions/pscExemptAsSharesAdmittedOnMarketItem"
}
},
"psc_exempt_as_trading_on_uk_regulated_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on a UK regulated market.",
"items": {
"$ref": "#/definitions/pscExemptAsTradingOnUkRegualatedMarketItem"
}
},
"psc_exempt_as_trading_on_eu_regulated_market": {
"description": "If present the company has been or is exempt from keeping a PSC register, as it has voting shares admitted to trading on an EU regulated market.",
"items": {
"$ref": "#/definitions/pscExemptAsTradingOnEuRegualatedMarketItem"
}
},
"disclosure_transparency_rules_chapter_five_applies": {
"description": "If present the company has been or is exempt from keeping a PSC register, because it is a DTR issuer and the shares are admitted to trading on a regulated market.",
"items": {
"$ref": "#/definitions/diclosureTransparencyRulesChapterFiveAppliesItem"
}
}
}
},
"companyExemptions": {
"title": "companyExemptions",
"required": [
"links",
"kind",
"etag",
"exemptions"
],
"properties": {
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/exemptions_definitions-linksType"
},
"type": "array"
},
"kind": {
"type": "string",
"enum": [
"exemptions"
]
},
"etag": {
"type": "string",
"description": "The ETag of the resource."
},
"exemptions": {
"description": "Company exemptions information.",
"items": {
"$ref": "#/definitions/exemptions"
}
}
}
},
"links": {
"title": "links",
"properties": {
"self": {
"description": "Link to this disqualification resource.",
"type": "string"
}
},
"required": [
"self"
]
},
"definitions-address": {
"title": "address",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"country": {
"description": "The country. For example, UK.",
"type": "string"
},
"locality": {
"description": "The locality. For example London.",
"type": "string"
},
"postal_code": {
"description": "The postal code. For example CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region. For example Surrey.",
"type": "string"
}
}
},
"last_variation": {
"title": "last_variation",
"properties": {
"varied_on": {
"description": "The date the variation was made against the disqualification.",
"type": "string",
"format": "date"
},
"case_identifier": {
"description": "The case identifier of the variation.",
"type": "string"
},
"court_name": {
"description": "The name of the court that handled the variation case.",
"type": "string"
}
}
},
"reason": {
"title": "reason",
"properties": {
"description_identifier": {
"description": "An enumeration type that provides the description for the reason of disqualification.\n For enumeration descriptions see `description_identifier` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/disqualified_officer_descriptions.yml)",
"type": "string"
},
"act": {
"description": "An enumeration type that provides the law under which the disqualification was made.\n For enumeration descriptions see `act` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/disqualified_officer_descriptions.yml)",
"type": "string"
},
"article": {
"description": "The article of the act under which the disqualification was made.\n Only applicable if `reason.act` is `company-directors-disqualification-northern-ireland-order-2002`.",
"type": "string"
},
"section": {
"description": "The section of the act under which the disqualification was made.\n Only applicable if `reason.act` is `company-directors-disqualification-act-1986` or `sanctions-anti-money-laundering-act-2018`.",
"type": "string"
}
},
"required": [
"description_identifier",
"act"
]
},
"disqualification": {
"title": "disqualification",
"properties": {
"case_identifier": {
"description": "The case identifier of the disqualification.",
"type": "string"
},
"address": {
"description": "The address of the disqualified officer as provided by the disqualifying authority.",
"type": "object",
"items": {
"$ref": "#/definitions/definitions-address"
}
},
"company_names": {
"description": "The companies in which the misconduct took place.",
"type": "array",
"items": {
"type": "string"
}
},
"court_name": {
"description": "The name of the court that handled the disqualification case.",
"type": "string"
},
"disqualification_type": {
"description": "An enumeration type that provides the disqualifying authority that handled the disqualification case.\n For enumeration descriptions see `disqualification_type` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/disqualified_officer_descriptions.yml)",
"type": "string"
},
"disqualified_from": {
"description": "The date that the disqualification starts.",
"type": "string",
"format": "date"
},
"disqualified_until": {
"description": "The date that the disqualification ends.",
"type": "string",
"format": "date"
},
"heard_on": {
"description": "The date the disqualification hearing was on.",
"type": "string",
"format": "date"
},
"undertaken_on": {
"description": "The date the disqualification undertaking was agreed on.",
"type": "string",
"format": "date"
},
"last_variation": {
"description": "The latest variation made to the disqualification.",
"type": "array",
"items": {
"$ref": "#/definitions/last_variation"
}
},
"reason": {
"description": "The reason for the disqualification.",
"type": "object",
"items": {
"$ref": "#/definitions/reason"
}
}
},
"required": [
"address",
"disqualification_type",
"disqualified_from",
"disqualified_until",
"reason"
]
},
"permission_to_act": {
"title": "permission_to_act",
"required": [
"expires_on",
"granted_on"
],
"properties": {
"company_names": {
"description": "The companies for which the disqualified officer has permission to act.",
"type": "array",
"items": {
"type": "string"
}
},
"court_name": {
"description": "The name of the court that granted the permission to act.",
"type": "string"
},
"expires_on": {
"description": "The date that the permission ends.",
"type": "string",
"format": "date"
},
"granted_on": {
"description": "The date that the permission starts.",
"type": "string",
"format": "date"
}
}
},
"naturalDisqualification": {
"title": "naturalDisqualification",
"required": [
"disqualifications",
"etag",
"kind",
"links",
"surname"
],
"properties": {
"date_of_birth": {
"description": "The disqualified officer's date of birth.",
"type": "string",
"format": "date"
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"forename": {
"description": "The forename of the disqualified officer.",
"type": "string"
},
"honours": {
"description": "The honours that the disqualified officer has.",
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"natural-disqualification"
]
},
"nationality": {
"description": "The nationality of the disqualified officer.",
"type": "string"
},
"other_forenames": {
"description": "The other forenames of the disqualified officer.",
"type": "string"
},
"surname": {
"description": "The surname of the disqualified officer.",
"type": "string"
},
"title": {
"description": "The title of the disqualified officer.",
"type": "string"
},
"links": {
"description": "Links to other resources associated with this officer disqualification resource.",
"type": "object",
"items": {
"$ref": "#/definitions/links"
}
},
"disqualifications": {
"description": "The officer's disqualifications.",
"type": "array",
"items": {
"$ref": "#/definitions/disqualification"
}
},
"permissions_to_act": {
"description": "Permissions to act that have been granted for the disqualified officer.",
"type": "array",
"items": {
"$ref": "#/definitions/permission_to_act"
}
},
"person_number": {
"description": "The disqualified officer's person number.",
"type": "string"
}
}
},
"corporateDisqualification": {
"title": "corporateDisqualification",
"required": [
"disqualifications",
"etag",
"kind",
"links",
"name"
],
"properties": {
"company_number": {
"description": "The registration number of the disqualified officer.",
"type": "string"
},
"country_of_registration": {
"description": "The country in which the disqualified officer was registered.",
"type": "string"
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"corporate-disqualification"
]
},
"name": {
"description": "The name of the disqualified officer.",
"type": "string"
},
"links": {
"description": "Links to other resources associated with this officer disqualification resource.",
"type": "object",
"items": {
"$ref": "#/definitions/links"
}
},
"disqualifications": {
"description": "The officer's disqualifications.",
"type": "array",
"items": {
"$ref": "#/definitions/disqualification"
}
},
"permissions_to_act": {
"description": "Permissions that the disqualified officer has to act outside of their disqualification.",
"type": "array",
"items": {
"$ref": "#/definitions/permission_to_act"
}
},
"person_number": {
"description": "The disqualified officer's person number.",
"type": "string"
}
}
},
"definitions-dateOfBirth": {
"title": "dateOfBirth",
"properties": {
"month": {
"description": "The month the officer was born in.",
"type": "integer"
},
"year": {
"description": "The year the officer was born in.",
"type": "integer"
}
},
"required": [
"month",
"year"
]
},
"officerAppointmentList_definitions-address": {
"title": "address",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"care_of": {
"description": "The care of name.",
"type": "string"
},
"country": {
"description": "The country. For example, UK.",
"type": "string"
},
"locality": {
"description": "The locality. For example London.",
"type": "string"
},
"po_box": {
"description": "The post-office box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code. For example CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region. For example Surrey.",
"type": "string"
}
}
},
"appointedTo": {
"title": "appointedTo",
"properties": {
"company_name": {
"description": "The name of the company the officer is acting for.",
"type": "string"
},
"company_number": {
"description": "The number of the company the officer is acting for.",
"type": "string"
},
"company_status": {
"description": "The status of the company the officer is acting for.",
"type": "string"
}
},
"required": [
"company_number"
]
},
"appointmentLinkTypes": {
"title": "appointmentLinkTypes",
"required": [
"company"
],
"properties": {
"company": {
"description": "Link to the company profile resource that this appointment is associated with.",
"type": "string"
}
}
},
"nameElements": {
"title": "nameElements",
"properties": {
"forename": {
"description": "The forename of the officer.",
"type": "string"
},
"title": {
"description": "Title of the officer.",
"type": "string"
},
"other_forenames": {
"description": "Other forenames of the officer.",
"type": "string"
},
"surname": {
"description": "The surname of the officer.",
"type": "string"
},
"honours": {
"description": "Honours an officer might have.",
"type": "string"
}
},
"required": [
"surname"
]
},
"officerAppointmentSummary": {
"title": "officerAppointmentSummary",
"properties": {
"address": {
"description": "The correspondence address of the officer.",
"items": {
"$ref": "#/definitions/officerAppointmentList_definitions-address"
},
"type": "object"
},
"appointed_before": {
"description": "The date the officer was appointed before. Only present when the `is_pre_1992_appointment` attribute is `true`.",
"type": "string",
"format": "date"
},
"appointed_on": {
"description": "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.",
"type": "string",
"format": "date"
},
"appointed_to": {
"description": "The company information of the appointment.",
"items": {
"$ref": "#/definitions/appointedTo"
},
"type": "object"
},
"contact_details": {
"description": "The contact at the `corporate-managing-officer` of a `registered-overseas-entity`.",
"items": {
"$ref": "#/definitions/contactDetails"
},
"type": "object"
},
"name": {
"description": "The full name of the officer.",
"type": "string"
},
"country_of_residence": {
"description": "The officer's country of residence.",
"type": "string"
},
"former_names": {
"description": "Former names for the officer, if there are any.",
"items": {
"$ref": "#/definitions/formerNames"
},
"type": "array"
},
"identification": {
"description": "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.",
"items": {
"$ref": "#/definitions/corporateIdent"
},
"type": "object"
},
"is_pre_1992_appointment": {
"description": "Indicator representing if the officer was appointed before their appointment date.",
"type": "boolean"
},
"links": {
"description": "Links to other resources associated with this officer appointment item.",
"type": "object",
"items": {
"$ref": "#/definitions/appointmentLinkTypes"
}
},
"name_elements": {
"description": "A document encapsulating the separate elements of a natural officer's name.",
"type": "object",
"items": {
"$ref": "#/definitions/nameElements"
}
},
"nationality": {
"description": "The officer's nationality.",
"type": "string"
},
"occupation": {
"description": "The officer's occupation.",
"type": "string"
},
"officer_role": {
"enum": [
"cic-manager",
"corporate-director",
"corporate-llp-designated-member",
"corporate-llp-member",
"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",
"judicial-factor",
"llp-designated-member",
"llp-member",
"managing-officer",
"member-of-a-management-organ",
"member-of-a-supervisory-organ",
"member-of-an-administrative-organ",
"nominee-director",
"nominee-secretary",
"receiver-and-manager",
"secretary"
],
"type": "string"
},
"principal_office_address": {
"description": "The principal/registered office address of a `corporate-managing-officer` of a `registered-overseas-entity`.",
"items": {
"$ref": "#/definitions/officerAppointmentList_definitions-address"
},
"type": "object"
},
"resigned_on": {
"description": "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.",
"type": "string",
"format": "date"
},
"responsibilities": {
"description": "The responsibilities of the managing officer of a `registered-overseas-entity`.",
"type": "string"
}
},
"required": [
"appointed_to",
"links",
"name",
"officer_role"
]
},
"definitions-officerLinkTypes": {
"title": "officerLinkTypes",
"required": [
"self"
],
"properties": {
"self": {
"description": "Link to this officer appointment resource.",
"type": "string"
}
}
},
"appointmentList": {
"title": "appointmentList",
"properties": {
"date_of_birth": {
"description": "The officer's date of birth details.",
"items": {
"$ref": "#/definitions/definitions-dateOfBirth"
},
"type": "object"
},
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"is_corporate_officer": {
"description": "Indicator representing if the officer is a corporate body.",
"type": "boolean"
},
"items": {
"description": "The list of officer appointments.",
"type": "array",
"items": {
"$ref": "#/definitions/officerAppointmentSummary"
}
},
"items_per_page": {
"description": "The number of officer appointments to return per page.",
"type": "integer"
},
"kind": {
"enum": [
"personal-appointment"
],
"type": "string"
},
"links": {
"description": "Links to other resources associated with this officer appointment resource.",
"items": {
"$ref": "#/definitions/definitions-officerLinkTypes"
},
"type": "object"
},
"name": {
"description": "The corporate or natural officer name.",
"type": "string"
},
"start_index": {
"description": "The first row of data to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the `items_per_page` parameter.",
"type": "integer"
},
"total_results": {
"description": "The total number of officer appointments in this result set.",
"type": "integer"
}
},
"required": [
"etag",
"is_corporate_officer",
"items",
"items_per_page",
"kind",
"links",
"name",
"start_index",
"total_results"
]
},
"classificationDesc": {
"title": "classificationDesc",
"required": [
"type",
"description"
],
"properties": {
"type": {
"enum": [
"charge-description",
"nature-of-charge"
],
"type": "string",
"description": "The type of charge classication.\n For enumeration descriptions see `classificationDesc` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/mortgage_descriptions.yml)"
},
"description": {
"type": "string",
"description": "Details of the charge classification"
}
}
},
"particularDesc": {
"title": "particularDesc",
"required": [
"type",
"description"
],
"properties": {
"type": {
"enum": [
"short-particulars",
"charged-property-description",
"charged-property-or-undertaking-description",
"brief-description"
],
"type": "string",
"description": "The type of charge particulars.\n For enumeration descriptions see `particular-description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/mortgage_descriptions.yml)"
},
"description": {
"type": "string",
"description": "Details of charge particulars"
},
"contains_floating_charge": {
"type": "boolean",
"description": "The charge contains a floating charge"
},
"contains_fixed_charge": {
"type": "boolean",
"description": "The charge contains a fixed charge"
},
"floating_charge_covers_all": {
"type": "boolean",
"description": "The floating charge covers all the property or undertaking or the company"
},
"contains_negative_pledge": {
"type": "boolean",
"description": "The charge contains a negative pledge"
},
"chargor_acting_as_bare_trustee": {
"type": "boolean",
"description": "The chargor is acting as a bare trustee for the property"
}
}
},
"securedDetailsDesc": {
"title": "securedDetailsDesc",
"required": [
"type",
"description"
],
"properties": {
"type": {
"enum": [
"amount-secured",
"obligations-secured"
],
"type": "string",
"description": "The type of secured details.\n For enumeration descriptions see `secured-details-description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/mortgage_descriptions.yml)"
},
"description": {
"type": "string",
"description": "Details of the amount or obligation secured by the charge"
}
}
},
"alterationsDesc": {
"title": "alterationsDesc",
"required": [
"type",
"description"
],
"properties": {
"has_alterations_to_order": {
"type": "boolean",
"description": "The charge has alterations to order"
},
"has_alterations_to_prohibitions": {
"type": "boolean",
"description": "The charge has alterations to prohibitions"
},
"has_alterations_to_provisions": {
"type": "boolean",
"description": "The charge has provisions restricting the creation of further charges"
}
}
},
"persons_entitled": {
"title": "persons_entitled",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the person entitled."
}
}
},
"transaction_links": {
"title": "transaction_links",
"properties": {
"filing": {
"type": "string",
"description": "Link to the charge filing data"
},
"insolvency_case": {
"type": "string",
"description": "Link to the insolvency case related to this filing"
}
}
},
"transactions": {
"title": "transactions",
"properties": {
"filing_type": {
"type": "string",
"description": "Filing type which created, updated or satisfied the charge"
},
"delivered_on": {
"type": "string",
"format": "date",
"description": "The date the filing was submitted to Companies House"
},
"insolvency_case_number": {
"type": "string",
"description": "The insolvency case related to this filing"
},
"links": {
"type": "array",
"description": "The resources related to this filing",
"items": {
"$ref": "#/definitions/transaction_links"
}
}
}
},
"insolvency_case_links": {
"title": "insolvency_case_links",
"properties": {
"case": {
"type": "string",
"description": "Link to the insolvency case data"
}
}
},
"insolvency_cases": {
"title": "insolvency_cases",
"properties": {
"case_number": {
"type": "string",
"description": "The number of this insolvency case"
},
"links": {
"type": "array",
"description": "The resources related to this insolvency case",
"items": {
"$ref": "#/definitions/insolvency_case_links"
}
}
}
},
"charge_links": {
"title": "charge_links",
"required": [
"self"
],
"properties": {
"self": {
"type": "string",
"description": "Link to the this charge data"
}
}
},
"chargeDetails": {
"title": "chargeDetails",
"required": [
"etag",
"status",
"classification",
"charge_number",
"id"
],
"properties": {
"etag": {
"type": "string"
},
"id": {
"type": "string",
"description": "The id of the charge"
},
"charge_code": {
"type": "string",
"description": "The charge code is a replacement of the mortgage description"
},
"classification": {
"type": "array",
"description": "Classification information",
"items": {
"$ref": "#/definitions/classificationDesc"
}
},
"charge_number": {
"type": "integer",
"description": "The charge number is used to reference an individual charge"
},
"status": {
"enum": [
"outstanding",
"fully-satisfied",
"part-satisfied",
"satisfied"
],
"type": "string",
"description": "The status of the charge.\n For enumeration descriptions see `status` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/mortgage_descriptions.yml)"
},
"assests_ceased_released": {
"enum": [
"property-ceased-to-belong",
"part-property-release-and-ceased-to-belong",
"part-property-released",
"part-property-ceased-to-belong",
"whole-property-released",
"multiple-filings",
"whole-property-released-and-ceased-to-belong"
],
"type": "string",
"description": "Cease/release information about the charge.\n For enumeration descriptions see `assets-ceased-released` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/mortgage_descriptions.yml)"
},
"acquired_on": {
"type": "string",
"format": "date",
"description": "The date the property or undertaking was acquired on"
},
"delivered_on": {
"type": "string",
"format": "date",
"description": "The date the charge was submitted to Companies House"
},
"resolved_on": {
"type": "string",
"format": "date",
"description": "The date the issue was resolved on"
},
"covering_instrument_date": {
"type": "string",
"format": "date",
"description": "The date by which the series of debentures were created"
},
"created_on": {
"type": "string",
"format": "date",
"description": "The date the charge was created"
},
"satisfied_on": {
"type": "string",
"format": "date",
"description": "The date the charge was satisfied"
},
"particulars": {
"type": "array",
"description": "Details of charge or undertaking",
"items": {
"$ref": "#/definitions/particularDesc"
}
},
"secured_details": {
"type": "array",
"description": "Information about what is secured against this charge",
"items": {
"$ref": "#/definitions/securedDetailsDesc"
}
},
"scottish_alterations": {
"type": "array",
"items": {
"$ref": "#/definitions/alterationsDesc"
},
"description": "Information about alterations for Scottish companies"
},
"more_than_four_persons_entitled": {
"type": "boolean",
"description": "Charge has more than four person entitled"
},
"persons_entitled": {
"type": "array",
"description": "People that are entitled to the charge",
"items": {
"$ref": "#/definitions/persons_entitled"
}
},
"transactions": {
"type": "array",
"description": "Transactions that have been filed for the charge.",
"items": {
"$ref": "#/definitions/transactions"
}
},
"insolvency_cases": {
"type": "array",
"description": "Transactions that have been filed for the charge.",
"items": {
"$ref": "#/definitions/insolvency_cases"
}
},
"links": {
"type": "array",
"description": "The resources related to this charge",
"items": {
"$ref": "#/definitions/charge_links"
}
}
}
},
"chargeList": {
"title": "chargeList",
"required": [
"etag",
"items"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"total_count": {
"type": "integer",
"description": "Total number of charges returned by the API (filtering applies)."
},
"unfiletered_count": {
"type": "integer",
"description": "Number of satisfied charges"
},
"satisfied_count": {
"type": "integer",
"description": "Number of satisfied charges"
},
"part_satisfied_count": {
"type": "integer",
"description": "Number of satisfied charges"
},
"items": {
"type": "array",
"description": "List of charges",
"items": {
"$ref": "#/definitions/chargeDetails"
}
}
}
},
"caseDates": {
"title": "caseDates",
"required": [
"type",
"date"
],
"properties": {
"type": {
"type": "string",
"description": "Describes what date is represented by the associated `date` element.\n For enumeration descriptions see `insolvency_case_date_type` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml).",
"enum": [
"instrumented-on",
"administration-started-on",
"administration-discharged-on",
"administration-ended-on",
"concluded-winding-up-on",
"petitioned-on",
"ordered-to-wind-up-on",
"due-to-be-dissolved-on",
"case-end-on",
"wound-up-on",
"voluntary-arrangement-started-on",
"voluntary-arrangement-ended-on",
"moratorium-started-on",
"moratorium-ended-on",
"declaration-solvent-on"
]
},
"date": {
"type": "string",
"format": "date",
"description": "The case date, described by `date_type`."
}
}
},
"practitionerAddress": {
"title": "practitionerAddress",
"required": [
"address_line_1"
],
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of the address."
},
"address_line_2": {
"type": "string",
"description": "The second line of the address."
},
"locality": {
"type": "string",
"description": "The locality. For example London."
},
"region": {
"type": "string",
"description": "The region. For example Surrey."
},
"postal_code": {
"type": "string",
"description": "The postal code. For example CF14 3UZ."
},
"country": {
"type": "string",
"description": "The country."
}
}
},
"practitioners": {
"title": "practitioners",
"required": [
"name",
"address"
],
"properties": {
"name": {
"description": "The name of the practitioner.",
"type": "string"
},
"address": {
"type": "array",
"description": "The practitioners' address.",
"items": {
"$ref": "#/definitions/practitionerAddress"
}
},
"appointed_on": {
"type": "string",
"format": "date",
"description": "The date the practitioner was appointed on."
},
"ceased_to_act_on": {
"type": "string",
"format": "date",
"description": "The date the practitioner ceased to act for the case."
},
"role": {
"type": "string",
"description": "The type of role.",
"enum": [
"final-liquidator",
"receiver",
"receiver-manager",
"proposed-liquidator",
"provisional-liquidator",
"administrative-receiver",
"practitioner",
"interim-liquidator"
]
}
}
},
"definitions-links": {
"title": "links",
"properties": {
"charge": {
"type": "string",
"description": "The link to the charge this case is lodged against."
}
}
},
"case": {
"title": "case",
"required": [
"type",
"dates",
"practitioners"
],
"properties": {
"type": {
"type": "string",
"enum": [
"compulsory-liquidation",
"creditors-voluntary-liquidation",
"members-voluntary-liquidation",
"in-administration",
"corporate-voluntary-arrangement",
"corporate-voluntary-arrangement-moratorium",
"administration-order",
"receiver-manager",
"administrative-receiver",
"receivership",
"foreign-insolvency",
"moratorium"
],
"description": "The type of case.\n For enumeration descriptions see `insolvency_case_type` section in the [enumeration mappings] (https://github.com/companieshouse/api-enumerations/blob/master/constants.yml)."
},
"dates": {
"type": "array",
"description": "The dates specific to the case.",
"items": {
"$ref": "#/definitions/caseDates"
}
},
"notes": {
"type": "array",
"description": "The dates specific to the case.",
"items": {
"type": "string"
}
},
"practitioners": {
"type": "array",
"description": "The practitioners for the case.",
"items": {
"$ref": "#/definitions/practitioners"
}
},
"links": {
"type": "object",
"description": "The practitioners for the case.",
"items": {
"$ref": "#/definitions/definitions-links"
}
},
"number": {
"type": "string",
"description": "The case number."
}
}
},
"companyInsolvency": {
"title": "companyInsolvency",
"required": [
"etag",
"cases"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"cases": {
"type": "array",
"description": "List of insolvency cases.",
"items": {
"$ref": "#/definitions/case"
}
},
"status": {
"type": "string",
"description": "Company insolvency status details",
"enum": [
"administration-order",
"administrative-receiver",
"in-administration",
"liquidation",
"live-receiver-manager-on-at-least-one-charge",
"receivership",
"receiver-manager",
"voluntary-arrangement",
"voluntary-arrangement-receivership"
]
}
}
},
"self_links": {
"title": "self_links",
"required": [
"self"
],
"properties": {
"self": {
"type": "string",
"description": "Link to this company."
}
}
},
"companyUKEstablishments_definitions-links": {
"title": "links",
"required": [
"company"
],
"properties": {
"company": {
"type": "string",
"description": "The link to the company."
}
}
},
"companyDetails": {
"title": "companyDetails",
"required": [
"company_number",
"company_name",
"company_status",
"links"
],
"properties": {
"company_number": {
"type": "string",
"description": "The number of the company."
},
"company_name": {
"type": "string",
"description": "The name of the company."
},
"company_status": {
"type": "string",
"description": "Company status."
},
"locality": {
"type": "string",
"description": "The locality e.g London."
},
"links": {
"description": "Resources related to this company.",
"type": "object",
"items": {
"$ref": "#/definitions/companyUKEstablishments_definitions-links"
}
}
}
},
"companyUKEstablishments": {
"title": "companyUKEstablishments",
"required": [
"etag",
"kind",
"items"
],
"properties": {
"etag": {
"type": "string",
"description": "The ETag of the resource."
},
"kind": {
"type": "string",
"description": "UK Establishment companies.",
"enum": [
"ukestablishment-companies"
]
},
"links": {
"type": "object",
"description": "UK Establishment Resources related to this company.",
"items": {
"$ref": "#/definitions/self_links"
}
},
"items": {
"type": "array",
"description": "List of UK Establishment companies.",
"items": {
"$ref": "#/definitions/companyDetails"
}
}
}
},
"definitions-nameElements": {
"title": "nameElements",
"properties": {
"forename": {
"description": "The forename of the person with significant control.",
"type": "string"
},
"title": {
"description": "Title of the person with significant control.",
"type": "string"
},
"middle_name": {
"description": "The middle name of the person with significant control.",
"type": "string"
},
"surname": {
"description": "The surname of the person with significant control.",
"type": "string"
}
},
"required": [
"surname"
]
},
"pscLinksType": {
"title": "pscLinksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
},
"statement": {
"description": "The URL of the statement linked to this person with significant control.",
"type": "string"
}
}
},
"pscListIdent": {
"title": "pscListIdent",
"properties": {
"legal_authority": {
"description": "The legal authority supervising the corporate entity or legal person with significant control.",
"type": "string"
},
"legal_form": {
"description": "The legal form of the corporate entity or legal person with significant control as defined by its country of registration.",
"type": "string"
},
"place_registered": {
"description": "The place the corporate entity with significant control is registered.",
"type": "string"
},
"registration_number": {
"description": "The registration number of the corporate entity with significant control.",
"type": "string"
},
"country_registered": {
"description": "The country or state the corporate entity with significant control is registered in.",
"type": "string"
}
},
"required": [
"legal_authority",
"legal_form"
]
},
"pscModels_definitions-address": {
"title": "pscAddress",
"required": [
"address_line_1",
"postal_code",
"premises"
],
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"care_of": {
"description": "Care of name.",
"type": "string"
},
"country": {
"description": "The country. For example, UK.",
"type": "string"
},
"locality": {
"description": "The locality. For example London.",
"type": "string"
},
"po_box": {
"description": "The post-officer box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code. For example CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region. For example Surrey.",
"type": "string"
}
}
},
"beneficialOwnerAddress": {
"title": "beneficialOwnerAddress",
"properties": {
"address_line_1": {
"description": "The first line of the address.",
"type": "string"
},
"address_line_2": {
"description": "The second line of the address.",
"type": "string"
},
"care_of": {
"description": "The care of name.",
"type": "string"
},
"country": {
"description": "The country. For example, United Kingdom.",
"type": "string"
},
"locality": {
"description": "The locality. For example London.",
"type": "string"
},
"po_box": {
"description": "The post-officer box number.",
"type": "string"
},
"postal_code": {
"description": "The postal code. For example CF14 3UZ.",
"type": "string"
},
"premises": {
"description": "The property name or number.",
"type": "string"
},
"region": {
"description": "The region. For example Surrey.",
"type": "string"
}
}
},
"listSummary": {
"title": "listSummary",
"required": [
"etag",
"name",
"links",
"address",
"notified_on",
"natures_of_control"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"notified_on": {
"description": "The date that Companies House was notified about this person with significant control.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this person with significant control.",
"type": "string",
"format": "date"
},
"country_of_residence": {
"description": "The country of residence of the person with significant control.",
"type": "string"
},
"date_of_birth": {
"description": "The date of birth of the person with significant control.",
"items": {
"$ref": "#/definitions/dateOfBirth"
},
"type": "object"
},
"name": {
"description": "Name of the person with significant control.",
"type": "string"
},
"name_elements": {
"description": "A document encapsulating the separate elements of a person with significant control's name.",
"items": {
"$ref": "#/definitions/definitions-nameElements"
},
"type": "object"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/pscLinksType"
},
"type": "object"
},
"nationality": {
"description": "The nationality of the person with significant control.",
"type": "string"
},
"identification": {
"description": "",
"items": {
"$ref": "#/definitions/pscListIdent"
},
"type": "object"
},
"ceased": {
"description": "Presence of that indicator means the super secure person status is ceased <br />",
"type": "boolean"
},
"description": {
"description": "Description of the super secure legal statement <br />",
"enum": [
"super-secure-persons-with-significant-control"
],
"type": "string"
},
"kind": {
"enum": [
"individual-person-with-significant-control",
"corporate-entity-person-with-significant-control",
"legal-person-with-significant-control",
"super-secure-person-with-significant-control",
"individual-beneficial-owner",
"corporate-entity-beneficial-owner",
"legal-person-beneficial-owner",
"super-secure-beneficial-owner"
],
"type": "string"
},
"address": {
"description": "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.",
"items": {
"$ref": "#/definitions/pscModels_definitions-address"
},
"type": "object"
},
"natures_of_control": {
"description": "Indicates the nature of control the person with significant control holds.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"items": {
"type": "string"
},
"type": "array"
},
"is_sanctioned": {
"description": "Flag indicating if the beneficial owner was declared as being sanctioned on the latest filing of the overseas entity",
"type": "boolean"
},
"principal_office_address": {
"description": "The principal/registered office address of a corporate-entity-beneficial-owner or legal-person-beneficial-owner of a registered-overseas-entity.",
"items": {
"$ref": "#/definitions/beneficialOwnerAddress"
},
"type": "object"
}
}
},
"pscListLinksType": {
"title": "pscListLinksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
},
"persons_with_significant_control_list": {
"description": "The URL of the persons with significant control list resource.",
"type": "string"
}
}
},
"list": {
"title": "list",
"properties": {
"items_per_page": {
"description": "The number of persons with significant control to return per page.",
"type": "integer"
},
"items": {
"description": "The list of persons with significant control.",
"items": {
"$ref": "#/definitions/listSummary"
},
"type": "array"
},
"start_index": {
"description": "The offset into the entire result set that this page starts.",
"type": "integer"
},
"total_results": {
"description": "The total number of persons with significant control in this result set.",
"type": "integer"
},
"active_count": {
"description": "The number of active persons with significant control in this result set.",
"type": "integer"
},
"ceased_count": {
"description": "The number of ceased persons with significant control in this result set.",
"type": "integer"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/pscListLinksType"
},
"type": "object"
}
},
"required": [
"items_per_page",
"items",
"start_index",
"total_results",
"active_count",
"ceased_count",
"links"
]
},
"individual": {
"title": "individual",
"required": [
"etag",
"notified_on",
"kind",
"country_of_residence",
"date_of_birth",
"name",
"name_elements",
"links",
"nationality",
"address",
"natures_of_control"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"notified_on": {
"description": "The date that Companies House was notified about this person with significant control.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this person with significant control.",
"type": "string",
"format": "date"
},
"kind": {
"enum": [
"individual-person-with-significant-control"
],
"type": "string"
},
"country_of_residence": {
"description": "The country of residence of the person with significant control.",
"type": "string"
},
"date_of_birth": {
"description": "The date of birth of the person with significant control.",
"items": {
"$ref": "#/definitions/dateOfBirth"
},
"type": "object"
},
"name": {
"description": "Name of the person with significant control. Generated by combining the name elements.",
"type": "string"
},
"name_elements": {
"description": "A document encapsulating the separate elements of a person with significant control's name.",
"items": {
"$ref": "#/definitions/definitions-nameElements"
},
"type": "object"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/pscLinksType"
},
"type": "object"
},
"nationality": {
"description": "The nationality of the person with significant control.",
"type": "string"
},
"address": {
"description": "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.",
"items": {
"$ref": "#/definitions/pscModels_definitions-address"
},
"type": "object"
},
"natures_of_control": {
"description": "Indicates the nature of control the person with significant control holds.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"type": "array"
}
}
},
"beneficialOwnerDateOfBirth": {
"title": "beneficialOwnerDateOfBirth",
"properties": {
"day": {
"description": "The day of the date of birth.",
"type": "integer"
},
"month": {
"description": "The month of date of birth.",
"type": "integer"
},
"year": {
"description": "The year of date of birth.",
"type": "integer"
}
}
},
"beneficialOwnerNameElements": {
"title": "beneficialOwnerNameElements",
"properties": {
"forename": {
"description": "The forename of the beneficial owner.",
"type": "string"
},
"title": {
"description": "Title of the beneficial owner.",
"type": "string"
},
"middle_name": {
"description": "The middle name of the beneficial owner.",
"type": "string"
},
"surname": {
"description": "The surname of the beneficial owner.",
"type": "string"
}
},
"required": [
"surname"
]
},
"beneficialOwnerLinksType": {
"title": "beneficialOwnerLinksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
},
"statement": {
"description": "The URL of the statement linked to this beneficial owner.",
"type": "string"
}
}
},
"individualBeneficialOwner": {
"title": "individualBeneficialOwner",
"required": [
"etag",
"kind",
"links"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"notified_on": {
"description": "The date that Companies House was notified about this beneficial owner.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this beneficial owner.",
"type": "string",
"format": "date"
},
"kind": {
"enum": [
"individual-beneficial-owner"
],
"type": "string"
},
"date_of_birth": {
"description": "The date of birth of the beneficial owner.",
"items": {
"$ref": "#/definitions/beneficialOwnerDateOfBirth"
},
"type": "object"
},
"name": {
"description": "Name of the beneficial owner. Generated by combining the name elements.",
"type": "string"
},
"name_elements": {
"description": "A document encapsulating the separate elements of a beneficial owner's name.",
"items": {
"$ref": "#/definitions/beneficialOwnerNameElements"
},
"type": "object"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/beneficialOwnerLinksType"
},
"type": "object"
},
"nationality": {
"description": "The nationality of the beneficial owner.",
"type": "string"
},
"address": {
"description": "The service address of the beneficial owner. If given, this address will be shown on the public record instead of the residential address.",
"items": {
"$ref": "#/definitions/beneficialOwnerAddress"
},
"type": "object"
},
"natures_of_control": {
"description": "Indicates the nature of control the beneficial owner holds.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"type": "array"
},
"is_sanctioned": {
"description": "Flag indicating if the beneficial owner was declared as being sanctioned on the latest filing of the overseas entity",
"type": "boolean"
}
}
},
"corporateEntityIdent": {
"title": "corporateEntityIdent",
"properties": {
"legal_authority": {
"description": "The legal authority supervising the corporate entity with significant control.",
"type": "string"
},
"legal_form": {
"description": "The legal form of the corporate entity with significant control as defined by its country of registration.",
"type": "string"
},
"place_registered": {
"description": "The place the corporate entity with significant control is registered.",
"type": "string"
},
"registration_number": {
"description": "The registration number of the corporate entity with significant control.",
"type": "string"
},
"country_registered": {
"description": "The country or state the corporate entity with significant control is registered in.",
"type": "string"
}
},
"required": [
"legal_authority",
"legal_form"
]
},
"corporateEntity": {
"title": "corporateEntity",
"required": [
"etag",
"notified_on",
"kind",
"name",
"links",
"address",
"identification",
"natures_of_control"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"notified_on": {
"description": "The date that Companies House was notified about this person with significant control.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this person with significant control.",
"type": "string",
"format": "date"
},
"kind": {
"enum": [
"corporate-entity-person-with-significant-control"
],
"type": "string"
},
"name": {
"description": "Name of the person with significant control.",
"type": "string"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/pscLinksType"
},
"type": "object"
},
"address": {
"description": "The address of the person with significant control.",
"items": {
"$ref": "#/definitions/pscModels_definitions-address"
},
"type": "object"
},
"identification": {
"description": "",
"items": {
"$ref": "#/definitions/corporateEntityIdent"
},
"type": "object"
},
"natures_of_control": {
"description": "Indicates the nature of control the person with significant control holds.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"type": "array"
}
}
},
"beneficialOwnerCorporateEntityIdent": {
"title": "beneficialOwnerCorporateEntityIdent",
"properties": {
"legal_authority": {
"description": "The legal authority supervising the corporate entity beneficial owner.",
"type": "string"
},
"legal_form": {
"description": "The legal form of the corporate entity beneficial owner as defined by its country of registration.",
"type": "string"
},
"place_registered": {
"description": "The place the corporate entity beneficial owner is registered.",
"type": "string"
},
"registration_number": {
"description": "The registration number of the corporate entity beneficial owner.",
"type": "string"
},
"country_registered": {
"description": "The country or state the corporate entity beneficial owner is registered in.",
"type": "string"
}
}
},
"corporateEntityBeneficialOwner": {
"title": "corporateEntityBeneficialOwner",
"required": [
"etag",
"kind",
"links"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"notified_on": {
"description": "The date that Companies House was notified about this beneficial owner.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this beneficial owner.",
"type": "string",
"format": "date"
},
"kind": {
"enum": [
"corporate-entity-beneficial-owner"
],
"type": "string"
},
"name": {
"description": "Name of the beneficial owner.",
"type": "string"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/beneficialOwnerLinksType"
},
"type": "object"
},
"address": {
"description": "The address of the beneficial owner.",
"items": {
"$ref": "#/definitions/beneficialOwnerAddress"
},
"type": "object"
},
"principal_office_address": {
"description": "The principal/registered office address of a corporate-entity-beneficial-owner of a registered-overseas-entity.",
"items": {
"$ref": "#/definitions/beneficialOwnerAddress"
},
"type": "object"
},
"identification": {
"description": "",
"items": {
"$ref": "#/definitions/beneficialOwnerCorporateEntityIdent"
},
"type": "object"
},
"natures_of_control": {
"description": "Indicates the nature of control the beneficial owner holds.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"type": "array"
},
"is_sanctioned": {
"description": "Flag indicating if the beneficial owner was declared as being sanctioned on the latest filing of the overseas entity",
"type": "boolean"
}
}
},
"legalPersonIdent": {
"title": "legalPersonIdent",
"properties": {
"legal_authority": {
"description": "The legal authority supervising the legal person with significant control.",
"type": "string"
},
"legal_form": {
"description": "The legal form of the legal person with significant control as defined by its country of registration.",
"type": "string"
}
},
"required": [
"legal_authority",
"legal_form"
]
},
"legalPerson": {
"title": "legalPerson",
"required": [
"etag",
"notified_on",
"kind",
"name",
"links",
"address",
"identification",
"natures_of_control"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"notified_on": {
"description": "The date that Companies House was notified about this person with significant control.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this person with significant control.",
"type": "string",
"format": "date"
},
"kind": {
"enum": [
"legal-person-person-with-significant-control"
],
"type": "string"
},
"name": {
"description": "Name of the person with significant control.",
"type": "string"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/pscLinksType"
},
"type": "object"
},
"address": {
"description": "The address of the person with significant control.",
"items": {
"$ref": "#/definitions/pscModels_definitions-address"
},
"type": "object"
},
"identification": {
"description": "",
"items": {
"$ref": "#/definitions/legalPersonIdent"
},
"type": "object"
},
"natures_of_control": {
"description": "Indicates the nature of control the person with significant control holds.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"type": "array"
}
}
},
"legalPersonBeneficialOwnerIdent": {
"title": "legalPersonBeneficialOwnerIdent",
"properties": {
"legal_authority": {
"description": "The legal authority supervising the legal person beneficial owner.",
"type": "string"
},
"legal_form": {
"description": "The legal form of the legal person beneficial owner as defined by its country of registration.",
"type": "string"
}
}
},
"legalPersonBeneficialOwner": {
"title": "legalPersonBeneficialOwner",
"required": [
"etag",
"kind",
"links"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"notified_on": {
"description": "The date that Companies House was notified about this beneficial owner.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this beneficial owner.",
"type": "string",
"format": "date"
},
"kind": {
"enum": [
"legal-person-beneficial-owner"
],
"type": "string"
},
"name": {
"description": "Name of the beneficial owner.",
"type": "string"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/beneficialOwnerLinksType"
},
"type": "object"
},
"address": {
"description": "The address of the beneficial owner.",
"items": {
"$ref": "#/definitions/beneficialOwnerAddress"
},
"type": "object"
},
"principal_office_address": {
"description": "The principal/registered office address of a legal-person-beneficial-owner of a registered-overseas-entity.",
"items": {
"$ref": "#/definitions/beneficialOwnerAddress"
},
"type": "object"
},
"identification": {
"description": "",
"items": {
"$ref": "#/definitions/legalPersonBeneficialOwnerIdent"
},
"type": "object"
},
"natures_of_control": {
"description": "Indicates the nature of control the beneficial owner holds.\n For enumeration descriptions see `description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"type": "array"
},
"is_sanctioned": {
"description": "Flag indicating if the beneficial owner was declared as being sanctioned on the latest filing of the overseas entity",
"type": "boolean"
}
}
},
"statementLinksType": {
"title": "statementLinksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
},
"person_with_significant_control": {
"description": "The URL of the person with significant control linked to this statement.",
"type": "string"
}
}
},
"statement": {
"title": "statement",
"required": [
"etag",
"kind",
"notified_on",
"statement",
"links"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"kind": {
"enum": [
"persons-with-significant-control-statement"
],
"type": "string"
},
"notified_on": {
"description": "The date that the person with significant control statement was processed by Companies House.",
"type": "string",
"format": "date"
},
"ceased_on": {
"description": "The date that Companies House was notified about the cessation of this person with significant control.",
"type": "string",
"format": "date"
},
"restrictions_notice_withdrawal_reason": {
"description": "The reason for the company withdrawing a <code>restrictions-notice-issued-to-psc</code> statement",
"enum": [
"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"
],
"type": "string"
},
"statement": {
"description": "Indicates the type of statement filed.\n For enumeration descriptions see `statement_description` section in the [enumeration mappings](https://github.com/companieshouse/api-enumerations/blob/master/psc_descriptions.yml) file. \n",
"enum": [
"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"
],
"type": "string"
},
"linked_psc_name": {
"description": "The name of the psc linked to this statement.",
"type": "string"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/statementLinksType"
},
"type": "object"
}
}
},
"statementListLinksType": {
"title": "statementListLinksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
},
"persons_with_significant_control_statements_list": {
"description": "The URL of the persons with significant control statements list resource.",
"type": "string"
}
}
},
"statementList": {
"title": "statementList",
"properties": {
"items_per_page": {
"description": "The number of persons with significant control statements to return per page.",
"type": "integer"
},
"items": {
"description": "The list of persons with significant control statements.",
"items": {
"$ref": "#/definitions/statement"
},
"type": "object"
},
"start_index": {
"description": "The offset into the entire result set that this page starts.",
"type": "integer"
},
"total_results": {
"description": "The total number of persons with significant control statements in this result set.",
"type": "integer"
},
"active_count": {
"description": "The number of active persons with significant control statements in this result set.",
"type": "integer"
},
"ceased_count": {
"description": "The number of ceased persons with significant control statements in this result set.",
"type": "integer"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/statementListLinksType"
},
"type": "object"
}
},
"required": [
"items_per_page",
"items",
"start_index",
"total_results",
"active_count",
"ceased_count",
"links"
]
},
"superSecureLinksType": {
"title": "superSecureLinksType",
"required": [
"self"
],
"properties": {
"self": {
"description": "The URL of the resource.",
"type": "string"
}
}
},
"superSecure": {
"title": "superSecure",
"required": [
"etag",
"kind",
"description",
"links"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"kind": {
"enum": [
"super-secure-person-with-significant-control"
],
"type": "string"
},
"description": {
"description": "Description of the super secure legal statement \n",
"enum": [
"super-secure-persons-with-significant-control"
],
"type": "string"
},
"ceased": {
"description": "Presence of that indicator means the super secure person status is ceased \n",
"type": "boolean"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/superSecureLinksType"
},
"type": "object"
}
}
},
"superSecureBeneficialOwner": {
"title": "superSecureBeneficialOwner",
"required": [
"etag",
"kind",
"description",
"links"
],
"properties": {
"etag": {
"description": "The ETag of the resource.",
"type": "string"
},
"kind": {
"enum": [
"super-secure-beneficial-owner"
],
"type": "string"
},
"description": {
"description": "Description of the super secure legal statement \n",
"enum": [
"super-secure-beneficial-owner"
],
"type": "string"
},
"ceased": {
"description": "Presence of this indicator means the super secure beneficial owner status is ceased \n",
"type": "boolean"
},
"links": {
"description": "A set of URLs related to the resource, including self.",
"items": {
"$ref": "#/definitions/superSecureLinksType"
},
"type": "object"
}
}
}
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment