Overview

This section documents every Companies V2 endpoint, with request parameters, response schemas, and live examples. New to the API? Start with the Getting Started guide. For what’s changed recently, see the Changelog.

​

Base URL

​

Authentication

Every request requires your API key, sent in the Authorization header. See Getting Started for how to obtain and send your key.

​

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.

​

Finding your way around

• Getting Started and the other guides — task-based walkthroughs for search, profiles, documents, and orders.
• API Reference (this section) — every endpoint, listed below.
• Changelog — version history for the V2 contract.