Welcome to BioClient.Web

The Web edition of the Biometric Client Framework (BioClient.Web) biometrically enables web applications.

It implements a rich set of functionality, allowing your web applications to rapidly and easily perform biomeric enrolments, verifications, and identifications with a large number of biometric readers, biometric engines, and biometric stores.

1. What is BioClient.Web

The Web edition of the Biometric Client Framework (BioClient.Web) consists of a set of javascript files which invoke the BioClient websockets service, which in turns handles all interaction with biometric sensors, engines, and stores.

• A biometric sensor is a capture device, which captures a biometric sample, such as a fingerprint reader or camera to capture a facial image.
• A biometric engine is a software library, which extracts biometric features from biometric samples, and which compares features with each other, to establish the identity of a person.
• A biometric store is a software product, which stores identities and their biometric samples and features

2. Using BioClient.Web

With BioClient.Web, you can easily add biometric functionality to your web applications. All biometric operations are supported. BioClient.Web can be used server-side or client-side. Client-side can be used with any web technology, such as ASP.NET, PHP, Java, Angular, React, Vuew, or Ruby, as it only relies on three simple Javascript files. Server-side is only suitable for ASP.NET and ASP.Net Core, as BioClient.Web itself is implemented in .Net Standard.

Client-Side BioClient.Web

When using the client-side architecture, all biometric operations are performed on the client machine, using the BioClient.Web windows service. The client machine must have the required biometric sensors and engines installed, and must have access to the required biometric stores. This architecture typically requires the least changes to your web application, as all biometric operations are performed on the client machine, and server-side code only needs to handle the final results of the biometric operations.

This manual describes the use of the client-side API.

Server-Side BioClient.Web

When using the server-side architecture, all biometric operations are performed on the server, using the BioClient API. It is often not possible or not sensible to use server-side for capture operations, as the required biometric sensors (fingerprint readers or cameras) are typically not available on the server. The server must have the required biometric engines installed, and must have access to the required biometric stores. This architecture typically requires more changes to the server-side of your web application, as biometric operations are performed on the server, calling the BioClient API.

See documentation of Bioclient.Core for more information on the server-side API.

3. Transacting with BioClient.Web

• Identity enrolment provides for enrolment of identities or persons.
• Identity retrieval provides for retrieval of identities or persons.
• Identity verification provides for verification of identities or persons.
• Identity identification provides for identification of identities or persons.
• Manage sensors, engines, and stores provides for management of sensors, engines, and stores.

Quick Start Notes:

• Refer to Getting started with BioClient.Web for how to getting started quickly with BioClient.Web.
• Refer to Install BioClient.Web how to install BioClient.Web and get it ready for use.