Skip to main content
API keys let external systems call the AI Insurance API on your company’s behalf — integrations, dashboards, data syncs, configuration as code. The API Keys tab of the admin area is where keys are created, reviewed, and revoked. Open it by selecting your company name at the bottom of the left sidebar, then the API Keys tab.
Any role that can view API keys sees this tab — every standard role except Client Member. Creating and revoking keys needs the Create an API key and Revoke an API key permissions, which of the standard roles only Admin holds. See Roles & permissions.
The admin API Keys tab showing a Company ID card with a copy button, and below it an API Keys table with Name, Description, Role, Expires, Last Used, and Actions columns plus a Create New API Key button.

The API Keys tab: your Company ID at the top, then the key list.

​
Your Company ID

The card at the top of the page shows your Company ID, with a copy button. Most API endpoints include the company ID in their URL, so you’ll need it alongside any key — see Authentication for how the two fit together in a request.

​
The key list

Each key row shows:

​
Keys have roles

A key’s access is scoped by a role — one of your company’s roles, the same list users are assigned from. A key with the Viewer role can only read and export data; a key with Admin can do everything its user counterpart could. Give each integration the least powerful role that covers what it does — a read-only reporting integration should get Viewer, not Admin.
Custom roles work for keys too. If no standard role fits an integration, create one with exactly the permissions it needs and assign that role to the key.

​
Create a key

1

Select Create New API Key

The button sits at the top right of the API Keys card.
2

Configure the key

Give it a Name (e.g. “External Dashboard Integration”), pick its Role, optionally set an Expiration Date (the field defaults to one year from today; clear it for a key that never expires), and optionally add a Description.
3

Copy the key

The new key is shown once, in the confirmation dialog, with a copy button. Store it somewhere secure (a secrets manager, not a shared doc) — after you close the dialog it can never be displayed again. The dialog briefly holds the Done button so you don’t dismiss it before copying.
The Create New API Key dialog with a Name field, a Role dropdown, an optional Expiration Date field noting the one-year default, an optional Description field, and Create Key / Cancel buttons.

Configure the key's name, role, and expiration.

The API Key Created dialog showing a warning that this is the only time the key will be shown, the key value in a monospace box with a copy button, a summary of the key's name, role, and expiration, and a Done button.

The key is displayed exactly once — copy it before closing.

Treat an API key like a password: it grants access to your company’s data at the level of its role. If a key is ever exposed, revoke it immediately and create a replacement.

​
Use a key

Requests authenticate by sending the key in the Authorization header — the raw key, with no prefix. The full request format, examples, and pitfalls are in Authentication; the endpoint catalog is in the API reference.

​
Revoke a key

The trash button on a key’s row revokes it after a confirmation. Revoking is immediate and permanent — any application still using the key loses access on its next request, and the key can’t be restored. To rotate a key, create the new one first, switch your integration over, then revoke the old one.