Adding the Identity Verification SDK to your project

To add our SDK to your own application, you should add it to the build process of your application. Currently we support doing this using CocoaPods or Carthage.

                        
pod 'Klippa-Identity-Verification', podspec: 'https://custom-ocr.klippa.com/sdk/ios/specrepo/ExampleUsername/ExamplePassword/KlippaIdentityVerification/latest.podspec'
                        
                    

                        
# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'
    
target 'Your-Project-Name' do
    # Comment the next line if you don't want to use dynamic frameworks
    use_frameworks!
    
    # Pods for Your-Project-Name
    pod 'Klippa-Identity-Verification', podspec: 'https://custom-ocr.klippa.com/sdk/ios/specrepo/ExampleUsername/ExamplePassword/KlippaIdentityVerification/latest.podspec'
    
end
                        
                    

                        
binary "https://custom-ocr.klippa.com/sdk/ios/carthage/ExampleUsername/ExamplePassword/KlippaIdentityVerification.json"
                        
                    

Updating Info.plist file

Camera

If you want to use the Camera capabilities inside of the Identity SDK please add the following to your Info.plist.

Name
 Privacy - Camera Usage Description

                
<key>NSCameraUsageDescription</key>
<string>Your Camera usage description here.</string>
                
            

Near field communication

If you want to use the Near field communication (NFC) capabilities inside of the Identity SDK please add the following to your Info.plist.

Name
 Privacy - NFC Scan Usage Description

                
<key>NFCReaderUsageDescription</key>
<string>Your NFC usage description here.</string>

Name
 ISO7816 application identifiers for NFC Tag Reader Session

                
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
<string>A0000002471001</string>
<string>A0000002472001</string>
<string>00000000000000</string>
</array>
            
                

Important: When using NFC also add "Near Field Communication Tag Reading" capability to your app using the Signing & Capabilities pane of the project editor.

Creating sessions

Before you can start using the identity verification you need to generate a session token in your backend. You can then start the session using your newly generated token. Once the session has been completed you can collect the files and data read by the OCR.

Starting the identity verification

In the ViewController that you want to launch the identity verification, implement the IdentityBuilderDelegate

                    
// Add to the top of your file
import KlippaIdentityVerification

// Your class definition should look like this.
final class ExampleIdentityVerificationViewController: UIViewController, IdentityBuilderDelegate {

    // ... Rest of your controller code.

    func startIdentityVerification() {
        // @todo: get a session token from the API through your backend here.
        let builder = IdentityBuilder(builderDelegate: self, sessionKey: "{insert-session-token-here}")

        // Build returns a viewController UIViewController that you can present.
        let viewController = builder.build()
        self.present(viewController, animated: true, completion: nil)
    }

    func identityVerificationFinished() {
        print("Finished")
    }

    func identityVerificationCanceled(withError: KlippaError) {
        print("canceled with error: \(withError)")
    }

    func identityVerificationContactSupportPressed() {
        print("identityVerificationContactSupportPressed")
    }

    // ... Rest of your controller code.
}
                    
                

When you want to start the identity verification, for example after a button click, call the startIdentityVerification method.

Note: Currently iOS Simulators are not supported due to incompatible binaries.

Customizing the identity verification

The SDK has a few customizing settings, the following methods are available:

Intro & Success

To configure whether to show intro/success screens, add the following to the builder:

                    
builder.hasIntroScreen = true
builder.hasSuccessScreen = true
                    
                

Colors

                    
builder.kivColors.textColor = UIColor.red
builder.kivColors.backgroundColor = UIColor.lightGray
builder.kivColors.progressBarBackground = UIColor.lightGray
builder.kivColors.progressBarForeground = UIColor.orange
builder.kivColors.successColor = UIColor.purple
builder.kivColors.errorColor = UIColor.red
builder.kivColors.otherColor = UIColor.lightGray
                    
                

Fonts

                    
builder.kivFonts.fontName = "ComicSans"
builder.kivFonts.boldFontName = "ComicSans"
                    
                

Language

We currently support English, Dutch, German, French and Spanish.
Note: It's currently not possible to change the strings.

                    
builder.kivLanguage = .Dutch
                    
                

Retry Threshold

To configure how often a user can attempt a task before the contact support button is shown to the user.

                    
builder.retryThreshold = 1
                    
                

Auto capture

The ability to automatically take a photo of the document when it passes all checks.

                    
builder.enableAutoCapture = true
                    
                

Verify include list

The extracted data keys that will be shown to the user after the document has been processed.

                    
builder.kivVerifyIncludeList = [
    "DateOfBirth",
    "DateOfIssue",
    "DocumentNumber",
    "DocumentSubtype",
    "DocumentType",
    "Face",
    "Gender",
    "GivenNames",
    "Height",
    "IssuingCountry",
    "IssuingInstitution",
    "Nationality",
    "PersonalNumber",
    "PlaceOfBirth",
    "Residency",
    "Signature",
    "Surname"
]
                    
                

Verify exclude list

The extracted data keys that will be hidden from the user after the document has been processed.

                    
builder.kivVerifyExcludeList = []
                    
                

Validation include & exclude lists

You can edit the validation include list: the failed validations that are shown to the user Or the validation exclude list: the failed validations that are hidden from the user.
For more information regarding validations check out the API documentation.

                    
builder.kivValidationIncludeList = [
    "DetectFace",
    "CompareFace",
    "DetectSignature",
    "CompareSignature",
    "CheckRequiredField",
    "MatchSidesFront",
    "MatchSidesBack",
    "FieldValidation",
    "MatchVizMrz",
    "MrzChecksum"
]

builder.kivValidationIncludeList = []
                    
                

SDK size

The dependency download size itself is 67.3MB when extracted, but it contains builds for multiple architectures, it depends on the architecture of the phone how much the SDK is going to add to the app size:

• arm64: 32.2MB
• x86_64-simulator: 35MB

Troubleshooting

Sandbox Issue

In case you encounter issues related to the Sandbox, you can disable the ENABLE_USER_SCRIPT_SANDBOXING by following these steps:

1. In Xcode select your App project
2. With your app as the target, go to Build Settings.
3. In the Build Options group, change User Script Sandboxing to NO.

Apple Silicon Architecture Issue

If you are using a Mac computer with an Apple silicon chip and facing problems building this SDK for iOS simulators, you can resolve this by following these steps:

1. In Xcode, select your App project.
2. With your app as the target, go to Build Settings.
3. In the Architectures group, add a new group for debugging by using the + symbol.
4. Change Any SDK to iOS Simulator.
5. Replace Standard Architectures with x86_64.
6. Repeat steps 1 to 5 for the Pods target.

Versions

The following versions are available:

Changelog