Docovue

Privacy-first document scanning and OCR plugin for Flutter with smart auto-capture and anti-spoofing detection. Supports 12+ document types with 100% on-device processing – no cloud, no network calls, no data leaks.

✨ Features

🎯 Smart Auto-Capture

• Automatic document detection with edge recognition
• Live bounding box with color-coded feedback (White → Orange → Green)
• Hands-free capture – detects document and captures automatically
• Front & back camera support with seamless switching

🛡️ Anti-Spoofing / Liveness Detection

• Prevents fraud – detects photos of photos, screen displays, photocopies
• Blur detection – ensures sharp, focused images
• Texture analysis – verifies physical document properties
• Reflection detection – identifies screen glare patterns

📄 Supported Documents

Document Type	Extraction	Output Fields
Indian Documents
Aadhaar Card	⭐⭐⭐⭐⭐ Full	Number, Name, DOB
PAN Card	⭐⭐⭐⭐⭐ Full	Number, Name, DOB
Voter ID	⭐⭐⭐⭐ Good	ID Number, Name, Age
Driving License	⭐⭐⭐⭐ Good	License No, Name, DOB
Global Documents
Passport	⭐⭐⭐ Generic	Number, Name, DOB
National ID	⭐⭐⭐ Generic	Top 3 fields
Financial
Credit/Debit Cards	⭐⭐⭐⭐⭐ Full	Masked Number, Expiry, Name
Invoices	⭐⭐⭐ Generic	Invoice No, Amount, Date
Receipts	⭐⭐⭐ Generic	Receipt No, Amount, Date
Healthcare
Insurance Cards	⭐⭐⭐ Generic	Policy No, Name, Validity
Lab Reports	⭐⭐⭐ Generic	Patient, Report No, Date

🔒 Privacy & Compliance

• ✅ 100% On-Device – All OCR runs locally (ML Kit on Android, Vision on iOS)
• ✅ Zero Network Calls – No data sent to cloud services
• ✅ No Data Storage – Plugin doesn't cache or persist data
• ✅ GDPR Ready – Built-in consent dialogs
• ✅ HIPAA Compatible – Suitable for healthcare apps (with proper implementation)
• ✅ PCI-DSS Friendly – Masks sensitive card data

🚀 Quick Start

Installation

Add to your pubspec.yaml:

dependencies:
  docovue: ^1.0.0

Run:

flutter pub get

Platform Setup

Android

Add to android/app/build.gradle:

android {
    compileSdkVersion 34
    
    defaultConfig {
        minSdkVersion 21  // ML Kit requires API 21+
    }
}

dependencies {
    implementation 'com.google.mlkit:text-recognition:16.0.0'
}

Add to android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" android:required="true" />

iOS

Add to ios/Runner/Info.plist:

<key>NSCameraUsageDescription</key>
<string>This app needs camera access to scan documents</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>This app needs photo library access to import documents</string>

Minimum iOS version: 11.0

📖 Usage

Basic Example – Auto-Capture Scanner

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

class DocumentScannerPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Scan Document')),
      body: DocovueScannerWidget(
        allowedTypes: const {
          DocovueDocumentType.aadhaar,
          DocovueDocumentType.pan,
          DocovueDocumentType.creditCard,
        },
        config: const DocovueScannerConfig(
          autoCapture: true,        // Enable smart auto-capture
          verifyOriginal: true,     // Enable anti-spoofing
          confidenceThreshold: 0.70,
        ),
        onResult: (result) {
          result.when(
            success: (document) {
              // Get top 3 extracted fields
              final summary = document.toSummary(maxFields: 3);
              print('Extracted: $summary');
              Navigator.pop(context, document);
            },
            unclear: (rawText, confidence) {
              print('Unclear (${(confidence * 100).toFixed(0)}%): $rawText');
            },
            error: (error) {
              print('Error: ${error.message}');
            },
          );
        },
      ),
    );
  }
}

Scan from File (Gallery/Existing Image)

import 'package:image_picker/image_picker.dart';
import 'package:docovue/docovue.dart';

Future<void> scanFromGallery() async {
  // Pick image
  final picker = ImagePicker();
  final image = await picker.pickImage(source: ImageSource.gallery);
  
  if (image == null) return;

  // Scan document
  final result = await DocovueScanner.scanDocumentFromFile(
    imagePath: image.path,
    allowedTypes: const {
      DocovueDocumentType.aadhaar,
      DocovueDocumentType.passport,
    },
    config: const DocovueScannerConfig(
      verifyOriginal: false,  // Skip liveness for gallery images
      confidenceThreshold: 0.75,
    ),
  );

  result.when(
    success: (document) {
      final fields = document.toSummary(maxFields: 3);
      print('Success: $fields');
    },
    unclear: (rawText, confidence) {
      print('Could not classify document');
    },
    error: (error) {
      print('Scan error: ${error.message}');
    },
  );
}

Configuration Options

// High-security mode (recommended for financial/ID documents)
DocovueScannerConfig.highSecurity()
// • verifyOriginal: true (anti-spoofing enabled)
// • confidenceThreshold: 0.90
// • maskSensitiveDataInLogs: true

// Healthcare mode (PHI/HIPAA)
DocovueScannerConfig.healthcare()
// • verifyOriginal: true
// • confidenceThreshold: 0.85

// Financial mode (PCI-DSS)
DocovueScannerConfig.financial()
// • verifyOriginal: true (fraud prevention)
// • confidenceThreshold: 0.95

// Development mode
DocovueScannerConfig.development()
// • verifyOriginal: false
// • debugMode: true

