Mobile SDKs

The Vouched mobile SDKs add identity verification directly to your iOS and Android apps. The SDK guides the user through capturing their ID document and taking a selfie with a liveness check, sends both to Vouched, and returns the verification result to your app.

Everything the user sees is a drop-in flow built with the platform's native UI framework, so it feels like part of your app rather than a browser handoff. You can keep the default screens as they are, or replace individual screens with your own.

What the SDK handles

• Document capture. Automatic detection of the front, back, or full ID, with quality checks before the image is accepted.
  • Enhanced Document Detection reads documents faster and more reliably than the classic pipeline, and is licensed per application. To enable it, give your Vouched representative the application ID of every app that will run the SDK.
    • Product flavors and an applicationIdSuffix each produce a separate application ID, and every one has to be registered
    • Until it is enabled, document capture runs the classic pipeline instead. Capture still works, and no code change is needed on your side once enhanced capture is turned on.
• Face capture with liveness. A selfie paired with a liveness challenge that confirms a real person is present.
• Submission and results. The SDK creates the verification job, uploads the captures, and returns the completed result to your app.
• Result handling. Separate paths for a successful verification, a user cancellation, and an error.
• Optional customization. Add your own instruction screens before the ID and face stages, and track the user's progress through each stage.

Verification flows

Choose the flow that matches what you need to confirm:

• ID only. Captures the ID document and stops there.
• Full identity verification. Captures the ID document, then a selfie with liveness, and matches the two. This is the most common choice.
• Re-verification. Selfie only, used to confirm a returning user against a verification they completed earlier.
• Selfie verification. Selfie only, without an ID document.

Your Vouched representative can confirm which flow fits your use case and which checks are enabled on your account.

Before you start

1. Contact your Vouched representative to set up your account and issue an API key. Your representative will also confirm the flow type and any additional checks you want enabled, such as address verification, or cross-checking user-provided details against the ID.
2. Add the SDK to your project using the instructions below.
3. Follow the platform README for the full integration, including code examples and configuration options.

Verification requires a real camera, so plan to test on a physical device. Simulators and emulators will not complete a capture.

iOS

Requirements

• iOS 17.0 or later
• Xcode 16.0 or later
• Swift 5.9 or later
• An Apple Developer account (the free tier is fine for local development)

Install

Add the package in Xcode through File → Add Package Dependencies, or add it to your Package.swift:

dependencies: [
    .package(url: "https://github.com/vouched/vouched-ios", from: "<version>")
]

Your app also needs a camera usage description in Info.plist, plus one additional key that the capture screens depend on. Both are covered in the README.

iOS SDK README

Android

Requirements

• Android 8.0 (API level 26) or later
• Kotlin 2.2.21 or later
• Android Gradle Plugin 8.12.3 or later
• Core library desugaring enabled

Install

Add the dependency to your app's build.gradle.kts:

dependencies {
    implementation("id.vouched.android:vouched-sdk-android:<version>")
    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.1.5")
}

Your app also needs camera, internet, and network state permissions in the manifest. The SDK's capture screens request camera access from the user at runtime for you.

Android SDK README

Customizing the experience

The default flow works without any UI changes, but you can adjust the parts your users notice most:

• Instruction screens. Show your own screen before the ID stage and before the face stage, so the guidance matches your product's tone.
• Terminal screens. Decide what the user sees when verification succeeds, when they cancel, and when something goes wrong.
• Stage tracking. Get a callback each time the user moves from one stage to the next, which is useful for your own funnel analytics.

Capture behavior itself, such as timeouts, quality thresholds, and which liveness challenge runs, is also configurable. These settings affect pass rates, so contact your Vouched representative before changing them rather than tuning them on your own.

Reading the result

When the flow finishes successfully, your app receives the completed verification job. It includes the job identifier, the overall status, whether the verification passed, the fields read from the ID, and confidence scores for things like face match and ID quality. It also includes any signals Vouched raised during the review.

If the flow does not finish, your app receives either a cancellation with an optional reason, or an error with a message you can log.

Analytics

We recommend turning on anonymous analytics. It lets the Vouched team see where verifications are failing inside your integration, which is the quickest route to a fix if you open a support ticket. Consent can be set when the flow starts or updated later from your app's privacy settings.

Sample apps

Both repositories include a working sample app that shows a complete integration. Add your API key, run it on a physical device, and you can step through the full flow before writing any of your own code.

Already using an earlier version?

The previous generation of mobile SDKs, including the React Native SDK, remains available and supported. React Native is only offered on that earlier version today.

If you are on an earlier SDK and want to move to the current one, contact your Vouched representative. They can walk through what changes in your integration and help plan the upgrade.