Device Register

Device Register helps enrolling a specific device for a particular user, ensuring that the device is recognized and linked to the user's account.

This flow supports both Mobile and Desktop applications.

Prerequisites

• Download the ezto verify mobile app before proceeding with the flow.

How to Setup

1 Navigate to Workspace > Workflows, and click on the flow created for Device Register. 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 Device Register 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.
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
Allow Multi Device Registration	This configuration permits multiple devices to be registered for biometric verification under the same user's account.
Max Device Count	Set the maximum number of devices the user can register, with a value ranging from 1 to 10.
Clear Data	Removes existing data upon initiating the process, ensuring a fresh start for the new flow.

5 After you've configured everything needed, click on SAVE.

6 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 Device Register includes the following parameters:

Name	Description
device_registered	This denotes whether the device registration is completed. The value will be "True" if the registration is successfully completed and "False" if it is not.
push_token	Token used for push notifications or communication with the device.
device_registered_at	This provides a timestamp, in Unix epoch format, indicating the exact time when the device registration was completed. This allows you to know precisely when the registration 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.

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 (Mobile) 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 scanning 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.

5 Once you scan the QR code, it will take a few seconds to register the new device.

6 The process will be completed and the device will be registered successfully.

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 Device Register:

{
   "workflow": "verification",
   "user_id": "mark@gmail.com",
   "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
   "device_registered_at": "1719569072",
   "device_registered": "true/false",
   "push_token": "cIeSFhRDQoxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}