The Kyckr sandbox is a dedicated test environment that mirrors the full functionality of the production API. You can complete the entire integration journey — searching for companies, retrieving profiles, ordering filings — without incurring charges or touching live registry data.Documentation Index
Fetch the complete documentation index at: https://developer.kyckr.com/llms.txt
Use this file to discover all available pages before exploring further.
The sandbox covers the V2 REST API only. If you are working with V1, refer to the V1 documentation.
What the sandbox supports
The sandbox is designed to let you validate the complete end-to-end flow your integration will rely on in production:| Capability | Available in sandbox |
|---|---|
| Company search by name | ✓ |
| Company search by registration number | ✓ |
| Lite Profile retrieval | ✓ |
| Enhanced Profile retrieval | ✓ (select jurisdictions) |
| Filing list retrieval | ✓ |
| Filing document download | ✓ (blank PDF returned) |
Order history (/orders) | ✓ (fixed response, see note below) |
Connecting to the sandbox
The sandbox uses a separate base URL from the production environment. Use your sandbox credentials when making requests.Known differences from production
Keep the following in mind when building against the sandbox. These are intentional design choices, not bugs. Name search behaviour. When searching by company name, the sandbox returns all companies available for the selected country, regardless of the search term you provide. This is expected behaviour — do not rely on search-term filtering when writing sandbox tests. Performance Response times in the sandbox are not representative of production. Do not use sandbox performance as a benchmark for SLA planning or latency estimates. Filing documents The/companies/{kyckrId}/documents endpoint returns a valid list of available filings for any sandbox company. However, the PDF returned on download is always a blank document. This is sufficient to test the ordering and retrieval flow end-to-end.
Order history The /orders endpoint always returns the same fixed list of orders. Querying for a specific order ID is not supported in the sandbox.
Available jurisdictions
Lite Profile and Enhanced Profile
The following jurisdictions have full Lite and Enhanced Profile data available:| Country | Code |
|---|---|
| Australia | AU |
| Austria | AT |
| Belgium | BE |
| China | CN |
| Denmark | DK |
| Estonia | EE |
| France | FR |
| Germany | DE |
| India | IN |
| Ireland | IE |
| Italy | IT |
| Luxembourg | LU |
| Netherlands | NL |
| New Zealand | NZ |
| Singapore | SG |
| Spain | ES |
| United Arab Emirates | AE |
| United Kingdom | GB |
| United States — Florida | US-FL |
| United States — New York | US-NY |
Lite Profile only
The following jurisdictions return Lite Profile data only. Enhanced Profile is not available for these in the sandbox.| Country | Code |
|---|---|
| Canada (all provinces) | CA-ALL |
| Canada — Ontario | CA-ON |
| Canada — Quebec | CA-QC |
| Switzerland | CH |
Recommended test sequence
Work through the following sequence to validate your integration before moving to production.Search for a company
Use
/companies/search with a supported jurisdiction code. Confirm that results are returned and that the response structure matches your expected schema.Retrieve a Lite Profile
Use the
kyckrId from your search result to call /companies/{kyckrId}/lite. Verify the fields your integration depends on are present and correctly typed.Retrieve an Enhanced Profile
Call
/companies/{kyckrId}/enhanced for a jurisdiction that supports it (see table above). Check that the representatives and shareholders arrays are populated as expected.List available filings
Call
/companies/{kyckrId}/documents to retrieve the filing list. Confirm the response structure and that document metadata is present.Download a filing
Order and download a filing document. Verify your pipeline handles the PDF response correctly. The file returned will be blank — this is expected.