Skip to content

Commit

Permalink
Final commit for 4.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
JumioMobileTeam committed Apr 14, 2023
1 parent 3021ceb commit 0b11c69
Show file tree
Hide file tree
Showing 51 changed files with 734 additions and 256 deletions.
3 changes: 3 additions & 0 deletions Carthage/IProovDependencies.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"4.5.0": "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.5.0/IProovDependencies.zip",
}
3 changes: 3 additions & 0 deletions Carthage/Jumio.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"4.5.0": "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.5.0/Jumio.xcframework.zip",
}
3 changes: 3 additions & 0 deletions Carthage/JumioDeviceRisk.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"4.5.0": "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.5.0/JumioDeviceRisk.xcframework.zip",
}
3 changes: 3 additions & 0 deletions Carthage/JumioDocFinder.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"4.5.0": "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.5.0/JumioDocFinder.xcframework.zip",
}
3 changes: 3 additions & 0 deletions Carthage/JumioIProov.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"4.5.0": "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.5.0/JumioIProov.xcframework.zip",
}
3 changes: 3 additions & 0 deletions Carthage/Microblink.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"4.5.0": "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.5.0/Pdf417Mobi.xcframework.zip",
}
14 changes: 7 additions & 7 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// swift-tools-version:5.3
import PackageDescription

let version = "4.4.0"
let version = "4.5.0"

