Skip to content

BioID Web Service#


BioID Web Service is a "Biometrics as a service" provider. This document will explain how to use Gluu's BioID interception script to configure the Gluu Server for a two-step authentication process with username and password as the first step, and BioID's biometric authentication as the second step.

In order to use this authentication mechanism your organization will need to register for a BioID account.



The mandatory properties in the BioID authentication script are as follows

Property Description Example
ENDPOINT URL of the BioID Web Service
APP_IDENTIFIER API key c20b04cc-776a-45ed-7a1f-06347f8edf6c
APP_SECRET API secret sTGB4n4HAkvc2BnJp6KeNUTk
STORAGE The storage name assigned by BioID depending on the type of contract you have. bws
PARTITION A number assigned to your company by BioID. 12345

Configure BioID Account#

  1. Sign up for a BioID account.

  2. Upon registration, you will recieve an email with the instance name (listed as STORAGE in Gluu's BioID authentication script), partition number(listed as PARTITION in Gluu's BioID authentication script).

  3. As the owner of this instance, you are entitled to access BWS Portal at using the account associated with your email. With the BWS Portal, you can do the following:
    a. View your trial information such as your credentials (e.g. your client certificate), enrolled classes, BWS logs and more.
    b. Create your App ID and App secret, under "Web API keys".

BioID Documentation#

You can find all API reference at Lots of useful information about BWS is available at For liveness detection, you will find information about motion trigger helpful:

Configure oxTrust#

Follow the steps below to configure the BioID module in the oxTrust Admin GUI.

  1. Navigate to Configuration > Person Authentication Scripts.
  2. Scroll down to the BioID authentication script

  3. Configure the properties, all of which are mandatory, according to your API

  4. Enable the script by ticking the check box

Now BioID's biometric authentication is available as an authentication mechanism for your Gluu Server. This means that, using OpenID Connect acr_values, applications can now request BioID biometric authentication for users.


To make sure BioID has been enabled successfully, you can check your Gluu Server's OpenID Connect configuration by navigating to the following URL: https://<hostname>/.well-known/openid-configuration. Find "acr_values_supported": and you should see "bioid".

Make BioID the Default Authentication Mechanism#

Now applications can request BioID's biometric authentication. To make BioID biometic authentication your default authentication mechanism, follow these instructions:

  1. Navigate to Configuration > Manage Authentication.
  2. Select the Default Authentication Method tab.
  3. In the Default Authentication Method window you will see two options: Default acr and oxTrust acr.

    • The oxTrust acr field controls the authentication mechanism that is presented to access the oxTrust dashboard GUI (the application you are in).
    • The Default acr field controls the default authentication mechanism that is presented to users from all applications that leverage your Gluu Server for authentication.

You can change one or both fields to BioID authentication as you see fit. If you want BioID to be the default authentication mechanism for access to oxTrust and all other applications that leverage your Gluu Server, change both fields to bioid.


Testing the script#

If you use the default BioID interception script, a user's facial and periocular traits are enrolled during the first authentication attempt. Subsequently, the user's facial and periocular traits are verified.

  1. Enrolling Biometric traits

  2. Validating a user based on their biometric traits: