KYB

Retrieve a stored KYB check

Returns the result exactly as it was returned at the time of the check. Its PDF certificate is GET /kyb/checks/{id}.pdf, made and registered afresh on each download: fair use allows 300 an hour and 2,000 a day for each account, then 429 fair_use_limit with Retry-After (a refused or not-found download is not counted).

get/kyb/checks/{id}

Request

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

Path parameters

idstring required

Response

Stored result

check_idstring required
company_numberstring required
company_namestring nullable
referencestring nullable
outcome'pass' | 'refer' | 'fail' | 'unable_to_check' required

unable_to_check: nothing failed, but a check that matters could not run: the officers could not be read from Companies House and no copy is held (reason code OFFICERS_UNAVAILABLE), so no director was checked, or a register the check needs, such as the disqualified directors register, is not complete or current. Never a pass: run the check again later.

summarystring
reason_codesstring[] required
warningsstring[]
data_as_ofstring nullable
checked_atstring date-time required
disclaimerstring

What the check covered, naming only the sanctions lists it actually screened

noticestring

Who the data is prepared for and that CompanyStack accepts no responsibility to anyone else who relies on it (Terms 15B). Keep it with the data if you show it to others (Terms 17.5).

Changes

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