Release commit for 3.2.0

Jumio · Jun 4, 2019 · 0a11a19 · 0a11a19
1 parent cad38bf
commit 0a11a19
Show file tree

Hide file tree

Showing 38 changed files with 1,296 additions and 592 deletions.
diff --git a/README.md b/README.md
@@ -8,13 +8,20 @@
 - [FAQ](docs/integration_faq.md)
 
 # Release notes
-SDK version: 3.1.0
+SDK version: 3.2.0
 
 #### Changes
-* Optimized 3D liveness handling to reduce number of false rejects [Netverify]
-* Improved reading of ePassports [Netverify]
+* Added support for [Jumio screening](https://www.jumio.com/screening/)  [Netverify]
+* 3D Liveness improvements [Netverify, Authentication]
+  * Improved face models to increase conversion rate
+  * Better UX by accepting faces even if they are not perfectly aligned with the overlay
+  * Better user guidance in error cases (bad lighting, bad angle)
+  * Return face help animations in Custom UI [Netverify]
+* Added ePassport support to Custom UI [Netverify]
+* Added additional customization options to scan overlay/view [Netverify/Fastfill]
 
 #### Fixes
+* Fixed capture problem of Spanish resident permits [Netverify/Fastfill]
 * Various smaller bug fixes/improvements [Netverify/Fastfill, Authentication, Document Verification, BAM Checkout]
 
 # Basic Setup
@@ -120,7 +127,7 @@ Our SDK supports accessibility features. Visually impaired users can now enable
 # Support
 
 ## Previous version
-The previous release version 3.0.0 of the Jumio Mobile SDK is supported until 2019-07-18.
+The previous release version 3.1.0 of the Jumio Mobile SDK is supported until 2019-08-05.
 
 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).
 

