iProov Biometrics iOS SDK v12.2.0

Introduction

The iProov Biometrics iOS SDK enables you to integrate iProov into your iOS app. We also have an Android SDK, Xamarin SDK, Flutter SDK, React Native SDK and Web SDK.

Requirements

iOS 13.0 and above
Xcode 15.0.1 and above

The framework has been written in Swift 5.5, and we recommend the use of Swift for the simplest and cleanest integration, however, it is also possible to call iProov from within an Objective-C app using our Objective-C API, which provides an Objective-C friendly API to invoke the Swift code.

Dependencies

The iProov Biometrics SDK includes the following third-party code:

These dependencies are vendored and compiled into the SDK, this requires no action and is provided for information and licensing purposes only.

Module Stability

The iProov SDK supports module stability. The advantage of this is that the SDK does not need to be recompiled for every new version of the Swift compiler.

Repository Contents

The framework package is provided via this repository, which contains the following:

README.md - This document!
Example - A basic sample project using iProov, written in Swift and using CocoaPods.
iProov.xcframework - The iProov framework in XCFramework format. You can add this to your project manually if you aren't using a dependency manager.
iProov.framework - The iProov framework as a "fat" dynamic framework for both device & simulator. (You can use this if you are unable to use the XCFramework version for whatever reason.)
iProovAPIClient.podspec & iProovAPIClient - Files relating to the iOS API client.
iProov.podspec - Required by CocoaPods. You do not need to do anything with this file.
resources - Directory containing additional development resources you may find helpful.
iProovTargets - Directory containing dummy file, required for SPM.
carthage - Directory containing files required for Carthage support.

Upgrading from Earlier Versions

If you're already using an older version of the iProov Biometrics SDK, consult the Upgrade Guide for detailed information about how to upgrade your app.

Registration

You can obtain API credentials by registering on the iProov Portal.

Installation

Integration with your app is supported via CocoaPods, Swift Package Manager, and Carthage. You can also install the SDK manually in Xcode without the use of any dependency manager (this is not recommended). We recommend CocoaPods for the easiest and most flexible installation.

CocoaPods

Note: The SDK is distributed as an XCFramework, therefore you are required to use CocoaPods 1.9.0 or newer.

If you are not yet using CocoaPods in your project, first run sudo gem install cocoapods followed by pod init. (For further information on installing CocoaPods, click here.)
Add the following to your Podfile (inside the target section):
```
pod 'iProov'
```
Run pod install.

Swift Package Manager

Installing via Xcode

Select File → Add Packages… in the Xcode menu bar.
Search for the iProov SDK package using the following URL:
```
https://github.com/iProov/ios
```
Set the Dependency Rule to be Up to Next Major Version and input 12.2.0 as the lower bound.
Click Add Package to add the iProov SDK to your Xcode project and then click again to confirm.

Installing via Package.swift

If you prefer, you can add iProov via your Package.swift file as follows:

.package(
	name: "iProov",
	url: "https://github.com/iProov/ios.git",
	.upToNextMajor(from: "12.2.0")
),

Then add iProov to the dependencies array of any target for which you wish to use iProov.

Carthage

Note: You are strongly advised to use Carthage v0.38.0 or above, which has full support for pre-built XCFrameworks, however older versions of Carthage are still supported (but you must use traditional universal/"fat" frameworks instead).

Add the following to your Cartfile:

binary "https://raw.githubusercontent.com/iProov/ios/master/carthage/IProov.json"

Create the following script named carthage.sh in your root Carthage directory:

# carthage.sh
# Usage example: ./carthage.sh build --platform iOS

set -euo pipefail
 
xcconfig=$(mktemp /tmp/static.xcconfig.XXXXXX)
trap 'rm -f "$xcconfig"' INT TERM HUP EXIT

