SDKs: Android, iOS, React Native, Flutter and web

What the SDK reads

Once started, the SDK reads the session for you. Your app passes its own identifiers and the event’s details, never the signals. What the server decides is read against everything the session has bound and read before.

The verification modules, eKYC, document verification, liveness and face match, video KYC, KYB, AML screening and bank account verification, run at sign-up and wherever your journey calls for them again, through the same SDK. See the platform overview.

Android

Kotlin. Install the package, start the SDK once, then call decide at each moment. The first call here is the login.

dependencies {
  implementation(
    "com.deepidsdk:deepid-android:<version>"
  )
}

// Application.onCreate: once, before the first screen
DeepID.start(this, key = BuildConfig.DEEPID_SANDBOX_KEY)

val decision = DeepID.decide(
  Event.LoginAttempt(customer = user.id)
)

when (decision.action) {
  Action.ALLOW -> signIn()
  else -> show(decision.message)
}

iOS

Swift. Install the package, start the SDK once, then call decide at each moment. The first call here is the login.

dependencies: [
  .package(
    url: "<package-url>",
    from: "<version>"
  )
]

// App init: once, before the first screen
DeepID.start(key: Config.deepidSandboxKey)

let decision = try await DeepID.decide(
  .loginAttempt(customer: user.id)
)

switch decision.action {
case .allow: signIn()
default: show(decision.message)
}

React Native

TypeScript. Install the package, start the SDK once, then call decide at each moment. The first call here is the login.

npm install @deepid/react-native

import { DeepID } from "@deepid/react-native"

// Once, before the first screen
DeepID.start({ key: DEEPID_SANDBOX_KEY })

const decision = await DeepID.decide(
  "login.attempt",
  { customer: user.id },
)

if (decision.action === "allow") signIn()
else show(decision.message)

Flutter

Dart. Install the package, start the SDK once, then call decide at each moment. The first call here is the login.

flutter pub add deepid_flutter

import 'package:deepid_flutter/deepid.dart';

// Once, before the first screen
await DeepID.start(key: deepidSandboxKey);

final decision = await DeepID.decide(
  LoginAttempt(customer: user.id),
);

if (decision.action == DecisionAction.allow) {
  signIn();
} else {
  show(decision.message);
}

Web

TypeScript. Install the package, start the SDK once, then call decide at each moment. The first call here is the login.

npm install @deepid/web

import { createDeepID } from "@deepid/web"

// Once, as the page loads
const deepid = createDeepID({ key: DEEPID_SANDBOX_KEY })

const decision = await deepid.decide(
  "login.attempt",
  { customer: user.id },
)

if (decision.action === "allow") signIn()
else show(decision.message)

What each route asks for

The SDK asks the customer for a permission only at the moment the route that needs it runs, and never for a route your policy does not use. The routes are the network check, the SIM check, Aadhaar consent and a one-time code, in that order, with the first that verifies ending it; a face check runs where the policy steps up.

Packages and versions

The <version> and <package-url> placeholders are filled in with your sandbox access, together with the minimum Android and iOS versions each SDK supports.

What the SDK adds to your app’s size and start-up, and how long a decision takes inside your journey, are measured in the sandbox on your own app and traffic. No figure for either is published on this site.