Installation

Add the package

The SDK is a Swift package with one product, DeepIDV.

Xcode
Package.swift

In Xcode, choose File > Add Package Dependencies…
Enter https://github.com/Deep-Identity-Inc/deepidv-sdk-swift
Set Dependency Rule to Up to Next Major Version from 1.3.0.
Add the DeepIDV library to your app target.

dependencies: [
    .package(url: "https://github.com/Deep-Identity-Inc/deepidv-sdk-swift", from: "1.3.0"),
],
targets: [
    .target(
        name: "YourApp",
        dependencies: [.product(name: "DeepIDV", package: "deepidv-sdk-swift")]
    ),
]

Then import it where you use it:

import DeepIDV

Declare camera access

The capture screens use the camera, so your app must say why in its Info.plist. Without this key, iOS ends the app the first time the camera opens.

<key>NSCameraUsageDescription</key>
<string>Used to scan your ID and take a selfie to verify your identity.</string>

The SDK asks for permission the first time a camera screen opens. If the user has turned camera access off, the screen explains it and offers Open Settings. Your app also receives .failure with kind .cameraPermissionDenied. The SDK doesn’t use the microphone or the photo library.

Privacy manifest

The SDK ships its own PrivacyInfo.xcprivacy, which Xcode adds to your app’s privacy report. You don’t need to copy its entries. See Privacy for what it declares and the two values you declare yourself if you use them.

Custom fonts

If you brand the screens with your own font, bundle the font files and list them under UIAppFonts in your Info.plist. A family iOS can’t find falls back to the system font.

How updates arrive

The SDK follows semantic versioning. With Up to Next Major Version, your app picks up new minor and patch releases the next time you update packages (File > Packages > Update to Latest Package Versions). Read the changelog before you update: minor releases can change defaults, and each one lists what to check under Upgrading. To stay on one exact version, set the rule to Exact Version.

Guides

TypeScript

iOS

Add the package

Declare camera access

Privacy manifest

Custom fonts

How updates arrive

Next steps

Quickstart

Proxy mode

​Add the package

​Declare camera access

​Privacy manifest

​Custom fonts

​How updates arrive

​Next steps

Quickstart

Proxy mode

Add the package

Declare camera access

Privacy manifest

Custom fonts

How updates arrive

Next steps