Table of Contents

• Swift Package Manager
  • Run project (without NFC)
  • Run project (with NFC)
• Usage
• Code Example
• SDK error codes
  • How to deal with errors
• Fat Framework Support
• Compatibility, End of Support, End of Life

Swift Package Manager

The IDnow framework can incorporate the IDnow AutoIdent platform into iOS apps.

Since SDK version 4.15.0 (Xcode 13.2) we added support for the swift package manager by providing the corresponding xcframeworks as binary targets. To add the swift package to your project please refer to: Adding Package Dependencies to Your App

IDNowSDKCore variants are available as xcframeworks:

• without NFC 📦
• with NFC 📦

You can also choose options without XS2A, but please make sure you don't need this feature before selecting.

Note: 3rd Party components such as Video Selfies and NFC scanning do not support the dynamic runtime language customization using the preferredLanguage parameter. These components always use the device_language. Hence, our recommended best practice for optimal user experience is to allow the SDK to use the device language instead of the preferredlanguage parameter.

Please choose the corresponding setup required for your use cases. If you need NFC please reach out to IDnow to obtain the needed dependencies. (see: Using the SDK with NFC and run your project)

Note: If you see improvements for the Swift Package please let us know in the issues section. Thank you for your support! 📮

Example:

Adding the library required:

Using the SDK and run your project

• Add swift package: https://github.com/idnow/de.idnow.ios.sdk.spm as a dependency
• Insert SDK calling code in your app: Code Example
• Add NSCameraUsageDescription and NSPhotoLibraryUsageDescription keys in your app's .plist file
• Compile & Run

Using the SDK with NFC and run your project

This version of IDnowCoreSDK is dependent on the presence of ReadID frameworks.

New Feature: Reading NFC chip of electronic IDs & Passports and validating their authenticity

By leveraging the NFC capability (Near Field Communication), our SDK can now read out the data of the NFC chips of electronic IDs & Passports which adds an extra layer of security to digital identity verification. This will boost the identity verification process and increase the level of fraud protection. We support ICAO 9303 documents (passports, ID cards, residence permits): please contact IDnow for more information.

• Add swift package: https://github.com/idnow/de.idnow.ios.sdk.spm as a dependency
• Put ReadID_UI.xcframework in the app folder (please reach out to IDnow to obtain the ReadID xcframeworks)
• XCode -> Target -> General -> Frameworks, Libraries and Embedded Content -> Add ReadID_UI.xcframework and and check Embed and Sign.
• On the Signing & Capabilities configuration tab add the Capability ‘Near Field Communication Tag Reading’
• Add ‘NFCReaderUsageDescription’ to your App’s Info.plist file
• Copy the snippet below into your App’s Info.plist file

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

• To support PACE-only French ID cards issued from 2020 onwards, on iOS 16+, your app needs to have the correct entitlement. In the project navigator, select the entitlement file for your application There should be an entry Near Field Communication Tag Reader Session Formats with one sub-item Item 0 (Near Field Communication Tag Reader Session Format) with a value of Tag-Specific Data Protocol (TAG). Select this line and click on the + icon. A new line should appear, starting with Item 1. Change the value of the new line to Password Authenticated Connection Establishment (PACE)

• Add NSCameraUsageDescription and NSPhotoLibraryUsageDescription keys in your App's .plist file

• Insert SDK calling code in your app: Code Example

• Compile & Run

Usage

Starting an automated ident

The API to start an automated Ident is:

public func start(token: String, preferredLanguage: String = default, fromViewController: UIViewController, listener: @escaping IDNowSDKResultListener)

• The token needs to be all uppercase characters only and should conform to the following regular expression .{3}-.{5}$
• Setting the prefferedLanguage (optional) tells the SDK in which language the AutoIdent UI should be shown. If the language is not available the framework first tries the language of the device and if that is not available it falls back to English.

Language limitations: 3rd Party components such as Video Selfie and NFC scanning do not support the dynamic runtime language customization using the preferredLanguage parameter. These components always use the device_language. Hence, our recommended best practice for optimal user experience is to allow the SDK to use the device language instead of the preferredlanguage parameter.

