Introduction
Under Development: This SDK is currently in development. Documentation and API may change. For production use, please contact our team.
Overview
The Vouch Mobile SDK enables iOS, Android, and React Native applications to integrate cryptographic verification capabilities directly into their user flows. Users can generate web proofs from their mobile devices without leaving your native application, providing a seamless and secure verification experience.
Platform Support
iOS
The Vouch iOS SDK is available for Swift applications targeting iOS 16.4 and above. The SDK provides a SwiftUI-based interface that can be embedded directly into your application, enabling seamless cryptographic verification workflows.
Minimum Requirements:
- Minimal deployment target set to iOS 14+. (The SDK requires iOS 16.4+ to perform a verification, but for compatibility reasons we allow linking to older iOS versions).
Key Features:
- Native SwiftUI integration
- Swift Package Manager support
- Seamless user experience with in-app verification flows
- Comprehensive error handling and callback support
Getting Started:
- Installation Guide - Set up the SDK in your iOS project
- Usage Guide (Swift) - Learn how to integrate verification flows into your Swift app
- Usage Guide (Objective-C) - Learn how to integrate verification flows into your Objective-C app
Repository: vouch-ios-sdk on GitHub
Android
The Vouch Android SDK is available for applications targeting API level 26 and above. The SDK provides a Kotlin-based, Java-compatible interface that can be embedded directly into your application, enabling seamless cryptographic verification workflows.
Key Features:
- Native integration
- distributed via Maven
- Seamless user experience with in-app verification flows
- Comprehensive error handling and callback support
Getting Started:
- Installation Guide - Set up the SDK in your Android project
- Usage Guide (Kotlin) - Learn how to integrate verification flows into your Kotlin app
- Integration for apps with lower minSDK - Learn how to integrate the SDK into apps with lower minSDK
Example application: vouch-android-sdk-example on GitHub
Minimum Requirements:
- Android 8+ (API level 26+)
- RAM: Minimum requirements vary by data source complexity. 4GB RAM is recommended for optimal performance.
React Native
The Vouch React Native SDK (@getvouch/mobile-sdk) embeds the full verification flow in React Native and Expo apps. Integration is hook-first: mount a single provider, drive the flow with the useVouch hook, and render the flow screen wherever your app decides to show it. A promise-based modal API is also available for hosts migrating from the deprecated @getvouch/react-native-sdk.
Key Features:
- Hook-first API with a single root provider and observable flow state
- Works in Expo and bare React Native apps, on iOS and Android
- Modal compatibility API easing migration from the legacy React Native SDK
Getting Started:
- Installation Guide - Set up the SDK in your React Native project
- Usage Guide - Learn how to integrate verification flows into your app
- Migrating from the legacy SDK - Move off the deprecated
@getvouch/react-native-sdk
Package: @getvouch/mobile-sdk on npm
Minimum Requirements:
- React Native 0.81.5 – 0.83.x with React 19.1 – 19.2
- iOS 16.4+, Android 8+ (API level 26+)