​

SmartComply iOS SDK

​

Features

• Drop-in SwiftUI view — SmartComplyFlowView manages the entire verification flow with no UI code required
• Two verification modes — document photo capture or ID number data entry, configured from your Dashboard
• Guide-box document capture — crops exactly what falls inside the ID card frame so the image sent to the backend is always clean
• Liveness detection — face challenge system (blink, turn head) runs automatically after identity verification
• Dynamic ID types — channels and fields are fetched live from your Dashboard configuration
• Multi-country support — renders a country picker automatically when more than one country is configured
• Dark and light mode — theme adapts to the system colour scheme; override with preferredColorScheme
• Automatic retry — handles upload retries and session errors internally

​

Requirements

• iOS 16.0 or later
• Swift 5.9 or later
• Xcode 15 or later
• iPhone X or later — liveness detection requires a front-facing TrueDepth camera

​

Installation

​

Xcode (recommended)

1. Open your project in Xcode
2. Go to File → Add Package Dependencies
3. Enter the repository URL: https://github.com/386konsult/ios-sdk
4. Select Exact Version and enter 1.0.0
5. Click Add Package and select the SmartComplySDK library

​

Package.swift

dependencies: [
    .package(url: "https://github.com/386konsult/ios-sdk", exact: "1.0.0")
],
targets: [
    .target(
        name: "YourApp",
        dependencies: [
            .product(name: "SmartComplySDK", package: "ios-sdk")
        ]
    )
]

​

Platform Setup

<key>NSCameraUsageDescription</key>
<string>Camera access is required to photograph your ID document and complete liveness verification.</string>

​

Quick Start

​

1. Create the SDK instance

import SmartComplySDK

let sdk = SmartComply(
    config: SDKConfig(
        apiKey:      "pk_live_xxxxxxxxxxxx",
        clientId:    UUID().uuidString,       // unique per verification attempt
        environment: .production
    )
)

​

2. Present the flow view

import SmartComplySDK

struct ContentView: View {
    @State private var showVerification = false
    let sdk = SmartComply(config: SDKConfig(apiKey: "pk_live_...", clientId: UUID().uuidString))

    var body: some View {
        Button("Verify Identity") {
            showVerification = true
        }
        .fullScreenCover(isPresented: $showVerification) {
            SmartComplyFlowView(sdk: sdk) { result in
                showVerification = false
                print("Entry ID:", result.entryId)
                print("Status:", result.status)
                if let name = result.verifiedName {
                    print("Verified name:", name)
                }
            }
        }
    }
}

1. Creates a secure session
2. Displays a welcome screen with your brand name and ID type cards
3. Shows a country picker if multiple countries are configured
4. User photographs the front of their ID inside the guide box
5. Photographs the back if required (National ID, Driver’s Licence, Voter’s Card)
6. Runs liveness face challenges
7. Returns a FlowResult to your completion handler

1. Creates a secure session
2. Displays a welcome screen with ID type selection
3. Shows a country picker if multiple countries are configured
4. User enters their ID number and any required fields
5. Identity is verified against the national database
6. Runs liveness face challenges
7. Returns a FlowResult to your completion handler

​

SDK Configuration

public struct SDKConfig {
    public init(
        apiKey: String,
        clientId: String,
        environment: SDKEnvironment = .sandbox,
        requestTimeout: TimeInterval = 30,       // seconds
        uploadTimeout: TimeInterval  = 120,      // seconds
        maxUploadRetries: Int = 3,
        debug: Bool = false
    )
}

​

FlowResult

public struct FlowResult {
    public let entryId: Int          // liveness entry ID — use this to query results via the API
    public let status: String        // e.g. "submitted"
    public let submittedAt: String?  // ISO 8601 timestamp
    public let idTypeName: String?   // e.g. "National ID", "BVN"
    public let verifiedName: String? // name returned by the identity provider (data mode only)
}

Final verification results are delivered via webhook. Once the backend completes processing, SmartComply sends a webhook event to the URL configured in your Dashboard. Set up your webhook endpoint to receive the final status, extracted fields, and any failure reasons. See the Webhooks guide for the full payload reference.

​

Error Handling

do {
    _ = try await sdk.createSession()
} catch let error as SDKError {
    print("API error \(error.statusCode):", error.message)
} catch {
    print("Network error:", error.localizedDescription)
}