[ { "v": 1, "name": "CompanyStack API", "folders": [ { "v": 1, "name": "Auth", "folders": [], "requests": [ { "v": "1", "name": "Register a new account", "method": "POST", "endpoint": "<>/auth/register", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "none", "authActive": true }, "body": { "contentType": "application/json", "body": "{}" } }, { "v": "1", "name": "Login to view API keys", "method": "POST", "endpoint": "<>/auth/login", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "none", "authActive": true }, "body": { "contentType": "application/json", "body": "{}" } }, { "v": "1", "name": "List your API keys", "method": "GET", "endpoint": "<>/auth/keys", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Create an API key", "method": "POST", "endpoint": "<>/auth/keys", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{}" } }, { "v": "1", "name": "Regenerate an API key", "method": "POST", "endpoint": "<>/auth/keys/1/regenerate", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Revoke an API key", "method": "DELETE", "endpoint": "<>/auth/keys/1", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Usage against your plan limits", "method": "GET", "endpoint": "<>/auth/usage", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Companies", "folders": [], "requests": [ { "v": "1", "name": "Get company by number", "method": "GET", "endpoint": "<>/company/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Search companies", "method": "GET", "endpoint": "<>/company/search", "params": [ { "key": "q", "value": "tesco", "active": true }, { "key": "status", "value": "", "active": false }, { "key": "sic", "value": "62020", "active": false }, { "key": "postcode", "value": "EC2", "active": false }, { "key": "town", "value": "LEEDS", "active": false }, { "key": "limit", "value": "20", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Autocomplete company names", "method": "GET", "endpoint": "<>/company/autocomplete", "params": [ { "key": "q", "value": "", "active": true }, { "key": "limit", "value": "10", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Bulk lookup (up to 100)", "method": "POST", "endpoint": "<>/company/bulk", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{}" } }, { "v": "1", "name": "Companies by SIC code", "method": "GET", "endpoint": "<>/company/sic/62020", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Companies by postcode", "method": "GET", "endpoint": "<>/company/postcode/EC2", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Intelligence", "folders": [], "requests": [ { "v": "1", "name": "Company health score", "method": "GET", "endpoint": "<>/intelligence/health/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Director network analysis", "method": "GET", "endpoint": "<>/intelligence/directors/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Corporate group structure", "method": "GET", "endpoint": "<>/intelligence/group/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Sector benchmark", "method": "GET", "endpoint": "<>/intelligence/benchmark/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Company timeline", "method": "GET", "endpoint": "<>/intelligence/timeline/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Financial indicators", "method": "GET", "endpoint": "<>/intelligence/financials/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Filed accounts, year by year", "method": "GET", "endpoint": "<>/accounts/00445790", "params": [ { "key": "basis", "value": "presented", "active": false }, { "key": "limit", "value": "20", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Screen companies by their filed figures, place, age and filings", "method": "GET", "endpoint": "<>/accounts/search/filter", "params": [ { "key": "min_turnover", "value": "1000000", "active": true }, { "key": "max_turnover", "value": "", "active": false }, { "key": "min_assets", "value": "", "active": false }, { "key": "max_assets", "value": "", "active": false }, { "key": "min_net_assets", "value": "", "active": false }, { "key": "max_net_assets", "value": "", "active": false }, { "key": "min_profit", "value": "", "active": false }, { "key": "max_profit", "value": "", "active": false }, { "key": "min_employees", "value": "", "active": false }, { "key": "max_employees", "value": "", "active": false }, { "key": "min_cash", "value": "", "active": false }, { "key": "max_cash", "value": "", "active": false }, { "key": "min_liabilities", "value": "", "active": false }, { "key": "max_liabilities", "value": "", "active": false }, { "key": "min_turnover_growth", "value": "", "active": false }, { "key": "max_turnover_growth", "value": "", "active": false }, { "key": "min_employee_growth", "value": "", "active": false }, { "key": "max_employee_growth", "value": "", "active": false }, { "key": "sic_code", "value": "62", "active": false }, { "key": "status", "value": "", "active": false }, { "key": "accounts_type", "value": "", "active": false }, { "key": "region", "value": "", "active": false }, { "key": "town", "value": "LEEDS", "active": false }, { "key": "county", "value": "", "active": false }, { "key": "local_authority", "value": "E08000035", "active": false }, { "key": "constituency", "value": "", "active": false }, { "key": "ward", "value": "", "active": false }, { "key": "msoa", "value": "", "active": false }, { "key": "rural_urban", "value": "", "active": false }, { "key": "imd_decile_min", "value": "", "active": false }, { "key": "imd_decile_max", "value": "", "active": false }, { "key": "incorporated_from", "value": "", "active": false }, { "key": "incorporated_to", "value": "", "active": false }, { "key": "accounts_overdue", "value": "", "active": false }, { "key": "accounts_overdue_days", "value": "", "active": false }, { "key": "confirmation_overdue", "value": "", "active": false }, { "key": "confirmation_overdue_days", "value": "", "active": false }, { "key": "gazette", "value": "", "active": false }, { "key": "gazette_days", "value": "", "active": false }, { "key": "insolvent", "value": "", "active": false }, { "key": "net_assets_falling", "value": "", "active": false }, { "key": "has_charges", "value": "", "active": false }, { "key": "exclude_holding", "value": "", "active": false }, { "key": "include_implausible", "value": "", "active": false }, { "key": "include_mass_registration", "value": "", "active": false }, { "key": "basis", "value": "", "active": false }, { "key": "sort", "value": "", "active": false }, { "key": "order", "value": "", "active": false }, { "key": "limit", "value": "50", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "PSC", "folders": [], "requests": [ { "v": "1", "name": "Persons of significant control", "method": "GET", "endpoint": "<>/psc/company/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Search PSC records", "method": "GET", "endpoint": "<>/psc/search", "params": [ { "key": "name", "value": "Smith", "active": true }, { "key": "limit", "value": "20", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Companies a person has significant control of", "method": "GET", "endpoint": "<>/psc/network/Smith", "params": [ { "key": "born", "value": "", "active": false }, { "key": "limit", "value": "50", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Analytics", "folders": [], "requests": [ { "v": "1", "name": "Market overview statistics", "method": "GET", "endpoint": "<>/analytics/overview", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Search SIC codes by description", "method": "GET", "endpoint": "<>/analytics/sic-search", "params": [ { "key": "q", "value": "", "active": true } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Get all SIC codes with company counts", "method": "GET", "endpoint": "<>/analytics/sic-codes", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Industry analytics", "method": "GET", "endpoint": "<>/analytics/sic/62020", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Area analytics", "method": "GET", "endpoint": "<>/analytics/postcode/EC2", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Enterprise", "folders": [], "requests": [ { "v": "1", "name": "Due diligence report", "method": "GET", "endpoint": "<>/enterprise/due-diligence/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Find competitors", "method": "GET", "endpoint": "<>/enterprise/competitors/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Live", "folders": [], "requests": [ { "v": "1", "name": "Real-time company profile", "method": "GET", "endpoint": "<>/live/profile/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Company officers (directors & secretaries)", "method": "GET", "endpoint": "<>/live/officers/00445790", "params": [ { "key": "limit", "value": "100", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Persons with significant control (live)", "method": "GET", "endpoint": "<>/live/psc/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Mortgages & charges", "method": "GET", "endpoint": "<>/live/charges/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Filing history", "method": "GET", "endpoint": "<>/live/filings/00445790", "params": [ { "key": "category", "value": "", "active": false }, { "key": "limit", "value": "25", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Insolvency history", "method": "GET", "endpoint": "<>/live/insolvency/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Full real-time company report", "method": "GET", "endpoint": "<>/live/complete/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Circuit breaker health status", "method": "GET", "endpoint": "<>/live/status", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Watchlist", "folders": [], "requests": [ { "v": "1", "name": "List watched companies", "method": "GET", "endpoint": "<>/watchlist", "params": [ { "key": "limit", "value": "50", "active": false }, { "key": "offset", "value": "0", "active": false }, { "key": "scope", "value": "default", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Add company to watchlist", "method": "POST", "endpoint": "<>/watchlist", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{}" } }, { "v": "1", "name": "Remove from watchlist", "method": "DELETE", "endpoint": "<>/watchlist/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Get alerts for watched companies", "method": "GET", "endpoint": "<>/watchlist/alerts", "params": [ { "key": "alert_type", "value": "", "active": false }, { "key": "company_number", "value": "00445790", "active": false }, { "key": "since", "value": "", "active": false }, { "key": "until", "value": "", "active": false }, { "key": "limit", "value": "50", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Mark alert as read", "method": "POST", "endpoint": "<>/watchlist/alerts/1/read", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Alert summary counts", "method": "GET", "endpoint": "<>/watchlist/alerts/summary", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Webhook signing secret", "method": "GET", "endpoint": "<>/watchlist/webhook-secret", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Rotate the webhook signing secret", "method": "POST", "endpoint": "<>/watchlist/webhook-secret/rotate", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Send a signed test webhook", "method": "POST", "endpoint": "<>/watchlist/webhooks/test", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"url\": \"https://example.com/hooks/companystack\"\n}" } }, { "v": "1", "name": "Webhook delivery log", "method": "GET", "endpoint": "<>/watchlist/webhooks/deliveries", "params": [ { "key": "status", "value": "", "active": false }, { "key": "limit", "value": "50", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Officers", "folders": [], "requests": [ { "v": "1", "name": "Get company officers (cached)", "method": "GET", "endpoint": "<>/officers/company/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Search officers by name", "method": "GET", "endpoint": "<>/officers/search", "params": [ { "key": "name", "value": "Smith", "active": true }, { "key": "limit", "value": "20", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "All appointments for a person", "method": "GET", "endpoint": "<>/officers/person/SMITH%2C%20John/appointments", "params": [ { "key": "limit", "value": "50", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Director history: one officer's appointments across companies", "method": "GET", "endpoint": "<>/officers//appointments", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Director history summary: counts only", "method": "GET", "endpoint": "<>/officers//appointments/summary", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Filings", "folders": [], "requests": [ { "v": "1", "name": "Get filing history (cached)", "method": "GET", "endpoint": "<>/filings/company/00445790", "params": [ { "key": "category", "value": "", "active": false }, { "key": "limit", "value": "25", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Latest filing for a company", "method": "GET", "endpoint": "<>/filings/company/00445790/latest", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Recent filings across all companies", "method": "GET", "endpoint": "<>/filings/recent", "params": [ { "key": "limit", "value": "20", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Postcodes", "folders": [], "requests": [ { "v": "1", "name": "Postcode lookup with location and the companies registered there", "method": "GET", "endpoint": "<>/postcodes/lookup/EC2R%208AH", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Companies at the postcodes nearest a point", "method": "GET", "endpoint": "<>/postcodes/nearby", "params": [ { "key": "lat", "value": "51.5074", "active": true }, { "key": "lng", "value": "-0.1278", "active": true }, { "key": "radius", "value": "1", "active": false }, { "key": "limit", "value": "20", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Area summary by postcode prefix", "method": "GET", "endpoint": "<>/postcodes/area/EC2", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Search", "folders": [], "requests": [ { "v": "1", "name": "Search industries by keyword", "method": "GET", "endpoint": "<>/search/industry", "params": [ { "key": "q", "value": "software", "active": true }, { "key": "limit", "value": "20", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Companies in an industry", "method": "GET", "endpoint": "<>/search/industry/62020/companies", "params": [ { "key": "postcode", "value": "EC2R 8AH", "active": false }, { "key": "status", "value": "", "active": false }, { "key": "limit", "value": "20", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "KYB", "folders": [], "requests": [ { "v": "1", "name": "Verify a company (KYB) in one call", "method": "POST", "endpoint": "<>/kyb/check", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\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}" } }, { "v": "1", "name": "List your stored KYB checks", "method": "GET", "endpoint": "<>/kyb/checks", "params": [ { "key": "company_number", "value": "00445790", "active": false }, { "key": "outcome", "value": "", "active": false }, { "key": "limit", "value": "50", "active": false }, { "key": "cursor", "value": "", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Retrieve a stored KYB check", "method": "GET", "endpoint": "<>/kyb/checks/kyb_3f9a1c0d5e7b2a4c6d8e0f12", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Change Feed", "folders": [], "requests": [ { "v": "1", "name": "Register changes since a cursor", "method": "GET", "endpoint": "<>/changes", "params": [ { "key": "cursor", "value": "", "active": false }, { "key": "since", "value": "2026-09-01T00:00:00Z", "active": true }, { "key": "types", "value": "added,dissolved", "active": false }, { "key": "companies", "value": "", "active": false }, { "key": "watchlist", "value": "", "active": false }, { "key": "sic", "value": "62,6311", "active": false }, { "key": "postcode", "value": "EC2,M1", "active": false }, { "key": "limit", "value": "100", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Cursor at the head of the feed", "method": "GET", "endpoint": "<>/changes/cursor", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Compliance", "folders": [], "requests": [ { "v": "1", "name": "Director & PSC identity verification status (ECCTA)", "method": "GET", "endpoint": "<>/compliance/identity/12345678", "params": [ { "key": "refresh", "value": "", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Filing and identity verification deadlines for a portfolio", "method": "GET", "endpoint": "<>/compliance/deadlines", "params": [ { "key": "companies", "value": "", "active": false }, { "key": "types", "value": "accounts,confirmation_statement,identity_verification", "active": true }, { "key": "within_days", "value": "90", "active": false }, { "key": "include_overdue_days", "value": "365", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "List calendar feeds", "method": "GET", "endpoint": "<>/compliance/calendar-feeds", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Create an iCal feed of your watchlist deadlines", "method": "POST", "endpoint": "<>/compliance/calendar-feeds", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"name\": \"Client filing deadlines\"\n}" } }, { "v": "1", "name": "Revoke a calendar feed", "method": "DELETE", "endpoint": "<>/compliance/calendar-feeds/1", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "iCal feed (secret URL)", "method": "GET", "endpoint": "<>/calendar/cal_your_feed_token.ics", "params": [], "headers": [ { "key": "Accept", "value": "*/*", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "none", "authActive": true }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Financials", "folders": [], "requests": [ { "v": "1", "name": "Financial history and trends", "method": "GET", "endpoint": "<>/financials/12345678/history", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Peer comparison within the SIC code", "method": "GET", "endpoint": "<>/financials/12345678/peers", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Prospects", "folders": [], "requests": [ { "v": "1", "name": "Find companies by sector, place, age and size — or lookalikes", "method": "GET", "endpoint": "<>/prospects", "params": [ { "key": "sic", "value": "62,6311", "active": true }, { "key": "postcode", "value": "LS,M1", "active": false }, { "key": "town", "value": "LEEDS", "active": false }, { "key": "status", "value": "Active", "active": false }, { "key": "category", "value": "Private Limited Company", "active": false }, { "key": "accounts_category", "value": "MICRO ENTITY,SMALL", "active": false }, { "key": "incorporated_from", "value": "", "active": false }, { "key": "incorporated_to", "value": "", "active": false }, { "key": "min_age_years", "value": "", "active": false }, { "key": "max_age_years", "value": "", "active": false }, { "key": "min_turnover", "value": "", "active": false }, { "key": "max_turnover", "value": "", "active": false }, { "key": "min_employees", "value": "", "active": false }, { "key": "max_employees", "value": "", "active": false }, { "key": "min_net_assets", "value": "", "active": false }, { "key": "max_net_assets", "value": "", "active": false }, { "key": "has_charges", "value": "", "active": false }, { "key": "exclude_overdue", "value": "", "active": false }, { "key": "like", "value": "", "active": false }, { "key": "sort", "value": "newest", "active": false }, { "key": "limit", "value": "25", "active": false }, { "key": "cursor", "value": "", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Lists", "folders": [], "requests": [ { "v": "1", "name": "Your lists", "method": "GET", "endpoint": "<>/lists", "params": [ { "key": "include_archived", "value": "false", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Create a list", "method": "POST", "endpoint": "<>/lists", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"name\": \"My suppliers\",\n \"purpose\": \"suppliers\"\n}" } }, { "v": "1", "name": "List allowances and usage", "method": "GET", "endpoint": "<>/lists/usage", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Get or create \"My watchlist\"", "method": "POST", "endpoint": "<>/lists/default", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Which of your lists hold a company", "method": "GET", "endpoint": "<>/lists/membership/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "One list", "method": "GET", "endpoint": "<>/lists/42", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Delete a list", "method": "DELETE", "endpoint": "<>/lists/42", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Update a list", "method": "PATCH", "endpoint": "<>/lists/42", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"name\": \"Key suppliers\",\n \"alert_email\": true,\n \"archived\": false\n}" } }, { "v": "1", "name": "Companies on a list", "method": "GET", "endpoint": "<>/lists/42/items", "params": [ { "key": "q", "value": "", "active": false }, { "key": "status", "value": "", "active": false }, { "key": "grade", "value": "", "active": false }, { "key": "tag", "value": "", "active": false }, { "key": "overdue", "value": "", "active": false }, { "key": "signals", "value": "", "active": false }, { "key": "signal", "value": "", "active": false }, { "key": "sort", "value": "added", "active": false }, { "key": "order", "value": "", "active": false }, { "key": "limit", "value": "100", "active": false }, { "key": "offset", "value": "0", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Add companies", "method": "POST", "endpoint": "<>/lists/42/items", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\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}" } }, { "v": "1", "name": "Remove a company from a list", "method": "DELETE", "endpoint": "<>/lists/42/items/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Edit a company on a list", "method": "PATCH", "endpoint": "<>/lists/42/items/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"note\": \"Chased for accounts 1 Oct\",\n \"tags\": [\n \"VIP\",\n \"Payroll\"\n ],\n \"custom_ref\": \"CL-0042\",\n \"notify_email\": true\n}" } }, { "v": "1", "name": "Remove several companies", "method": "POST", "endpoint": "<>/lists/42/items/remove", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"company_numbers\": [\n \"08804411\",\n \"SC586124\"\n ]\n}" } }, { "v": "1", "name": "Match pasted text or a CSV before adding", "method": "POST", "endpoint": "<>/lists/42/import/preview", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"source\": \"csv\",\n \"text\": \"Client code,Company name,Company number\\nCL-0042,Example Trading Ltd,8804411\\nCL-0043,Acme Widgets Limited,\\n\"\n}" } }, { "v": "1", "name": "Webhook signing secret for a list", "method": "GET", "endpoint": "<>/lists/42/webhook-secret", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "List summary", "method": "GET", "endpoint": "<>/lists/42/summary", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "\"What changed\" on a list", "method": "GET", "endpoint": "<>/lists/42/alerts", "params": [ { "key": "limit", "value": "50", "active": false }, { "key": "before", "value": "", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Mark a list's alerts read", "method": "POST", "endpoint": "<>/lists/42/alerts/read", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Filing deadlines for a list", "method": "GET", "endpoint": "<>/lists/42/deadlines", "params": [ { "key": "within_days", "value": "180", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "iCal feed of a list's deadlines", "method": "POST", "endpoint": "<>/lists/42/calendar-feed", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Calendar feeds for a list", "method": "GET", "endpoint": "<>/lists/42/calendar-feeds", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Remove a calendar feed", "method": "DELETE", "endpoint": "<>/lists/42/calendar-feeds/1", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Export a list as CSV", "method": "GET", "endpoint": "<>/lists/42/export.csv", "params": [ { "key": "companies", "value": "", "active": false } ], "headers": [ { "key": "Accept", "value": "*/*", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "KYB-check a list", "method": "POST", "endpoint": "<>/lists/42/kyb", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"company_numbers\": [\n \"08804411\"\n ]\n}" } }, { "v": "1", "name": "Refresh health grades", "method": "POST", "endpoint": "<>/lists/42/health", "params": [ { "key": "refresh", "value": "", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Recent queued actions on a list", "method": "GET", "endpoint": "<>/lists/42/jobs", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Progress and results of a queued action", "method": "GET", "endpoint": "<>/lists/42/jobs/1", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "PDF company reports for a list, zipped", "method": "POST", "endpoint": "<>/lists/42/reports.zip", "params": [], "headers": [ { "key": "Accept", "value": "*/*", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"company_numbers\": [\n \"08804411\",\n \"SC586124\"\n ]\n}" } }, { "v": "1", "name": "Portfolio summary PDF for a list", "method": "POST", "endpoint": "<>/lists/42/portfolio-summary.pdf", "params": [], "headers": [ { "key": "Accept", "value": "*/*", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Find companies similar to a list", "method": "GET", "endpoint": "<>/lists/42/similar", "params": [ { "key": "limit", "value": "25", "active": false } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Signals", "folders": [], "requests": [ { "v": "1", "name": "Signals for one company", "method": "GET", "endpoint": "<>/signals/12345678", "params": [ { "key": "codes", "value": "REGISTRATION_CLUSTER,LICENCE_TO_TRADE", "active": true } ], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Signals for many companies", "method": "POST", "endpoint": "<>/signals/batch", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{\n \"company_numbers\": [\n \"12345678\",\n \"00445790\",\n \"SC586124\"\n ]\n}" } }, { "v": "1", "name": "Your Signals plan and lookups used", "method": "GET", "endpoint": "<>/signals/usage", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "What each signal checks", "method": "GET", "endpoint": "<>/signals/definitions", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "What each signal checks", "method": "GET", "endpoint": "<>/public/signals/definitions", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "none", "authActive": true }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Anonymised registration clusters", "method": "GET", "endpoint": "<>/public/signals/examples", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "none", "authActive": true }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Sanctions", "folders": [], "requests": [ { "v": "1", "name": "Screen a company against sanctions lists", "method": "GET", "endpoint": "<>/sanctions/company/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "Sanctions lists and the versions screened", "method": "GET", "endpoint": "<>/sanctions/lists", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Automated analyst view", "folders": [], "requests": [ { "v": "1", "name": "Get the Automated analyst view of a company", "method": "POST", "endpoint": "<>/intelligence/analyst/00445790", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": "application/json", "body": "{}" } }, { "v": "1", "name": "Automated analyst view focuses and your allowance", "method": "GET", "endpoint": "<>/intelligence/analyst/usage", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "api-key", "authActive": true, "key": "X-Api-Key", "value": "<>", "addTo": "Headers" }, "body": { "contentType": null, "body": null } } ] }, { "v": 1, "name": "Samples", "folders": [], "requests": [ { "v": "1", "name": "Sample gallery manifest", "method": "GET", "endpoint": "<>/samples/index.json", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "none", "authActive": true }, "body": { "contentType": null, "body": null } }, { "v": "1", "name": "One sample file", "method": "GET", "endpoint": "<>/samples/sme-1/health.json", "params": [], "headers": [ { "key": "Accept", "value": "application/json", "active": true } ], "preRequestScript": "", "testScript": "", "auth": { "authType": "none", "authActive": true }, "body": { "contentType": null, "body": null } } ] } ], "requests": [] } ]