if [[ "$@" != *'--use-xcframeworks'* ]]; then
	# See https://github.com/Carthage/Carthage/blob/master/Documentation/Xcode12Workaround.md for further details

	CURRENT_XCODE_VERSION="$(xcodebuild -version | grep "Xcode" | cut -d' ' -f2 | cut -d'.' -f1)00"
	CURRENT_XCODE_BUILD=$(xcodebuild -version | grep "Build version" | cut -d' ' -f3)

	echo "EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_simulator__NATIVE_ARCH_64_BIT_x86_64__XCODE_${CURRENT_XCODE_VERSION}__BUILD_${CURRENT_XCODE_BUILD} = arm64 arm64e armv7 armv7s armv6 armv8" >> $xcconfig
	echo 'EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_simulator__NATIVE_ARCH_64_BIT_x86_64__XCODE_'${CURRENT_XCODE_VERSION}' = $(EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_simulator__NATIVE_ARCH_64_BIT_x86_64__XCODE_$(XCODE_VERSION_MAJOR)__BUILD_$(XCODE_PRODUCT_BUILD_VERSION))' >> $xcconfig
	echo 'EXCLUDED_ARCHS = $(inherited) $(EXCLUDED_ARCHS__EFFECTIVE_PLATFORM_SUFFIX_$(EFFECTIVE_PLATFORM_SUFFIX)__NATIVE_ARCH_64_BIT_$(NATIVE_ARCH_64_BIT)__XCODE_$(XCODE_VERSION_MAJOR))' >> $xcconfig
fi

echo 'BUILD_LIBRARY_FOR_DISTRIBUTION=YES' >> $xcconfig

export XCODE_XCCONFIG_FILE="$xcconfig"
carthage "$@"

This script contains an important workaround. When building universal ("fat") frameworks, it ensures that duplicate architectures are not lipo'd into the same framework when building on Apple Silicon Macs, in accordance with the official Carthage workaround (note that the document refers to Xcode 12 but it also applies to Xcode 13 and 14).

Make the script executable:
```
chmod +x carthage.sh
```
You must now use ./carthage.sh instead of carthage to build the dependencies.

Carthage 0.38.0 and above (use XCFrameworks):
```
./carthage.sh update --use-xcframeworks --platform ios
```
Carthage 0.37.0 and below (use universal frameworks):
```
./carthage.sh update --platform ios
```
Add the built .framework/.xcframework file from the Carthage/Build folder to your project in the usual way.

Carthage 0.37.0 and below only:

You should follow the additional instructions here to remove simulator architectures from your universal binaries prior to running your app/submitting to the App Store.

Manual Installation

Select your project in Xcode.
Select your app target.
Select the General tab and then scroll down to Frameworks, Libraries, and Embedded Content.
Add iProov.xcframework from the release assets.

Note: Ensure you add the .xcframework file, rather than the .framework file.
Under the Embed column, ensure Embed & Sign is set.

Add an `NSCameraUsageDescription`

All iOS apps which require camera access must request permission from the user, and specify this information in the Info.plist.

Add an NSCameraUsageDescription entry to your app's Info.plist, with the reason why your app requires camera access (e.g. “To iProov you in order to verify your identity.”)

Get Started

iProov uses Genuine Presence™ technology to assure the identity of a user remotely; ensuring the user is the right person, a real person, and they are authenticating right now. Using our patented Flashmark™ solution, iProov ensures accurate online identity verification.

Get a Token

Before being able to launch iProov, you need to get a token to iProov against. There are 2 different token types:

A verify token - for logging-in an existing user
An enrol token - for registering a new user

iProov offers Genuine Presence Assurance™ technology (also known as "Dynamic Liveness") and Liveness Assurance™ technology (also known as "Express Liveness"):

Genuine Presence Assurance verifies that an online remote user is the right person, a real person and that they are authenticating right now, for purposes of access control and security.
Liveness Assurance verifies a remote online user is the right person and a real person for access control and security.

Please consult our REST API documentation for details on how to generate tokens.

