Skip to main content

Unlocking Your API Key

How to access your API key in Kintsugi

Updated over 2 months ago

This guide explains how to access your Kintsugi API key, whether you’re a premium plan subscriber or not.


Overview

Your Kintsugi API key provides access to powerful tax-engine integrations and developer tools. The steps to unlock your API key differ slightly depending on your subscription status. Please follow the instructions below that applies to you.


🔒 If you haven’t upgraded to a Premium Plan yet

Your API key remains locked until you meet the following requirements:

1. Upgrade to a Premium plan

  1. Go to Configuration → Billing Details → Current Subscription Plan.

  2. Click Choose Plan and select the Premium option.

  3. Make sure your payment details are valid and active.

2. Complete your onboarding

You must complete all onboarding tasks before your API key becomes available.

Once onboarding steps are completed, your API key will automatically unlock — no manual action required.

3. Access your API key

When your account is upgraded and onboarding is complete, you can locate your API key in the Configurations > API Key section of your Kintsugi app.

NOTE:

If you prefer not to upgrade yet, you can still test Kintsugi’s API using a sandbox environment:

  • Create a Test Organization to generate a test-only API key (which will not have access to or be connected to real data). Kindly refer to this guide: Creating a Test Organization


⭐ If you’re already on a Premium Plan

Great news! Your API key should unlock automatically once onboarding is complete.

1. Confirm onboarding completion

  • Make sure all onboarding sections are complete. The Dashboard's Pending Tasks section should show no tasks or no actions required.

  • Check that your data sources are connected/active and your organization information is filled out.

2. Locate your API key

You’ll find your unlocked API key in Configurations > API Key section.

Follow this guide to view and manage your key:


🧩 Troubleshooting Access issues

If your API key still isn’t visible:

1. Refresh your Kintsugi Screen

  • Refresh your Kintsugi page.

  • Log out and then log back in.

2. Verify your setup

  • Ensure your Premium plan is active and payment has processed successfully.

  • Double-check that all onboarding steps are completed.

3. Contact Support

If your API key remains locked after verifying everything, reach out to our Support team:

Please include any relevant screenshots or account details to help us resolve the issue quickly.

Did this answer your question?