Skip to main content
Scrive logoeID Hub Documentation

Integration

Scrive eID Hub provides a unified API for electronic IDs, identity verification, and signing services. While parameters differ between providers, every integration follows the same core pattern:

  1. Create an authentication or signing transaction with provider parameters.
  2. Direct the end user to the generated URL.
  3. After the end user authenticates, they are forwarded back to the URL provided at transaction creation.

Transaction lifecycle​

A transaction passes through the following states:

  • new — the transaction has been created by calling the new endpoint.
  • started — the transaction has been started, either by calling the start endpoint directly or indirectly via the eID Hub frontend. Starting a transaction creates a process at the eID provider, and often means it must be finalised within a defined timeframe.
  • complete — authentication or signing was successful.
  • failed — authentication or signing was not successful.

Some eID providers enforce an explicit timeout, so a transaction will always reach complete or failed once it expires. For providers without an explicit limit, if the end user abandons the flow, the transaction remains in started state and redirectUrl is never called. A transaction can also stay in started state if a technical error occurs during the flow that cannot be classified as either successful or unsuccessful.