Flutter SDK

Integrate SmartComply identity verification and liveness detection into your Flutter app.

Installation

You will receive an API key and a Client ID from SmartComply. Keep these secure and do not commit them to source control.

Add the SDK to your app’s pubspec.yaml:

dependencies:
  smartcomply_sdk: ^0.1.0

Then run:

flutter pub get

---

How It Works

1. createSession()

   Authenticates your app using apiKey + clientId.

   Endpoint: POST /v1/session/create → returns a session token used by all subsequent calls.

2. onboarding.verify()

   Verifies the user’s identity against a government ID (BVN or NIN).

   Endpoint: POST /v1/onboarding/verify → returns Identity confirmed.

3. liveness.startCheck()

   Opens the camera full-screen and runs the liveness challenge:

   • Face detection runs entirely on-device via ML Kit — no live streaming to the server.
   • Autoshot captured → POST /v1/liveness/create → returns an Entry ID.
   • Video uploaded → POST /v1/liveness/submit → returns the result.

---

Platform Setup

Android

In android/app/src/main/AndroidManifest.xml, add inside <manifest>:

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

In android/app/build.gradle (or build.gradle.kts):

android {
    defaultConfig {
        minSdk 21
    }
}

iOS

In ios/Runner/Info.plist:

<key>NSCameraUsageDescription</key>
<string>Camera is required for identity verification.</string>
<key>NSMicrophoneUsageDescription</key>
<string>Microphone is required for liveness recording.</string>

---

Initialisation

import 'package:smartcomply_sdk/smartcomply_sdk.dart';

final sdk = SmartComply(
  SDKConfig(
    apiKey: 'YOUR_API_KEY',        // Bearer token from SmartComply
    clientId: 'YOUR_CLIENT_UUID',  // UUID from your SmartComply dashboard
    environment: Environment.production,
  ),
);

Parameter	Required	Description
apiKey	✅	API key issued by SmartComply. Used to authenticate session creation.
clientId	✅	UUID of your SDK config record. Ties the session to your account settings.
environment	Optional	Environment.production or Environment.sandbox. Defaults to sandbox.
timeout	Optional	HTTP timeout. Defaults to 15 seconds.

---

Step 1 — Create a Session

final session = await sdk.createSession();
print(session.token); // UUID session token

Must be called before any other SDK method. All subsequent calls automatically use the session token.

---

Step 2 — Verify Identity

// Verify BVN
final result = await sdk.onboarding.verify(
  onboardingType: OnboardingType.bvn,
  idNumber: '22476562817',
);

// Verify NIN
final result = await sdk.onboarding.verify(
  onboardingType: OnboardingType.nin,
  idNumber: '91014204738',
);

if (result.isVerified) {
  print('Verified at: ${result.verifiedAt}');
}

OnboardingType	ID
OnboardingType.bvn	Bank Verification Number
OnboardingType.nin	National Identification Number

---

Step 3 — Liveness Check

Opens the camera full-screen, guides the user through actions, captures a photo and video, and submits both to the backend:

final result = await sdk.liveness.startCheck(
  context,
  identifier: '22476562817',     // user's ID number
  identifierType: 'bvn',         // 'bvn' or 'nin'
  country: 'nigeria',
  challengeActions: [
    ChallengeAction.blink,
    ChallengeAction.turnLeft,
  ],
);

print('Status: ${result.status}');           // "success"
print('Liveness: ${result.livenessStatus}'); // "processing" → "passed" | "failed"

Supported Challenge Actions

ChallengeAction	API value sent	Detection method
ChallengeAction.blink	BLINK	ML Kit eye open probability
ChallengeAction.turnLeft	TURN_LEFT	ML Kit head euler Y angle
ChallengeAction.turnRight	TURN_RIGHT	ML Kit head euler Y angle
ChallengeAction.turnHead	TURN_HEAD	ML Kit head euler Y angle (either direction)
ChallengeAction.openMouth	OPEN_MOUTH	Heuristic (confirmed by backend video AI)

After liveness/submit, the status will be "processing" while the backend AI analyses the video. The final passed or failed status is delivered via webhook to your webhook_url.

---

Error Handling

try {
  await sdk.createSession();
} on SDKError catch (e) {
  print('Error ${e.statusCode}: ${e.message}');
}

---

Full Example

import 'package:flutter/material.dart';
import 'package:smartcomply_sdk/smartcomply_sdk.dart';

final sdk = SmartComply(
  SDKConfig(
    apiKey: 'YOUR_API_KEY',
    clientId: 'YOUR_CLIENT_UUID',
    environment: Environment.production,
  ),
);

Future<void> runVerification(BuildContext context) async {
  try {
    // 1. Session
    await sdk.createSession();

    // 2. Identity
    final identity = await sdk.onboarding.verify(
      onboardingType: OnboardingType.bvn,
      idNumber: '22476562817',
    );
    if (!identity.isVerified) return;

    // 3. Liveness
    final liveness = await sdk.liveness.startCheck(
      context,
      identifier: '22476562817',
      identifierType: 'bvn',
      country: 'nigeria',
      challengeActions: [ChallengeAction.blink, ChallengeAction.turnLeft],
    );

    print('Liveness submitted: ${liveness.status}');
    // Final result delivered via webhook
  } on SDKError catch (e) {
    debugPrint('SmartComply error: $e');
  }
}