For the complete documentation index, see llms.txt. You can also append .md to any page URL to get its markdown version.
Skip to main content
For the complete documentation index, see llms.txt.

For the complete documentation index, see llms.txt

Authentication REST API

The Signicat Authentication REST API is our bespoke authentication protocol to enable you to perform end-user authentication and identity verification with electronic identities (eIDs) in an easy and secure way.

The Authentication REST API supports many different authentication flows, such as redirect, headless and embedded flows.

To learn more about the endpoints and properties of the Authentication REST API, see the API reference documentation.

Authentication protocols comparison

Integrating with the Authentication REST API offers less complexity than using OIDC and SAML 2.0.

Advantages:

  • REST standard: With a simple REST API, you do not need to implement complex protocols.
  • Wide flow support: The API supports complex flows such as headless and embedded flows.

Limitations:

  • You always need a backend system to call the API securely.
  • You may have to write more custom code instead of relying on an SDK like for OIDC and SAML.

Available flows​

The Authentication REST API supports the following authentication flows:

Redirect flow​

In a redirect flow, you redirect the end-user from your application to a Signicat-hosted page to authenticate with their chosen eID. After the end-user completes authentication, Signicat redirects them back to your pre-configured success callback URL. Your backend then queries the Authentication REST API to retrieve the session status and verified identity attributes (such as the subject identifier).

To explore a generic, step-by-step implementation, see the Redirect flow guide.

Headless flow​

In a headless flow, the frontend and backend components are decoupled so that your application maintains complete control over the user interface and user experience.

Instead of redirecting the end-user to a Signicat-hosted page, your backend initiates the session with the Authentication REST API and delivers the interaction challenge (such as a QR code or app-switch deep link) directly to your client application. All communication between your backend and the Signicat Authentication REST API is handled in the background.

Headless flow is currently only available for the following eIDs:

To explore a generic, step-by-step implementation, see the Headless flow guide.

Embedded flow​

Embedded flows enable you to render the authentication flow inside an iframe in your application (as opposed to the redirect flow where you are redirecting the user to another page).

In an embedded flow, the authentication journey happens inside a component, like an iframe, embedded within your UI. In this scenario, your application manages the iframe and polling logic, creating a hybrid integrated experience for your end-users.

We support embedded flows for the following eIDs:

API reference​

In our Authentication REST API reference, you can find information about the available endpoints and properties, as well as sample requests and responses.

Authentication REST API
Configure your Authentication REST API

Tutorial video​

This video shows you how to configure the Authentication REST API for the Signicat eID and Wallet Hub in the Signicat Dashboard.

On this page