Acuant Android Mobile SDK V10
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.idea improvements Sep 4, 2018
acuantsdk improvements Sep 4, 2018
app Deleted test id Aug 13, 2018
gradle/wrapper V1.0 Jun 26, 2018
.gitignore Initial commit Jun 26, 2018 Document edited Aug 9, 2018
build.gradle Added Medical Card Support Aug 9, 2018 V1.0 Jun 26, 2018
gradlew V1.0 Jun 26, 2018
gradlew.bat V1.0 Jun 26, 2018
settings.gradle V1.0 Jun 26, 2018

Acuant Android Mobile SDK v10

Last updated – August 9, 2018

Copyright © 2003-2018 Acuant Inc. All rights reserved.

This document contains proprietary and confidential information and creative works owned by Acuant and its respective licensors, if any. Any use, copying, publication, distribution, display, modification, or transmission of such technology in whole or in part in any form or by any means without the prior express written permission of Acuant is strictly prohibited. Except where expressly provided by Acuant in writing, possession of this information shall not be construed to confer any license or rights under any Acuant intellectual property rights, whether by estoppel, implication, or otherwise.

AssureID and i-Dentify are trademarks of Acuant Inc. Other Acuant product or service names or logos referenced this document are either trademarks or registered trademarks of Acuant.

All 3M trademarks are trademarks of Gemalto Inc.

Windows® is a registered trademark of Microsoft Corporation.

Certain product, service, or company designations for companies other than Acuant may be mentioned in this document for identification purposes only. Such designations are often claimed as trademarks or service marks. In all instances where Acuant is aware of a claim, the designation appears in initial capital or all capital letters. However, you should contact the appropriate companies for more complete information regarding such designations and their registration status.

August 2018

Acuant Inc.

6080 Center Drive, Suite 850

Los Angeles, CA 90045



Acuant Web Services supports data extraction from driver’s licenses, state IDs, other government issued IDs, custom IDs, driver’s licenses, barcodes, and passports. It also supports document authentication and facial recognition to verify and authenticate the identity.

This document contains a detailed description of all functions that developers need to integrate with the Acuant Android Mobile SDK.


Prerequisites: API version 21 or higher.

  1. Open the App manifest file.

  2. Specify the permissions in the App manifest file:

     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.CAMERA" />
     // Required if reading e-Chip in the e-Passports
     <uses-permission android:name="android.permission.NFC" />
  3. Add the following meta information in the manifest file:

     android:value="barcode,face" />
  4. Include the following line in the dependencies:

     implementation ''

