Skip to main content
Everything on this page applies to every Kyckr V2 API. Each product is listed separately below, with its own endpoints and changelog. New to the API? Start with the Getting Started guide.

​
Base URL

Every V2 product is served from these base URLs — there is no per-product host.

​
Authentication

Every request requires your API key, sent in the Authorization header. The same key works across all V2 products; see Getting Started for how to obtain and send it.

​
Response format

Responses share a common envelope:
  • correlationId — a unique ID for the request; quote it in support enquiries.
  • timeStamp — when the response was generated.
  • details — a human-readable status message.
  • data — the response payload, which varies by endpoint.
Asynchronous operations (orders) also return an orderId you can poll for the result.

​
Orders

Products that cannot answer in real time are ordered rather than fetched. Ordering is shared infrastructure: whichever product you order, you place the order on that product’s endpoint and retrieve the result from GET /orders/{orderId}.

​
Finding your way around

  • Getting Started and the other guides — task-based walkthroughs for search, profiles, documents, and orders.
  • API Reference (this section) — each product’s endpoints and its changelog, grouped by product.