Lists

KYB-check a list

Queues 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.

post/lists/{id}/kyb

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/lists/{id}/kyb
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idinteger required

Request body

company_numbersstring[]

Omit for every company on the list

Response

Queued

Changes

No recorded changes to this operation across all 1 revision of this API.