Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smileidentity/ios
The Official Smile ID iOS SDK
https://github.com/smileidentity/ios
combine ios swift swiftui
Last synced: about 1 month ago
JSON representation
The Official Smile ID iOS SDK
- Host: GitHub
- URL: https://github.com/smileidentity/ios
- Owner: smileidentity
- License: mit
- Created: 2022-12-14T17:08:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:03:00.000Z (3 months ago)
- Last Synced: 2024-10-29T15:55:45.112Z (3 months ago)
- Topics: combine, ios, swift, swiftui
- Language: Swift
- Homepage: https://docs.smileidentity.com/integration-options/mobile/ios-v10-beta
- Size: 20.5 MB
- Stars: 8
- Watchers: 7
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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](https://usesmileid.com/talk-to-an-expert) for a free Smile ID account, which comes
with Sandbox access.
Please see [CHANGELOG.md](CHANGELOG.md) or
[Releases](https://github.com/smileidentity/ios/releases) for the most recent version and
release notes
## Getting Started
Full documentation is available at https://docs.usesmileid.com/integration-options/mobile
The [sample app](Example) 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`:
```ruby
pod 'SmileID'
```
You can add SmileID as a dependency by adding it to the `dependencies` value of your `Package.swift`
```swift
dependencies: [
.package(url: "https://github.com/smileidentity/ios.git", .upToNextMajor(from: ""))
]
```
#### 2. Smile Config
Please download your `smile_config.json` file from the
[Smile ID Portal](https://portal.usesmileid.com/sdk) 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.
```swift
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.
```swift
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.usesmileid.com/integration-options/mobile
If you require further assistance, you can
[file a support ticket](https://portal.usesmileid.com/partner/support/tickets) or
[contact us](https://www.usesmileid.com/contact-us/)
## Contributing
Bug reports and Pull Requests are welcomed. Please see [CONTRIBUTING.md](CONTRIBUTING.md)
## License
[MIT License](LICENSE)