nashid_verify_sdk 1.0.2

The nashid_verify_sdk Flutter plugin provides an interface to integrate the Nashid SDK into your application for document scanning and verification purposes.

Flutter Implementation for Nashid Verification SDK (iOS & Android)

Introduction

This document serves as a comprehensive guide for Flutter developers to seamlessly integrate the VerifySDK into their applications. By following the step-by-step instructions provided, developers can simplify the process of scanning Oman ID cards and passports, and efficiently retrieve document scan results.

The VerifySDK is designed to streamline identity verification processes, ensuring a smooth integration experience across platforms.

---

Prerequisites

• Prerequisites:
  • Latest Flutter SDK.
  • Latest CocoaPods for iOS.
  • Latest Android Studio with SDK tools.
  • Xcode (16.1 or higher) for iOS development.
  • An IDE like Android Studio or VS Code with Flutter and Dart plugins.
  • Gradle 8.0 or higher
• 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

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:

   a. 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>
   

   b. In Podfile:

   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['DEBUG_INFORMATION_FORMAT'] = 'dwarf-with-dsym'
          config.build_settings['OTHER_SWIFT_FLAGS'] = '-no-verify-emitted-module-interface'
          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
          config.build_settings['ONLY_ACTIVE_ARCH'] = 'NO'
        end
      end
   end
   

   c. Enable Near Field Communication (NFC) Reading capability in your projects, as follows:

   • Open your project in Xcode.
   • Navigate to your Target settings.
   • Go to the Signing & Capabilities tab.
   • Click the + Capability button.
   • Select Near Field Communication Tag Reading from the list.

   d. Please ensure your iOS app entitlement file includes both TAG and ISO7816 formats for NFC functionality.

   • Check your ios/Runner/Runner.entitlements file for the following entry:

   <key>com.apple.developer.nfc.readersession.formats</key>
   <array>
     <string>TAG</string>
     <!-- Add this line -->
     <string>ISO7816</string> 
   </array>
   

   e. Set Privacy Usage Description for NFC, as follows:

   • In Xcode, go to the Build Settings tab.
   • Search for Privacy - NFC Scan Usage Description.
   • Double-click the field and add desired description, for example: "Needed permission to read Passport’s NFC"

   f. Add the following script in Build Phases > Run Script and ensure that this script is always the last step in the list.

   cd "${CONFIGURATION_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/Frameworks/NewVerifySDK.ramework/"
   if [[ -d "Frameworks" ]]; then
   rm -fr Frameworks
   fi
   

   g. Run:

   cd ios && pod install
   

