Simprints Documentation
  • Introduction
    • Goals
    • Audience
    • Disclaimer
  • Product Overview
    • Product Overview
      • Simprints ID (SID)
        • Enrolment
        • Verification
        • Indentification
      • Biometrics
        • Fingerprints Recognition
          • Vero Fingerprint Scanners
        • Face Recognition
      • SID Intents Launcher
      • Cloud Backend
      • Data Collection Platforms
        • DHIS2
        • CommCare
        • ODK + Survey CTO
  • Architecture
    • System architecture
      • Mobile
        • Simprints ID (SID)
          • Project structure
          • Biometric flow orchestration
  • Installation
    • Installation, Quick Start and Device Requirements
      • Installation
      • Quick Start Guide
      • Device Requirements
  • Security & Privacy
    • Security & Privacy Considerations
      • Security Policy
      • Responsible Use
      • Privacy Policy
      • Cookie Policy
  • Development
    • Getting setup
    • Simprints for Developers
      • Simprints for Developers
      • Integrating with Simprints
        • Getting Started
        • Enrollment
        • Identification
        • Verification
        • Exit Forms
        • Confidence Score Bands
        • Enrolment & Identification +
        • Handling Errors
        • Metadata
      • Other Intergrations
        • ODK Integrations + SurveyCTO
          • Enrol
          • Identify
          • Verify
          • FAQ
        • CommCare Integration
          • CommCare: Enrolment
          • Identification
          • FAQs
          • ↔️CoSync
        • DHIS2
  • Troubleshooting
    • FAQs
    • Common Issues
  • Community & Support
    • Support Channels
    • Community Guidelines
    • Open Source Contributions
  • Product Roadmap
    • Product Roadmap
      • Current Releases
      • Previous Releases
      • Submit an Idea or Request
  • Licence
  • Contribution Guidelines
    • Contribution Guidelines
      • Code Contributions
      • Bug Reports
      • Feature Requests
  • Supporting Partners
Powered by GitBook
LogoLogo
On this page

Was this helpful?

Edit on GitHub
  1. Development
  2. Simprints for Developers

Integrating with Simprints

PreviousSimprints for DevelopersNextGetting Started

Last updated 1 year ago

Was this helpful?

This section contains links to information about how to integrate with Simprints ID, using a custom Android application. Key features and terminology that Simprints ID uses will also be introduced in this section.

What is Simprints ID?

Simprints ID is a standalone Android app that is responsible for enrolling and verifying a person's identity, using unique features like the person's fingerprint and face.

The custom app is responsible for capturing any biographical information along with additional data being collected, and Simprints ID is responsible for capturing the person's biometric identity. After a new biometric record is created in Simprints ID, a unique ID is generated and returned to the custom app. This unique ID is to be stored along with the person's biographical data and any other data collected, within the custom app and servers.

This unique ID, that is stored on the custom app, is what is used to match a newly captured biometric template with a previously enrolled one. When there is the need to verify that a person is who they say they are, a call is made to Simprints ID using this unique ID, from which Simprints ID will take a new biometric capture with the person present, and validate that it matches the previously enrolled biometric capture with that unique ID.

General Flow

  1. Calling app creates an Intent using projectID, moduleID and userID

  2. Triggers the Intent to start Simprints ID flow

  3. Simprints ID validates parameters and authenticates the device

  4. Consent screen is shown, to let the beneficiary agree to terms of biometric data capture

  5. Beneficiary's biometrics get captured and triggered flow proceeds

  6. Simprints ID returns the result from triggered flow to calling app

  7. The calling app receives a result and handles success or failure scenarios

That is Simprints ID in a nutshell! Enroll, verify or identify a person during a visit. Here are some links to get you up to speed with the flows:

Getting Started
Enrolment
Identification
Verification
Enrolment+ & Identification+
Exit Forms
Tiers & Confidence Scores
Handling Errors
Metadata