diff --git a/docs/integration_authentication.md b/docs/integration_authentication.md
@@ -8,14 +8,14 @@ Biometric-based Jumio Authentication establishes the digital identities of your
 - [Release notes](#release-notes)
 - [Setup](#setup)
 - [Dependencies](#dependencies)
-- [Initialization](#integration)
+- [Initialization](#initialization)
 - [Customization](#customization)
 - [SDK Workflow](#sdk-workflow)
 - [Custom UI](#custom-ui)
 - [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.1.0
+For technical changes, please read our [transition guide](transition-guide_authentication.md) SDK version: 3.2.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.1.0@aar                    | x | Jumio Core library		                      | 4.64 MB |
-|com.jumio.android:auth:3.1.0@aar                      | x | Authentication library 		              | 82.59 KB |
-|com.jumio.android:face:3.1.0@aar                     | x | Face library	                            | 83.58 KB |
-|com.facetec:zoom-authentication-hybrid:7.0.9@aar     | x | Zoom face scanning library	              | 12.1 MB  |
-|androidx.appcompat:appcompat:1.0.0                   | x | Android appcompat library	                | - |
+|com.jumio.android:core:3.2.0@aar                    | x | Jumio Core library		                      | 4.65 MB |
+|com.jumio.android:auth:3.2.0@aar                      | x | Authentication library 		              | 86.33 KB |
+|com.jumio.android:face:3.2.0@aar                     | x | Face library	                            | 84.23 KB |
+|com.facetec:zoom-authentication-hybrid:7.0.12@aar     | x | Zoom face scanning library	              | 11.79 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.1.0                     |   | Jumio SDK Javadoc			                    | - |
+|com.jumio.android:javadoc:3.2.0                     |   | Jumio SDK Javadoc			                    | - |
 
 ### Others
 
@@ -195,11 +195,11 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 
 |Code        			| Message  | Description      |
 | :--------------:|:---------|:-----------------|
-|A10000| We have encountered a network communication problem | Retry possible, user decided to cancel |
-|B10000| Authentication failed | Secure connection could not be established, retry impossible |
-|C10401| Authentication failed | API credentials invalid, retry impossible |
-|D10403| Authentication failed | Wrong API credentials used, retry impossible|
-|E20000| No Internet connection available | Retry possible, user decided to cancel |
+|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 |
 |H00000| The camera is currently not available | Camera cannot be initialized, retry impossible |
@@ -208,7 +208,7 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 |L00000| Enrollment transaction reference invalid | The provided enrollment transaction reference can not be used for an authentication |
 |M00000| The scan could not be processed | An error happened during the processing. The SDK needs to be started again|
 
-The first letter (A-M) represents the error case. The remaining characters are represented by numbers that contain information helping us understand the problem situation. Please always include the whole code when filing an error related issue to our support team.
+The first letter (A-M) represents the error case. The remaining characters are represented by numbers that contain information helping us understand the problem situation([x][yyyy]). Please always include the whole code when filing an error related issue to our support team.
 
 ## Custom UI
 Authentication 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.
@@ -246,6 +246,4 @@ After handling the result, it is very important to clean up the SDK by calling
 
 ## Callback
 
-To get information about callbacks, please read our [page with server related information](https://github.com/Jumio/implementation-guides/blob/master/netverify/callback.md).
-
-__Note:__ Callbacks for Authentication will be available later in March 2019, please check availability with your Account Manager.
+To get information about callbacks, please read our [page with server related information](https://github.com/Jumio/implementation-guides/blob/master/netverify/callback.md#callback-for-authentication).
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.1.0
+For technical changes, please read our [transition guide](transition-guide_bam-checkout.md) SDK version: 3.2.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.1.0@aar                    | x | Jumio Core library|	4.64 MB |
-|com.jumio.android:bam:3.1.0@aar                     | x | BAM Checkout library | 2.02 MB |
-|androidx.appcompat:appcompat:1.0.0            				| x | Android appcompat library| - |
+|com.jumio.android:core:3.2.0@aar                    | x | Jumio Core library|	4.65 MB |
+|com.jumio.android:bam:3.2.0@aar                     | x | BAM Checkout library | 2.02 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.1.0                     |   | Jumio SDK Javadoc| - |
+|com.jumio.android:javadoc:3.2.0                     |   | Jumio SDK Javadoc| - |
 
 If an optional module is not linked, the scan method is not available but the library size is reduced.
 
@@ -306,9 +306,9 @@ public void onBamError(String errorCode, String errorMessage, boolean retryPossi
 
 | Code        			| Message   | Description     |
 | :---------------: |:----------|:----------------|
-|B10000| Authentication failed | Secure connection could not be established, retry impossible |
-|C10401| Authentication failed | API credentials invalid, retry impossible |
-|D10403| Authentication failed | Wrong API credentials used, retry impossible|
+|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|
 |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 |
 |H00000| The camera is currently not available | Camera cannot be initialized, retry impossible |
@@ -317,6 +317,8 @@ public void onBamError(String errorCode, String errorMessage, boolean retryPossi
 |M00000| Background execution is not supported | Cancellation triggered automatically |
 |N00000| Your card is expired | Retry possible |
 
+The first letter (B-N) represents the error case. The remaining characters are represented by numbers that contain information helping us understand the problem situation([x][yyyy]). Please always include the whole code when filing an error related issue to our support team.
+
 ## Card retrieval API
 
 You can implement RESTful HTTP GET APIs to retrieve credit card image and data for a specific scan. Find the Implementation Guide at the link below.

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.1.0
+For technical changes, please read our [transition guide](transition-guide_document_verification.md) SDK version: 3.2.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.1.0@aar                    | x | Jumio Core library            | 4.64 MB |
-| com.jumio.android:dv:3.1.0@aar                      | x | Document Verification library | 115.54 |
-| androidx.appcompat:appcompat:1.0.0                   | x | Android appcompat library        | - |
+| com.jumio.android:core:3.2.0@aar                    | x | Jumio Core library            | 4.65 MB |
+| com.jumio.android:dv:3.2.0@aar                      | x | Document Verification library | 115.55 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.1.0                     |   | Jumio SDK Javadoc             | - |
+| com.jumio.android:javadoc:3.2.0                     |   | Jumio SDK Javadoc             | - |
 
 If an optional module is not linked, the scan method is not available but the library size is reduced.
 
@@ -233,16 +233,18 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
 
 |Code        			| Message   | Description    |
 | :--------------:|:----------|:---------------|
-|A10000| We have encountered a network communication problem | Retry possible, user decided to cancel |
-|B10000| Authentication failed | Secure connection could not be established, retry impossible |
-|C10401| Authentication failed | API credentials invalid, retry impossible |
-|D10403| Authentication failed | Wrong API credentials used, retry impossible|
-|E20000| No Internet connection available | Retry possible, user decided to cancel |
+|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 |
 |H00000| The camera is currently not available | Camera cannot be initialized, retry impossible |
 |I00000| Certificate not valid anymore. Please update your application | End-to-end encryption key not valid anymore, retry impossible |
 |K10400| Unsupported document code defined. Please contact Jumio support | An unsupported document code has been set, retry impossible |
 
+The first letter (A-K) represents the error case. The remaining characters are represented by numbers that contain information helping us understand the problem situation([x][yyyy]). Please always include the whole code when filing an error related issue to our support team.
+
 ## 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](https://github.com/Jumio/implementation-guides/blob/master/netverify/callback.md).
diff --git a/docs/integration_faq.md b/docs/integration_faq.md
@@ -8,7 +8,7 @@
 - [App bundles](#app-bundles)
 - [Architectures - ABI filters & Splitting](#arch)
 
-### Reducing the size of your app
+#### 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 27 MB as mentioned in the [Netverify guide](integration_netverify-fastfill.md).
 If you want to reduce the size of the SDK within your application, there are several ways that are explained in the following chapters.