> For the complete documentation index, see [llms.txt](https://docs.voveid.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.voveid.com/docs/api/flows.md).

# Flows

### Introduction

Welcome to the Vove ID Custom Flows documentation. Our new **Custom Flows** feature empowers you to design personalized identity verification processes tailored to your specific needs. With this feature, you can set specific conditions, choose supported documents, and create a seamless verification journey for your users.

### Key Benefits

* **Flexibility**: Design verification processes that align with your business requirements.
* **Customization**: Set specific conditions and select required documents, and verify each user differently
* **Efficiency**: Streamline the user verification experience.
* **Scalability**: Easily update flows as your needs evolve.

***

### Getting Started with Custom Flows

To begin creating your custom flows:

1. **Log In to Your Dashboard**
   * Access your Vove ID client dashboard with your credentials.
2. **Navigate to the Flows Section**
   * From the main menu, select **"Flows"**.
3. **Create a New Flow**

   * Click on the **"Create New Flow"** button.

   <figure><img src="https://4173094968-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F83UoxmShmjD5iX8BJPn0%2Fuploads%2F7XhPiUCjEYkoEng7cL40%2FScreenshot%202024-10-12%20at%2022.51.23.png?alt=media&amp;token=24830400-015e-4b12-afd9-483bb8029258" alt=""><figcaption><p>Settings => Flows Pages</p></figcaption></figure>

***

### Creating a Custom Flow

**Step 1: Define Flow Details**

* **Flow Name**
  * Enter a unique name for your flow (e.g., *"Premium User Verification"*).

**Step 2: Set Steps**

* **Liveness**
  * You can turn it ON to verify users liveness and make sure there is a real person trying to get verified
* **Steps**
  * Select as many steps needed to verify user, for each step you can select the supported documents

**Face Match Levels**

Vove ID allows you to configure the **Face Match Level** used when comparing the user's live face with the photo on their identity document.

The match level ranges from **1 to 7**. Higher levels require a stronger facial similarity and provide a lower **False Acceptance Rate (FAR)**.

| Match Level | False Acceptance Rate (FAR) | Meaning                                                                                                     |
| ----------- | --------------------------: | ----------------------------------------------------------------------------------------------------------- |
| **Level 7** |                1 in 500,000 | Highest match confidence. Recommended for high-security or high-risk use cases.                             |
| **Level 6** |                1 in 100,000 | Very high match confidence. Suitable for regulated and higher-risk onboarding.                              |
| **Level 5** |                 1 in 10,000 | High match confidence. Provides a strong balance between security and user acceptance.                      |
| **Level 4** |                  1 in 1,000 | Moderate match confidence. Suitable for lower-risk verification scenarios.                                  |
| **Level 3** |                    1 in 500 | More permissive matching with a higher probability of false acceptance.                                     |
| **Level 2** |                    1 in 250 | Permissive matching. Recommended only when a higher acceptance rate is preferred over strict face matching. |
| **Level 1** |                    1 in 100 | Most permissive matching level.                                                                             |
| **Level 0** |                           — | The faces are considered a **non-match**.                                                                   |

**Understanding FAR**

**False Acceptance Rate (FAR)** represents the probability that two different people could incorrectly be considered a match.

For example:

* **Level 7 — 1/500,000 FAR** means approximately 1 false acceptance could occur for every 500,000 impostor comparison attempts.
* **Level 5 — 1/10,000 FAR** means approximately 1 false acceptance could occur for every 10,000 impostor comparison attempts.
* **Level 1 — 1/100 FAR** means approximately 1 false acceptance could occur for every 100 impostor comparison attempts.

As the Match Level increases, the matching threshold becomes stricter.

> **Note:** False Reject Rates (FRR) may vary depending on factors such as anti-tampering characteristics of the identity document, document/image quality, and the age of the photograph displayed on the identity document.

**Step 3: Select Supported Documents**

* **Document Types**
  * Choose the types of documents users must provide (e.g., passport, national ID, utility bill).
* **Verification Requirements**
  * Specify any additional verification steps or document requirements.

**Step 4: Configure Flow Steps**

* **Step Order**
  * Arrange the steps in the order you want users to complete them.
* **Instructions**
  * Add custom instructions or messages for users at each step.

**Step 5: Review and Activate**

* **Preview Flow**
  * Review all settings to ensure accuracy.
* **Activate Flow**
  * Save and activate the flow for it to become live.
  * you can use as many flows you want by using their specific ID, and the default flow will be used as default when you don't specify the ID.
* Update Flow
  * you can't update a flow, because the flow can be already assigned to some verifications, but when you update a flow a new version will be created with a different ID and you can either make it default or use the ID for new verifications.

***

#### Managing Your Flows

* **Edit Existing Flows**
  * Make changes to your flows by selecting the flow and clicking **"Edit"**. You can't update a flow, because the flow can be already assigned to some verifications, but when you update a flow a new version will be created with a different ID and you can either make it default or use the ID for new verifications.
* **Deactivate Flows**
  * Temporarily disable a flow without deleting it.
* **Delete Flows**
  * We don't allow deleting flows for the same reason of editing flows, but you can deactive it by disabling it.
* **Duplicate Flows**
  * Create a copy of an existing flow by modifying an existing flow, without altering the original.

***

#### Future Enhancements (Coming soon)

We are committed to continually improving the Custom Flows feature. Upcoming enhancements include:

* **Advanced Conditional Logic**
  * More complex condition settings for granular control.
* **Multi-Language Support**
  * Customize flows for different languages to cater to a global user base.
* **Analytics Integration**
  * Gain insights into flow performance and user behavior.

***

#### Support and Feedback

If you have questions or need assistance:

* **Contact Support or your account manager**
  * Email us at <contact@voveid.com>.
* **Provide Feedback**
  * Your feedback helps us improve. Let us know your thoughts and suggestions.

***

Thank you for choosing Vove ID for your digital identity solutions. We are excited to see how you leverage Custom Flows to enhance your user verification process.
