Skip to main content

Usage

Start a SE BankID transaction by creating one with the transaction endpoint, choosing seBankID as the provider and auth or sign as the method. You can integrate using the eID Hub frontend, which handles the BankID UI for you, or go API-only if you need full control over the user experience. The end user completes it in their BankID app, either on the same device via autostart or on another device by scanning an animated QR code. Both are part of BankID's mandatory secure start, which eID Hub handles for you.

SE BankID specifics worth knowing at the guide level:

  • Signing requires the text the user will see and sign. You can optionally pass data that's signed but not shown.
  • You can pre-fill the user's personal number or leave it out and let them identify in the app.
  • Secure start is always enforced. Any older autostart-token toggle is ignored.
  • The completion redirect to your redirectUrl only fires for SE BankID when you use the eID Hub frontend. For other providers it's unconditional.
  • SE BankID is one of the few providers whose transactions can be cancelled after they've started, not only before. See Cancel a transaction.

Risk indication and forced security code are optional controls set on the request.

Phone authentication (callInitiator)

BankID can identify a user during a phone call rather than on screen, for example when a support agent verifies a caller. Set callInitiator to record who placed the call: User if the customer called you, or RP if you called the customer. Setting it switches the transaction to phone authentication.

Two things to note: risk indication is not available in phone authentication, and extra control (below) is compatible with it.