repository·master·Indexed 19 days ago
https://github.com/microblink/blinkid-iosAn iOS SDK for high-performance document scanning and data extraction, including MRZ, barcodes, and visual field inspection. The SDK consists of the core BlinkID framework for scanning and analysis, and an optional BlinkIDUX package providing a ready-to-use SwiftUI user interface. It supports modern iOS development using Swift 6 and concurrency features, requiring iOS 15.0+ for the core SDK and iOS 16.0+ for the UX package.
The BlinkID SDK is a solution for secure document scanning on iOS, capable of capturing and analyzing various identification documents. It consists of two main parts:
Supported documents and result fields are documented in the Microblink documentation.
The BlinkID SDK is lightweight with a compressed download size of approximately 2.4 MB. When installed on a device, the uncompressed size is approximately 5.5 MB.
Size measurements are based on Xcode App Size Reports. You can view the detailed size reports in the repository's size-report directory.
ProcessingStatus called AwaitingOtherSide. This status is triggered once the SDK has successfully processed the first side of a document and is waiting for the user to provide the other side.Starting from version 2.5.1, the SDK uses strict nullability annotations for all result class getters.
nil, it means no data exists for that specific field on the scanned document.@""), it means the field exists on the document but is empty.Redaction allows you to anonymize sensitive data before the scanning result is finalized. You can apply redaction globally via RedactionSettings or dynamically per document using a RedactionSettingsResolver.
// Example of static RedactionSettings
let redaction = RedactionSettings(
mode: .fullResult,
fields: [.additionalAddressInformation, .additionalPersonalIdNumber],
documentNumberRedactionSettings: DocumentNumberRedactionSettings(
prefixDigitsVisible: 0,
suffixDigitsVisible: 4
),
redactMrz: true,
redactBarcode: false
)The ProcessResult structure encapsulates the complete results of a scanning process, including frame analysis and completeness information.
Provides detailed analysis of a single frame:
processingStatus: Overall status for the frame.documentDetectionStatus: Status of document detection (e.g., .success, .cameraTooFar, .documentPartiallyVisible).documentLocation: A Quadrilateral representing the document's position in the image.documentClassInfo: Details about the detected document (country, region, type).Retrieved via session.getScanningStatus(), this tracks the lifecycle of the scanning operation:
.scanningSideInProgress: A document side is being scanned..scanningBarcodeInProgress: The barcode is being scanned..sideScanned: A side has been completed..documentScanned: The entire document is complete..cancelled: The process was cancelled.Tracks which components have been successfully extracted:
viz: Completeness of VIZ extraction.mrz: Completeness of MRZ extraction.barcode: Completeness of barcode extraction.faceImage, signatureImage, barcodeImage, documentImages: Completeness of various image extractions.BlinkIDUX package, you can customize the appearance of the prebuilt UI components using the UXThemeProtocol. This allows you to modify typography, colors, and strings to match your application's branding.AdditionalProcessingInfo field was updated to provide specific details about why a scan failed in cases where the result is empty. This can be used to debug or provide user feedback when document recognition does not succeed.The GlareDetector is available in version 2.12.0 and is used by default in all recognizers whose settings implement GlareDetectorOptions. When glare is detected, the SDK will not perform OCR on the affected document position to prevent data errors.
detectGlare property to false on the recognizer settings.MetadataSettings.In version 5.6.0, the result structure for MBBlinkIdRecognizer and MBBlinkIdCombinedRecognizer was reorganized for better data access:
MBBarcodeResult: Barcode data is now encapsulated in its own structure.MBVizResult: Data from all OCR-ed fields (excluding MRZ) is encapsulated in a 'Visual Inspection Zone' structure.MBBlinkIdCombinedRecognizer, you can access front-side data via frontVizResult and back-side data via backVizResult separately.Data Priority Logic: The main result object is populated using the following hierarchy:
A BlinkIDSession manages the lifecycle of a document scanning workflow, including image processing, analysis, and result generation.
Important Integration Notes:
process and getResult) must be called within the @ProcessingActor context to ensure thread safety.Sendable and uses actor isolation for concurrent environments.cancelActiveProcessing() at any time to terminate ongoing operations./// Processes a camera frame for document analysis.
/// - Parameter image: The camera frame to analyze
public func analyze(image: CameraFrame) async {
guard !paused else {
return
}
let inputImage = InputImage(cameraFrame: image)
let result = await BlinkIDSession.process(inputImage: inputImage)
if result.processResult?.inputImageAnalysisResult.processingStatus == .success {
Task { @ProcessingActor in
let sessionResult = session.getResult()
// Finish scanning
}
}
}Choose the appropriate method for clearing caches based on the current state of the SDK:
| Feature | deleteCachedResources(...) |
|---|---|
| Terminates the SDK | No (deletes files only) |
| Requires active instance | No (static utility) |
| Folder location | From parameters (must match config) |
| Actor requirement | None |
| Risk of wrong folder | Possible if names mismatch |
| Feature | terminateBlinkIDSdkAndDeleteCachedResources() |
|---|---|
| Terminates the SDK | Yes |
| Requires active instance | Yes (no-op if no instance exists) |
| Folder location | From the live instance's actual paths |
| Actor requirement | Must be in ProcessingActor |
| Risk of wrong folder | None |
Summary Recommendation:
terminateBlinkIDSdkAndDeleteCachedResources().deleteCachedResources(...) with your configured folder names.