Help CentreAPI keys let your own systems and integrations connect to Veridox. You create and manage them on the API keys page in Settings. Anyone whose role can view organisation settings can see the keys. Creating and revoking them needs edit access: by default, Organisation Admins can view and Organisation Owners can manage. See Roles and permissions for how access works.
This page covers managing keys in the dashboard. For how to use a key in code, including authentication, endpoints, and request formats, see docs.veridox.ai.
Generate a key
You can hold several keys at once. One per service or integration is a good habit.
- Select Generate Key.
- Give it a Name, such as the service or integration it's for. Each active key needs a unique name.
- Choose the key's Permissions: what it's allowed to do, picked from the permissions your own role holds. At least one is required. A permission that lets the key change or delete something also lets it view that thing.
- Optionally set an Expires At date. Leave it blank for a key with no expiry.
When the key is created, it's shown to you once, with the warning:
Copy this key now. You will not be able to see it again.
Use Copy key to copy it and store it somewhere safe, then select Done. If you lose it, you'll need to generate a new one.
A key's permissions are fixed
A key keeps the permissions it was created with. They don't change if your role changes or your organisation tightens what roles can do, so review your keys after any role change. Revoking a key is the only way to remove its access.
Manage existing keys
Each key in the list shows its Name, its permissions, an Active or Inactive status, a masked preview of the key, when it was Created, when it Expires (or No expiry), and when it was Last used (or Never used). The full key is never shown again after creation, only the preview. Turn on Show inactive keys to include keys that have been revoked or have expired.
To remove a key, select Revoke and confirm. Anything using that key loses access immediately (your other keys are unaffected), so revoke a key only when you're sure it's no longer in use.