company-v2

About testing

Information about the Kyckr V2 test environment

The Kyckr Test API provides JSON responses for all calls, enabling easy building, testing, and verification of projects without incurring costs. The same functions available in production are also available in the test environment.

The new test environment only covers V2 of our REST API.

Important differences between test and production environments

  • The main function of our test environment is to allow developers to test the end-to-end process from searching a company to then ordering profiles and filings.
  • The performance in Test is not indicative of the performance in Production.
  • Name search will retrieve all available companies in the test environment for the selected country, regardless of the search term.

Lite and Enhanced Profiles

The following jurisdictions have example Lite and Enhanced profiles available in the test environment:

  • United Kingdom (GB)
  • Ireland (IE)
  • Netherlands (NL)
  • Italy (IT)
  • Australia (AU)
  • Luxembourg (LU)
  • Singapore (SG)
  • France (FR)
  • Germany (DE)
  • Belgium (BE)
  • Estonia (EE)
  • Spain (ES)
  • United States - New York (US-NY)
  • United States - Florida (US-FL)
  • Denmark (DK)
  • United Arab Emirates (AE)
  • India (IN)
  • China (CN)
  • New Zealand (NZ)
  • Austria (AT)

The following jurisdictions have Lite Profile only:

  • Switzerland (CH)
  • Canada - (CA-ALL)
  • Canada - Quebec - (CA-QC)
  • Canada - Ontario - (CA-ON)

Registry documents

A list of available filings for any company in the sandbox can be retrieved using the /companies/{kyckrId}/documents endpoint.

The PDF returned will be a blank PDF.

Integrators are able to test the end to end function of ordering and retrieving filings.

In the test environment, the orders retrieved from the /orders endpoint will always return the same list, and searching for a specific order ID is not possible.

Video tutorial - V2 test environment walkthrough