Flutter SDK Integration

Introduction

Prerequisites

Flutter:

• Prerequisites:
• Latest Flutter SDK.
• Latest CocoaPods for iOS.
• Latest Android Studio with SDK tools.
• Gradle 8.0 or higher
• Xcode (16.1 or higher) for iOS development.
• iOS 16.0 or higher
• An IDE like Android Studio or VS Code with Flutter and Dart plugins.

• Recommendations:
• We recommend that you run flutter doctor to verify the setup.
• We recommend that you set up a real-device for testing.
• We recommend that you run flutter pub get to fetch plugin dependencies.

Installation

Flutter:

1. Run this command:

flutter pub add nashid_verify_sdk

Note: Alternatively, you can update your pubspec.yaml manually to include the package as the following:

dependencies:
  nashid_verify_sdk: ^latest_version

2. For iOS, Do the following:
1. In iOS module’s Info.plist file:

<key>NSCameraUsageDescription</key>
 <string>We need access to the camera to scan documents</string>
 <key>NFCReaderUsageDescription</key>
 <string>NFC permission is required to complete the full KYC process.</string>
 <key>NSLocationWhenInUseUsageDescription</key>
 <string>Location permission is required to complete the full KYC process.</string>
 <key>NSLocationAlwaysUsageDescription</key>
 <string>Location permission is required to complete the full KYC process.</string>
 <key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
 <string>Location permission is required to complete the full KYC process.</string>
 <key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
 <array>
    <string>A000000018524F500101</string>
    <string>A0000002471001</string>
    <string>A0000002472001</string>
    <string>00000000000000</string>
    <string>A00000024300130000000101</string>
    <string>A0000002430013000000010109</string>
    <string>A000000243001300000001FF</string>
 </array>

2. In Podfile:

# Update iOS deployment target
platform :ios, '16.0'
 post_install do |installer|
  installer.pods_project.targets.each do |target|
   flutter_additional_ios_build_settings(target)
    # --- Add these Lines ---
   target.build_configurations.each do |config|
     config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
    end
    # -------------------------
   end

3. Enable Near Field Communication (NFC) Reading capability in your projects, as follows:
1. Open your project in Xcode.
2. Navigate to your Target settings.
3. Go to the Signing & Capabilities tab.
4. Click the + Capability button.
5. Select Near Field Communication Tag Reading from the list.
4. Add the following lines to your ios/Runner/Runner.entitlements file if your app uses both general NFC and ISO7816-based scanning:

<key>com.apple.developer.nfc.readersession.formats</key>
<array>
    <string>TAG</string>
    <!-- Add ISO7816 only if your app uses both general NFC and ISO7816-based scanning -->
    <string>ISO7816</string> 
</array>

5. Set Privacy Usage Description for NFC, as follows:
1. In Xcode, go to the Build Settings tab.
2. Search for Privacy - NFC Scan Usage Description.
3. Double-click the field and add desired description, for example: "Needed permission to read Passport’s NFC"
6. Run:

cd ios && pod install

 

3. For Android, Do the following:
1. Update AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"> <!--Add this line in manifest tag-->
<!-- Add this attribute to the <application> tag -->
tools:replace="android:name"
android:enableOnBackInvokedCallback="true"

2. Recommendation to use the following lines to app-level build.gradle file:

android {
  compileSdk 36
  defaultConfig {
     minSdk 21
     targetSdk 36
  }
}

Usage

1. Import Nashid Verify SDK:

// Import this package to access all the required functions
import 'package:nashid_verify_sdk/nashid_verify_sdk.dart';
// Create an instance to access the SDK functions
final nashidVerifySdk = NashidVerifySdk();

2. Initialize Nashid Verify SDK:

1. SDK Application Key (Mandatory): The key generated using your Nashid Verify admin dashboard.

2. SDK Application Key Secret (Mandatory): The key secret generated using your Nashid Verify admin dashboard.

3. Language Code (Optional): en for English (default), ar for Arabic ..etc.

4. Extra Data (Optional): An object of key-value pairs that you can use to annotate the verification data generated with additional data that your consumer application may need.

// Create an instance to access the SDK functions
final nashidVerifySdk = NashidVerifySdk();
Map<String, dynamic> response = await _nashidIoPlugin.initialize(
    sdkKey: "<your-sdk-key>",
    sdkSecretKey: "<your-sdk-secret-key>",
    languageId:"en",
    extraData: { // optional 
       "example-key": "example-values",
    }
);

3. Verify A Document Using Nashid Verify SDK

1. Result: A boolean flag that is true when the verification flow is successful, and false other wise.

2. Error Message: A string contains the error details in case of unsuccessful verification.

3. Verification ID: An ID of the created verification. This ID can be used later on to get the results collected with any additional checks/information annotated by backend services.

Example 1: Verify With Omani ID

Flutter:

Map<String, dynamic> response = _nashidIoPlugin.verify(ofType: NashidDocumentType.OMANI_ID);

Example 2: Verify With International Passport

Flutter:

Map<String, dynamic> response = _nashidIoPlugin.verify(ofType: NashidDocumentType.INTERNATIONAL_PASSPORT);

4. Using Nashid Verify SDK To Get A Verification Result

Example: Retrieve the data of verification ID abcd1234

 Map<String, dynamic> response = await _nashidIoPlugin.getVerificationResult(
     verificationId: "abcd1234",
);

• The verificationID (abcd1234) is just an example value that represents what we get as a result of the verify functionality.

• Example ID Card Response:

