iOS SDK
Introduction
The HyperVerge iOS SDK is a native iOS library that enables comprehensive customer onboarding and verification workflows within your iOS applications. Built specifically for iOS using Swift, the SDK provides flexible capabilities including identity verification, fraud detection, document processing, face authentication, and compliance checks.
Key Features
- Provides easy implementation with just a few lines of code
- Offers native iOS development using Swift with full iOS compatibility
- Supports document capture, selfie verification, face matching, liveness detection, and operations
- Enables core functionalities like Camera and Geo Location without internet connectivity
- Features modular architecture to exclude unused components and reduce app size
- Allows configurable UI text for multiple languages
- Enables seamless verification continuation across different devices
Implementation Overview
- Add the SDK to your iOS project as a dependency through CocoaPods
- Guide users through verification steps using native iOS UI components
- Receive structured results containing status information and extracted data
- Process verification results to determine subsequent steps in user workflows
Prerequisites
Development Requirements:
- iOS Version: Supports iOS 13.0 and higher
- Xcode Version: 16.2 or higher (from 1.0.0)
- Xcode Version: 15.2 or higher (from 0.22.0)
- Swift Version: 5.5 or higher
- CocoaPods: 1.11.x
- Swift Package Manager (SPM): supported from 1.0.0 onwards
- Development Environment: Xcode with CocoaPods or SPM support
Required Permissions:
The iOS SDK requires specific permissions to function properly, including:
- camera access for document and face capture,
- microphone permissions for video-based workflows, and
- optional location permissions for geo-tagging features.
iOS SDK permissions are handled through Info.plist customization. You add only the permissions your app needs to the Info.plist file, and omit those you don't require. For a comprehensive list of all required permissions, optional permissions, and a detailed configuration example, see our SDK Permissions Guide.
App Store Compliance:
- Ensure proper Info.plist permission descriptions
- Follow Apple's guidelines for camera and microphone usage
HyperVerge Account Setup:
- Active HyperVerge account with dashboard access
- Set up and configure a specific workflow in your HyperVerge One account dashboard
- Obtain valid appId and appKey credentials from the HyperVerge One dashboard
- Ensure you provide the correct WorkflowID to integrate any workflow provided by HyperVerge
Related Documentation
| Page | Description |
|---|---|
| Quick Start Guide | Get started quickly with the iOS SDK using this step-by-step quick start guide |
| Integration Guide | Step by step guide for integrating the iOS SDK into your iOS application with code examples |
| Changelogs | Track version updates, new features, bug fixes, and breaking changes in the iOS SDK |
| FAQs | Frequently asked questions about permissions, iOS compatibility, security warnings, and troubleshooting |
| SDK Permissions Guide | Learn about required permissions, optional permissions, and how to configure Info.plist for your iOS app |