Configure Email OTP
With the Signicat Email OTP service, you can perform email-based user authentication.
This page describes how to configure Email OTP on the Signicat Dashboard.
For more general information on how to integrate with Signicat, see the Quick start guide.
Prerequisites
If you don't have an account already, sign up for a free Signicat account by completing the following initial preparations:
- Sign up to the Signicat Dashboard and register your profile. For more details, see the Get started with Signicat guide.
- In the Dashboard, make sure you have set up an organisation and an account.
- Additionally, to use this product, you must set up a domain.
We recommend 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:
- In the Signicat Dashboard, navigate to Products > eID Hub > eIDs.
- Select Add new.
- Choose Email OTP from the list of eIDs.
- 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
- 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".
Test Email OTP in the Dashboard
After you activate Email OTP, you can simulate an authentication flow in the Signicat Dashboard.
If you are testing our services with a sandbox account, then we prepend all emails and SMS messages with a Test message warning.
- In the Signicat Dashboard, navigate to Products > eID Hub > eIDs.
- Select Test eIDs on the top-right side.
- Optional. If you have multiple eIDs active in your account, select Email OTP from the list of identity providers.
- Enter your email address, then select Next.
- Open your email account and copy the one-time password.
- 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.
Before going live with Email OTP in production, we recommend that you test your integration with an authentication protocol, as explained below.
Customise email service settings
Signicat Email OTP inherits the email settings configured in the Signicat Communication service.
On the Branding > Communication > Email page in the Signicat Dashboard, you can manage the email settings for your account. In particular, you can customise:
- The email sender name
- The email domain name (
{from_address_prefix}@{domain_name}) - The email address prefix
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.
Find out more about setting custom email settings in the Communication service documentation.
Set up a connection with a protocol
To establish a connection between Signicat Email OTP service and your application, you need to use an authentication protocol.
With Signicat you can integrate using the following authentication protocols:
- OpenID Connect (OIDC)
- Security Assertion Markup Language (SAML) 2.0
- Signicat Authentication REST API
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 - developed and maintained by Signicat - offers more flexibility and supports headless and redirect integration flow(s) (grant type).
You can find integration guides and more information about each protocol in the Signicat eID Hub documentation.
Set up the protocol
To integrate to Email OTP with OIDC or the Signicat Authentication REST API, select one of the guides below:
For more information about the different protocol types, see the Signicat eID Hub documentation.