)
- }
-}
```
-
-[`SCAN_VIEW`][scanview] points out that a [`JumioScanView`][jumioscanview] needs to be attached to the [`JumioScanPart`][jumioscanpart]. The [`JumioScanView`][jumioscanview] is a custom view that can be placed in your layout. During runtime it just needs to be attached to the [`JumioScanPart`][jumioscanpart].
-
-```kotlin
-JumioScanStep.SCAN_VIEW -> {
- currentScanPart?.let {
- jumioScanView.attach(it)
- }
-}
-```
-
-[`IMAGE_TAKEN`][imagetaken] is triggered as soon as the image is taken and has been uploaded to the Jumio server. The camera preview is stopped during that step if no additional part needs to be scanned. Otherwise [`NEXT_PART`][nextpart] will be triggered with additional information on which part has to be scanned next.
-
-When background processing is executed, [`JumioScanStep.PROCESSING`][processing] is triggered.
-
-If images for confirmation or rejection need to be displayed then [`JumioScanStep.CONFIRMATION_VIEW`][confirmationview] or [`JumioScanStep.REJECT_VIEW`][rejectview] is triggered. Simply attach the [`JumioConfirmationHandler`][jumioconfirmationhandler] or [`JumioRejectHandler`][jumiorejecthandler] once the steps are triggered and render the available [`JumioCredentialParts`][jumiocredentialpart] in [`JumioConfirmationView`][jumioconfirmationview] or [`JumioRejectView`][jumiorejectview] objects:
-
-```kotlin
JumioScanStep.CONFIRMATION_VIEW -> {
- val confirmationHandler = ConfirmationHandler()
- confirmationHandler.attach(scanPart)
- confirmationHandler.parts.forEach {
- val confirmationView = JumioConfirmationView(context)
- confirmationHandler.renderPart(it, confirmationView)
- ...
- }
+ confirmationView.setVisibility(View.VISIBLE)
+ confirmationView.attach(scanPart!!)
}
JumioScanStep.REJECT_VIEW -> {
- val rejectHandler = RejectHandler()
- rejectHandler.attach(scanPart)
- rejectHandler.parts.forEach {
- val rejectView = JumioRejectView(context)
- rejectHandler.renderPart(it, rejectView)
- ...
- }
-}
-```
-
-The scan part can be confirmed by calling [`confirmationView.confirm()`][confirm] or retaken by calling [`confirmationView.retake()`][retakeconfirmation] or [`rejectView.retake()`][retakereject].
-
-The retry scan step returns a data object of type [`JumioRetryReason`][jumioretryreason]. On [`RETRY`][retry], a retry should be triggered on the scan part.
-
-```kotlin
-JumioScanStep.RETRY -> {
- val reason = data as? JumioRetryReason ?: return
-
- val retryCode = reason.code
- val retryMessage = reason.message
- ...
-
- currentScanPart?.retry(reason)
+ rejectView.setVisibility(View.VISIBLE)
+ rejectView.attach(scanPart!!)
}
```
+The scan part can be confirmed by calling `confirmationView.confirm()` or retaken by calling `confirmationView.retake()` or `rejectView.retake()`
-For possible retry codes please checkout [`JumioRetryReasonGeneric`][jumioretrygeneric], [`JumioRetryReasonDocumentVerification`][jumioretrydv], [`JumioRetryReasonNfc`][jumioretrynfc], [`JumioRetryReasonIproov`][jumioretryiproov] and [`JumioRetryReasonDigitalIdentity`][jumioretrydi].
-
-[`DIGITAL_IDENTITY_VIEW`][digitalidentityview] points out that the current [`JumioScanPart`][jumioscanpart] needs to be attached to a [`JumioDigitalIdentityView`][jumiodiview]. The [`JumioDigitalIdentityView`][jumiodiview] is a custom view that can be placed in your layout.
-
-```kotlin
-JumioScanStep.DIGITAL_IDENTITY_VIEW -> {
- currentScanPart?.let {
- jumioDigitalIdentityView.attach(it)
- }
-}
+The retry scan step returns a data object of type `JumioRetryReason`. On `RETRY`, a retry has to be triggered on the credential.
```
-
-[`THIRD_PARTY_VERIFICATION`][thirdpartyverification] is triggered in case the current [`JumioScanPart`][jumioscanpart] will switch to a third party's application to continue the verification process (e.g. for Digital Identity verification). As this might take some time, showing a loading indicator is recommended.
-
-```kotlin
-JumioScanStep.THIRD_PARTY_VERIFICATION -> {
- showLoadingView()
+if (data is JumioRetryReason) {
+ log("retry reason: ${data.code}")
+ log("retry message: ${data.message}")
}
```
-As soon as the scan part has been confirmed and all processing has been completed [`CAN_FINISH`][canfinish] is triggered. [`scanPart.finish()`][finishscanpart] can now be called. During the finish routine the SDK checks if there is an add-on functionality for this part available, e.g. possible NFC scanning after an MRZ scan part. In this case [`ADDON_SCAN_PART`][addonscanpart] will be called
-
-When an add-on to the current scan part is available, [`JumioScanStep.ADDON_SCAN_PART`][addonscanpart] is sent. The add-on scan part can be retrieved using the method `addonScanPart = currentCredential?.getAddonPart()`.
+As soon as the scan part has been confirmed and all processing has been completed `CAN_FINISH` is triggered. `scanPart.finish()` can now be called. During the finish routine the SDK checks if there is an add-on functionality for this part available, e.g. possible NFC scanning after an MRZ scan part. In this case `ADDON_SCAN_PART` will be called
-#### Scan Updates
+When an add-on to the current scan part is available, `JumioScanStep.ADDON_SCAN_PART` is sent. The add-on scan part can be retrieved using the method `addonScanPart = currentCredential?.getAddonPart()`.
-Apart from the scan steps, there are also scan updates distributed the `scanPart` method [`onUpdate()`][onupdate]. They cover additional scan information that is relevant and might need to be displayed during scanning. The parameters are [`JumioScanUpdate`][jumioscanupdate] and an optional value `data` of type `Any` that can contain additional information for each scan update as described.
+`JumioScanUpdate` covers scan information that is relevant and might need to be displayed during scanning.
-[`JumioScanUpdate`][jumioscanupdate] values: `CAMERA_AVAILABLE`, `FALLBACK`, `NFC_EXTRACTION_STARTED`, `NFC_EXTRACTION_PROGRESS`, `NFC_EXTRACTION_FINISHED`, `CENTER_ID`, `HOLD_STRAIGHT`, `MOVE_CLOSER`, `TOO_CLOSE`, `HOLD_STILL`, `MOVE_FACE_CLOSER`, `FACE_TOO_CLOSE`
-
-For `FALLBACK`, there are 2 possible [`JumioFallbackReason`][fallbackreason]'s sent in the optional `data` value to indicate the reason of the fallback.
+* `JumioScanUpdate` values: `LEGAL_HINT`, `CAMERA_AVAILABLE`, `FALLBACK`, `NFC_EXTRACTION_STARTED`, `NFC_EXTRACTION_PROGRESS`, `NFC_EXTRACTION_FINISHED`
### Result and Error Handling
+Instead of using the standard method `onActivityResult()`, implement the following methods within your `jumioControllerInterface` for successful scans and error notifications:
-Instead of using the standard method `onActivityResult()`, implement the following methods within your [`jumioControllerInterface`][jumiocontrollerinterface] for successful scans and error notifications:
-
-The method `onFinished(result: JumioResult)` has to be implemented to handle data after a successful scan, which will return [`JumioResult`][jumioresult].
+The method `onFinished(result: JumioResult)` has to be implemented to handle data after a successful scan.
-```kotlin
+```
override fun onFinished(result: JumioResult) {
- val data = result
- // handle success case
- finish()
-}
+ val data = result
+ // handle success case
+ finish()
+ }
```
-The method `onError(error: JumioError)` has to be implemented to handle data after an unsuccessful scan, which will return [`JumioError`][jumioerror]. Check the parameter [`error.isRetryable`][isretryable] to see if the failed scan attempt can be retried.
+The method `onError(error: JumioError)` has to be implemented to handle data after an unsuccessful scan. Check the parameter `error.isRetryable` to see if the failed scan attempt can be retried.
-```kotlin
+```
override fun onError(error: JumioError) {
- if (error.isRetryable) {
- // retry scan attempt
- } else {
- // handle error case
- }
- log(String.format("onError: %s, %s, %s", error.code, error.message, if (error.isRetryable) "true" else "false"))
-}
+ if(error.isRetryable) {
+ // retry scan attempt
+ } else {
+ // handle error case
+ }
+ log(String.format("onError: %s, %s, %s", error.code, error.message, if
+ (error.isRetryable) "true" else "false" )
+ }
```
+If an error is retryable, `jumioController.retry()` should be called to execute a retry.
-If an error is retryable, [`jumioController.retry()`][retrycontroller] should be called to execute a retry.
-
-### Instant Feedback
-
+#### Instant Feedback
The use of Instant Feedback provides immediate end user feedback by performing a usability check on any image the user took and prompting them to provide a new image immediately if this image is not usable, for example because it is too blurry. Please refer to the [JumioRejectReason table](#class-jumiorejectreason) for a list of all reject possibilities.
-## Customization
-
-The Jumio SDK provides various options to customize its UI. If you are using [Default UI](#default-ui) you can change each screen to fulfil your needs. In case you decide to implement the verification workflow on your own (see [Custom UI](#custom-ui)) you also have the possibility to influence the look and feel of some views provided by the SDK, e.g. [`JumioScanView`][jumioscanview].
-
-### Customization Tool
-
-[Jumio Surface](https://jumio.github.io/surface-tool/) is a web tool that offers the possibility to apply and visualize all available customization options for the Jumio SDK, as well as an export feature that generates all data needed to import the desired changes straight into your codebase.
-
-[](https://jumio.github.io/surface-tool/)
-
-### Default UI customization
-
-The surface tool utilizes each screen of Jumio's [Default UI](#default-ui) to visualize all items and colors that can be customized. If you are planning to use the [Default UI](#default-ui) implementation, you can specify the `Theme.Jumio` as a parent style in your application and override according attributes within this theme to match your application's look and feel.
-
-After customizing the SDK via the surface tool, you can click the **Android-Xml** button in the **Output** menu on the bottom right to copy the code from the theme `AppThemeCustomJumio` to your Android app's `styles.xml` file.
-
-Apply your custom theme that you defined before by replacing `Theme.Jumio` in the `AndroidManifest.xml:`
-
-```xml
-
- ...
-
-```
-
-#### Dark Mode
-
-`Theme.Jumio` attributes can also be customized for dark mode. If you haven't done so already, create a `values-night` folder in your resources directory and add a new `styles.xml` file. Adapt your custom Jumio theme for dark mode. The SDK will switch automatically to match the system settings of the user device.
-
-### Custom UI customization
-
-If you implement your own UI, you can still customize how some views provided by the SDK look. In particular this means you can customize Jumio's **scan overlay**, **NFC scanning** and **iProov Face liveness** views at the moment.
-
-By following the steps explained in [Default UI customization](#default-ui-customization) you can see potential attributes to override in the generated XML file.
-
# 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.
+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.
# Support
## Licenses
-
The software contains third-party open source software. For more information, see [licenses](licenses).
This software is based in part on the work of the Independent JPEG Group.
## Contact
-
-If you have any questions regarding our implementation guide please contact **Jumio Customer Service** at [support@jumio.com](mailto:support@jumio.com). The [Jumio online helpdesk](https://support.jumio.com) contains a wealth of information regarding our services including demo videos, product descriptions, FAQs, and other resources that can help to get you started with Jumio.
+If you have any questions regarding our implementation guide please contact Jumio Customer Service at support@jumio.com. The [Jumio online helpdesk](https://support.jumio.com) contains a wealth of information regarding our services including demo videos, product descriptions, FAQs, and other resources that can help to get you started with Jumio.
## Copyright
-
© Jumio Corporation, 395 Page Mill Road, Suite 150, Palo Alto, CA 94306
The source code and software available on this website (“Software”) is provided by Jumio Corp. or its affiliated group companies (“Jumio”) "as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall Jumio be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including but not limited to procurement of substitute goods or services, loss of use, data, profits, or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this Software, even if advised of the possibility of such damage.
In any case, your use of this Software is subject to the terms and conditions that apply to your contractual relationship with Jumio. As regards Jumio’s privacy practices, please see our privacy notice available here: [Privacy Policy](https://www.jumio.com/legal-information/privacy-policy/).
-
-[token]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk/-jumio-s-d-k/token.html
-[datacenter]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk/-jumio-s-d-k/data-center.html
-[sdkversion]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk/-jumio-s-d-k/-companion/version.html
-[isrooted]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk/-jumio-s-d-k/-companion/is-rooted.html
-[camerafacing]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-camera-facing/index.html
-[acquiremode]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-acquire-mode/index.html
-[fallbackreason]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-fallback-reason/index.html
-[userconsented]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.controller/-jumio-controller/user-consented.html
-[isconfigured]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-credential/is-configured.html
-[setidconfiguration]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/set-configuration.html
-[supportedcountries]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/supported-countries.html
-[getphysicaldocuments]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/get-physical-documents-for-country.html
-[getdigitaldocuments]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/get-digital-documents-for-country.html
-[iscompletecredential]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-credential/is-complete.html
-[iscompletecontroller]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.controller/-jumio-controller/is-complete.html
-[startscanpart]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.scanpart/-jumio-scan-part/start.html
-[finishscanpart]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.scanpart/-jumio-scan-part/finish.html
-[finishcredential]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-credential/finish.html
-[finishcontroller]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.controller/-jumio-controller/finish.html
-[isretryable]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.error/-jumio-error/is-retryable.html
-[confirm]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-confirmation-view/confirm.html
-[retakeconfirmation]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-confirmation-view/retake.html
-[retakereject]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-reject-view/retake.html
-[retrycontroller]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.controller/-jumio-controller/retry.html
-[onfinished]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-controller-interface/on-finished.html
-[onscanstep]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-scan-part-interface/on-scan-step.html
-[onupdate]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-scan-part-interface/on-update.html
-[canfinish]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-c-a-n_-f-i-n-i-s-h/index.html
-[prepare]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-p-r-e-p-a-r-e/index.html
-[started]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-s-t-a-r-t-e-d/index.html
-[attachactivity]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-a-t-t-a-c-h_-a-c-t-i-v-i-t-y/index.html
-[attachfile]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-a-t-t-a-c-h_-f-i-l-e/index.html
-[scanview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-s-c-a-n_-v-i-e-w/index.html
-[digitalidentityview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-d-i-g-i-t-a-l_-i-d-e-n-t-i-t-y_-v-i-e-w/index.html
-[imagetaken]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-i-m-a-g-e_-t-a-k-e-n/index.html
-[nextpart]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-n-e-x-t_-p-a-r-t/index.html
-[processing]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-p-r-o-c-e-s-s-i-n-g/index.html
-[confirmationview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-c-o-n-f-i-r-m-a-t-i-o-n_-v-i-e-w/index.html
-[rejectview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-r-e-j-e-c-t_-v-i-e-w/index.html
-[retry]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-r-e-t-r-y/index.html
-[addonscanpart]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-a-d-d-o-n_-s-c-a-n_-p-a-r-t/index.html
-[thirdpartyverification]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/-t-h-i-r-d_-p-a-r-t-y_-v-e-r-i-f-i-c-a-t-i-o-n/index.html
-[jumioactivityattacher]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-activity-attacher/index.html
-[jumiofileattacher]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-file-attacher/index.html
-[jumioscanview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-scan-view/index.html
-[jumiocontroller]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.controller/-jumio-controller/index.html
-[jumiocontrollerinterface]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-controller-interface/index.html
-[jumioresult]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.result/-jumio-result/index.html
-[jumioidresult]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.result/-jumio-i-d-result/index.html
-[jumiofaceresult]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.result/-jumio-face-result/index.html
-[jumiorejectreason]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.reject/-jumio-reject-reason/index.html
-[jumioerror]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.error/-jumio-error/index.html
-[jumiocredential]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-credential/index.html
-[jumioidcredential]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/index.html
-[jumiodocumentcredential]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-document-credential/index.html
-[jumiofacecredential]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-face-credential/index.html
-[jumiodatacredential]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-data-credential/index.html
-[jumiocredentialcategory]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-credential-category/index.html
-[jumiophysicaldocument]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.document/-jumio-physical-document/index.html
-[jumiodigitaldocument]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.document/-jumio-digital-document/index.html
-[jumiodocumenttype]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.document/-jumio-document-type/index.html
-[jumiodocumentvariant]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.document/-jumio-document-variant/index.html
-[jumiocredentialpart]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-credential-part/index.html
-[jumioscanstep]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/index.html
-[jumioretryreason]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.retry/-jumio-retry-reason/index.html
-[jumioretrygeneric]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.retry/-jumio-retry-reason-generic/index.html
-[jumioretrydv]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.retry/-jumio-retry-reason-document-verification/index.html
-[jumioretrynfc]: https://jumio.github.io/mobile-sdk-android/jumio-nfc/com.jumio.sdk.retry/-jumio-retry-reason-nfc/index.html
-[jumioretryiproov]: https://jumio.github.io/mobile-sdk-android/jumio-iproov/com.jumio.sdk.retry/-jumio-retry-reason-iproov/index.html
-[jumioretrydi]: https://jumio.github.io/mobile-sdk-android/jumio-digital-identity/com.jumio.sdk.retry/-jumio-retry-reason-digital-identity/index.html
-[jumioconfirmationview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-confirmation-view/index.html
-[jumiorejectview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-reject-view/index.html
-[jumioconfirmationhandler]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.handler/-jumio-confirmation-handler/index.html
-[jumiorejecthandler]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.handler/-jumio-reject-handler/index.html
-[jumioscanupdate]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-update/index.html
-[jumiofileattacher]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-file-attacher/index.html
-[jumioscanpart]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.scanpart/-jumio-scan-part/index.html
-[jumiomultipart]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-credential-part/-m-u-l-t-i-p-a-r-t/index.html
-[jumioscanmode]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-mode/index.html
-[jumioconsenttype]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-consent-type/index.html
-[jumioconsentitem]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.consent/-jumio-consent-item/index.html
-[credentialpartslist]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-credential/credential-parts.html
-[proguardrules]: https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/proguard-rules.pro
-[jumiodiview]: https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-digital-identity-view/index.html
diff --git a/docs/known_issues.md b/docs/known_issues.md
index 4f1dbef3..78412289 100644
--- a/docs/known_issues.md
+++ b/docs/known_issues.md
@@ -3,8 +3,6 @@
# Known Issues
## Table of Contents
-- [SDK Version 4.0.0 and Above](#sdk-version-400-and-above)
- - [Duplicate Files for 'libc++_shared.so' Library](#duplicate-lib-c)
- [SDK Version 3.9.2 and 4.0.0](#sdk-version-392-and-400)
- [Face Scan Crash at Start](#face-scan-crash-at-start)
- [SDK Version 3.9.0](#sdk-version-390)
@@ -21,29 +19,6 @@
- [Static Interface Methods Are only Supported with Android N](#Static-interface-methods-are-only-supported-with-Android-N)
- [SDK Crashes Trying to Display Animations (Android Version 5 and Lower)](#sdk-crashes-trying-to-display-animations-(android-version-4-and-lower))
- [Country Missing from the Country List](#country-missing-from-the-country-list)
- - [Datadog in Dynamic feature modules](#datadog-in-dynamic-feature-modules)
-
-# SDK Version 4.0.0 and Above
-
-
-
Duplicate Files for 'libc++_shared.so' Library
-
-
-If build fails with error message:
-
-_2 files found with path 'lib/arm64-v8a/libc++\_shared.so' from inputs ..._
-
-Please add the following `packagingOptions` to the configuration in your `build.gradle` file:
-
-```
-android{
- packagingOptions {
- pickFirst 'lib/armeabi-v7a/libc++_shared.so'
- pickFirst 'lib/arm64-v8a/libc++_shared.so'
- }
-}
-
-```
# SDK Version 3.9.2 and 4.0.0
@@ -102,7 +77,7 @@ android.jetifier.blacklist=bcprov-jdk15on
Please note that the naming of this will change with the Android Gradle Plugin 4 release and will become `android.jetifier.ignorelist`
## Custom UI
-On using iProov in CustomUI, in case `NetverifySDKController$retry` function is called for an error EXX0000, the SDK can fail with the following exception: `java.lang.NoClassDefFoundError: Failed resolution of: Lcom/jumio/zoom/custom/ZoomCustomScanPresenter`. This issue was fixed in SDK version 3.9.0. As a workaround it is possible to only add `implementation "com.jumio.android:zoom:3.8.0@aar"` to the build.gradle dependencies.
+On using iProov in CustomUI, in case `NetverifySDKController$retry` function is called for an error EX0000, the SDK can fail with the following exception: `java.lang.NoClassDefFoundError: Failed resolution of: Lcom/jumio/zoom/custom/ZoomCustomScanPresenter`. This issue was fixed in SDK version 3.9.0. As a workaround it is possible to only add `implementation "com.jumio.android:zoom:3.8.0@aar"` to the build.gradle dependencies.
# SDK Version 3.7.x
@@ -140,10 +115,3 @@ implementation "com.jumio.android:nv-barcode:3.9.0@aar"
A complete list of all dependencies [can be found here.](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_guide.md#dependencies)
__Note:__ Version numbers may vary.
-
-## Datadog in Dynamic feature modules
-Datadog registers a Content Receiver through its AndroidManifest. Therefore Datadog needs to be linked in the base app, otherwise the app will crash during start.
-```
-api "com.datadoghq:dd-sdk-android-rum:2.0.0"
-```
-__Note:__ Version numbers may vary.
\ No newline at end of file
diff --git a/docs/maintenance_policy.md b/docs/maintenance_policy.md
deleted file mode 100644
index eb1d5ad6..00000000
--- a/docs/maintenance_policy.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-# Maintenance and Support Policy
-
-## Overview
-This document outlines the maintenance policy for Jumio’s Software Development Kits (“SDKs”), including Mobile and Web SDK and their dependencies.
-Our SDK releases are published publicly as indicated in our documentation as well as to package managers. Documentation and sample implementations are available as source code on GitHub ([Android](https://github.com/Jumio/mobile-sdk-android) and [iOS](https://github.com/Jumio/mobile-sdk-ios)).
-
-We are consistently updating the Jumio SDKs in order to provide the best possible experience for you. Upgrading to the latest SDK version will not only ensure you benefit from various performance enhancements and bug fixes, but will also allow you to take advantage of new capabilities. All releases undergo comprehensive testing by our teams before being deployed.
-
-If you are using a Mobile SDK, please ensure your apps have been released and your end-users have updated before the End-of-Support date. Jumio does not provide support after the End-of-Support date.
-
-Customers should review the [Jumio Terms and Conditions](https://www.jumio.com/legal-information/privacy-notices/) for requirements related to the implementation of updates.
-
-## Versioning
-Jumio SDK release versions are in the form of X.Y.Z:
-* X major version - very rarely updated
-* Y minor version - normally updated once in a quarter
-* Z patch version - updated on demand
-
-Major versions of Jumio’s SDKs are released rarely, and only in case of substantial changes to support new features and patterns. Breaking changes can happen in Major and Minor versions. Applications need to be updated in order for them to work with the newest SDK version. Breaking changes are highlighted in our [Android](https://github.com/Jumio/mobile-sdk-android) and [iOS](https://github.com/Jumio/mobile-sdk-ios) implementation guides for each release.
-
-Jumio will only provide patches or additional updates on the latest version regardless if it’s Major, Minor or Patch.
-
-## SDK Version Lifecycle
-The life-cycle for SDK versions consists of these phases, which are outlined below:
-* __Developer Preview__ (Phase 0) - During this phase, SDKs are not supported, must not be used in production environments, and are meant for early access and feedback purposes only. It is possible for future releases to introduce breaking changes. It can be alpha, beta, or release candidate.
-* __General availability / Full support__ (Phase 1) - During this phase, SDKs are fully supported. Jumio will provide active support on this version and will provide required bug fixes or security fixes within new / upcoming versions (major, minor, patch).
-* __End-of-Support__ (Phase 2) - Each SDK version reaches end of support 9 months after the release date. Issues that appear after the End-of-Support date will only be addressed in the upcoming SDK releases. Previously published releases will continue to be available via public package managers and the code will remain on GitHub. Use of an SDK that has reached End-of-Support is done at the business customers’ discretion. We recommend upgrading to the latest version.
-* __End-of-Life__ (Phase 3) - By default, our SDK will reach the end of life 24 months after the release date. The SDK may continue to work but Jumio will no longer provide support or updates. Customers will be notified at least 3 months prior to the end of life of a product should it be less than 24 months.
-
-The following table is a visual representation of the SDK 4.x.x version life-cycle. SDK 3.x.x End-of-Life is set to December 31, 2023.
-
-| Version | Release | End of Support | End of Life |
-|:-------:|:-----------------:|:-----------------:|:-----------------:|
-| 4.8.1 | 23 October 2023 | 17 July 2024 | 17 October 2025 |
-| 4.8.0 | 17 October 2023 | 17 July 2024 | 17 October 2025 |
-| 4.7.1 | 23 October 2023 | 27 June 2024 | 27 September 2025 |
-| 4.7.0 | 27 September 2023 | 27 June 2024 | 27 September 2025 |
-| 4.6.1 | 23 October 2023 | 5 March 2024 | 5 June 2025 |
-| 4.6.0 | 5 June 2023 | 5 March 2024 | 5 June 2025 |
-| 4.5.1 | 23 October 2023 | 14 January 2024 | 14 April 2025 |
-| 4.5.0 | 14 April 2023 | 14 January 2024 | 14 April 2025 |
-| 4.4.2 | 23 October 2023 | 18 October 2023 | 18 January 2025 |
-| 4.4.1 | 18 January 2023 | 18 October 2023 | 18 January 2025 |
-| 4.4.0 | 20 December 2022 | 20 September 2023 | 20 December 2024 |
-| 4.3.0 | 30 August 2022 | 30 May 2023 | 30 August 2024 |
-| 4.2.0 | 25 May 2022 | 25 February 2023 | 25 May 2024 |
-| 4.1.1 | 23 October 2023 | 28 November 2022 | 28 February 2024 |
-| 4.1.0 | 28 February 2022 | 28 November 2022 | 28 February 2024 |
-| 4.0.0 | 16 November 2021 | 16 August 2022 | 16 November 2023 |
diff --git a/docs/transition_guide.md b/docs/transition_guide.md
index 197c30ab..00647aeb 100644
--- a/docs/transition_guide.md
+++ b/docs/transition_guide.md
@@ -1,157 +1,14 @@
# Transition Guide for Android SDK
-This section covers all technical changes that should be considered when updating from previous versions, including, but not exclusively: API breaking changes or new functionality in the public API, major dependency changes, attribute changes, deprecation notices.
+This section only covers the breaking technical changes that should be considered when updating from the previous version.
⚠️ When updating your SDK version, __all__ changes/updates made in in the meantime have to be taken into account and applied if necessary.
__Example:__ If you're updating from SDK version __3.7.2__ to __3.9.2__, the changes outlined in __3.8.0, 3.9.0__ and __3.9.1__ are __still relevant__.
-## 4.8.1
+## 4.2.1
No backward incompatible changes
-## 4.8.0
-No backward incompatible changes
-
-## 4.7.1
-No backward incompatible changes
-
-## 4.7.0
-#### Public API Changes
-* `rawBarcodeData` has been removed from [`JumioIDResult`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.result/-jumio-i-d-result/index.html)
-* `LEGAL_HINT` has been removed from [`JumioScanUpdate`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-update/index.html)
-* `giveDataDogConsent` has been removed from [`JumioSDK`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk/-jumio-s-d-k/-companion/index.html)
-
-#### Dependency Updates
-* Removed MRZ dependency: ~~`implementation "com.jumio.android:mrz:4.6.0"`~~
-* Removed Linefinder dependency: ~~`implementation "com.jumio.android:linefinder:4.6.0"`~~
-* Removed Barcode dependency: ~~`implementation "com.jumio.android:barcode:4.6.0"`~~
-* Datadog update: ~~`"com.datadoghq:dd-sdk-android:1.19.3"`~~ is replaced by `"com.datadoghq:dd-sdk-android-rum:2.0.0"` - If Datadog is used in a dynamic feature module please have a look at [this known issue](known_issues.md#datadog-in-dynamic-feature-modules).
-
-#### Custom UI Changes
-* The platform check has been moved from the [`JumioSDK`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk/-jumio-s-d-k/-companion/index.html) constructor to the [`JumioController`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.controller/-jumio-controller/index.html) constructor. In case the platform is not supported there will be a non-retryable F000001 [`JumioError`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.error/-jumio-error/index.html) delivered in [`JumioControllerInterface$onError`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-controller-interface/on-error.html) instead of a [`PlatformNotSupportedException`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.exceptions/-platform-not-supported-exception/index.html) being thrown. Please also make sure to check [`isSupportedPlatform`](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_guide.md#device-supported-check) before using the SDK.
-
-#### Localization Changes
-* SDK string translations for Brazilian Portuguese (pt-rBR) have been added
-
-#### Customization Changes
-* Customization attribute ~~`- `~~ has been removed
-
-#### Documentation Changes
-* Functions `persist` and `stop` in [`JumioController`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.controller/-jumio-controller/index.html) need to be called independently from `isComplete` as long as the workflow is not yet finished or canceled.
-
-## 4.6.1
-No backward incompatible changes
-
-## 4.6.0
-#### Public API Changes
-* `JUMIO_LIVENESS` has been added to [`JumioScanMode`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-mode/index.html)
-* `MOVE_FACE_CLOSER` has been added to [`JumioScanUpdate`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-update/index.html)
-* `FACE_TOO_CLOSE` has been added to [`JumioScanUpdate`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-update/index.html)
-
-#### Customization Changes
-* A new customization theme `
- @style/CustomFaceHelp
` has been added to help customize the newly added Jumio Liveness solution. This style includes the following attributes:
- * `- `
- * `
- `
-
-
-* The following customization attributes have been added to `@style/CustomOverlay` theme:
- * `
- `
- * `
- `
- * `
- `~~
- * ~~`
- `~~
-
-
-* See also: [Jumio sample `styles.xml`](../sample/JumioMobileSample/src/main/res/values/styles.xml)
-
-#### Dependency Updates
-* NEW Liveness dependency: `implementation "com.jumio.android:liveness:4.6.0"`
-
-## 4.5.1
-No backward incompatible changes
-
-## 4.5.0
-#### Public API Changes
-* ~~`onPause`~~ has been removed from [JumioScanPart](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.scanpart/-jumio-scan-part/index.html)
-
-* [`JumioError.code`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.error/-jumio-error/index.html) format updated from `[A][x][yyyy]` to `[A][xx][yyyy]`
-
-* Property [`countries`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/countries.html) of `JumioIDCredential` has been deprecated. Instead the following new property and functions have been added:
- * [`JumioIDCredential.supportedCountries`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/supported-countries.html)
- * [`JumioIDCredential.getPhysicalDocumentsForCountry(countryCode:)`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/get-physical-documents-for-country.html)
- * [`JumioIDCredential.getDigitalDocumentsForCountry(countryCode:)`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-i-d-credential/get-digital-documents-for-country.html)
-
-* [`JumioDeepLinkHandler`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.util/-jumio-deep-link-handler/index.html) has been added
-
-* [`JumioPhysicalDocument`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.document/-jumio-physical-document/index.html) and [`JumioDigitalDocument`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.document/-jumio-digital-document/index.html) have been added
-
-* [`JumioDocument`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.document/-jumio-document/index.html) type has changed to interface. (Original `JumioDocument` class has been replaced by `JumioPhysicalDocument`)
-
-* `DIGITAL` has been added in [`JumioCredentialPart`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-credential-part/index.html)
-
-* `DIGITAL_IDENTITY_VIEW` and `THIRD_PARTY_VERIFICATION` have been added in [`JumioScanStep`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/index.html)
-
-* [`JumioRetryReasonDigitalIdentity`](https://jumio.github.io/mobile-sdk-android/jumio-digital-identity/com.jumio.sdk.retry/-jumio-retry-reason-digital-identity/index.html) has been added
-
-* [`JumioConsentItem`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.consent/-jumio-consent-item/index.html) class and [`JumioConsentType`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-consent-type/index.html) enum have been added
-
-* [`onInitialized()`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-controller-interface/on-initialized.html) callback has been changed from ~~`onInitialized(credentials: List, policyUrl: String?)`~~ to [`onInitialized(credentials: List, consentItems: List?)`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-controller-interface/on-initialized.html)
- * Please refer to the [Consent Handling section](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_guide.md#consent-handling) in our integration guide for more details.
-
-#### Localization Keys
-The following keys have been added to `strings.xml`:
- * jumio_idtype_di
- * jumio_di_vendor_selection_title
- * jumio_di_retry_unknown
- * jumio_di_retry_third_party_verification_error
- * jumio_di_retry_service_error
- * jumio_di_retry_expired
- * jumio_di_back_to_document_selection
-
-#### Dependency Updates
-* IProov update: ~~`"com.iproov.sdk:iproov:8.0.3"`~~ is replaced by `"com.iproov.sdk:iproov:8.3.1"`
-
-## 4.4.2
-No backward incompatible changes
-
-## 4.4.1
-No backward incompatible changes
-
-## 4.4.0
-#### Public API Changes
-* `credentialParts` property of [`JumioCredential` class](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.credentials/-jumio-credential/credential-parts.html) has been changed from `ArrayList` to `List`
-* [`JumioConfirmationHandler`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.handler/-jumio-confirmation-handler/index.html) has been added. Attach a [JumioScanPart](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.scanpart/-jumio-scan-part/index.html) to this class to retrieve all accepted images and render them to [`JumioConfirmationView`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-confirmation-view/index.html) objects for confirmation.
-* [`JumioRejectHandler`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.handler/-jumio-reject-handler/index.html) has been added. Attach a [JumioScanPart](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.scanpart/-jumio-scan-part/index.html) to this class to retrieve all rejected images and render them to [`JumioRejectView`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-reject-view/index.html) objects for retaking.
-* Functions in [`JumioConfirmationView`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-confirmation-view/index.html) have been moved to [`JumioConfirmationHandler`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.handler/-jumio-confirmation-handler/index.html).
-* Functions in [`JumioRejectView`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.views/-jumio-reject-view/index.html) have been moved to [`JumioRejectHandler`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.handler/-jumio-reject-handler/index.html)
-* `MULTIPART` has been added in [`JumioCredentialPart`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-credential-part/index.html) as a new Autocapture scan part: Instead of having a single scan part for all parts of a document (front, back), there is now a single `MULTIPART` scan part that combines the two. Within this scan part all needed parts of a document are captured at once.
-* `NEXT_PART` has been added in [`JumioScanStep`](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-scan-step/index.html): This scan step shows that the previous part has been captured and the next one can be started (e.g. frontside has been captured, now switch to the backside of the document)
-
-#### Customization Updates
-* Attributes changed and added to [`Iproov.Customization` theme](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/src/main/res/values/styles.xml#L95)
-
-#### Dependency Updates
-* IProov update: ~~`"com.iproov.sdk:iproov:7.5.0"`~~ is replaced by `"com.iproov.sdk:iproov:8.0.3"`
-
-## 4.3.0
-#### Minimum SDK Version Changes
-* minSdkVersion has been increased to 21. The SDK can still be integrated in Apps that support lower minSdkVersions - check if the [platform is supported](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk/-jumio-s-d-k/-companion/is-supported-platform.html) before initializing the JumioSDK, otherwise it will throw a [PlatformNotSupportedException](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.exceptions/-platform-not-supported-exception/index.html).
-
-#### Dependency Updates
-* IProov update: ~~`"com.iproov.sdk:iproov:7.2.0"`~~ is replaced by `"com.iproov.sdk:iproov:7.5.0"`
-
-#### Public API Changes
-* Document Verification is now supported. Please check the [Integration Guide](https://github.com/Jumio/mobile-sdk-android/blob/master/docs/integration_guide.md#jumio-document-credential) for more information.
-
-#### Public API Changes
-* ~~`JumioCameraPosition`~~ from package `com.jumio.sdk.enums` in `com.jumio.sdk:core` is replaced by `JumioCameraFacing`
-* `JumioAcquireMode` has been added to package `com.jumio.sdk.enums` in `com.jumio.sdk:core`, containing fields `FILE` and `CAMERA`
-* [`JumioDataCredential` class](integration_guide.md/#jumio-data-credential) has been added for handling of Device Fingerprinting
-* [`JumioDocumentCredential` class](integration_guide.md/#jumio-document-credential) has been added for Document Verification handling
-
## 4.2.0
#### Public API Changes
* In [JumioControllerInterface](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.interfaces/-jumio-controller-interface/index.html) the signature of function `onInitialized` has been changed. Parameter `credentials` has been changed from `ArrayList` to `List`
@@ -159,7 +16,7 @@ No backward incompatible changes
* `JumioScanSide` from package `com.jumio.sdk.enums` in `com.jumio.sdk:core` has been renamed to [JumioCredentialPart](https://jumio.github.io/mobile-sdk-android/jumio-core/com.jumio.sdk.enums/-jumio-credential-part/index.html)
#### Dependency Updates
-* NEW Autocapture dependency (Beta): `implementation "com.jumio.android:docfinder:4.2.0"`
+* NEW Generic ID Scanning dependency (Beta): `implementation "com.jumio.android:docfinder:4.2.0"`
#### Customization Updates
* Boolean `iproov_floating_prompt_enabled` has been added to [`Iproov.Customization` theme](https://github.com/Jumio/mobile-sdk-android/blob/master/sample/JumioMobileSample/src/main/res/values/styles.xml#L84)
@@ -250,6 +107,7 @@ No backward incompatible changes
## 3.9.3
No backward incompatible changes
+
## 3.9.2
#### Dependency Changes
* IProov update: ~~`"com.iproov.sdk:iproov:6.3.1"`~~ is replaced by `"com.iproov.sdk:iproov:6.4.1"`. This version improves conversion and offers additional customization options.
@@ -306,7 +164,7 @@ No backward incompatible changes
* `recreate(NetverifyCustomScanView scanView, NetverifyCustomConfirmationView confirmationView, NetverifyCustomScanInterface netverifyCustomScanInterface)` has been added to [NetverifyCustomScanPresenter](https://jumio.github.io/mobile-sdk-android/com/jumio/nv/custom/NetverifyCustomScanPresenter.html#recreate-com.jumio.nv.custom.NetverifyCustomScanView-com.jumio.nv.custom.NetverifyCustomConfirmationView-com.jumio.nv.custom.NetverifyCustomScanInterface-) - this needs to be called in case the hosting activity is recreated.
-* The initialization and start of scan presenters has been split. This allows displaying a help view with the help animation prior to starting the scan presenter:
+* The initialization and start of scan presenters has been splitted. This allows displaying a help view with the help animation prior to starting the scan presenter:
* `startScanForPart(ScanSide scanSide, NetverifyCustomScanView scanView, NetverifyCustomConfirmationView confirmationView, NetverifyCustomScanInterface scanViewInterface` has been replaced with `initScanForPart(ScanSide scanSide, NetverifyCustomScanView scanView, NetverifyCustomConfirmationView confirmationView, NetverifyCustomScanInterface scanViewInterface)`
* The following method was added to `NetverifyCustomScanPresenter` to trigger scanning start after the initialization. This method needs to be called on the `NetverifyCustomScanPresenter` after it was initialized with `initScanForPart(..)`.
@@ -374,7 +232,7 @@ Several additions and changes, mostly in regards to the new liveness flow.
* Button style: ~~`
- @style/Custom.Netverify.Confirmation.MaterialButton.Outlined
`~~ is replaced by `- @style/Custom.Netverify.Confirmation.MaterialButton.Outlined
`
-* NEW IProov attribute: `- @style/CustomIproov
`
+* NEW Iproov attribute: `- @style/CustomIproov
`
* NEW IProov theme: `
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-nl/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-nl/strings-jumio-sdk.xml
index d214104d..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-nl/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-nl/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-pl/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-pl/strings-jumio-sdk.xml
index e74d6962..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-pl/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-pl/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-pt-rBR/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-pt-rBR/strings-jumio-sdk.xml
deleted file mode 100644
index ce86ce5d..00000000
--- a/sample/JumioMobileSample/src/main/res/values-pt-rBR/strings-jumio-sdk.xml
+++ /dev/null
@@ -1,210 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-pt/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-pt/strings-jumio-sdk.xml
index c4c15ce7..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-pt/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-pt/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-ro/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-ro/strings-jumio-sdk.xml
index aaed90b7..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-ro/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-ro/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-ru/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-ru/strings-jumio-sdk.xml
index 9fec788b..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-ru/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-ru/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-sk/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-sk/strings-jumio-sdk.xml
index ccd698a7..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-sk/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-sk/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-sl/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-sl/strings-jumio-sdk.xml
index 60e7da03..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-sl/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-sl/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-sv/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-sv/strings-jumio-sdk.xml
index 9e39f977..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-sv/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-sv/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-th/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-th/strings-jumio-sdk.xml
index 0a1aa81b..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-th/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-th/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-tr-rTR/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-tr-rTR/strings-jumio-sdk.xml
index eb542a46..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-tr-rTR/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-tr-rTR/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-uk-rUA/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-uk-rUA/strings-jumio-sdk.xml
deleted file mode 100644
index 4434dbf4..00000000
--- a/sample/JumioMobileSample/src/main/res/values-uk-rUA/strings-jumio-sdk.xml
+++ /dev/null
@@ -1,210 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-vi/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-vi/strings-jumio-sdk.xml
index 3159a845..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-vi/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-vi/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-zh-rTW/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-zh-rTW/strings-jumio-sdk.xml
index 5975906f..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-zh-rTW/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-zh-rTW/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-zh/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-zh/strings-jumio-sdk.xml
index bcb6842f..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-zh/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-zh/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values-zu/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values-zu/strings-jumio-sdk.xml
index 5ffda5df..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values-zu/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values-zu/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values/dimens.xml b/sample/JumioMobileSample/src/main/res/values/dimens.xml
index 90ec64a4..afb57f63 100644
--- a/sample/JumioMobileSample/src/main/res/values/dimens.xml
+++ b/sample/JumioMobileSample/src/main/res/values/dimens.xml
@@ -1,9 +1,6 @@
- 16dp
- 16dp
+ 16dp
+ 16dp
16dp
-
-
- 9:16
diff --git a/sample/JumioMobileSample/src/main/res/values/strings-jumio-sdk.xml b/sample/JumioMobileSample/src/main/res/values/strings-jumio-sdk.xml
index 50a177c4..7a30101b 100644
--- a/sample/JumioMobileSample/src/main/res/values/strings-jumio-sdk.xml
+++ b/sample/JumioMobileSample/src/main/res/values/strings-jumio-sdk.xml
@@ -2,209 +2,14 @@
-
-
-
\ No newline at end of file
diff --git a/sample/JumioMobileSample/src/main/res/values/strings.xml b/sample/JumioMobileSample/src/main/res/values/strings.xml
index 8e65f110..c7d8d28c 100644
--- a/sample/JumioMobileSample/src/main/res/values/strings.xml
+++ b/sample/JumioMobileSample/src/main/res/values/strings.xml
@@ -2,7 +2,13 @@
+ Jumio Sample Java
Jumio Sample Kotlin
+ MainActivity
+ Start %1$s
+ Default UI
+ Custom UI
+ Options:
Open navigation drawer
Close navigation drawer
diff --git a/sample/JumioMobileSample/src/main/res/values/styles.xml b/sample/JumioMobileSample/src/main/res/values/styles.xml
index 22ccf3f0..37f81a20 100644
--- a/sample/JumioMobileSample/src/main/res/values/styles.xml
+++ b/sample/JumioMobileSample/src/main/res/values/styles.xml
@@ -18,23 +18,11 @@
- @color/colorSecondary
-
-
-
-
-
-
\ No newline at end of file
-
-
-
## 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:support@jumio.com).
diff --git a/docs/integration_glossary.md b/docs/integration_glossary.md
index f043307e..4929d0ed 100644
--- a/docs/integration_glossary.md
+++ b/docs/integration_glossary.md
@@ -60,6 +60,3 @@ Passport
### 3D-Liveness
Liveness check: The 3D-liveness check makes sure that a face scan performed was not of a picture, but of an actual, living person who also matches the picture on the previously scanned document
-
-### DID
-Digital Identity
diff --git a/docs/integration_guide.md b/docs/integration_guide.md
index c5333740..04f10016 100644
--- a/docs/integration_guide.md
+++ b/docs/integration_guide.md
@@ -1,146 +1,82 @@
# Integration Guide for Android SDK
-
-Jumio’s products allow businesses to establish the genuine identity of their users by verifying government-issued IDs in real-time. ID Verification, Identity Verification and other services are used by financial service organizations and other leading brands to create trust for safe onboarding, money transfers and user authentication.
+Jumio’s products allow businesses to establish the genuine identity of their users by verifying government-issued IDs in real-time. ID Verification, Identity Verification and other services are used by financial service organizations and other leading brands to create trust for safe onboarding, money transfers, and user authentication.
## Table of Contents
-
- [Release Notes](#release-notes)
-- [Code Documentation](#code-documentation)
- [Setup](#setup)
- - [Dependencies](#dependencies)
- - [Autocapture](#autocapture)
- - [Certified Face Liveness](#certified-face-liveness)
- - [Barcode Scanning](#barcode-scanning)
- - [NFC Scanning](#nfc-scanning)
- - [SDK Version Check](#sdk-version-check)
- - [Root Detection](#root-detection)
- - [Device Supported Check](#device-supported-check)
- - [Privacy Notice](#privacy-notice)
- - [Digital Identity (DID)](#digital-identity-did)
- - [Risk Signal: Device Risk](#risk-signal-device-risk)
+- [Dependencies](#dependencies)
- [Initialization](#initialization)
- - [Requesting a Token (via OAuth2)](#requesting-a-token-via-oauth2)
- - [Initializing the Jumio SDK](#initializing-the-jumio-sdk)
- [Configuration](#configuration)
- - [Worfklow Selection](#worfklow-selection)
- - [Transaction Identifiers](#transaction-identifiers)
- - [Preselection](#preselection)
- - [Miscellaneous](#miscellaneous)
+- [Customization](#customization)
- [SDK Workflow](#sdk-workflow)
- - [Retrieving Information](#retrieving-information)
-- [Default UI](#default-ui)
- [Custom UI](#custom-ui)
- - [Controller Handling](#controller-handling)
- - [Credential Handling](#credential-handling)
- - [ScanPart Handling](#scanpart-handling)
- - [Result and Error Handling](#result-and-error-handling)
- [Instant Feedback](#instant-feedback)
-- [Customization](#customization)
- - [Customization Tool](#customization-tool)
- - [Default UI customization](#default-ui-customization)
- - [Custom UI customization](#custom-ui-customization)
+- [Callback](#callback)
+- [Code Documentation](https://jumio.github.io/mobile-sdk-android/)
## Release Notes
+Please refer to our [Change Log](changelog.md) for more information. Current SDK version: __4.2.1__
-Please refer to our [Change Log](changelog.md) for more information. Current SDK version: **4.8.1**
-
-For technical changes that should be considered when updating the SDK, please read our [Transition Guide](transition_guide.md).
-
-## Code Documentation
-
-Full API documentation for the Jumio Android SDK can be found [here](https://jumio.github.io/mobile-sdk-android/).
+For breaking technical changes, please read our [Transition Guide](transition_guide.md)
## Setup
-
The [basic setup](../README.md#basics) is required before continuing with the following setup for the Jumio SDK. If you are updating your SDK to a newer version, please also refer to:
-:arrow_right: [Changelog](changelog.md)
-:arrow_right: [Transition Guide](transition_guide.md)
-
-### Dependencies
+:arrow_right: [Changelog](docs/changelog.md)
+:arrow_right: [Transition Guide](docs/transition_guide.md)
+## Dependencies
The [SDK Setup Tool](https://jumio.github.io/mobile-configuration-tool/out/) is a web tool that helps determine available product combinations and corresponding dependencies for the Jumio SDK, as well as an export feature to easily import the applied changes straight into your codebase.
[](https://jumio.github.io/mobile-configuration-tool/out/)
-Below you can find a list of dependencies that can be added to your application to enable different functionality of the Jumio SDK. Some modules are mandatory, others are optional.
-
-If an optional module is **not linked**, some functionalities may not be available, but the library size will be reduced. The [Sample app](../sample/JumioMobileSample/) apk size is currently around **17 MB**.
-
-```groovy
-// [Mandatory] Jumio Core library
-dependencies {
- implementation "com.jumio.android:core:4.8.1"
- ...
-}
-
-// [Optional] Extraction methods
-dependencies {
- implementation "com.jumio.android:docfinder:4.8.1" // Autocapture library, includes all previous scanning methods
- implementation "com.jumio.android:barcode-mlkit:4.8.1" // Barcode scanning library, assists Autocapture
- implementation "com.jumio.android:nfc:4.8.1" // NFC scanning library, assists Autocapture
- implementation "com.jumio.android:iproov:4.8.1" // Face Liveness library
- implementation "com.jumio.android:liveness:4.8.1" // Face Liveness library
- implementation "com.jumio.android:digital-identity:4.8.1" // Digital Identity verification library
- ...
-}
-
-// [Optional] Jumio Default UI
-dependencies {
- implementation "com.jumio.android:defaultui:4.8.1"
- ...
-}
+Below there is a list of dependencies the application will need to work in Android. Some modules are mandatory, others are optional. If an optional module is __not linked__, some functionalities such as certain methods may not be available, but the library size will be reduced. The [Sample app](../sample/JumioMobileSample/) apk size is currently around __17 MB__.
-// [Optional] Additional functionality
+```
dependencies {
- implementation "com.jumio.android:camerax:4.8.1" // CameraX library
- implementation "com.jumio.android:datadog:4.8.1" // Analytics library
- implementation "com.jumio.android:devicerisk:4.8.1" // Device fingerprinting library
- ...
-}
+ implementation "com.jumio.android:core:4.2.1" // Jumio Core library
+ implementation "com.jumio.android:defaultui:4.2.1" // Jumio Default UI
+ implementation "com.jumio.android:mrz:4.2.1" // MRZ Scanning
+ implementation "com.jumio.android:nfc:4.2.1" // NFC Scanning
+ implementation "com.jumio.android:linefinder:4.2.1" // Linefinder Scanning
+ implementation "com.jumio.android:docfinder:4.2.1" // Generic ID Scanning (beta)
+ implementation "com.jumio.android:barcode:4.2.1" // Barcode scanning
+ implementation "com.jumio.android:barcode-mlkit:4.2.1" // Barcode scanning alternative
+ implementation "com.jumio.android:iproov:4.2.1" // Face Liveness library
+ implementation "com.jumio.android:datadog:4.2.1" // Analytics library
+ implementation "com.jumio.android:devicerisk:4.2.1" // Device fingerprinting library
```
-#### Autocapture
+#### Generic ID Scanning
+The module `com.jumio.android:docfinder` offers a generic scanning method across all ID documents, providing a more seamless capture experience for the end user. The SDK will automatically detect which type of ID document is presented by the user and guide them through the capturing process with live feedback.
-The module `com.jumio.android:docfinder` offers one generic scanning method across all ID documents, providing a more seamless capture experience for the end user. The SDK will automatically detect which type of ID document is presented by the user and guide them through the capturing process with live feedback.
-The models can be bundled with the app directly to save time on the download during the SDK runtime. Therefore download the following files from [here](https://cdn.mobile.jumio.ai/model/classifier_on_device_ep_99_float16_quant.enc) and [here](https://cdn.mobile.jumio.ai/model/normalized_ensemble_passports_v2_float16_quant.enc) and add it to the app assets folder.
+⚠️ __Note:__ This feature is currently i the Beta stage and suspect to change in the next SDK version. If you intend to use it in production, please contact Jumio Customer Service at support@jumio.com.
#### Certified Face Liveness
-
-Jumio uses Certified Liveness technology to determine liveness. Link `com.jumio.android:liveness` and `com.jumio.android:iproov` modules in order to use Jumio Liveness.
-
+Jumio uses Certified Liveness technology to determine liveness. The iProov SDK is referenced as a transitive dependency within the `com.jumio.android:iproov` module.
If necessary, the iProov SDK version can be overwritten with a more recent one:
-
-```groovy
-implementation "com.jumio.android:iproov:4.8.1"
-implementation("com.iproov.sdk:iproov:8.3.1") {
- exclude group: 'org.json', module: 'json'
+```
+implementation "com.jumio.android:iproov:4.2.1"
+implementation ("com.iproov.sdk:iproov:7.2.0"){
+ exclude group: 'org.json', module:'json'
}
```
-#### Barcode Scanning
-In order to benefit from barcode scanning functionality included in the `com.jumio.android:docfinder` dependency, please add `com.jumio.android:barcode-mlkit` to your `build-gradle` file.
-
-This dependency includes `com.google.android.gms:play-services-mlkit-barcode-scanning` library - if your application includes **other Google ML-kit libraries**, it might be necessary to override meta-data specified in the application tag of the `play-services-mlkit-barcode-scanning` manifest by [merging multiple manifests](https://developer.android.com/studio/build/manage-manifests#merge-manifests):
-
-```xml
+#### Barcode Scanning Alternative
+As an alternative to the `com.jumio.android:barcode` dependency, you can substitute `com.jumio.android:barcode-mlkit`. This dependency includes `com.google.android.gms:play-services-mlkit-barcode-scanning` library - if your application includes __other Google ML-kit libraries__, it might be necessary to override meta-data specified in the application tag of the `play-services-mlkit-barcode-scanning` manifest by [merging multiple manifests](https://developer.android.com/studio/build/manage-manifests#merge-manifests):
+```