Overview
The Onfido iOS SDK provides a drop-in set of screens and tools for iOS applications to capture identity documents and selfie photos and videos for the purpose of identity verification.
It offers a number of benefits to help you create the best identity verification experience for your customers:
- Carefully designed UI to guide your customers through the photo and video capture process
- Modular design to help you seamlessly integrate the photo and video capture process into your application flow
- Advanced image quality detection technology to ensure the quality of the captured images meets the requirement of the Onfido identity verification process, guaranteeing the best success rate
- Direct image upload to the Onfido service, to simplify integration
Note: The SDK is only responsible for capturing and uploading photos and videos. You still need to access the Onfido API to manage applicants and perform checks.
Getting started
- SDK supports iOS 11+
- SDK supports Xcode 14+*
- SDK has full bitcode support
- SDK supports following presentation styles:
- Only full screen style for iPhones
- Full screen and form sheet styles for iPads
* The latest SDK version to support Xcode 11.5-12 is 22. There is a workaround for older versions of Xcode if required. Please contact support for more information.
The Onfido SDK requires CoreNFC to run. Since Xcode 12 there is a bug where libnfshared.dylib
is missing from simulators. See Stack Overflow to solve this problem.
Even if you don't enable the NFC feature, Apple might ask you to provide a video to demonstrate NFC usage because NFC related code is part of the SDK binary regardless of runtime configuration. While we're working on a permanent solution for this problem, please download the video that has been shared in this post and send to Apple to proceed on your App Review process.
The following content assumes you're using our API v3 versions for backend calls. If you are currently using API v2
please refer to this migration guide for more information.
ℹ️
If you are integrating using Onfido Studio please see our Studio integration guide
1. Obtain an API token
In order to start integrating, you'll need an API token.
You can use our sandbox environment to test your integration. To use the sandbox, you'll need to generate a sandbox API token in your Onfido Dashboard.
Note: You must never use API tokens in the frontend of your application or malicious users could discover them in your source code. You should only use them on your server.
1.1 Regions
Onfido offers region-specific environments. Refer to the Regions section in our API documentation for token format and API base URL information.
2. Create an applicant
To create an applicant from your backend server, make a request to the 'create applicant' endpoint, using a valid API token.
Note: Different report types have different minimum requirements for applicant data. For a Document or Facial Similarity report the minimum applicant details required are first_name
and last_name
.
$ curl https://api.onfido.com/v3/applicants \ -H 'Authorization: Token token=<YOUR_API_TOKEN>' \ -d 'first_name=John' \ -d 'last_name=Smith'
The JSON response will return an id
field containing a UUID that identifies the applicant. Once you pass the applicant ID to the SDK, documents and live photos and videos uploaded by that instance of the SDK will be associated with that applicant.
3. Configure the SDK with token
You'll need to generate and include an SDK token every time you initialize the SDK.
To generate an SDK token, make a request to the 'generate SDK token' endpoint.
$ curl https://api.onfido.com/v3/sdk_token \ -H 'Authorization: Token token=<YOUR_API_TOKEN>' \ -F 'applicant_id=<APPLICANT_ID>' \ -F 'application_id=<YOUR_APPLICATION_BUNDLE_IDENTIFIER>'
Parameter | Notes |
---|---|
applicant_id | required Specifies the applicant for the SDK instance. |
application_id | required The application ID (for iOS "application bundle ID") that was set up during development. For iOS, this is usually in the form com.your-company.app-name . Make sure to use a valid application_id or you'll receive a 401 error. |
SDK tokens expire after 90 minutes.
expireHandler
You can use the optional expireHandler
parameter in the SDK token configurator function to generate and pass a new SDK token when it expires. This ensures the SDK continues its flow even after an SDK token has expired.
For example:
func getSDKToken(_ completion: @escaping (String) -> Void) { <Your network request logic to retrieve SDK token goes here> completion(myNewSDKtoken) } let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN>", expireHandler: getSDKToken)
-(void) getSDKToken: (void(^)(NSString *)) handler { <Your network request logic to retrieve SDK token goes here> handler(sdkToken); } ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN" expireHandler:^(void (^ handler)(NSString * expireHandler)) { [self getSDKToken:handler]; }];
4. App permissions
The SDK uses the device camera. You're required to have the following keys in your application's Info.plist
file:
NSCameraUsageDescription
NSMicrophoneUsageDescription
<key>NSCameraUsageDescription</key> <string>Required for document and facial capture</string> <key>NSMicrophoneUsageDescription</key> <string>Required for video capture</string>
Note: All keys will be required for app submission.
Manual installation
The SDK is available in the GitHub Releases tab where you can download the compressed framework. You can find the latest release here.
- Download the compressed debug zip file containing the
Onfido.framework
. - Uncompress the zip file and then move the
Onfido.framework
artefact into your project. - Add
Onfido.framework
located within your project to theEmbedded binaries
section in theGeneral
tab of your iOS app target. - Open your app's project file in Xcode. Then select your app's target under target list.
- Next select the
Build Phases
tab and under theEmbed Frameworks
step add a newRun Script Phase
. Name itOnfido Framework Archive
. - In the text area add the following code:
if [[ "$ACTION" != "install" ]]; then exit 0; fi FRAMEWORK_DIR="${CONFIGURATION_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}" ONFIDO_FRAMEWORK="${FRAMEWORK_DIR}/Onfido.framework" cd "${ONFIDO_FRAMEWORK}" lipo -remove i386 Onfido -o Onfido lipo -remove x86_64 Onfido -o Onfido
Non-Swift apps
If your app is not Swift based then you must create a new Swift file inside of your project. This file is required to force Xcode to package Swift runtime libraries required for the Onfido iOS SDK to run.
- Create a Swift file with the following contents:
import Foundation import AVFoundation import CoreImage import UIKit import Vision func fixLibSwiftOnoneSupport() { // from https://stackoverflow.com/a/54511127/2982993 print("Fixes dyld: Library not loaded: @rpath/libswiftSwiftOnoneSupport.dylib") }
- Set
Always Embed Swift Standard Libraries
toYes
in your project configuration.
Swift
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN>") .withWelcomeStep() .withDocumentStep() .withProofOfAddressStep() .withFaceStep(ofVariant: .photo(withConfiguration: nil)) .build() let onfidoFlow = OnfidoFlow(withConfiguration: config) .with(responseHandler: { results in // Callback when flow ends })
Objective-C
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN"]; [configBuilder withWelcomeStep]; [configBuilder withDocumentStep]; [configBuilder withProofOfAddressStep]; NSError *variantConfigError = NULL; Builder *variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withPhotoCaptureWithConfig: NULL]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &variantConfigError]]; if (variantConfigError == NULL) { NSError *configError = NULL; ONFlowConfig *config = [configBuilder buildAndReturnError:&configError]; if (configError == NULL) { ONFlow *onFlow = [[ONFlow alloc] initWithFlowConfiguration:config]; [onFlow withResponseHandler:^(ONFlowResponse *response) { // Callback when flow ends }]; } }
Swift
To receive the result from the flow, you should pass a callback to the instance of OnfidoFlow
.
The result object passed to the callback may include the following attributes:
let responseHandler: (OnfidoResponse) -> Void = { response in switch response { case .error(let error): case .success(let results): case .cancel(let reason): } }
Attribute | Notes |
---|---|
.success([OnfidoResult]) | User completed the flow. You can now create a check on your backend server. |
.error(Error) | Some error happened. |
.cancel | Flow was cancelled by the user. The reason can be .userExit (when the user taps back button on the first screen) or .deniedConsent (when the user denies consent on the consent screen). |
Objective-C
To receive the result from the flow, you should pass a callback to the instance of ONFlow
.
An instance of ONFlowResponse
is passed back to the callback with 3 properties:
(^responseHandlerBlock)(ONFlowResponse *response) { if (response.userCanceled) { } else if (response.results) { } else if (response.error) { } }
Properties | Notes |
---|---|
results | User completed the flow. You can now create a check on your backend server. |
error | Some error happened. |
userCanceled | Flow was cancelled by the user. You can check why the user cancelled using response.userCanceled.reason . When userCanceled is false then results or error properties will be set. |
Swift
[OnfidoResult]
is a list with multiple results. The results are different enum values, each with its own associated value (also known as payload). This enum, OnfidoResult
, can have the following values:
OnfidoResult.document
andOnfidoResult.face
: Its payload is relevant in case you want to manipulate or preview the captures in some way.
Capture result payload
You shouldn't need to inspect the results of the document and face captures as the SDK handles file uploads. However, if you want to see further information, you can access the result object.
Example for a document capture:
let document: Optional<OnfidoResult> = results.filter({ result in if case OnfidoResult.document = result { return true } return false }).first if let documentUnwrapped = document, case OnfidoResult.document(let documentResult) = documentUnwrapped { print(documentResult.front.id) }
To access the result object for a face capture input the case
as OnfidoResult.face
.
Objective-C
[ONFlowResult]
is a list with multiple results. The result is an instance of ONFlowResult
containing 2 properties:
type
, which is an enum with valuesONFlowResultTypeDocument
,ONFlowResultTypeFace
result
, which instance type can be ofONDocumentResult
orONFaceResult
. The result type can be derived by thetype
property
Capture result payload
You shouldn't need to inspect the results of the document and face captures as the SDK handles file uploads.However, if you want to see further information, you can access the result object.
Example for a document capture:
NSPredicate *documentResultPredicate = [NSPredicate predicateWithBlock:^BOOL(id flowResult, NSDictionary *bindings) { if (((ONFlowResult *)flowResult).type == ONFlowResultTypeDocument) { return YES; } else { return NO; } }]; NSArray *flowWithDocumentResults = [results filteredArrayUsingPredicate:documentResultPredicate]; if (flowWithDocumentResults.count > 0) { ONDocumentResult *documentResult = ((ONFlowResult *)flowWithDocumentResults[0]).result; NSLog(@"%@", documentResult.front.id); }
To access the result object for a face capture change the type to ONFlowResultTypeFace
.
Response Handler Errors
The Error
object returned as part of OnfidoResponse.error(Error)
is of type OnfidoFlowError
. It's an enum with multiple cases depending on the error type.
switch response { case let OnfidoResponse.error(error): switch error { case OnfidoFlowError.cameraPermission: // It happens if the user denies permission to the sdk during the flow case OnfidoFlowError.microphonePermission: // It happens when the user denies permission for microphone usage by the app during the flow case OnfidoFlowError.motionUnsupported: // It happens when the device does not support the Motion product and no fallback capture method has been configured case OnfidoFlowError.failedToWriteToDisk: // It happens when the SDK tries to save capture to disk, maybe due to a lack of space case OnfidoFlowError.upload(let OnfidoApiError): // It happens when the SDK receives an error from a API call see [https://documentation.onfido.com/#errors](https://documentation.onfido.com/#errors) for more information case OnfidoFlowError.exception(withError: let error, withMessage: let message): // It happens when an unexpected error occurs, please contact [ios-sdk@onfido.com](mailto:ios-sdk@onfido.com?Subject=ISSUE%3A) when this happens case OnfidoFlowError.invalidImageData: // It happens when the SDK tries to save capture to disk, but the image failed to compress to JPEG data case OnfidoFlowError.versionInsufficient: // It happens when the workflow version is insufficient default: // necessary because swift } }
Note: Not all errors will be passed to OnfidoResponse.error
. Run Exceptions and Configuration errors will be returned as an exception.
Run exceptions
When initiating the SDK there can be an exception.
You can handle run exceptions in Swift with a do/catch
as shown below:
do { try onfidoFlow.run(from: yourViewController, animated: true) } catch let error { switch error { case OnfidoFlowError.cameraPermission: // do something about it here case OnfidoFlowError.microphonePermission: // do something about it here default: // should not happen, so if it does, log it and let us know } }
Configuration errors
You must provide the following when configuring the Onfido iOS SDK:
- SDK token
- applicant
- at least one capture step
Otherwise, you may encounter the following errors when calling the build()
function on the OnfidoConfig.Builder
instance:
Error | Notes |
---|---|
OnfidoConfigError.missingSDKToken | When no token is provided or the token is an empty string. |
OnfidoConfigError.invalidSDKToken | When an invalid token is provided. |
OnfidoConfigError.missingSteps | When no step is provided. |
OnfidoConfigError.invalidDocumentFormatAndCountryCombination | When it is an unsupported document format for the specified country provided. See Document Type Configuration to check supported combinations. |
OnfidoConfigError.invalidCountryCode | When an invalid country code is provided. |
Response Handler Errors
The error
property of the ONFlowResponse
is of type NSError
.
You can identify the error by comparing the code
property of the NSError
instance with ONFlowError
, i.e. response.code == ONFlowErrorCameraPermission
. You can also print or log the userInfo
property of the NSError
instance.
The NSError
contained within the ONFlowResponse
's error
property can be handled as follows:
switch (error.code) { case ONFlowErrorCameraPermission: // It happens if the user denies permission to the sdk during the flow break; case ONFlowErrorMicrophonePermission: // It happens when the user denies permission for microphone usage by the app during the flow break; case ONFlowErrorMotionUnsupported: // It happens when the device does not support the Motion product and no fallback capture method has been configured break; case ONFlowErrorFailedToWriteToDisk: // It happens when the SDK tries to save capture to disk, maybe due to a lack of space break; case ONFlowErrorUpload: // It happens when the SDK receives an error from a API call see [https://documentation.onfido.com/#errors](https://documentation.onfido.com/#errors) for more information // you can find out more by printing or logging userInfo from error break; case ONFlowErrorException: // It happens when an unexpected error occurs, please contact [ios-sdk@onfido.com](mailto:ios-sdk@onfido.com?Subject=ISSUE%3A) when this happens break; case ONFlowErrorInvalidImageData: // It happens when the SDK tries to save capture to disk, but the image failed to compress to JPEG data break; case ONFlowErrorVersionInsufficient: // It happens when the workflow version is insufficient break; }
Note: Not all errors which are part of ONFlowError
will be passed to the response handler block. Run Exceptions and Configuration errors will be returned as an exception.
Run exceptions
You can handle run exceptions as shown below:
NSError *runError = NULL; [onFlow runFrom:yourViewController animated:YES error:&runError completion:nil]; //`yourViewController` should be your view controller if (runError) { switch (runError.code) { case ONFlowErrorCameraPermission: // do something about it here break; case ONFlowErrorMicrophonePermission: // do something about it here break; default: // do something about it here break; } }
Configuration errors
You must provide the following when configuring the Onfido iOS SDK:
- SDK token
- applicant
- at least one capture step
Otherwise you may encounter the following errors when calling the build()
function on the ONFlowConfigBuilder
:
Error | Notes |
---|---|
ONFlowConfigErrorMissingToken | When no token is provided or the token is an empty string. |
ONFlowConfigErrorMissingApplicant | When no applicant instance is provided. |
ONFlowConfigErrorMissingSteps | When no step is provided. |
ONFlowConfigErrorMultipleTokenTypes | When both an SDK token and a Mobile token are provided. |
ONFlowConfigErrorApplicantProvidedWithSDKToken | When both an SDK token and an applicant are provided. |
ONFlowConfigErrorInvalidDocumentFormatAndCountryCombination | When it is an unsupported document format for the specified country provided. See Document Type Configuration to check supported combinations. |
ONFlowConfigErrorInvalidCountryCode | When an invalid country code is provided. |
Introduction
Onfido provides the possibility to integrate with our Smart Capture SDK, without the requirement of using this data only through the Onfido API. Media callbacks enable you to control the end user data collected by the SDK after the end user has submitted their captured media. As a result, you can leverage Onfido’s advanced on-device technology, including image quality validations, while still being able to handle end users’ data directly. This unlocks additional use cases, including compliance requirements and multi-vendor configurations, that require this additional flexibility.
This feature must be enabled for your account. Please contact your Onfido Solution Engineer or Customer Success Manager.
Swift
final class SwiftDynamicFrameworkOnfidoRunner: OnfidoRunner, MediaCallback { func onMediaCaptured(result: MediaResult) { switch result { case let documentResult as MediaDocumentResult: // Your callback code here case let selfieResult as SelfieResult: // Your callback code here case let livenessResult as LivenessResult: // Your callback code here default: Break } } configBuilder.withMediaCallback(mediaCallback: self) }
User data
The callbacks return an object including the information that the SDK normally sends directly to Onfido. The callbacks are invoked when the end user confirms submission of their image through the SDK’s user interface.
Note: Currently, end user data will still automatically be sent to the Onfido backend, but you are not required to use Onfido to process this data.
The callback returns 3 possible objects:
- For documents, the callback returns a
MediaDocumentResult
object:
{ metadata: DocumentMetadata file: MediaFile }
The DocumentMetadata
object contains the metadata of the captured document:
{ side: String type: String issuingCountry: String? }
Note: issuingCountry
is optional based on end-user selection, and can be null
.
Note: If a document was scanned using NFC, the callback will return the passport photo in file
but no additional data.
- For live photos, the callback returns a
SelfieResult
object:
{ fileData: MediaFile }
- For videos, the callback returns a
LivenessResult
object:
{ fileData: MediaFile }
And the MediaFile
object has:
{ fileData: Data fileName: String fileType: String }
Create a check with Onfido
After receiving the user data from the SDK, you can choose to create a check with Onfido. In this case, you don’t need to re-upload the end user data as it is sent automatically from the SDK to the Onfido backend.
Please see our API documentation for more information on how to create a check.
Customizing SDK
The iOS SDK has multiple customizable options. You can also read our SDK customization guide.
Objective-C
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"]; ... [configBuilder withWelcomeStep]; NSError *configError = NULL; ONFlowConfig *config = [configBuilder buildAndReturnError:&configError]; if (configError) { // Handle config build error } else { // use config }
Document step
In the Document Capture step, an end user can select the issuing country and document type before capture. In a very limited number of cases, the end user may also be asked if they have a card or paper version of their document.
This information is used to optimize the capture experience, as well as inform the end user about which documents they are allowed to use.
This selection screen is optional, and will be automatically hidden where the end user is not required to indicate which document will be captured.
By default, the country selection will be pre-populated based on the end user’s primary SIM, but the end user can select another country from the list where allowed. The selection will default to empty when no SIM is present.
You can specify allowed issuing countries and document types for the document capture step in one of three ways:
- If you are using Onfido Studio, this is configured within a Document Capture task, documented in the Studio Product Guide
- Otherwise, for Onfido Classic you can set this globally in your Dashboard (recommended), or hard code it into your SDK integration. Both of these options are documented below.
Country and document type selection by Dashboard
Configuring the issuing country and document type selection step using your Dashboard is the recommended method of customization (available from iOS SDK version 28.0.0 and Android SDK version 16.0.0 onwards) as this configuration is also applied to your Document Reports. Any document that has been uploaded by an end user against your guidance will result in a Document Report sub-result of “rejected” and be flagged as Image Integrity > Supported Document.
We will be rolling out Dashboard-based configuration of allowed documents soon. In the meantime, contact support@onfido.com or your Customer Support Manager to request access to this feature.
- Open the Accounts tab on your Dashboard then click Supported Documents
- You will be presented with a list of all available countries and their associated supported documents. Make your selection, then click Save Change
Please note the following SDK behaviour:
- Hard coding any document type and issuing country configuration in your SDK integration will fully override the Dashboard-based settings
- Currently, only passport, national ID card, driving licence and residence permit are visible for document selection by the end user in the SDK. If you nominate other document types in your Dashboard (visa, for example), these will not be displayed in the user interface
- If you need to add other document types to the document selection screen, you can mitigate this limitation in the near-term, using the Custom Document feature
- If for any reason the configuration fails or is not enabled, the SDK will fallback to display the selection screen for the complete list of documents supported within the selection screens
Country and document type selection - SDK integration code
If you want to use your own custom document selection UI instead of displaying the Onfido document selection screen, you will need to specify the document details during SDK initialization.
The document selection screen will be skipped automatically when the single document type is specified.
The SDK will accept the following:
- The Document Type is required. This controls fundamental SDK document capture behaviour
- The Country is optional, but recommended. This enables any optimizations the SDK may have for this specific document issued by this country
- The Document Format is optional, and only accepted for French driving licence, Italian national identity card and South African national identity card This defaults to Card, representing modern forms of these documents. If the end user indicates that they have an older, paper version of one of these documents, use Folded to ensure an optimized capture experience
See more details in the Technical Reference, here for Android, and here for iOS.
Note: You may still wish to configure the Dashboard-based approach to ensure that the Document Report also rejects any document that has been uploaded by an end user against your guidance.
- Document type
The list of document types visible for the user to select can be shown or hidden using this option. Each document type has its own configuration class. While configuring document type, you can optionally pass a configuration object along with the document type.
The following document types are supported:
Document Type | Configuration Class | Configurable Properties |
---|---|---|
passport | PassportConfiguration | - country |
drivingLicence | DrivingLicenceConfiguration | - country - documentFormat |
nationalIdentityCard | NationalIdentityConfiguration | - country - documentFormat |
residencePermit | ResidencePermitConfiguration | - country |
visa | VisaConfiguration | - country |
workPermit | WorkPermitConfiguration | - country |
Note: If only one document type is specified, users will not see the selection screen and will be taken directly to the capture screen. Please see a more detailed guide here for Android, and here for iOS
- Document country
Country configuration allows you to specify the country of origin of the document. This is optional, but recommended. This enables any optimizations the SDK may have for this specific document issued by this country.
You'll need to pass the corresponding ISO 3166-1 alpha-3 3 letter country code to the SDK.
Note: You can specify country for all document types except passport
. This is because passports have the same format worldwide so the SDK does not require this additional information.
Note:: The SDK will throw a OnfidoConfigError.invalidCountryCode
(ONFlowConfigErrorInvalidCountryCode
) error if an invalid country code is provided.
For example, to only capture UK driving licenses:
Objective-C
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"]; NSError *documentConfigError = NULL; DocumentConfigBuilder *documentConfigBuilder = [ONDocumentTypeConfig builder]; [documentConfigBuilder withDrivingLicenceWithConfig:[[DrivingLicenceConfiguration alloc] initWithCountry: @"GBR"]]; ONDocumentTypeConfig *documentTypeConfig = [documentConfigBuilder buildAndReturnError: documentConfigError]; if (documentConfigError) { // Handle variant config error } else { NSError *configError = NULL; [configBuilder withDocumentStepOfType:documentTypeConfig]; ONFlowConfig *config = [configBuilder buildAndReturnError:&configError]; }
- Document format
The Document Format is optional, and only accepted for French driving licence, Italian national identity card and South African national identity card This defaults to Card
, representing modern forms of these documents. If the end user indicates that they have an older, paper version of one of these documents, use Folded
to ensure an optimized capture experience
If Folded
is configured the SDK will show a specific template overlay during document capture.
The following document formats are supported for each document type:
Document Type/ Document Format | card | folded |
---|---|---|
drivingLicence | ALL COUNTRIES | Only France (Country code "FRA") |
nationalIdentityCard | ALL COUNTRIES | Italy (Country code "ITA") South Africa (Country code "ZAF") |
Document Type/ Document Format | |
---|---|
passport | NOT CONFIGURABLE |
residencePermit | NOT CONFIGURABLE |
visa | NOT CONFIGURABLE |
workPermit | NOT CONFIGURABLE |
Note: If you configure the SDK with an unsupported document format the SDK will throw an OnfidoConfigError.invalidDocumentFormatAndCountryCombination
(ONFlowConfigErrorInvalidDocumentFormatAndCountryCombination
in Objective-C) error during runtime.
For example, for a folded Italian national identity card:
Objective-C
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"]; NSError *documentConfigError = NULL; DocumentConfigBuilder *documentConfigBuilder = [ONDocumentTypeConfig builder]; [documentConfigBuilder withNationalIdentityCardWithConfig:[[NationalIdentityConfiguration alloc] initWithDocumentFormat:DocumentFormatFolded country: @"ITA"]]; ONDocumentTypeConfig *documentTypeConfig = [documentConfigBuilder buildAndReturnError: documentConfigError]; if (documentConfigError) { // Handle variant config error } else { NSError *configError = NULL; [configBuilder withDocumentStepOfType:documentTypeConfig]; ONFlowConfig *config = [configBuilder buildAndReturnError:&configError]; }
- Customize the issuing country and document type selection screen with pre-selected documents
You can also customize the screen to display only a limited list of document types, using the configuration function to specify the ones you want to show.
Currently you can only include passport
, identityCard
, drivingLicence
, residencePermit
in the list.
For example, to show only the passport
and drivingLicence
document types:
Face step
In the Face step, a user can use the front camera to capture a live photo of their face (Photo), a live video (Video) or a motion capture using the Motion product (Motion).
The Face step has 3 variants for the Swift interface:
FaceStepVariant.photo(with: PhotoStepConfiguration?)
FaceStepVariant.video(with: VideoStepConfiguration?)
FaceStepVariant.motion(with: MotionStepConfiguration?)
For the Objective-C interface, you should use ONFaceStepVariantConfig
as below.
To configure for a live photo:
NSError * error; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withPhotoCaptureWithConfig: [[PhotoStepConfiguration alloc] initWithShowSelfieIntroScreen: YES]]]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &error]];
To configure for a live video:
NSError * error; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withVideoCaptureWithConfig: [[VideoStepConfiguration alloc] initWithShowIntroVideo: YES manualLivenessCapture: NO]]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &error]];
To configure for Motion:
The Motion variant may not be supported on certain devices based on minimum device and OS requirements, i.e. Motion currently is not supported on devices older than iPhone 7 and/or on iOS older than 12 as well as on iPads.
If the Motion variant is not supported on the user's device, you can configure the SDK to allow the user to capture a Selfie or a Video instead by using the MotionStepCaptureFallback
class.
The following examples show how to configure the Motion variant with a Photo capture fallback and a Video capture fallback.
Please note that if no fallback is configured and Motion is not supported on the user's device, an ONFlowError
of case motionUnsupported
will be returned through the response handler.
To configure for Motion with fallback to capturing a live photo:
NSError * error; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withMotionWithConfig: [[MotionStepConfiguration alloc] initWithCaptureFallback: [[MotionStepCaptureFallback alloc] initWithPhotoFallbackWithConfiguration: [[PhotoStepConfiguration alloc] initWithShowSelfieIntroScreen: YES]]]]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &error]];
To configure for Motion with fallback to capturing a live video:
NSError * error; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withMotionWithConfig: [[MotionStepConfiguration alloc] initWithCaptureFallback: [[MotionStepCaptureFallback alloc] initWithVideoFallbackWithConfiguration: [[VideoStepConfiguration alloc] initWithShowIntroVideo: YES manualLivenessCapture: NO]]]]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &error]];
To configure for Motion with no fallback:
NSError * error; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withMotionWithConfig: NULL]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &error]];
To configure for Motion with audio recording:
NSError * error; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withMotionWithConfig: [[MotionStepConfiguration alloc] initWithRecordAudio: YES]]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &error]];
Swift
To configure for a live photo:
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN_HERE>") .withWelcomeStep() .withDocumentStep() .withFaceStep(ofVariant: .photo(withConfiguration: PhotoStepConfiguration(showSelfieIntroScreen: true))) .build()
To configure for a live video:
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN_HERE>") .withWelcomeStep() .withDocumentStep() .withFaceStep(ofVariant: .video(withConfiguration: VideoStepConfiguration(showIntroVideo: true, manualLivenessCapture: false))) .build()
To configure for Motion:
The Motion variant may not be supported on certain devices based on minimum device and OS requirements, i.e. Motion currently is not supported on devices older than iPhone 7 and/or on iOS older than 12 as well as on iPads.
If the Motion variant is not supported on the user's device, you can configure the SDK to allow the user to capture a Selfie or a Video instead by using the MotionStepCaptureFallback
class.
The following examples show how to configure the Motion variant with a Photo capture fallback and a Video capture fallback.
Please note that if no fallback is configured and Motion is not supported on the user's device, an ONFlowError
of case motionUnsupported
will be returned through the response handler.
To configure for Motion with fallback to capturing a live photo:
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN_HERE>") .withWelcomeStep() .withDocumentStep() .withFaceStep(ofVariant: .motion(withConfiguration: MotionStepConfiguration(captureFallback: MotionStepCaptureFallback(photoFallbackWithConfiguration: PhotoStepConfiguration(showSelfieIntroScreen: true))))) .build()
To configure for Motion with fallback to capturing a live video:
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN_HERE>") .withWelcomeStep() .withDocumentStep() .withFaceStep(ofVariant: .motion(withConfiguration: MotionStepConfiguration(captureFallback: MotionStepCaptureFallback(videoFallbackWithConfiguration: VideoStepConfiguration(showIntroVideo: true, manualLivenessCapture: false))))) .build()
To configure for Motion with no fallback:
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN_HERE>") .withWelcomeStep() .withDocumentStep() .withFaceStep(ofVariant: .motion(withConfiguration: nil)) .build()
To configure for Motion with audio recording:
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN_HERE>") .withWelcomeStep() .withDocumentStep() .withFaceStep(ofVariant: .motion(withConfiguration: MotionStepConfiguration(recordAudio: true))) .build()
Objective-C
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"]; [configBuilder withWelcomeStep]; [configBuilder withDocumentStep]; NSError *variantError = NULL; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withVideoCaptureWithConfig: [[VideoStepConfiguration alloc] initWithShowIntroVideo: YES]]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &variantError]]; if (variantError) { // Handle variant config error } else { NSError *configError = NULL; ONFlowConfig *config = [configBuilder buildAndReturnError:&configError]; if (configError) { // Handle config build error } else { // use config } }
Objective-C
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"]; [configBuilder withProofOfAddressStep]; NSError *configError = NULL; ONFlowConfig *config = [configBuilder buildAndReturnError:&configError]; if (configError) { // Handle config build error } else { // use config }
NFC capture
Recent passports, national identity cards and residence permits contain a chip that can be accessed using Near Field Communication (NFC). The Onfido SDKs provide a set of screens and functionalities to extract this information, verify its authenticity and provide the results as part of a Document report. With version [29.1.0] of the Onfido iOS SDK, NFC is enabled by default and offered to customer when both the document and the device support NFC.
For more information on how to configure NFC and the list of supported documents, please refer to the NFC for Document Report guide.
Pre-requisites
This feature requires
Near Field Communication Tag Reading
capability in your app target. If you haven't added it before, please follow the steps in Apple's documentation.You're required to have the following key in your application's
Info.plist
file:
<key>NFCReaderUsageDescription</key> <string>Required to read ePassports</string>
- You have to include the entries below in your app target's
Info.plist
file to be able to read NFC tags properly.
<key>com.apple.developer.nfc.readersession.felica.systemcodes</key> <array> <string>12FC</string> </array> <key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key> <array> <string>A0000002471001</string> <string>A0000002472001</string> <string>00000000000000</string> <string>D2760000850101</string> </array>
UI customization
The iOS SDK supports the customization of colors, fonts and strings used in the SDK flow. For visualizations of the available options please see our SDK customization guide.
Swift
let appearance = Appearance() appearance.primaryColor = <DESIRED_UI_COLOR_HERE> appearance.primaryTitleColor = <DESIRED_UI_COLOR_HERE> appearance.secondaryTitleColor = <DESIRED_UI_COLOR_HERE> appearance.primaryBackgroundPressedColor = <DESIRED_UI_COLOR_HERE> appearance.secondaryBackgroundPressedColor = <DESIRED_UI_COLOR_HERE> appearance.backgroundColor = <DESIRED_UI_COLOR_HERE> appearance.borderCornerRadius = <DESIRED_CGFLOAT_BORDER_RADIUS_HERE> appearance.fontRegular = <DESIRED_FONT_NAME_HERE> appearance.fontBold = <DESIRED_FONT_NAME_HERE> appearance.setUserInterfaceStyle(<.unspecified | .light | .dark>) appearance.captureSuccessColors = <CaptureSuccessColors object>
Objective-C
ONAppearance *appearance = [[ONAppearance alloc] init]; appearance.primaryColor = <DESIRED_UI_COLOR_HERE>; appearance.primaryTitleColor = <DESIRED_UI_COLOR_HERE>; appearance.secondaryTitleColor = <DESIRED_UI_COLOR_HERE>; appearance.primaryBackgroundPressedColor = <DESIRED_UI_COLOR_HERE>; appearance.secondaryBackgroundPressedColor = <DESIRED_UI_COLOR_HERE>; appearance.backgroundColor = <DESIRED_UI_COLOR_HERE>; appearance.buttonCornerRadius = <DESIRED_CGFLOAT_BORDER_RADIUS_HERE>; appearance.fontRegular = <DESIRED_FONT_NAME_HERE>; appearance.fontBold = <DESIRED_FONT_NAME_HERE>; [appearance setUserInterfaceStyle: <.unspecified | .light | .dark>]; appearance.captureSuccessColors = <CaptureSuccessColors object>;
primaryColor
: Defines the button color and back navigation button colorprimaryTitleColor
: Defines the primary button text colorsecondaryTitleColor
: Defines the secondary button text and border colorprimaryBackgroundPressedColor
: Defines the primary button pressed state colorsecondaryBackgroundPressedColor
: Defines the secondary button pressed state colorbackgroundColor
: Defines the screen's background colorborderCornerRadius
: Defined border corner radius for all the buttons (default 5.0)fontRegular
: Defines the custom font name for the regular style labelsfontBold
: Defines the custom font name for the bold style labelsinterfaceStyle
: Defines the interface style. The value is unspecified by default. Note: This property is applicable only for Xcode 11 and above built apps and devices running on iOS 13 and abovecaptureSuccessColors
: Defines the color values for the capture screen success auto capture stateborderColor
: Defines the border color of the area of interest in capture screentickViewImageTintColor
: Defines the tick icon's tint color shown in capture screen after auto capture happenstickViewBackgroundColor
: Defines the tick icon's background color shown in capture screen after auto capture happens
Dark Mode only UI customisation
To just change the user interface style to .dark
, you can use initialiser below:
Language customization
The SDK supports and maintains the following 44 languages:
- Arabic: ar
- Armenian: hy
- Bulgarian: bg
- Chinese (Simplified): zh-Hans
- Chinese (Traditional): zh-Hant
- Croatian: hr
- Czech: cs
- Danish: da
- Dutch: nl
- English (United Kingdom): en-GB
- English: en
- Estonian: et
- Finnish: fi
- French (Canadian): fr-CA
- French: fr
- German: de
- Greek: el
- Hebrew: he
- Hindi: hi
- Hungarian: hu
- Indonesian: id
- Italian: it
- Japanese: ja
- Korean: ko
- Latvian: lv
- Lithuanian: lt
- Malay: ms
- Norwegian (Bokmål): no
- Persian: fa
- Polish: pl
- Portuguese (Brazil): pt-BR
- Portuguese: pt
- Romanian: ro
- Russian: ru
- Serbian (Latin): sr-Latn
- Slovak: sk
- Slovenian: sl
- Spanish (Latin America): es-419
- Spanish: es
- Swedish: sv
- Thai: th
- Turkish: tr
- Ukrainian: uk
- Vietnamese: vi
The strings used within the SDK can be customised by having a Localizable.strings
in your app for the desired language and by configuring the flow using withCustomLocalization()
method on the configuration builder.
You can find the keys for the localizable strings under the localization
directory which contains strings files for supported languages.
Swift
let config = try OnfidoConfig.builder() .withSDKToken("<YOUR_SDK_TOKEN_HERE>") .withWelcomeStep() .withDocumentStep(ofType: .drivingLicence(config: DrivingLicenceConfiguration(country: "GBR"))) .withFaceStep(ofVariant: .photo(withConfiguration: nil)) .withCustomLocalization() // will look for localizable strings in your Localizable.strings file .build()
Objective-C
ONFlowConfigBuilder *configBuilder = [ONFlowConfig builder]; [configBuilder withSdkToken:@"YOUR_SDK_TOKEN_HERE"]; [configBuilder withWelcomeStep]; [configBuilder withDocumentStepOfType:ONDocumentTypeDrivingLicence andCountryCode:@"GBR"]; NSError *variantError = NULL; Builder * variantBuilder = [ONFaceStepVariantConfig builder]; [variantBuilder withPhotoCaptureWithConfig: NULL]; [configBuilder withFaceStepOfVariant: [variantBuilder buildAndReturnError: &variantError]]; if (variantError) { // Handle variant config error } else { [configBuilder withCustomLocalization]; // will look for localizable strings in your Localizable.strings file NSError *configError = NULL; ONFlowConfig *config = [configBuilder buildAndReturnError:&configError]; }
Custom languages
The SDK can also be displayed in a custom language for locales that Onfido does not currently support. You can supply full or partial translations. For any key without a translation, the supported language default will be used.
When adding custom translations, you must add the whole set of keys included in the Localizable.strings
file.
You can name the strings file with the translated keys as you desire but the name of the file will have to be provided to the SDK as a parameter to the withCustomLocalization()
method:
withCustomLocalization(andTableName: "MY_CUSTOM_STRINGS_FILE")
(swift) or [configBuilder withCustomLocalizationWithTableName:@"MY_CUSTOM_STRINGS_FILE"];
(Objective-C).
Additionally you can specify the bundle from which to read the strings file:
withCustomLocalization(andTableName: "MY_CUSTOM_STRINGS_FILE", in: myBundle)
(swift)
[configBuilder withCustomLocalizationWithTableName:@"MY_CUSTOM_STRINGS_FILE" in: myBundle];
(Objective-C).
Note: If string translations change it will result in a MINOR version change. If you have custom translations you're responsible for testing your translated layout.
If you want a language translated you can get in touch with us at ios-sdk@onfido.com
Creating checks
The SDK is responsible for the capture of identity documents and selfie photos and videos. It doesn't perform any checks against the Onfido API. You need to access the Onfido API in order to manage applicants and perform checks.
For a walkthrough of how to create a check with a Document and Facial Similarity report using the iOS SDK read our Mobile SDK Quick Start guide.
Read our API documentation for further details on how to create a check with the Onfido API.
Note: If you're testing with a sandbox token, please be aware that the results are pre-determined. You can learn more about sandbox responses.
Note: If you're using API v2, please refer to the API v2 to v3 migration guide for more information.
Setting up webhooks
Reports may not return results straightaway. You can set up webhooks to be notified upon completion of a check or report, or both.
Overriding the hook
In order to expose a user's progress through the SDK a hook method must be defined while creating the OnfidoFlow.swift
instance using a .with(eventHandler: EventHandler)
call. For example:
OnfidoFlow(withConfiguration: config) .with(eventHandler: { (event: Event) -> () in // Your code here })
The code inside of the defined method will now be called when a particular event is triggered, usually when the user reaches a new screen. For a full list of events see tracked events.
The parameter being passed in is an OnfidoFlow.Event
struct which contains the following:
eventName | string < /br> Indicates the type of event. This will always be returned as "Screen" as each tracked event is a user visiting a screen. |
properties | dictionary < /br> Contains the specific details of an event. For example, the name of the screen visited. |
Tracked events
Below is the list of potential events currently being tracked by the hook:
WELCOME - User reached the "Welcome" screen USER_CONSENT - User reached "user consent" screen DOCUMENT_CAPTURE - User reached the "document capture" screen (for one-sided document) DOCUMENT_CAPTURE_FRONT - User reached the "document capture" screen for the front side (for two-sided document) DOCUMENT_CAPTURE_BACK - User reached the "document capture" screen for the back side (for two-sided document) DOCUMENT_CAPTURE_CONFIRMATION - User reached the "document confirmation" screen (for one-sided document) DOCUMENT_CAPTURE_CONFIRMATION_FRONT - User reached the "document confirmation" screen for the front side (for two-sided document) DOCUMENT_CAPTURE_CONFIRMATION_BACK - User reached the "document confirmation" screen for the back side (for two-sided document) DOCUMENT_UPLOAD - User's document is uploading FACIAL_INTRO - User reached the "selfie intro" screen FACIAL_CAPTURE - User reached the "selfie capture" screen FACIAL_CAPTURE_CONFIRMATION - User reached the "selfie confirmation" screen FACIAL_UPLOAD - User's selfie is uploading VIDEO_FACIAL_INTRO - User reached the "liveness intro" screen VIDEO_FACIAL_CAPTURE - User reached the "liveness video capture" screen VIDEO_FACIAL_CAPTURE_STEP_1 - User reached the 1st challenge during "liveness video capture", challenge_type can be found in eventProperties VIDEO_FACIAL_CAPTURE_STEP_2 - User reached the 1st challenge during "liveness video capture", challenge_type can be found in eventProperties VIDEO_FACIAL_CAPTURE_CONFIRMATION - User reached the "liveness video confirmation" screen VIDEO_FACIAL_UPLOAD - User's liveness video is uploading MOTION_FACIAL_INTRO - User reached the "motion intro" screen MOTION_FACIAL_ALIGNMENT - User reached the "motion alignment" screen MOTION_FACIAL_CAPTURE - User reached the "motion capture" screen MOTION_FACIAL_NO_FACE_DETECTED - User's face was not detected MOTION_FACIAL_CAPTURE_ERROR_TIMEOUT - User's motion capture timed out MOTION_FACIAL_CAPTURE_ERROR_TOO_FAST - User performed the motion headturn too fast MOTION_FACIAL_UPLOAD - User's motion capture is uploading MOTION_FACIAL_UPLOAD_COMPLETED - User's motion capture finished uploading MOTION_FACIAL_CONNECTION_ERROR - User was presented the "motion connection error" screen during upload
Going live
Once you are happy with your integration and are ready to go live, please contact Client Support to obtain a live API token. You will have to replace the sandbox tokens in your code with the live tokens.
Check the following before you go live:
- you have set up webhooks to receive live events
- you have entered correct billing details inside your Onfido Dashboard
Size Impact
User iOS Version | SDK Size Impact (MB) |
---|---|
12.2 and above | $SIZE_IMPACT_TEXT_1 |
Below 12.2 | $SIZE_IMPACT_TEXT_2 |
* If the application is in Swift but doesn't include any Swift libraries that Onfido iOS SDK requires
** If the application doesn't include any Swift code, i.e. written completely in Objective-C, and Onfido iOS SDK is the only
Swift library that application integrates with
Note: These calculations were performed based on a single application architecture
Migrating
You can find the migration guide at MIGRATION.md
Certificate pinning
Note: Certificate pinning works only on devices running on iOS 10.3 or above.
You can pin any communications between our SDK and server through the .withCertificatePinning()
method in our OnfidoConfig.Builder
configuration builder. This method accepts CertificatePinningConfiguration
as a parameter, with sha-256 hashes of the certificate's public keys.
For more information about the hashes, please email ios-sdk@onfido.com.
Swift
let config = try OnfidoConfig.builder() ... do { config.withCertificatePinning(try CertificatePinningConfiguration(hashes: ["<EXAMPLE_HASH>"])) } catch { // handle CertificatePinningConfiguration initialisation failures. i.e Providing empty array causes initialiser to be failed. } ... configBuilder.build()
Objective-C
ONFlowConfigBuilder * builder = [ONFlowConfig builder]; ... NSError * error = NULL; ONCertificatePinningConfiguration * pinningConf = [[ONCertificatePinningConfiguration alloc] initWithHashes: @[@"<EXAMPLE_HASH>"] error: &error]]; if(error != NULL) { // handle ONCertificatePinningConfiguration initialisation failures. i.e Providing empty array causes initialiser to be failed. } [builder withCertificatePinningConfiguration: pinningConf]; ...
Handling certificate pinning error
To identify a certificate pinning error, check the message
property of the OnfidoFlowError.exception
object. It will return invalid_certificate
for certificate pinning related errors.
let responseHandler: (OnfidoResponse) -> Void = { response in switch response { case let .error(error): // Some error happened if case OnfidoFlowError.exception(withError: _, withMessage: let optionalMessage) = error, let message = optionalMessage { if message == "invalid_certificate" { // HANDLE INVALID CERTIFICATE CASE HERE } } case let .success(results): // User completed the flow // You can create your check here case .cancel: // Flow cancelled by the user } }
Accessibility
The Onfido iOS SDK has been optimised to provide the following accessibility support by default:
- Screen reader support: accessible labels for textual and non-textual elements available to aid VoiceOver navigation, including dynamic alerts
- Dynamic font size support: all elements scale automatically according to the device's font size setting
- Sufficient color contrast: default colors have been tested to meet the recommended level of contrast
- Sufficient touch target size: all interactive elements have been designed to meet the recommended touch target size
Refer to our accessibility statement for more details.
Licensing
Due to API design constraints, and to avoid possible conflicts during the integration, we bundle some of our 3rd party dependencies. For those, we include the licensing information inside our bundle and also in this repo under license folder, with the file named onfido_licenses.json. This file contains a summary of our bundled dependencies and all the licensing information required, including links to the relevant license texts contained in the same folder. Integrators of our library are then responsible for keeping this information along with their integrations.
Example on how to access the licenses:
let onfidoBundle = Bundle(for: OnfidoFlow.self) guard let licensesPath = onfidoBundle.path(forResource: "onfido_licenses", ofType: "json", inDirectory: nil), let licensesData = try? Data(contentsOf: URL(fileURLWithPath: licensesPath)), let licensesContent = String(data: licensesData, encoding: .utf8) else { return } print(licensesContent) guard let mitLicensePath = onfidoBundle.path(forResource: "onfido_licenses_mit", ofType: "txt", inDirectory: nil), let mitLicenseData = try? Data(contentsOf: URL(fileURLWithPath: mitLicensePath)), let mitLicenseFileContents = String(data: mitLicenseData, encoding: .utf8) else { return } print(mitLicenseFileContents)
Support
Please open an issue through GitHub. Please be as detailed as you can. Remember not to submit your token in the issue. Also check the closed issues to see whether it has been previously raised and answered.
If you have any issues that contain sensitive information please send us an email with the ISSUE:
at the start of the subject to ios-sdk@onfido.com
Previous versions of the SDK will be supported for a month after a new major version release. Note that when the support period has expired for an SDK version, no bug fixes will be provided, but the SDK will keep functioning (until further notice).
Copyright 2022 Onfido, Ltd. All rights reserved.
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Note: If the strings translations change it will result in a MINOR version change, therefore you are responsible for testing your translated layout in case you are using custom translations. More on language localisation
Added
- Ability to customise logo and branding available on all Motion screens. This is an enterprise feature, please reach out to your CSM if you want to know more
- Adding translations for live feedback on wrong passport page or tilted document.
- Changed primaryColor description
- Enable screen background colour customisation
- Enable explicitly setting the user interface style
- When using Studio, Selfie and Video are configured based on the configuration set in Studio
Changed
- Adjust colour contrast of brackets in Headturn step in motion
- Adjust colour contrast of corners in Alignment step in motion
- Added feedback on UI while video is being recorded on document capture
- Increase document overlay width to 90% for all devices that do not have a 16:9 screen.
- Removed OnfidoExtended framework variant
Fixed
- Fixed umbrella header importing private header files
- Added missing Norwegian localisations for document capture. Improved Hungarian message for wrong document side detected.
- Fixed missing country setting issue on document capture Studio flow which affects capture UX and validations
- Fixed incorrect image quality messages being reported on document confirmation screen after 3 attempts
- Disabled swipe to dismiss gesture on loading screen in model presentation contexts
- Fixed reporting the incorrect NFC Media ID in flow response
- Fixed USA and Canadian API calls that were incorrectly calling EU servers
- Fixed endless spinner appearing when navigating back from document capturing screen
Added
- Ability to customise logo and branding available on all Motion screens. This is an enterprise feature, please reach out to your CSM if you want to know more
- Adding translations for live feedback on wrong passport page or tilted document.
- Enable screen background colour customisation
- Enable explicitly setting the user interface style
- When using Studio, Selfie and Video are configured based on the configuration set in Studio
- Fixed endless spinner appearing when navigating back from document capturing screen
Fixed
- Fixed umbrella header importing private header files
- Added missing Norwegian localisations for document capture. Improved Hungarian message for wrong document side detected.
- Fixed missing country setting issue on document capture Studio flow which affects capture UX and validations
- Fixed incorrect image quality messages being reported on document confirmation screen after 3 attempts
- Disabled swipe to dismiss gesture on loading screen in model presentation contexts
- Fixed reporting the incorrect NFC Media ID in flow response
Added
- Enable consent screen buttons only when user scrolls to bottom of text
- Added experimental feature to detect and validate document on device
- Add swipe gesture for navigating back to previous viewControllers
- Enabled NFC by default in
OnfidoConfig
. Addeddisable()
for disabling it - Deprecated
withNFCReadFeature()
inOnfidoConfig
- Combined NFC Intro & Read screens into single Scan screen
- Add back swipe gesture for Photo, Video and Motion capture screens
Fixed
- Fixed crashing at end of the Studio flow in loading screen
- Fixed error message to give a more accurate reason to the user when there is a missing media type connection error
- UI: Fixed the issue which caused standard font to be shown even when the custom font feature was enabled
- Fixed wrong screen being displayed and no error being returned after microphone permission denied
- Fixed the issue where it was not possible to dismiss the SDK after the consent screen was shown
- Fixed missing document types (Visa, Work permit, Generic) for customized
withDocumentStep
API
Changed
- Removed mobile token support
- Dropped iOS 10 support. Now supporting iOS 11 or newer.
- Removed initialisers with parameters for Appearance (ONAppearance) and CaptureSuccessColors (ONCaputreSuccessColors), and made properties public.
- Renamed withPassportNFCReadBetaFeatureEnabled sdk configuration function to withNFCReadBetaFeatureEnabled.
- Removed EnterpriseFeature convenience initialiser. Use EnterpriseFeatures.builder().withHideOnfidoLogo(_:).build() instead.
Changed
- Accessibility: improved instructions for capturing various document types
- Accessibility: improved instructions for selfie camera capture
- Now returning a single document and face result object. Only last capture returned.
- Accessibility: announcing number of results when searching for countries
- UI: Now showing auto capure message below capture frame area. Same as manual capture.
- UI: Now showing capture instructions at all times even when warning present to user
- Accessibility: improved the instruction for selfie and video capture
- Accessibility: added reference that video is being played on intro video screen
- UI: Now showing spinner instead of deterministic progress bar
Changed
- UI: Now primary button is retake and secondary is confirm on capture confirmation screen when warning present
- Made some improvements around video recording logic to prevent several crash issues which have been reported on github. Issue 1, Issue 2. Those issues are: https://github.com/onfido/onfido-ios-sdk/issues/227
Added
- Added Canadian driver's license autocapture as an experimental feature. Follow README to understand how to enable this feature
Changed
- UI: Changed text and background colors in light mode
- Now sharing Onfido license files in github repository along with SDK bundle
- UI: Changed Onfido logo position in capture screens
- UI: Changed Onfido logo position in intro and permission screens
- UI: Added Onfido logo to the document type selection screen
- Removed unused strings from localisation
- Renamed some generic keys
- UI: Changed bubble view position and apperance for document capture flow
- Now disabling passport autocapture on simulators
Changed
- Renamed most localisation keys. Now names are more explicit to in which screens they are used. See MIGRATION to easily migrate Strings from 18.7.0 to 18.8.0.
Fixed
- Fixed bundle localisation issue. Related Github issue
Fixed
- UI: Fix the problem about having buttons in different height. Github Issue
- Fixed localisation language selection when app and device preferred language is not supported by Bundle
Fixed
- Fix for sending duplicate VIDEO_FACIAL_CAPTURE_CONFIRMATION analytic event.Related github issue
- Improved memory usage
- UI: Fixed the camera load problem in some specific cases
- UI: Fixed incorrect VoiceOver focus on video capture intro video
- UI: Fixed error problem user taps shutter button right after presenting SDK.Related github issue
Changed
- UI: Changed continuous glare detection logic for US DL documents
- UI: Autocapture manual fallback alert UI has changed
- UI: No longer running glare validation on back side of Romanian identity card
- Added eventHandler and corresponding event method to ONFlow.swift for User Analytic Events
- UI: Improved US Driver Licence edge detection
- Sending barcode detection result to the API
Fixed
- Fixed SDK crash when invalid SDK token provided
- Fixed sdk not showing document format selection when document type and country preselected but no format specified
- UI: Fix the issue related with having incorrect navigation bar theme when dark mode disabled for SDK
- UI: Now showing upload progress when user taps upload button immediately
Added
- Added German as supported language
- Added document format option for document capture step. Also changed the way to configure document capture step. Please check README for the details
- Added integrator defined event hook to allow integrators to collect user analytics
- UI: Added icon to differentiate document back capture from front capture
Fixed
- Fixed the Localizable.strings not updated problem.See
- UI: Fixed missing right margin issue on selfie intro screen
- UI: Fixed alert text cut off in some scenarios
- UI: Fixed the text cut-off issue on liveness capture screen
Added
- Added certificate pinning support. See https://github.com/onfido/onfido-ios-sdk#certificate-pinning for the details.
Changed
- UI: Now using grey Onfido logo with higher contrast for accessibility
- Now using API v3 for communication with the backend.
- UI: Now only detecting glare on rectangles of ID1 size on US DL autocapture
- UI: Now auto capturing non-blurry US DL only
- Updated bubble view design and updated barcode not readable copy
- Removed deprecated withApplicant() function from public API. Please check migration document to understand what needs to be done.
- UI: Updated liveness capture head turn challenge design
- Updated code snippets and descriptions about API v2 with API v3 in README.
- UI: Selfie oval now same as liveness oval size
- Updated README to include bitcode support information
- UI: Updated flow intro screen user interface
- Updated mrz not detected error copy
- Changed 'mobile sdk token' expression with 'mobile token' on README to prevent confusion
- UI: Now running selfie capture validation on device instead of back-end
- UI: Now showing selfie capture post upload errors in bubble view instead of using pop-ups
- UI: Now loading selfie intro screen purely from code; Removed Xib file
Fixed
- Fixed folded paper document on back capture loading lag issue
- UI: Fixed selfie capture text truncated when large text size used
- UI: Fixed Arabic country name endonyms
- Fixed warning about missing umbrella header (https://github.com/onfido/onfido-ios-sdk/issues/131)
Added
- UI: User can choose to capture folded paper documents for French driving license and italian identity document
- UI: Now checking face is in document captured when document must contain face
- UI: Now showing error message when passport MRZ is cut off in captured image
- Now changing document capture frame ratio for folded paper documents and showing document template for 4 seconds
- Now showing passport template when user selects passport capture
Fixed
- UI: Fixed white background shown on camera capture screens
- Cocoapods documentation is now pointing to GitHub README
Changed
- UI: Now showing manual capture option on retake when autocapturing US DL
- UI: Now showing manual capture for US DL when only barcode detected
- Updated README to explain how to obtain sandbox token
- Changed carthage spec json file name. Please check the README for the details.
- Now captured images include EXIF meta data.
Added
- Carthage support added, please check the README for the details.
Fixed
- UI: Fixed the UI bug which affects navigation bar in camera screens when integrator uses global appearance customisation for the navigation bar
- UI: Fixed the issue that causes showing constraint warnings in the console when user goes to the any camera capture screen
- UI: VoiceOver focuses on back button instead of take new picture on capture confirmation screen when transitioning between photo capture to capture confirmation
- Fixed Segment SDK crash issues, upgraded Segment SDK version to 3.7.0
Added
- Added ability to refresh SDK token when its expired
- UI: Added dark mode support for iOS 13. See the https://github.com/onfido/onfido-ios-sdk#ui-customisation page for the details.
Fixed
- UI: Fixed the not being able to set correct font issue on iOS 13
- UI: Fix for the separator disappear problem when any document type tapped on iOS 13
- UI: Fixed the not showing unsupported orientation view for flow intro and selfie intro screens when device in horizontal mode
- UI: Fixed the crash on liveness head turn challenge screen when head turn animation and tapping next button happened at the same time
- UI: Fixed liveness intro video player and video reload showing at the same time
- UI: Error bubble view on capture confirmation view cut off on iPad modal
Added
- Added United States' driver's license autocapture as an experimental feature. Can be enabled by calling withUSDLAutocapture() in the OnfidoConfig.builder()
- Updated README with adding SDK size impact information
- UI: Added dynamic font size support for video capture confirmation screen
- UI: Added support for the new token format
Fixed
- UI: Unsupported screen appears and gets stuck in app only supporting portrait mode
- UI: Fixed the UI issue about showing unnecessary oval shape in upload progress bar view
- UI: Poland's endonym on country selection screen
- UI: Fixed the crash on iPad for the apps that support only landscape orientation
Fixed
- UI: User sees liveness intro screen after app is backgrounded during liveness capture
- UI: Device permission screen labels overlapping with icon when user setting has larger text size
- UI: Fix for having wrong sized record button on liveness capture screen in some dynamic font size configured cases
- UI: Fixed crash when tapping two buttons on capture confirmation screen at the same time
- Removed unnecessary string keys
- SDK does not throw
OnfidoFlowError.microphonePermission
when face capture photo variant is used and app has microphone permission denied
Added
- UI: Showing bubble for wrong head turn detection on liveness screen
- UI: Added dynamic font size support for flow intro and selfie intro screens
- UI: Added dynamic font size support for liveness capture screen
- UI: Added dynamic font size support for bubble views that appears in photo capture, liveness head turn detection and capture confirmation screens
- UI: Added dynamic font size support for liveness intro screen
- UI: Added dynamic font size support for photo capture confirmation screen
- UI: Added dynamic font size support for buttons
- UI: Added dynamic font size support for document photo capture screen
- UI: Added french localisation
- Allowing custom localisation from non-localised strings file
Added
- UI: Added optional welcome intro screen
- UI: Added selfie (face capture photo variant) intro screen
- UI: Added dynamic font size support for document type selection screen
- UI: Added dynamic font size support for country selection screen
- UI: Added latency for face detection on liveness capture (face capture video variant) to allow readability of instructions
Fixed
- UI: Fixed text cut-off issue on liveness instructions screens when user language is Spanish
- UI: Fixed Onfido logo and video playback view overlapping issue in liveness intro screen
- Fixed cut-off issue on document images captured on certain iPads
- Fix for the intermittent video cut-off issue when liveness capture recorded on certain iPads
- Removed unused assets
Fixed
- UI: Fix sdk crash on capture during the backside capture of two sided document on Cordova
- UI: Fix for the Segment SDK name clash
- UI: Fix infinite spinning wheel not removed when liveness upload failed.
- UI: Fixed custom localisation of text in liveness confirmation screen now going over multiple lines when text too long (max three)
[7.2.0] - 2018-07-17
Note: This version might be a breaking change if you are providing customised language translations. Please see MIGRATION.md.
[7.1.0] - 2018-06-07
Note: This version might be a breaking change if you are providing customised language translations. Please see MIGRATION.md.
[7.0.0] - 2018-04-17
Note: This version might be a breaking change if you are providing customised language translations. Please see MIGRATION.md.
Fixed
- upload results objects now exposing to objective-c integrator
- UI: Fixed possible crash on camera capture
- UI: Fixed crash on rotation during live video recording
- UI: Fixed crash on going back from preselected document capture screen while glare detected
- UI: Fixed back button with English text on non-English language text flow
[6.0.0] - 2018-04-04
Note:
- This version is not backwards-compatible. Migration notes can be found in MIGRATION.md
Fixed
- UI: Fixed large back button issue on iPhone X
- UI: Fixed face capture oval height ratio on iPhone X
- Internal: Fixed issue with not cleaning up uploaded images and videos from device
- Internal: Fixed issue with different video codecs being used for video capture
- Internal: Fixed document photo resolution in order to reduce data usage