Getting Started

• Release Notes
• SDK Size
• System Requirements
• Devices Tested
• Known Issues

Migration Guide

Integration Guides

Code Examples

Frequently Asked Questions (FAQs)

Third-Party Licenses

Terms and Conditions

This version is a complete redesign of the MiSnap SDK and is NOT backwards compatible.

This release focuses on providing a uniform API throughout the different parts of the SDK, ease of integration, and true opt-in behavior for optional components.

Additionally, the MiSnap SDK for Android is now available as a maven/gradle dependency and requires a valid license to function. Please follow the FAQs for more details and see the in-code documentation for the API changes.

Starting with v5.0.0, the MiSnap SDK does not provide any module as source.

• [Common] Support to record a video of the session.
• [Common] Support to seamlessly start multiple sessions.
• [Common] Support to query the camera capabilities before starting a session.
• [Common] Support for 1080p selfie images.
• [Common]Support to show a manual review screen to users.
• [Common] Dutch (nl) string translations.
• [Common] Support for Jetpack Navigation to create custom flows.
• [Common] Android Views for creating custom screens.
• [Document] Support for generic documents analysis sessions.
• [Document] Support to extract BSN (burgerservicenummer) from newer Netherlands passport templates.
• [Barcode] x86_64 support for the barcode scanning use case.
• [Barcode] Support for mandatory barcode extraction in addition to a good quality image.

• [Common] Changed the minimum API level to 23 (Android Marshmallow).
• [Common] Dropped the use of deprecated camera APIs in favor of CameraX.
• [Common] Reduced the memory footprint of the SDK by roughly 15%.
• [Common] MiSnap SDK now runs in the same process as the host app.
• [Common] Improved the organization and discoverability of the SDK configuration options.
• [Common] Improved the document orientation handling.
• [Common] Improved the SDK theming (including support for light and dark themes).
• [Common] Improved messaging when accessibility services are enabled.
• [Document] Various non-ID documents were folded into the generic document use case.
• [Face & NFC] Reduced the SDK footprint for face and NFC use cases.

• [Common] MiSnapWorkflow UX1 and UX2 in favor of a new, unified style.
• [Document] Support for credit cards.

Please see this page for the full list of regions and documents supported by the MiSnap SDK NFC Reader.

All sizes are download sizes for the arm64-v8a architecture. Please see this page for the in-depth size tables.

Please see versions.gradle for more details.

Please see the devices tested page for more details.

• As the face-analysis module uses Google’s MLKit for face detection, please follow this link for known issues.
• The MiSnap SDK supports CameraX v1.0.x and it is not compatible with higher minor versions.
• The minSdkVersion used in the MiSnap SDK is not compatible with higher jmrtd versions.

Please follow this migration guide to upgrade to MiSnap SDK v5.0.0 if you have an existing MiSnap SDK integration.

The MiSnap SDK provides several integration layer options. We highly recommend this activity-based integration guide.

To integrate the MiSnap SDK in single-activity architecture applications, please follow this fragment-based integration guide.

The MiSnap SDK also provides some easy-to-use custom Android Views to recreate various screens without integrating the default Fragments provided in the SDK. Please follow this views integration guide for more information.

To use MiSnap's base processing without any UI/UX provided in the MiSnap SDK, please follow this science integration guide.

The MiSnap SDK provides a set of code examples that can be used as reference along with the integration guides to assist you with the SDK integration.

We highly recommend to use them as they provide key best practices for an optimal MiSnap SDK integration.

Please follow these steps:

1. Create a Personal Access Token (PAT) on https://www.github.com.
   Please follow this guide to create a PAT and make sure to select the read:packages scope.
2. Add the following to the project level build.gradle:

   allProjects {
     repositories {
       ...
       maven {
         url = uri('https://maven.pkg.github.com/mitek-systems/misnap-android')
         credentials {
           username = 'your-github-username'
           password = 'personal-access-token' // created in Step 1.
         }
       }
     }
   }

3. Add the required dependencies as per the Integration Guides.

