Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smileidentity/android
The Official Smile ID Android SDK
https://github.com/smileidentity/android
android gradle-kotlin-dsl jetpack-compose kotlin ktlint
Last synced: about 2 months ago
JSON representation
The Official Smile ID Android SDK
- Host: GitHub
- URL: https://github.com/smileidentity/android
- Owner: smileidentity
- License: mit
- Created: 2022-12-09T16:00:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:31:47.000Z (3 months ago)
- Last Synced: 2024-10-29T13:31:45.638Z (3 months ago)
- Topics: android, gradle-kotlin-dsl, jetpack-compose, kotlin, ktlint
- Language: Kotlin
- Homepage: https://docs.usesmileid.com/integration-options/mobile/android-v10-beta
- Size: 2.29 MB
- Stars: 16
- Watchers: 12
- Forks: 5
- 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 Android SDK
[](https://github.com/smileidentity/android/actions/workflows/build.yaml)
[](https://mvnrepository.com/artifact/com.smileidentity/android-sdk)
[](https://oss.sonatype.org/content/repositories/snapshots/com/smileidentity/android-sdk/)
[](https://github.com/smileidentity/android/actions/workflows/build_app.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
Javadocs are available at https://javadoc.io/doc/com.smileidentity/android-sdk/latest/index.html
The [sample app](sample/src/main/java/com/smileidentity/sample/compose/MainScreen.kt) included in
this repo is a good reference implementation
#### 0. Requirements
- Android 5.0 (API level 21) and above
- Google Play Services
#### 1. Dependency
The SDK is available on Maven Central. To use it, add the following to your `build.gradle`:
```groovy
implementation("com.smileidentity:android-sdk:")
```
#### 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 `assets` directory (e.g.
`app/src/main/assets`). You may need to create the directory if it does not already exist.
#### 3. Initialization
The SDK should be initialized within your `Application` class' `onCreate`:
```kotlin
SmileID.initialize(this)
```
## UI Components
All UI functionality is exposed via either Jetpack Compose or Fragments
#### Jetpack Compose
All Composables are available under the `SmileID` object.
e.g.
```kotlin
SmileID.SmartSelfieEnrollment()
SmileID.SmartSelfieAuthentication()
SmileID.DocumentVerification()
SmileID.BiometricKYC()
```
#### Fragment
All Fragments are available under the `com.smileidentity.fragment` package.
(e.g. `SmartSelfieEnrollmentFragment`)
#### Theming
To customize the theme, you can pass in a custom `ColorScheme` to the SmileID composable, OR
override [the color resources defined in the SDK](lib/src/main/res/values/colors.xml)
## API
To make raw API requests, you can use `SmileID.api` (requires coroutines)
## 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)