Release commit for 3.4.0

Jumio · Nov 12, 2019 · 511dba9 · 511dba9
1 parent fd8b5b3
commit 511dba9
Show file tree

Hide file tree

Showing 38 changed files with 637 additions and 158 deletions.
diff --git a/README.md b/README.md
@@ -8,24 +8,20 @@
 - [FAQ](docs/integration_faq.md)
 
 # Release notes
-SDK version: 3.3.2
+SDK version: 3.4.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.
 
 #### Changes
-* 3D Liveness improvements [Netverify, Authentication]
-  * Updated detection models to improve face capture experience
-  * Fixed a problem that liveness images were rotated by 90 degree in rare situations
-  * Fixed face capture problem on some devices (e.g. Samsung J series, Redmi Note 7)
-* New Authentication features [Authentication]
-  * Added retry handling to allow up to 3 capture attempts per session
-  * Added support for storing the 3D facemap on customer premise functionality
-* Support of Portuguese and Italian language [Netverify/Fastfill, Authentication, Document Verification]
-* Improved speed of image processing during ID capture [Netverify/Fastfill]
-* Improved dependency check of face libraries [Netverify]
-* Fixed a bug that sometimes the ID image was cropped too much [Netverify]
-* Fixed a bug that J error was not displayed in custom UI [Netverify Custom UI]
-* Improved document alignment for more accurate image cropping [Netverify]
-* Fixed a problem when two instances were presented shortly after each other [Netverify]
-* Various smaller bug fixes/improvements [Netverify/Fastfill, Authentication, Document Verification, BAM Checkout]
+* 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]
+
+#### Fixes
+* Fixed several technical problems during face scanning [Netverify, Authentication]
+* Various smaller bug fixes/improvements [Netverify/Fastfill, Authentication, Document Verification]
 
 # Basic Setup
 
