Skip to main content

API keys

Your API key is how your integration authenticates with the API. Each institution has one active key at a time.

Getting a key​

Keys are issued from your uapply dashboard — or by the uapply team on your institution's behalf. When a key is created, the full key is shown once: copy it right away and store it somewhere safe.

A key looks like this:

uap_live_a1B2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v

(uap_live_ followed by 43 characters.)

Using your key​

Send it in the Authorization header on every request:

curl https://api.uapply.africa/api/v1/applications \
  -H "Authorization: Bearer uap_live_your_key"

See Authentication for the accepted header formats.

Rotating a key​

Need a fresh key — or think your current one may have leaked? Rotate it from your dashboard. Rotating:

  • issues a brand-new key (shown once, just like the first), and
  • immediately disables the old one.

So update your integration with the new key right away, or requests will start failing with 401.

Keep it safe​

  • Shown once. uapply can't recover a key for you — only replace it. If you lose it, rotate to get a new one.
  • Server-side only. Treat the key like a password. Never commit it to source control or ship it in a browser app.
  • One active key. Creating or rotating a key replaces the previous one.