Plugin for React Native

Official Jumio Mobile SDK plugin for React Native

This plugin is compatible with version 4.1.0 of the Jumio SDK. If you have questions, please reach out to your Account Manager or contact Jumio Support.

Table of Contents

• Compatibility
• Setup
• Integration
  • iOS
  • Android
• Usage
  • Retrieving Information
• Customization
• Callbacks
• FAQ
  • Using Dynamic Frameworks with React Native Sample App
  • iOS Localization
  • iProov String Keys
• Support

Compatibility

We only ensure compatibility with a minimum React Native version of 0.67.4

Setup

Create React Native project and add the Jumio Mobile SDK module to it.

react-native init MyProject
cd MyProject
npm install --save https://github.com/Jumio/mobile-react.git#v4.1.0

Integration

iOS

1. Add the "NSCameraUsageDescription"-key to your Info.plist file.
2. Your app's deployment target must be at least iOS 11.0

Android

AndroidManifest
Open your AndroidManifest.xml file and change allowBackup to false. Add user permission HIGH_SAMPLING_RATE_SENSORS to access sensor data with a sampling rate greater than 200 Hz.

<application
...
android:allowBackup="false">
</application>
...
<uses-permission android:name="android.permission.HIGH_SAMPLING_RATE_SENSORS"/>

Make sure your compileSdkVersion and buildToolsVersion are high enough.

android {
  compileSdkVersion 31
  buildToolsVersion "32.0.0"
  ...
}

Enable MultiDex
Follow the Android developers guide: https://developer.android.com/studio/build/multidex.html

android {
  ...
  defaultConfig {
    ...
    multiDexEnabled true
  }
}

Upgrade Gradle build tools
The plugin requires at least version 4.0.0 of the Android build tools. This transitively requires and upgrade of the Gradle wrapper to version 7 and an update to Java 11.

Upgrade build tools version to 7.0.3 in android/build.gradle:

buildscript {
  ...
  dependencies {
    ...
    classpath 'com.android.tools.build:gradle:7.0.3'
  }
}

Modify the Gradle Wrapper version in android/gradle.properties.

Repository
Add the Jumio Mobile SDK repository:

exclusiveContent {
  forRepository {
    maven {
      url 'https://mobile-sdk.jumio.com'
    }
  }
  filter {
    includeGroup "com.jumio.android"
    includeGroup "com.iproov.sdk"
  }
}

Proguard Rules
For information on Android Proguard Rules concerning the Jumio SDK, please refer to our Android guides.

Usage

1. Add "NativeModules" to the import of 'react-native'.

import {
  ...
  NativeModules
} from 'react-native';

2. Create a variable of your iOS module:

const { JumioMobileSDK } = NativeModules;

3. The SDKs can be initialized with the following calls.

JumioMobileSDK.initialize(<AUTHORIZATION_TOKEN>, <DATACENTER>);

Datacenter can either be US, EU or SG.

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

  JumioMobileSDK.start();

Optionally, it is possible to check whether a device is rooted / jailbroken with the following method:

  const isRooted = await JumioMobileSDK.isRooted();

Retrieving information

You can listen to events to retrieve the scanned data:

• EventResult for Jumio results.
• EventError for Jumio error.

First add NativeEventEmitter to the import from 'react-native' and listen to the events.

import {
...
NativeEventEmitter
} from 'react-native';

The event receives a JSON object with all the data. The example below shows how to retrieve the information of each emitter as a String:

const emitterJumio = new NativeEventEmitter(JumioMobileSDK);
emitterJumio.addListener(
    'EventResult',
    (EventResult) => console.warn("EventResult: " + JSON.stringify(EventResult))
);
emitterJumio.addListener(
    'EventError',
    (EventError) => console.warn("EventError: " + JSON.stringify(EventError))
);

Customization

Android

The JumioSDK colors can be customized by overriding the custom theme AppThemeCustomJumio. An example customization of all values that can be found in the styles.xml of the DemoApp

Callbacks

In oder to get information about result fields, Retrieval API, Delete API, global settings and more, please read our page with server related information.

Result Objects

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

EventResult