Note The Android Mobile SDK uses the Android Vision library.

  1. Add the following dependencies for e-Chip verification:

     implementation ('org.jmrtd:jmrtd:0.5.13')
     implementation ('org.ejbca.cvc:cert-cvc:1.4.3')
     implementation ('com.madgag.spongycastle:prov:')
     implementation ('net.sf.scuba:scuba-sc-android:0.0.9')
     //Note : Required for e-Chip reading in e-Passports
  2. Add the Acuant SDK dependency:

     implementation project(':acuantsdk')
  3. Keep the following ProGuard rules while obfuscating:

     -keep class * {
     	native <methods>;
     -keep class org.ejbca.** { *; }
     -keepclassmembers class org.ejbca.** { *; }
     -keep class net.sf.scuba.** { *; }
     -keepclassmembers class net.sf.scuba.** { *; }
     -keep class org.jmrtd.** { *; }
     -keepclassmembers class org.jmrtd.** { *; } 

Note: See the sample application for information about how to correctly set up the permissions and dependencies.

Initializing the SDK

  1. Set the endpoints:

    val endPoints = Endpoints()
    endPoints!!.frmEndpoint = ""
    endPoints!!.idEndpoint = ""
    endPoints!!.healthInsuranceEndpoint = ""
  2. Set the credentials:

     val credential = Credential()
     credential!!.username = ""
     credential!!.password = "password"
     credential!!.subscription = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
     credential!!.endpoints = endPoints
  3. Initialize the Controller:

     Controller.init(credential, object : InitializationListener {
         override fun initializationFinished(error: Error?) {
             if (error == null) {
                 // Success
             } else {
                 // Handle error here

Image capture

Image capture is described by the sample application in the "com.acuant.sampleapp.documentcapturecamera" package. See the createCameraSource of DocumentCaptureActivity function that shows how to capture a document.

Note: The sample capture code is provided if there is a requirement to detect PDF417 2D barcode in the image.

// To create a document detector
   documentDetector = controller.createDocumentDetector(context,this);
   DocumentCameraSource.Builder builder = new
       .setRequestedPreviewSize(1600, 1024)
// The following method will start detecting barcode on the document with time (in seconds):

Image cropping

After an image is captured, it is sent to the cropping library for cropping.

  1. Set card attributes:

    If the card type is known, then set it to the correct type (for example, CardType.ID1, CardType.ID2, or CardType.ID3). If card type is ID2, then set the card width (in inches). If the card type is either ID1 or ID3, then use the AUTO setting to automatically detect the card type with the cropping function.

     val cardAttributes = CardAtributes()
     if(!isHealthInsuranceCard) {
          //cardAttributes.cardType = CardType.ID2
          //cardAttributes.cardWidth = 4.13f
          cardAttributes.cardType = CardType.AUTO

    Note: See

  2. Set the cropping options:

    Set the CardAttributes, regardless of whether the captured image(s) is a Health Insurance card, and whether the Image metrics (Sharpness and Glare) are required.

     val options = CroppingOptions()
     options.imageMetricsRequired = imageMetricsRequired
     options.cardAtributes = cardAttributes
     // For Medical Insurance Card set the isHealthCard to true
     options.isHealthCard = false
  3. Set the Image to be cropped:

     val data = CroppingData()
     data.image = image
  4. Crop the image:

     val acuantImage : Image = controller.crop(options,data);
  5. Image class structure:

     public class Image {
     		public Bitmap image;
     		public CardType detectedCardType;
     		public boolean hasImageMetrics;
     		public boolean isSharp;
     		public boolean hasGlare;
     		public int sharpnessGrade;
     		public int glareGrade;
     		public Error error;

    Note: A sharpness grade of 50 and above is defined as a sharp image. A glare grade of 50 or higher indicates that there is no glare present in the image.

Facial recognition

The following sample describes how to create a live face detector and camera source.

  1. Create a live face detector and a CameraSource:

     // The first parameter is the activity and the second one is the LiveFaceListener
     val liveFaceDetector = controller.createLiveFaceDetector(context, this)
     // Pass the detector to the CameraSource
     val mCameraSource = CameraSource.Builder(context, liveFaceDetector)
             .setRequestedPreviewSize(320, 240)
  2. LiveFaceListener interface

    The LiveFaceListener interface includes the following method:

     override fun liveFaceDetailsCaptured(liveFaceDetails: LiveFaceDetails) {
     if (liveFaceDetails.error == null) {
             // A live face is detected and the face image can be accessed as liveFaceDetails.image
     	} else {

Process captured images

Use a Web Service call to process the captured images.

  1. Set the processing options:

     val cardAttributes = CardAtributes()
     // If it is ID2 type then set the cardWidth correctly
     //cardAttributes.cardType = CardType.ID2
     //cardAttributes.cardWidth = 4.13f
     cardAttributes.cardType = cardType
     val idProcessingOptions = IdOptions()
     idProcessingOptions.cardAttributes = cardAttributes
     // For Medical Insurance Card set isHealthCard to true. 
     // By default it is set to false
     mageProcessingOptions.isHealthCard = false

    Note: By default, the processing mode is set to the mode enabled in the subscription. However, if a user only requires data capture, then they can limit the processing mode by setting the following option:

     imageProcessingOptions.processingMode = ProcessingMode.DataCapture
  2. Set the processing data:

     val idProcessingData = IdData()
     imageProcessingData.frontImage = backImage // Bitmap
     imageProcessingData.backImage = frontImage // Bitmap
     imageProcessingData.barcodeString = capturedBarcodeString // String
  3. Process the ID:

     controller.processId(idProcessingData,idProcessingOptions,object : ImageProcessingListener{
         override fun imageProcessingFinished(result: ImageProcessingResult?) {
         		// Handle the response

Process a Facial Match

  1. Set the facial data:

     val facialMatchData = FacialMatchData()
     facialMatchData.faceImageOne = capturedFaceImage
     facialMatchData.faceImageTwo = capturedSelfieImage
  2. Process the facial match:

     	controller.processFacialMatch(facialMatchData,object : FacialMatchListener{
     		override fun facialMatchFinished(result: FacialMatchResult?) {
               // Handle response here

Read the e-Passport chip

  1. Initialize the Android NFC Adapter:

     NfcAdapter nfcAdapter = NfcAdapter.getDefaultAdapter(this);
  2. Ensure that the permission is provided in runtime for API level 23 and above.

  3. Use the SDK API to listen to NFC tags available in an e-Passport:

     controller.listenNFC(activity, nfcAdapter, listener)
  4. If an NFC Tag is discovered, then the control will return to the method of the Activity that was previously overridden:

     protected void onNewIntent(Intent intent)
     	// Read the information from the tag as below
     	controller.readNFCTag(intent, docNumber, dateOfBirth, dateOfExpiry)
  5. Implement the Listener methods for success or failure:

     override fun tagReadSucceeded(cardDetails: NFCData?, image: Bitmap?, sign_image: Bitmap?) {
     	// Handle Response
     override fun tagReadFailed(message: String?) {
     	// Handle error