README.md

Smile ID React Native SDK

Smile ID provides premier 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 Smile ID Documentation

0. Requirements

• Node.js >=16.0
• React Native >=0.70
• A smile_config.json file from Smile ID Portal
• See: Android Requirements for Android specific requirements.
• See: iOS Requirements for iOS specific requirements.

1. Dependency

The latest release is available on npm

Add the dependency to your package.json:

{
  "dependencies": {
    "@smile_identity/react-native": "<latest-version>"
  }
}

2. Initialization

There are multiple ways to initialize the SDK. See Initialization and choose the best option for your integration

Getting Help

For detailed documentation, please visit Smile ID Documentation

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