Documentation

Ship scanning
with confidence.

A practical guide to installing, configuring and presenting ScannerKitSDK in your iOS app.

01 / Setup

Getting started

Add the private package to your app, then configure it before presenting the scanner.

import ScannerKit

let licenseURL = URL(string: "https://scannerkit-licenses.ashokdy.workers.dev/v1/licenses/validate")!
let validator = ScannerKitRemoteLicenseValidator(endpoint: licenseURL)

try ScannerKit.configure(.init(licenseKey: "YOUR_LICENSE_KEY", productIdentifier: "com.byvyomi.scannerkit"))
try await ScannerKit.activate(using: validator)

validator is the SDK's remote license validator. It sends the configured key to your ScannerKit licensing endpoint and returns the active entitlements. Start with a trial key from the homepage. Keep production keys in secure app configuration.

02 / Coverage

Identity documents

Capture identity-card fronts and backs and receive normalized fields through the result model.

03 / Coverage

Passport & MRZ

Passport capture includes MRZ detection and parsing with a predictable structured result.

04 / Coverage

Cheques & financial documents

Cheque capture and parsing cover MICR, amount words and structured cheque fields.

05 / Commercial

Licensing

Trial licenses run for seven days and are bound to your bundle identifier. Production licenses can expire or be revoked independently of your app release.