iOS SDK

Integrate the TrustPlatform iOS SDK into your iOS app

Requirements

Requirement	Minimum version
iOS	14.0
Swift	6.0

Installation

1. In Xcode, select File > Add Package Dependencies…
2. Paste the repository URL:

   https://github.com/idnow/trustplatform-sdk-ios

3. Click Add Package (We recommend setting the version rule to Up to Next Major Version).
4. In the package product selection sheet, add TrustPlatform to your app target. Click Add Package.

Configure Your App

Open your Info.plist file and add the following keys.

Key	Type	Notes
Privacy - Camera Usage Description	String	Required for document and biometric capture
Privacy - Microphone Usage Description	String	Required for video-based verification steps

---

Configure the SDK

Call IDnowTrustPlatform.configure(environment:) once at app startup, before you create a session.

// AppDelegate.application(_:didFinishLaunchingWithOptions:)
// or your @main struct init:
IDnowTrustPlatform.configure(environment: .production)

Environment	Description
.production	The production environment
.sandbox	The sandbox environment for development and testing (default)

Start a Session

1. Create a new session via the /sessions API.
2. Use the session token to initialize a new TPSession instance.
3. Call run(from:) and switch on the returned FlowOutcome.

func startVerification(from viewController: UIViewController) async {
    let session = TPSession(token: sessionToken)
    do {
        switch try await session.run(from: viewController) {
        case .completed:
            // The flow completed. Query your backend for the outcome.
            // See https://docs.eu.platform.idnow.io/docs/integration/get-session-results
        case .aborted:
            // The user aborted the flow.
        @unknown default:
            break
        }
    } catch {
        // Handle technical failures — see Handle Errors below.
    }
}

To abort a running session programmatically, call session.stop().

Handle Outcomes

run(from:) returns a FlowOutcome value when the flow reaches a terminal state.

Case	When it occurs
.completed	The flow completed successfully
.aborted	The user aborted the flow

.completed only signals that the flow finished. To retrieve the actual outcome, query the Get session results API endpoint using the sessionId you received when creating the session.

Handle Errors

run(from:) throws a TrustPlatformError when a technical failure prevents the flow from running or completing.

Case	When it occurs
flowFailure	A technical failure occurred within the flow
invalidToken	The session token is not valid for an SDK session
sessionExpired	The session timed out on the server
networkFailure(underlying:)	No connection or a request failed
nativeHandlerFailure(code:message:)	A native handler reported a non-recoverable failure
internalError	An unexpected SDK-internal failure

errorDescription on each case is localized and safe to display to end users.

DocIDV Handler (Optional)

The TrustPlatformDocIDV framework adds native document identity verification to your integration. It is separate from the core TrustPlatform framework and is optional.

Add the Framework

1. Select your app target, then open the Frameworks, Libraries, and Embedded Content list.
2. Click + and add TrustPlatformDocIDV from the TrustPlatform package.

Configure Your App for DocIDV

Entitlements File

1. Open your app's entitlements file. If you do not have one, select File > New File > Property List and name it YourApp.entitlements.
2. Add a key Near Field Communication Tag Reader Session Formats of type Array.
3. Add one item to the array:
   • Type: String
   • Value: TAG

Info.plist File

1. Open your Info.plist file.
2. Add the key Privacy - NFC Scan Usage Description and enter a string that explains why the app uses NFC.
3. Add the key ISO7816 application identifiers for NFC Tag Reader Session of type Array.
4. Add the following two string items to the array:
   • A00000045645444C2D3031
   • A0000002471001

How It Works

When you link TrustPlatformDocIDV, the SDK discovers the DocIDVHandler class automatically at runtime. No registration call is required. If the framework is not linked, the SDK runs the DocIDV step in the webview instead.