Skip to main content
Create API keys for your integration and manage the keys you already have.

​
Who Can Do This

Only an Admin can manage API keys in API Center.

​
Create an API Key

1

Name the Key and Choose Its Type

Open API Center > Create API Key. Enter a Key name, choose Sandbox or Live, and select Next.Sandbox keys test supported workflows without changing business records. Live keys can perform real operations. Read Sandbox Mode before testing.
2

Select Access

Create API key dialog at the access step with the Full Access, Read Only, and Reports Only presets and the Advanced tab

Access Step

Choose a Preset (Full Access, Read Only, or Reports Only) or use Advanced to select individual access areas. Select at least one area, then Next.
3

Choose the IP Restriction

Create API key dialog at the IP restriction step

IP Restriction Step

Select Restrict by IP address or Unrestricted access, then Next.
4

Review and Create

Create API key dialog at the review step summarizing the key name, type, access, and IP restriction

Review Step

Review the name, type, access, and IP restriction, then select Create API key.
5

Save the Secret

The secret appears only once. Copy it into secure storage before closing the dialog. Do not put it in public code or send it to support.
6

Verify Access

Verify API access from the system that will use the key.
Grant only the access your integration needs. Credential-bearing and destructive service endpoints require Full Access (admin:full), not just service-write access. See API scopes.Forms, Settings, and scheduled-report scopes are reserved. Selecting them does not add public v1 endpoints for those features.
Restricted keys use the broker’s shared whitelist. You can create a restricted key with an empty list, but it rejects all requests until you add a matching address. See IP Firewall for setup.

​
Manage Existing Keys

API Keys table with masked live and sandbox keys

API Keys Table

The table shows masked keys, their status, and their IP restrictions.
Regeneration invalidates the old secret immediately. Save the replacement and update your integration. Deletion cannot be undone.
Last Used is the last time a key passed authentication, firewall, and rate-limit checks. It shows Never before that happens.
To add or remove allowed addresses or change a key’s restriction, follow IP Firewall. Its whitelist is shared by all restricted keys for your broker.

​
Troubleshooting

A name and at least one access area are required to create a key.
Add a whitelist entry before enabling IP restriction on an existing unrestricted key.
If creation fails after correcting the input, Contact Support with the error message, not a key secret.

​
Next Step

Review API Logs

Check the result of each request your new key makes.
Last modified on October 4, 2026