@smile_identity/react-native
v10.2.1
Published
Official wrapper for the Smile ID <v10 android and iOS SDKs
Downloads
605
Readme
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. 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 your app's entry file (normally index.tsx
) by calling initialize
:
import { initialize } from 'rn-smile-id';
import React, { useEffect } from 'react';
const App = () => {
useEffect(() => {
initialize().then(() => console.log('Smile ID Initialized'));
}, []);
return (
// ...rest of your component
);
};
export default App;
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