Parameter	Type	Max. length	Description
selectedCountry	String	3	ISO 3166-1 alpha-3 country code as provided or selected
selectedDocumentType	String	16	PASSPORT, DRIVER_LICENSE, IDENTITY_CARD or VISA
idNumber	String	100	Identification number of the document
personalNumber	String	14	Personal number of the document
issuingDate	Date		Date of issue
expiryDate	Date		Date of expiry
issuingCountry	String	3	Country of issue as (ISO 3166-1 alpha-3) country code
lastName	String	100	Last name of the customer
firstName	String	100	First name of the customer
dob	Date		Date of birth
gender	String	1	m, f or x
originatingCountry	String	3	Country of origin as (ISO 3166-1 alpha-3) country code
addressLine	String	64	Street name
city	String	64	City
subdivision	String	3	Last three characters of ISO 3166-2:US state code
postCode	String	15	Postal code
mrzData	MRZ-DATA		MRZ data, see table below
optionalData1	String	50	Optional field of MRZ line 1
optionalData2	String	50	Optional field of MRZ line 2
placeOfBirth	String	255	Place of Birth

MRZ-Data

Parameter	Type	Max. length	Description
format	String	8	MRP, TD1, TD2, CNIS, MRVA, MRVB or UNKNOWN
line1	String	50	MRZ line 1
line2	String	50	MRZ line 2
line3	String	50	MRZ line 3
idNumberValid	BOOL		True if ID number check digit is valid, otherwise false
dobValid	BOOL		True if date of birth check digit is valid, otherwise false
expiryDateValid	BOOL		True if date of expiry check digit is valid or not available, otherwise false
personalNumberValid	BOOL		True if personal number check digit is valid or not available, otherwise false
compositeValid	BOOL		True if composite check digit is valid, otherwise false

FAQ

Using Dynamic Frameworks with React Native Sample App

Jumio SDK version 3.8.0 and newer use iProov dependencies that need need to be built as dynamic frameworks. Since React Native supports only static libraries, a pre-install hook has been added to ensure that pods added as dynamic_frameworks are actually built as dynamic frameworks, while all other pods are built as static libraries.

dynamic_frameworks = ['Socket.IO-Client-Swift', 'Starscream', 'iProov']
pre_install do |installer|
  installer.pod_targets.each do |pod|
    if !dynamic_frameworks.include?(pod.name)
      puts "Overriding the static_framework? method for #{pod.name}"
      def pod.static_framework?;
        true
      end
      def pod.build_type;
        Pod::BuildType.static_library
      end
    end
  end
end

Additionally, a post install hook needs to be added to the Podfile to ensure dependencies are build for distribution:

post_install do |installer|
    installer.pods_project.targets.each do |target|
      target.build_configurations.each do |config|
          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
      end
    end
end

Please refer to the iOS section of our DemoApp guide for additional details.

iOS Localization

After installing Cocoapods, please localize your iOS application using the languages provided at the following path:
ios -> Pods -> JumioMobileSDK -> JumioMobileSDK-3.9.0 -> Localizations -> xx.lproj

iProov String Keys

Please note that as of 3.8.0. the following keys have been added to the SDK:

• "IProov_IntroFlash"
• "IProov_IntroLa"
• "IProov_PromptLivenessAlignFace"
• "IProov_PromptLivenessNoTarget"
• "IProov_PromptLivenessScanCompleted"
• "IProov_PromptTooClose"
• "IProov_PromptTooFar"

Make sure your podfile is up to date and that new pod versions are installed properly so your Localizable files include new strings. For more information, please refer to our Changelog and Transition Guide.

Support

iOS Known Issues

Android Known Issues

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

The source code and software available on this website (“Software”) is provided by Jumio Corp. or its affiliated group companies (“Jumio”) "as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall Jumio be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including but not limited to procurement of substitute goods or services, loss of use, data, profits, or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this Software, even if advised of the possibility of such damage. In any case, your use of this Software is subject to the terms and conditions that apply to your contractual relationship with Jumio. As regards Jumio’s privacy practices, please see our privacy notice available here: Privacy Policy.