API Reference KYC Central v#0.9.0

Copy Markdown View Source

Modules

Official Elixir client for the KYC Central API — UK company KYC and AML risk assessment.

LLM-written analyst commentary over an assessment.

The result of running a rule set against one company.

Charity Commission for England and Wales lookups.

Companies House company, officer, PSC, charge and filing data.

Ask questions about the product in natural language.

The single error type returned by every function in this library.

Financial Conduct Authority register lookups.

Global LEI Foundation lookups — legal entity identifiers and parent chains.

HMRC VAT registration lookups.

Insolvency Service Individual Insolvency Register screening.

Poll background jobs started by the API.

FATF high-risk and increased-monitoring jurisdiction reference data.

The risk assessment endpoint — the reason this API exists.

Adverse media search. Requires an active Professional subscription.

Offshore and shell-company jurisdiction reference data.

Screen against the ICIJ Offshore Leaks database.

A single risk signal raised against a company.

The per-rule breakdown of an assessment, including rules that passed.

Discover the rule sets available to your key.

Discover individual rules and the company fields they can test.

Screen names against OFAC, the UN Security Council, the UK Sanctions List and the EU Financial Sanctions Files.

HTTP plumbing: URL building, retries, decoding and error mapping.