Quick Start Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
By the end of this guide, you should have:
An understanding of Simprints core components
Provisioned a biometric modality
Captured some biometric data (either your Fingerprint or Face)
📱
🧬
📂
👉
✅
🔮
Required
Web browser (hopefully, you are reading on one!)
Optional
Vero scanner (needed for fingerprint)
Two apps are required to use Simprints:
1. Simprints ID
Simprints ID (SID) hosts the frontend biometric user flows (enrollment, identification, verification).
2. Intents Launcher
SID is not a standalone application; it requires a calling app to open each flow.
In a real project, the calling app would be a fully-fledged health record collection app (such as DHIS2 or CommCare)
For this guide, we will use Simprints Intents Launcher (launching February 2024), a calling app developed by Simprints to test SID.
Install the APK on your phone
Simprints can be configured to support either Face and/or Fingerprint modalities. For simplicity, choose one of these for a first-time setup.
Face
Simprints has not developed its own Face algorithm (yet..). We use a commercial algorithm created by RankOne Computing, so each device using it must be provisioned with a license.
Open Simprints ID
Copy your device ID
Fingerprint
If you own a Vero scanner and want to use Fingerprint as your modality, you are in luck as Simprints has developed its Fingerprint algorithm, and although the algorithm isn't yet open source, you don’t need to do anything to provision it.
Projects can currently be created in the closed-source Simprints back end. Projects contain:
Configuration data
Biometric licenses
Biometric templates (face/fingerprint)
Projects are created and configured in Vulcan (Not currently open source).
You’re at the home stretch! Let’s perform an Enrollment to capture your biometric data to be checked against later.
Open Intents Launcher
Fill in projectId
with the Project ID given to you by Simprints
You can use any User Id
and Module Id
(for instance "User1" and "Module1")
Leave all other fields as they are
Tap Enroll (this will open SID)
Login to SID by scanning the QR code generated in Vulcan
Follow the steps in SID to enroll
View the response in Intents Launcher.
Hopefully, you don’t experience any errors here. However, if you see something like “Invalid User ID” or “Invalid Project ID”, go back a step and check your Project configuration.
Last part! Let’s perform an Identification to check if we can find the biometric record you created in the last step.
Open Intents Launcher
Fill in Project Id
with the Project ID generated in Vulcan
You can use any User Id
and Module Id
(for instance "User1" and "Module1")
Tap Identify (this will open SID)
Follow the steps in SID
View the response; it should look something like this:
If you made it this far, congrats! You should understand how Simprints works and an end-to-end solution working on your phone to play around with.
Here are a few suggestions of what you could try and do next:
Perform a verification
Create your custom intent in Intents Launcher
Android phone (most modern Android phones are supported; for full requirements)
Download and install SID from the
.
Unfortunately, we cannot release these to our open-source users. If you want to discuss this, we will help you. Get in touch with us via one of the methods listed . We will need your device ID, too.