SDK Installation
Install guides for every Mubeen SDK
Every Mubeen integration starts with two things: a site key from your dashboard and a regional backend URL. From there, install the SDK that matches your platform. This page gets you from zero to a working install; the platform guides then walk you through initialization and sending the device ID to your backend.
Prerequisites
Before installing anything, make sure you have:
| Requirement | Details |
|---|---|
| Site Key | Starts with public_ — obtain from your Mubeen dashboard |
| Backend URL | Region-specific collection endpoint — https://fp.de.mubeen.ai (EU) or https://fp.sa.mubeen.ai (KSA). Required on every initialization. |
The backend_url determines where fingerprint data is collected and stored. Choose the region that matches your data-residency obligations — it is required on every initialization, across all platforms and install flavors.
If your keys were issued for the Zain Cloud deployment, use the Zain endpoints instead of the regional ones above: fp.efm.zaincloud.com.sa for fingerprint collection and api.efm.zaincloud.com.sa for the API. Everything else in this guide applies unchanged.
Choose Your Platform
| Platform | Install Method | Guide |
|---|---|---|
| Web (plain HTML) | CDN <script> tag — no package manager | Client-Side Integration (HTML) |
| React SPA | CDN <script> tag + useDeviceId hook | Client-Side Integration (React) |
| Android | Maven Central dependency | Android Device Intel |
| iOS | Swift Package Manager | iOS Device Intel |
| Backend / server | No SDK — REST API | Server-Side Integration |
Web (Plain HTML)
The JavaScript SDK ships as a single script served from the Mubeen CDN — there is nothing to install with npm or yarn. The fastest path is the one-line auto-init flavor:
<script src="https://cdn.mubeen.ai/fp/mub_fp.js?site_key=YOUR_SITE_KEY&backend_url=fp.sa.mubeen.ai"></script>
Two more install flavors (data-attribute auto-init and manual initialization) support self-hosting the script and consent-gated setup — see Client-Side Integration (HTML) for the quickstart or the SDK Reference for all three.
React
React single-page applications use the same CDN script plus a useDeviceId hook that exposes the device ID to your components. No npm package is required. Both auto and manual initialization are supported — see Client-Side Integration (React).
Android
Add the dependency to your app's build.gradle.kts:
dependencies {
implementation("ai.mubeen:deviceintel-lib:1.7.3")
}
1.7.3 was the latest release at the time of writing. Check Maven Central for the most recent version before integrating.
The library is available on Maven Central — no extra repository setup is needed. Full setup, permissions, and initialization: Android Device Intel.
iOS
The iOS SDK is distributed as a signed XCFramework via Swift Package Manager. In Xcode: File → Add Package Dependencies…, enter the package URL, and pick the current release:
https://github.com/mubeen-ai/Mubeen-IOS-SDK-public.git
Or in Package.swift:
dependencies: [
.package(url: "https://github.com/mubeen-ai/Mubeen-IOS-SDK-public.git", from: "2.0.0")
]
Configuration and usage: iOS Device Intel.
Backend
There is no server SDK to install — the backend integrates against the REST API directly with any HTTP client. Start with the Server-Side Integration guide, which includes a cURL quick test you can run before writing any code.
Next Steps
- Client-Side Integration (HTML) — drop the SDK into a web page
- Client-Side Integration (React) — integrate into a React SPA
- Server-Side Integration — send the device ID with your API requests and read the risk decision