Release commit for 3.5.0

Jumio · Jan 31, 2020 · a4e176d · a4e176d
1 parent 92a512a
commit a4e176d
Show file tree

Hide file tree

Showing 25 changed files with 113 additions and 130 deletions.
diff --git a/README.md b/README.md
@@ -8,28 +8,23 @@
 - [FAQ](docs/integration_faq.md)
 
 # Release notes
-### SDK version: 3.4.0
+### SDK version: 3.5.0
 
 #### Deprecation notice
-This is the last version that supports Android 4.x and 5.0. The minimum supported Android version will be increased to 5.1 in the next SDK version 3.5.0.
+This is the last version that supports Android 4.x and 5.0. The minimum supported Android version will be increased to 5.1 (API level 22) in the next SDK version 3.6.0.
 
 #### Changes
-* New major 3D Liveness version with improved face detection models [Netverify, Authentication]
-* Support for Colombian ID barcode scanning [Netverify/Fastfill]
-* Improved image selection to reduce number of documents which are not fully visible [Netverify]
-* Advanced document checks on the back of IDs to increase user conversion [Netverify]
+* New Singapore datacenter compatibility [Netverify/Fastfill, Authentication, Document Verification, BAM Checkout]
+* Support for dynamic library modules to reduce the initial download size of the app  [Netverify/Fastfill, Authentication, Document Verification, BAM Checkout]
+* Advanced document checks on the back of IDs to increase user conversion - for paper documents [Netverify]
+* Aligned confirmation view design with Netverify [Document Verification]
+* Added fallback handling for device cameras without auto-focus [Netverify/Fastfill]
 
 #### Fixes
-* Fixed several technical problems during face scanning [Netverify, Authentication]
+* Fixed handling of credit card masking [BAM checkout]
+* Fixed problems with Belgium ID card backside scanning [Netverify/Fastfill]
 * Various smaller bug fixes/improvements [Netverify/Fastfill, Authentication, Document Verification]
 
-### SDK version: 3.4.1
-
-#### Changes
-* Updated privacy policy within user journey [Netverify, Authentication]
-
-#### Fixes
-* Fixed a problem that face capturing was not working in CustomUI on tablets [Netverify Custom UI]
 
 # Basic Setup
 
