Exploring API Access for Test Environment (Sandbox) and for Live Organization

What is Kintsugi's API?

An API (Application Programming Interface) allows different software systems to communicate with each other. Kintsugi's API lets you programmatically interact with our platform, enabling you to automate tasks, integrate with other tools, and build custom solutions.

Understanding Test vs. Live Organizations

Before accessing Kintsugi's API, it's important to understand the difference between test and live organizations:

Test Organization (Sandbox)
A safe space where you can experiment, test features, and develop integrations without affecting your real data or compliance workflows. Think of it as a practice area.

Live Organization
Your actual working environment where your real data and compliance processes reside.

API Access for Test Organizations

You can explore Kintsugi's API in a test organization on any plan, including Free. No paid plan or Premium subscription is required.

How to get started:

1. Create a test organization. Go to Configuration → Settings, scroll to Create Test Organization, and click Create. Full steps are in Creating a Test Organization.

2. Confirm you are inside the test organization before continuing. The organization switcher shows a Test badge. If you do not see it, switch organizations first.

3. Go to Configuration → API Keys and click New.

4. Choose an expiration period, then copy the key using the copy icon. The key is displayed only once.

API Access for Live Organizations

API keys for live organizations are a Premium feature. Two conditions must both be met:

1. An active Premium subscription. Go to Configuration → Billing Details → Current Subscription Plan, click Choose Plan, and select Premium. Confirm your payment details are valid.

2. A completed onboarding checklist. Your key stays locked until every onboarding task is finished. Check the Pending Tasks section on your Dashboard.

Once both are done, generate your key at Configuration → API Keys. See How to Create and Delete API Keys.

Which plans include LIVE organization API keys?

The Starter plan does not include API keys. Starter is a paid plan, but API access is a Premium-only feature.

If you are on Free or Starter, the API Keys tab still appears under Configuration with a padlock icon. That is expected behavior, not an error.

Your API key only works in the organization that created it

Every organization has its own Organization ID and its own API keys. A key generated in a test organization authenticates only against that test organization. It cannot read, write, or calculate against your live organization, and a live organization key cannot reach your test organization.

This matters most when you connect an external platform. If you set up an integration such as Chargebee using a test organization key, the connection points at your sandbox rather than your live compliance data. Symptoms usually look like authentication failures, or transactions appearing in an organization you did not expect.

Before pasting a key anywhere, confirm two things: which organization you were in when you generated it, and which Organization ID you are sending alongside it. API requests need both, since the key authenticates the request and the Organization ID tells Kintsugi which organization it applies to. See Where to Find Your Organization ID.

Key points to remember

• Test organization API keys are available on any plan, including Free. No paid plan is required.

• Live organization API keys require Premium and a completed onboarding checklist. Starter does not include them.

• Both test and live organizations can be created without a paid account. Creating an organization and getting an API key are separate things.

• API keys are scoped to a single organization and are not interchangeable between test and live.

• Test organizations provide a risk-free space for development, experimentation, and training.

• Test organizations cannot be converted into live organizations.

Need help?

For further concerns, we're always here to help. If you can't find the answer you're looking for, just reach out to us using the chat in the bottom right corner of your screen.