Skip to content

Flutter

This guide provides step-by-step instructions on installing the IDV SDK into a Flutter application.

Requirements

  • Flutter >= 3.10.0 and Dart SDK >= 3.1.5 < 4.0.0
  • iOS: minimum deployment target is 13.0
  • Android: minimum API level is 21

Prerequisites

Before integrating the SDK, ensure the following:

  • Camera permission enabled
  • NFC permission enabled
  • Internet permission enabled

The Regula IDV SDK dependency should be added to pubspec.yaml.

The SDK includes multiple modules (Document Reader SDK, Face SDK). Include only the modules required for your workflow and follow their specific setup instructions.

Add Regula SDK to Your Project

1. Copy the regula.license and db.dat files to the android/app/src/main/assets/Regula/ folder.

2. Add the regula.license and db.dat files to your Xcode project at ios/Runner/.

3. Add the kotlin-kapt plugin and enable data binding feature in android/app/build.gradle:

plugins {
    id "kotlin-kapt"
}

android {
    buildFeatures {
        dataBinding true
    }
}

4. In your pubspec.yaml add the following dependencies:

  # Main dependency
  flutter_idv: 3.2.156

  # Required only if you're going to use the Document Reader SDK in your workflows
  flutter_document_reader_api: 9.1.781
  flutter_document_reader_core_fullauthrfid: 9.1.1498
  flutter_idv_module_document_reader: 3.2.93

  # Required only if you're going to use the Face SDK in your workflows
  flutter_face_api: 7.2.626
  flutter_face_core_basic: 7.2.235
  flutter_idv_module_face: 3.2.94

Run flutter pub get after adding the dependencies.