How do I create and manage API keys to connect other software to Corfix?
This article will summarize what API keys are, how to create one in Corfix, and how to keep them secure.
If your company wants to connect Corfix to another software system, such as a payroll, accounting, or ERP platform, you will need an API key. This article walks you through creating, editing, and deleting API keys, and explains who on your team can manage them.
Prerequisites / Warning- You need permission to manage API keys. Your role must have the API Key permissions enabled (see "Who Can Manage API Keys?" below). If you do not see the Manage API Keys button, contact your company administrator.
- Contact your Customer Success Manager API Docs.
- The key's secret is shown only once. When you create a key, Corfix displays the secret a single time. If you lose it, you cannot recover it — you will need to delete the key and create a new one.
- Deleting a key is permanent. Any connection using that key will immediately stop working.
An API key works like a special password for software instead of people. It lets another system, such as your payroll or accounting platform, securely talk to Corfix on your company's behalf without anyone needing to log in manually.
Each key is made up of two parts:
- A Name and Description so you can remember what the key is used for (for example, "Acumatica").
- A Secret, which is the actual password the other software uses. Treat it like any other password: keep it private and store it somewhere secure.
Each key is also assigned a Role, which controls what the connected software is allowed to see and do in Corfix. For example, a key assigned the Admin role can access the same information an Admin user can.
How It WorksCreating an API Key
- Go to My Account Details in the left-hand menu.
- Under Company Details, click Manage API Keys.
- On the API Keys page, click the blue Add button in the top right.
- In the Add API Key window:
- Enter a Name for the key (required, at least 3 characters). Use a name that describes what it connects to, like "Acumatica".
- Optionally, add a Description with more detail.
- Select a Role. This determines what the connected software can access. Choose the most limited role that still allows the connection to work.
- Click Save.
- A confirmation window appears with your key's Secret. Click Copy and save the secret somewhere secure right away — this is the only time it will be displayed.
- Click OK to finish. Your new key now appears in the API Keys list.
Editing or Deleting an API Key
- On the API Keys page, find the key in the list.
- Click Choose Action in the Actions column
- Select Edit to update the key's name, description, or role, or select Delete to remove it.
Warning: Deleting a key immediately disconnects any software using it. Only delete a key if you are certain it is no longer needed, or if you believe the secret has been exposed.
Who Can Manage API Keys?
Administrators can control which roles are allowed to work with API keys. Under your role settings, the API Key Permissions section contains four toggles:
- View API Keys — see the list of keys.
- Add API Key — create new keys.
- Edit API Key — change a key's name, description, or role.
- Delete API Key — remove keys.
Turn on only the permissions each role needs, then click Save.
Use Cases and Benefits- Connect your payroll software: Automatically send time and payroll data between Corfix and your payroll platform, removing manual exports.
- Sync with your accounting or ERP system: Keep projects and records aligned across systems, such as with Acumatica or Sage.
- Control exactly what connected software can access: Assigning a role to each key means a connection only sees what it needs, nothing more.
- Revoke access instantly: If a connection is no longer needed or a secret is exposed, deleting the key cuts off access immediately.
- Track your connections: The API Keys list shows each key's name, description, creation date, and role, so you always know what is connected and why.