API Reference

Overview

The Genius Scan SDK provides comprehensive APIs for document scanning, image processing, and PDF generation. The API documentation is organized by platform to provide you with the specific details for your implementation.

Native API Documentation

Core API Components

ScanFlow APIs

The main entry point for simple integration with pre-built UI:

Component	iOS	Android	Description
Configuration	GSKScanFlowConfiguration	ScanFlowConfiguration	Configure scan behavior and UI
Flow Controller	GSKScanFlow	ScanFlow	Manage the scanning session
Result	GSKScanFlowResult	ScanFlowResult	Access scanned pages and PDF

Document Processing APIs

Low-level APIs for custom integration:

Component	iOS	Android	Description
Page Detection	GSKDocumentDetector	DocumentDetector	Document boundary detection
Image Enhancement	GSKScanProcessor	ScanProcessor	Perspective and filter corrections
PDF Generation	GSKDocumentGenerator	DocumentGenerator	Create PDF from scanned pages
OCR	GSKOCR	OcrProcessor	Text recognition and searchable PDFs

Barcode APIs

For barcode and QR code scanning:

Component	iOS	Android	Description
Live Scanning	GSKBarcodeScanFlow	BarcodeScanActivity.Contract	Real-time code detection
Configuration	GSKBarcodeScanFlowConfiguration	BarcodeScanFlowConfiguration	Configure supported code types
Results	GSKBarcodeScanFlowResult	BarcodeScanFlowResult	Access detected code values

Cross-platform Package References

The cross-platform integrations expose their public APIs through their package references:

• React Native module
• Flutter plugin
• Cordova plugin
• Capacitor plugin
• .NET MAUI package

API Versioning

The SDK follows semantic versioning:

• Major version (x.0.0): Breaking API changes
• Minor version (x.y.0): New features, backward compatible
• Patch version (x.y.z): Bug fixes, backward compatible

Additional Resources

• Code Examples
• Document Scanning Quick Start
• Troubleshooting