# Face Capture

The Face Capture module captures a user’s face with their device’s camera and runs configurable liveness, face recognition, and image quality checks. It can enroll new users so their face can be matched against an ID photo or used for later authentication. It can also log in returning users using [1:1](https://developer.incode.com/docs/glossary#11-face-authentication) or [1:N](https://developer.incode.com/docs/glossary#1n-face-authentication) face authentication.

For an overview of this module and how it works, see [Face Capture](https://developer.incode.com/docs/face-capture).

## Supported with:

:white_check_mark: Workflows | :white_check_mark: Flows

## Add Face Capture to Workflows

1. In the left menu, click **Flow Builder** > **Workflows**.
2. Click **New**.
3. From the Modules list, drag and drop the **Face Capture** module into the builder.
4. You can click the three dots > **Edit** on the module node to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Add Face Capture to Flows

1. In the left menu, click **Flow Builder** > **Flows**.
2. Click **New**.
3. On the **Select Modules** tab, find the **Face Capture** module and click **Add**.
4. You can click **Details & Configurations** to open the [Configuration Options](#configuration-options) panel and adjust settings as needed.

## Configuration Options

This section details all the configuration options available for this module. After changing anything, click **Save configurations** before closing the configuration panel.

The options you see in your configuration may differ from those documented below. Contact your Incode representative for more information.

Several liveness and validation checks use a threshold scale (Ultra Low, Low, Medium, High, Ultra High) that controls how strictly the check is applied. A lower threshold matches faces with a higher degree of anomalies (more permissive); a higher threshold matches faces with a lower degree of anomalies (more strict).

![](https://files.readme.io/78920abef1916ca2fa7dec22c5f91333c0effddb1b25454c6fdb7bc2d09721b1-image.png)

| Setting                                | Description                                                                                                                                                                                                               |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **_Face capture tutorial_**            | When enabled, displays an instructional screen before the capture step to guide the user through the process.                                                                                                             |
| **_Show preview_**                     | When enabled, shows the user a preview of the captured face or selfie.                                                                                                                                                    |
| **_Assisted Onboarding_**              | When enabled, allows face capture using the rear camera.                                                                                                                                                                  |
| **_Enable face recording_**            | When enabled, records the face capture session for review purposes.                                                                                                                                                       |
| **_Autocapture timeout (Seconds)_**    | The number of seconds the camera will attempt automatic capture before timing out. Default: _25_. If autocapture does not succeed within this window, the user is prompted to retry or switch to manual capture.          |
| **_Number of image capture attempts_** | The maximum number of times a user can attempt to capture their face before the session ends. Default: _3_.                                                                                                               |
| **_Reliable age estimation check_**    | When enabled, estimates the user's age from the captured selfie and checks it against a minimum age threshold (set in the adjacent "years old" field; default _18_).                                                      |
| **_Physical attack&#x20;_**(Liveness)  | When enabled, checks the selfie for signs of a physical presentation attack (e.g., printed photo, mask). Threshold sets the strictness of the check.                                                                      |
| **_Digital attack&#x20;_**(Liveness)   | When enabled, checks the selfie for signs of a digital presentation attack (e.g., a face displayed on a screen). Threshold sets the strictness of the check.                                                              |
| **_Evasion attack&#x20;_**(Liveness)   | When enabled, checks the selfie for signs that the user is attempting to evade detection (e.g., obscuring or distorting their face). Threshold sets the strictness of the check.                                          |
| **_Image quality_**                    | When enabled, validates that the captured image meets a minimum quality standard. Severity is configured in the **Image Quality Severity** dropdown, with options _Ultra Low_, _Low_, _Medium_, _High_, and _Ultra High_. |
| **_Occlusion check_**                  | When enabled, checks whether the user's face is partially obscured in the captured image. Threshold sets the strictness of the check.                                                                                     |
| **_Lenses validation_**                | When enabled, checks whether the user is wearing glasses or contact lenses that may interfere with capture.                                                                                                               |
| **_Mask validation_**                  | When enabled, checks whether the user is wearing a face mask.                                                                                                                                                             |
| **_Hat validation_**                   | When enabled, checks whether the user is wearing a hat or other headwear that may obscure the face.                                                                                                                       |
| **_Closed eyes validation_**           | When enabled, checks whether the user's eyes are closed in the captured image.                                                                                                                                            |
| **_Brightness validation_**            | When enabled, checks whether the image brightness is within an acceptable range.                                                                                                                                          |
| **_Allow manual review_**              | When enabled, sessions that fail face capture after all attempts are routed for manual review instead of being rejected outright.                                                                                         |
| **_On-Device Processing_**             | When enabled, performs face capture processing on the user's device rather than server-side.                                                                                                                              |

<br />
