Skip to main content

Selfie Registration

The Selfie Registration allows users to securely store their facial template for future use during liveness checks, ensuring a smooth and secure verification process.

How to setup,

1 Go to Workspace > Workflows, and click on the flow created for Selfie Registration. 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 Selfie Registration to add it.

Selfie Registration

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 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 Selfie Registration includes the following parameters:

NameDescription
selfie_registeredThis indicates whether selfie registration has been completed. The value will be "True" if the registration is successfully completed and "False" if it is not.
photo_urlURL to the photo used or captured during the selfie registration process.
selfie_registered_atThis provides a timestamp, in Unix epoch format, indicating the exact time when the selfie 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.

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 Before proceeding, familiarize yourself with the Do's and Don'ts. Once you're aware, click on Start to begin.

Start

5 Once you have taken the pictures, preview your picture and then click on Submit.

Capture

6 The verification process will be completed only if the provided 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.

Completed

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 Selfie Registration:

{
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"workflow": "verification",
"user_id": "mark@gmail.com",
"selfie_registered_at": "1719569072",
"photo_url": "https://minio-api.eztovrfy.com/xx-xx-xx",
"selfie_registered": "true/false"
}