-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7361986
commit e2bc37c
Showing
113 changed files
with
1,723 additions
and
14,009 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,6 @@ | |
| # FAQ | ||
|
|
||
| ## Table of Contents | ||
| - [User Consent](#user-consent) | ||
| - [Improve User Experience and Reduce Drop-off Rate](#improve-user-experience-and-reduce-drop-off-rate) | ||
| - [Managing Errors](#managing-errors) | ||
| - [Ad Blockers or Firewall](#ad-blockers-or-firewall) | ||
|
|
@@ -21,18 +20,8 @@ | |
| - [Java 8 Compatibility](#Java-8-compatibility) | ||
| - [Overview of Scanning Methods](overview-of-scanning-methods) | ||
| - [Glossary of Commonly Used Abbreviations](#glossary) | ||
| - [Google Play Store Prominent Disclosure](#google-play-store-prominent-disclosure) | ||
| - [Jumio Support](#jumio-support) | ||
|
|
||
| ## User Consent | ||
| User consent is now acquired for all users to ensure the accordance with biometric data protection laws. Depending on the legal requirements, consent can be acquired in one of two ways: __Active__ or __passive__. | ||
|
|
||
| For __active__ consent instances, the user needs to accept the consent items explicitly, e.g. by enabling a UI switch or checking a checkbox for each consent item. For __passive__ consent instances, it is enough to present the consent text and URL to the user. The user implicitly accepts the passive consent items by continuing with the journey. | ||
|
|
||
| <img src="images/consent/consent_passive.jpg" alt="Acquiring passive user consent"> | ||
| <img src="images/consent/consent_active_unchecked.jpg" alt="Acquiring active user consent"> | ||
| <img src="images/consent/consent_active_checked.jpg" alt="Acquired active user consent"> | ||
|
|
||
| ## Improve User Experience and Reduce Drop-off Rate | ||
| When evaluating user flows, one of the most commonly used metrics is the rate of drop-offs. At Jumio, we see considerable variance in drop-off rates across industries and customer implementations. For some implementations and industries, we see a higher rate of drop-offs on the first screens when compared with the average. | ||
| Scanning an ID with sensitive personal data printed on it naturally creates a high barrier for participation on the part of the end user. Therefore, conversion rates can be significantly influenced when the application establishes a sense of trust and ensures that users feel secure sharing their information. | ||
|
|
@@ -56,12 +45,12 @@ Not every error that is returned from the SDK should be treated the same. The er | |
|
|
||
| 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 | Cause | Recommended Handling | | ||
| |:-----------:|:---------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | A[xx][yyyy] | Caused by temporary network issues like a slow connection. | Advise to check the signal and retry the SDK journey. | | ||
| | E[xx][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. Advise to connect to WIFI and retry the SDK journey afterwards. | | ||
| | G[xx][0000] | The user pressed back or X to exit the SDK while no error view was presented. | Reasons for this could be manifold. 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[xx][yyyy] | The SDK journey was not completed within the session's max. lifetime. (The default is 15 minutes.) | The user should be informed about the timeout and be directed to start a new Jumio SDK session. | | ||
| |Code | Cause | Recommended Handling | | ||
| |:---:|:------|:---------------------| | ||
| | A[x][yyyy] | Caused by temporary network issues like a slow connection. | Advise 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. Advise 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's max. lifetime. (The default is 15 minutes.) | The user should be informed about the timeout and be directed to start a new Jumio SDK session. | | ||
|
|
||
| ### Ad Blockers or Firewall | ||
| End users might face the situation where they are connected to a network that can't reach our Jumio endpoints. | ||
|
|
@@ -79,19 +68,20 @@ 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 | 1.78 MB | core | | ||
| | Base + Liveness | 2.23 MB | core, iproov | | ||
| | Base + MRZ | 3.15 MB | core, mrz | | ||
| | Base + MRZ, Linefinder | 3.42 MB | core, mrz, linefinder | | ||
| | Base + MRZ, Linefinder, Barcode | 4.47 MB | core, mrz, linefinder, barcode | | ||
| | Base + MRZ, Linefinder, Barcode-Vision | 3.72 MB | core, mrz, linefinder, barcode-vision | | ||
| | Base + MRZ, Linefinder, Barcode, Liveness | 4.91 MB | core, mrz, linefinder, barcode, iproov | | ||
| | Base + MRZ, Linefinder, Barcode, NFC | 6.02 MB | core, mrz, linefinder, barcode, nfc | | ||
| | All (Custom UI only) | 12.30 MB | core, mrz, linefinder, barcode, barcode-vision, iproov, nfc, docfinder, devicerisk | | ||
| | Base + MRZ, Linefinder, Default UI | 3.84 MB | core, mrz, linefinder, default-ui | | ||
| | Base + MRZ, Linefinder, Default UI, DataDog | 4.34 MB | core, mrz, linefinder, default-ui, datadog | | ||
| | All (with Default UI) | 13.13 MB | core, mrz, linefinder, barcode, barcode-vision, iproov, nfc, docfinder, devicerisk, default-ui, datadog | | ||
|
|
||
| __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. | ||
|
|
||
|
|
@@ -114,7 +104,7 @@ defaultConfig { | |
| } | ||
| ``` | ||
|
|
||
| It's also possible to manually provide a split apk on Google Play. The apk can be split based on the architecture if multiple apks should be uploaded to the Google Play Store. Google Play Store manages to deliver the appropriate apk for the device. | ||
| It's also possible to manually provide a splitted apk on Google Play. The apk can be split based on the architecture if multiple apks should be uploaded to the Google Play Store. Google Play Store manages to deliver the appropriate apk for the device. | ||
| ``` | ||
| splits { | ||
| abi { | ||
|
|
@@ -209,28 +199,17 @@ android { | |
|
|
||
| ## Overview of Scanning Methods | ||
|
|
||
| #### Autocapture | ||
| Combines all previously existing scanning methods into one automatic, seamless experience. | ||
|
|
||
|   | ||
|
|
||
| #### 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. | ||
|
|
||
|    | ||
|
|
||
| #### 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. | ||
|
|
||
|   | ||
|
|
||
| #### 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. | ||
|
|
||
|   | ||
|
|
@@ -248,8 +227,5 @@ Data extraction from eMRTD documents, for example passports. | |
| ## Glossary | ||
| A [quick guide to commonly used abbreviations](integration_glossary.md) throughout the documentation which may not be all that familiar. | ||
|
|
||
| ## Google Play Store Prominent Disclosure | ||
| Some parts of the SDK might require prominent disclosure - please see the [Privacy Notice](integration_guide.md#privacy-notice) section in the Integration Guide for further details | ||
|
|
||
| ## Jumio Support | ||
| The Jumio development team is constantly striving to optimize the size of our frameworks while increasing functionality, to improve your KYC and to fight fraud. If you have any further questions, please reach out to our [support team](mailto:[email protected]). | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.