Skip to main content

[V2.1] Generating API Credentials

Create an API credential in the dashboard and use it to get access tokens for the Notabene API.

Written by Emanuel

Your backend needs an API credential to call the Notabene API. A credential is a client ID and a client secret, which your backend exchanges for an access token, and it sends that token with every request.

Requirements

  • API access comes only with Notabene’s paid plans.

  • Your account must be active before you can create production credentials.

  • Your role needs API credentials access: Group Admin, Entity MLRO or Entity Admin, as listed in Member Roles and Permissions.

Create a credential

  1. In the dashboard, go to Developers › API Credentials.

  2. Click Create API Credentials.

  3. Copy the client ID and the client secret, and store the secret in your secrets manager.

The client secret is shown only once. Store it straight away, because the dashboard cannot display it again.

Use the credential

Your backend exchanges the credential for an access token with the OAuth 2.0 client credentials grant, and a token lasts 24 hours. A credential works only in the environment where you created it, sandbox or production. The token request for each environment is in Authentication in the developer docs.

Limits and rotation

You can hold up to 3 credentials at once. To rotate a credential without downtime, create a new one, move your backend to it, and then delete the old one.

If you need help with your credentials, write to support@notabene.id.

Did this answer your question?