Getting Your Partner API Key

How Everee issues, rotates and retires your partner API key. You claim it yourself, so nobody at Everee ever sees it.

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.

Test and production keys

You get two kinds of partner key:

  • A test key (zk_test_) creates and reaches only your Sandbox companies. You can claim one once your partnership agreement is in place and Everee has set up your access, or earlier, for a limited time, under evaluation access, so you can build and test your integration. See Who Payroll Infrastructure is for.
  • A production key (zk_prod_) creates and reaches only your Production companies. Everee issues one after it reviews and approves your integration.

You keep your test key after approval, so you can keep creating Sandbox companies to test with. Each key reaches only its own environment: a request with the test key for a Production company, or with the production key for a Sandbox company, returns 404. See Sandbox & Production.

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

  1. Your Everee contact invites you. They choose whether it is a test key or a production key, a label for the key (for example "Sandbox" or "Production"), and who should claim it. Claim a test key first. The production key comes after Everee approves your integration, and it is claimed the same way.
  2. 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.
  3. 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.
  4. Open the link, enter the code and select Generate my key. The key appears once, together with its key ID. The key ID is not a secret: it identifies the key, so quote it when you ask Everee about the key.
  5. 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.
The screen where you claim your partner API key

Claiming your partner key from Everee.


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 zk_test_2 for a test key or zk_prod_2 for a production key, and is 57 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:

  1. They invite a technical contact to claim the replacement, the same way as above. The replacement is the same kind of key as the one it replaces: a test key is replaced by a test key.
  2. 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.
  3. 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 seeWhat to do
The link says it was already used, expired or revokedAsk your Everee contact for a new invitation.
The link says it is lockedAsk your Everee contact for a new code.
You lost the key after claiming itAsk your Everee contact to rotate it.
Payroll run requests return 400 with "This company isn't set up for embedded payroll"The company is hosted. Create your Sandbox companies with your partner test key. See Hosted payroll or Payroll Infrastructure?.
Requests return 401The 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). You manage the company's keys with your partner API key: see, add, rotate and retire them with the Company API keys endpoints. If a company key is lost, create or rotate one.


Did this page help you?