company-v1

About testing

Information about the Kyckr 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.

Important differences between the 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.
  • It is important to note that some registries don't keep their test environments up to date with production. If the company does not appear in search or if data is not accurate, this does not reflect what is seen in the live environment.
  • The test environment should not be used to confirm whether Kyckr's API connection to certain registries works. Documentation on the data available in each jurisdiction is provided during integration with Kyckr. Only a limited number of companies are available in the test environment - which is a key difference when compared to use of the production API.
  • The performance in our test environment is not indicative of the performance in production.

Ordering documents in test

  • The UK is the only jurisdiction in the test environment where all documents returned in the filing search can be ordered and retrieved.
  • Outside of the UK, a list of available filings can still be retrieved. However, these orders will not be completed.

Stub responses

For some jurisdictions, Kyckr provides stub responses in testing. For Lite and Enhanced Profiles, the same test data company will be returned. The Search API will return a unique company id.

Jurisdictions with stub responses include

Jurisdiction ISO Code
France FR
Germany DE
Italy IT
Japan JP
Canada CA
Hong Kong HK

Countries that are unavailable in test

Lite API

Country ISO Code
Gibraltar GI
Italy IT
Lithuania LT
Malta MT
New Zealand NZ
Spain ES

Core API

Country ISO Code
Italy IT
Lithuania LT
Malta MT
Spain ES