jumio-cordova v3.5.0

Plugin for Apache Cordova

Official Jumio Mobile SDK plugin for Apache Cordova

This plugin is compatible with version 3.5.0 of the Jumio SDK. If you have questions, please reach out to your Account Manager or contact Jumio Support at support@jumio.com or https://support.jumio.com

Compatibility

With this release, we only ensure compatibility with the latest Cordova versions and plugins. At the time of this release, the following minimum versions are supported:

• Cordova: 9.0.0
• Cordova Android: 8.1.0
• Cordova iOS: 5.0.1

Setup

Create Cordova project and add our plugin

cordova create MyProject com.my.project "MyProject"
cd MyProject
cordova platform add ios
cordova platform add android
cordova plugin add https://github.com/Jumio/mobile-cordova.git#v3.5.0

Integration

iOS

Manual integration or dependency management via cocoapods possible, please see the official documentation of the Jumio Mobile SDK for iOS

Android

Add the Jumio repository:

repositories {
    maven { url 'http://mobile-sdk.jumio.com' }
    maven { url 'https://maven.google.com/' }
}

Add a parameter for your SDK_VERSION into the ext-section:

ext {
    SDK_VERSION = "3.5.0"
}

Add required permissions for the products as described in chapter Permissions

Open the android project of your cordova project located in /platforms/android and insert the dependencies from the products you require to your build.gradle file. (Module: android)

• Netverify & Fastfill
• Document Verification
• BAM Checkout

Due to the outdated Cordova platform that is not yet updated for Android API version 28 and AndroidX, it's necessary to adapt your project to support the proper build environment for the native Jumio Android component. Take a look at the Demo App build.gradle how to upgrade to API level 28. The FAQ section at the bottom covers common build issues and how to fix them. Open your Cordova Android project in Android Studio to get IDE auto-suggestions and support for all the required changes.

Usage

Netverify / Fastfill

To initialize the SDK, perform the following call.

Jumio.initNetverify(<API_TOKEN>, <API_SECRET>, <DATACENTER>, {configuration});

Datacenter can either be US, EU or SG.

Configure the SDK with the configuration-Object.

Initialization example with configuration.

Jumio.initNetverify("API_TOKEN", "API_SECRET", "US", {
    requireVerification: false,
    userReference: "USERREFERENCE",
    preselectedCountry: "USA",
    cameraPosition: "BACK",
    documentTypes: ["DRIVER_LICENSE", "PASSPORT", "IDENTITY_CARD", "VISA"],
    enableWatchlistScreening: "ENABLED",
    watchlistSearchProfile: "YOURPROFILENAME"
});

Android eMRTD scanning

If you are using eMRTD scanning, following lines are needed in your Manifest file:

-keep class net.sf.scuba.smartcards.IsoDepCardService {*;}
-keep class org.jmrtd.** { *; }
-keep class net.sf.scuba.** {*;}
-keep class org.bouncycastle.** {*;}
-keep class org.ejbca.** {*;}

-dontwarn java.nio.**
-dontwarn org.codehaus.**
-dontwarn org.ejbca.**
-dontwarn org.bouncycastle.**

Add the needed dependencies following this chapter of the android integration guide.

Enable eMRTD by using the following method in your native android code:

netverifySDK.setEnableEMRTD(true);

As soon as the sdk is initialized, the sdk is started by the following call.

Jumio.startNetverify(successCallback, errorCallback);

Example

Jumio.startNetverify(function(documentData) {
    // YOUR CODE
}, function(error) {
    // YOUR CODE
});

Authentication

To initialize the SDK, perform the following call.

  Jumio.initAuthentication(<API_TOKEN>, <API_SECRET>, <DATACENTER>, {configuration});

To start the SDK, perform the following call.

Jumio.startAuthentication();

Datacenter can either be US, EU or SG.

Configure the SDK with the configuration-Object. (configuration marked with * are mandatory)

In order to connect the Authentication transaction to a specific Netverify user identity the parameter enrollmentTransactionReference must be set. In case an Authentication transaction has been created via the facemap server to server API authenticationTransactionReference should be used. Therefore enrollmentTransactionReference should not be set.

Initialization example with configuration:

    initAuthentication: function() {
      // Authentication
      Jumio.initAuthentication(<API_TOKEN>, <API_SECRET>, <DATACENTER>, {
        enrollmentTransactionReference: "EnrollmentTransactionReference",
        //authenticationTransactionReference: "AuthenticationTransactionReference",
        userReference: "UserReference"
        callbackUrl: "URL"
      });
    }

    startAuthentication: function() {
      Jumio.startAuthentication(function(result) {
          alert(JSON.stringify(result));
        }, function(error) {
          alert(JSON.stringify(error));
      });
    }

Document Verification

To initialize the SDK, perform the following call.

Jumio.initDocumentVerification(<API_TOKEN>, <API_SECRET>, <DATACENTER>, {configuration});

Datacenter can either be US, EU or SG.

Configure the SDK with the configuration-Object. (configuration marked with * are mandatory)

Possible types:

• BS (Bank statement)
• IC (Insurance card)
• UB (Utility bill, front side)
• CAAP (Cash advance application)
• CRC (Corporate resolution certificate)
• CCS (Credit card statement)
• LAG (Lease agreement)
• LOAP (Loan application)
• MOAP (Mortgage application)
• TR (Tax return)
• VT (Vehicle title)
• VC (Voided check)
• STUC (Student card)
• HCC (Health care card)
• CB (Council bill)
• SENC (Seniors card)
• MEDC (Medicare card)
• BC (Birth certificate)
• WWCC (Working with children check)
• SS (Superannuation statement)
• TAC (Trade association card)
• SEL (School enrolment letter)
• PB (Phone bill)
• USSS (US social security card)
• SSC (Social security card)
• CUSTOM (Custom document type)

Initialization example with configuration.

Jumio.initDocumentVerification("API_TOKEN", "API_SECRET", "US", {
    type: "BC",
    userReference: "USERREFERENCE",
    country: "USA",
    customerInternalReference: "YOURSCANREFERENCE",
    cameraPosition: "BACK"
});

As soon as the SDK is initialized, the SDK is started by the following call.

Jumio.startDocumentVerification(successCallback, errorCallback);

Example

Jumio.startDocumentVerification(function(documentData) {
    // YOUR CODE
}, function(error) {
    // YOUR CODE
});

BAM Checkout

To Initialize the SDK, perform the following call.

Jumio.initBAM(<API_TOKEN>, <API_SECRET>, <DATACENTER>, {configuration});

Datacenter can either be US, EU or SG.

Configure the SDK with the configuration-Object.

Initialization example with configuration.

Jumio.initBAM("API_TOKEN", "API_SECRET", "US", {
    cardHolderNameRequired: false,
    cvvRequired: true,
    cameraPosition: "BACK",
    cardTypes: ["VISA", "MASTER_CARD"]
});

As soon as the sdk is initialized, the sdk is started by the following call.

Jumio.startBAM(successCallback, errorCallback);

Example

Jumio.startBAM(function(cardInformation) {
    // YOUR CODE
}, function(error) {
    // YOUR CODE
});

Customization

Android

Netverify

The Netverify SDK can be customized to the respective needs by following this customization chapter.

BAM Checkout

The Netverify SDK can be customized to the respective needs by following this customization chapter.

Document Verification

The Netverify SDK can be customized to the respective needs by following this customization chapter.

iOS

The SDK can be customized to the respective needs. You can pass the following customization options to the initializer:

All colors are provided with a HEX string with the following format: #ff00ff.

Customization example

Jumio.initNetverify("API_TOKEN", "API_SECRET", "US", {
    requireVerification: false,
    ...
}, {
    disableBlur: true,
    backgroundColor: "#ff00ff",
    barTintColor: "#ff1298"
);

Callback

To get information about callbacks, Netverify Retrieval API, Netverify Delete API and Global Netverify settings and more, please read our page with server related information.

The JSONObject with all the extracted data that is returned for the specific products is described in the following subchapters:

Netverify & Fastfill

NetverifyDocumentData:

MRZ-Data

BAM Checkout

BAMCardInformation

Document Verification

No data returned.

FAQ

This is a list of common Android build issues and how to resolve them:

• Gradle plugin 4.X not supported, please install 5.X

  	-> Change the version in the gradle-wrapper.properties file

• MinSdkVersion/TargetSdkVersion not supported in AndroidManifest.xml

  	-> Remove both versions from AndroidManifest.xml as suggested by Android Studio (as they are taken from build.gradle only since Gradle 5)

• Command "compile" is obsolete, use implementation instead

  	-> Change all dependency declarations to use "implementation" instead of "compile" to support the latest gradle changes - https://github.com/Jumio/mobile-cordova/blob/master/demo/platforms/android/build.gradle#L291

• Theme.Netverify/Bam/DocumentVerification/Authentication cannot be resolved

  	-> Add the Jumio dependencies as proposed here: https://github.com/Jumio/mobile-cordova/blob/master/demo/platforms/android/build.gradle#L95

• Ressources from styles.xml "cornerRadius" and others not found

  -> Build tools and support library are not at version 28. Change compileSdk and buildToolsVersion as described here -> https://github.com/Jumio/mobile-cordova/blob/master/demo/platforms/android/build.gradle#L222

• Device-ready not fired after X seconds

  -> The plugin definition in "YOURPROJECT/platforms/android/platform_www/plugins/cordova-plugin-jumio-mobilesdk/www" might be duplicated/corrupted due to the issue mentioned in this Stackoverflow post - https://stackoverflow.com/questions/28017540/cordova-plugin-javascript-gets-corrupted-when-added-to-project/28264312#28264312 , please fix the duplicated "cordova.define()" call in these files as mentioned in the post.

Support

Contact

If you have any questions regarding our implementation guide please contact Jumio Customer Service at support@jumio.com or https://support.jumio.com. The Jumio online helpdesk contains a wealth of information regarding our service including demo videos, product descriptions, FAQs and other things that may help to get you started with Jumio. Check it out at: https://support.jumio.com.

Licenses

The software contains third-party open source software. For more information, please see Android licenses and iOS licenses

This software is based in part on the work of the Independent JPEG Group.

Copyright

© Jumio Corp. 268 Lambert Avenue, Palo Alto, CA 94306