{"ok":true,"site":"company-information-service","host":"find-and-update.company-information.service.gov.uk","about":"Companies House public register (UK): search companies, officers and disqualified directors, and read company profiles, filing history, officers, PSCs, charges, officer appointments, dissolved and alphabetical company searches, name availability, advanced search with CSV export, and filing document PDFs.","commands":[{"command":"search-all","summary":"Search companies and officers together by keyword. Results are mixed; the item class is type-company or type-officer.","params":[{"name":"q","type":"string","required":true,"description":"Search keyword: a company name, company number or person name"},{"name":"page","type":"number","description":"Result page number, starting at 1"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/search-all?q=tesco&page=2"},{"command":"search-companies","summary":"Search companies by name or number. Returns name, profile URL, company number, incorporation or dissolution date and address.","params":[{"name":"q","type":"string","required":true,"description":"Company name or company number"},{"name":"page","type":"number","description":"Result page number (20 results per page)"},{"name":"searchType","type":"string","description":"Set to 'dissolved' to search dissolved companies","oneOf":["dissolved"]}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/search-companies?q=tesco&page=2&searchType=dissolved"},{"command":"search-officers","summary":"Search company officers (directors, secretaries, corporate officers) by name. Returns links to each officer's appointments.","params":[{"name":"q","type":"string","required":true,"description":"Officer name. Can include a location filter, e.g. John Smith location:\"CF14\""},{"name":"page","type":"number","description":"Result page number (20 results per page)"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/search-officers?q=tesco&page=2"},{"command":"search-disqualified-officers","summary":"Search disqualified directors by name. Returns links to each disqualification detail page.","params":[{"name":"q","type":"string","required":true,"description":"Person or company name"},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/search-disqualified-officers?q=smith&page=2"},{"command":"get-disqualified-officer","summary":"Get disqualification details for a person or company: date of birth, nationality, disqualification type, start and end dates, case reference, companies involved and reason.","params":[{"name":"kind","type":"string","description":"'natural' for a person, 'corporate' for a company. Take it from the search result URL.","oneOf":["natural","corporate"],"default":"natural"},{"name":"officerId","type":"string","required":true,"description":"Disqualified officer id, the last segment of the URL returned by search-disqualified-officers"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/get-disqualified-officer"},{"command":"get-company","summary":"Get a company overview by company number: name, registered office address, status, SIC code and previous names.","params":[{"name":"companyNumber","type":"string","required":true,"description":"8-character company number, with leading zeros or a prefix such as SC or NI, e.g. 00445790"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/get-company"},{"command":"list-filing-history","summary":"List a company's filing history (date, type, description, PDF link), optionally filtered by category. Paginated.","params":[{"name":"companyNumber","type":"string","required":true,"description":"Company number, e.g. 00445790"},{"name":"category","type":"string","description":"Filing category filter, e.g. accounts, confirmation-statement, officers, capital, mortgage, incorporation, resolution, address, persons-with-significant-control"},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/list-filing-history?category=accounts&page=2"},{"command":"get-filing-document","summary":"Download a filing document PDF. The server redirects to a signed S3 URL.","params":[{"name":"companyNumber","type":"string","required":true,"description":"Company number"},{"name":"transactionId","type":"string","required":true,"description":"Filing transaction id, the path segment after /filing-history/ in a documentUrl from list-filing-history"},{"name":"format","type":"string","description":"Document format","oneOf":["pdf"],"default":"pdf"},{"name":"download","type":"string","description":"1 to force a download (attachment), 0 to view inline","oneOf":["0","1"],"default":"0"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/get-filing-document"},{"command":"list-company-officers","summary":"List a company's officers (directors and secretaries) with role, appointment date, date of birth and links to their appointments.","params":[{"name":"companyNumber","type":"string","required":true,"description":"Company number"},{"name":"filter","type":"string","description":"Set to 'active' to show only current officers","oneOf":["active"]},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/list-company-officers?page=2"},{"command":"list-company-pscs","summary":"List a company's persons with significant control (owners and controllers), or the reason the company is exempt.","params":[{"name":"companyNumber","type":"string","required":true,"description":"Company number"},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/list-company-pscs?page=2"},{"command":"list-company-charges","summary":"List a company's registered charges (mortgages and security agreements), with links to each charge's details.","params":[{"name":"companyNumber","type":"string","required":true,"description":"Company number"},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/list-company-charges?page=2"},{"command":"get-charge","summary":"Get one charge's details: type, created and delivered dates, status, filing transaction with PDF link, and persons entitled.","params":[{"name":"companyNumber","type":"string","required":true,"description":"Company number"},{"name":"chargeId","type":"string","required":true,"description":"Charge id, the last segment of a URL from list-company-charges"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/get-charge"},{"command":"get-officer-appointments","summary":"List all company appointments held by one officer: company, company status, role, appointed and resigned dates, correspondence address.","params":[{"name":"officerId","type":"string","required":true,"description":"Officer id from a search-officers or list-company-officers URL (/officers/{id}/appointments)"},{"name":"filter","type":"string","description":"Set to 'active' to show only current appointments","oneOf":["active"]},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/get-officer-appointments?page=2"},{"command":"advanced-search-companies","summary":"Advanced company search. Filter by name include/exclude, registered office address, incorporation and dissolution date ranges, status, SIC code and company type. Returns company names and profile URLs","params":[{"name":"companyNameIncludes","type":"string","description":"Company name must contain this text"},{"name":"companyNameExcludes","type":"string","description":"Exclude company names containing this text"},{"name":"registeredOfficeAddress","type":"string","description":"Full or partial registered office address"},{"name":"incorporationFromDay","type":"string","description":"Incorporated on or after: day (1-31)"},{"name":"incorporationFromMonth","type":"string","description":"Incorporated on or after: month (1-12)"},{"name":"incorporationFromYear","type":"string","description":"Incorporated on or after: year (YYYY)"},{"name":"incorporationToDay","type":"string","description":"Incorporated on or before: day"},{"name":"incorporationToMonth","type":"string","description":"Incorporated on or before: month"},{"name":"incorporationToYear","type":"string","description":"Incorporated on or before: year"},{"name":"dissolvedFromDay","type":"string","description":"Dissolved on or after: day"},{"name":"dissolvedFromMonth","type":"string","description":"Dissolved on or after: month"},{"name":"dissolvedFromYear","type":"string","description":"Dissolved on or after: year"},{"name":"dissolvedToDay","type":"string","description":"Dissolved on or before: day"},{"name":"dissolvedToMonth","type":"string","description":"Dissolved on or before: month"},{"name":"dissolvedToYear","type":"string","description":"Dissolved on or before: year"},{"name":"status","type":"string","description":"Company status","oneOf":["active","dissolved","open","closed","converted-closed","receivership","administration","liquidation","insolvency-proceedings","voluntary-arrangement"]},{"name":"sicCodes","type":"string","description":"SIC nature-of-business code, e.g. 10710 (bread and fresh pastry)"},{"name":"type","type":"string","description":"Company type code, e.g. ltd, plc, llp, private-unlimited, private-limited-guarant-nsc"},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/advanced-search-companies?companyNameIncludes=bakery&registeredOfficeAddress=london&incorporationFromYear=2015&status=active&sicCodes=10710&type=ltd&page=2"},{"command":"export-advanced-search-csv","summary":"Download advanced company search results as CSV, using the same filters as advanced-search-companies.","params":[{"name":"companyNameIncludes","type":"string","description":"Company name must contain this text"},{"name":"companyNameExcludes","type":"string","description":"Exclude company names containing this text"},{"name":"registeredOfficeAddress","type":"string","description":"Full or partial registered office address"},{"name":"incorporationFromDay","type":"string","description":"Incorporated on or after: day"},{"name":"incorporationFromMonth","type":"string","description":"Incorporated on or after: month"},{"name":"incorporationFromYear","type":"string","description":"Incorporated on or after: year"},{"name":"incorporationToDay","type":"string","description":"Incorporated on or before: day"},{"name":"incorporationToMonth","type":"string","description":"Incorporated on or before: month"},{"name":"incorporationToYear","type":"string","description":"Incorporated on or before: year"},{"name":"dissolvedFromDay","type":"string","description":"Dissolved on or after: day"},{"name":"dissolvedFromMonth","type":"string","description":"Dissolved on or after: month"},{"name":"dissolvedFromYear","type":"string","description":"Dissolved on or after: year"},{"name":"dissolvedToDay","type":"string","description":"Dissolved on or before: day"},{"name":"dissolvedToMonth","type":"string","description":"Dissolved on or before: month"},{"name":"dissolvedToYear","type":"string","description":"Dissolved on or before: year"},{"name":"status","type":"string","description":"Company status","oneOf":["active","dissolved","open","closed","converted-closed","receivership","administration","liquidation","insolvency-proceedings","voluntary-arrangement"]},{"name":"sicCodes","type":"string","description":"SIC code, e.g. 10710"},{"name":"type","type":"string","description":"Company type code, e.g. ltd, plc, llp"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/export-advanced-search-csv?companyNameIncludes=bakery&registeredOfficeAddress=london&status=active"},{"command":"search-dissolved-companies","summary":"Search companies dissolved since 1989 by their name at dissolution or by a previous name.","params":[{"name":"companyName","type":"string","required":true,"description":"Company name or number"},{"name":"changedName","type":"string","description":"Match the name at dissolution, or match previous names","oneOf":["name-at-dissolution","previous-name-dissolved"],"default":"name-at-dissolution"},{"name":"searchType","type":"string","description":"Set to 'alphabetical' to list results alphabetically. Numbers and previous names are unavailable in this mode.","oneOf":["alphabetical"]},{"name":"page","type":"number","description":"Result page number"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/search-dissolved-companies?companyName=tesco&changedName=name-at-dissolution&page=2"},{"command":"alphabetical-search-companies","summary":"Browse the register alphabetically around a company name (40 rows per page). Returns name, number and status. Uses cursor paging via searchAfter/searchBefore.","params":[{"name":"companyName","type":"string","required":true,"description":"Company name to start browsing from"},{"name":"searchAfter","type":"string","description":"Next-page cursor: the last row's name, uppercase with no spaces or punctuation, plus ':' and the company number, e.g. TESCOBARBERSWOOD:07137692"},{"name":"searchBefore","type":"string","description":"Previous-page cursor: the first row's name in the same format as searchAfter"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/alphabetical-search-companies?companyName=tesco&searchAfter=TESCOBARBERSWOOD%3A07137692"},{"command":"check-company-name-availability","summary":"Check whether a proposed company name is available by listing existing companies with the same or similar names.","params":[{"name":"q","type":"string","required":true,"description":"Proposed company name"}],"exampleUrl":"https://clify-dev.netlify.app/company-information-service/check-company-name-availability?q=tesco"}]}