Skip to content

Commit

Permalink
Release commit for 4.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@JumioMobileTeam
JumioMobileTeam committed Jun 5, 2023
1 parent 1496f2a commit 6f85b92
Show file tree
Hide file tree
Showing 82 changed files with 3,164 additions and 1,201 deletions.
11 changes: 6 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ Once you start up the sample application, you'll be given the option of trying o

## General Requirements
⚠️  __Android Deprecation Notice__
Please be aware that SDK 4.3.0 does not support Android 4.4 (API level 19) anymore.
Please be aware that the upcoming SDK 4.7.0 will be the last SDK version supporting Android 5.0 (API level 21).
All subsequent SDK versions will require at least Android 6.0 "Marshmallow" (API level 23).

The minimum requirements for the SDK are:
* Android 5.0 "Lollipop" (API level 21) or higher
Expand All @@ -123,9 +124,9 @@ You will need a __commercial Jumio License__ to run any of our examples. For det
## Authentication and Encryption
ℹ️  __As of version 4.0.0 and onward, the SDK can only be used in combination with Jumio KYX. 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://jumio.github.io/kyx/integration-guide.html) for further details. To authenticate against the API calls, an OAuth2 access token needs to be retrieved from the Customer Portal.
Before starting a session in our SDK, an SDK token has to be obtained. Please refer to out [API Guide](https://docs.jumio.com/production/Content/Integration/Integration%20Guide.htm) 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://jumio.github.io/kyx/integration-guide.html#account-creation) or [Account Update](https://jumio.github.io/kyx/integration-guide.html#account-update) API, a SDK token is returned, which needs to be applied to initiate the mobile SDK.
Within the response of the [Account Creation or Account Update](https://docs.jumio.com/production/Content/Integration/Creating%20or%20Updatng%20Account/Creating%20or%20Updating%20Accounts.htm) API, a SDK token is returned, which needs to be applied to initiate the mobile SDK.

### Basic Authentication (Deprecated)
Previously, Basic Auth credentials were constructed using your API token as the User ID and your API secret as the password. You still can manage API token and secret in the Customer Portal under:
Expand All @@ -142,7 +143,7 @@ Client ID and Client secret are used to generate an OAuth2 access token. OAuth2
* EU: `https://auth.emea-1.jumio.ai/oauth2/token`
* SG: `https://auth.apac-1.jumio.ai/oauth2/token`

The [TLS Protocol](https://tools.ietf.org/html/rfc5246) is required to securely transmit your data, and we strongly recommend using the latest version. For information on cipher suites supported by Jumio during the TLS handshake see [supported cipher suites](https://github.com/Jumio/implementation-guides/blob/master/netverify/supported-cipher-suites.md).
The [TLS Protocol](https://tools.ietf.org/html/rfc5246) is required to securely transmit your data, and we strongly recommend using the latest version. For information on cipher suites supported by Jumio during the TLS handshake see [supported cipher suites](https://docs.jumio.com/production/Content/Integration/API%20Authorization/Supported%20Cipher%20Suites.htm?Highlight=cipher).

ℹ️  __Note:__ Calls with missing, incorrect or suspicious headers or parameter values will result in HTTP status code __400 Bad Request Error__ or __403 Forbidden__.

Expand Down Expand Up @@ -170,7 +171,7 @@ curl --request POST --location 'https://auth.amer-1.jumio.ai/oauth2/token' \
Your OAuth2 access token is valid for 60 minutes. After the token lifetime is expired, it is necessary to generate a new access token.

### Workflow Transaction Token Timeout
The token lifetime is set to 30 minutes per default. It can be configured via the [Jumio Customer Portal](https://github.com/Jumio/implementation-guides/blob/master/netverify/portal-settings.md) and can be overwritten using the API call (`tokenLifetime`). Within this token lifetime the token can be used to initialize the SDK.
The token lifetime is set to 30 minutes per default. It can be configured via the [Jumio Customer Portal](https://docs.jumio.com/production/Content/Settings/Identity%20Verification/Application%20Settings.htm) and can be overwritten using the API call (`tokenLifetime`). Within this token lifetime the token can be used to initialize the SDK.

As soon as the workflow (transaction) starts, a 15 minutes session timeout is triggered. For each action performed (capture image, upload image) the session timeout will reset, and the 15 minutes will start again.

Expand Down
7 changes: 6 additions & 1 deletion docs/changelog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,15 @@ 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.5.0__
Current SDK version: __4.6.0__

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

## SDK Version: __4.6.0__
![Improvement] Added Jumio Liveness module to enhance the Liveness user experience and interface (Identity Verification)

![Improvement] Improved Liveness customization options (Identity Verification)

## SDK Version: __4.5.0__
![Improvement] Added possibility for users to verify their identity using [Digital Identity](../README.md#digital-identity) [ID Verification, Identity Verification]

Expand Down
29 changes: 15 additions & 14 deletions docs/integration_faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,20 +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.58 MB | core |
| Base + Liveness | 3.50 MB | core, iproov |
| Base + MRZ | 4.10 MB | core, mrz |
| Base + MRZ, Linefinder | 4.48 MB | core, mrz, linefinder |
| Base + MRZ, Linefinder, Barcode | 5.53 MB | core, mrz, linefinder, barcode |
| Base + MRZ, Linefinder, Barcode-Vision | 4.80 MB | core, mrz, linefinder, barcode-vision |
| Base + MRZ, Linefinder, Barcode, Liveness | 6.44 MB | core, mrz, linefinder, barcode, iproov |
| Base + MRZ, Linefinder, Barcode, NFC | 7.17 MB | core, mrz, linefinder, barcode, nfc |
| All (Custom UI only) | 9.87 MB | core, mrz, linefinder, barcode, barcode-vision, iproov, nfc, docfinder, devicerisk |
| Base + MRZ, Linefinder, Default UI | 4.89 MB | core, mrz, linefinder, default-ui |
| Base + MRZ, Linefinder, Default UI, DataDog | 5.35 MB | core, mrz, linefinder, default-ui, datadog |
| All (with Default UI) | 10.57 MB | core, mrz, linefinder, barcode, barcode-vision, iproov, nfc, docfinder, devicerisk, default-ui, datadog |
| 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

0 comments on commit 6f85b92

Please sign in to comment.