API Keys

API Keys are required to call API.1 (Consent API and Accounting API). You create and manage API Keys in the Client Portal per environment. For how to use your key in API.1 requests, see Usage.

Create Development API Key

Create a Development API Key for non-production use—e.g. when building or testing your integration. Development keys let you create Development Consents and access sandbox data. For how to use the key in requests, see Usage. For the full lifecycle, see API Key Lifecycle.

Create Production API Key

Create a Production API Key when you are ready to go live. Production keys let you create Production Consents and access real data from Your Customer's Accounting Systems. Store it securely—see Security. For creation and lifecycle, see API Key Lifecycle.

Naming and expiry

When creating an API Key you can set a descriptive name and an expiry. For details and recommendations on expiry and rotation, see API Key Lifecycle.

Delete API Key

You can delete an API Key from the Client Portal. Once deleted, it can no longer be used for API.1 requests. For the full lifecycle and rotation steps, see API Key Lifecycle.

circle-info

Expiry reminder emails

To support business continuity, we send expiry reminder emails as an API Key's expiry date approaches and again 24 hours before it expires.

Last updated

Was this helpful?