Skip to main content

Configure Email OTP

With the Signicat Email OTP service, you can perform email-based user authentication.

This page describes how to configure Email OTP in the Signicat Dashboard.

Want to learn more?

For general information about integrating with Signicat, see the eID and Wallet Hub Quick start guide.

Prerequisites​

If you do not have an account already, then you need to sign up to the Signicat Dashboard for free and complete the initial preparations. To do this:

  1. Sign up to the Signicat Dashboard and register your profile.
  2. Ensure that you have created an organisation.
  3. Create an account. To do this:
    1. Go to Signicat Dashboard > Organisation, then select + Add account.
    2. Enter an account name, choose the type of account that you want to create, then select Create.
  4. Create a domain. To do this:
    1. Go to Signicat Dashboard > Settings > Domain management, then select + Add domain.
    2. To create a standard domain, enter a domain name. Then, select Add domain.
    3. To create a custom domain, follow the instructions in the Custom domains documentation.
Account types

We recommend that you create a sandbox account to test our services before going live. Sandbox and production accounts must be set up separately.

Add Email OTP in the Dashboard​

To use an eID, you first need to activate it. In the Signicat Dashboard:

  1. In the Signicat Dashboard, navigate to Products > eID and Wallet Hub > eIDs.
  2. Select Add new.
  3. Choose Email OTP from the list of eIDs.
  4. Optional. Customise the email subject and body to unify the user experience with your brand.
    Note: You can use the HTML tags <b> (bold text) and <br> (single line break) to format the email body.
Email OTP page

Email OTP page

  1. Select Add to save and activate Email OTP in your account.

Email OTP should now appear in the list of available eIDs with the status set to "Active".

Customise email service settings​

The Signicat Email OTP inherits the email settings configured in the Signicat Communication service.

To manage the email settings for your Signicat account, go Branding > Communication > Email in the Signicat Dashboard. Here, you can customise:

  • The domain name ({from_address_prefix}@{domain_name})
  • The address prefix
  • The sender name

By default, the email sender name is set to "Signicat". The email domain and address prefix are set to noreply@email.signicat.com. Alternatively, you can set up your custom SMTP server or use your own custom email domain.

Learn more about how to edit the email settings in the Communication > Email documentation.

Theming​

The Signicat Theming services lets you customise your themes to offer a consistent branding experience to your end-users.

To customise the theming of the Email OTP authentication flow, follow the instructions in the Theming documentation.

Test Email OTP in the Dashboard​

After you activate Email OTP, you can simulate an authentication flow in the Signicat Dashboard.

Test message warning

If you are testing our services with a sandbox account, then we prepend all emails and SMS messages with a Test message warning.

  1. In the Signicat Dashboard, navigate to Products > eID and Wallet Hub > eIDs.
  2. Select Test eIDs on the top-right side.
  3. Optional. If you have multiple eIDs active in your account, select Email OTP from the list of identity providers.
  4. Enter your email address, then select Next.
  5. Open your email account and copy the one-time password.
  6. Enter one-time password in the Email OTP UI, then select Verify.

You are now presented with a success page where you can review the flow metadata.

Test your integration

Before going live with Email OTP in production, we recommend that you also test your integration with an authentication protocol, as explained in the guides below.

Set up a connection with a protocol​

To establish a connection between Signicat Email OTP service and your application, you need to integrate with an authentication protocol.

With Signicat you can integrate using the following authentication protocols:

See the guides in the Implement with a protocol section below for instructions relevant to Email OTP.

Picking a protocol

OIDC and SAML 2.0 are official identity protocols. We recommend using OIDC since implementing SAML 2.0 involves more advanced steps.

The Authentication REST API is developed and maintained by Signicat. It offers more flexibility and supports headless and redirect flow(s).

You can find integration guides and more information about each protocol in the Signicat eID and Wallet Hub documentation.

Implement with a protocol​

To establish a connection with Signicat Email OTP, select an implementation guide with an authentication protocol below:

Integration with OIDC
Integrate with Email OTP using OpenID Connect
Integration with REST API
Integrate with Email OTP using Signicat Authentication REST API
Integration with SAML 2.0
Integrate with Email OTP using SAML 2.0

For more information about the authentication protocols, see the Signicat eID and Wallet Hub documentation.

On this page