Skip to main content
Important: Kintsugi uses API key authentication via headers, not bearer token authentication. You must include both the API key and organization ID in request headers.

Prerequisite

1
Make sure you have an API key. Refer Creating and managing API Keys.
2
Make sure you have your organization ID.
  • Partner Experience (Partners): The organization/client context and IDs come from within the Partner Experience.
  • Kintsugi app (direct customers): You can find your Organization ID in the lower left-hand corner after logging into the Kintsugi Platform.

Making Requests

1
Now that you have the API Key and Organization ID, you’re ready to make authorized requests to the Kintsugi API.
2
API Key Header: Set your API key in the header with the key x-api-key (lowercase with hyphens):
curl -H "x-api-key: your-api-key" \
     https://api.trykintsugi.com/v1/tax/estimate
API Key Header
3
Organization ID Header: For most requests, you also need to set the organization ID in the header with the key x-organization-id (lowercase with hyphens):
curl -H "x-api-key: your-api-key" \
     -H "x-organization-id: your-org-id" \
     https://api.trykintsugi.com/v1/tax/estimate
Organization ID Header

Authentication Format

Kintsugi API uses header-based API key authentication, not bearer token authentication. Every request requires:
  1. x-api-key header with your API key
  2. x-organization-id header with your organization ID
Both headers are required for authentication. The organization ID ensures requests are scoped to the correct organization.

Finding Your Organization ID

Where you find your Organization ID depends on your account type:
  • Partner Experience (Partners): Your organization/client context and IDs are available within the Partner Experience.
  • Kintsugi app (direct customers): Your Organization ID can be found in the lower left-hand corner of the Kintsugi Platform dashboard after you log in. It’s displayed as a unique identifier for your organization.

Client API keys

Client API keys are created with one of two scopes (see Creating and Managing API Keys):
  • Partner scope: call the Partner APIs (/v2/partner/*) across your whole portfolio. The portfolio endpoints derive scope from the key; per-organization endpoints still take x-organization-id.
  • Client scope: call the main organization APIs for a single client. Send x-organization-id set to that client organization.
# Partner-scope key against a portfolio endpoint
curl -H "x-api-key: your-partner-api-key" \
     https://api.trykintsugi.com/v2/partner/clients
When your user belongs to more than one partner and you authenticate with a bearer session, select the active partner with the x-partner-id header.