Getting Started

Simprints ID is our standalone app that lets you capture biometrics for purposes of enrolment, identification and verification. You communicate with the Simprints ID using Android intents. To see an overview of what happens check here.

Using our open-source helper library, LibSimprints, you can easily integrate Simprints ID with your custom android application. To start with the integration, you will first add the library as a dependency to your android project.

Installation

NOTE:  Ensure you are installing the latest version of LibSimprints, you can check our releases page for the latest version. 

For Gradle:

implementation "com.simprints:libsimprints:2023.2.1"

For Maven:

<dependency>

<groupId>com.simprints</groupId>

<artifactId>libsimprints</artifactId>

<version>2023.2.1</version>

<type>pom</type>

</dependency> 

Basic Features

Simprints ID supports 3 basic features: Enrolment, Identification, and Verification.

1. Enrolment - this is a process that involves registering a new beneficiary, using their biometric data.

2. Identification - this is a process that involves identifying a beneficiary from a list of matching candidates.

3. Verification -  this involves verifying that a beneficiary is who they say they are.

Note:  any call to Simprints ID should be triggered after capturing the user's personal information, i.e. on form submission, so the last action is the biometric capture.

Basic Parameters

Since Simprints ID is a standalone application, when integrating with Simprints ID your Android application communicates with Simprints ID through Android Intents.

This process requires some basic parameters to be sent in the corresponding intent. Here is a list of request parameters you would encounter when integrating with Simprints ID, what they stand for, and what they are used for:

• Project ID  -  this is a unique id that is generated for your project during integration with Simprints ID and is used for integration purposes as well as authentication. As you can have multiple projects, to target different solutions, each project has its own unique id which is the project ID.

• Module ID   -  this can be used to stratify a dataset. During an identification, large datasets (e.g. project-wide) can take longer to search for a match and reduce accuracy. Having modules will help run the identification in smaller datasets. Common modules include sub-district, school or health facility. We recommend each module does not exceed 15,000 registrations

This module id is a unique id that represents any specific module (geographical location), where the frontline worker is capturing biometrics for enrolment, identification, or verification.

• User ID  -  This is a unique id that represents the logged-in user who attends to the beneficiaries during the biometric capture. This is specific to your app.

• Session ID  -  This is a unique id that is generated for every Simprints ID initiated flow, i.e. enrolment, identification, or verification. It is used to track each flow from start to finish.