Warning: In a production app, you should always obtain tokens securely via a server-to-server call. To save you from having to setup a server for demo/PoC apps for testing, we provide Swift sample code for obtaining tokens via iProov API v2 with our open-source iOS API Client. You should ensure you migrate to server-to-server calls before going into production, and don't forget to use your production API key & secret!

Launch the SDK

Once you have obtained a token, you can simply call IProov.launch():

import iProov

let token = "{{ your token here }}"
let streamingURLString = "wss://eu.rp.secure.iproov.me/ws" // Substitute as appropriate

guard let streamingURL = URL(string: streamingURLString) else {
    // handle your URL error
}

IProov.launch(streamingURL: streamingURL, token: token) { status in

    switch status {
    case .connecting:
        // The SDK is connecting to the server. You should provide an indeterminate progress indicator
        // to let the user know that the connection is taking place.

    case .connected:
        // The SDK has connected, and the iProov user interface will now be displayed. You should hide
        // any progress indication at this point.

    case let .processing(progress, message):
        // The scan has completed, and the SDK will update your app with the progress of streaming
        // to the server and authenticating the user.
        // This will be called multiple times as the progress updates.

    case let .success(result):
        // The user was successfully verified/enrolled and the token has been validated.
        // You can access the following properties:
        let frame: UIImage? = result.frame // An optional image containing a single frame of the user, if enabled for your service provider (see important security info below)

    case let .failure(result):
        // The user was not successfully verified/enrolled, as their identity could not be verified,
        // or there was another issue with their verification/enrollment.
        // You can access the following properties:
        let reason: FailureReason = result.reason // A reason of why the claim failed
        let feedbackCode: String = reason.feedbackCode // A code referring to the failure reason (see list below)
        let localizedDescription: String = result.localizedDescription // A human-readable suggestion about what to do to get to a successful claim
        let frame: UIImage? = result.frame // An optional image containing a single frame of the user, if enabled for your service provider (see important security info below)

    case let .canceled(canceler):
        // Either:
        //
        // (a) The user canceled iProov by pressing the close button, or sending the
        // app to the background (canceler will be .user), or
        //
        // (b) You canceled iProov by calling cancel() on the SDK (canceler will be .integration) - see cancelation below.

    case let .error(error):
        // The user was not successfully verified/enrolled due to an error (e.g. lost internet connection)
        // along with an `iProovError` with more information about the error (NSError in Objective-C).
        // It will be called once, or never.

    @unknown default:
        // Reserved for future usage.
        break
    }
}

Warning: You should never use iProov as a local authentication method. This means that:

You cannot rely on the fact a successful result was returned to prove that the user was authenticated or enrolled successfully (it is possible the iProov process could be manipulated locally by a malicious user). You can treat the success callback as a hint to your app to update the UI, etc. but you must always independently validate the token server-side (using the /validate API call) before performing any authenticated user actions.

The frame returned in the success & failure results should be used for UI/UX purposes only. If you require an image for upload into your system for any reason (e.g. face matching, image analysis, user profile image, etc.) you should retrieve this securely via the server-to-server /validate API call.

Canceling the SDK

Under normal circumstances, the user will be in control of the completion of the iProov scan, i.e. they will either complete the scan, or use the close button to cancel. In some cases, you (the integrator) may wish to cancel the iProov scan programmatically, for example in response to a timeout or change of conditions in your app.

To cancel the iProov SDK, you first need to hold a reference to the iProov session (returned from IProov.launch()) and you can then call cancel() on it.

let session = IProov.launch(...)

DispatchQueue.main.asyncAfter(deadline: .now() + 10) { // Example - cancel the session after 10 sec
    session.cancel() // Will return true if the session was successfully canceled
}

Options

You can customize the iProov session by passing in an Options reference when launching iProov and setting any of these values:

