Help centre / Your organisation / For your developers

Create and revoke keys

Updated · 1 minute to read Download as PDF

An API key lets one of your own systems use Unforged. Make a separate key for each system, so you can revoke one without disturbing the others.

  1. Open Keys

    From All products, open Organisation and then Keys.

  2. Name the key

    Select Create key and give it a Name that says where it’s used, for example Loan system (prod).

  3. Choose what it can do

    Tick the permissions the system needs, or select Checks only for a key that just runs and reads signature checks. A key can’t do more than you can yourself.

  4. Copy it straight away

    Select Create key, then Copy, and put the key wherever your system keeps its secrets. We only show it once, so if you lose it, create a new one.

  5. Revoke a key

    Find the key in the list, select Revoke and then Revoke key. Anything still using it stops working on its next request, and this can’t be undone.

Keeping keys safe

Treat a key like a password. Keep it out of emails, chat messages and shared documents. If you think one might have leaked, revoke it and create a new one straight away.

The Last used column tells you whether a key is still in use, which helps when you’re tidying up old ones.

If something goes wrong

A permission can’t be ticked. Your own role doesn’t include it. Ask an Owner to create the key, or to change your role.

Your system stopped working after someone left. Their keys may have been revoked when they were removed. Create a new key and update your system to use it.

Still stuck? Write to [email protected] and we'll get back to you.