> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deepidv.com/llms.txt
> Use this file to discover all available pages before exploring further.

# iOS SDK overview

> Add identity verification to an iOS app: guided ID capture, selfie, face liveness, re-verification and full verification workflows, as native SwiftUI screens.

The deepidv iOS SDK puts identity verification inside your app. It ships the capture screens your users see (ID document, selfie, face liveness) and the calls behind them, so a complete verification is one SwiftUI view.

![Four iPhone screens in a row: an ID card held in the capture frame with 'Hold still', a selfie taken in the oval with a green tick, the liveness ring filling around a face, and the 'Thanks, you're done' screen.](https://mintcdn.com/deep-identity-inc/KR_jLd52VE3haGnp/images/ios/overview-flow.webp?fit=max\&auto=format\&n=KR_jLd52VE3haGnp\&q=85\&s=9ddecc1e06a12418ab52ccaa0959a884)

A workflow on iPhone: ID capture, selfie, face liveness, and the closing screen.

## What's included

| Area | What you get |
| - | - |
| [Workflows](https://docs.deepidv.com/integrate/sdks/ios/workflows/run-a-workflow.md) | `DeepIDVWorkflowView` runs a verification workflow you built in the Admin Console, step by step: ID verification (up to three documents), face liveness, retries, resuming and a closing screen. |
| [Document capture](https://docs.deepidv.com/integrate/sdks/ios/document-capture.md) | Guided capture of ID cards, driver's licenses and passports. Recognizes the document, catches a card held upside down, refuses health cards, captures automatically and falls back to a manual shutter. |
| [Selfie](https://docs.deepidv.com/integrate/sdks/ios/selfie.md) | A front-camera selfie with face guidance. |
| [Face liveness](https://docs.deepidv.com/integrate/sdks/ios/face-liveness.md) | A native liveness check (head movement, optionally with a colored-light sequence), scored by deepidv. |
| [Re-verification](https://docs.deepidv.com/integrate/sdks/ios/re-verification.md) | Confirms a returning user is the same person, with their face. |
| [Drop-in verification](https://docs.deepidv.com/integrate/sdks/ios/drop-in-verification.md) | ID and selfie in one view, without a workflow. |
| [Headless API](https://docs.deepidv.com/integrate/sdks/ios/headless/document-and-identity.md) | `async` methods for images you captured yourself: document scan, identity verify, liveness and iGaming checks. |
| [Branding](https://docs.deepidv.com/integrate/sdks/ios/branding.md) and [languages](https://docs.deepidv.com/integrate/sdks/ios/languages.md) | Your colors, fonts and corner radius; English, Spanish and French. |

## Requirements

* iOS 15 or later
* Xcode 26 or later (Swift 6.2)
* `NSCameraUsageDescription` in your app's `Info.plist`
* No third-party dependencies: the SDK uses Apple frameworks only

## How it fits together

Your app runs the screens. Your backend holds the deepidv API key, creates sessions, and receives the decision.

```mermaid theme={null}
flowchart LR
    A[Your iOS app<br/>deepidv SDK] -- "SDK requests" --> B[Your backend<br/>proxy]
    B -- "x-api-key" --> C[deepidv API]
    A -. "photos (presigned uploads)" .-> D[(deepidv storage)]
    C -- "webhook: decision" --> B
```

* The SDK never needs your secret API key on the device. Route its requests through your backend, which adds the key. See [Security and API keys](https://docs.deepidv.com/integrate/sdks/ios/security-and-api-keys.md).
* Photos upload straight to deepidv storage through short-lived presigned URLs, so your backend doesn't carry images.
* The decision reaches your backend through [webhooks](https://docs.deepidv.com/webhooks/overview.md) and `GET /v1/sessions/{id}`. The SDK's result is for your UI, not for granting access.

## What do you want to do?

| Goal | Start here |
| - | - |
| Verify a new user with ID and face | [Quickstart](https://docs.deepidv.com/integrate/sdks/ios/quickstart.md), then [Run a workflow](https://docs.deepidv.com/integrate/sdks/ios/workflows/run-a-workflow.md) |
| Pick the right integration | [Choose an integration](https://docs.deepidv.com/integrate/sdks/ios/choose-an-integration.md) |
| Confirm a returning user | [Re-verification](https://docs.deepidv.com/integrate/sdks/ios/re-verification.md) |
| Build your own screens around our capture | [Document capture](https://docs.deepidv.com/integrate/sdks/ios/document-capture.md), [Selfie](https://docs.deepidv.com/integrate/sdks/ios/selfie.md), [Face liveness](https://docs.deepidv.com/integrate/sdks/ios/face-liveness.md) |
| Use photos you already have | [Headless API](https://docs.deepidv.com/integrate/sdks/ios/headless/document-and-identity.md) |
| Match your brand | [Branding](https://docs.deepidv.com/integrate/sdks/ios/branding.md) |
| Ship safely | [Security and API keys](https://docs.deepidv.com/integrate/sdks/ios/security-and-api-keys.md), [Proxy mode](https://docs.deepidv.com/integrate/sdks/ios/proxy-mode.md) |
| Let an AI assistant do the integration | [Build with AI](https://docs.deepidv.com/integrate/sdks/ios/ai-agents.md) |

## Source and releases

The SDK is open source under the MIT license: [github.com/Deep-Identity-Inc/deepidv-sdk-swift](https://github.com/Deep-Identity-Inc/deepidv-sdk-swift). Every release is listed in the [changelog](https://docs.deepidv.com/integrate/sdks/ios/reference/changelog.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.