Release commit for 4.2.0

README.md

@@ -1,17 +1,15 @@
-![Jumio](docs/images/jumio_feature_graphic.jpg)
+![Header Graphic](docs/images/jumio_feature_graphic.jpg)
 
 [![Version](https://img.shields.io/github/v/release/Jumio/mobile-sdk-android?style=flat)](#release-notes)
 [![License](https://img.shields.io/badge/license-commercial-3D3D3D?style=flat)](#copyright)
 [![Platform](https://img.shields.io/badge/platform-Android-lightgrey?style=flat)](#general-requirements)
-[![Maven](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fmobile-sdk.jumio.com%2Fcom%2Fjumio%2Fandroid%2Fcore%2Fmaven-metadata.xml?style=flat)](#integration)
+[![Maven](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.mobile.jumio.ai%2Fcom%2Fjumio%2Fandroid%2Fcore%2Fmaven-metadata.xml?style=flat)](#integration)
 [![API Level](http://img.shields.io/badge/API%20Level-19+-orange?style=flat)](#general-requirements)
 
 # Table of Contents
 - [Overview](#overview)
 - [Get Started](#get-started)
-    - [ID Verification](docs/integration_guide.md)
-    - [Authentication SDK](https://github.com/Jumio/mobile-sdk-android/blob/v3.9.2/docs/integration_authentication.md)
-    - [Document Verification SDK](https://github.com/Jumio/mobile-sdk-android/blob/v3.9.2/docs/integration_document-verification.md)
+    -  [Jumio SDK Integration](docs/integration_guide.md)
 - [Quickstart](#quickstart)
 - [Basics](#basics)
     - [General Requirements](#general-requirements)
@@ -33,29 +31,29 @@ The Jumio Software Development Kit (SDK) provides you with a set of tools and UI
 
 Onboard new users and easily verify their digital identities by making sure the IDs they provide are valid and authentic. Extract data from ID documents completely automatically and within seconds. Confirm that users really are who they say they are by having them take a quick selfie and match it to their respective documents. Jumio uses cutting-edge biometric technology such as 3D face mapping to make sure there is an actual, real-life person in front of the screen.
 
-![Menu Screen](docs/images/images_overview/menu_screen.jpg)  ![Scan Screen](docs/images/images_overview/intro_screen.jpg)  ![Confirm Screen](docs/images/images_overview/confirm_screen.jpg)
+![SDK Overview](docs/images/images_overview/images_overview.png)
 
 Using the Jumio SDK will allow you to create the best possible solution for your individual needs, providing you with a range of different services to choose from.
 
+-----
+
 # Get Started
 Please note that [basic setup](#basics) is required before continuing with the integration of any of the following services.
 
-## ID Verification
-ID Verification (formerly known as Netverify) is a secure and easy solution that allows you to establish the genuine identity of your users in your mobile application by verifying their passports and other government-issued IDs in real time. Very user-friendly and highly customizable, it makes onboarding new customers quick and simple.
-
-- [Jumio Mobile SDK](docs/integration_guide.md)
+## Jumio SDK Integration
+Jumio KYX platform and related services are a secure and easy solution that allows you to establish the genuine identity of your users in your mobile application, by verifying their passports, government-issued IDs and actual liveness in real-time. Very user-friendly and highly customizable, it makes onboarding new customers quick and simple.
 
-## Jumio Authentication
-Authentication is a cutting-edge biometric-based service that establishes digital identities of your users, simply by taking a selfie. Advanced 3D face mapping-technology quickly and securely authenticates users and their digital identities.
+:arrow_right:  [SDK INTEGRATION GUIDE](docs/integration_guide.md)    
+:arrow_right:  [Changelog](docs/changelog.md)   
+:arrow_right:  [Transition Guide](docs/transition_guide.md)   
 
-- [Integration Authentication SDK (3.9.0, deprecated)](https://github.com/Jumio/mobile-sdk-android/blob/v3.9.0/docs/integration_authentication.md)
-- [Transition Guide Authentication SDK (3.9.0, deprecated)](https://github.com/Jumio/mobile-sdk-android/blob/v3.9.0/docs/transition-guide_authentication.md)
+#### Previous SDK Versions
+If you need information on older SDK versions, please refer to:    
+- [3.9.2](https://github.com/Jumio/mobile-sdk-android/tree/v3.9.2)
+- [3.9.1](https://github.com/Jumio/mobile-sdk-android/tree/v3.9.1)
+- [3.9.0](https://github.com/Jumio/mobile-sdk-android/tree/v3.9.0)
 
-## Jumio Document Verification
-Document Verification is a powerful solution that allows users to scan various types of documents quickly and easily in your mobile application. Data extraction is already supported for various document types, such as bank statements.
-
-- [Integration Document Verification SDK (3.9.2, deprecated)](https://github.com/Jumio/mobile-sdk-android/blob/v3.9.2/docs/integration_document-verification.md)
-- [Transition Guide Document Verification SDK (3.9.2, deprecated)](https://github.com/Jumio/mobile-sdk-android/blob/v3.9.2/docs/transition-guide_document-verification.md)
+-----
 
 # Quickstart
 This section provides a quick overview on how to get started with the [Android sample application](sample) that can be found here on Github. You will need a __commercial Jumio License__ to successfully run any of our examples; for details, contact sales@jumio.com. You will also need an up-to-date Android Studio version to open and try out the sample project.
@@ -85,15 +83,18 @@ If you haven't done so already, please refer to the [Authentication and Encrypti
 
 Once you start up the sample application, you'll be given the option of trying out the Jumio SDK. Click the hamburger menu in the top left corner to choose a service. Your application will also need camera permissions, which will be prompted for automatically once you try to start any of the services. If you deny camera permissions, you won't be able to use any of the services.
 
+-----
+
 # Basics
 
 ## General Requirements
 ⚠️  __Android Deprecation Notice__  
-Please be aware that SDK 4.1.0 will be the last SDK version supporting Android 4.4 (API level 19). All subsequent SDK versions will require at least Android 5.0 "Lollipop" (API level 21).
+Please be aware that SDK 4.2.0 will be the last SDK version supporting Android 4.4 (API level 19). All subsequent SDK versions will require at least Android 5.0 "Lollipop" (API level 21).
 
 The minimum requirements for the SDK are:
-*	Android 4.4 (API level 19) or higher
-*	Internet connection
+* Android 4.4 (API level 19) or higher
+* Internet connection
+* Jumio KYX or Jumio API v3
 
 The following architectures are supported in the SDK:
 *	ARMv7 processor with Neon
@@ -104,6 +105,8 @@ The following architectures are supported in the SDK:
 You will need a __commercial Jumio License__ to run any of our examples. For details, contact sales@jumio.com.
 
 ## Authentication and Encryption
+ℹ️  __As of version 4.0.0 and onward, the SDK can only be used in combination with Jumio KYX or Jumio API v3. API v2 as well as using API token and secret to authenticate against the SDK will no longer be compatible.__
+
 Before starting a session in our SDK, an SDK token has to be obtained. Please refer to out [API Guide](https://github.com/Jumio/implementation-guides/blob/master/api-guide/api_guide.md) for further details. To authenticate against the API calls, an OAuth2 access token needs to be retrieved from the Customer Portal.
 
 Within the response of the [Account Creation](https://github.com/Jumio/implementation-guides/blob/master/api-guide/api_guide.md#account-creation) or [Account Update](https://github.com/Jumio/implementation-guides/blob/master/api-guide/api_guide.md#account-update) API, a SDK token is returned, which needs to be applied to initiate the mobile SDK.
@@ -181,7 +184,7 @@ repositories {
 	exclusiveContent {
 		forRepository {
 			maven {
-				url 'https://mobile-sdk.jumio.com'
+				url 'https://repo.mobile.jumio.ai'
 			}
 		}
 		filter {
@@ -238,16 +241,20 @@ To grant or revoke user consent, please use `JumioSDK.giveDataDogConsent(boolean
 
 ⚠️  __Note:__ The use of the Datadog module is only possible if it is not already included in your application.
 
+----
+
 # Security
 All SDK related traffic is sent over HTTPS using TLS and public key pinning. Additionally, the information itself within the transmission is also encrypted utilizing __Application Layer Encryption__ (ALE). ALE is a Jumio custom-designed security protocol that utilizes RSA-OAEP and AES-256 to ensure that the data cannot be read or manipulated even if the traffic was captured.
 
+----
+
 # Release Notes
 See our [Change Log](docs/changelog.md) for more information about our current SDK version and further details.
 
 # Support
 
 ## Previous Version
-The previous release version 4.0.0 of the Jumio Mobile SDK is supported until 2022-06-07.
+The previous release version 4.1.0 of the Jumio Mobile SDK is supported until 2022-08-27.
 
 When the support period has expired, bug fixes and technical support will no longer be provided. Current bugs are typically fixed in the upcoming versions. __Older SDK versions will keep functioning with our server until further notice,__ but we highly recommend that you always update to the latest version to benefit from SDK improvements and bug fixes.