Sandbox
What it is
The Know Your Customer Limited sandbox is a free, full-fidelity replica of the production KYB API, at https://api.knowyourcustomer.dev. It is not a stub or a mock. The live-registry behaviour is simulated against over 980 sample companies and individuals, with their real ownership trees and registry documents, so you exercise the same company search, entity data, UBO resolution, and document flows you will see in production. It runs the same contract, returns the same response shapes, and moves cases through the same status progression as production. What you build against the sandbox runs in production by changing the base URL and credentials.
The sandbox is free to use, with no live registry charges. It is provided "as is" with no SLA.
What's loaded
The sandbox is pre-loaded with realistic data so you can build against real structures:
- Over 980 sample companies and individuals, with genuine ownership structures including multi-level beneficial ownership.
- Synthetic individuals for identity and document flows.
- Realistic per-jurisdiction latency, so your polling logic is tested against the timings you will see in production.
Three good starter companies
| Company | Jurisdiction | Identifier | Why try it |
|---|---|---|---|
| CROPWELL BISHOP CREAMERY LIMITED | GB | reg 00364890 | Multi-level UBO: a corporate parent above individual owners. |
| SC ENGINEERING PRIVATE LIMITED | SG | UEN 200815219G | A Singapore registry case. |
| Ubizense Limited | HK | BR 69293323 | A Hong Kong registry case. |
Search for any of these, create a case, poll to ready, and read the structure. See the Quickstart.
For the complete, searchable list of everything you can create in the sandbox, including the synthetic scenario companies and individuals and the full catalogue of registry companies, see the Test cases page.
How it mirrors production
The sandbox is designed so your integration needs no changes to go live:
- Same contract: identical endpoints, request bodies, and parameters.
- Same shapes: identical response objects (
caseCommonId,controllingEntitiesAndIndividuals, the recursive org-chart, the document upload response, and so on). - Same statuses: cases build asynchronously and move through the same status set, with realistic latency, so you exercise real polling.
Where it differs
- No real registry calls: the company data is from pre-loaded public records, not fetched live, so there are no registry charges.
- No real AML hits: screening runs against the case but does not surface real sanctions, PEP, or adverse-media matches on real people.
- Synthetic identity data: individuals and their documents are synthetic. Identity prevalidation is exercised (for example, a forged or unrecognised ID returns
IdentityDocumentNotRecognized), but no real person is verified. - Reports are for evaluation only: sandbox reports demonstrate the format and content but are not for production compliance use.
- No SLA: the sandbox is provided "as is".
Limits and fair use
The sandbox is rate-limited and subject to fair use, so build clients that cache the bearer token, poll with backoff rather than tight loops, and retry transient errors with backoff. A 429 means you are being rate-limited: back off and retry. Do not load-test the sandbox.
Reset your tenant
To start clean, delete the cases you created. Deleting cases clears your test data so you can re-run flows from scratch. Your tenant remains provisioned; only the cases are removed.
Sample onboarding app
A complete, clonable sample corporate-onboarding web app is included with your sandbox access. It runs a full KYB journey against the API, from company search through ownership and UBO resolution, document collection, and AML screening to an onboarding decision, with the raw API calls visible in a built-in developer and debug view. Use it as a reference implementation you can read, run on day one, and adapt.
View your cases in the operator console
A ready-to-use operator console is included with your sandbox access, at workspace.knowyourcustomer.dev. It is a reduced developer copy of the KYC Workspace that your internal compliance users see: a case list and tabbed case detail (company profile, screening, documents, ownership, audit trail), rendered over your sandbox tenant. Connect with your sandbox clientId and clientSecret, or save a one-click bookmark link, and browse the cases you create exactly as an internal reviewer would. It is the fastest way to see what your own users will see once cases exist.
Ready to build
Request access: submit your details and sign the Sandbox Testing Agreement. Our team reviews each request, and once it is approved we will email your sandbox credentials. Then follow the Quickstart.