// Custom configuration
const DocovueScannerConfig(
  autoCapture: true,              // Smart auto-capture
  verifyOriginal: true,           // Anti-spoofing
  confidenceThreshold: 0.70,      // 70% minimum confidence
  showConsentDialog: true,        // GDPR consent
  maskSensitiveDataInLogs: true,  // Privacy protection
  debugMode: false,               // Debug logs
)

🎨 UI Components

Auto-Capture Flow

1. User opens scanner
   ├─ WHITE bounding box: "Position document"
   
2. Document detected
   ├─ ORANGE bounding box: "Hold steady... 1/4"
   ├─ Progress counter: 2/4 → 3/4 → 4/4
   
3. Document stable
   ├─ GREEN bounding box: "Capturing!"
   ├─ Auto-captures (2 seconds total)
   
4. Liveness check (if enabled)
   ├─ "Verifying authenticity..."
   ├─ ✅ Original → Continue to OCR
   ├─ ❌ Fake → "Original ID Required" error
   
5. OCR Processing
   ├─ Extracts text using ML Kit
   ├─ Classifies document type
   ├─ Extracts structured fields
   
6. Result
   ├─ SUCCESS: Returns top 3 fields
   ├─ UNCLEAR: Shows tips + raw OCR text
   └─ ERROR: Shows error message

Camera Controls

• 🔄 Camera Switch: Toggle between front/back camera
• ⚪ AUTO Indicator: Shows progress (1/4, 2/4, 3/4, 4/4)
• 💡 Flash: Toggle flash/torch (back camera only)

🔧 Advanced Usage

Extract Specific Document Fields

result.when(
  success: (document) {
    document.map(
      aadhaar: (aadhaar) {
        print('Aadhaar: ${aadhaar.maskedAadhaarNumber}');
        print('Name: ${aadhaar.name}');
        print('DOB: ${aadhaar.dateOfBirth}');
      },
      pan: (pan) {
        print('PAN: ${pan.maskedPanNumber}');
        print('Name: ${pan.name}');
      },
      card: (card) {
        print('Card: ${card.maskedCardNumber}');
        print('Expiry: ${card.expiryDate}');
        print('Holder: ${card.cardHolderName}');
      },
      passport: (passport) => handlePassport(passport),
      generic: (generic) {
        // Generic extraction for other document types
        print('Fields: ${generic.detectedFields}');
      },
    );
  },
);

Validation Utilities

import 'package:docovue/docovue.dart';

// Validate extracted data
bool isValidAadhaar = isValidAadhaar('123456789012');
bool isValidPAN = isValidPan('ABCDE1234F');
bool isValidCard = isValidCardNumber('4111111111111111');

// Mask sensitive data
String masked = maskCardNumber('4111111111111111'); 
// Output: "**** **** **** 1111"

String maskedAadhaar = maskAadhaarNumber('123456789012'); 
// Output: "XXXX-XXXX-9012"

🛡️ Security Best Practices

Data Handling

// ✅ DO: Use masked data in logs
print('Card scanned: ${document.maskedCardNumber}');

// ❌ DON'T: Log full sensitive data
print('Card: ${document.fullCardNumber}'); // Bad!

// ✅ DO: Enable data masking in production
DocovueScannerConfig(
  maskSensitiveDataInLogs: true,  // Always true in production
)

// ✅ DO: Enable anti-spoofing for ID/financial docs
DocovueScannerConfig(
  verifyOriginal: true,  // Prevents photo-of-photo attacks
)

Compliance

GDPR – Show consent dialog:

DocovueScannerConfig(
  showConsentDialog: true,
  consentDialogTitle: 'Document Processing',
  consentDialogMessage: 'We process your document locally...',
)

HIPAA – Use healthcare mode:

DocovueScannerConfig.healthcare()

PCI-DSS – Never store full card numbers:

// ✅ Store masked version only
final safeData = card.toPciCompliantJson(); // Excludes full PAN

📊 Performance

• OCR Speed: 1-3 seconds per document
• Auto-Capture: 2 seconds from detection to capture
• Memory: ~50-100 MB during processing
• Battery: Minimal impact (camera + ML Kit)

🐛 Troubleshooting

"Unclear Document" Issues

Causes:

• Poor lighting (too dark/bright)
• Document too far/close
• Blurry image (camera not focused)
• Low contrast document

Solutions:

// Lower confidence threshold
DocovueScannerConfig(
  confidenceThreshold: 0.60,  // Default: 0.70
)

// Enable debug mode to see raw OCR text
DocovueScannerConfig(
  debugMode: true,
)

Auto-Capture Not Triggering

Check:

• Lighting is adequate
• Document fills 50-70% of bounding box
• Holding device steady for 2 seconds
• autoCapture: true in config

Liveness Detection Too Strict

// Disable for testing
DocovueScannerConfig(
  verifyOriginal: false,
)

// Or use in specific scenarios only
verifyOriginal: documentType == DocovueDocumentType.creditCard,

🗺️ Roadmap

• iOS implementation (currently Android-optimized)
• Enhanced MRZ parsing for passports
• Batch document scanning
• Custom document type training
• Improved low-light performance

📄 License

MIT License - see LICENSE file for details.

🆘 Support

Contact

• Developer: Praveen
• Email: praveenvenkat042k@gmail.com
• Portfolio: praveen-dev.space
• Issues: GitHub Issues

Contributing

Contributions welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request

⚠️ Disclaimer

Docovue is not a legally certified KYC solution. OCR accuracy is best-effort. Always:

• Validate extracted data before use
• Implement proper error handling
• Follow compliance requirements for your jurisdiction
• Use human review for critical workflows