@@ -111,12 +107,14 @@ __Note:__ You get an *UnsatisfiedLinkError*, if the app and the CPU architecture
 Our SDK supports the [default Android localization features](https://developer.android.com/training/basics/supporting-devices/languages.html) for different languages and cultures.
 All label texts and button titles in the SDK can be changed and localized by adding the required Strings you want to change in a `strings.xml` file in a `values` directory for the language and culture preference that you want to support. You can check out strings that are modifiable at [.../src/main/res/values/strings-jumio-sdk.xml](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/src/main/res/values/strings-jumio-sdk.xml) within our Sample application.
 
-For our products Fastfill,Netverify & Document Verification we are providing six individual languages for your convenience:
+For our products Netverify & Fastfill, Authentication & Document Verification we are providing eight individual languages for your convenience:
 * Chinese (Simplified)
 * Dutch
 * English
 * French
 * German
+* Italian
+* Portuguese
 * Spanish
 
 Our SDK supports accessibility features. Visually impaired users can now enable __TalkBack__ or change the __font size__ on their device. The accessibility-strings that are used by TalkBack contain *accessibility_* in their key and can be also modified in the `strings.xml`.
@@ -130,7 +128,7 @@ Our SDK supports accessibility features. Visually impaired users can now enable
 # Support
 
 ## Previous version
-The previous release version 3.3.1 of the Jumio Mobile SDK is supported until 2020-01-06.
+The previous release version 3.3.2 of the Jumio Mobile SDK is supported until 2020-02-15.
 
 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.3.2
+For technical changes, please read our [transition guide](transition-guide_authentication.md) SDK version: 3.4.0
 
 ## Setup
 The [basic setup](../README.md#basic-setup) is required before continuing with the following setup for Authentication.
@@ -35,18 +35,18 @@ You can specify your own theme (see chapter [Customization](#customization)). Th
 
 ## Dependencies
 
-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 __30.03 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 __27.44 MB__.
 
 |Dependency        | Mandatory           | Description       | Size (Jumio libs only) |
 | ---------------------------- |:-------------:|:-----------------|:---------:|
-|com.jumio.android:core:3.3.2@aar                    | x | Jumio Core library		                      | 4.09 MB |
-|com.jumio.android:auth:3.3.2@aar                      | x | Authentication library 		              | 87.28 KB |
-|com.jumio.android:face:3.3.2@aar                     | x | Face library	                            | 87.30 KB |
-|com.facetec:zoom-authentication-hybrid:7.0.14@aar     | x | Zoom face scanning library	              | 12.40 MB  |
-|androidx.appcompat:appcompat:1.0.2                   | x | Android appcompat library	                | - |
-|androidx.room:room-runtime:2.0.0                     | x | Android database object mapping library	  | - |
-|com.google.android.material:material:1.0.0           |   | Android material design library	          | - |
-|com.jumio.android:javadoc:3.3.2                     |   | Jumio SDK Javadoc			                    | - |
+|com.jumio.android:core:3.4.0@aar                    | x | Jumio Core library		                      | 4.10 MB |
+|com.jumio.android:auth:3.4.0@aar                      | x | Authentication library 		              | 89.57 KB |
+|com.jumio.android:face:3.4.0@aar                     | x | Face library	                            | 91.37 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	  | - |
+|com.google.android.material:material:1.0.0           | x | Android material design library	          | - |
+|com.jumio.android:javadoc:3.4.0                     |   | Jumio SDK Javadoc			                    | - |
 
 ### Others
 

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.3.2
+For technical changes, please read our [transition guide](transition-guide_bam-checkout.md) SDK version: 3.4.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.3.2@aar                    | x | Jumio Core library|	4.09 MB |
-|com.jumio.android:bam:3.3.2@aar                     | x | BAM Checkout library | 3.61 MB |
-|androidx.appcompat:appcompat:1.0.2            				| x | Android appcompat library| - |
-|androidx.room:room-runtime:2.0.0			              | x | Android database object mapping library	| - |
-|com.jumio.android:javadoc:3.3.2                     |   | Jumio SDK Javadoc| - |
+|com.jumio.android:core:3.4.0@aar                    | x | Jumio Core library|	4.10 MB |
+|com.jumio.android:bam:3.4.0@aar                     | x | BAM Checkout library | 3.61 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.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.3.2
+For technical changes, please read our [transition guide](transition-guide_document-verification.md) SDK version: 3.4.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.3.2@aar                    | x | Jumio Core library            | 4.09 MB |
-| com.jumio.android:dv:3.3.2@aar                      | x | Document Verification library | 117.90 KB |
-| androidx.appcompat:appcompat:1.0.2                   | x | Android appcompat library        | - |
-|androidx.room:room-runtime:2.0.0			              | x | Android database object mapping library	| - |
-| com.jumio.android:javadoc:3.3.2                     |   | Jumio SDK Javadoc             | - |
+| com.jumio.android:core:3.4.0@aar                    | x | Jumio Core library            | 4.10 MB |
+| com.jumio.android:dv:3.4.0@aar                      | x | Document Verification library | 118.74 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.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_faq.md b/docs/integration_faq.md
@@ -4,6 +4,7 @@
 
 ## Table of Content
 - [Improving user experience and reducing drop-off rate](#improving-user-experience-and-reducing-drop-off-rate)
+- [Managing errors](#managing-errors)
 - [Reducing the size of your app](#reducing-the-size-of-your-app)
   - [Strip unused modules](#strip-unused-modules)
   - [App bundles](#app-bundles)
@@ -28,6 +29,18 @@ Our SDK provides a variety of customization options to help customers achieve a
  - SDK is either customized to have a more embedded appearance or [CustomUI](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_netverify-fastfill.md#custom-ui) is used to create a completely seamless integration in the UX of our customers.
  - Also after the Jumio workflow that shows the displayed results and/or a message that the ID is currently verified, which might take some minutes.
 
+### Managing errors
+Not every error that is returned from the SDK should be treated the same. The error codes listed for [Netverify](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_netverify-fastfill.md#error-codes) should be handled specifically.
+
+The following table highlights the most common error codes which are returned from the SDK and explains how to handle them appropriately in your application.
+
+|Code|Handling|
+|:--------------:|:--------------|
+|A[x][yyyy]| Caused by temporary network issues like a slow connection. Advice to check the signal and retry the SDK journey. |
+|E[x][yyyy]| Flight mode is activated or no connection available. The user should be asked to disable flight mode or to verify if the phone has proper signal. Advice to connect to wifi and retry the SDK journey afterwards. |
+|G[0][0000]| The user pressed back or X to exit the SDK while no error view was presented. Reasons for this could be manyfold. Often it might be due to the fact that the user  didn't have his identity document at hand. Give the user the option to retry. |
+|J[x][yyyy]| The SDK journey was not completed within the session max. lifetime (default 15 min). The user should be informed about the timeout and be directed to start a new Jumio SDK session. |
+
 ### Reducing the size of your app
 The Netverify SDK contains a wide range of different scanning methods. The SDK is able to capture identity documents and extract information on the device using enhanced machine learning and computer vision technologies.
 The current download size of the sample application containing all products is 29 MB as mentioned in the [Netverify guide](integration_netverify-fastfill.md).