let package = Package(
name: "Jumio",
Expand Down Expand Up @@ -31,7 +31,7 @@ let package = Package(
.package(
name: "iProov",
url: "https://github.com/iProov/ios.git",
.exact("10.1.0")
.exact("10.1.3")
),
],
targets: [
Expand Down Expand Up @@ -63,27 +63,27 @@ let package = Package(
.binaryTarget(
name: "Jumio",
url: "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/\(version)/Jumio.xcframework.zip",
checksum: "3c00e83c045c987808311054c0f16800a0bd381d0e73ab66a729893b4fce5a67"
checksum: "5896a0254b1a07438d486522433face219e03ff3be6b7c7a223c9916121c20a3"
),
.binaryTarget(
name: "JumioDocFinder",
url: "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/\(version)/JumioDocFinder.xcframework.zip",
checksum: "3ecc2595d0d8546fcdb766c35663665e4f4b210c9dec633d46dc114c8e26b071"
checksum: "4a41916d5b7e94d8bb0620b94495f93ba3bcae50fa2948e7288e708eda88e40d"
),
.binaryTarget(
name: "JumioDeviceRisk",
url: "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/\(version)/JumioDeviceRisk.xcframework.zip",
checksum: "6f4ceabd4091b5f29ec8dabfa37466886a81ef12683b543d12e52f396f62440e"
checksum: "39da720a0a14dad0963b4fcde77be34c03c49fe9dfcfea8165000f9a76fee166"
),
.binaryTarget(
name: "JumioIProov",
url: "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/\(version)/JumioIProov.xcframework.zip",
checksum: "5fad851accbc44c23856ba521d88cc138930a4356d8aecebaee8ac0aaba971c2"
checksum: "4294240daf9e21be340559798e0b63732db236baf7c744c886c34c397b2b6fbb"
),
.binaryTarget(
name: "Pdf417Mobi",
url: "https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/\(version)/Pdf417Mobi.xcframework.zip",
checksum: "b6d45025a2dd77ce21737a08f2627fc3ad5a572ff45dcd61de43d228f7932575"
checksum: "a84a6eba6215f0c8fbd27ee0be855ff1ccf5ee82e9c3b7f7ac373a0b637516ea"
),
]
)
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
![Jumio](docs/images/jumio_feature_graphic.jpg)

![Version](https://img.shields.io/github/v/release/Jumio/Mobile-SDK-IOS?style=flat)
[![API Doc](https://img.shields.io/github/v/release/Jumio/Mobile-SDK-IOS?label=API%20doc&color=green&style=flat)](https://jumio.github.io/mobile-sdk-ios/Jumio)
![License](https://img.shields.io/cocoapods/l/JumioMobileSDK.svg?style=flat)
![Platform](https://img.shields.io/cocoapods/p/JumioMobileSDK.svg?style=flat)
[![Pod Version](https://img.shields.io/cocoapods/v/Jumio.svg?style=flat)](https://cocoapods.org/pods/Jumio)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Swift Package Manager](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
[![Swift 3.0-5.x](http://img.shields.io/badge/Swift-3.x,%204.x%20&%205.x-orange.svg?style=flat)](https://swift.org/)

# Table of Contents
- [Overview](#overview)
- [Get Started](#get-started)
- [Jumio SDK Integration](docs/integration_guide.md)
- [Jumio SDK Integration](#jumio-sdk-integration)
- [Code Documentation](#code-documentation)
- [FAQ](#faq)
- [Known Issues](#known-issues)
- [Quickstart](#quickstart)
- [Basics](#basics)
- [General Requirements](#general-requirements)
Expand All @@ -20,13 +25,15 @@
- [App Thinning and Size Matters](#app-thinning-and-size-matters)
- [Language Localization](#language-localization)
- [Document Verification](#document-verification)
- [Digital Identity](#digital-identity)
- [Analytics with Datadog](#analytics-with-datadog)
- [Security](#security)
- [Release Notes](#release-notes)
- [Maintenance and Support](#maintenance-and-support)
- [Code Documentation](https://jumio.github.io/mobile-sdk-ios/Jumio/)
- [FAQ](docs/integration_faq.md)
- [Known Issues](docs/known_issues.md)
- [Two-factor Authentication](#two-factor-authentication)
- [Licenses](#licenses)
- [Contact](#contact)
- [Copyright](#copyright)

# Overview
The Jumio Software Development Kit (SDK) provides you with a set of tools and UIs (default or custom) to develop an iOS application perfectly fitted to your specific needs.
Expand Down Expand Up @@ -57,6 +64,15 @@ If you need information on older SDK versions, please refer to:
- [3.9.1](https://github.com/Jumio/mobile-sdk-ios/tree/v3.9.1)
- [3.9.0](https://github.com/Jumio/mobile-sdk-ios/tree/v3.9.0)

## Code Documentation
Full API documentation for the Jumio iOS SDK can be found [here](https://jumio.github.io/mobile-sdk-ios/Jumio).

## FAQ
Link to Jumio iOS SDK FAQ can be found [here](docs/integration_faq.md).

## Known Issues
List of known issues can be found [here](docs/known_issues.md).

-----

# Quickstart
Expand Down Expand Up @@ -225,13 +241,20 @@ For more details, please refer to our [integration guide](docs/integration_guide

ℹ️  __Note:__ To enable the use of this feature, please contact [Jumio support](#support).

# Digital Identity
As of Jumio iOS SDK 4.5.0, users may use their Digital Identity to verify their identity.
For now 'ID by Mastercard' is the only Digital Identity provider currently supported by our SDK.

If you want to enable Digital Identity verification for your account please [contact us](https://support.jumio.com).
In case you are already set up to use Digital Identity verificaiton within your app, check out the integration steps explained [here](docs/integration_guide.md#digital-identity).

# Analytics With Datadog
Analytic feedback and diagnostics enable us to continually improve our SDK and its performance, as well as investigate potential issues. With the Jumio SDK, we use [Datadog](https://github.com/DataDog/dd-sdk-ios) as an optional tool to collect diagnostic information. Data collected includes specific SDK information like version numbers, started and finished SDK instances and scan workflows, thrown exceptions and error information, as well as other mobile events. Please note that gathering analytics data requires user consent due to legal regulations such as GDPR. The consent is granted when our MLA is accepted.

To benefit from Datadog, include the following pod in your Podfile (for more details, see [Cocoapods Section](docs/integration_guide.md#via-cocoapods):

```
pod 'Jumio/Datadog', '~>4.3.1'
pod 'Jumio/Datadog', '~>4.5.0'
```

In this case, it is also necessary to include the following post-install hook in your Podfile:
Expand Down
13 changes: 12 additions & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,20 @@ 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.4.0__
Current SDK version: __4.5.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.5.0__
![Improvement] Added possibility for users to verify their identity using [Digital Identity](../README.md#digital-identity) [ID Verification, Identity Verification]

![Improvement] iProov SDK version update to 10.1.3 [Identity Verification]

![Improvement] Improved user consent handling in accordance with biometric data protection laws [ID Verification, Identity Verification]

![Improvement] Improvement Added Carthage as new option for dependency manager

![Fix] Bug fixes: UI bugs [ID Verification]

## SDK Version: __4.4.0__
![Improvement] Fully redesigned ID Autocapture experience - seamless capturing, precise guidance and faster user journey [ID Verification]

Expand Down
Binary file modified docs/images/capturing_methods/autocapture_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/autocapture_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/barcode_scanning_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/barcode_scanning_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/linefinder_scanning_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/linefinder_scanning_02.png
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.
Binary file modified docs/images/capturing_methods/manual_capturing_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/manual_capturing_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/mrz_scanning_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/capturing_methods/mrz_scanning_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/surface_tool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 15 additions & 14 deletions docs/integration_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Our SDK provides a variety of [customization options](integration_guide.md#custo
### Suggested Improvements with Additional Customization:
![Onboarding good case](images/onboardingGoodCase.jpg)
- Host application has an explanatory help screen that explains what will happen next and why this information is needed.
- In `multipart` ScanParts, the user is guided to move to the next part (e.g. back side of the identity card) with an animation. The extraction should be disabled during this guidance.
- SDK is either customized to have a more embedded appearance or [CustomUI](integration_guide.md#custom-ui) is used to create a completely seamless integration in the UX of our customers.
- Also after the Jumio workflow that shows the displayed results and/or a message that the ID is currently verified, which might take some minutes.

Expand All @@ -39,10 +40,10 @@ The following table highlights the most common error codes which are returned fr

| 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. |
| 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[00][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[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. |

### Ad blockers or Firewall
End users might face the situation where they are connected to a network that can't reach our Jumio endpoints.
Expand All @@ -59,16 +60,16 @@ The following table shows a range of different product configurations with the f

| Product Configuration | Size | Modules |
| :------------------------- | :----: | :-----: |
| Slim | 2.85 MB | base |
| Linefinder | 3.39 MB | base, linefinder |
| MRZ | 4.86 MB | base, mrz, linefinder |
| NFC | 6.02 MB | base, mrz, nfc, linefinder |
| Barcode | 4.37 MB | base, barcode, linefinder |
| All | 6.99 MB | base, mrz, nfc, barcode, linefinder |
| All + Liveness | 8.21 MB | base, mrz, nfc, barcode, linefinder, iproov |
| All + Liveness + DeviceRisk| 8.56 MB | base, mrz, nfc, barcode, linefinder, iproov, devicerisk |
| All + Liveness + DocFinder | 9.82 MB | base, mrz, nfc, barcode, linefinder, iproov, docfinder |
| All + Liveness + Datadog | 8.97 MB | base, mrz, nfc, barcode, linefinder, iproov, datadog |
| Slim | 2.89 MB | base |
| Linefinder | 3.42 MB | base, linefinder |
| MRZ | 4.89 MB | base, mrz, linefinder |
| NFC | 6.05 MB | base, mrz, nfc, linefinder |
| Barcode | 4.40 MB | base, barcode, linefinder |
| All | 7.02 MB | base, mrz, nfc, barcode, linefinder |
| All + Liveness | 8.08 MB | base, mrz, nfc, barcode, linefinder, iproov |
| All + Liveness + DeviceRisk| 8.42 MB | base, mrz, nfc, barcode, linefinder, iproov, devicerisk |
| All + Liveness + DocFinder | 9.69 MB | base, mrz, nfc, barcode, linefinder, iproov, docfinder |
| All + Liveness + Datadog | 8.84 MB | base, mrz, nfc, barcode, linefinder, iproov, datadog |

In case you use a combination of these products, make sure to add frameworks only once to your app and that those frameworks are linked and embedded in your Xcode project.

Expand Down
Loading

0 comments on commit 0b11c69

Please sign in to comment.