Skip to main content
Required Shift role: Technical. See Users management for the full role matrix.
An API key is the credential a server on your side uses to call the Paylead API on its own, with no human signed in to Shift: your bank’s mobile app backend, a data ingestion job, a scheduled report. Each key is a client_id and client_secret pair. Your system exchanges it for a short-lived access token, then sends that token on every API call. Generate, view, and revoke keys from My account > Developers > API Keys. For how the pair becomes an access token and how that token travels on each call, see Authentication. For events Paylead pushes to your system in real time, see Webhooks. The API 2.0 documentation button at the top of the screen opens the API overview.

Scopes

The scopes you pick decide which parts of the API a key can reach. They are fixed at generation: to change the reach of an integration, generate a new key and revoke the old one. Give each key the scopes its system calls and no more. Checking Full access checks and locks every other scope. Uncheck it to return to your individual selection.

View existing keys

The API Keys table lists every key active on your Program. Revoking a key removes its row, so the table is your live inventory of what can reach your data. The bin icon at the end of each row revokes the key.

Generate an API key

1

Open the generator

In My account > Developers > API Keys, click Generate new API key.
2

Name the key

In Label (required), name the consuming system, for example Lyra mobile app or Yuna ingestion job. Future operators rely on this label to know what they would break by revoking the key. One key serves one system: do not reuse a key across services.
3

Pick the scopes

Check the scopes the system needs. See Scopes.
4

Set the token lifetime

TTL sets how long each access token stays valid, in seconds. Leave it blank for the default of 3600 seconds (one hour).
5

Generate

Click Generate key. Shift opens the API key generated dialog with the Label, Scopes, Client ID, and Client Secret.
6

Copy the credentials

Copy the Client ID and the Client Secret with the copy buttons next to them and paste both into your secret manager before you click Close: the secret is never shown again. If you closed the dialog without it, revoke the key and generate a new one. The new key appears in the table.
The key is usable immediately. Request an access token with it from the consuming system, as described in Authentication, to confirm the credentials reached it intact.

Rotation and revocation

A key stays valid until someone revokes it, so rotation only happens if you schedule it. For the rotation sequence and secret handling, see Rotate credentials. Generate each key from the Shift environment it will call: sandbox and production credentials are separate (see Sandbox vs. production credentials).

Revoke a key

In the key’s row, click the bin icon, then click Confirm. Shift revokes the key and the row leaves the table.
Revocation cannot be undone. The key stops issuing access tokens at once, and the tokens it already issued expire at the end of their TTL. Deploy the replacement key before you revoke, not after.

API 1.x keys

Keys issued for API 1.x live on a separate screen. Open it from the See API 1.x keys link in the banner at the top of API Keys, and come back with ← API keys. New integrations use the keys described on this page.

What’s next

Webhooks

Register a callback URL and receive Program events in real time.

Authentication

Exchange the key for an access token and send it on each call.