Number Prompt
This method enhances convenience by enabling verifications through a simple number prompt system, making the process faster and more user-friendly.
This flow supports only Mobile applications.
Prerequisites
- Download the ezto verify mobile app before proceeding with the flow.
- Ensure an additional verification workflow accompanies the Number Prompt workflow. In this case Web to Device flow serves as the initial part of verification, and the second workflow triggers another part of the verification that is configured.
- Have two different applications in the Workspace, each designated for a specific workflow.
- The second workflow must include the Number Prompt along with any other verification workflows if required. Ensure that the Web to Device has "Number Prompt" enabled in the workflow's configs.
How to Setup
1 Navigate to Workspace > Workflows, and click on the flow created for Number Prompt. 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 Number Prompt to add it.
This workflow only works with Web to Device. So, make sure to add an application consisting of Web to Device in order for the Number Prompt to execute.
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. |
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 After you've configured everything needed, click on the SAVE
button.
5 Proceed to attach the workflow to the relevant application for execution. Refer to the 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 Number Prompt includes the following parameters:
Name | Description |
---|---|
web_to_device | Status indicating the outcome of communication between the web platform and the device. |
allow_new_device | Indicates whether a user is permitted to access the service or application from a new or unrecognized device. If set to true, the user can use a new device; if false, the user may be restricted to previously authorized devices. |
prompt_success | Indicates whether the number prompt process was successfully completed. |
prompt_completed_at | Timestamp marking when the number prompt process was completed. |
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.
Make sure to configure the
"allow_new_device": true
in the body of the respective API.
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.
This is the initial verification process configured; as an example, Verify Aadhaar is used here.
4 Begin by providing the Aadhaar Number and click Submit.
5 To initiate Number Prompt flow, you will be prompted to scan the QR code with the ezto verify mobile app.
This depends on what you have configured for the mobile notification way, i.e, QR code or Push integration. To know the difference between QR code or Push, refer here.
6 Once you've scanned the code, a number will appear on the web interface. Simultaneously, a set of numbers will be displayed in the ezto verify mobile app.
7 Select the number in the mobile app that matches the one shown on the web interface to proceed.
8 The verification process will be completed successfully.
9 Here is a sample response for Number Prompt:
{
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"workflow": "verification",
"user_id": "mark@gmail.com",
"aadhaar_number": "334108903696",
"aadhaar_verified": "true",
"aadhaar_verified_at": "1733729102",
"web_to_device": "true/false",
"allow_new_device": "true/false",
"prompt_success": "true/false",
"prompt_completed_at": "1733729174"
}