Session authentication API

The Session authentication API enables you to create and manage the JSON Web Tokens (JWT) required for integrating components.

Authentication

We recommend that you use an API key to connect to the Session authentication API. Generate an API key in your Customer Area if you have a platform setup or marketplace setup. If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area.

To connect to the Session authentication API, add an X-API-Key header with the API key as the value, for example:

curl
-H 'Content-Type: application/json' \
-H 'X-API-Key: ADYEN_LEGAL_ENTITY_MANAGEMENT_API_KEY' \
...

Roles and permissions

To create a token, you must meet specific requirements. These requirements vary depending on the type of component. For more information, see the documentation for Onboarding and Platform Experience components.

Versioning

The Session authentication API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://test.adyen.com/authe/api/v1/sessions

Going live

To access the live endpoint, generate an API key in your live Customer Area if you have a platform or marketplace setup. If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area. You can then use the API key to send requests to https://authe-live.adyen.com/authe/api/v1.