For the complete documentation index, see llms.txt. This page is also available as Markdown.

Face

Face capture Widget v.5.33.0

Introduction

Face authentication is a process that allows verifying users' identity through facial biometric technology.

To carry out user authentication, a prior one-time biometric registration step is required to verify identity. Once registered, the authentication process involves capturing the face which, compared with the one previously registered, will allow the user to access the product and/or service.

Requirements and installation

To be able to use Facephi Authentication, you must have a compatible browser on your device, whether on a desktop computer or a mobile device. The compatible operating systems and browsers are:

  • Windows, macOS, Android, iOS.

  • Mozilla Firefox, Google Chrome, Opera, Safari.

Face capture

When you begin, a message appears asking for the necessary permissions to carry out the process.

To continue, press button (1). To cancel the permission and not continue, press button (2).

  1. Button to allow access

  2. Button to cancel access

Once the process starts, a text (2) appears giving you instructions on how to position yourself, or what you need to keep in mind.

This message updates in real time, and will give you details about:

  • Distance: close, far.

  • Framing: outside the circle, rotated.

  • Movement

  • Lighting

If the proper conditions are met, the capture will happen automatically and you will be taken to the next step.

If you want to close the process, press the icon (1).

  1. Button to close the process

  2. Help message

When your position and the conditions are correct, the circle (2) changes shape and color. If you are not correctly positioned, it will return to the previous state with help messages.

If you want to close the process, press the icon (1).

  1. Button to close the process

  2. Information circle for the process status

  3. Help message

Once the face has been captured, a preview screen will appear (if it has been enabled in Settings). Here you must check that the face is fully visible and well lit.

If the photo is blurry, cropped, or poorly lit, we recommend retrying this step (3) to retake the photo and avoid future errors. A poor capture at this step may cause future facial identification errors.

If the photo is sharp, press the button (4) to continue to the next step.

  1. Button to close the process

  2. Information button

  3. Retry button

  4. Continue button

The preview is used to confirm that it has been captured correctly

This is the face capture tutorial. Here you will find some tips on how to position your face, or what things to keep in mind so the capture is completed successfully. There are 3 tips in total.

To view them, press the button (3) or (4). To go back to document capture, press the button (2).

To exit the Widget without capturing, press the icon (1).

  1. Button to close the process

  2. Back button

  3. Previous button

  4. Next button

Errors

Time exceeded

The maximum time for the Widget to capture has been exceeded.

The most likely case is that the necessary conditions were not met for the Widget to take an adequate photo.

Retry this step by following the instructions on screen and pressing the button (3), or, if available, pressing the information icon (2) to receive tips.

  1. Button to close the process

  2. Information button

  3. Retry button

Camera permissions

Camera permission has previously been denied, but the widget is trying to access it.

After a few seconds the message will disappear and you will return to the previous screen.

  1. Button to close the process

Face not detected

If, during face capture, the camera does not detect any face, this error message will appear. Press the button (1) to close this screen, or the button (2) to retry.

  1. Button to close

Technical issues

This message appears when there is an internal technical issue. In principle, it is a temporary error. Here we should wait a moment for the error to be resolved.

  1. Close button

Last updated