SwiftBindings.BlinkIDUX

SwiftBindings.BlinkIDUX

Native Swift interop bindings for BlinkIDUX, Microblink's drop-in scanning UX components for BlinkID. These are not Objective-C proxy wrappers — they use .NET 10's native Swift interop for direct, high-performance calls into Swift APIs from C#.

📖 Full usage guide → — launching the prebuilt scan UX from C#, theming it, reading scan outcomes, and the headless analyzer path when you need the extracted document fields.

Installation

dotnet add package SwiftBindings.BlinkIDUX

This package depends on SwiftBindings.BlinkID; both are required for end-to-end scanning.

Requirements

• .NET 10.0+
• iOS 16.0+ (the BlinkIDUX xcframework's own minimum; the BlinkID core is 15.0)
• macOS host for development
• A BlinkID licence key from Microblink (BlinkID is commercial)
• NSCameraUsageDescription in Info.plist

Usage

Launch the prebuilt scanning UX and present it as a UIViewController:

using BlinkIDUX;
using UIKit;

var session = await BlinkIDUXViewSession.CreateAsync(
    licenseKey: "<your-microblink-licence-key>",
    showIntroductionAlert: true,
    showHelpButton: true,
    allowHapticFeedback: true,
    preferFrontCamera: false,
    onResult: code => InvokeOnMainThread(() => HandleOutcome(code)));

if (session.ViewController is UIViewController scanner)
    PresentViewController(scanner, animated: true, completionHandler: null);

Brand it with the static theme bridge before creating the session:

using Swift;

var brand = SwiftColor.FromHex(0x1E88E5);
BlinkIDTheme.SetAlertTitleColor(brand);
BlinkIDTheme.SetAlertTitleFont(SwiftFont.System(20, SwiftFontWeight.Semibold));
BlinkIDTheme.SetHelpButtonBackgroundColor(brand);

The UX session reports an outcome code (0 completed, 1 interrupted, 2 cancelled, 3 ended) rather than the extracted document data. For the full BlinkIDScanningResult, drive BlinkIDAnalyzer yourself — see the usage guide.

Documentation

• Usage guide (wiki) — full C# walkthrough of the binding surface
• BlinkID core SDK bindings (wiki) — the sibling package this one depends on
• BlinkIDUX API reference (DocC)
• Microblink BlinkID documentation
• blinkid-ios on GitHub

How It Works

These bindings are auto-generated by Swift Dotnet Bindings using .NET 10's native Swift interop via the SwiftBindings SDK.

Building from Source

Only needed if you're contributing or building the package locally.

# One-time: install the pinned Nuke CLI from .config/dotnet-tools.json
dotnet tool restore

# Build the package end-to-end (xcframework + bindings + dotnet build)
dotnet nuke BuildLibrary --library BlinkIDUX

License

The bindings are MIT licensed. The BlinkID and BlinkIDUX SDKs are licensed by Microblink — refer to Microblink's licensing terms.