Get Started
Last updated
Last updated
The Sybrin Biometrics Web SDK can be used to run liveness detection. Implementing the web SDK is as easy dropping and referencing the relevant files into your project, then simply using the JavaScript API or the web components supplied by the SDK. In this section we will focus on how to get the Sybrin Biometrics Web SDK into your project.
Please ensure that you have acquired an API key and endpoints from Sybrin.
Please ensure that you have the following essential files:
sybrin.biometrics.js
Depending on whether you want to use express (faster, smaller, less accurate), complex (slower, larger, more accurate) or both facial recognition models, please ensure that you have the following essential files:
The following are optional files:
index.css
index.html
index.js
If you are using Typescript, you may make use of the typings found under the src
folder.
The Sybrin Biometrics Web SDK is configurable and does not require a specific project structure. You may drop the required files into the root of the project as provided or you can change the folder structure and file locations. This includes the face detection model. Please see configuration options for details on how to configure the path to the face detection model.
To load the web SDK and its modules, simply add a script tag with a reference to the sybrin.biometrics.js JavaScript file to the HTML file of your project:
The above example assumes sybrin.biometrics.js is located at the root of your project. This can be added to the <head>
tag or the <body>
tag according to preference.
You are now ready and all set up to use the Sybrin Biometrics Web SDK! Check out all the Biometrics Features
Express
Complex
assets/express-model-weights_manifest.json
assets/complex-model-weights_manifest.json
assets/express-model-shard1.xml
assets/complex-model-shard1.xml
-
assets/complex-model-shard2.xml