donpaul120 / smileid-ios

The Official Smile ID iOS SDK

Smile ID iOS SDK

Smile ID provides the best solutions for Real Time Digital KYC, Identity Verification, User Onboarding, and User Authentication across Africa.

If you haven’t already, sign up for a free Smile ID account, which comes with Sandbox access.

Please see CHANGELOG.md or Releases for the most recent version and release notes

Getting Started

Full documentation is available at https://docs.smileidentity.com/integration-options/mobile

The sample app included in this repo is a good reference implementation

0. Requirements

• iOS 13 and above
• Xcode 14 and above

1. Installation

The SDK is available via CocoaPods and Swift Package Manager.

To integrate SmileID into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'SmileID'

You can add SmileID as a dependency by adding it to the dependencies value of your Package.swift

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

2. Smile Config

Please download your smile_config.json file from the Smile ID Portal and add it to your project. Ensure the file is added to your app's target.

3. Initialization

Initialize the SDK in your AppDelegate's application(_:didFinishLaunchingWithOptions:) method or the SceneDelegate's scene(_:willConnectTo:options:) depending on your app's structure.

let config = try? Config(url: Constant.configUrl)
SmileID.initialize(config: config)

UI Components

All UI functionality is exposed via SwiftUI views. To support UIKit, embed the views in a UIHostingController. All views are available under the SmileID object.

e.g.

SmileID.smartSelfieEnrollmentScreen()
SmileID.smartSelfieAuthenticationScreen()

Theming

To customise the colors and typography of the SDK screens, you need to create a class that conforms to SmileIdTheme protocol. This protocol exposes the cutomisable UI elements on the SDK.

API

To make raw API requests, you can use SmileID.api

Getting Help

For detailed documentation, please visit https://docs.smileidentity.com/integration-options/mobile

If you require further assistance, you can file a support ticket or contact us

Contributing

Bug reports and Pull Requests are welcomed. Please see CONTRIBUTING.md

License

MIT License