> For the complete documentation index, see [llms.txt](https://docs.hollaex.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hollaex.com/plugins/use-plugins/facevault-automatic-kyc.md).

# FaceVault - Automatic KYC

## FaceVault - Automatic KYC

The FaceVault Plugin is an identity verification solution integrated into HollaEx exchanges. Powered by [FaceVault](https://facevault.id), it provides a fully hosted verification flow — government ID capture, document OCR, selfie liveness, face matching, and anti-spoofing — without your team handling raw document images in the exchange UI.

The plugin adds an **Identity Verification** tab to the user dashboard. Users complete KYC on your branded FaceVault-hosted page (`facevault.id/v/<slug>`), and the tab shows their latest status (verified, under review, or failed) based on FaceVault’s trust score. The plugin is **webview-only** (no server-side install scripts), so it works on **HollaEx Cloud** and self-hosted kits.

For API details, trust scoring, and advanced options, see the [FaceVault documentation](https://facevault.id/docs).

FaceVault is fully open source, and can be viewed on it's [Github repo.](https://github.com/khreechari/facevault-hollaex)

***

### Who is this for?

This plugin is ideal for exchange operators who:

* Need to meet **KYC / AML** requirements for trading, deposits, or withdrawals.
* Want to **automate** identity checks instead of manually reviewing every passport and selfie in the built-in HollaEx KYC flow.
* Prefer a **hosted** verification experience with FaceVault branding (logo, accent, copy) on a dedicated page.
* Run on **HollaEx Cloud** or a **self-hosted** kit and want a third-party plugin without custom kit builds.

***

### How it works

1. A user opens **Identity Verification** in their account.
2. The plugin sends them to your FaceVault-hosted verification page for the configured **slug**.
3. FaceVault runs ID upload, optional proof of address (depending on site level), liveness, face match, and fraud checks.
4. FaceVault returns a **trust score** (0–100) and decision (`accept`, `review`, or `reject`).
5. The plugin updates the **KYC tab badge** in HollaEx to reflect the result.

Operators can still review borderline cases and manage users from the operator dashboard as with other external KYC plugins.

***

### Installation

You can install the plugin from the **Operator Control Panel** or by uploading the marketplace JSON file.

#### Option A — Pre-configured JSON from FaceVault (recommended)

1. Sign up at [devdash.facevault.id](https://devdash.facevault.id).
2. Open **Sites** and click **+ Add Site**.
3. Configure your hosted verification site (name, verification level, **slug**, branding, safety options). Hosted page is enabled by default.
4. On the site card, choose **HollaEx plugin…** → **Download**. The JSON includes your slug pre-filled.
5. In HollaEx, go to **Plugins** → **My plugins** → **Add Third Party Plugin**.
6. Paste or upload the JSON, then **Activate** the plugin.

No slug entry is required in HollaEx if you use the downloaded file.

#### Option B — Generic marketplace JSON

Use the App Store / marketplace file (for example `facevault-kyc.marketplace.json`):

1. In the Operator Control Panel, go to **Plugins** → **My plugins** → **Add Third Party Plugin**.
2. Paste the full JSON contents (or upload the file), then **Activate**.
3. Open **Plugins** → select **facevault-kyc** → **Configure**.
4. Set your **slug** (see configuration table below).

See also: [Installing plugins](https://docs.hollaex.com/plugins/installing-plugin).

***

### Configuration

#### 1. Create your FaceVault site and slug

If you have not already:

1. Sign in at [devdash.facevault.id](https://devdash.facevault.id).
2. Create a hosted-verification **Site** and choose a unique **slug** (for example `acme`). Slugs must be available and cannot impersonate major brands.
3. Optional: customize **Branding** (display name, accent, logo) and **Safety** (captcha, daily cap, fraud-disclaimer text) on the site.

Your public verification URL will be:

```
https://facevault.id/v/<slug>
```

#### 2. Configure the plugin in HollaEx

Open the plugin in the Operator Control Panel and set the following field:

| Field  | Required | Default | Description                                                                                                                                            |
| ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `slug` | yes      | —       | Your FaceVault hosted-page slug (for example `acme`). Create the site at [devdash.facevault.id](https://devdash.facevault.id) and paste the slug here. |

Plugin metadata (from marketplace JSON):

| Property    | Value                                  |
| ----------- | -------------------------------------- |
| Plugin name | `facevault-kyc`                        |
| Type        | `external_kyc`                         |
| Version     | `2.0.14` (marketplace version `20014`) |
| Author      | FaceVault                              |

Once the slug is saved and the plugin is enabled, users will see **Identity Verification** in the KYC area and can start verification from the exchange.

***

### Trust score and user levels

FaceVault assigns a **0–100 trust score** and a decision on every completion:

| Score   | Decision | KYC tab badge (typical) |
| ------- | -------- | ----------------------- |
| ≥ 70    | Accept   | Verified by FaceVault   |
| 40 – 69 | Review   | Under review            |
| < 40    | Reject   | Verification failed     |

The plugin updates the **in-tab status badge** automatically when users finish verification.

Promoting HollaEx **user verification levels** (for example, level 1 → 2) based on FaceVault results may require additional server-side wiring (for example, a webhook receiver that maps trust scores to kit user levels). See [FaceVault integrations](https://facevault.id/integrations/) for optional level-mapping guidance.

***

### Optional — FaceVault dashboard webhook

For server-side notifications (dashboard alerts, custom automation, or level mapping outside the webview), you can configure a webhook on your FaceVault **Site** under the **For developers** tab in [devdash.facevault.id](https://devdash.facevault.id):

1. Set your **Webhook URL** (HTTPS endpoint you control).
2. Copy the **signing secret** when shown (shown once).
3. Verify callbacks using the `X-FaceVault-Signature` HMAC-SHA256 header against the raw request body.

Webhook payloads include session ID, trust score, trust decision, and related verification fields. Details: [FaceVault API — Webhooks](https://facevault.id/docs).

{% hint style="info" %}
This marketplace plugin does not expose API keys or webhook secrets in HollaEx **public\_meta** — only the **slug** is required in the operator UI. API keys are used in the FaceVault developer dashboard for direct API / widget integrations, not for the standard hosted-page + HollaEx plugin flow.
{% endhint %}

***

### What gets verified

* **ID document** — capture, OCR (MRZ and national ID engines), and document fraud signals.
* **Liveness** — selfie flow with multi-signal anti-spoofing.
* **Face match** — dual-model face-match ensemble (ArcFace + AdaFace) comparison between ID portrait and selfie.
* **Proof of address** — optional, depending on your site’s verification level (Standard vs Strict).
* **Trust scoring** — combined accept/review/reject decision.

***

### Benefits

The FaceVault plugin saves exchange operators time by automating most identity checks. Manual review is only needed for borderline **review** outcomes. Verification typically completes in under a minute instead of hours or days of staff queue time.

Because verification runs on FaceVault’s hosted page, you avoid building a custom capture UI in the kit. The plugin is compatible with **HollaEx Cloud** restrictions (no third-party plugin server scripts).

For pricing, comparisons with other providers, and OPEX / API integrations, visit [facevault.id/integrations](https://facevault.id/integrations/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hollaex.com/plugins/use-plugins/facevault-automatic-kyc.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.