Installation

Minimum iOS: 16.0
Swift tools: 5.9
UI frameworks: SwiftUI and UIKit

Add the package

In Xcode: File → Add Package Dependencies… and enter:

https://github.com/ChmodLab/chmod-kyc-sdk-ios

Pick the latest version and add the ChmodKyc library to your app target. Or, if you manage dependencies in a Package.swift:

dependencies: [
    .package(url: "https://github.com/ChmodLab/chmod-kyc-sdk-ios", from: "0.0.20")
],
targets: [
    .target(name: "MyApp", dependencies: [
        .product(name: "ChmodKyc", package: "chmod-kyc-sdk-ios")
    ])
]

Info.plist

Three entries are required.

<key>NSCameraUsageDescription</key>
<string>We need the camera to scan your ID document.</string>

<key>NSLocationWhenInUseUsageDescription</key>
<string>We use your location to verify your identity.</string>

<key>CADisableMinimumFrameDurationOnPhone</key>
<true/>

iOS terminates the app the moment the SDK asks for the camera if NSCameraUsageDescription is missing. This is the operating system killing your process, not the SDK failing, so there is nothing to catch. Add it before you run the flow once.

string

required

Shown in the camera permission prompt. Always required.

string

Shown in the location permission prompt. Required only while locationPermission is REQUIRED.

boolean

required

Not a permission. It opts the render loop into the full refresh rate on ProMotion iPhones. The SDK validates it when the flow is presented and throws if it is missing or false.

Verify the setup

Import the module and build. If it compiles, the package is wired up:

import ChmodKyc

Quick start

Launch the flow from SwiftUI or UIKit.

Handling the result

Every outcome and error code.

Overview

iOS

Android

Configuration

Other Platforms

Installation

Add the package

Info.plist

Verify the setup

Next

Quick start

Handling the result

​Add the package

​Info.plist

​Verify the setup

​Next

Quick start

Handling the result

Add the package

Info.plist

Verify the setup

Next