The MiSnap SDK provides the Library_Modules/maven-local-manager.sh script for Linux/MacOS and the Library_Modules/maven-local-manager.bat script for Windows in the release package. Please follow the below steps:

1. Run the appropriate script to deploy all the MiSnap SDK aar files to maven local.
   
   For Linux/MacOS:
   a. Open a terminal in the Library_Modules directory.
   b. Run the sh maven-local-manager.sh -i command.
   
   For Windows:
   a. Open a command prompt in the Library_Modules directory.
   b. Run the maven-local-manager.bat /i command.

2. Add the following to the project level build.gradle:

   allprojects {
     repositories {
       ...
       //Please make sure that mavenLocal() is the last entry in the repositories block
       mavenLocal()
     }
   }

3. Add the required dependencies as per the Integration Guides.

Yes, MiSnap now requires a valid license to be provided to function. Please follow the appropriate Integration Guide and the code samples for information on how to pass a license to the SDK.

Please reach out to your Mitek support team to obtain a license.

Avoid hard-coding the license in your application. Instead, fetch it from your application server before invoking the MiSnap SDK. This will allow you to easily switch the license in the future without requiring you to roll out a new version of your app.

Yes, when invoking the MiSnap SDK, it is a best practice to first query the camera support and set the MiSnapSettings capture mode according to the device's camera capabilities. This helps the asset selection of the HelpFragment be faster providing a smoother user experience. Look into examples/camera/CameraSupport.Kt for a code example on how to query the camera support.

Please see the regions and documents page for the full list of supported regions and documents.

The MiSnap SDK uses both JVM and native components, and so requires dedicated library versions for different hardware architectures (ABIs). No single device requires multiple ABIs, and so bundling multiple ABIs into a single app increases its size without providing any addition functionality. This can be avoided by either using App Bundles or by using Apk Splits.

• OpenCV

• Apache Commons Imaging

• Kotlin

• Kotlin Serialization

• Kotlin Coroutines

• Material Components for Android

• JP2ForAndroid

• jMRTD

• Smart Card Utilities for Better Access (SCUBA) for Android

By you accessing this SDK and/or any related documentation, sample apps and libraries (collectively, the “SDK”) you acknowledge that either (i) you currently are a party to a contract/license with Mitek Systems, Inc. (“Mitek”) which governs access to and use of the SDK (in which case, the terms and conditions of that contract govern your use of the SDK) or (ii) you agree to the following terms and conditions:

You will use the SDK solely to evaluate the SDK for the purpose of internal development of software and applications to the extent necessary for such applications to transfer data to Mitek. You have no right to receive any underlying software or a copy of the object code or source code to the SDK. You will not make copies of the SDK. You will not make the SDK available to any third party. Mitek shall own all modifications, revisions, or derivative works of the code contained in its SDK.

Your right to use the SDK is conditional upon the following. You may not: (i) sell, rent, lease or otherwise distribute or share the SDK; (ii) disassemble, decompile, reverse engineer the SDK or output from the foregoing or otherwise attempt to derive the source code (or the underlying ideas, algorithms, structure or organization); (iii) provide access to the SDK to any third party; (iv) create any derivative works based upon the SDK; (v) access the SDK in order to build a competitive solution or gather competitive intelligence or to assist someone else to build a competitive solution or gather competitive intelligence; (vi) use the SDK in a way that violates any applicable law; (vii) interfere with or disrupt the integrity or performance of the SDK, or (viii) attempt to gain unauthorized access to Mitek’s related systems or networks.

Mitek is giving permission to you to use the SDK solely in accordance with these terms and conditions. The SDK is not being sold. Mitek and/or its licensors retain the exclusive ownership of all rights, title and interest, including all intellectual property rights, in and to the SDK(s) and associated documentation, including but not limited (i) any components, corrections, updates, upgrades, methodologies, derivative works and associated documentation thereof and (ii) all trademarks, trade names, trade secrets and other proprietary information of Mitek related thereto. Mitek also owns all suggestions, ideas, enhancement requests, or feedback related to the SDK.

All rights not expressly granted to you are reserved by Mitek and its licensors, and you shall have no rights which arise by implication or estoppel.