3. For Android, Do the following:

   a. 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"
   

   b. Add the following lines to app-level build.gradle file:

   android {
     compileSdk 34
     defaultConfig {
       minSdk 21
       targetSdk 34
   }
   

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:

To start using the SDK, you need to create an SDK Application and configure the desired verification flow via your admin dashboard.

The initialize() function expects the following arguments:

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.

The initialize() function returns a value, indicating whether initialization was successful (true) or unsuccessful (false), along with an error message in case of unsuccessful initialization.

Map<String, dynamic> response = await _nashidIoPlugin.initialize(
    sdkKey: "<your-sdk-key>",
    sdkSecretKey: "<your-sdk-secret-key>",
    languageId:"en",
    extraData: {}
);

3. Verify A Document Using Nashid Verify SDK

Once Nashid Verify SDK is initialized successfully, you can start verifications journeys for your users using the verify() function.

This function expects an input argument specifying the type of document to be verified.

ID Type	Value
OMANI_ID	1
INTERNATIONAL_PASSPORT	2
EMIRATI_ID	3
SAUDI_ID	4
BAHRAINI_ID	5
QATARI_ID	6
KUWAIT_ID	7

And as a result of the verification flow it returns three values:

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.

Example1: Verify With Omani ID

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

Example2: Verify With International Passport

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

Example3: Verify With Emirati ID

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

Example4: Verify With Saudi ID

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

Example5: Verify With Bahraini ID

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

Example6: Verify With Qatari ID

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

Example7: Verify With Kuwait ID

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

4. Using Nashid Verify SDK To Get A Verification Result

Once you have a valid verification ID as an outcome of a successful verification journey you can use getVerificationResult() function to get the results collected with any additional checks/information annotated by backend services using the verification ID.

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 Response For Passports:

{
    "data": {
        "id": "abcd1234",
        "created_at": "2025-01-14T09:44:39.051016+00:00",
        "updated_at": "2025-01-14T09:45:33.344098+00:00",
        "updated_by": null,
        "data": {
            "NFC": {
                "name": "John Doe",
                "gender": "FEMALE",
                "address": "123 Elm Street",
                "nationality": "USA",
                "phone_number": "97987201",
                "document_type": "Passport",
                "name_of_holder": "John Doe",
                "place_of_birth": "City A",
                "document_number": "PL9087683",
                "issuing_country": "USA",
                "issuing_authority": "ABC",
                "document_expiry_date": "2030-03-18",
                "passport_date_of_birth": "1990-05-11"
            },
            "scan": {
                "gender": "Male",
                "country": "USA",
                "mrz_text": "MRZ123456",
                "full_name": "John Doe",
                "document_no": "DOC12345",
                "nationality": "American",
                "date_of_birth": "1990-05-15",
                "document_type": "Passport",
                "expiry_date": "2030-01-01"
            },
            "liveness": {
                "score": "99",
                "passive_liveness_confirmed": false,
                "active_liveness_confirmed": true
            }
        },
        "metadata": {
            "gender": "Female",
            "location": {
                "latitude": 37.7749,
                "longitude": -122.4194
            },
            "timestamp": "2024-58-22 08:58:52",
            "app_version": "1.0(11)",
            "device_ipv4": "0.0.0.0",
            "device_ipv6": "fe80::4cc0:34ff:fe60:cc21",
            "device_type": "SM-G996B",
            "system_name": "Android",
            "system_version": "13",
            "device_identifier": "samsung_SM-G996B"
        },
        "artifacts": {
            "nfc_face_image": "https://xxxxx.yyyyy/xxx.png",
            "ocr_face_image": "https://xxxxx.yyyyy/yyy.png",
            "back_side_image": "https://xxxxx.yyyyy/zzz.png",
            "front_side_image": "https://xxxxx.yyyyy/aaaa.png",
            "active_liveness_image": "https://xxxxx.yyyyy/xxx.png",
            "pasive_liveness_image": "https://xxxxx.yyyyy/abcd.png"
        },
        "annotations": {
            "face_matching": {
                "mode": "ocr",
                "notes": "",
                "is_successful": false,
                "nfc_matching_score": null,
            }
        },
        "type": {
            "value": 2,
            "title": "International Passport"
        },
        "status": {
            "value": 1,
            "title": "Successful"
        }
    },
    "message": "Verification retrieved successfully.",
    "consolidated_message": "Verification retrieved successfully.",
    "details": {}
}

• Example Response For ID cards:

{
  "result": true,
  "errorMessage": "",
  "scanData": {
    "message": "Verification retrieved successfully.",
    "data": {
      "id": "dummy123456",
      "annotations": {},
      "data": {
        "NFC": {
          "issue_date": "2023-01-15",
          "full_name_arabic": "محمد أحمد علي",
          "country_of_birth_english": "Sample Country",
          "full_name_english": "MOHAMMED AHMED ALI",
          "date_of_birth": "1990-05-20",
          "gender_english": "Male",
          "place_of_issue_english": "Sample City",
          "country_of_birth_arabic": "دولة عينة",
          "place_of_issue_arabic": "مدينة عينة",
          "expiry_date": "2028-01-15",
          "nationality_english": "SAMPLE",
          "identity_number": "12345678",
          "nationality_arabic": "عينة",
          "gender_arabic": "ذكر",
          "company_name_english": "",
          "permit_type": "",
          "visa_number": "",
          "company_name_arabic": "",
          "company_address_arabic": "",
          "permit_number": "",
          "use_by_date": "",
        },
        "liveness": {
          "active_liveness_confirmed": true,
          "score": 0.95,
          "passive_liveness_confirmed": true
        },
        "scan": {
          "date_of_birth": "1990-05-20",
          "expiry_date": "2028-01-15",
          "gender": "MALE",
          "country": "SMP",
          "document_type": "ID",
          "nationality": "SMP",
          "full_name": "MOHAMMED AHMED ALI",
          "mrz_text": "IDSMP12345678<<8<<<<<<<<<<<<<<<9005205M28011520SMP<<<<<<<<<<<8MOHAMMED<AHMED<ALI<<<<<<",
          "document_no": "12345678"
        }
      },
      "metadata": {
        "device_ipv6": "fe80::dummy:ipv6:address",
        "gender": "MALE",
        "timestamp": "2025-02-04 08:30:00",
        "location": {
          "longitude": 55.123456,
          "latitude": 25.654321
        },
        "system_name": "Android",
        "system_version": "12.0.1",
        "device_identifier": "Samsung Galaxy S21",
        "extra_data": {
          "email": "[e-mail]",
          "last_name": "Doe",
          "first_name": "John"
        },
        "device_type": "Smartphone",
        "device_ipv4": "192.168.1.100"
      },
      "artifacts": {
        "back_side_image": "https://xxxxx.yyyyy/back.png",
        "ocr_face_image": "https://xxxxx.yyyyy/face.png",
        "nfc_face_image": "https://xxxxx.yyyyy/nfc_face.png",
        "livness_image_without_bg": "https://xxxxx.yyyyy/liveness.png",
        "front_side_image": "https://xxxxx.yyyyy/front.png"
      },
      "type": {
        "title": "Sample ID",
        "value": 1
      },
      "status": {
        "title": "Successful",
        "value": 1
      }
    },
    "consolidated_message": "Verification retrieved successfully."
  }
}