Skip to main content

Standard API keys

Standard API keys are the original per-user credentials. They are sent in the Authorization header using the format apikey USERNAME:API_KEY.

info

Standard keys are fully supported, but new integrations should prefer Bearer API keys, which are client-scoped (full-access or route-limited) and can expire.

Every request also needs the shared Client Header (CLIENT-ID), the correct Environment URL, and — where required — the signature headers.

Authorization Header​

The Authorization Header provides credentials that authenticate a user agent with a server, allowing access to protected resources.

Required Keys

  • UsernameREQUIREDString

    Obtained from the Keys section in Settings

  • API_KEYREQUIREDString

    Obtained from the Keys section in Settings


Authorization Header
AUTHORIZATION: 'apikey `USERNAME:API_KEY`'

This is how your authorization header should look:

Authorization Header
AUTHORIZATION: 'apikey api_demo:1f2pdas7jkj389d8sda'
tip

The Interactive API is a convenient way to try API endpoints. Visit the Interactive API v8: Receipts & Invoices test from the portal.

Managing standard keys​

To create, remove, or reset standard keys via the partner API, see Standard API Key Management.