Skip to main content

📱 iOS SDK

The PasskeymeSDK provides native iOS passkey authentication using the AuthenticationServices framework. This SDK handles only WebAuthn/FIDO2 operations and requires backend integration for complete authentication flows.

🚀 Quick Start​

Get started with iOS passkey authentication in just a few steps:

  1. Configuration & Setup - Configure apple-app-site-association and Associated Domains
  2. SDK Integration - Install and integrate the SDK into your iOS app
  3. Security Best Practices - Implement production security patterns
  4. API Reference - Complete SDK documentation

📋 Prerequisites​

  • iOS 16.0+ (for optimal passkey support)
  • Xcode 14+ with Swift 5.7+
  • Apple Developer Account with app signing capabilities
  • Domain ownership for apple-app-site-association hosting
  • PasskeyMe Application configured at passkeyme.com

⚙️ How It Works​

🔧 Installation​

CocoaPods​

# Podfile
pod 'PasskeymeSDK'

Swift Package Manager​

dependencies: [
    .package(url: "https://github.com/passkeyme/ios-sdk.git", from: "1.0.0")
]

💡 Quick Example​

import PasskeymeSDK

class AuthManager {
    func registerPasskey(challenge: String) {
        PasskeymeSDK.passkeyRegister(challenge: challenge) { result in
            switch result {
            case .success(let credential):
                print("Registration successful: \(credential)")
            case .failure(let error):
                print("Registration failed: \(error.localizedDescription)")
            }
        }
    }
    
    func authenticatePasskey(challenge: String) {
        PasskeymeSDK.passkeyAuthenticate(challenge: challenge) { result in
            switch result {
            case .success(let assertion):
                print("Authentication successful: \(assertion)")
            case .failure(let error):
                print("Authentication failed: \(error.localizedDescription)")
            }
        }
    }
}

📚 Documentation Structure​

🔧 Configuration

Essential setup including apple-app-site-association and Associated Domains

Setup Guide →

📱 Integration

Complete SDK integration with SwiftUI and UIKit examples

Integration →

🔒 Security

Production security best practices and implementation patterns

Security →

📖 API Reference

Complete SDK API documentation with examples and data structures

API Docs →

🔗 Related Documentation​

Need Help?

The iOS SDK provides comprehensive support for passkey authentication. If you need assistance with integration or have questions about specific use cases, check our troubleshooting guide or reach out to our support team.

SDK Purpose

This is a low-level SDK for native iOS apps. For cross-platform solutions, consider: