KYB / AML summary
kyb_checkRead-onlyIdempotent
One-call Know-Your-Business summary for one company: registry status, insolvency, liquidation, sanctions screening, debarment, tax/social/health debts, VAT reliability and the overall risk verdict. Use before onboarding a customer or supplier. A null field means WITHHELD or NOT MEASURED — it does NOT mean clean; say so when you report it.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ico | Yes | National registry identifier (SK/CZ IČO, AT Firmenbuch number, PL KRS/REGON, FR SIREN, …). Leading zeros are normalised server-side. | |
| country | No | ISO 3166-1 alpha-2 country of the register (e.g. SK, CZ, AT, PL). Strongly recommended: registry numbers are NOT unique across countries (an SK and a CZ company can share the same 8-digit IČO), and without it the server picks one by tie-break. | |
| purpose | No | Legal purpose for natural-person (FO) data, attested by the account holder. Only needed when the API key has full FO access; must be one of the purposes licensed on the key. Never guess it — ask the user if it is not known. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Consolidated KYB/AML signals and the register the answer refers to. | |
| meta | No | Request metadata: request_id (quote it in support requests), duration_ms, cached. |