@@ -57,17 +52,8 @@ public static String[] getRequiredPermissions();
 ```
 
 ## Proguard
-If you are using Proguard, add the following lines in its configuration.
-
-```
--keep class com.jumio.** { *; }
--keep class jumio.** { *; }
--keep class com.microblink.** { *; }
--keep class com.microblink.**$* { *; }
--dontwarn com.microblink.**
--keep class com.facetec.zoom.** { *; }
--dontwarn javax.annotation.Nullable
-```
+Proguard settings are applied automatically as they are defined as consumer proguard rules within the SDK.
+The current rules can also be found in the [Sample app](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/).
 
 ## Integration
 Use the SDK in your application by including the Maven repositories with the following `build.gradle` configuration in Android Studio:
@@ -136,7 +122,7 @@ Our SDK supports accessibility features. Visually impaired users can now enable
 # Support
 
 ## Previous version
-The previous release version 3.4.0 of the Jumio Mobile SDK is supported until 2020-03-05.
+The previous release version 3.4.1 of the Jumio Mobile SDK is supported until 2020-05-01.
 
 In case the support period is expired, no bug fixes and technical support are provided anymore (bugs are typically fixed in the upcoming versions).
 Older SDK versions will keep functioning with our server until further notice, but we highly recommend to always update to the latest version to benefit from SDK improvements and bug fixes.

diff --git a/docs/integration_authentication.md b/docs/integration_authentication.md
@@ -15,7 +15,7 @@ Biometric-based Jumio Authentication establishes the digital identities of your
 - [Javadoc](https://jumio.github.io/mobile-sdk-android/)
 
 ## Release notes
-For technical changes, please read our [transition guide](transition-guide_authentication.md) SDK version: 3.4.1
+For technical changes, please read our [transition guide](transition-guide_authentication.md) SDK version: 3.5.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Authentication.
@@ -39,14 +39,14 @@ The [Sample app](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/
 
 |Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | ---------------------------- |:-------------:|:-----------------|:---------:|
-|com.jumio.android:core:3.4.1@aar                    | x | Jumio Core library		                      | 4.11 MB |
-|com.jumio.android:auth:3.4.1@aar                      | x | Authentication library 		              | 89.26 KB |
-|com.jumio.android:face:3.4.1@aar                     | x | Face library	                            | 93.06 KB |
+|com.jumio.android:core:3.5.0@aar                    | x | Jumio Core library		                      | 4.11 MB |
+|com.jumio.android:auth:3.5.0@aar                      | x | Authentication library 		              | 93.67 KB |
+|com.jumio.android:face:3.5.0@aar                     | x | Face library	                            | 95.43 KB |
 |com.facetec:zoom-authentication:8.0.11@aar     | x | Zoom face scanning library	              | 9.00 MB  |
 |androidx.appcompat:appcompat:1.1.0                   | x | Android appcompat library	                | - |
-|androidx.room:room-runtime:2.2.1                     | x | Android database object mapping library	  | - |
+|androidx.room:room-runtime:2.2.3                     | x | Android database object mapping library	  | - |
 |com.google.android.material:material:1.0.0           | x | Android material design library	          | - |
-|com.jumio.android:javadoc:3.4.1                     |   | Jumio SDK Javadoc			                    | - |
+|com.jumio.android:javadoc:3.5.0                     |   | Jumio SDK Javadoc			                    | - |
 
 ### Others
 
@@ -206,7 +206,6 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 |A[x][yyyy]| We have encountered a network communication problem | Retry possible, user decided to cancel |
 |B[x][yyyy]| Authentication failed | Secure connection could not be established, retry impossible |
 |C[x]0401| Authentication failed | API credentials invalid, retry impossible |
-|D[x]0403| Authentication failed | Wrong API credentials used, retry impossible|
 |E[x]0000| No Internet connection available | Retry possible, user decided to cancel |
 |F00000| Scanning not available at this time, please contact the app vendor | Resources cannot be loaded, retry impossible |
 |G00000| Cancelled by end-user | No error occurred |

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: 3.4.1
+For technical changes, please read our [transition guide](transition-guide_bam-checkout.md) SDK version: 3.5.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Bam-Checkout.
@@ -42,11 +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:3.4.1@aar                    | x | Jumio Core library|	4.11 MB |
-|com.jumio.android:bam:3.4.1@aar                     | x | BAM Checkout library | 3.61 MB |
+|com.jumio.android:core:3.5.0@aar                    | x | Jumio Core library|	4.11 MB |
+|com.jumio.android:bam:3.5.0@aar                     | x | BAM Checkout library | 3.62 MB |
 |androidx.appcompat:appcompat:1.1.0            				| x | Android appcompat library| - |
-|androidx.room:room-runtime:2.2.1			              | x | Android database object mapping library	| - |
-|com.jumio.android:javadoc:3.4.1                     |   | Jumio SDK Javadoc| - |
+|androidx.room:room-runtime:2.2.3			              | x | Android database object mapping library	| - |
+|com.jumio.android:javadoc:3.5.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: 3.4.1
+For technical changes, please read our [transition guide](transition-guide_document-verification.md) SDK version: 3.5.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for DocumentVerification.
@@ -39,11 +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:3.4.1@aar                    | x | Jumio Core library            | 4.11 MB |
-| com.jumio.android:dv:3.4.1@aar                      | x | Document Verification library | 118.77 KB |
+| com.jumio.android:core:3.5.0@aar                    | x | Jumio Core library            | 4.11 MB |
+| com.jumio.android:dv:3.5.0@aar                      | x | Document Verification library | 125.75 KB |
 | androidx.appcompat:appcompat:1.1.0                   | x | Android appcompat library        | - |
-|androidx.room:room-runtime:2.2.1			              | x | Android database object mapping library	| - |
-| com.jumio.android:javadoc:3.4.1                     |   | Jumio SDK Javadoc             | - |
+|androidx.room:room-runtime:2.2.3			              | x | Android database object mapping library	| - |
+| com.jumio.android:javadoc:3.5.0                     |   | Jumio SDK Javadoc             | - |
 
 If an optional module is not linked, the scan method is not available but the library size is reduced.
 
@@ -236,7 +236,6 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 |A[x][yyyy]| We have encountered a network communication problem | Retry possible, user decided to cancel |
 |B[x][yyyy]| Authentication failed | Secure connection could not be established, retry impossible |
 |C[x]0401| Authentication failed | API credentials invalid, retry impossible |
-|D[x]0403| Authentication failed | Wrong API credentials used, retry impossible|
 |E[x]0000| No Internet connection available | Retry possible, user decided to cancel |
 |F00000| Scanning not available this time, please contact the app vendor | Resources cannot be loaded, retry impossible |
 |G00000| Cancelled by end-user | No error occurred |

diff --git a/docs/integration_netverify-fastfill.md b/docs/integration_netverify-fastfill.md
@@ -17,7 +17,7 @@ Jumio’s Netverify® ID Verification allows businesses to establish the genuine
 - [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: 3.4.1
+For technical changes, please read our [transition guide](transition-guide_netverify-fastfill.md) SDK version: 3.5.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Netverify.
@@ -34,50 +34,31 @@ Using the SDK requires an activity declaration in your `AndroidManifest.xml`.
 
 You can specify your own theme (see chapter [Customization](#customization)). The orientation can be sensor based or locked with the attribute `android:screenOrientation`.
 
-If you are using eMRTD scanning, the following lines are needed in your `proguard-rules.pro` 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.**
--dontwarn org.jmrtd.PassportService
--dontwarn net.sf.scuba.**
-```
-
-If you want to use offline scanning for Fastfill please contact your Jumio Customer Success Manager.
-
 ## 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, Document Verification and Authentication included is currently __27.43 MB__.
