# @regulaforensics/facesdk-webclient

> JS client for facesdk web service

Latest version **8.3.767** (published 2026-08-04) · MIT license · 6.1K weekly downloads

## Install

```sh
npm install @regulaforensics/facesdk-webclient
pnpm add @regulaforensics/facesdk-webclient
yarn add @regulaforensics/facesdk-webclient
bun add @regulaforensics/facesdk-webclient
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

## Facts

| | |
|---|---|
| Version | 8.3.767 |
| Published | 2026-08-04 |
| First published | 2021-04-20 |
| Weekly downloads | 6.1K |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 214.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Regula Forensics, Inc. |
| Maintainers | regula, ikliashchou |
| Keywords | face recognition, facesdk, regulaforensics, regula |

## Links

- npm: https://www.npmjs.com/package/@regulaforensics/facesdk-webclient
- npm.io page: https://npm.io/package/@regulaforensics/facesdk-webclient

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.18.0
- [base64-arraybuffer](https://npm.io/package/base64-arraybuffer.md) ^1.0.2

## Recent versions

- 8.3.767 (latest) — 2026-08-04
- 8.4.855-rc (rc) — 2026-10-03
- 8.4.854-nightly (nightly) — 2026-10-03
- 6.2.0-beta.8 (next) — 2024-09-27
- 8.4.853-rc — 2026-10-02
- 8.4.852-nightly — 2026-10-02
- 8.4.851-rc — 2026-10-01
- 8.4.850-nightly — 2026-10-01
- 8.4.849-rc — 2026-09-30
- 8.4.848-nightly — 2026-09-30
- 8.4.847-rc — 2026-09-29
- 8.4.846-nightly — 2026-09-29
- 8.4.845-nightly — 2026-09-28
- 8.4.844-rc — 2026-09-26
- 8.4.843-nightly — 2026-09-26
- … 873 more at https://npm.io/package/@regulaforensics/facesdk-webclient/versions

## README

# Regula FaceSDK js client for the browser and node.js based on axios

[![npm version](https://img.shields.io/npm/v/@regulaforensics/facesdk-webclient?color=yellow&style=flat-square)](https://www.npmjs.com/package/@regulaforensics/facesdk-webclient)
![npm type definitions](https://img.shields.io/npm/types/typescript?style=flat-square&collor=858df6)
[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-0a8c42?style=flat-square)](https://github.com/regulaforensics/FaceSDK-web-openapi)


Face recognition as easy as reading two bytes.

 - Face Matching - Compare the person holding the ID to the person pictured in the ID document (1:1)
 - Face Recognition - Find the person by his or her photo in databases / lists (1:N)
 - Liveness Detection - Perform liveness check using a selfie taken with the user’s smartphone.

If you have any problems with or questions about this client, please contact us
through a [GitHub issue](https://github.com/regulaforensics/FaceSDK-web-js-client/issues).
You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/FaceSDK-web-js-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small; We are always thrilled to receive pull requests, and do our best to process them as fast as we can. See [dev guide](./dev.md).

## Install package

```
npm install @regulaforensics/facesdk-webclient
```
## Example of Face Matching

Performing request:

```js
const face1 = fs.readFileSync('face1.jpg').buffer;
const face2 = fs.readFileSync('face2.jpg').buffer;

const sdk = new FaceSdk({ basePath: 'http://localhost:41101' });

const response = await sdk.matchApi.match({
    images: [
        { type: ImageSource.LIVE, data: face1, index: 1 },
        { type: ImageSource.DOCUMENT_RFID, data: face2, index: 2 }
    ]
  });
```

Parsing results:
```js
for (const result of response.results) {
    console.log(`pair(${result.firstIndex},${result.secondIndex})   similarity: ${result.similarity}`)
}
```

You can find more detailed guide and run this sample in [example](https://github.com/regulaforensics/FaceSDK-web-js-client/tree/master/examples/basic) folder.

## Compatibility

Language level
* ES5, ES6.Promises - depends on a native ES6 Promise implementation to be supported. If your environment doesn't support ES6 Promises, you can polyfill.

Module system
* CommonJS
* ES6 module system

Definitions
* TypeScript's definitions should be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package))

---
_Source: https://npm.io/package/@regulaforensics/facesdk-webclient · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._