Supported Languages These ISO 639-1 language codes are currently supported: bg (Bulgarian), cs (Czech), da (Danish), de (German), el (Greek), en (English), es (Spanish), et (Estonian), fi (Finnish), fr (French), hr (Croatian), hu (Hungarian), it (Italian), ja (Japanese), ka (Georgian), ko (Korean), lt (Lithuanian), lv (Latvian), nb (Norwegian), nl (Dutch), pl (Polish), pt (Portuguese), ro (Romanian), ru (Russian), sk (Slovak), sl (Slovenian), sr (Serbian-latin), sv (Swedish), tr (Turkish), zh (Chinese).

• the calling view controller
• an IDnowResultListener which gets called once the SDK returns. The possible return codes are: ** FINISHED the ident was finished ** CANCELLED The user canceled the ident ** ERROR an error occurred

Binding Key

BindingKey is an additional parameter that can be sent by customers when initializing the SDK. It can be used for device binding use cases and helps establish a correlation between a user's verified identity and their mobile device. It is particularly useful for device authentication and re-authentication scenarios when users change devices. BindingKey for a completed identification can be fetched via an API endpoint and compared with the one that was used during SDK initialization.

Usage:

 // add the binding parameter during initialization if you want to use it. 
 IDnowSDK.shared.start(bindingKey: YOUR_BINDING_KEY)

Code example

IDNowSDK.shared.start(token: token, preferredLanguage:"en", fromViewController: self, listener:{(result: IDNowSDK.IdentResult.type, statusCode: IDNowSDK.IdentResult.statusCode, message: String) in
    if result == .ERROR {
        self.showAlert(text: statusCode.description)
    } else if result == .FINISHED {

    }
})

Code example If you are using an SDK version lower than 5.0.0

IDNowSDK.shared.start(token: token, preferredLanguage:"en", fromViewController: self, listener:{ (result: IDNowSDK.IdentResult, message: String) in
   if result == IDNowSDK.IdentResult.ERROR {
       self.showAlert(text: message)
   } else if result == IDNowSDK.IdentResult.FINISHED {

   }
})

SDK error codes

In the case of IDNowSDK.IdentResult.type.ERROR, the possible error codes are below.

"EUnreachable" --> No network connection
"E10" --> General type of error
"E100" --> Ident code syntax incorrect
"E101" --> Ident code not found
"E102" --> Ident code expired
"E103" --> Ident code already completed
"E110" --> Get ident info failed; invalid response
"E111" --> Get ident info failed; server reachability
"E112" --> Get ident info failed; Internal error
"E120" --> Parsing error
"E121" --> Server error
"E130" --> Get ident resources failed; invalid response
"E131" --> Get ident resources failed; server reachability
"E140" --> Get name failed; invalid response
"E141" --> Get name failed; server reachability
"E142" --> Get name failed; full name missing
"E150" --> Start ident failed; invalid response
"E151" --> Start ident failed; server reachability
"E152" --> Start ident failed; missing session key
"E153" --> Start ident failed; wrong ident method
"E160" --> Get Emirates NFC resources failed; invalid response
"E161" --> Get Emirates NFC resources failed; server reachability
"E170" --> Socket connection force closed
"E171" --> Process force closed

How to deal with errors

• For E102 it is recommended to create another ident and restart the process with the new ident code.
• For E103 it is recommended to show a screen to the user with the message that they have submitted all info needed and that they should wait for the final result.
• For E170 it is recommended to notify the user that the ident process timed out or was started on a different device and ask them to try again.
• For all other error codes it is recommended to show a generic error for the user and ask them to try again by restarting the process.

Fat Framework Support

In case you want to continue using the fat framework, please get in touch with your IDnow representative.

Compatibility Matrix

Please refer to the following link to find information about compatibility, end-of-support (EOS), and end-of-life (EOL) dates about our products: IDnow Compatibility Matrix: Browser & OS Compatibility guide