In order to effortlessly implement the eID Hub, we highly recommend that you make use of our API documentation, which includes a dedicated section on authentication and explains further how to use the API token.

When setting up the integration, consider the following:

Using (or not using) the eID Hub frontend:

The eID Hub provides a frontend for all eID providers. If you integrate to more than one eID, it is recommended that you use eID Hub frontend, since it has the same flow for all providers.
If using the eID Hub frontend, you only need to use two API endpoints: one for creating a new transaction and one for retrieving the transaction details. If not using the eID Hub frontend, you will need to use one additional endpoint to start transactions.
Norwegian BankID, Finnish FTN, German Verimi, Dutch iDIN and Belgian itsme, all have their own stand-alone UI. If only integrating to these providers, it’s not necessary to use the eID Hub frontend. For these providers, the eID Hub frontend redirects to, or, embeds the provider's own UI.
For Swedish BankID, SMS OTP, and Freja eID, which do not provide an UI, you can either use the eID Hub frontend or implement your own UI.
For Onfido, Swisscom and Danish MitID, which do not provide a hosted stand-alone UI, you have to use the eID Hub frontend.

Redirect or pop-up window:

We strongly suggest using a redirect, as it provides a smooth end-user experience and has the widest compatibility.

After authentication or signing, the end user is redirected to the URL specified when creating the transaction. The UI behaviour on this URL is defined by the selected strategy:

Redirection: next-step page
Pop-up window: self-closing script (most likely)

Define provider parameters:

The API documentation describes the necessary parameters for each provider and contains the JSON body fields for each endpoint.

You can collapse and expand the branches with provider parameters. For example, in the “Add new transaction” section, you can expand providerParameters, and then further expand the sign and noBankID branches to see all parameters needed to create a new sign transaction with Norwegian BankID.

You will also see which parameters are mandatory (marked as Required) and which are optional.

The response JSON body has a similar nested presentation structure. You can also expand the branches in the documentation. The fields marked as required are always present and will never be null. Other fields may be absent or may be null.

Make sure to read the section on Versioning in the API documentation as the addition of new JSON fields is considered a non-breaking change.

Integrating the eID Hub