+The [Sample app](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/) apk size with the products Netverify, BAM, Document Verification and Authentication included is currently __26.56 MB__.
 
 |Dependency        | Mandatory           | Description            | Size (Jumio libs only) |
 | ---------------- |:-------------------:|:------------------------|:---------:|
-|com.jumio.android:core:3.4.1@aar                     | x | Jumio Core library		                         			 | 4.11 MB |
-|com.jumio.android:nv:3.4.1@aar                       | x | Netverify library 		                         			 | 522.18 KB |
+|com.jumio.android:core:3.5.0@aar                     | x | Jumio Core library		                         			 | 4.11 MB |
+|com.jumio.android:nv:3.5.0@aar                       | x | Netverify library 		                         			 | 537.61 KB |
 |androidx.appcompat:appcompat:1.1.0                   | x | Android appcompat library	                           | - |
 |androidx.cardview:cardview:1.0.0                     | x | Android cardview library (Netverify only)	           | - |
-|androidx.room:room-runtime:2.2.1                     | x | Android database object mapping library	         		 | - |
+|androidx.room:room-runtime:2.2.3                     | x | Android database object mapping library	         		 | - |
 |androidx.constraintlayout:constraintlayout:1.1.3     | x | Android constraint layout library 			             | - |
-|com.google.android.gms:play-services-vision:18.0.0   |   | Barcode Scanning 			                 							 | - |
-|com.jumio.android:face:3.4.1@aar                     |   | Face library	                                 			 | 93.06 KB |
+|com.google.android.gms:play-services-vision:19.0.0   |   | Barcode Scanning 			                 							 | - |
+|com.jumio.android:face:3.5.0@aar                     |   | Face library	                                 			 | 95.43 KB |
 |com.facetec:zoom-authentication:8.0.11@aar            |   | Zoom face scanning library	                         | 9.00 MB |
 |com.google.android.material:material:1.0.0           |   | Android material design library	                 		 | - |
