iOS SDK Overview¶
Biometrid iOS SDK provides identity verification capabilities for native iOS applications. Available in two variants to fit different integration needs.
SDK Variants¶
Core SDK¶
BiometridStandard
Headless integration - Full API access without UI components
- Complete API access with custom UI development
- Smaller binary size
- Maximum flexibility for custom integrations
UI SDK¶
BiometridFull
Complete solution - Pre-built UI components included
- Ready-to-use native interface
- Quick integration
- Accessibility compliant
Requirements¶
| Requirement | Minimum |
|---|---|
| Xcode | 16.0 or later |
| iOS Deployment Target | 16.0 |
| Swift | 5.9 or later |
| CocoaPods | Required |
Installation¶
Step 1: Create or Update Podfile¶
If you don't have a Podfile, initialize one:
cd /path/to/your/project
pod init
Step 2: Add SDK Dependencies¶
Open your Podfile and add the pod for your chosen variant:
Core SDK¶
platform :ios, '16.0'
source 'https://cdn.cocoapods.org'
source 'https://dl.cloudsmith.io/public/biometrid/face01-liveness/cocoapods/index.git'
source 'https://dl.cloudsmith.io/public/biometrid/mobile/cocoapods/index.git'
source 'https://github.com/CocoaPods/Specs'
target 'YourAppName' do
use_frameworks!
pod 'BiometridStandard', '~> 3.2.1'
end
post_install do |installer|
installer.pods_project.targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['ENABLE_BITCODE'] = 'NO'
config.build_settings['ENABLE_USER_SCRIPT_SANDBOXING'] = 'NO'
config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '16.0'
end
end
end
UI SDK¶
platform :ios, '16.0'
source 'https://cdn.cocoapods.org'
source 'https://dl.cloudsmith.io/public/biometrid/face01-liveness/cocoapods/index.git'
source 'https://dl.cloudsmith.io/public/biometrid/mobile/cocoapods/index.git'
source 'https://github.com/CocoaPods/Specs'
target 'YourAppName' do
use_frameworks!
pod 'BiometridFull', '~> 3.3.0'
end
post_install do |installer|
installer.pods_project.targets.each do |target|
target.build_configurations.each do |config|
config.build_settings['ENABLE_BITCODE'] = 'NO'
config.build_settings['ENABLE_USER_SCRIPT_SANDBOXING'] = 'NO'
config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '16.0'
end
end
end
The following dependencies are installed automatically:
- BiometridLiveness
- Face06
- Face01
- Sentry
Step 3: Install Pods¶
pod install
After installation, always use the .xcworkspace file:
open YourAppName.xcworkspace
Project Configuration¶
The SDK requires specific build settings. CocoaPods configures most of these automatically, but verify:
| Setting | Required Value |
|---|---|
| Enable Bitcode | NO |
| User Script Sandboxing | NO |
| Always Embed Swift Standard Libraries | YES |
Required Permissions¶
Add the following keys to your Info.plist:
<!-- Required -->
<key>NSCameraUsageDescription</key>
<string>Camera access is required to capture identity documents and perform liveness detection for verification purposes.</string>
<!-- Optional: enhanced liveness features -->
<key>NSMicrophoneUsageDescription</key>
<string>Microphone access may be required for enhanced liveness detection.</string>
<!-- Optional: allow users to select existing photos -->
<key>NSPhotoLibraryUsageDescription</key>
<string>Access to your photo library is required to select identity documents.</string>
| Permission | Required | Purpose |
|---|---|---|
NSCameraUsageDescription |
Yes | Document capture and liveness detection |
NSMicrophoneUsageDescription |
No | Enhanced liveness features |
NSPhotoLibraryUsageDescription |
No | Selecting existing photos |
Features¶
- Native iOS experience: UIKit and SwiftUI support
- Secure: End-to-end encryption and Keychain integration
- Accessibility: VoiceOver and Dynamic Type support
- Multi-language support: English, Portuguese, Spanish