{
  "data": {
    "id": "dummy-id-12345",
    "created_at": "2025-01-01T00:00:00.000000+00:00",
    "updated_at": "2025-01-01T00:01:00.000000+00:00",
    "updated_by": null,
    "data": {
      "NFC": {
        "issue_date": "2020-01-01",
        "expiry_date": "2030-01-01",
        "date_of_birth": "1990-01-01",
        "gender_arabic": "ذكر",
        "gender_english": "Male",
        "identity_number": "12345678",
        "full_name_arabic": "اسم عربي تجريبي",
        "full_name_english": "JOHN DOE",
        "nationality_arabic": "تجريبي",
        "nationality_english": "DUMMYLAND",
        "place_of_issue_arabic": "مكان الإصدار",
        "place_of_issue_english": "Dummy City",
        "country_of_birth_arabic": "بلد الميلاد",
        "country_of_birth_english": "Dummyland"
      },
      "scan": {
        "gender": "MALE",
        "country": "DUM",
        "mrz_text": "IDDUM1234567<<0<<<<<<<<<<<<<<<9001011M3001011DUM<<<<<<<<<<<0JOHN<DOE<TEST<DUMMY",
        "full_name": "JOHN DOE TEST DUMMY",
        "document_no": "1234567",
        "expiry_date": "2030-01-01",
        "nationality": "DUM",
        "date_of_birth": "1990-01-01",
        "document_type": "ID"
      },
      "liveness": {
        "active_liveness_confirmed": true,
        "passive_liveness_confirmed": false
      }
    },
    "metadata": {
      "gender": "MALE",
      "location": {
        "latitude": 0.000000,
        "longitude": 0.000000
      },
      "timestamp": "2025-01-01 00:00:00",
      "app_version": "0.0.1 (000)",
      "device_ipv4": "0.0.0.0",
      "device_ipv6": "::1",
      "device_type": "iPhone",
      "system_name": "iOS",
      "system_version": "0.0",
      "device_identifier": "Dummy Device"
    },
    "artifacts": {
      "nfc_face_image": "https://dummy.domain.com/nfc_face_image.jpg",
      "ocr_face_image": "https://dummy.domain.com/ocr_face_image.jpg",
      "back_side_image": "https://dummy.domain.com/back_side_image.jpg",
      "front_side_image": "https://dummy.domain.com/front_side_image.jpg",
      "active_liveness_image": "https://dummy.domain.com/active_liveness_image.jpg"
    },
    "annotations": {
      "face_matching": {
        "mode": "both",
        "notes": "",
        "is_successful": true
      }
    },
    "type": {
      "value": 1,
      "title": "oman ID"
    },
    "status": {
      "value": 3,
      "title": "Verified"
    },
    "status_notes": [],
    "nfc_collected": true,
    "processing_time": "1.234 seconds"
  },
  "message": "verification retrieved successfully.",
  "consolidated_message": "verification retrieved successfully.",
  "details": {}
}

• Example Passport Response:

{
  "data": {
    "id": "dummy-id-12345",
    "created_at": "2025-08-03T12:19:20.546556+00:00",
    "updated_at": "2025-08-03T12:19:25.292090+00:00",
    "updated_by": null,
    "data": {
      "NFC": {
        "name": "JOHN DOE",
        "gender": "Male",
        "address": "123 DUMMY STREET, TEST CITY",
        "telephone": "9999999999",
        "issue_date": "2022-01-01",
        "nationality": "DUM",
        "date_of_birth": "1990-01-01",
        "document_type": "Passport",
        "place_of_birth": "TEST CITY",
        "issuing_country": "Dummyland",
        "passport_number": "DUM1234567",
        "personal_number": "123456789",
        "issuing_authority": "TEST OFFICE",
        "passport_expiry_date": "2032-01-01"
      },
      "scan": {
        "gender": "MALE",
        "country": "DUM",
        "mrz_text": "P<DUMDOE<<JOHN<<<<<<<<<<<<<<<<<<<DUM1234567DUM9001019M3201011123456789<<<<<<<<<00",
        "full_name": "DOE JOHN",
        "document_no": "DUM1234567",
        "expiry_date": "2032-01-01",
        "nationality": "DUM",
        "date_of_birth": "1990-01-01",
        "document_type": "Passport"
      },
      "liveness": {
        "active_liveness_confirmed": true,
        "passive_liveness_confirmed": false
      }
    },
    "metadata": {
      "gender": "MALE",
      "location": {
        "latitude": 0.000000,
        "longitude": 0.000000
      },
      "timestamp": "2025-08-03 12:19:19",
      "app_version": "0.0.0 (000)",
      "device_ipv4": "0.0.0.0",
      "device_ipv6": "::1",
      "device_type": "iPhone",
      "system_name": "iOS",
      "system_version": "0.0",
      "device_identifier": "Dummy Device"
    },
    "artifacts": {
      "nfc_face_image": "https://dummy.image.url/nfc_face.jpg",
      "ocr_face_image": "https://dummy.image.url/ocr_face.jpg",
      "front_side_image": "https://dummy.image.url/front_side.jpg",
      "active_liveness_image": "https://dummy.image.url/active_liveness.jpg"
    },
    "annotations": {
      "face_matching": {
        "mode": "both",
        "notes": "",
        "is_successful": true
      }
    },
    "type": {
      "value": 2,
      "title": "International Passport"
    },
    "status": {
      "value": 3,
      "title": "Verified"
    },
    "status_notes": [],
    "nfc_collected": true,
    "processing_time": 4.745
  },
  "message": "Verification retrieved successfully.",
  "consolidated_message": "Verification retrieved successfully.",
  "details": {}
}