Overview
Amani provides three SDK families, each designed for a distinct purpose within the identity verification ecosystem. Rather than offering similar capabilities, each SDK focuses on a different layer of the verification experience — from automated identity capture, to live assisted verification, to accessibility support.
KYC SDK
Identity verification — document capture (ID, passport), selfie, NFC chip reading, hologram detection, liveness checks, and biometric matching. Available in two integration styles: Core SDK and UI SDK.
Choose KYC SDK →Video SDK
Real-time video calling for assisted KYC sessions, powered by WebRTC. An agent can guide the end-user through the verification process live over a video connection.
Choose Video SDK →VoiceAssistant SDK
Accessibility add-on that delivers TTS (text-to-speech) voice guidance through each step of the KYC flow. Supports remote voice config and custom MP3 audio files per language.
View VoiceAssistant Docs →KYC SDK
The KYC SDK is the core of Amani's identity verification product. It handles every step of the KYC process — document capture, selfie matching, NFC chip reading, hologram validation, and biometric login — across Android, iOS, Flutter, and React Native.
It is offered in two integration styles that expose the same underlying verification engine but differ significantly in how much work the developer needs to do.
⚙️ Core SDK
The Core SDK exposes each verification capability as an independent module. You call modules directly, build your own screens, wire up your own navigation, and control every aspect of the flow. The SDK acts as a headless engine — it has no built-in UI at all.
ID Capture
Scan and OCR identity documents (passport, driver's licence, national ID) with optional hologram detection and video recording.
Selfie
Three capture modes: manual shutter, automatic face-detection, and pose estimation for liveness verification.
NFC Chip Reading
Read biographic and biometric data from ePassport and eID chips using the device's NFC hardware.
Digital Signature
Capture and submit a handwritten digital signature as part of the KYC record.
BioLogin
Authenticate returning users via a biometric comparison against a stored face template (v1 and v2 backends).
Customer Info
Collect and submit structured customer data (name, DOB, document number) alongside the verification.
🧩 UI SDK
The UI SDK bundles the Core SDK engine with a complete set of prebuilt screens and an opinionated flow manager. You initialise it with a token and it handles every screen, transition, error message, and result callback automatically.
Customisation is available at the surface level: you can change colours, localised text strings, and toggle individual features (e.g. hologram detection, geolocation) via configuration parameters. The underlying screen layouts are managed by the SDK.
Prebuilt Screens
Ready-to-use screens for every KYC step, including instructions, capture viewfinders, upload progress, and success/failure states.
Theme Customisation
Override brand colours, button styles, and all user-facing text strings without rebuilding any layouts.
Automatic Flow
The SDK reads the verification rules from the server and drives the user through exactly the required steps — no manual navigation code needed.
Single-call Integration
Start the entire KYC flow with one method call (showSDK() / startAmaniSDKWithToken()) and receive a single success/failure result callback.
Localisation
Built-in multi-language support. Pass a language code at initialisation to switch all on-screen text automatically.
Includes Core Engine
Every feature of the Core SDK is available under the hood — NFC, pose estimation, hologram detection — all activated via config flags, no extra code.
🧬 BioMatch SDK
BioMatch is a standalone biometric authentication add-on. It captures the user's facial data and matches it against a facial template that was previously registered during an earlier KYC session. If a match is found, the user is authenticated without repeating the full verification flow.
BioMatch is currently shipped as a separate native SDK for Android and iOS only. However, cross-platform apps can integrate it by building a custom native bridge to the Android/iOS SDK on each target platform.
Facial Data Capture
Captures the user's live facial biometric at authentication time using the same capture engine as the KYC SDK.
Template Matching
Compares the captured face against the stored biometric template from the user's original KYC registration. Returns a profile information that links to Biometric Profile.
Re-authentication Flow
Authenticates returning users without re-running the full KYC process — suitable for login, re-verification, or step-up authentication gates.
Separate Package
Distributed as an independent SDK. Add it only to the apps and targets that require biometric re-authentication; it adds no overhead to flows that don't use it.
Core vs UI — Side-by-Side Comparison
| Dimension | 🧩 UI SDK | ⚙️ Core SDK |
|---|---|---|
| Integration effort | Low — one method call | High — wire every screen and transition |
| Prebuilt screens | ✓ Full set included | ✕ None — build your own |
| UI customisation | Surface level (colours, texts) | In single-view modules, colors and texts can be customized programmatically, and developers have full control over any preceding or subsequent logic and screens. |
| Flow management | Automatic (server-driven) | Manual — you control navigation |
| Business logic | Config-flag level | Arbitrary custom logic |
| Localisation | Built-in language switching | Manual per-string translation |
| Time to production | 20–30 min | 4–6 hours |
| Access to modules | Via config flags | Direct API calls |
| NFC / hologram | Config flag | Direct module API |
| Pose estimation | Config flag | Direct module API |
| Best for | Standard, compliant KYC flows | Fully custom-branded experience |
Which Should I Choose?
Choose UI SDK if…
- You want to ship KYC quickly with minimal UI work
- Your brand can accept Amani's screen layouts with colour & text overrides
- Your team does not have native mobile design capacity
- You need reliable, pre-tested error states and edge-case handling out of the box
- The verification flow is server-driven and you don't need custom step ordering
Choose Core SDK if…
- Your product has a distinct design system the KYC flow must conform to
- You need custom screen transitions, animations, or multi-step wizards
- You need to interleave KYC steps with your own app screens
- You need to add custom business rules between verification steps
- You have the native mobile development capacity to build the UI
Video SDK
The Video SDK enables real-time, agent-assisted KYC sessions over a live video connection. An operator joins the call from the Amani Studio dashboard, guides the user through the verification steps, and can request actions (show the front of the ID, hold still for a selfie) in real time.
It is distinct from the KYC SDK — rather than an automated, self-service flow, it adds a human layer to the verification process.
Features
WebRTC Video Calling
Low-latency, peer-to-peer video stream between the user's device and the agent's browser dashboard.
Fully Customizable UI
Replace any icon, text, or color in the video call interface. You can also inject any native view directly into the call screen — full freedom over the look and feel.
Camera Control
The agent can request the user switch between front and rear cameras during the session.
Secure Signalling
Session signalling via Socket.IO with token-based authentication, consistent with the rest of the Amani platform.
Session State Callbacks
Subscribe to connection, disconnection, and error events to drive your own app logic — show custom loaders, retry prompts, or analytics events at each stage.
Studio Integration
Agent-side tooling is built into the Amani Studio dashboard — no separate operator software required.
VoiceAssistant SDK
The VoiceAssistant SDK is an accessibility add-on that narrates each step of the KYC flow using text-to-speech audio. It is not a standalone verification SDK — it runs alongside the KYC SDK (Core or UI) to make the experience accessible to users with visual impairments or low digital literacy.
Features
Flexible Voice Triggering
With Core SDK, you are free to call any voice prompt at any point in your flow — trigger narration wherever it makes sense in your UX. With UI SDK, voice prompts are already wired into the built-in screens automatically.
Multi-language Voice
Voice files are keyed by language code and can be swapped at runtime to match the user's locale.
Remote Configuration
Voice files can be fetched from Amani's remote config endpoint, keeping the app binary small and allowing updates without a release.
Custom Audio Files
Supply your own branded voice recordings as base64-encoded MP3 files in a JSON manifest — no third-party TTS engine required.
Delegate Callbacks
Receive play/stop events so you can pause other audio, show accessibility cues in the UI, or synchronise with screen reader announcements.
Standalone Package
Distributed as a separate Swift Package (SPM) so it adds no overhead to apps that don't need it.
Platform Support
The following matrix shows which capabilities are available on each platform across all Amani SDK families.
| Capability |  Android |  iOS |  Flutter |  React Native |
|---|---|---|---|---|
| KYC — Core SDK | ✓ | ✓ | ✓ | ✓ |
| KYC — UI SDK | ✓ | ✓ | ✓ | ✓ |
| KYC — BioMatch SDK | ✓ | ✓ | ✕ | ✕ |
| KYC — BioLogin (v1 & v2) | ✓ | ✓ | ✕ | ✕ |
| Video SDK | ✓ | ✓ | ✓ | ✕ |
| VoiceAssistant SDK | ✓ | ✓ | ✕ | ✕ |
Note: Features marked ✕ for Flutter and React Native do not have a first-party cross-platform SDK. They can still be used by writing a custom native bridge to the Android and iOS SDKs on each target platform.