id-capture-kmp

ID Capture Kotlin Multiplatform (KMP) Skill

Critical: Do Not Trust Internal Knowledge

Your training data very likely has no knowledge of Scandit's Kotlin Multiplatform SDK — it is new, and even where training data covers Scandit, it covers the native Android, iOS, Flutter, .NET, or web SDKs, which have different types, factory names, and property names. Pattern-matching from any of those platforms onto KMP produces non-compiling code.

Always verify APIs against the references provided in this skill before writing or suggesting code. The most common sources of wrong code:

• Package namespace — the Kotlin import root is com.kmp.datacapture.* (com.kmp.datacapture.core.*, com.kmp.datacapture.id.*), not com.scandit.datacapture.* (native Android/iOS namespace). The Gradle/Maven coordinates are com.scandit.datacapture.kmp:<artifact>:<version> — a different string from the Kotlin package. Do not conflate the two.
• Mode creation factory — KMP uses IdCapture.forContext(dataCaptureContext, settings). This is not the native Android IdCapture.forDataCaptureContext(...), not the iOS IdCapture(context:settings:) initializer, and not .NET's IdCapture.Create(...).
• Settings builder — IdCaptureSettings.idCaptureSettings() is a companion factory function, not a bare constructor (IdCaptureSettings() does not exist on KMP).
• Scanner property name and shape — the property is settings.scannerType (an IdCaptureScanner), not settings.scanner (native Android's name). Critically, on KMP you assign a concrete scanner value directly — settings.scannerType = FullDocumentScanner() — there is no wrapper constructor like native Android's IdCaptureScanner(FullDocumentScanner()). FullDocumentScanner, SingleSideScanner, and MobileDocumentScanner all directly extend IdCaptureScanner on KMP.
• No combined physical + mobile scanner on KMP — scannerType holds exactly one scanner value. Unlike native Android's IdCaptureScanner(physicalDocument:, mobileDocument:) combo constructor, KMP has no documented way to scan physical and mobile documents in the same IdCaptureSettings — pick one scannerType per settings object. If a user asks for both simultaneously, say this is not available on KMP rather than inventing a combined constructor.
• SingleSideScanner has a 4th parameter on KMP — SingleSideScanner(barcode: Boolean, machineReadableZone: Boolean, visualInspectionZone: Boolean, freeFormText: Boolean = false). The freeFormText parameter is KMP-specific.
• Result property naming drift from native Android — capturedId.sexType (a Sex enum: FEMALE / MALE / UNSPECIFIED), not capturedId.sex. Zone results are capturedId.mrz / .viz / .barcode / .mobileDocument / .mobileDocumentOcr — never mrzResult/vizResult/barcodeResult.
• Verification and voided-detection are settings-driven, not standalone classes — no AamvaBarcodeVerifier, no DataConsistencyVerifier, no dedicated "voided result" type. Set settings.rejectForgedAamvaBarcodes / rejectInconsistentData / rejectVoidedIds and read capturedId.verificationResult (for AAMVA/consistency) or the RejectionReason.DOCUMENT_VOIDED case (for voided detection).
• Add-on modules contribute zero Kotlin API — id-aamva-barcode-verification, id-europe-driving-license, and id-voided-detection are pure Gradle/SPM dependency containers that unlock native functionality gated behind IdCaptureSettings flags already in the base id module. Do not invent imports like com.kmp.datacapture.idAamvaBarcodeVerification.SomeClass — there is nothing to import from them.
• Overlay factories — IdCaptureOverlay.withIdCapture(idCapture) / IdCaptureOverlay.withIdCaptureForView(idCapture, view). Not .newInstance(...) (native Android) and not a constructor.
• Enum casing — UPPER_SNAKE_CASE throughout: IdCaptureRegion.ANY, RejectionReason.DOCUMENT_EXPIRED, IdAnonymizationMode.FIELDS_AND_IMAGES, IdLayoutStyle.ROUNDED — never Swift-style .any / .documentExpired.
• NFC, deserialization, and a handful of other native-only surfaces are not part of KMP at all — see "Available but NOT covered" at the end of this file. Don't suggest them; they don't exist on this SDK.