flutter_checkin_sdk #

Production-ready Flutter plugin for the Checkin.com (GetID) native SDK on Android and iOS.

Features #

Clean Dart API with repository and platform interface layers
MethodChannel for commands, EventChannel for SDK callbacks
Strongly typed models, events, and exceptions
Android (Kotlin) and iOS (Swift) implementations
Example app with Riverpod state management

Supported platforms #

Platform	Minimum version	Native SDK
Android	API 21+	`ee.getid:getidlib:4.2.2`
iOS	16.0+	`GetID 4.1.3`

Installation #

Add the dependency to your pubspec.yaml:

dependencies:
  flutter_checkin_sdk: ^0.1.2 # or pub.dev latest published version

Android #

The plugin bundles the Checkin.com Android SDK dependency. Ensure your project can resolve the GetID Maven repositories (the example app adds them in android/build.gradle.kts):

maven { url = uri("https://jitpack.io") }
maven { url = uri("https://cdn.getid.cloud/sdk/android") }

`android/gradle.properties`

The GetID SDK pulls in dependencies (including bcprov-jdk18on) that can break Android builds when Jetifier is enabled. Update your host app android/gradle.properties as follows:

Property	Recommended value	Why
`android.enableJetifier`	`false`	Jetifier fails on `bcprov-jdk18on` (newer Java bytecode) from the GetID SDK. Modern AndroidX projects no longer need Jetifier.
`android.jetifier.ignorelist`	`protobuf-lite,protobuf-javalite,bcprov-jdk18on`	Safeguard if Jetifier is re-enabled: exclude BouncyCastle JARs from transformation.

Typical Flutter default:

android.enableJetifier=true
android.jetifier.ignorelist=protobuf-lite,protobuf-javalite

Recommended change when using this plugin:

android.enableJetifier=false
android.jetifier.ignorelist=protobuf-lite,protobuf-javalite,bcprov-jdk18on

Add required permissions to your app's AndroidManifest.xml:

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

If your flow uses NFC document reading, also add:

<uses-permission android:name="android.permission.NFC" />
<uses-feature android:name="android.hardware.nfc" android:required="false" />

Add the following to your app's android/app/build.gradle (or build.gradle.kts) to avoid duplicate manifest merge conflicts:

android {
    packaging {
        jniLibs {
            useLegacyPackaging = false
        }
        resources {
            excludes += ['META-INF/versions/9/OSGI-INF/MANIFEST.MF']
        }
    }
}

iOS #

The plugin depends on the Checkin.com iOS SDK via CocoaPods:

pod 'GetID', podspec: 'https://cdn.getid.cloud/sdk/ios/4.1.3/GetID.podspec'

Add the following to your app's Info.plist:

<key>NSCameraUsageDescription</key>
<string>This app uses the camera to capture identity documents and perform liveness checks.</string>
<key>UIDesignRequiresCompatibility</key>
<true/>

If your flow includes NFC, also add NFCReaderUsageDescription, enable the Near Field Communication Tag Reading capability, and configure ISO 7816 identifiers as described in the iOS SDK documentation.

Initialization #

The native SDK does not expose a separate initialize method. The plugin's initialize() call prepares the platform channel bridge and event stream.

final sdk = FlutterCheckinSdk();
await sdk.initialize();

Example usage #

import 'package:flutter_checkin_sdk/flutter_checkin_sdk.dart';

final sdk = FlutterCheckinSdk();

Future<void> runCheckinFlow() async {
  await sdk.initialize();

  sdk.events.listen((event) {
    switch (event) {
      case VerificationStarted():
        print('Flow started');
      case VerificationCompleted(:final result):
        print('Completed: ${result.applicationId}');
      case VerificationCancelled():
        print('Cancelled');
      case VerificationFailed(:final error):
        print('Failed: ${error.message}');
      default:
        break;
    }
  });

  /// apiUrl, flowName, and SDK key are provided by your Checkin.com account
  /// In production, use JWT authentication instead of the SDK key.
  /// See the "JWT authentication" section below.
  /// If you are in the sandbox environment, use the sandbox API URL and flow name.
  await sdk.startVerification(
    apiUrl: 'https://company-name.getid.ee',
    auth: CheckinAuth.sdkKey('YOUR_SDK_KEY'), // use JWT in production
    flowName: 'YOUR_FLOW_NAME',
    locale: 'en',
    metadata: const VerificationMetadata(
      externalId: 'user-123',
      labels: {'department': 'EST'},
    ),
    profileData: const {
      'first-name': 'John',
      'last-name': 'Doe',
    },
    acceptableDocuments: const AcceptableDocuments({
      'EST': [DocumentType.passport, DocumentType.idCard],
      'default': [DocumentType.passport],
    }),
  );
}

JWT authentication (production) #

Obtain a JWT from your backend using your SDK key:

curl -H "Content-Type: application/json" \
     -H "x-sdk-key: SDK_KEY" \
     -X POST API_URL/sdk/v2/token

Then pass the token:

await sdk.startVerification(
  apiUrl: apiUrl,
  auth: CheckinAuth.jwt(jwtToken),
  flowName: flowName,
);

Verification results #

The native SDK does not return verification results. Use the applicationId from [VerificationCompleted] and fetch results from your backend via the Checkin.com API.

API reference #