Created
August 11, 2025 15:52
-
-
Save riosengineer/f00a516f5c8175fedea41e3872fd2294 to your computer and use it in GitHub Desktop.
Companies House Agent OpenAPI v3
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.0.1", | |
| "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", | |
| "contact": { | |
| "name": "Companies House API Support", | |
| "url": "https://developer.company-information.service.gov.uk/", | |
| "email": "api@companieshouse.gov.uk" | |
| } | |
| }, | |
| "servers": [ | |
| { | |
| "url": "https://api.company-information.service.gov.uk" | |
| } | |
| ], | |
| "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" | |
| } | |
| ], | |
| "components": { | |
| "securitySchemes": { | |
| "Authorization": { | |
| "type": "apiKey", | |
| "name": "Authorization", | |
| "in": "header" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "Authorization": [] | |
| } | |
| ], | |
| "paths": { | |
| "/company/{companyNumber}/registered-office-address": { | |
| "get": { | |
| "tags": [ | |
| "registeredOfficeAddress" | |
| ], | |
| "summary": "Get registered office address", | |
| "description": "Returns the registered office address for a company.", | |
| "operationId": "get_registered_office_address", | |
| "parameters": [ | |
| { | |
| "name": "companyNumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{companyNumber}": { | |
| "get": { | |
| "tags": [ | |
| "companyProfile" | |
| ], | |
| "summary": "Get company profile", | |
| "description": "Returns the company profile for a company.", | |
| "operationId": "get_company_profile", | |
| "parameters": [ | |
| { | |
| "name": "companyNumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/search": { | |
| "get": { | |
| "tags": [ | |
| "search" | |
| ], | |
| "summary": "Search all", | |
| "description": "Performs a search across all company data.", | |
| "operationId": "search_all", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/search/companies": { | |
| "get": { | |
| "tags": [ | |
| "search" | |
| ], | |
| "summary": "Search companies", | |
| "description": "Performs a search for companies.", | |
| "operationId": "search_companies", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/search/officers": { | |
| "get": { | |
| "tags": [ | |
| "search" | |
| ], | |
| "summary": "Search officers", | |
| "description": "Performs a search for officers.", | |
| "operationId": "search_officers", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/search/disqualified-officers": { | |
| "get": { | |
| "tags": [ | |
| "search" | |
| ], | |
| "summary": "Search disqualified officers", | |
| "description": "Performs a search for disqualified officers.", | |
| "operationId": "search_disqualified_officers", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/dissolved-search/companies": { | |
| "get": { | |
| "tags": [ | |
| "search" | |
| ], | |
| "summary": "Search dissolved companies", | |
| "description": "Performs a search for dissolved companies.", | |
| "operationId": "search_dissolved_companies", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/alphabetical-search/companies": { | |
| "get": { | |
| "tags": [ | |
| "search" | |
| ], | |
| "summary": "Alphabetical search for companies", | |
| "description": "Performs an alphabetical search for companies.", | |
| "operationId": "alphabetical_search_companies", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/advanced-search/companies": { | |
| "get": { | |
| "tags": [ | |
| "search" | |
| ], | |
| "summary": "Advanced search for companies", | |
| "description": "Performs an advanced search for companies.", | |
| "operationId": "advanced_search_companies", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/officers": { | |
| "get": { | |
| "tags": [ | |
| "officers" | |
| ], | |
| "summary": "List company officers", | |
| "description": "Returns a list of officers for a company.", | |
| "operationId": "list_company_officers", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/appointments/{appointment_id}": { | |
| "get": { | |
| "tags": [ | |
| "officers" | |
| ], | |
| "summary": "Get company officer appointment", | |
| "description": "Returns details of a company officer appointment.", | |
| "operationId": "get_company_officer_appointment", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "appointment_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/registers": { | |
| "get": { | |
| "tags": [ | |
| "registers" | |
| ], | |
| "summary": "Get company registers", | |
| "description": "Returns the registers for a company.", | |
| "operationId": "get_company_registers", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/filing-history/{transaction_id}": { | |
| "get": { | |
| "tags": [ | |
| "filingHistory" | |
| ], | |
| "summary": "Get company filing history transaction", | |
| "description": "Returns details of a specific filing history transaction for a company.", | |
| "operationId": "get_company_filing_history_transaction", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "transaction_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/filing-history": { | |
| "get": { | |
| "tags": [ | |
| "filingHistory" | |
| ], | |
| "summary": "List company filing history", | |
| "description": "Returns a list of filing history transactions for a company.", | |
| "operationId": "list_company_filing_history", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/exemptions": { | |
| "get": { | |
| "tags": [ | |
| "exemptions" | |
| ], | |
| "summary": "Get company exemptions", | |
| "description": "Returns the exemptions for a company.", | |
| "operationId": "get_company_exemptions", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/disqualified-officers/natural/{officer_id}": { | |
| "get": { | |
| "tags": [ | |
| "officerDisqualifications" | |
| ], | |
| "summary": "Get natural disqualified officer", | |
| "description": "Returns details of a natural disqualified officer.", | |
| "operationId": "get_natural_disqualified_officer", | |
| "parameters": [ | |
| { | |
| "name": "officer_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/disqualified-officers/corporate/{officer_id}": { | |
| "get": { | |
| "tags": [ | |
| "officerDisqualifications" | |
| ], | |
| "summary": "Get corporate disqualified officer", | |
| "description": "Returns details of a corporate disqualified officer.", | |
| "operationId": "get_corporate_disqualified_officer", | |
| "parameters": [ | |
| { | |
| "name": "officer_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/officers/{officer_id}/appointments": { | |
| "get": { | |
| "tags": [ | |
| "officerAppointments" | |
| ], | |
| "summary": "List officer appointments", | |
| "description": "Returns a list of appointments for an officer.", | |
| "operationId": "list_officer_appointments", | |
| "parameters": [ | |
| { | |
| "name": "officer_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/charges": { | |
| "get": { | |
| "tags": [ | |
| "charges" | |
| ], | |
| "summary": "List company charges", | |
| "description": "Returns a list of charges for a company.", | |
| "operationId": "list_company_charges", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/charges/{charge_id}": { | |
| "get": { | |
| "tags": [ | |
| "charges" | |
| ], | |
| "summary": "Get company charge details", | |
| "description": "Returns details of a specific charge for a company.", | |
| "operationId": "get_company_charge_details", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "charge_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/insolvency": { | |
| "get": { | |
| "tags": [ | |
| "insolvency" | |
| ], | |
| "summary": "Get company insolvency case", | |
| "description": "Returns the insolvency case for a company.", | |
| "operationId": "get_company_insolvency_case", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/uk-establishments": { | |
| "get": { | |
| "tags": [ | |
| "UKEstablishments" | |
| ], | |
| "summary": "List UK establishments for a company", | |
| "description": "Returns a list of UK establishments for a company.", | |
| "operationId": "list_company_uk_establishments", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "List persons with significant control", | |
| "description": "Returns a list of persons with significant control for a company.", | |
| "operationId": "list_company_psc", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/individual/{psc_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get individual person with significant control", | |
| "description": "Returns details of an individual person with significant control for a company.", | |
| "operationId": "get_individual_psc", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/individual/{psc_id}/full_record": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get full record for individual person with significant control", | |
| "description": "Returns the full record for an individual person with significant control for a company.", | |
| "operationId": "get_individual_psc_full_record", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/individual/{psc_id}/verification-state": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get verification state for individual person with significant control", | |
| "description": "Returns the verification state for an individual person with significant control for a company.", | |
| "operationId": "get_individual_psc_verification_state", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/individual-beneficial-owner/{psc_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get individual beneficial owner", | |
| "description": "Returns details of an individual beneficial owner for a company.", | |
| "operationId": "get_individual_beneficial_owner", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/corporate-entity/{psc_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get corporate entity person with significant control", | |
| "description": "Returns details of a corporate entity person with significant control for a company.", | |
| "operationId": "get_corporate_entity_psc", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/corporate-entity-beneficial-owner/{psc_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get corporate entity beneficial owner", | |
| "description": "Returns details of a corporate entity beneficial owner for a company.", | |
| "operationId": "get_corporate_entity_beneficial_owner", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/legal-person/{psc_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get legal person with significant control", | |
| "description": "Returns details of a legal person with significant control for a company.", | |
| "operationId": "get_legal_person_psc", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/legal-person-beneficial-owner/{psc_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get legal person beneficial owner", | |
| "description": "Returns details of a legal person beneficial owner for a company.", | |
| "operationId": "get_legal_person_beneficial_owner", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "psc_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control-statements": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "List persons with significant control statements", | |
| "description": "Returns a list of persons with significant control statements for a company.", | |
| "operationId": "list_company_psc_statements", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control-statements/{statement_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get persons with significant control statement", | |
| "description": "Returns details of a persons with significant control statement for a company.", | |
| "operationId": "get_psc_statement", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "statement_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/super-secure/{super_secure_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get super secure person with significant control", | |
| "description": "Returns details of a super secure person with significant control for a company.", | |
| "operationId": "get_super_secure_psc", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "super_secure_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/company/{company_number}/persons-with-significant-control/super-secure-beneficial-owner/{super_secure_id}": { | |
| "get": { | |
| "tags": [ | |
| "personsWithSignificantControl" | |
| ], | |
| "summary": "Get super secure beneficial owner", | |
| "description": "Returns details of a super secure beneficial owner for a company.", | |
| "operationId": "get_super_secure_beneficial_owner", | |
| "parameters": [ | |
| { | |
| "name": "company_number", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "super_secure_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment