Swiftpack.co - getyoti/yoti-doc-scan-ios as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by getyoti.
getyoti/yoti-doc-scan-ios v4.1.0
An iOS SDK for Yoti's identity verification services
⭐️ 5
🕓 3 days ago
.package(url: "https://github.com/getyoti/yoti-doc-scan-ios.git", from: "v4.1.0")



Our SDK allows a user of your app to take a photo of their document, as well as to scan or capture their face, we then verify this instantly and prepare a response, which your system can then retrieve on your hosted site.


To integrate with our SDK, a working infrastructure is needed (see developers.yoti.com for more details).


  • iOS 13.0+
  • Swift 5.3+



Add the following to your Podfile and run pod install from its directory:

platform :ios, '13.0'

target 'TargetName' do
  pod 'YotiSDKIdentityDocument'         // Optional
  pod 'YotiSDKSupplementaryDocument'    // Optional
  pod 'YotiSDKFaceTec'                  // Optional
  pod 'YotiSDKFaceCapture'              // Optional


1. Configure and build your dependencies

Add the following to your Cartfile and run carthage bootstrap --platform iOS --use-xcframeworks from its directory:

binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiNetwork.json"
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiDocumentCapture.json"             // Include only if `YotiSDKIdentityDocument` is added
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiNFC.json"                         // Include only if `YotiSDKIdentityDocument` is added
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKNetwork.json"
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKCommon.json"
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKDesign.json"
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKCore.json"
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKDocument.json"                 // Include only if `YotiSDKIdentityDocument` or `YotiSDKSupplementaryDocument` is added
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKIdentityDocument.json"         // Optional
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKSupplementaryDocument.json"    // Optional
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKFace.json"                     // Include only if `YotiSDKFaceTec` or `YotiSDKFaceCapture` is added
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKFaceTec.json"                  // Optional
binary "https://raw.githubusercontent.com/getyoti/yoti-doc-scan-ios/master/Specs/Carthage/YotiSDKFaceCapture.json"              // Optional
binary "https://raw.githubusercontent.com/getyoti/yoti-face-capture-ios/master/Specs/Carthage/YotiFaceCapture.json" == 5.0.1    // Include only if `YotiSDKFaceCapture` is added
binary "https://raw.githubusercontent.com/BlinkID/blinkid-ios/master/blinkid-ios.json" == 5.18.0                                // Include only if `YotiSDKIdentityDocument` is added

2. Embed frameworks

Locate your fetched dependencies in $(PROJECT_DIR)/Carthage/Build/**, and add them to GeneralFrameworks, Libraries and Embedded Content. Ensure to Embed & Sign all of these dependencies, and to point your target's FRAMEWORK_SEARCH_PATHS to their directory.

3. Link binary with libraries (Optional)

If YotiSDKIdentityDocument is specified as part of your dependencies, then add the following libraries at Build PhasesLink Binary With Libraries:

  • AVFoundation.framework
  • CoreMedia.framework
  • CoreNFC.framework
  • libc++.tbd
  • libiconv.tbd
  • libz.tbd

Swift Package Manager

Add the following line to your Package.swift file:

.package(url: "https://github.com/getyoti/yoti-doc-scan-ios.git", from: "1.0.0")

...or add our package in Xcode via File -> Swift Packages -> Add Package Dependency... using the URL of this repository.

If you are including YotiSDKIdentityDocument in your target, then you should also link your binary to the required libraries as outlined here.


1. Import frameworks

Import the frameworks needed for your implementation:

import YotiSDKCommon
import YotiSDKCore
import YotiSDKIdentityDocument          // Optional
import YotiSDKSupplementaryDocument     // Optional
import YotiSDKFaceTec                   // Optional
import YotiSDKFaceCapture               // Optional

2. Launch the SDK

Initialize and present the YotiSDKNavigationController:

let navigationController = YotiSDKNavigationController()
navigationController.sdkDataSource = self
navigationController.sdkDelegate = self
present(navigationController, animated: true, completion: nil)

3. Specify the session and its supported module types

Conform to YotiSDKDataSource:

func sessionID(for navigationController: YotiSDKNavigationController) -> String {

func sessionToken(for navigationController: YotiSDKNavigationController) -> String {

func supportedModuleTypes(for navigationController: YotiSDKNavigationController) -> [YotiSDKModule.Type] {
        YotiSDKIdentityDocumentModule.self,         // Optional
        YotiSDKSupplementaryDocumentModule.self,    // Optional
        YotiSDKFaceTecModule.self,                  // Optional
        YotiSDKFaceCaptureModule.self               // Optional

4. Handle the result

Conform to YotiSDKDelegate:

func navigationController(_ navigationController: YotiSDKNavigationController, didFinishWithResult result: YotiSDKResult) {
    dismiss(animated: true)
    switch result {
    case .success:
    case .failure(let error):

5. Modify the properties and capabilities of your project's target

Add NSCameraUsageDescription to your Info.plist.

If YotiSDKIdentityDocument is included in your target, then you should also:

Supported languages

Our SDK supports the 9 languages listed in the table below, but their use is driven by the localization configuration of your target. If your target only supports a subset of our SDK's supported languages, our SDK will fall back to English on the ones your target doesn't support.

Language Code
Arabic ar
Dutch nl
English (default) en
French fr
German de
Italian it
Russian ru
Spanish es
Turkish tr

Error codes

Code Description
1000 No error occurred. The user cancelled the session
2000 Unauthorised request (wrong or expired session token)
2001 Session not found
2002 Session expired
2003 SDK launched without session Token
2004 SDK launched without session ID
3000 Yoti's services are down or unable to process the request
3001 An error occurred during a network request
3002 The user did not have a network connection
4000 The user did not grant permission to the camera
4001 The user submitted a wrong document
5000 The user's camera was not found and file upload is not allowed
5002 No more local tries for the liveness flow
5003 SDK is out-of-date, please update the SDK to the latest version
5004 An unexpected internal error occurred
5005 An unexpected document capture error occurred
5006 An unexpected liveness capture error occurred
5008 An unsupported configuration was used
6000 The identity document dependency could not be found
6001 The face scan dependency could not be found
6002 The supplementary document dependency could not be found
6003 The face capture dependency could not be found
7000 The user did not have the required documents


For any questions or support please contact us here. Once we have answered your question, we may contact you again to discuss Yoti products and services. If you'd prefer us not to do this, please let us know when you e-mail.


See the licence here.


Stars: 5
Last commit: 3 days ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

3 days ago
  • General UI improvements to iPhone 10+ devices
  • Bug fixes, incl. a rare issue that could occur during document upload when the integrator's app is put into the background
  • Added flexibility around when to ask the user for biometric consent if required

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics