OTP
The Verify Email process is used to confirm the validity of a user's email address, it typically involves sending a verification email to the user's provided address, which contains a unique verification code.
How to setup,
1 Go to Workspace > Workflows, and click on the flow created for Verify Email. If you need understanding in creating a workflow, refer to the step-by-step guide here.
2 Hover over the plus (+) symbol and select Workflow. From the list, click Verify Email to add it.
3 Click on the newly added workflow, then select the General tab to customize your preferences.
Manage General
| Name | Description |
|---|---|
| Enable | This toggle is enabled by default. When enabled, the particular workflow module begins its execution. Conversely, if disabled, the workflow module remains inactive and won't proceed. |
| Rule | This determines the criteria for triggering the particular workflow module. When the selected rule is evaluated, and is satisfied, the workflow proceeds as provided. If not, the workflow will not be executed. Note: If no rules are set, the workflow defaults to its standard action without any rule. For more information about the rules, refer here. |
4 Then, click on the Configs tab to set the necessary configurations.
Manage Configs
| Name | Description |
|---|---|
| Email Verification Expiry Duration | This setting allows you to specify the duration for which the email verification link or OTP (One-Time Password) remains valid. After this period, the verification process expires and users will need to request a new verification. |
| Email Verification OTP Length | You can configure the length of the OTP (One-Time Password) used for email verification. The length can be set within the range of 4 to 8 digits, with a default value of 6 digits. |
| Allowed Email Domains | Specify the email domains that are allowed to be verified. Only email addresses from these specified domains will be considered valid for verification purposes. |
| Email Sender | By default, all emails are sent through the default Email Provider configured for the system. If you prefer to use your own email provider, instructions on how to configure this can be found here. |
5 After you've configured everything needed, click on SAVE.
6 Proceed to attach the workflow to the relevant application for execution. Refer to instructions on how to attach a workflow to an application here.
Expected result
Based on the provided configuration, the information that will be fetched for Verify Email includes the following parameters:
| Name | Description |
|---|---|
email_verified | This denotes whether the email verification is completed. The value will be "True" if the verification is successfully completed and "False" if it is not. |
email | Refers to the email address being validated or verified. |
email_verified_at | This provides a timestamp, in Unix epoch format, indicating the exact time when the email verification was completed. This allows you to know precisely when the verification event occurred. |
The response received will include the accurate information mentioned above. Note that, the response values can vary depending on the specific workflow modules.
How it works,
1 Launch Postman or your preferred API tool and execute the flow by configuring the suitable Method, URL, and Body settings. If you're seeking guidance on how to perform these actions, see here.
2 Upon initiating the API call, a verification request will be sent to your configured Verification Way settings.
3 Based on the request, execute the flow in an incognito browser and follow the prompts to complete the verification process.
4 Begin by providing the Email Address and click on Submit.
5 An email containing an OTP will be sent to the email address provided above. Please input the OTP and click on Submit to proceed.
6 The verification process will be completed only if the entered data is valid.
If "force onboarding" is enabled in the API request, all users, regardless of status, will be directed to the onboarding flow first, followed by the verification flow if configured.
7 The response can differ depending on the chosen Verification Way and Notification Way configurations. To know more, see here.
8 Here is a sample response for Verify Email:
{
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"user_id": "mark@gmail.com",
"workflow": "verification",
"email": "mark@gmail.com",
"email_verified": "true/false",
"email_verified_at": "1719569072",
}