> For the complete documentation index, see [llms.txt](https://docs.webtonative.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.webtonative.com/website-plugins/wordpress/biometric-authentication.md).

# WordPress Biometric Authentication Guide

This plugin enables biometric authentication for users in your WordPress application. Follow the steps below to configure and use the plugin effectively.

## Step 1: Configure Biometric Authentication Settings

1. Navigate to the **WordPress Admin Dashboard.**
2. Go to **Settings > Biometric Authentication.**

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfrlhRQv4gzsuurtCpSDK1umt6IKDvhYaQvzCA1EBHKbcP_cw53dhzWFteOx49xU27jU-XFq9LGWxMuKg_Bm_JQyRH54ehOTKtRYwj1y4fIcwsnM4pWI4TQQo6UClH2Sw4Gnv0bbg?key=8fypB0WwX012kuShdOKyH1VA" alt="" width="188"><figcaption></figcaption></figure>

3. Configure the following options:

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdPxZtcin-DZE7h6XnaJ1pKVq0mAMc5OUxztN89Mr4rEdEW3cVthRk9iLmKTXjxdf5di04pMNfTWG-kZYp7sQwrY_hsfvTBVc1VFbhbDJVYKxcJzTIkDLLDoIe08fFB12uIzyb29Q?key=8fypB0WwX012kuShdOKyH1VA" alt=""><figcaption></figcaption></figure>

* **Enable Biometrics**: Check this box to activate biometric authentication for users.
* **Prompt on Resume**: Enable a biometric prompt when the app is resumed.
* Prompt on Open: Enable a biometric prompt when the app is opened.
* Biometric Timeout (Minutes): Set the time delay (in minutes) after which biometric authentication will be required again.

4. Click Save Changes to apply the settings.

## Step 2: Allow Users to Enable Biometric Authentication

1. Add the shortcode <mark style="color:green;">**\[wtn\_biometric\_settings]**</mark> to a page (profile page) or post where users can manage their biometric preferences.
2. Logged-in users will see an option to enable or disable biometric authentication.
3. **When enabled:**

* Users will be prompted to authenticate via biometrics (e.g., fingerprint or face recognition).
* A secure token will be stored for subsequent authentication.

## Step 3: Enable Biometric Login (optional)

1. Add the shortcode <mark style="color:green;">**\[wtn\_biometric\_login]**</mark> to display a **Login with Biometric** button.
2. Unauthenticated users with biometric authentication enabled can log in using their biometrics.
3. The user will be redirected to their dashboard or the specified page if authentication is successful.

*<mark style="color:orange;">**Note**</mark>*: The user will only be able to perform biometric login when their session or token has expired. Biometric login will not be available in the case of a forced logout.

## Step 4: Automatic Biometric Prompts

* The plugin will automatically prompt for biometric authentication based on the admin settings:
  * **On App Resume**: If the app is inactive for the configured timeout.
  * **On App Open**: Every time the app is launched.
  * **On Logout**: If the user logs out, they must reauthenticate to access the app.

## FAQs

#### How do I reset biometric authentication for a user?

* As an admin, you can manually delete the user's biometric token from their profile or reset the settings from the admin panel.

#### What happens if biometric authentication fails?

* Users will not be logged in or authorized to proceed unless they successfully authenticate.

#### Can users disable biometric authentication?

* **Yes**, users can toggle biometric authentication off from the settings page added via the <mark style="color:green;">**\[wtn\_biometric\_settings]**</mark> shortcode.
