{ "info": { "_postman_id": "1bd07fe4-4e7f-4b1d-a684-b2f35327ed4c", "name": "CompanyStack API", "description": "UK company data API: the Companies House register (about 6 million companies), figures read from filed accounts, health scores, owners (PSC), sanctions screening and monitoring.\n\nCompanyStack is not affiliated with or endorsed by Companies House. Contains public sector information licensed under the Open Government Licence v3.0 (https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/); other sources and their licences: https://companystack.co.uk/data-sources. Accounts figures and register details are the company's own filings, shown as filed; CompanyStack does not audit or verify them.\n\nAuthenticate with your API key as `Authorization: Bearer cs_...` (or `X-Api-Key`). Free keys cover search and company profiles; see https://companystack.co.uk/pricing for what each plan includes. Limits are per account, in UTC minute and day windows, and every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (Unix seconds) and the `X-RateLimit-Daily-*` equivalents. A 403 with `code: plan_upgrade_required` means the endpoint is not in your plan; a path that does not exist answers 404 on every plan; a 429 includes `Retry-After`.\n\nPaging on the Free plan: `GET /company/search` returns only the first page (at most 10 results) and does not apply `offset`; the response reports `offset: 0`. Do not page until an empty page with a Free key; stop when a page holds fewer results than `limit`. Paid plans page with `limit` (up to 100) and `offset`.\n\nDeveloper tools: a hosted MCP server for SI agents at https://api.companystack.co.uk/mcp (Streamable HTTP, API key in `X-Api-Key`; https://companystack.co.uk/developers/mcp), Postman, Bruno and Hoppscotch collections (https://companystack.co.uk/developers/postman), and JavaScript and Python examples (https://companystack.co.uk/developers/sdks).\n\nData provenance: accounts figures are read by software from filings at Companies House and pass automated plausibility checks before they are published; they are shown as filed and not audited or verified by CompanyStack. Each year in `GET /accounts/{number}` says how it was read (`source.kind`: `filed` for electronic accounts, `scanned` for PDF or paper read by OCR, `comparative` for the prior-year column of the next year's accounts, or `unverified`), with `source.quality`, `source.flags` and `source.implausible` recording the checks; `basis` is `company` or `group` (consolidated), `currency` is the currency filed (never converted) and `restated` holds figures a later filing reported differently. Responses are a point-in-time copy of public records that can lag the source, provided as is and without warranty; scores, KYB results and Signals are indicators, not credit ratings or advice. Terms, clauses 15 to 15B: https://companystack.co.uk/terms#data-accuracy.\n\nGenerated from the OpenAPI spec 2.1.0. Set `apiKey` in the \"CompanyStack\" environment (or the collection variables) to your key.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Api-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.companystack.co.uk", "type": "string" } ], "item": [ { "name": "Auth", "description": "Registration and API key management", "item": [ { "id": "40e9b56e-0726-48e2-ae64-867ccb85fdab", "name": "Register a new account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/register", "host": [ "{{baseUrl}}" ], "path": [ "auth", "register" ] }, "description": "Register a new account\n\nCreate an account. We email the address a link to confirm it; the account can be signed in to once it is confirmed, and your first API key is made then (create more on the API keys page). The reply is the same whether or not the address already has an account (its owner is emailed instead), so it cannot be used to find out who has one.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [] }, { "id": "f00f696b-9445-481e-ab5d-2121740be5ce", "name": "Login to view API keys", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/login", "host": [ "{{baseUrl}}" ], "path": [ "auth", "login" ] }, "description": "Login to view API keys", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } }, "response": [] }, { "id": "57d5784e-43ca-4b2b-ac1b-8fbf77eaa7f6", "name": "List your API keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/keys", "host": [ "{{baseUrl}}" ], "path": [ "auth", "keys" ] }, "description": "List your API keys\n\nMasked keys with creation date, last use and requests today." }, "response": [] }, { "id": "b929a81c-c339-425a-a989-6df5daceef04", "name": "Create an API key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/keys", "host": [ "{{baseUrl}}" ], "path": [ "auth", "keys" ] }, "description": "Create an API key\n\nReturns the full key once. Free accounts can hold 3 active keys, Starter 5, Business 10.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "0acdd9d4-fd48-421c-a6f0-76e8a511ef1a", "name": "Regenerate an API key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/keys/:id/regenerate", "host": [ "{{baseUrl}}" ], "path": [ "auth", "keys", ":id", "regenerate" ], "variable": [ { "key": "id", "value": "1", "description": "" } ] }, "description": "Regenerate an API key\n\nRevokes the key and issues a replacement with the same name." }, "response": [] }, { "id": "6aa8a48d-67b7-4b1f-a916-bac542417228", "name": "Revoke an API key", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "auth", "keys", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "" } ] }, "description": "Revoke an API key" }, "response": [] }, { "id": "1302088f-a784-492b-a16d-c3b0f0b16c89", "name": "Usage against your plan limits", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/auth/usage", "host": [ "{{baseUrl}}" ], "path": [ "auth", "usage" ] }, "description": "Usage against your plan limits\n\nAPI-key usage against your plan limits: this minute and today (the counters the rate limiter enforces), requests refused with 429 (`rate_limited`, today and 30 days; they use no quota), this month, the last 30 days by day, by endpoint and by key (with `paused` keys beyond the plan's key limit), requests per hour today, and the signed-in website's own usage in `website`." }, "response": [] } ] }, { "name": "Companies", "description": "Company lookup, search, and bulk operations", "item": [ { "id": "2c1a4522-6201-4ff9-aebb-4e4920320867", "name": "Get company by number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/company/:number", "host": [ "{{baseUrl}}" ], "path": [ "company", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Get company by number\n\nRetrieve detailed company profile by Companies House number." }, "response": [] }, { "id": "b9debef6-c344-4313-a399-c474562bc673", "name": "Search companies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/company/search?q=tesco", "host": [ "{{baseUrl}}" ], "path": [ "company", "search" ], "query": [ { "key": "q", "value": "tesco", "description": "Words in the company name (full-text, ranked by relevance)", "disabled": false }, { "key": "status", "value": "", "description": "Company status, case-insensitive substring (e.g. active, dissolved)", "disabled": true }, { "key": "sic", "value": "62020", "description": "Exact SIC code, matched against any of the company's four", "disabled": true }, { "key": "postcode", "value": "EC2", "description": "Registered office postcode area (B, SW), district (M1, SW1A; EC2 includes EC2A to EC2Y), sector (M1 1) or postcode (M1 1AE). \"B\" is Birmingham only, not BA to BT; anything else is a 400.", "disabled": true }, { "key": "town", "value": "LEEDS", "description": "Registered office post town, case-insensitive substring", "disabled": true }, { "key": "limit", "value": "20", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "Results to skip, for paging. Paid plans only: on the Free plan offset is not applied and the first page is always returned.", "disabled": true } ] }, "description": "Search companies\n\nFull-text search across about 6 million UK companies. Give at least one of q, status, sic, postcode or town; filters combine with AND.\n\nFree plan: only the first page is available. At most 10 results are returned and `offset` is not applied (the response reports `offset: 0`), so a loop that pages until it gets an empty page never ends: stop when a page holds fewer results than `limit`, or when `paging_limited` is true. When the plan limits paging, the response carries `paging_limited: true`, the ignored `requested_offset`, a plain-sentence `notice` and an `upgrade_url`. Paid plans return up to 100 results per page and page with `offset`." }, "response": [] }, { "id": "dccb8df6-03a3-4479-aad0-052f7eadc881", "name": "Autocomplete company names", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/company/autocomplete?q=", "host": [ "{{baseUrl}}" ], "path": [ "company", "autocomplete" ], "query": [ { "key": "q", "value": "", "description": "", "disabled": false }, { "key": "limit", "value": "10", "description": "Suggestions to return (capped by your plan)", "disabled": true } ] }, "description": "Autocomplete company names" }, "response": [] }, { "id": "e8ea2846-0475-4371-a950-e85d9503cf17", "name": "Bulk lookup (up to 100)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/company/bulk", "host": [ "{{baseUrl}}" ], "path": [ "company", "bulk" ] }, "description": "Bulk lookup (up to 100)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "34304244-b628-4aa4-a1c1-0bec6fe409b0", "name": "Companies by SIC code", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/company/sic/:code", "host": [ "{{baseUrl}}" ], "path": [ "company", "sic", ":code" ], "variable": [ { "key": "code", "value": "62020", "description": "" } ] }, "description": "Companies by SIC code" }, "response": [] }, { "id": "455aaf76-85f1-49c9-ad1c-b8b9c5156cc8", "name": "Companies by postcode", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/company/postcode/:prefix", "host": [ "{{baseUrl}}" ], "path": [ "company", "postcode", ":prefix" ], "variable": [ { "key": "prefix", "value": "EC2", "description": "" } ] }, "description": "Companies by postcode" }, "response": [] } ] }, { "name": "Intelligence", "description": "Health scores, filed accounts, the financial screener, benchmarks and timelines", "item": [ { "id": "ffed685b-e18c-44c6-a047-de6b82375e96", "name": "Company health score", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/health/:number", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "health", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Company health score\n\nA rules-based health score (0 to 100) with a grade, the dimensions and signals behind it, red flags and positive signals, built from public records and the company's filed accounts. It is an indicator, not a credit rating." }, "response": [] }, { "id": "67f7924f-f303-4820-a7a6-a1c289d47f39", "name": "Director network analysis", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/directors/:number", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "directors", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Director network analysis" }, "response": [] }, { "id": "a4cc543a-4fa4-4e60-a6bc-73fe0eb6adcc", "name": "Corporate group structure", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/group/:number", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "group", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Corporate group structure" }, "response": [] }, { "id": "87cecd3c-1a70-4547-a0ae-426d742a54f2", "name": "Sector benchmark", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/benchmark/:number", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "benchmark", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Sector benchmark" }, "response": [] }, { "id": "9eb6a11b-db12-44a5-a844-9ea1bc2f2602", "name": "Company timeline", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/timeline/:number", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "timeline", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Company timeline" }, "response": [] }, { "id": "fd4f06d3-9dd7-4863-ae52-8b736ef7d46d", "name": "Financial indicators", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/financials/:number", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "financials", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Financial indicators" }, "response": [] }, { "id": "365e0f6a-e8e9-4f09-adb7-40661c6f4f5d", "name": "Filed accounts, year by year", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/:number", "host": [ "{{baseUrl}}" ], "path": [ "accounts", ":number" ], "query": [ { "key": "basis", "value": "presented", "description": "presented: one row per year, group figures where held, else company figures. group: consolidated figures only. company: the legal entity's own figures only. Years held only on the other basis are left out.", "disabled": true }, { "key": "limit", "value": "20", "description": "Years to return, newest first (capped by your plan: history_limited_to)", "disabled": true } ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Filed accounts, year by year\n\nEvery year of accounts figures held for a company, newest first, with ratios and where each year's figures came from. A company that heads a group files two sets of figures for a year: its own (basis `company`) and the consolidated group's (basis `group`). By default one row per year is returned, the group figures where they are held and the company figures otherwise; `basis` selects one basis only. Every row states its `basis`, and `bases` counts the years held on each." }, "response": [] }, { "id": "76d2176e-7fa0-4a46-adca-813be941e3ed", "name": "Screen companies by their filed figures, place, age and filings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/accounts/search/filter?min_turnover=1000000", "host": [ "{{baseUrl}}" ], "path": [ "accounts", "search", "filter" ], "query": [ { "key": "min_turnover", "value": "1000000", "description": "Turnover at least (pounds)", "disabled": false }, { "key": "max_turnover", "value": "", "description": "Turnover at most (pounds)", "disabled": true }, { "key": "min_assets", "value": "", "description": "Total assets at least", "disabled": true }, { "key": "max_assets", "value": "", "description": "Total assets at most", "disabled": true }, { "key": "min_net_assets", "value": "", "description": "Net assets at least (negative for net liabilities)", "disabled": true }, { "key": "max_net_assets", "value": "", "description": "Net assets at most", "disabled": true }, { "key": "min_profit", "value": "", "description": "Profit at least", "disabled": true }, { "key": "max_profit", "value": "", "description": "Profit at most", "disabled": true }, { "key": "min_employees", "value": "", "description": "Employees at least", "disabled": true }, { "key": "max_employees", "value": "", "description": "Employees at most", "disabled": true }, { "key": "min_cash", "value": "", "description": "Cash at bank at least", "disabled": true }, { "key": "max_cash", "value": "", "description": "Cash at bank at most", "disabled": true }, { "key": "min_liabilities", "value": "", "description": "Current liabilities at least", "disabled": true }, { "key": "max_liabilities", "value": "", "description": "Current liabilities at most", "disabled": true }, { "key": "min_turnover_growth", "value": "", "description": "Turnover growth on the year before, at least (percent)", "disabled": true }, { "key": "max_turnover_growth", "value": "", "description": "Turnover growth, at most (percent)", "disabled": true }, { "key": "min_employee_growth", "value": "", "description": "Employee growth on the year before, at least (percent)", "disabled": true }, { "key": "max_employee_growth", "value": "", "description": "Employee growth, at most (percent)", "disabled": true }, { "key": "sic_code", "value": "62", "description": "SIC code or its start (2 to 5 digits), comma-separated for several", "disabled": true }, { "key": "status", "value": "", "description": "Company status, e.g. active", "disabled": true }, { "key": "accounts_type", "value": "", "description": "Accounts type as filed, e.g. micro-entity, small, full", "disabled": true }, { "key": "region", "value": "", "description": "Region slug, e.g. yorkshire-and-the-humber", "disabled": true }, { "key": "town", "value": "LEEDS", "description": "Registered office post town", "disabled": true }, { "key": "county", "value": "", "description": "ONS county codes, comma-separated", "disabled": true }, { "key": "local_authority", "value": "E08000035", "description": "ONS local authority codes, comma-separated", "disabled": true }, { "key": "constituency", "value": "", "description": "ONS constituency codes, comma-separated", "disabled": true }, { "key": "ward", "value": "", "description": "ONS ward codes, comma-separated", "disabled": true }, { "key": "msoa", "value": "", "description": "ONS MSOA codes, comma-separated", "disabled": true }, { "key": "rural_urban", "value": "", "description": "rural or urban", "disabled": true }, { "key": "imd_decile_min", "value": "", "description": "Index of multiple deprivation decile at least (1 = most deprived tenth)", "disabled": true }, { "key": "imd_decile_max", "value": "", "description": "Deprivation decile at most", "disabled": true }, { "key": "incorporated_from", "value": "", "description": "Incorporated on or after (YYYY-MM-DD)", "disabled": true }, { "key": "incorporated_to", "value": "", "description": "Incorporated on or before (YYYY-MM-DD)", "disabled": true }, { "key": "accounts_overdue", "value": "", "description": "Only companies whose accounts are overdue", "disabled": true }, { "key": "accounts_overdue_days", "value": "", "description": "Accounts overdue by at least this many days", "disabled": true }, { "key": "confirmation_overdue", "value": "", "description": "Only companies whose confirmation statement is overdue", "disabled": true }, { "key": "confirmation_overdue_days", "value": "", "description": "Confirmation statement overdue by at least this many days", "disabled": true }, { "key": "gazette", "value": "", "description": "Gazette notice groups, comma-separated (e.g. insolvency, strike_off)", "disabled": true }, { "key": "gazette_days", "value": "", "description": "Gazette notices within this many days (default 365)", "disabled": true }, { "key": "insolvent", "value": "", "description": "Only companies with insolvency notices", "disabled": true }, { "key": "net_assets_falling", "value": "", "description": "Only companies whose net assets fell on the year before", "disabled": true }, { "key": "has_charges", "value": "", "description": "Only companies with outstanding charges", "disabled": true }, { "key": "exclude_holding", "value": "", "description": "Leave out holding and financing vehicles", "disabled": true }, { "key": "include_implausible", "value": "", "description": "Include figures that fail the plausibility checks", "disabled": true }, { "key": "include_mass_registration", "value": "", "description": "Include companies at mass-registration addresses", "disabled": true }, { "key": "basis", "value": "", "description": "Force the basis (normally chosen from the filters)", "disabled": true }, { "key": "sort", "value": "", "description": "", "disabled": true }, { "key": "order", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "50", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ] }, "description": "Screen companies by their filed figures, place, age and filings\n\nThe financial screener: companies matching every filter given (AND), judged on their latest filed accounts whenever a figure is filtered or sorted on (`basis_code: accounts`), otherwise on the register with or without accounts (`register`). Give at least one filter; without one the 400 lists `filters_available`. Money is in whole pounds. Figures that fail the plausibility checks are left out unless `include_implausible=true`, and companies at mass-registration addresses unless `include_mass_registration=true`. Up to 200 rows a page, paged with offset; `total` is capped at 10,000. Needs API Starter or above." }, "response": [] } ] }, { "name": "PSC", "description": "Persons of Significant Control (ownership data)", "item": [ { "id": "a42bc109-faf1-49f8-ad98-1ce5dfa532b4", "name": "Persons of significant control", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/psc/company/:number", "host": [ "{{baseUrl}}" ], "path": [ "psc", "company", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Persons of significant control" }, "response": [] }, { "id": "2216df65-b11a-4584-ab0e-ea96f2736c79", "name": "Search PSC records", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/psc/search?name=Smith", "host": [ "{{baseUrl}}" ], "path": [ "psc", "search" ], "query": [ { "key": "name", "value": "Smith", "description": "", "disabled": false }, { "key": "limit", "value": "20", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ] }, "description": "Search PSC records" }, "response": [] }, { "id": "75d1a509-8e97-4589-ae80-1ca343a27616", "name": "Companies a person has significant control of", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/psc/network/:name", "host": [ "{{baseUrl}}" ], "path": [ "psc", "network", ":name" ], "query": [ { "key": "born", "value": "", "description": "Month and year of birth (YYYY-MM): only people born then, to tell apart people who share a name", "disabled": true }, { "key": "limit", "value": "50", "description": "", "disabled": true } ], "variable": [ { "key": "name", "value": "Smith", "description": "Name to match (substring, case-insensitive)" } ] }, "description": "Companies a person has significant control of" }, "response": [] } ] }, { "name": "Analytics", "description": "Market and industry statistics", "item": [ { "id": "ff8b0bd5-229f-468e-ab9c-f85b1a726c3b", "name": "Market overview statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/overview", "host": [ "{{baseUrl}}" ], "path": [ "analytics", "overview" ] }, "description": "Market overview statistics" }, "response": [] }, { "id": "7b3ab719-0c9a-43c9-acb9-918800b12831", "name": "Search SIC codes by description", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/sic-search?q=", "host": [ "{{baseUrl}}" ], "path": [ "analytics", "sic-search" ], "query": [ { "key": "q", "value": "", "description": "", "disabled": false } ] }, "description": "Search SIC codes by description" }, "response": [] }, { "id": "769d3078-9da8-47ac-a16a-3aa9cc9e91f1", "name": "Get all SIC codes with company counts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/sic-codes", "host": [ "{{baseUrl}}" ], "path": [ "analytics", "sic-codes" ] }, "description": "Get all SIC codes with company counts" }, "response": [] }, { "id": "54e23e2b-416d-4daa-ab3f-297b0166c442", "name": "Industry analytics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/sic/:code", "host": [ "{{baseUrl}}" ], "path": [ "analytics", "sic", ":code" ], "variable": [ { "key": "code", "value": "62020", "description": "" } ] }, "description": "Industry analytics" }, "response": [] }, { "id": "10ca2356-3038-404c-aa29-09c9a1fe496a", "name": "Area analytics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/analytics/postcode/:prefix", "host": [ "{{baseUrl}}" ], "path": [ "analytics", "postcode", ":prefix" ], "variable": [ { "key": "prefix", "value": "EC2", "description": "" } ] }, "description": "Area analytics" }, "response": [] } ] }, { "name": "Enterprise", "description": "Due diligence and competitive intelligence", "item": [ { "id": "e152293f-2662-4333-a148-c3bb4539de18", "name": "Due diligence report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/enterprise/due-diligence/:number", "host": [ "{{baseUrl}}" ], "path": [ "enterprise", "due-diligence", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Due diligence report\n\nComprehensive risk assessment with PSC analysis." }, "response": [] }, { "id": "3df3bd3e-e0fb-4514-a0a7-80e58fd4ecdf", "name": "Find competitors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/enterprise/competitors/:number", "host": [ "{{baseUrl}}" ], "path": [ "enterprise", "competitors", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Find competitors" }, "response": [] } ] }, { "name": "Live", "description": "Real-time Companies House proxy — officers, filings, charges, insolvency, PSC", "item": [ { "id": "bb3f2372-1be0-42ad-a1ad-3b52a38b3c03", "name": "Real-time company profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/profile/:number", "host": [ "{{baseUrl}}" ], "path": [ "live", "profile", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Real-time company profile\n\nFetches the latest company profile directly from Companies House in real-time." }, "response": [] }, { "id": "cd429555-e5fb-4629-a73a-940f8b7e1b4d", "name": "Company officers (directors & secretaries)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/officers/:number", "host": [ "{{baseUrl}}" ], "path": [ "live", "officers", ":number" ], "query": [ { "key": "limit", "value": "100", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Company officers (directors & secretaries)\n\nReal-time list of current and resigned directors, secretaries, and other officers." }, "response": [] }, { "id": "8a59de8a-2f94-4954-a837-201888d9f73c", "name": "Persons with significant control (live)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/psc/:number", "host": [ "{{baseUrl}}" ], "path": [ "live", "psc", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Persons with significant control (live)\n\nReal-time beneficial ownership data — who controls the company." }, "response": [] }, { "id": "e2a8d515-54e5-4f1a-ab8d-7b021578cece", "name": "Mortgages & charges", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/charges/:number", "host": [ "{{baseUrl}}" ], "path": [ "live", "charges", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Mortgages & charges\n\nAll secured charges (mortgages, debentures, liens) registered against the company." }, "response": [] }, { "id": "08394844-4f14-462b-a3d1-0ee9c32eed8f", "name": "Filing history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/filings/:number", "host": [ "{{baseUrl}}" ], "path": [ "live", "filings", ":number" ], "query": [ { "key": "category", "value": "", "description": "Filter filings by category", "disabled": true }, { "key": "limit", "value": "25", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Filing history\n\nComplete filing history from Companies House. Filter by category (accounts, confirmation-statement, annual-return, etc)." }, "response": [] }, { "id": "15758a3d-2006-4010-adf8-96ebb7e001b3", "name": "Insolvency history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/insolvency/:number", "host": [ "{{baseUrl}}" ], "path": [ "live", "insolvency", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Insolvency history\n\nLiquidation, administration, and other insolvency proceedings." }, "response": [] }, { "id": "88755ce8-534c-48f1-a1f6-37c9d32b344e", "name": "Full real-time company report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/complete/:number", "host": [ "{{baseUrl}}" ], "path": [ "live", "complete", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Full real-time company report\n\nComprehensive report combining our snapshot data with all real-time Companies House data (profile, officers, PSC, charges, filings, insolvency) in a single call." }, "response": [] }, { "id": "5eed3036-2956-4ff6-ac51-75e2d1cd6d5a", "name": "Circuit breaker health status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/live/status", "host": [ "{{baseUrl}}" ], "path": [ "live", "status" ] }, "description": "Circuit breaker health status\n\nReturns the current state of the Companies House API circuit breaker." }, "response": [] } ] }, { "name": "Watchlist", "description": "Company monitoring — watch companies and receive change alerts", "item": [ { "id": "5307a8bd-1c10-40ec-a982-323a653909df", "name": "List watched companies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist", "host": [ "{{baseUrl}}" ], "path": [ "watchlist" ], "query": [ { "key": "limit", "value": "50", "description": "At most 100, or 500 with scope=monitored", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true }, { "key": "scope", "value": "default", "description": "monitored: every company on a monitored list, not only My watchlist", "disabled": true } ] }, "description": "List watched companies\n\nList the companies on your watchlist (\"My watchlist\", the default list) with current status and unread alert counts. With scope=monitored, every company on any monitored list you can see, once each, with the lists that hold it. Both forms include monitored_total (companies on monitored lists) and monitored_lists." }, "response": [] }, { "id": "4884469d-d3f5-4730-a379-f87461036a87", "name": "Add company to watchlist", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist", "host": [ "{{baseUrl}}" ], "path": [ "watchlist" ] }, "description": "Add company to watchlist", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "11c40bb1-7c28-4a2e-ab7d-8c78e2248f89", "name": "Remove from watchlist", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/:company_number", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", ":company_number" ], "variable": [ { "key": "company_number", "value": "00445790", "description": "" } ] }, "description": "Remove from watchlist" }, "response": [] }, { "id": "bf538ced-fcdf-4db8-aa9c-a3dc218bd6bd", "name": "Get alerts for watched companies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/alerts", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", "alerts" ], "query": [ { "key": "alert_type", "value": "", "description": "", "disabled": true }, { "key": "company_number", "value": "00445790", "description": "", "disabled": true }, { "key": "since", "value": "", "description": "", "disabled": true }, { "key": "until", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "50", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ] }, "description": "Get alerts for watched companies\n\nPaginated alerts for all watched companies with read/unread status." }, "response": [] }, { "id": "c95ae451-cac3-492f-a0dc-3ace821efd10", "name": "Mark alert as read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/alerts/:id/read", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", "alerts", ":id", "read" ], "variable": [ { "key": "id", "value": "1", "description": "" } ] }, "description": "Mark alert as read" }, "response": [] }, { "id": "03469ce3-dd64-4091-ae33-267143026dd6", "name": "Alert summary counts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/alerts/summary", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", "alerts", "summary" ] }, "description": "Alert summary counts\n\nTotal unread alerts, broken down by type and company." }, "response": [] }, { "id": "10088b18-d50d-4445-a6fc-9c094b116c55", "name": "Webhook signing secret", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/webhook-secret", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", "webhook-secret" ] }, "description": "Webhook signing secret\n\nWatchlist alerts are POSTed to each entry's webhook_url as JSON events (`type: company.alert`). Verify the `CompanyStack-Signature` header: `t=,v1=.\")>`, compare in constant time, reject timestamps older than 5 minutes, and de-duplicate on `CompanyStack-Event-Id`. Failed deliveries are retried after 1m, 5m, 30m, 2h, 6h, 12h and 24h." }, "response": [] }, { "id": "33c37f91-5d7d-4f1b-a248-17c99c927884", "name": "Rotate the webhook signing secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/webhook-secret/rotate", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", "webhook-secret", "rotate" ] }, "description": "Rotate the webhook signing secret\n\nFor 24 hours both secrets sign each webhook (two v1 values)." }, "response": [] }, { "id": "f2d8cfd6-3294-41fd-a2a3-439e80b6736a", "name": "Send a signed test webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/webhooks/test", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", "webhooks", "test" ] }, "description": "Send a signed test webhook", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/hooks/companystack\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "fa003ac0-f139-443d-ae2f-2e1928091beb", "name": "Webhook delivery log", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/watchlist/webhooks/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "watchlist", "webhooks", "deliveries" ], "query": [ { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "50", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ] }, "description": "Webhook delivery log" }, "response": [] } ] }, { "name": "Officers", "description": "Officer data with 24-hour caching from Companies House", "item": [ { "id": "d2f320b6-ddd6-44cc-aae4-2c0815c7b21d", "name": "Get company officers (cached)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/officers/company/:number", "host": [ "{{baseUrl}}" ], "path": [ "officers", "company", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Get company officers (cached)\n\nEvery appointment at a company, current and resigned, read from Companies House (every page) and cached; served from the cache while it is under 24 hours old. A person re-appointed to the same role has a row for each appointment. When Companies House cannot be reached, the cached copy is served however old (`_stale: true`, with `_cached_at`); with no copy held the response is 503 with code companies_house_unavailable and Retry-After." }, "response": [] }, { "id": "d438823f-a93b-4ca2-aa5e-996cd465dcb5", "name": "Search officers by name", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/officers/search?name=Smith", "host": [ "{{baseUrl}}" ], "path": [ "officers", "search" ], "query": [ { "key": "name", "value": "Smith", "description": "", "disabled": false }, { "key": "limit", "value": "20", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ] }, "description": "Search officers by name\n\nEvery director, secretary and LLP member on the Companies House register, by name (Companies House's officer search, cached for six hours). Each result is a person or corporate officer with their date of birth (month and year), number of appointments and correspondence address; pass `officer_id` to GET /officers/{officer_id}/appointments for their appointments. When the search allowance for Companies House is used up the response is 503 with code search_busy and Retry-After." }, "response": [] }, { "id": "caf520bf-84d7-42b4-a330-3214b36fb90d", "name": "All appointments for a person", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/officers/person/:name/appointments", "host": [ "{{baseUrl}}" ], "path": [ "officers", "person", ":name", "appointments" ], "query": [ { "key": "limit", "value": "50", "description": "Appointments to return, current ones first", "disabled": true } ], "variable": [ { "key": "name", "value": "SMITH, John", "description": "" } ] }, "description": "All appointments for a person\n\nSearches the whole Companies House register of officers for the name (the same search as GET /officers/search, cached for six hours), keeps the people whose name holds every word given, in any order (accents, punctuation, case and titles ignored), and reads the appointments of up to 5 of them (as GET /officers/{officer_id}/appointments, cached for up to 3 days). Appointments are grouped by company, current ones first; each position names the officer_id and name it belongs to, and `people` lists each person with their month and year of birth, so different people who share a name can be told apart. People who have objected cannot be found by name, and appointments withheld at their request are left out. people_matched, people_truncated and people_unavailable say how many people matched, whether more matched than were read, and how many could not be read just now; other_names_found offers up to 5 other names the search found (often Companies House's own spelling) to search again with." }, "response": [] }, { "id": "ee4ebc2f-3535-4699-aff8-be58377ff156", "name": "Director history: one officer's appointments across companies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/officers/:officer_id/appointments", "host": [ "{{baseUrl}}" ], "path": [ "officers", ":officer_id", "appointments" ], "variable": [ { "key": "officer_id", "value": "", "description": "" } ] }, "description": "Director history: one officer's appointments across companies\n\nEvery appointment of one officer, current and resigned, across all companies, from the Companies House officer appointments register (cached for up to 3 days), with what happened to each company: in insolvency, dissolved with its accounts overdue (consistent with compulsory strike-off), dissolved, or active. The summary counts companies that failed in the last 5 years while the officer was appointed or within 12 months of leaving, as the health score does. Take officer_id from the officers lists (officer_id in GET /live/officers/{number} and GET /officers/company/{number}). No addresses are returned and the date of birth is month and year only; appointments withheld at the request of the person named are left out. Up to 500 appointments are read (truncated: true beyond that)." }, "response": [] }, { "id": "a87ec289-e644-48cd-ad7c-a0782a88e68c", "name": "Director history summary: counts only", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/officers/:officer_id/appointments/summary", "host": [ "{{baseUrl}}" ], "path": [ "officers", ":officer_id", "appointments", "summary" ], "variable": [ { "key": "officer_id", "value": "", "description": "" } ] }, "description": "Director history summary: counts only\n\nThe counts and summary sentence of GET /officers/{officer_id}/appointments (\"12 appointments, 3 companies in insolvency in the last 5 years\") without the appointments themselves." }, "response": [] } ] }, { "name": "Filings", "description": "Filing history with 24-hour caching from Companies House", "item": [ { "id": "a981ed7a-0f50-46c2-af9c-c91089580fa5", "name": "Get filing history (cached)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/filings/company/:number", "host": [ "{{baseUrl}}" ], "path": [ "filings", "company", ":number" ], "query": [ { "key": "category", "value": "", "description": "Filter by filing category", "disabled": true }, { "key": "limit", "value": "25", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Get filing history (cached)\n\nFiling history for a company — fetches from Companies House and caches locally. Returns from cache if fresh (< 24h)." }, "response": [] }, { "id": "1903c3a6-afcc-476c-a9d1-0e7c11229a29", "name": "Latest filing for a company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/filings/company/:number/latest", "host": [ "{{baseUrl}}" ], "path": [ "filings", "company", ":number", "latest" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Latest filing for a company\n\nReturns just the most recent filing for a company from cache." }, "response": [] }, { "id": "399f051a-79c5-4222-ab57-b249f5ee5f0b", "name": "Recent filings across all companies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/filings/recent", "host": [ "{{baseUrl}}" ], "path": [ "filings", "recent" ], "query": [ { "key": "limit", "value": "20", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ] }, "description": "Recent filings across all companies\n\nMost recent filings from the local cache across all companies." }, "response": [] } ] }, { "name": "Postcodes", "description": "Postcode lookup, companies at the nearest postcodes, and area statistics", "item": [ { "id": "9b5840c3-7c35-4b6a-a205-6bf950bfe8a9", "name": "Postcode lookup with location and the companies registered there", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/postcodes/lookup/:postcode", "host": [ "{{baseUrl}}" ], "path": [ "postcodes", "lookup", ":postcode" ], "variable": [ { "key": "postcode", "value": "EC2R 8AH", "description": "" } ] }, "description": "Postcode lookup with location and the companies registered there\n\nLook up a postcode to get its location and areas (ONS Postcode Directory, Great Britain only: a Northern Ireland postcode returns no location, and `notice` says why) and the companies registered at that postcode." }, "response": [] }, { "id": "a77c0fe4-b8dc-4bcd-aa74-1bc02f34b91a", "name": "Companies at the postcodes nearest a point", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/postcodes/nearby?lat=51.5074&lng=-0.1278", "host": [ "{{baseUrl}}" ], "path": [ "postcodes", "nearby" ], "query": [ { "key": "lat", "value": "51.5074", "description": "", "disabled": false }, { "key": "lng", "value": "-0.1278", "description": "", "disabled": false }, { "key": "radius", "value": "1", "description": "Only postcodes within this many km are considered (at most the 20 nearest)", "disabled": true }, { "key": "limit", "value": "20", "description": "", "disabled": true } ] }, "description": "Companies at the postcodes nearest a point\n\nCompanies registered at the 20 Great Britain postcodes nearest a latitude/longitude, among those within `radius` km. It does not cover every postcode inside the radius, results are ordered by company name, and no distance is returned." }, "response": [] }, { "id": "1fcc3e61-285e-4ef1-aefe-345b5fca2b62", "name": "Area summary by postcode prefix", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/postcodes/area/:prefix", "host": [ "{{baseUrl}}" ], "path": [ "postcodes", "area", ":prefix" ], "variable": [ { "key": "prefix", "value": "EC2", "description": "" } ] }, "description": "Area summary by postcode prefix\n\nGet summary statistics for a postcode area including company counts and top industries." }, "response": [] } ] }, { "name": "Search", "description": "Industry search and filtered company listings", "item": [ { "id": "0a72189f-f7e1-4fb9-af0a-c9482a75628f", "name": "Search industries by keyword", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/search/industry?q=software", "host": [ "{{baseUrl}}" ], "path": [ "search", "industry" ], "query": [ { "key": "q", "value": "software", "description": "", "disabled": false }, { "key": "limit", "value": "20", "description": "", "disabled": true } ] }, "description": "Search industries by keyword\n\nSIC codes whose description contains every word of the keyword (or whose code starts with it, e.g. 620), with each code's description and its number of active companies (primary SIC code), largest first." }, "response": [] }, { "id": "2c5f1d0b-1243-4b6d-a840-eb3edc73f164", "name": "Companies in an industry", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/search/industry/:code/companies", "host": [ "{{baseUrl}}" ], "path": [ "search", "industry", ":code", "companies" ], "query": [ { "key": "postcode", "value": "EC2R 8AH", "description": "Registered office postcode area (B, SW), district (M1, SW1A), sector (M1 1) or postcode (M1 1AE); \"B\" is Birmingham only, not BA to BT", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "20", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ], "variable": [ { "key": "code", "value": "62020", "description": "" } ] }, "description": "Companies in an industry\n\nList companies by SIC code with optional postcode and status filters." }, "response": [] } ] }, { "name": "KYB", "description": "One-call business verification with pass / refer / fail, reason codes and a stored audit record", "item": [ { "id": "a51f5468-aaca-4bc1-a023-71da31e50836", "name": "Verify a company (KYB) in one call", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/kyb/check", "host": [ "{{baseUrl}}" ], "path": [ "kyb", "check" ] }, "description": "Verify a company (KYB) in one call\n\nRuns structured checks — existence, status, name and registered postcode match, age, overdue filings, Gazette company insolvency notices, PSC register and PSC discrepancies against the beneficial owners you supply, named directors, disqualified-director screening (it reports `unable_to_check`, never `pass`, while CompanyStack's copy of the disqualified directors register is not complete and current), sanctions screening (the company, its previous names, current PSCs and officers against every sanctions list loaded, including the UK Sanctions List (which includes the UN designations the UK gives effect to), the EU list, the US lists (OFAC and Consolidated Screening List) and the Canadian, Australian, NZ and French lists; full detail in the `sanctions` field, see GET /sanctions/company/{number}), optional ECCTA identity verification, registered-address density and net assets — and returns an overall `pass`, `refer`, `fail` or `unable_to_check` with reason codes. `unable_to_check` means nothing failed but a check that matters could not run: the officers could not be read (Companies House unreachable and no copy held), so no director was checked, or a source the check needs is missing, incomplete or out of date in CompanyStack's copy (the disqualified directors register, The Gazette's insolvency notices, the sanctions lists, the PSC register, or identity verification when you asked for it). A missing source is never read as \"nothing found\". It is never a pass, and outranks `refer` (whose reasons are still listed); run the check again later. Every result is stored and can be retrieved later with GET /kyb/checks/{id} as evidence of your due diligence.\n\nReason codes: COMPANY_NOT_FOUND, COMPANY_DISSOLVED, COMPANY_IN_INSOLVENCY, PROPOSAL_TO_STRIKE_OFF, VOLUNTARY_ARRANGEMENT, STATUS_UNUSUAL, NAME_MISMATCH, NAME_SIMILAR, NAME_MATCHES_PREVIOUS_NAME, REGISTERED_POSTCODE_MISMATCH, NEWLY_INCORPORATED, ACCOUNTS_OVERDUE, CONFIRMATION_STATEMENT_OVERDUE, INSOLVENCY_NOTICE, STRIKE_OFF_NOTICE, NO_PSC_REGISTERED, PSC_DISCREPANCY, DIRECTOR_NOT_FOUND, POSSIBLE_DISQUALIFIED_PERSON, OFFICERS_UNAVAILABLE (the officers check and every check that needs the officers: result `unable_to_check`), DISQUALIFIED_REGISTER_UNAVAILABLE, GAZETTE_UNAVAILABLE, SANCTIONS_UNAVAILABLE, PSC_REGISTER_UNAVAILABLE, IDENTITY_VERIFICATION_UNAVAILABLE (a source missing, incomplete or out of date: result `unable_to_check`), SANCTIONS_POSSIBLE_MATCH, SANCTIONS_STRONG_MATCH (a name match on a sanctions list: refer, never fail — review it against the official entry), IDENTITY_VERIFICATION_OVERDUE. Warnings: HIGH_DENSITY_REGISTERED_ADDRESS, GAZETTE_HISTORY_PARTIAL (CompanyStack's Gazette copy does not cover the whole 24-month look-back), NEGATIVE_NET_ASSETS, IDENTITY_VERIFICATION_DUE_SOON, SANCTIONS_SCREENING_INCOMPLETE (no matches, but a list was not loaded or not refreshed recently, or some names could not be screened), PSC_EXEMPTION_TO_CONFIRM (a public limited company with no PSC: exempt if its voting shares are admitted to trading on a UK or EEA regulated market — confirm the listing). Organisations outside the PSC rules (overseas companies, registered societies and similar) get psc_register `not_checked`.", "body": { "mode": "raw", "raw": "{\n \"company_number\": \"12345678\",\n \"expected_name\": \"Example Trading Ltd\",\n \"expected_postcode\": \"E14 5AB\",\n \"expected_pscs\": [\n \"Example Holdings Ltd\"\n ],\n \"reference\": \"client-4411\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "7674373a-a9bd-48b3-a414-c655338c4392", "name": "List your stored KYB checks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/kyb/checks", "host": [ "{{baseUrl}}" ], "path": [ "kyb", "checks" ], "query": [ { "key": "company_number", "value": "00445790", "description": "", "disabled": true }, { "key": "outcome", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "50", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "", "disabled": true } ] }, "description": "List your stored KYB checks" }, "response": [] }, { "id": "8d6c3eaa-c3ac-4624-ade5-de3976c60529", "name": "Retrieve a stored KYB check", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/kyb/checks/:id", "host": [ "{{baseUrl}}" ], "path": [ "kyb", "checks", ":id" ], "variable": [ { "key": "id", "value": "kyb_3f9a1c0d5e7b2a4c6d8e0f12", "description": "" } ] }, "description": "Retrieve a stored KYB check\n\nReturns the result exactly as it was returned at the time of the check." }, "response": [] } ] }, { "name": "Change Feed", "description": "Cursor-paginated feed of register changes — poll \"what changed since my last call\"", "item": [ { "id": "64b9958d-d276-49d1-a07c-28c1b43b437f", "name": "Register changes since a cursor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/changes?since=2026-09-01T00:00:00Z", "host": [ "{{baseUrl}}" ], "path": [ "changes" ], "query": [ { "key": "cursor", "value": "", "description": "", "disabled": true }, { "key": "since", "value": "2026-09-01T00:00:00Z", "description": "", "disabled": false }, { "key": "types", "value": "added,dissolved", "description": "Comma list: added, updated, dissolved, removed_from_snapshot, missing_from_snapshot", "disabled": true }, { "key": "companies", "value": "", "description": "Comma list of up to 500 company numbers", "disabled": true }, { "key": "watchlist", "value": "", "description": "Only companies on your watchlist", "disabled": true }, { "key": "sic", "value": "62,6311", "description": "SIC codes or 2–4 digit prefixes (any of the four SIC codes)", "disabled": true }, { "key": "postcode", "value": "EC2,M1", "description": "Areas, districts, sectors or full postcodes", "disabled": true }, { "key": "limit", "value": "100", "description": "", "disabled": true } ] }, "description": "Register changes since a cursor\n\nEvents recorded as the register changes (monthly snapshot import and the live Companies House stream). Store `next_cursor` and pass it back to receive only newer events; a cursor is returned even when the page is empty. Each call scans at most 20,000 events, so with narrow filters a page can be empty while `has_more` is true — keep paging. Without `cursor`, the feed starts at `since` (default: 7 days ago)." }, "response": [] }, { "id": "1d79a9ae-ce45-46e0-a153-4f31ba5a8c12", "name": "Cursor at the head of the feed", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/changes/cursor", "host": [ "{{baseUrl}}" ], "path": [ "changes", "cursor" ] }, "description": "Cursor at the head of the feed\n\nStart consuming from now without replaying history." }, "response": [] } ] }, { "name": "Compliance", "description": "Identity verification (ECCTA) status, portfolio filing deadlines and iCal feeds", "item": [ { "id": "14c07156-0d35-4cd6-ad2e-bd243e7381ce", "name": "Director & PSC identity verification status (ECCTA)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/compliance/identity/:number", "host": [ "{{baseUrl}}" ], "path": [ "compliance", "identity", ":number" ], "query": [ { "key": "refresh", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "number", "value": "12345678", "description": "" } ] }, "description": "Director & PSC identity verification status (ECCTA)\n\nEvery officer and PSC with their Companies House identity verification dates and a status: verified, overdue, due_soon, pending, not_yet_scheduled or not_applicable. The 12-month transition for existing directors and PSCs runs from 18 November 2025; their due dates follow the confirmation statement or birth month, so some run to 30 November 2026. Data is read from Companies House and cached for 24 hours (`refresh=true` forces a refresh)." }, "response": [] }, { "id": "8862f318-1cd6-4b32-a055-140d0837590f", "name": "Filing and identity verification deadlines for a portfolio", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/compliance/deadlines?types=accounts,confirmation_statement,identity_verification", "host": [ "{{baseUrl}}" ], "path": [ "compliance", "deadlines" ], "query": [ { "key": "companies", "value": "", "description": "Comma list of up to 500 company numbers (default: your watchlist)", "disabled": true }, { "key": "types", "value": "accounts,confirmation_statement,identity_verification", "description": "", "disabled": false }, { "key": "within_days", "value": "90", "description": "", "disabled": true }, { "key": "include_overdue_days", "value": "365", "description": "", "disabled": true } ] }, "description": "Filing and identity verification deadlines for a portfolio\n\nAccounts, confirmation statement and identity verification deadlines for the companies listed, or for your watchlist when `companies` is omitted — e.g. an accountancy practice's client book. Overdue items are included." }, "response": [] }, { "id": "37ee682d-d9bf-4b52-a311-761436d70443", "name": "List calendar feeds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/compliance/calendar-feeds", "host": [ "{{baseUrl}}" ], "path": [ "compliance", "calendar-feeds" ] }, "description": "List calendar feeds" }, "response": [] }, { "id": "35dd76e9-fc77-48d1-a67b-f644fee34bb5", "name": "Create an iCal feed of your watchlist deadlines", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/compliance/calendar-feeds", "host": [ "{{baseUrl}}" ], "path": [ "compliance", "calendar-feeds" ] }, "description": "Create an iCal feed of your watchlist deadlines\n\nReturns a secret URL (shown once) to subscribe to in Outlook, Google Calendar or Apple Calendar. Events include reminders 30 and 7 days before each deadline.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Client filing deadlines\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "4788ccfe-cea4-4986-a207-0a9b57a9e38c", "name": "Revoke a calendar feed", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/compliance/calendar-feeds/:id", "host": [ "{{baseUrl}}" ], "path": [ "compliance", "calendar-feeds", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "" } ] }, "description": "Revoke a calendar feed" }, "response": [] }, { "id": "03ca3ce8-4ac8-4e1b-a4c0-7a3e65514264", "name": "iCal feed (secret URL)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/calendar/cal_your_feed_token.ics", "host": [ "{{baseUrl}}" ], "path": [ "calendar", "cal_your_feed_token.ics" ] }, "description": "iCal feed (secret URL)", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Financials", "description": "Parsed-accounts history, trends, signals and sector peer comparison", "item": [ { "id": "3b33ddaf-fc57-47f6-a454-ff95ff9b3cdd", "name": "Financial history and trends", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/financials/:number/history", "host": [ "{{baseUrl}}" ], "path": [ "financials", ":number", "history" ], "variable": [ { "key": "number", "value": "12345678", "description": "" } ] }, "description": "Financial history and trends\n\nEvery parsed accounts period with ratios, per-metric trends (change on previous period, CAGR, direction: growing / declining / stable / volatile) and signals such as NET_ASSETS_TURNED_NEGATIVE, CASH_DECLINING, CURRENT_RATIO_BELOW_ONE and LIABILITIES_OUTPACING_ASSETS." }, "response": [] }, { "id": "6957bfa5-121e-4dab-ae0d-5af9e521b4f3", "name": "Peer comparison within the SIC code", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/financials/:number/peers", "host": [ "{{baseUrl}}" ], "path": [ "financials", ":number", "peers" ], "variable": [ { "key": "number", "value": "12345678", "description": "" } ] }, "description": "Peer comparison within the SIC code\n\nPercentile of turnover, net assets, total assets, cash, employees and profit against active companies with the same primary SIC code (latest accounts within 24 months)." }, "response": [] } ] }, { "name": "Prospects", "description": "Filtered company lists and lookalike search", "item": [ { "id": "29c0a64b-bd9f-4ae2-a73c-85e4cd142b1e", "name": "Find companies by sector, place, age and size — or lookalikes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/prospects?sic=62,6311", "host": [ "{{baseUrl}}" ], "path": [ "prospects" ], "query": [ { "key": "sic", "value": "62,6311", "description": "", "disabled": false }, { "key": "postcode", "value": "LS,M1", "description": "", "disabled": true }, { "key": "town", "value": "LEEDS", "description": "", "disabled": true }, { "key": "status", "value": "Active", "description": "Comma list, or \"any\"", "disabled": true }, { "key": "category", "value": "Private Limited Company", "description": "", "disabled": true }, { "key": "accounts_category", "value": "MICRO ENTITY,SMALL", "description": "", "disabled": true }, { "key": "incorporated_from", "value": "", "description": "", "disabled": true }, { "key": "incorporated_to", "value": "", "description": "", "disabled": true }, { "key": "min_age_years", "value": "", "description": "", "disabled": true }, { "key": "max_age_years", "value": "", "description": "", "disabled": true }, { "key": "min_turnover", "value": "", "description": "", "disabled": true }, { "key": "max_turnover", "value": "", "description": "", "disabled": true }, { "key": "min_employees", "value": "", "description": "", "disabled": true }, { "key": "max_employees", "value": "", "description": "", "disabled": true }, { "key": "min_net_assets", "value": "", "description": "", "disabled": true }, { "key": "max_net_assets", "value": "", "description": "", "disabled": true }, { "key": "has_charges", "value": "", "description": "", "disabled": true }, { "key": "exclude_overdue", "value": "", "description": "", "disabled": true }, { "key": "like", "value": "", "description": "Company number to find lookalikes of", "disabled": true }, { "key": "sort", "value": "newest", "description": "", "disabled": true }, { "key": "limit", "value": "25", "description": "", "disabled": true }, { "key": "cursor", "value": "", "description": "", "disabled": true } ] }, "description": "Find companies by sector, place, age and size — or lookalikes\n\nFilters combine with AND; comma-separated values with OR. Needs at least one narrowing filter. `like={company_number}` searches that company's 4-digit SIC class (its postcode area first), scores up to 500 candidates on sector, location, size and age, and returns the closest with a `similarity` of 0–100. New-incorporation lists: `incorporated_from=…&sort=newest`." }, "response": [] } ] }, { "name": "Lists", "description": "Named lists of companies — clients, suppliers, a lending portfolio or prospects. Add companies one at a time, by pasting numbers or names, or from a CSV; CompanyStack keeps each monitored list under watch (alerts, signed webhooks, email digests grouped by list) and summarises status, health grades, overdue filings and deadlines. Your watchlist is your default list, \"My watchlist\": the /watchlist endpoints keep working over it. Lists share your plan's watchlist cap: it counts distinct companies across all your lists.", "item": [ { "id": "3cf56017-d409-4b39-ac05-9eac04788be9", "name": "Your lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists", "host": [ "{{baseUrl}}" ], "path": [ "lists" ], "query": [ { "key": "include_archived", "value": "false", "description": "", "disabled": true } ] }, "description": "Your lists\n\nEvery list you can see, with company counts, status mix, health-grade mix, overdue filings, unread alerts and the next deadline, plus your plan's list allowances and usage." }, "response": [] }, { "id": "09958caa-54c6-456c-a937-4ded5a384c20", "name": "Create a list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists", "host": [ "{{baseUrl}}" ], "path": [ "lists" ] }, "description": "Create a list", "body": { "mode": "raw", "raw": "{\n \"name\": \"My suppliers\",\n \"purpose\": \"suppliers\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "1bb24020-1370-4844-af1e-9569b3409801", "name": "List allowances and usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/usage", "host": [ "{{baseUrl}}" ], "path": [ "lists", "usage" ] }, "description": "List allowances and usage" }, "response": [] }, { "id": "8f26360f-406a-4ca9-a53b-ddb2fb362b8b", "name": "Get or create \"My watchlist\"", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/default", "host": [ "{{baseUrl}}" ], "path": [ "lists", "default" ] }, "description": "Get or create \"My watchlist\"\n\nThe one-click target for watching a company. Same list as the /watchlist endpoints." }, "response": [] }, { "id": "089f7263-827b-4f4c-affc-163f8a0d8fa2", "name": "Which of your lists hold a company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/membership/:number", "host": [ "{{baseUrl}}" ], "path": [ "lists", "membership", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Which of your lists hold a company" }, "response": [] }, { "id": "291ecfdd-89fd-40c2-a085-9b9f307ebd47", "name": "One list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "One list" }, "response": [] }, { "id": "0590160c-2639-4e32-a078-3d0c480b4f3d", "name": "Delete a list", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Delete a list\n\nDeletes the list and its companies' notes and tags. The default list cannot be deleted." }, "response": [] }, { "id": "0dcb1b5d-8a59-479c-a66e-f9d41f2b0b52", "name": "Update a list", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Update a list\n\nRename, change purpose, turn monitoring or alert channels on or off, share with your team, archive (`archived: true`) or restore (`archived: false`).", "body": { "mode": "raw", "raw": "{\n \"name\": \"Key suppliers\",\n \"alert_email\": true,\n \"archived\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "f44d71ab-235c-4e70-a671-2913622a289f", "name": "Companies on a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "items" ], "query": [ { "key": "q", "value": "", "description": "Search name, number, reference, note and tags", "disabled": true }, { "key": "status", "value": "", "description": "", "disabled": true }, { "key": "grade", "value": "", "description": "", "disabled": true }, { "key": "tag", "value": "", "description": "", "disabled": true }, { "key": "overdue", "value": "", "description": "", "disabled": true }, { "key": "signals", "value": "", "description": "Add a `signals` summary to each item (raised count, codes, names; highest severity with the Signals add-on). `signals_included` says what you get: full, names or null.", "disabled": true }, { "key": "signal", "value": "", "description": "Only companies with any, no, or this signal raised (needs Signals, or web-app Pro/Team)", "disabled": true }, { "key": "sort", "value": "added", "description": "", "disabled": true }, { "key": "order", "value": "", "description": "", "disabled": true }, { "key": "limit", "value": "100", "description": "", "disabled": true }, { "key": "offset", "value": "0", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Companies on a list\n\nEach company with its status, health grade, last accounts, next deadline, latest change, unread alerts, latest KYB outcome, your reference, tags and note. Filter and sort server-side." }, "response": [] }, { "id": "32449737-97b7-4422-aec8-cb2591484c31", "name": "Add companies", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "items" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Add companies\n\nAdds up to 5,000 companies by number. Companies already on another of your lists use none of your cap. Supplying a reference, note or tags for a company already on the list updates it. When the cap is reached part-way, the rest are returned in `over_limit` (403 if none could be added).", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"company_number\": \"08804411\",\n \"custom_ref\": \"CL-0042\",\n \"tags\": [\n \"VIP\"\n ]\n },\n {\n \"company_number\": \"SC586124\"\n }\n ],\n \"method\": \"api\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "54326578-2c33-4ecc-a709-b0a8516f33c3", "name": "Remove a company from a list", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/items/:number", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "items", ":number" ], "variable": [ { "key": "id", "value": "42", "description": "" }, { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Remove a company from a list" }, "response": [] }, { "id": "275ed044-4d7e-4b96-a117-39246953a7d0", "name": "Edit a company on a list", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/items/:number", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "items", ":number" ], "variable": [ { "key": "id", "value": "42", "description": "" }, { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Edit a company on a list", "body": { "mode": "raw", "raw": "{\n \"note\": \"Chased for accounts 1 Oct\",\n \"tags\": [\n \"VIP\",\n \"Payroll\"\n ],\n \"custom_ref\": \"CL-0042\",\n \"notify_email\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "eba1a16a-82d8-40f6-a300-8b3cb7f337a3", "name": "Remove several companies", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/items/remove", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "items", "remove" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Remove several companies", "body": { "mode": "raw", "raw": "{\n \"company_numbers\": [\n \"08804411\",\n \"SC586124\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "76e27d5a-bfd9-443c-ac1b-397f437408d3", "name": "Match pasted text or a CSV before adding", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/import/preview", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "import", "preview" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Match pasted text or a CSV before adding\n\nPaste company numbers or names (one per line), or send a CSV file's text with `source: \"csv\"`. The company number column is found by its header (\"Company number\", \"CRN\", \"Reg no\"…) or its contents; names are matched against the register (exact name after ignoring punctuation and LIMITED/LTD; a registered postcode column settles ties). Your reference, tags, note and postcode columns are picked up too. Nothing is added: send the matched numbers to POST /lists/{id}/items. Rows come back as matched, ambiguous (with up to 5 candidates to choose from), not_found or already_on_list, and rejected rows carry the reason. CSV import needs a plan with CSV (Pro, Team or a paid API plan); pasting is on every plan.", "body": { "mode": "raw", "raw": "{\n \"source\": \"csv\",\n \"text\": \"Client code,Company name,Company number\\nCL-0042,Example Trading Ltd,8804411\\nCL-0043,Acme Widgets Limited,\\n\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "1171250e-0d2d-4946-a6c1-8b64ed7310a0", "name": "Webhook signing secret for a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/webhook-secret", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "webhook-secret" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Webhook signing secret for a list\n\nThe secret that signs this list's webhook deliveries with the `CompanyStack-Signature` header: the list owner's account secret, which also signs the watchlist's webhooks. Only the account owner can read it (it signs every webhook on the account), on a plan with webhooks (CompanyStack Team or any paid API plan). Rotate it with POST /watchlist/webhook-secret/rotate (account owner)." }, "response": [] }, { "id": "376dbf48-2ed0-4e22-adbf-7ffc984a8490", "name": "List summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/summary", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "summary" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "List summary\n\nCounts by status, grade distribution, overdue filings, unread and recent alerts, the next five deadlines (90 days) and the latest KYB outcomes." }, "response": [] }, { "id": "1fb3ac32-c4cb-48c5-ab83-ee2198e984d2", "name": "\"What changed\" on a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/alerts", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "alerts" ], "query": [ { "key": "limit", "value": "50", "description": "", "disabled": true }, { "key": "before", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "\"What changed\" on a list\n\nAlerts for the list's companies since each was added, newest first. Page with `before` (the last `detected_at`)." }, "response": [] }, { "id": "d37fc94b-5d8f-4531-a70e-bb2bfcbad5a2", "name": "Mark a list's alerts read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/alerts/read", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "alerts", "read" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Mark a list's alerts read" }, "response": [] }, { "id": "2ca45cb4-49c5-4716-a14d-65bc7c25cc17", "name": "Filing deadlines for a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/deadlines", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "deadlines" ], "query": [ { "key": "within_days", "value": "180", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Filing deadlines for a list" }, "response": [] }, { "id": "204e049f-969d-4854-a97b-30cd51e163f1", "name": "iCal feed of a list's deadlines", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/calendar-feed", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "calendar-feed" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "iCal feed of a list's deadlines\n\nReturns a secret subscription URL (shown once) for Outlook, Google Calendar or Apple Calendar. Remove it with DELETE /lists/{id}/calendar-feeds/{feedId}." }, "response": [] }, { "id": "6602f665-f879-4d3f-a260-3a905603d744", "name": "Calendar feeds for a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/calendar-feeds", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "calendar-feeds" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Calendar feeds for a list" }, "response": [] }, { "id": "8d47205a-34e4-419c-ac71-0c78bae53d94", "name": "Remove a calendar feed", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/calendar-feeds/:feedId", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "calendar-feeds", ":feedId" ], "variable": [ { "key": "id", "value": "42", "description": "" }, { "key": "feedId", "value": "1", "description": "" } ] }, "description": "Remove a calendar feed" }, "response": [] }, { "id": "a560d86e-20b7-44ba-a892-86a39b78373e", "name": "Export a list as CSV", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/lists/:id/export.csv", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "export.csv" ], "query": [ { "key": "companies", "value": "", "description": "Comma-separated company numbers", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Export a list as CSV\n\nOne row per company (reference, tags, note, status, grade, deadlines, latest change, latest KYB). From the website this is metered against the web-app plan's monthly export rows. `companies=` exports a selection." }, "response": [] }, { "id": "1d1759ee-3273-43ff-ae20-334844de05e7", "name": "KYB-check a list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/kyb", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "kyb" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "KYB-check a list\n\nQueues a KYB check (as POST /kyb/check, with your reference for each company) for every company on the list, or those in `company_numbers`. Checks count against a monthly allowance (web app: Pro 250, Team 1,000; paid API plans: your watchlist cap); anything over it is returned in `skipped`. Poll GET /lists/{id}/jobs/{jobId}. Each stored check has a PDF certificate at /kyb/checks/{check_id}.pdf.", "body": { "mode": "raw", "raw": "{\n \"company_numbers\": [\n \"08804411\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "347bad7c-c81c-4dc3-a6ef-f600f0211287", "name": "Refresh health grades", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/health", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "health" ], "query": [ { "key": "refresh", "value": "", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Refresh health grades\n\nQueues health scoring for companies not scored in the last 7 days (`?refresh=true` for all)." }, "response": [] }, { "id": "0fc0ec7e-7e90-4bd8-a879-1d77830e00c1", "name": "Recent queued actions on a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/jobs", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "jobs" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Recent queued actions on a list" }, "response": [] }, { "id": "44baf9cf-242c-4c1b-a518-6af2dd80a471", "name": "Progress and results of a queued action", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/jobs/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "jobs", ":jobId" ], "variable": [ { "key": "id", "value": "42", "description": "" }, { "key": "jobId", "value": "1", "description": "" } ] }, "description": "Progress and results of a queued action" }, "response": [] }, { "id": "eee3eda1-e110-489c-a154-579e98ef7c59", "name": "PDF company reports for a list, zipped", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "*/*" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/reports.zip", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "reports.zip" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "PDF company reports for a list, zipped\n\nUp to 25 branded company reports in one ZIP, counted against the web-app plan's monthly report allowance (Pro 50, Team 250). Refused up front if the selection would go over it.", "body": { "mode": "raw", "raw": "{\n \"company_numbers\": [\n \"08804411\",\n \"SC586124\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "c62bc9d9-0a9c-4476-a570-9bd1ab3e509e", "name": "Portfolio summary PDF for a list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/lists/:id/portfolio-summary.pdf", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "portfolio-summary.pdf" ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Portfolio summary PDF for a list\n\nEvery company on the list on one sheet (up to 150; a bigger list shows the ones needing the most attention): health grade, risk, net assets and their change, overdue filings, red flags and what changed since the list's previous summary, then the detail for the companies that need a look. Web-app Pro and Team; not counted against the report allowance. Also included at the top of the reports.zip pack." }, "response": [] }, { "id": "e1f910c7-96ab-494a-aed4-894b95e5e6ba", "name": "Find companies similar to a list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id/similar", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "similar" ], "query": [ { "key": "limit", "value": "25", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "42", "description": "" } ] }, "description": "Find companies similar to a list\n\nLookalikes seeded from the whole list: active companies in the list's most common SIC classes (its most common postcode area first), each scored 0–100 against its closest list member on sector, location, size and age. Companies already on the list are excluded." }, "response": [] } ] }, { "name": "Signals", "description": "CompanyStack Signals (add-on): risk signals about UK companies from Companies House and official registers, each with evidence, sources, licences and the date the source was checked. REGISTRATION_CLUSTER finds many companies in one trade formed at one registered office within 120 days (the mini-umbrella pattern). LICENCE_TO_TRADE checks whether a company whose SIC code normally needs registration appears on the Care Quality Commission, Gambling Commission or Traffic Commissioners' registers; it never says a company is unlicensed, only \"no matching entry found on (checked )\". CUSTOMER_PAYS_SLOWLY reads the company's own payment practices reports. Signals concern companies only. Signals Essentials (+£39 a month, on API Starter or Business, or web-app Team) includes 1,000 lookups a month; Signals Pro (+£149, on API Business) 10,000 and batch checks. Responses carry `X-Signals-Lookups-Limit` and `X-Signals-Lookups-Used`.", "item": [ { "id": "270667c3-af3f-4efc-a1b3-8865807d48b1", "name": "Signals for one company", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/signals/:company_number?codes=REGISTRATION_CLUSTER,LICENCE_TO_TRADE", "host": [ "{{baseUrl}}" ], "path": [ "signals", ":company_number" ], "query": [ { "key": "codes", "value": "REGISTRATION_CLUSTER,LICENCE_TO_TRADE", "description": "Comma-separated signal codes (default: all)", "disabled": false } ], "variable": [ { "key": "company_number", "value": "12345678", "description": "Companies House number (leading zeros may be omitted; SC, NI and other prefixes are kept)" } ] }, "description": "Signals for one company\n\nEvery signal for the company with its state, severity, plain-English message, evidence and sources. Uses one lookup from your monthly allowance (web-app sessions without the add-on see signal names only and are not metered)." }, "response": [] }, { "id": "d17342fc-4ba2-4dd5-a914-3abf0939d686", "name": "Signals for many companies", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/signals/batch", "host": [ "{{baseUrl}}" ], "path": [ "signals", "batch" ] }, "description": "Signals for many companies\n\nUp to 500 companies in one call on Signals Pro (one lookup per company found). Numbers that are not company numbers, or not on the register, are listed and not charged.", "body": { "mode": "raw", "raw": "{\n \"company_numbers\": [\n \"12345678\",\n \"00445790\",\n \"SC586124\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "308ffdcd-7573-453b-ae66-d619a5b4ff06", "name": "Your Signals plan and lookups used", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/signals/usage", "host": [ "{{baseUrl}}" ], "path": [ "signals", "usage" ] }, "description": "Your Signals plan and lookups used" }, "response": [] }, { "id": "dcadfb35-b96f-4698-a9ae-373ebeb0e638", "name": "What each signal checks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/signals/definitions", "host": [ "{{baseUrl}}" ], "path": [ "signals", "definitions" ] }, "description": "What each signal checks\n\nEvery signal's logic, sources with their licences and attribution, known false positives, and the SIC-to-register map. The same data is public (no key) at /public/signals/definitions." }, "response": [] }, { "id": "9d7892e7-8bbd-4d9a-acd2-4f1dda6be1c8", "name": "What each signal checks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/public/signals/definitions", "host": [ "{{baseUrl}}" ], "path": [ "public", "signals", "definitions" ] }, "description": "What each signal checks\n\nEvery signal's logic, sources with their licences and attribution, known false positives, and the SIC-to-register map used by LICENCE_TO_TRADE. No key needed.", "auth": { "type": "noauth" } }, "response": [] }, { "id": "af536ee7-4e60-4dd2-a65e-8a19fa9949b2", "name": "Anonymised registration clusters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/public/signals/examples", "host": [ "{{baseUrl}}" ], "path": [ "public", "signals", "examples" ] }, "description": "Anonymised registration clusters\n\nThe largest registration clusters in staffing, payroll and business-support trades from the latest daily computation: trade, postcode district, counts and months only (no company names, numbers or street addresses). No key needed.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Sanctions", "description": "Screen a company, its previous names, PSCs and officers against the official sanctions lists loaded: the UK Sanctions List (which includes the UN designations the UK gives effect to), the EU list and the lists of the US, Canada, Australia, New Zealand and France, each taken from its publisher and checked for changes every hour (France's every three hours). Japan's list is supported but screened only once a copy is loaded. Each result's `lists` names every list and whether it was screened", "item": [ { "id": "1959a911-423b-49a6-afe7-fd11964f0d97", "name": "Screen a company against sanctions lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sanctions/company/:number", "host": [ "{{baseUrl}}" ], "path": [ "sanctions", "company", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "Companies House number (leading zeros may be omitted)" } ] }, "description": "Screen a company against sanctions lists\n\nScreens the company's registered name and previous names, its current persons with significant control (people and corporate owners) and its current officers (read live from Companies House) against every sanctions list CompanyStack loads, each downloaded from its official publisher and checked for changes every hour (the French register every three hours): UK Sanctions List (Foreign, Commonwealth & Development Office (FCDO)); EU Consolidated Financial Sanctions List (European Commission (Financial Sanctions Files)); OFAC Specially Designated Nationals (SDN) List (US Treasury, Office of Foreign Assets Control); OFAC Consolidated Sanctions List (non-SDN) (US Treasury, Office of Foreign Assets Control); Consolidated Canadian Autonomous Sanctions List (Global Affairs Canada); Australian Sanctions Consolidated List (Department of Foreign Affairs and Trade (DFAT), Australia); New Zealand Russia Sanctions Register (Ministry of Foreign Affairs and Trade (MFAT), New Zealand); Japan Ministry of Finance Asset Freeze List (Ministry of Finance, Japan); French National Register of Asset Freezes (Direction générale du Trésor, France); US Consolidated Screening List (Commerce and State lists) (International Trade Administration, US Department of Commerce). There is no separate UN list: the UK Sanctions List includes the UN designations the UK gives effect to. A list is screened only when we hold a copy of it: one that could not be loaded (for example because its download failed) has status `not_loaded` in `lists` and was not screened.\n\nNames are compared after removing case, accents, punctuation, titles and legal forms, in any word order, and each close name is checked against birth month and year (people; Companies House publishes no more), nationality or country, and registration numbers (companies). Each potential match lists the fields that agreed and disagreed, the reasons in plain English and a link to the official entry. **A name match is not a finding that anyone is sanctioned**: nothing is a close name match without date of birth or nationality / country corroboration, every match needs human review, and no name match is not a clearance. `lists` shows which list versions (and their own dates) were screened; a list that was not loaded is named in `lists_not_screened`. Also run by POST /kyb/check (the `sanctions_screening` check and the `sanctions` field). API Starter and above; web-app Pro and Team." }, "response": [] }, { "id": "a2edee07-28c2-4ee4-a761-c0afb8ef0d82", "name": "Sanctions lists and the versions screened", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sanctions/lists", "host": [ "{{baseUrl}}" ], "path": [ "sanctions", "lists" ] }, "description": "Sanctions lists and the versions screened\n\nEvery list CompanyStack screens against: the version served, the list's own date, when it last changed (loaded_at) and was last checked (checked_at; lists are checked hourly), its jurisdiction and licence, and why a list is stale or not loaded." }, "response": [] } ] }, { "name": "Automated analyst view", "description": "A review of one UK company, with a finance, credit, acquisition or compliance focus, generated automatically by a language model from CompanyStack's data only, citing every figure. Generated automatically by a language model from our data. No person reviews it. It can be wrong and is not advice.", "item": [ { "id": "52c71608-ab64-4c13-ab05-0b5454eb2c4d", "name": "Get the Automated analyst view of a company", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/analyst/:number", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "analyst", ":number" ], "variable": [ { "key": "number", "value": "00445790", "description": "" } ] }, "description": "Get the Automated analyst view of a company\n\nA language model reviews the company, with the chosen focus (finance, credit, acquisition or compliance), from CompanyStack's own data only: the profile, parsed accounts, Health Score, officers, PSCs, charges, filings, Gazette notices and sanctions screening. Every figure in the answer cites a fact (returned in `facts`); answers quoting figures that are not in our data are repaired or rejected before they are returned. Leave out `question` for the standard review for that focus. The same question on the same data is served from a cache and does not use your allowance again. API Starter includes 100 answers a month, Business 400, Enterprise 2,000; each call also counts as one request. Generated automatically by a language model from our data. No person reviews it. It can be wrong and is not advice. Not a credit rating and not a credit limit.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "7520dedf-08b9-4a9b-a041-5e511e3d8e24", "name": "Automated analyst view focuses and your allowance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/intelligence/analyst/usage", "host": [ "{{baseUrl}}" ], "path": [ "intelligence", "analyst", "usage" ] }, "description": "Automated analyst view focuses and your allowance\n\nThe four focuses with their suggested questions, how many answers your plan has left, and the fixed notice." }, "response": [] } ] }, { "name": "Samples", "description": "Real, unedited sample output (public)", "item": [ { "id": "a0b38c7e-790e-4e20-ab89-f60c0c813620", "name": "Sample gallery manifest", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/samples/index.json", "host": [ "{{baseUrl}}" ], "path": [ "samples", "index.json" ] }, "description": "Sample gallery manifest\n\nReal, unedited output for a set of UK companies, generated by the same code that serves the API: which companies, when the samples were generated, the date of the underlying data, and the files for each. No key needed.", "auth": { "type": "noauth" } }, "response": [] }, { "id": "7c7d708b-203e-4a41-a016-d5d1ec0f3480", "name": "One sample file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/samples/:slot/:file", "host": [ "{{baseUrl}}" ], "path": [ "samples", ":slot", ":file" ], "variable": [ { "key": "slot", "value": "sme-1", "description": "" }, { "key": "file", "value": "health.json", "description": "" } ] }, "description": "One sample file\n\nA JSON sample ({ sample, response }: the request metadata and the exact response) or a sample PDF. File names are listed in the manifest. No key needed.", "auth": { "type": "noauth" } }, "response": [] } ] } ] }