Skip to content

Commit

Permalink
Release commit for 4.6.2
Browse files Browse the repository at this point in the history
  • Loading branch information
JumioMobileTeam committed Mar 7, 2024
1 parent 26a9949 commit cf2ccdb
Show file tree
Hide file tree
Showing 66 changed files with 901 additions and 734 deletions.
43 changes: 23 additions & 20 deletions README.md
Expand Up @@ -38,7 +38,7 @@ 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.

![SDK Overview](docs/images/images_overview/overview_android_4.7.0.png)
![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.

Expand Down Expand Up @@ -80,21 +80,24 @@ Once you’ve got the sample application downloaded and unzipped, open Android S

Android Studio will now start to import the project. This might take a bit of time. Make sure to wait until the Gradle Build has finished and the application is properly installed!

The Android sample application contains the package `com.jumio.sample`, which consists of:
* `MainActivity.kt`
* `customui/`
* `CustomUIActivity.kt`
* `adapter/`
* `CustomConsentAdapter.kt`
* `CustomCountryAdapter.kt`
* `CustomDocumentAdapter.kt`
The Android sample application contains the package `com.jumio.sample.kotlin`, which consists of:
* `MainActivity`
* `customui`
* `CustomUIActivity`
* `CustomCountryAdapter`
* `CustomDocumentAdapter`
* `CustomVariantAdapter`

To use the Jumio Sample Application you need an SDK Token. If you haven't done so already, please refer to the [Authentication and Encryption section](#authentication-and-encryption) for more details on how to obtain your SDK token.
To add your individual SDK token to the application copy/paste it to the token input field once the application is started.
Right at the top of the `CustomUiActivity` you’ll find a `companion object` with the following empty parameters:

`const val EXTRA_TOKEN="sdk_token"`
`const val EXTRA_DATACENTER="datacenter"`

If you haven't done so already, please refer to the [Authentication and Encryption section](#authentication-and-encryption) for more details on how to obtain your SDK token. Add your individual SDK token instead of the placeholder. The default setting for the data center is `JumioDataCenter.US`.

⚠️  __Note:__ We strongly recommend not storing any credentials inside your app! We suggest loading them during runtime from your server-side implementation.

Once you start up the sample application, you'll be given the option of trying out the Jumio SDK. The sample application needs camera permissions, which will be prompted for automatically once you try to start the SDK via one of the buttons. If you deny camera permissions, you won't be able to use the SDK.
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.

-----

Expand Down Expand Up @@ -229,10 +232,10 @@ The following Proguard Keep rules have to be added to the Jumio Mobile SDK:
The following Proguard Keep rules have to be added to the Jumio Mobile SDK if the corresponding dependencies have been added:

```text
#Tensorflow
-keep class org.tensorflow.** { *; }
-keep class org.tensorflow.**$* { *; }
-dontwarn org.tensorflow.**
#Microblink
-keep class com.microblink.** { *; }
-keep class com.microblink.**$* { *; }
-dontwarn com.microblink.**
#IProov
-keep public class com.iproov.sdk.IProov {public *; }
Expand All @@ -245,10 +248,6 @@ The following Proguard Keep rules have to be added to the Jumio Mobile SDK if th
-dontwarn okhttp3.**
-dontwarn okio.**
#Datadog
-keep class com.datadog.** { *; }
-keep class com.datadog.**$* { *; }
#JMRTD
-keep class org.jmrtd.** { *; }
-keep class net.sf.scuba.** {*;}
Expand Down Expand Up @@ -325,6 +324,10 @@ To benefit from Datadog, add the following dependency to your `build.gradle` fil
implementation "com.jumio.android:datadog:${SDK_VERSION}"
```

To grant or revoke user consent, please use `JumioSDK.giveDataDogConsent(boolean)` method.

⚠️  __Note:__ The use of the Datadog module is only possible if it is not already included in your application.

----

# Security
Expand Down
32 changes: 1 addition & 31 deletions docs/changelog.md
Expand Up @@ -16,40 +16,10 @@ All notable changes, such as SDK releases, updates and fixes, are documented in
For detailed technical changes please refer to our [Transition Guide](transition_guide.md).

## Support Period
Current SDK version: __4.8.2__
Current SDK version: __4.6.2__

Please refer to our [SDK maintenance and support policy](maintenance_policy.md) for more information about Mobile SDK maintenance and support.

## SDK Version: __4.8.2__
![Improvement] iProov SDK version update to 8.5.2 [Identity Verification]

## SDK Version: __4.8.1__
![Fixes](https://img.shields.io/badge/Fix-success) Removed Location handling to fix potential Google Play Store rejections

## SDK Version: __4.8.0__
![Improvement] Managing Liveness dependencies to help better conversion [Identity Verification]

## SDK Version: __4.7.2__
![Improvement] iProov SDK version update to 8.5.2 [Identity Verification]

## SDK Version: __4.7.1__
![Fixes](https://img.shields.io/badge/Fix-success) Removed Location handling to fix potential Google Play Store rejections

## SDK Version: __4.7.0__
![Improvement] Added support for [CameraX](https://developer.android.com/training/camerax)

![Improvement] Datadog SDK version update to 2.0: Added possibility to have a dedicated Jumio Datadog instance

![Improvement] Improved Jumio Liveness capturing experience [Identity Verification]

![Change] Updated Jumio Liveness module [Identity Verification]

![Change] Removed previous scanning functionalities, now all included in Autocatpure functionality [ID Verification]

![Change] Removed Microblink barcode scanning, switched to MLkit [ID Verification]

![Fix] Fixed Liveness customizaton bug [Identity Verification]

## SDK Version: __4.6.2__
![Improvement] iProov SDK version update to 8.5.2 [Identity Verification]

Expand Down
Binary file added docs/images/images_overview/confirm_screen.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/images_overview/images_overview.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/images_overview/intro_screen.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/images_overview/menu_screen.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
40 changes: 18 additions & 22 deletions docs/integration_faq.md
Expand Up @@ -79,19 +79,21 @@ Depending on your specific needs, you may want to strip out unused functionality

The following table shows a range of different product configurations with the size and modules that are linked for it. These measurements reflect the extra size that Jumio components add to your app download size and are based on our [sample application](../sample/JumioMobileSample/).

| Product Configuration | Size | Modules |
| :------------------------------------------- | :------: | :------------------------------------------------------------------------------------------: |
| Base | 2.67 MB | core |
| Base + iProov | 3.52 MB | core, iproov |
| Base + Autocapture | 4.21 MB | core, docfinder |
| Base + Autocapture, Barcode-Vision | 4.51 MB | core, docfinder, barcode-vision |
| Base + Autocapture, Barcode-Vision, iProov | 5.35 MB | core, docfinder, barcode, iproov |
| Base + Autocapture, Barcode-Vision, Liveness | 6.28 MB | core, docfinder, barcode, liveness |
| Base + Autocapture, Barcode-Vision, NFC | 7.59 MB | core, docfinder, barcode, nfc |
| All (Custom UI only) | 10.33 MB | core, docfinder, barcode-vision, iproov, nfc, devicerisk, digital-identity, camerax,liveness |
| Base + Autocapture, Default UI | 4.60 MB | core, docfinder, default-ui |
| Base + Autocapture, Default UI, Datadog | 5.21 MB | core, docfinder, default-ui, datadog |
| All (with Default UI) | 11.17 MB | core, docfinder, barcode-vision, iproov, nfc, devicerisk, default-ui, datadog, liveness |
| Product Configuration | Size | Modules |
|:--------------------------------------------|:--------:|:-----------------------------------------------------------------------------------------------------------------:|
| Base | 2.68 MB | core |
| Base + iProov | 3.51 MB | core, iproov |
| Base + MRZ | 4.19 MB | core, mrz |
| Base + MRZ, Linefinder | 4.57 MB | core, mrz, linefinder |
| Base + MRZ, Linefinder, Barcode | 5.62 MB | core, mrz, linefinder, barcode |
| Base + MRZ, Linefinder, Barcode-Vision | 4.89 MB | core, mrz, linefinder, barcode-vision |
| Base + MRZ, Linefinder, Barcode, iProov | 6.45 MB | core, mrz, linefinder, barcode, iproov |
| Base + MRZ, Linefinder, Barcode, Liveness | 8.93 MB | core, mrz, linefinder, barcode, liveness |
| Base + MRZ, Linefinder, Barcode, NFC | 7.26 MB | core, mrz, linefinder, barcode, nfc |
| All (Custom UI only) | 13.07 MB | core, mrz, linefinder, barcode, barcode-vision, iproov, nfc, docfinder, devicerisk, liveness |
| Base + MRZ, Linefinder, Default UI | 4.92 MB | core, mrz, linefinder, default-ui |
| Base + MRZ, Linefinder, Default UI, DataDog | 5.09 MB | core, mrz, linefinder, default-ui, datadog |
| All (with Default UI) | 13.58 MB | core, mrz, linefinder, barcode, barcode-vision, iproov, nfc, docfinder, devicerisk, default-ui, datadog, liveness |

__Note:__ The size values in the table above depict the decompressed install size required on a device and are comparable to the estimated Play Store files size. The size value might vary by a few percent, depending on the actual device used. All sizes are calculated based on a build of our sample application using arm64 architecture, english translations and xxhdpi screen resolution.

Expand Down Expand Up @@ -214,23 +216,17 @@ Combines all previously existing scanning methods into one automatic, seamless e

![Autocapture Success](images/capturing_methods/autocapture_01.jpg) ![Autocapture Scanning](images/capturing_methods/autocapture_02.jpg)

#### Linefinder (deprecated)
***As of SDK version 4.7.0 this module has been deprecated. Please use [Autocapture](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_faq.md#autocapture)
instead.***
#### Linefinder
Scanning using edge detection.

![Linefinder Empty](images/capturing_methods/linefinder_scanning_01.jpg) ![Linefinder Document](images/capturing_methods/linefinder_scanning_02.jpg) ![Linefinder Processing](images/capturing_methods/linefinder_scanning_03.jpg)

#### MRZ (deprecated)
***As of SDK version 4.7.0 this module has been deprecated. Please use [Autocapture](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_faq.md#autocapture)
instead.***
#### MRZ
Data extraction from passports, some identity cards and some visas.

![MRZ Empty](images/capturing_methods/mrz_scanning_01.jpg) ![MRZ Document](images/capturing_methods/mrz_scanning_02.jpg)

#### Barcode (deprecated)
***As of SDK version 4.7.0 this module has been deprecated. Please use [Autocapture](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_faq.md#autocapture)
instead.***
#### Barcode
PDF417 barcode data extraction, for example from US and Canadian driver licenses.

![Barcode Empty](images/capturing_methods/barcode_scanning_01.jpg) ![Barcode Document](images/capturing_methods/barcode_scanning_02.jpg)
Expand Down

0 comments on commit cf2ccdb

Please sign in to comment.