https://github.com/smileidentity/flutter
The Official Smile ID Flutter SDK
https://github.com/smileidentity/flutter
android flutter flutter3 ios
Last synced: 10 months ago
JSON representation
The Official Smile ID Flutter SDK
- Host: GitHub
- URL: https://github.com/smileidentity/flutter
- Owner: smileidentity
- License: mit
- Created: 2023-07-17T12:35:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-27T12:26:23.000Z (over 1 year ago)
- Last Synced: 2024-11-27T13:26:59.571Z (over 1 year ago)
- Topics: android, flutter, flutter3, ios
- Language: Dart
- Homepage: https://docs.smileidentity.com/integration-options/mobile
- Size: 427 KB
- Stars: 2
- Watchers: 8
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Smile ID Flutter SDK
[](https://pub.dev/packages/smile_id)
[](https://github.com/smileidentity/flutter/actions/workflows/build.yaml)
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://www.usesmileid.com/schedule-a-demo/) for a free Smile ID account, which comes
with Sandbox access.
Please see [CHANGELOG.md](CHANGELOG.md) or
[Releases](https://github.com/smileidentity/android/releases) for the most recent version and
release notes
## Getting Started
Full documentation is available at https://docs.usesmileid.com/integration-options/mobile
#### 0. Requirements
* Flutter 3.0.0+
* Dart 3.0.5+
* A `smile_config.json` file from [SmileID](https://portal.usesmileid.com/sdk)
* See: https://github.com/smileidentity/android for Android specific requirements
* See: https://github.com/smileidentity/ios for iOS specific requirements
#### 1. Dependency
The latest release is available on [pub.dev](https://pub.dev/packages/smile_id)
Add the dependency to your `pubspec.yaml`
```yaml
dependencies:
smile_id:
```
#### 2. Smile Config
#### Android
Place the `smile_config.json` file under your application's assets, located at `src/main/assets`
(This should be at the same level as your `java` and `res` directories). You may need to create the
directory if it does not already exist.
#### iOS
Drag the `smile_config.json` into your project's file inspector and ensure that the file is added to
your app's target. Confirm that it is by checking the Copy Bundle Resources drop down in the Build
Phases tab as shown below.
#### 3. Initialization
Initialize the Smile ID SDK in `main.dart` by calling `initialize`
```dart
import 'package:smile_id/smile_id.dart';
void main() {
SmileID.initialize();
}
```
## 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)