Option Name	Description	Default Value
`filter`	Adjust the filter used for the face preview. See below for further detail.	`LineDrawingFilter()`
`stringsBundle`	App bundle from which strings should be retrieved.	`nil`
`stringsTable`	App table from which strings should be retrieved.	`nil`
`titleTextColor`	Text color for the title.	`.white`
`closeButtonTintColor`	Tint color applied to the close button.	`.white`
`closeButtonImage`	Image to be used for the close button.
`title`	Title text to be displayed at the top of the screen.	`nil`
`font`	Name of the font to be used for the title & prompt.	`"HelveticaNeue-Medium"`
`logoImage`	Logo to be placed next to the title.	`nil`
`promptTextColor`	Color for prompt text.	`.white`
`promptBackgroundColor`	Color for background of prompt.	`.black.withAlphaComponent(0.8)`
`promptRoundedCorners`	Whether the prompt has rounded (`true`) or straight (`false`) corners.	`true`
`disableExteriorEffects`	Whether the blur and vignette effect outside the oval should be disabled.	`false`
`presentationDelegate`	Custom logic for presenting and dismissing the iProov UI. See below for further details.	`DefaultPresentationDelegate()`
`surroundColor`	Color applied the area outside the oval.	`.black.withAlphaComponent(0.4)`
`headerBackgroundColor`	The color of the header bar.	`nil`
`certificates`	Certificates to be passed as a string (the certificate's Subject Public Key Info as SHA-256 hash). See below for further details.	iProov Server Certificates
`timeout`	Network timeout to be applied to the WebSocket connection.	`10` (seconds)
`viewDelegate`	Optional delegate to receive UI state updates. See below for further details.	nil

Filter Options

The SDK supports two different camera filters:

`LineDrawingFilter`

LineDrawingFilter is iProov's traditional "canny" filter, which is available in 3 styles: .shaded (default), .classic and .vibrant.

The foregroundColor and backgroundColor can also be customized.

Example:

options.filter = Options.LineDrawingFilter(style: .vibrant,
                                           foregroundColor: UIColor.black,
                                           backgroundColor: UIColor.white)

`NaturalFilter`

NaturalFilter provides a more direct visualization of the user's face and is available in 2 styles: .clear (default) and .blur.

Example:

options.filter = Options.NaturalFilter(style: .clear)

Note: NaturalFilter is available for Liveness Assurance claims only. Attempts to use NaturalFilter for Genuine Presence Assurance claims will result in an error.

If disableExteriorEffects is set to true, filter can not be set to NaturalFilter.Style.blur. This combination of options will result in an error.

Certificate Pinning

By default, the iProov SDK pins to the iProov server certificates, which are used by *.rp.secure.iproov.me.

If you are using your own reverse-proxy, you will need to update the pinning configuration to pin to your own certificate(s) instead.

Certificates should be passed as an array of String, where the String is the base64-encoded SHA-256 hash of a certificate's Subject Public Key Info. You can load a certificate as follows:

options.certificates = ["O8qZKEXWWkMPISIpvB7DUow++JzIW2g+k9z3U/l5V94="]

To get Subject Public Key Info from a .crt file, use the following command:

$ openssl x509  -in cert.crt -pubkey -noout | openssl pkey -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64

To get Subject Public Key Info from a .der file, use the following command:

$ openssl x509 -inform der -in cert.der -pubkey -noout | openssl pkey -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64

When multiple certificates are passed, as long as the server matches any of the certificates, the connection will be allowed. Pinning is performed against the public key of the certificate.

You can also disable certificate pinning entirely, by passing an empty array:

options.certificates = []

Warning: Never disable certificate pinning in production apps!

Genuine Presence Assurance Options

GPA-specific options can be set under Options.genuinePresenceAssurance:

Option Name	Description	Default Value
`notReadyOvalStrokeColor`	Color for oval stroke when in a GPA "not ready" state.	`.white`
`readyOvalStrokeColor`	Color for oval stroke when in the GPA "ready" state.	#01AC41
`controlYPosition`	Whether to control y position of the face through showing prompts when using GPA.	false

Liveness Assurance Options

LA-specific options can be set under Options.livenessAssurance:

Option Name	Description	Default Value
`ovalStrokeColor`	Color for oval stroke during LA scan.	`.white`
`completedOvalStrokeColor`	Color for oval stroke after LA scan completes.	#01AC41

Custom `IProovPresentationDelegate`

By default, upon launching the SDK, it will get a reference to your app delegate's window's rootViewController, then iterate through the view controller stack to find the top-most view controller and then present() iProov's view controller as a modal view controller from the top-most view controller on the stack.

This may not always be the desirable behavior; for instance, you may wish to present iProov as part of a UINavigationController-based flow. Therefore, it is also possible to set the options.presentationDelegate property, which allows you to override the presentation/dismissal behavior of the iProov view controller by conforming to the IProovPresentationDelegate protocol:

extension MyViewController: IProovPresentationDelegate {

    func present(iProovViewController: UIViewController, completion: (() -> Void)?) {
        // How should we present the iProov view controller?
    }

    func dismiss(iProovViewController: UIViewController, completion: (() -> Void)?) {
        // How should we dismiss the iProov view controller once it's done?
    }

}

Warning: There are a couple of important rules you must follow when using this functionality:

With great power comes great responsibility! The iProov view controller requires full coverage of the entire screen in order to work properly. Do not attempt to present your view controller to the user in such a way that it only occupies part of the screen, or is obscured by other views. You must also ensure that the view controller is entirely removed from the user's view once dismissed.

To avoid the risk of retain cycles, Options only holds a weak reference to your presentation delegate. Ensure that your presentation delegate is retained for the lifetime of the iProov capture session, or you may result in a defective flow.

Note: The default UI options defined above have been verified to comply with the WCAG 2.1 AA accessibility standard. Changing these values could result in non-compliance with the guidelines.

Optional `IProovViewDelegate`

If you want to receive UI state updates from iProov SDK, you can set an object of a type conforming to IProovViewDelegate protocol to options.viewDelegate.

Example:

extension MyViewController: IProovViewDelegate {
    func willPresentIProovView() {
    	// Called before the iProov user interface is presented.
    }

    func didPresentIProovView() {
    	// Called when the iProov user interface is presented.
    }

    func didDismissIProovView() {
    	// Called when the iProov user interface is dismissed.
    }
}

let myViewController = MyViewController()
options.viewDelegate = myViewController

Localization

The SDK ships with support for the following languages:

English - en
Dutch - nl
French - fr
German - de
Italian - it
Portuguese - pt
Portuguese (Brazil) - pt-BR
Spanish - es
Spanish (Colombia) - es-CO
Welsh - cy-GB

You can customize the strings from your app or localize them into a different language. For further details, see our Localization Guide.

Handling Failures & Errors

Failures

Failures occur when the user's identity could not be verified. A failure means that the capture was successfully received and processed by the server, which returned a result. Crucially, this differs from an error, where the capture itself failed due to a system failure.

Failures are caught via the .failure(reason) enum case in the callback. The reason is an enum with the reason that the user could not be verified/enrolled, which has the following properties:

feedbackCode - A string representation of the feedback code.
localizedDescription - You should present this to the user as it may provide an informative hint for the user to increase their chances of iProoving successfully next time.

The available feedback codes are as follows:

Enum value	`localizedDescription` (English)	GPA	LA
`unknown`	Try again	✅	✅
`tooMuchMovement`	Keep still	✅	⚠️
`tooBright`	Move somewhere darker	✅	⚠️
`tooDark`	Move somewhere brighter	✅	⚠️
`misalignedFace`	Keep your face in the oval	✅	❌
`eyesClosed`	Keep your eyes open	✅	⚠️
`faceTooFar`	Move your face closer to the screen	✅	❌
`faceTooClose`	Move your face farther from the screen	✅	❌
`sunglasses`	Remove sunglasses	✅	⚠️
`obscuredFace`	Remove any face coverings	✅	❌
`multipleFaces`	Ensure only one person is visible	⚠️	⚠️

Key: ✅ = will be returned, ❌ = will not be returned, ⚠️ = may be returned in the future

These are not an indication of tests being performed but only whether reasons of failure are reported.

Errors

Errors occur when the capture could not be completed due to a technical problem or user action which prevents the capture from completing.

Errors are caught via the .error(error) enum case in the callback. The error parameter provides the reason the iProov process failed as an IProovError.

Enum value	Description
`captureAlreadyActive`	An existing iProov capture is already in progress. Wait until the current capture completes before starting a new one.
`cameraPermissionDenied`	The user disallowed access to the camera when prompted. You should direct the user to re-enable camera access via Settings.
`consentRequired`	The user has not granted consent. For iProov internal use only. You can safely ignore.
`networkError(String?)`	An error occurred with the video streaming process. The associated string (if available) will contain further information about the error.
`serverError(String?)`	A server-side error/token invalidation occurred. The associated string (if available) will contain further information about the error.
`unexpectedError(String)`	An unexpected and unrecoverable error has occurred. The associated string will contain further information about the error. These errors should be reported to iProov for further investigation.
`userTimeout`	The user has taken too long to complete the claim.
`notSupported`	The device is not supported.

API Client

The iProov iOS API Client is a simple wrapper for the iProov REST API v2 written in Swift and using Alamofire for use in demo/PoC apps.

For further details, see the documentation in the iProovAPIClient folder.

Example Project

For a simple iProov experience that is ready to run out-of-the-box and uses the iProov API client, check out the Example project.

Installation

Ensure that you have CocoaPods installed and then run pod install from the Example directory to install the required dependencies.
Rename Credentials.example.swift to Credentials.swift and update it with your Base URL, API Key and Secret. You can obtain these credentials from the iProov Portal.
Open Example.xcworkspace.
You can now build and run the project. Please note that you can only launch iProov on a real device; it will not work in the simulator.

Warning: The Example project uses the iOS API Client to directly fetch tokens on-device and this is inherently insecure. Production implementations of iProov should always obtain tokens securely from a server-to-server call.

Help & Support

You may find your question answered in our FAQs or one of our other Wiki pages.

Consult the Documentation Center for the detailed implementation guide, glossary, and API reference.

For further help with integrating the iProov Biometrics SDK, please contact [email protected].

Name		Name	Last commit message	Last commit date
Latest commit History 141 Commits
Example		Example
carthage		carthage
iProov.xcframework		iProov.xcframework
iProovAPIClient		iProovAPIClient
iProovTargets		iProovTargets
images		images
resources		resources
.gitignore		.gitignore
LICENSE.md		LICENSE.md
Package.swift		Package.swift
README.md		README.md
iProov.podspec		iProov.podspec
iProovAPIClient.podspec		iProovAPIClient.podspec

License

iProov/ios

Folders and files

Latest commit

History

Repository files navigation

iProov Biometrics iOS SDK v12.2.0

Introduction

Requirements

Dependencies

Module Stability

Repository Contents

Upgrading from Earlier Versions

Registration

Installation

CocoaPods

Swift Package Manager

Installing via Xcode

Installing via Package.swift

Carthage

Manual Installation

Add an NSCameraUsageDescription

Get Started

Get a Token

Launch the SDK

Canceling the SDK

Options

Filter Options

LineDrawingFilter

NaturalFilter

Certificate Pinning

Genuine Presence Assurance Options

Liveness Assurance Options

Custom IProovPresentationDelegate

Optional IProovViewDelegate

Localization

Handling Failures & Errors

Failures

Errors

API Client

Example Project

Installation

Help & Support

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 58

Packages 0

Contributors 8

Languages

Add an `NSCameraUsageDescription`

`LineDrawingFilter`

`NaturalFilter`

Custom `IProovPresentationDelegate`

Optional `IProovViewDelegate`

Packages