> ## 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.

# Test the API

> Use the Kyckr sandbox environment to build and verify your integration before going live — at no cost.

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.

<Info>
  The sandbox is shared between V1 and V2. The same sandbox environment covers both APIs.
</Info>

***

## 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                         | ✓ (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.

```bash theme={null}
# Base URL — sandbox
https://rest.kyckr.com/test
```

All endpoints, request formats, and response schemas are identical to production. No changes to your request structure are needed when switching environments.

***

## 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 filing search 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 order status endpoint always returns the same fixed list of orders. Querying for a specific order reference may not reflect the exact order placed 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.

<Steps>
  <Step title="Search for a company">
    Use the company search endpoint with a supported jurisdiction code. Confirm that results are returned and that the response structure matches your expected schema.
  </Step>

  <Step title="Retrieve a Lite Profile">
    Use the `codeField` from your search result to call the Lite Profile endpoint. Verify the fields your integration depends on are present and correctly typed.
  </Step>

  <Step title="Retrieve an Enhanced Profile">
    Call the Enhanced Profile endpoint for a jurisdiction that supports it (see table above). Check that the `directorsField` and `shareHoldersField` arrays are populated as expected.
  </Step>

  <Step title="List available filings">
    Call the filing search endpoint to retrieve the document catalogue. Confirm the response structure and that document metadata — including `idField`, `productTitleField`, and `tierValueField` — is present.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Review order history">
    Call the order status endpoint to confirm your order history logic handles the fixed sandbox response without errors.
  </Step>
</Steps>

***

## Moving to production

Once you have validated your integration in the sandbox, switch to your production credentials and update the base URL. No other changes to your request structure are required.

If you do not yet have production credentials, [request access via the Kyckr demo page](https://www.kyckr.com/book-a-demo).