Getting Your Partner API Key

Your partner API key lets your platform create companies and onboard them. For your security, Everee never sees or sends the key itself. Instead, a technical contact at your company claims it: Everee creates the key at the moment they claim it and shows it to them once.

Before you start

Tell your Everee contact who your technical contacts are: the people who may receive a key. Each one needs a name and an email address. A key can only be offered to a technical contact on this list, so ask your Everee contact to add anyone new before you need them.

Claiming your key

Your Everee contact invites you. They choose a label for the key (for example "Production") and who should claim it.
You get an email with a link. The link works for 7 days. Opening it only shows you what is waiting; it does not use anything up.
Your Everee contact gives you a 6-digit code on a call. Everee does not send the code by email, so someone who only has the email cannot claim the key.
Open the link, enter the code and select Generate my key. The key appears once.
Copy it somewhere safe right away, such as your secrets manager. It cannot be shown again. If you lose it, ask your Everee contact to rotate it.

Five wrong codes lock the link. Ask your Everee contact for a new code, or a new invitation if the link has expired.

When the key is claimed, every technical contact on your list gets an email saying who claimed it. If you did not expect that email, contact Everee right away.

Using the key

Your key begins with psk_prod_2 for Production or psk_test_2 for Sandbox, and is 58 characters long (<kind>_<mode>_<version digit><16-character key ID><32-character secret>). Send it as an HTTP Basic credential, as described in Authentication. Treat it like a password: keep it on your servers, never in client-side code, and never in chat or email.

Rotating your key

To replace a key, for example on a schedule or when someone who knew it leaves, ask your Everee contact to rotate it:

They invite a technical contact to claim the replacement, the same way as above.
Once the new key is claimed, the old key keeps working for a period you agree with them, from none up to one week, so you can switch your systems over without downtime.
When that period ends, the old key stops working and requests using it return 401.

Every technical contact is emailed when the old key is scheduled to stop working.

Retiring a key

Ask your Everee contact to expire a key. It can stop working immediately or after a delay of up to one week. An expiry that has not yet happened can be cancelled.

Something went wrong?

What you see	What to do
The link says it was already used, expired or revoked	Ask your Everee contact for a new invitation.
The link says it is locked	Ask your Everee contact for a new code.
You lost the key after claiming it	Ask your Everee contact to rotate it.
Requests return `401`	The key may have been retired, or mistyped. Check it is the key you claimed, then contact your Everee contact.

Company keys

Each company you create has its own company API key, returned once at company creation (see Creating and completing a company).

🚧
Coming soon: generating and rotating company keys
Generating a replacement company key and rotating it through the Partner Company API is not available yet. Until it ships, contact your Everee contact if a company key is lost or needs replacing.