API versioning
Pin the Kausate API version and plan upgrades across requests, responses and webhooks.
Pin a version
Send Kausate-Version with a published API version date in YYYY-MM-DD format
on every API request. The date selects the endpoint, request and response
contract within /v2. Use the version selector in the
API Reference to see the contract for that date.
curl "https://api.kausate.com/v2/platform/jurisdictions" \
-H "X-API-Key: ${API_KEY}" \
-H "Kausate-Version: 2026-08-01"An explicit header takes precedence over Default API Version in your organization settings. With neither an explicit header nor an organization default, Kausate uses the latest API version.
Use the exact date listed in the reference. A valid date between releases selects the most recent version on or before that date. A malformed date or a date before the earliest supported version is rejected.
Changes and deprecations
Breaking changes, such as removing a field or changing an endpoint's request shape, are introduced in a new dated version. Earlier supported versions retain their contracts. Compatible additions can reach existing versions, so clients should accept unfamiliar response fields.
For example, version 2025-04-01 takes the company identifier in the report
URL, while 2026-05-01 takes kausateId in the JSON body of
POST /v2/companies/report.
When a feature is marked deprecated, check the reference for its replacement and any published retirement date. Pin the target date in a test environment and verify the endpoints you call, the fields you read and any error responses you handle before changing the header in production.
Webhook payloads
Order webhooks normally follow the version of the originating request. Use
payloadVersion on a webhook endpoint to pin its order payloads
independently. Read Kausate-Version on the incoming delivery before decoding
the body. Monitor events use the current version. The
webhook guide explains the
fallback order and retry behavior.
Last updated on