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
  • What is ODK?
  • Prerequisites
  • ODK
  • Simprints
  • Simprints Parameters
  • Ready?

Was this helpful?

Edit on GitHub
  1. Development
  2. Simprints for Developers
  3. Other Intergrations

ODK Integrations + SurveyCTO

PreviousOther IntergrationsNextEnrol

Last updated 1 year ago

Was this helpful?

Simprints ID can be integrated into any ODK based platform. Make sure you have checked out our page before continuing.

What is ODK?

An ODK xml form can collect information about a beneficiary over time. Within an ODK XML form, there is functionality to integrate the Simprints ID app. This will allow frontline workers the ability to scan and capture a beneficiary's biometric records.

In some contexts, asking to scan people’s fingerprints can be unfamiliar and intimidating, leading to some beneficiaries refusing to be scanned. When building an ODK form, we recommend that the question that asks for fingerprint scanning should come much later in the workflow, after other basic demographic information has been collected, in order to build up some comfort level for the user about the process, and warm them up to providing consent for their fingerprints to be scanned.

In this guide, we will show you how to integrate your ODK enrolment/registration, or verification form with Simprints ID. The sample forms we use in this guide are the bare minimum that a form should have, and in real-case scenarios, your forms will likely have more content than what is shown in this guide.

Prerequisites

ODK

  • Access to ODK XML forms

  • Some basic form-building knowledge with ODK

*If using SurveyCTO, access to their web platform () and SurveyCTO collect mobile app ()

Simprints

  • Simprints Project ID

  • Simprints QR code

*Contact your Simprints Project Manager if you do not have this

Simprints Parameters

  • project_id – this is the unique alphanumeric id provided by the Simprints project manager to differentiate data from different projects - it needs to be a string in quotation marks. Please contact your Simprints project manager if you do not have this

  • user_id – this variable should be populated when the user logs in to the data collection app. It can be linked to the user filling out the form. There should be an earlier question in the form asking for the username (e.g., data collector’s name, school name, health facility name)

  • module_id – this variable should be populated with the category information to break down a database. For example, this can be a district, region, or health centre

Ready?

Simprints offers three distinct callouts that you can use within your ODK XML form:

There are 3 parameters that are important when integrating your ODK form with Simprints ID (click for more information). Information on these parameters will either need to be collected or calculated before the callout to Simprints ID.

Getting Started
link
link
here
Enrol
Identify
Verify