-|com.jumio.android:javadoc:3.4.1                      |   | Jumio SDK Javadoc			                 							 | - |
-|com.jumio.android:nv-barcode:3.4.1@aar               |   | US / CAN Barcode Scanning                            | 3.13 MB |
-|com.jumio.android:nv-barcode-vision:3.4.1@aar        |   | US / CAN Barcode Scanning Alternative (reduced size) | 38.89 KB |
-|com.jumio.android:nv-mrz:3.4.1@aar                   |   | MRZ scanning                                         | 2.09 MB |
-|com.jumio.android:nv-nfc:3.4.1@aar                   |   | eMRTD Scanning                                       | 771.17 KB |
+|com.jumio.android:javadoc:3.5.0                      |   | Jumio SDK Javadoc			                 							 | - |
+|com.jumio.android:nv-barcode:3.5.0@aar               |   | US / CAN Barcode Scanning                            | 2.25 MB |
+|com.jumio.android:nv-barcode-vision:3.5.0@aar        |   | US / CAN Barcode Scanning Alternative (reduced size) | 39.44 KB |
+|com.jumio.android:nv-mrz:3.5.0@aar                   |   | MRZ scanning                                         | 2.09 MB |
+|com.jumio.android:nv-nfc:3.5.0@aar                   |   | eMRTD Scanning                                       | 788.14 KB |
 |org.bouncycastle:bcprov-jdk15on:1.61                 |   | eMRTD Scanning                                       | - |
 |net.sf.scuba:scuba-sc-android:0.0.18                 |   | eMRTD Scanning                                       | - |
-|com.jumio.android:nv-ocr:3.4.1@aar                   |   | Template Matcher                                     | 1.08 MB |
+|com.jumio.android:nv-ocr:3.5.0@aar                   |   | Template Matcher                                     | 1.08 MB |
 
 #### Dependency conflicts
 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):
@@ -114,7 +95,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:3.4.1@aar"
+implementation "com.jumio.android:bam:3.5.0@aar"
 ```
 
 #### Root detection
@@ -399,7 +380,6 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 |A[x][yyyy]| We have encountered a network communication problem | Retry possible, user decided to cancel |
 |B[x][yyyy]| Authentication failed | Secure connection could not be established, retry impossible |
 |C[x]0401| Authentication failed | API credentials invalid, retry impossible |
-|D[x]0403| Authentication failed | Wrong API credentials used, retry impossible|
 |E[x]0000| No Internet connection available | Retry possible, user decided to cancel |
 |F00000| Scanning not available this time, please contact the app vendor | Resources cannot be loaded, retry impossible |
 |G00000| Cancelled by end-user | No error occurred |
@@ -448,7 +428,7 @@ public Set<NVDocumentVariant> getDocumentVariants(NVDocumentType documentType);
 
 **[NVScanSide](https://jumio.github.io/mobile-sdk-android/com/jumio/core/data/document/ScanSide.html)** values: `FRONT`, `BACK`, `FACE`
 
-`onNetverifyUserConsentRequried` within *yourNetverifyCustomSDKInterface* is invoked when the end-user’s consent to Jumio’s privacy policy is legally required. [onUserConsented](https://jumio.github.io/mobile-sdk-android/com/jumio/nv/custom/NetverifyCustomSDKController.html#onUserConsented--) needs to be called after the end-user has accepted 
+`onNetverifyUserConsentRequried` within *yourNetverifyCustomSDKInterface* is invoked when the end-user’s consent to Jumio’s privacy policy is legally required. [onUserConsented](https://jumio.github.io/mobile-sdk-android/com/jumio/nv/custom/NetverifyCustomSDKController.html#onUserConsented--) needs to be called after the end-user has accepted
 
 After `onNetverifyResourcesLoaded` within *yourNetverifyCustomSDKInterface*, start scanning by providing a ScanSide from the list, instances of the class `NetverifyCustomScanView` and `NetverifyCustomConfirmationView`, and an instance of your class which implements the `NetverifyCustomScanInterface`. You will receive a `NetverifyCustomScanPresenter` object.