Release commit for 2.15.0

Jumio · Jan 24, 2019 · 8d7be01 · v-mas · Mar 12, 2019 · 8d7be01
1 parent a0d5c86
commit 8d7be01
Show file tree

Hide file tree

Showing 25 changed files with 418 additions and 158 deletions.
diff --git a/README.md b/README.md
@@ -7,16 +7,14 @@
 - [Support](#support)
 
 # Release notes
-SDK version: 2.14.0
+SDK version: 2.15.0
 
 #### Changes
-* Switched to new Android X components [Netverify/Fastfill, Document Verification, BAM Checkout]
-* Added support for Kotlin to our sample project [Netverify/Fastfill, Document Verification, BAM Checkout]
-* Changed default values to true for requireVerification, requireFaceMatch and enableExtraction [Netverify/Fastfill, Document Verification]
-* Deprecated US social security card document type [Document Verification]
+* New ISO 30107-3 Level 1 compliant 3D face liveness capturing technology [Netverify]
+* Added the option to screen share the SDK in debug builds [Netverify/Fastfill, Document Verification, BAM Checkout]
 
 #### Fixes
-* Fixed a bug in the image quality check on Android 9 devices [Netverify/Fastfill, Document Verification]
+* Fixed a problem in which N/A was returned as the identityVerification result in the server callback [Netverify]
 * Various smaller bug fixes/improvements [Netverify/Fastfill, Document Verification, BAM Checkout]
 
 # Basic Setup
@@ -50,20 +48,20 @@ If you are using Proguard, add the following lines in its configuration.
 ```
 -keep class com.jumio.** { *; }
 -keep class jumio.** { *; }
--keep class com.samsung.** { *; }
--keep class com.samsung.**$* { *; }
--dontwarn com.samsung.**
 -keep class com.microblink.** { *; }
 -keep class com.microblink.**$* { *; }
 -dontwarn com.microblink.**
+-keep class com.facetec.zoom.** { *; }
+-dontwarn javax.annotation.Nullable
 ```
 
 ## Integration
 Use the SDK in your application by including the Maven repositories with the following `build.gradle` configuration in Android Studio:
 
 ```
 repositories {
-	maven { url 'https://maven.google.com/' }
+	google()
+	jcenter()
 	maven { url 'https://mobile-sdk.jumio.com' }
 }
 ```
@@ -121,15 +119,16 @@ Our SDK supports accessibility features. Visually impaired users can now enable
 # Support
 
 ## Previous version
-The previous release version 2.13.0 of the Jumio Mobile SDK is supported until 2019-01-16.
+The previous release version 2.14.0 of the Jumio Mobile SDK is supported until 2019-04-23.
 
 In case the support period is expired, no bug fixes are provided anymore (typically fixed in the upcoming versions). The SDK will keep functioning (until further notice).
 
 ## Two-factor Authentication
 If you want to enable two-factor authentication for your Jumio customer portal please contact us at https://support.jumio.com. Once enabled, users will be guided through the setup upon their first login to obtain a security code using the "Google Authenticator" app.
 
 ## Licenses
-The software contains third-party open source software. For more information, please see [/licenses](https://github.com/Jumio/mobile-sdk-android/tree/master/licenses).
+The software contains third-party open source software. For more information, please see [licenses](https://github.com/Jumio/mobile-sdk-android/tree/master/licenses).
+
 This software is based in part on the work of the Independent JPEG Group.
 
 ## Contact

diff --git a/docs/integration_bam-checkout.md b/docs/integration_bam-checkout.md
@@ -17,7 +17,7 @@ BAM Checkout SDK is a powerful, cutting-edge solution to extract data from your
 - [Javadoc](https://jumio.github.io/mobile-sdk-android/)
 
 ## Release notes
-For technical changes, please read our [transition guide](transition-guide_bam-checkout.md) SDK version: 2.14.0
+For technical changes, please read our [transition guide](transition-guide_bam-checkout.md) SDK version: 2.15.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Bam-Checkout.
@@ -42,10 +42,11 @@ If you want to use offline scanning for BAM Checkout (Credit card scanning), ple
 
 |Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | :---------------------------- |:-------------:|:-----------------|:------------:|
-|com.jumio.android:core:2.14.0@aar                    | x | Jumio Core library|	4.52 MB |
-|com.jumio.android:bam:2.14.0@aar                     | x | BAM Checkout library | 2.02 MB |
-|androidx.appcompat:appcompat:1.0.0            				| x | Android native library| - |
-|com.jumio.android:javadoc:2.14.0                     |   | Jumio SDK Javadoc| - |
+|com.jumio.android:core:2.15.0@aar                    | x | Jumio Core library|	4.52 MB |
+|com.jumio.android:bam:2.15.0@aar                     | x | BAM Checkout library | 2.02 MB |
+|androidx.appcompat:appcompat:1.0.0            				| x | Android appcompat library| - |
+|androidx.room:room-runtime:2.0.0			              | x | Android database object mapping library	| - |
+|com.jumio.android:javadoc:2.15.0                     |   | Jumio SDK Javadoc| - |
 
 If an optional module is not linked, the scan method is not available but the library size is reduced.
 

diff --git a/docs/integration_document-verification.md b/docs/integration_document-verification.md
@@ -15,7 +15,7 @@ Document Verification is a powerful solution to enable scanning various types (U
 - [Javadoc](https://jumio.github.io/mobile-sdk-android/)
 
 ## Release notes
-For technical changes, please read our [transition guide](transition-guide_document_verification.md) SDK version: 2.14.0
+For technical changes, please read our [transition guide](transition-guide_document_verification.md) SDK version: 2.15.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for DocumentVerification.
@@ -39,10 +39,11 @@ You can specify your own theme (see [Customization](#customizing-look-and-feel)
 
 | Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | ----------------- |:-------------------:|:------------------|:-------------------:|
-| com.jumio.android:core:2.14.0@aar                    | x | Jumio Core library            | 4.52 MB |
-| com.jumio.android:dv:2.14.0@aar                      | x | Document Verification library | 117.12 KB |
-| androidx.appcompat:appcompat:1.0.0                   | x | Android native library        | - |
-| com.jumio.android:javadoc:2.14.0                     |   | Jumio SDK Javadoc             | - |
+| com.jumio.android:core:2.15.0@aar                    | x | Jumio Core library            | 4.52 MB |
+| com.jumio.android:dv:2.15.0@aar                      | x | Document Verification library | 117.09 KB |
+| androidx.appcompat:appcompat:1.0.0                   | x | Android appcompat library        | - |
+|androidx.room:room-runtime:2.0.0			              | x | Android database object mapping library	| - |
+| com.jumio.android:javadoc:2.15.0                     |   | Jumio SDK Javadoc             | - |
 
 If an optional module is not linked, the scan method is not available but the library size is reduced.
 
@@ -168,7 +169,22 @@ documentVerificationSDK.setDocumentName(“YOURDOCNAME”);
 ## Customization
 
 ### Customizing look and feel
-The SDK can be customized to fit your application’s look and feel by specifying `Theme.DocumentVerification` as a parent style of your own theme. Click on the element `Theme.DocumentVerification` in the manifest while holding Ctrl and Android Studio will display the available items.
+The SDK can be customized to fit your application’s look and feel by specifying `Theme.DocumentVerification` as a parent style of your own custom theme. Click on the element `Theme.DocumentVerification` in the manifest while holding Ctrl and Android Studio will display the available items.
+Change the colors of the styles attributes to fit your requirements.
+
+### Customize look and feel
+There are 2 possibilities for applying the customized theme that was explained in the previous chapter:
+* Customizing theme in AndroidManifest
+* Customizing theme at runtime
+
+#### Customizing theme in AndroidManifest
+Apply the your custom theme DocumentVerification with the  that you defined before by replacing `Theme.DocumentVerification` in the AndroidManifest.xml:
+```
+<activity
+            android:name="com.jumio.dv.DocumentVerificationActivity"
+            android:theme="@style/CustomDocumentVerificationTheme"
+						... />
+```
 
 ### Customizing theme at runtime
 

diff --git a/docs/integration_netverify-fastfill.md b/docs/integration_netverify-fastfill.md
@@ -17,7 +17,7 @@ Netverify & Fastfill SDK offers scanning and authentication of governmental issu
 - [Javadoc](https://jumio.github.io/mobile-sdk-android/)
 
 ## Release notes
-For technical changes, please read our [transition guide](transition-guide_netverify-fastfill.md) SDK version: 2.14.0
+For technical changes, please read our [transition guide](transition-guide_netverify-fastfill.md) SDK version: 2.15.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Netverify.
@@ -56,39 +56,40 @@ If you want to use offline scanning for Fastfill please contact your Jumio Custo
 ## Dependencies
 
 If an optional module is __not linked__, the __scan method is not available__ but the library size is reduced.
-The [Sample app](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/) apk size with the products Netverify, BAM and Document Verification included is currently __21.19 MB__.
+The [Sample app](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/) apk size with the products Netverify, BAM and Document Verification included is currently __27.90 MB__.
 
 |Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | ---------------------------- |:-------------:|:-----------------|:---------:|
-| com.jumio.android:core:2.14.0@aar                   | x | Jumio Core library		| 4.52 MB |
-| com.jumio.android:nv:2.14.0@aar                     | x | Netverify library 		| 497.56 KB |
-|androidx.appcompat:appcompat:1.0.0			              | x | Android native library	| - |
-|androidx.cardview:cardview:1.0.0				              | x | Android cardview library (Netverify only)	| - |
-|com.google.android.gms:play-services-vision:15.0.1   |   | Barcode Scanning 			| - |
-|com.jumio.android:nv-liveness:2.14.0@aar 	          | x | Face-Liveness library	| 4.54 MB |
-|com.google.android.material:material:1.0.0           |   | Android native library	| - |
-|com.jumio.android:javadoc:2.14.0                     |   | Jumio SDK Javadoc			| - |
-|com.jumio.android:nv-barcode:2.14.0@aar              |   | US / CAN Barcode Scanning | 3.45 MB |
-|com.jumio.android:nv-barcode-vision:2.14.0@aar 	    |   | US / CAN Barcode Scanning Alternative (reduced size) | 34.25 KB |
-|com.jumio.android:nv-mrz:2.14.0@aar             		  |   | MRZ scanning 					| 2.21 MB |
-|com.jumio.android:nv-nfc:2.14.0@aar              	  |   | eMRTD Scanning 				| 751.31 KB |
-|com.madgag.spongycastle:prov:1.58.0.0             	  |   | eMRTD Scanning 				| - |
-|net.sf.scuba:scuba-sc-android:0.0.16             	  |   | eMRTD Scanning 				| - |
-|com.jumio.android:nv-ocr:2.14.0@aar             		  |   | Template Matcher 			| 1.57 MB |
+|com.jumio.android:core:2.15.0@aar                    | x | Jumio Core library		                         | 4.52 MB |
+|com.jumio.android:nv:2.15.0@aar                      | x | Netverify library 		                         | 481.50 KB |
+|androidx.appcompat:appcompat:1.0.0                   | x | Android appcompat library	                         | - |
+|androidx.cardview:cardview:1.0.0                     | x | Android cardview library (Netverify only)	         | - |
+|androidx.room:room-runtime:2.0.0                     | x | Android database object mapping library	         | - |
+|com.google.android.gms:play-services-vision:15.0.1   |   | Barcode Scanning 			                 | - |
+|com.jumio.android:nv-face:2.15.0@aar                 |   | Face library	                                 | 78.94 KB |
+|com.facetec:zoom-authentication-hybrid:7.0.2@aar     |   | Zoom face scanning library	                         | 12.1 MB |
+|com.google.android.material:material:1.0.0           |   | Android material design library	                 | - |
+|com.jumio.android:javadoc:2.15.0                     |   | Jumio SDK Javadoc			                 | - |
+|com.jumio.android:nv-barcode:2.15.0@aar              |   | US / CAN Barcode Scanning                            | 3.45 MB |
+|com.jumio.android:nv-barcode-vision:2.15.0@aar       |   | US / CAN Barcode Scanning Alternative (reduced size) | 35.72 KB |
+|com.jumio.android:nv-mrz:2.15.0@aar                  |   | MRZ scanning                                         | 2.23 MB |
+|com.jumio.android:nv-nfc:2.15.0@aar                  |   | eMRTD Scanning                                       | 750.36 KB |
+|com.madgag.spongycastle:prov:1.58.0.0                |   | eMRTD Scanning                                       | - |
+|net.sf.scuba:scuba-sc-android:0.0.16                 |   | eMRTD Scanning                                       | - |
+|com.jumio.android:nv-ocr:2.15.0@aar                  |   | Template Matcher                                     | 1.57 MB |
 
 ### Google Mobile Vision
 
 #### Dependency conflicts
-If the dependencies `com.jumio.android:nv-liveness` and `com.jumio.android:nv-barcode-vision` are both used in the application, the following lines have to be added to the application tag in the AndroidManifest.xml to avoid merge issues (see [AndroidManifest.xml](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/src/main/AndroidManifest.xml) in Sample app):
+If the dependency `com.jumio.android:nv-barcode-vision` is used in the application, the following lines have to be added to the application tag in the AndroidManifest.xml to avoid merge issues (see [AndroidManifest.xml](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/src/main/AndroidManifest.xml) in Sample app):
 ```
 <meta-data
 			android:name="com.google.android.gms.vision.DEPENDENCIES"
-			android:value="barcode, face"
+			android:value="barcode"
 			tools:replace="android:value"/>
 ```
 
 #### Operationality
-If the Google Mobile Vision API is not operational on a device, a manual fallback will be used for the face workflow.
 The operationality of the Google Mobile Vision API can be checked with the following SDK method (see [NetverifyFragment](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/src/main/java/com/jumio/sample/java/NetverifyFragment.java)  in Sample app):
 ```
 GoogleVisionStatus NetverifySDK.isMobileVisionOperational(Activity activity, int requestCode);
@@ -114,7 +115,7 @@ In case of __DIALOG_PENDING__, the `requestCode` provided in the method above ca
 If you use Netverify and BAM Checkout in your app, add the following dependency:
 
 ```
-implementation "com.jumio.android:bam:2.14.0@aar"
+implementation "com.jumio.android:bam:2.15.0@aar"
 ```
 
 #### Root detection
@@ -235,15 +236,15 @@ __Note:__ COUNTRYCODE is an optional parameter and can also be passed as `null`.
 
 Possible countries: [ISO 3166-1 alpha-3](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code
 
-Use the nv-barcode-vision library instead of the play-services-vision libary and add the following meta-data tags to your `AndroidManifest.xml`:
+Use the nv-barcode-vision library instead of the nv-barcode libary and add the following meta-data tags to your `AndroidManifest.xml`:
 
 ```
 <meta-data
 			android:name="com.google.android.gms.version"
 			android:value="@integer/google_play_services_version" />
 <meta-data
 			android:name="com.google.android.gms.vision.DEPENDENCIES"
-			android:value="barcode, face"
+			android:value="barcode"
 			tools:replace="android:value"/>
 ```
 
@@ -264,12 +265,27 @@ netverifySDK.setCameraPosition(JumioCameraPosition.FRONT);
 ### Customization tool
 [Jumio Surface](https://jumio.github.io/surface-android/) is a web tool that offers the possibility to apply and visualize, in real-time, all available customization options for Netverify / Fastfill SDK as well as an export feature to import the applied changes straight into your codebase.
 
-### Customize look and feel
+Use the tab __"Customize SDK"__ to check out all the screens and adapt the look&feel of the SDK to your needs.
+
+The tab __"XML Output"__ visualizes all the colors that can be customized. As visualized in the code there, the SDK can be customized to fit your application's look and feel by specifying `Theme.Netverify` as a parent style and overriding attributes within this theme.
 
-The SDK can be customized to fit your application's look and feel by specifying `Theme.Netverify` as a parent style and overriding attributes within this theme. Click on the element `Theme.Netveriy` in the manifest while holding Ctrl and Android Studio will display the available attributes of the Theme that can be customized.
+After customizing the SDK, you can copy the code from the theme `CustomNetverifyTheme` to your Android app `styles.xml` file.
+
+### Customize look and feel
+There are 2 possibilities for applying the customized theme that was explained in the previous chapter:
+* Customizing theme in AndroidManifest
+* Customizing theme at runtime
 
-### Customizing theme at runtime
+#### Customizing theme in AndroidManifest
+Apply the `CustomNetverifyTheme` that you defined before by replacing `Theme.Netverify` in the AndroidManifest.xml:
+```
+<activity
+            android:name="com.jumio.nv.NetverifyActivity"
+            android:theme="@style/CustomNetverifyTheme"
+						... />
+```
 
+#### Customizing theme at runtime
 To customize the theme at runtime, overwrite the theme that is used for Netverify in the manifest by calling the following property. Use the resource id of a customized theme that uses Theme.Netverify as parent.
 
 ```
@@ -389,6 +405,8 @@ The first letter (A-J) represents the error case. The remaining characters are r
 Netverify can be also implemented as a custom scan view. This means that only the scan view (including the scan overlays) are provided by the SDK.
 The handling of the lifecycle, document selection, readability confirmation, intermediate callbacks, and all other steps necessary to complete a scan have to be handled by the client application that implements the SDK.
 
+**Note:** The new 3D face liveness capturing technology is not optimised for tablets or when using our SDK in combination with Custom UI. When using Identity Verification, the selfie scanner will fallback to a simple face capturing functionality instead. Portrait orientation support is required in your app.
+
 To use the custom scan view with a plain scanning user interface, specify an instance of your class which implements the [NetverifyCustomSDKInterface](https://jumio.github.io/mobile-sdk-android/com/jumio/nv/custom/NetverifyCustomScanInterface.html). You will receive a [NetverifyCustomSDKController](https://jumio.github.io/mobile-sdk-android/com/jumio/nv/custom/NetverifyCustomSDKController.html) object.
 
 ```

diff --git a/docs/transition-guide_bam-checkout.md b/docs/transition-guide_bam-checkout.md
@@ -4,6 +4,11 @@
 
 This section only covers the breaking technical changes that should be considered when updating from the previous version.
 
+## 2.15.0
+#### Added Room
+Dependencies that have been added to the SDK:
++ androidx.room:room-runtime:2.0.0  
+
 ## 2.14.0
 #### Migrate to AndroidX
 The support library was migrated to [`AndroidX`](https://developer.android.com/jetpack/androidx/). As the developer page outlines, this is a mandatory step since all new Support Library development and maintenance will occur in the AndroidX library. This [`migration guide`](https://developer.android.com/jetpack/androidx/migrate) shows you how to migrate your application to AndroidX.

diff --git a/docs/transition-guide_document-verification.md b/docs/transition-guide_document-verification.md
@@ -4,6 +4,11 @@
 
 This section only covers the breaking technical changes that should be considered when updating from the previous version.
 
+## 2.15.0
+#### Added Room
+Dependencies that have been added to the SDK:
++ androidx.room:room-runtime:2.0.0  
+
 ## 2.14.0
 #### Migrate to AndroidX
 The support library was migrated to [`AndroidX`](https://developer.android.com/jetpack/androidx/). As the developer page outlines, this is a mandatory step since all new Support Library development and maintenance will occur in the AndroidX library. This [`migration guide`](https://developer.android.com/jetpack/androidx/migrate) shows you how to migrate your application to AndroidX.