Validate
The Validate Email process serves to verify and confirm the authenticity of an individual's email address.
How to Setup
1 Go to Workspace > Workflows, and click on the flow created for Validate 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 Validate Email to add it.
3 Click on the newly added workflow, then select the General tab to customize your preferences.
Manage General
(*) Indicates an action to be mandatory.
Name | Description |
---|---|
Display Name* | Set a name to the workflow for easy identification. |
Description | Summarize the purpose and functionality of this workflow module. |
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. |
Skip | Allows the user to skip this specific workflow module during execution. When selected, it provides an option to bypass the particular workflow without affecting other modules in the sequence. |
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 Valid Claims | Claims specify the information that should appear in the generated response. Note that only the selected claims will appear in the final response. The claims for Validate Email are, |
Threshold Email Validation Quality Score | Set the threshold value (maximum value: 100) against which the validation score is compared. If the email score exceeds this threshold, the email validation will be considered successful. This ensures that only email addresses with a quality score above the specified threshold are accepted. |
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.
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 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.
6 The response can differ depending on the chosen Verification Way and Notification Way configurations. To know more, see here.
7 Here is a sample response for Validate Email:
{
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"user_id": "mark@gmail.com",
"workflow": "verification",
"email_valid_verified_at": "1719569072",
"email_validation_verified": "true/false",
"email": "mark@gmail.com",
}