Kausate Sandbox
How to use Kausate in Kausate Sandbox — what you can call, which identifiers it uses, and which documents you can order
New to the API? Start with the jurisdictions overview, which explains how ordering, identifiers and documents work everywhere.
What you can call here
What each operation does is the same everywhere and is explained on the jurisdictions overview.
| Operation | Status |
|---|---|
| Autocomplete | Live |
| Company search | Live |
| Company report Includes: Registered details, Legal representatives and Shareholders. | Live |
| Shareholder graph | Live |
| Beneficial owners | Live |
| Financials | Live |
| List documents | Live |
| Retrieve a document | Live |
| Prefill | Live |
How to search
Start with company search and jurisdictionCode: "zz". Pass the name as companyName, a registration number as companyNumber, or both to narrow the result. Here companyNumber is read as sandboxId.
Fields
To say exactly what you mean, send an advancedQuery instead. Kausate Sandbox understands these fields:
| Field | What it does |
|---|---|
name | Company name to search for. |
sandboxId | Sandbox company number (e.g. '000001') |
Examples
{ "jurisdictionCode": "zz", "advancedQuery": { "sandboxId": "000001" }}Company identifiers
Search by passing the registration number as companyNumber — it is matched against the schemes this register can search on, so you do not name the scheme yourself. Not every scheme below is searchable; the rest label the values returned in a company’s identifiers.
| Identifier | Appears as | Format |
|---|---|---|
| Kausate Sandbox Number Synthetic 6-digit sandbox company number for the Kausate Sandbox jurisdiction (zz) | zz_sandbox_number | ^\d{6}$ |
Documents you can order
| Document | Order by | Status |
|---|---|---|
| Sandbox Document Free synthetic document (list + retrieval) for the Kausate Sandbox jurisdiction (zz). Deterministic mock PDF. | register_extract | Live |
Documents with a shortcut are ordered directly by that name — for example register_extract.
Last updated on