Skip to main content

Face Register

The Face Register workflow uses advanced face recognition technology to securely register a user. This process involves capturing and analyzing the user's facial features to create a unique digital representation.

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 Face 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 Face Register to add it.

Face Register

3 Click on the newly added workflow, then select the General tab to customize your preferences.

General

Manage General

NameDescription
EnableThis 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.
RuleThis 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 SAVE.

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

NameDescription
face_registeredThis indicates whether face registration has been completed. The value will be "True" if the registration is successfully completed and "False" if it is not.
face_registered_atThis provides a timestamp, in Unix epoch format, indicating the exact time when the face 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.

QR

5 Click on the Start button.

ezto verify

6 Please scan your face to complete the registration process.

Face Scan

7 The face registration process will be successfully completed.

Completed

8 The response can differ depending on the chosen Verification Way and Notification Way configurations. To know more, see here.

9 Here is a sample response for Face Register:

{
"workflow": "verification",
"user_id": "mark@gmail.com",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"face_registered": "true/false",
"face_registered_at": "1719569072",
}