Overview
Run your PayMedia eKYC onboarding journeys and video verification calls inside your own Android and iOS apps.
The PayMedia eKYC Mobile SDK puts the onboarding journeys you design in Institution Admin inside your own mobile app. Customers never leave your app and never see a browser: the journey opens full screen, in your institution's branding, exactly as you published it.
What it does
- Runs any published work flow, page for page as you designed it, including branches, API calls and the services it calls.
- Captures identity documents and selfies with the phone's own camera, with an on-screen guide frame for each.
- Runs the video verification call inside your app, with the camera, microphone and screen handled for the customer.
- Tells the customer on their phone when their video call is booked, moved, about to start, or when the agent is ready.
- Reports progress to your app as it happens: the journey started, the application was submitted with its reference, the call began and ended.
How it fits together
- In Institution Admin, under Settings › Mobile SDK, you create a key for an environment and allow your app to use it.
- Your app configures the SDK with your journey host and that key.
- When a customer starts, the SDK checks with your institution that this app, this key and this SDK version may start a journey now. Only then does it show anything.
- The journey runs inside your app. Everything the customer enters goes to your institution, never to your app.
Requirements
| Android | iOS | |
|---|---|---|
| Minimum OS | Android 7.0 (API 24) | iOS 15 |
| Language | Kotlin or Java | Swift |
| Distribution | Maven (Gradle) | Swift Package Manager or CocoaPods |
| Push (optional) | Firebase Cloud Messaging | Firebase Cloud Messaging with APNs |
Environments
Your institution has a Sandbox, a UAT and a Production environment. Each has its own SDK keys, its own allowed apps, its own version policy and its own push settings, so a test build can never start a live journey by mistake. Use a Sandbox or UAT key in your development and test builds, and a Production key only in the build you release.