Skip to content

API mapping reference

Target MiSnap version: 5.12.0 - IDLive Face Plus: 2.6.0

This reference is for integrators moving from the IDLive Face Plus 2.6.0 iOS capture stack (IDLiveFaceCamera, IDLiveFaceDetection, IDLiveFaceIAD) to MiSnap 5.12.0 (MiSnapFacialCapture + MiSnapFacialCaptureUX + MiSnapIAD).

Mappings should apply to other IDLive 2.x releases; re-verify if your version differs. Step-by-step migration with code examples: Migration guide.


Breaking changes

Review these differences before you start the migration:

Area IDLive Face Plus MiSnap
Payload size default .normal when payloadSize is omitted .small — set aiBasedRtsPayloadSize explicitly if you relied on IDLive defaults
auto_and_manual mode Auto fire and manual shutter in the same session No direct equivalent — see Migrating auto_and_manual
IAD bundle result type Data from createIADBundle() Base64 String in result.aiBasedRts — decode before upload
Encryption key format DER Data passed to createIADBundle(key:) Base64 DER string in aiBasedRtsEncryptionKey
License IDLive license key - (License.setLicense) Different MiSnap license key from Mitek - (MiSnapLicenseManager.shared.setLicenseKey)
General capture errors cameraController(_:didEncounterError:) No direct UX equivalent — IQA hints are on-screen; license failures use miSnapFacialCaptureLicenseStatus(_:)

Dependency swap

IDLive Face Plus MiSnap
IDLiveFaceCamera.xcframework MiSnapFacialCapture + MiSnapFacialCaptureUX
IDLiveFaceDetection.xcframework Built into MiSnapFacialCapture IQA
IDLiveFaceIAD.xcframework MiSnapIAD
— MiSnapCore (required)
— MiSnapAssetManager (required with UX)

See Migration guide — Step 1 for installation methods (SPM, manual). License setup: Migration guide — Step 2.


Customization mapping

A. IAD bundle

IDLive Face Plus MiSnap 5.12.0 Notes
prepareForIAD() + createIADBundle() parameters.aiBasedRtsEnabled = true + MiSnapIAD Bundle created on successful capture
Default payload (no arg) aiBasedRtsPayloadSize IDLive Face Plus defaults to .normal; MiSnap defaults to .small — set aiBasedRtsPayloadSize explicitly if you relied on IDLive Face Plus defaults
payloadSize: .small aiBasedRtsPayloadSize = .small MiSnap default
payloadSize: .normal aiBasedRtsPayloadSize = .normal IDLive Face Plus default when omitted
createIADBundle(key:) (DER Data) aiBasedRtsEncryptionKey (base64 DER string) Required for server acceptance — must match server payload encryption. If omitted in MiSnap, SDK uses a built-in default
createIADBundle(key:keyId:) aiBasedRtsKeyId
createIADBundle(..., externalMeta:) aiBasedRtsExternalMeta
createIADBundle() → Data result.aiBasedRts (base64 String) Same bundle bytes, different result type

Before:

vc.prepareForIAD()
// ...
let bundle = try controller.createIADBundle()  // default payloadSize is .normal in IDLive

After:

let configuration = MiSnapFacialCaptureConfiguration()
    .withCustomParameters { parameters in
        parameters.aiBasedRtsEnabled = true
        // MiSnap default is .small; set .normal if you relied on IDLive Face Plus default:
        // parameters.aiBasedRtsPayloadSize = .normal
        // parameters.aiBasedRtsEncryptionKey = "<base64-DER-key>"  // must match server
        // parameters.aiBasedRtsKeyId = "my-key-id"                 // optional
        // parameters.aiBasedRtsExternalMeta = "session-id"         // optional
    }

MiSnap defaults to .small. IDLive Face Plus defaults to .normal when payloadSize is omitted — set aiBasedRtsPayloadSize explicitly if you need the same bundle size.

Align encryption keys with your IAD Server configuration.


B. Capture and quality

IDLive Face Plus MiSnap Notes
IDCameraController UI MiSnapFacialCaptureViewController + UX Or custom UI on MiSnapFacialCaptureAnalyzer
Custom embedded preview Custom VC + analyzer No drop-in replacement
Auto / manual capture parameters.mode = .auto / .manual Pick one at configuration time — no combined mode
IDLive Face Plus auto_and_manual No direct equivalent See Migrating auto_and_manual below
Front camera (IAD) parameters.camera.position = .front Forced front when aiBasedRtsEnabled
debugMode uxParameters.showLandmarks + parameters.logging Partial — landmarks overlay and MIBI logging; no full IDLive Face Plus debugMode parity
1080p with IAD Automatic when aiBasedRtsEnabled
allowToPreviewBeforeSending uxParameters.showReviewScreen,reviewMode Preview before send feature

Capture mode — before / after:

// Before
vc.captureMode = .auto
vc.prepareForIAD()

// After
let configuration = MiSnapFacialCaptureConfiguration()
    .withCustomParameters { parameters in
        parameters.mode = .auto
        parameters.aiBasedRtsEnabled = true
    }

Migrating auto_and_manual

IDLive Face Plus: auto fire and manual shutter active in the same session (PhotoCaptureMode.auto_and_manual). MiSnap: parameters.mode is .auto or .manual only.

IDLive Face Plus use case MiSnap
Auto-first IAD flow (PhotoCaptureMode.auto) parameters.mode = .auto
Auto + manual fallback (PhotoCaptureMode.auto_and_manual) parameters.mode = .auto, uxParameters.seamlessFailover = true
Manual + live IQA hints (PhotoCaptureMode.manual) parameters.enhancedManualEnabled = true + license with Enhanced Manual
Concurrent auto + shutter Custom UI on MiSnapFacialCaptureAnalyzer

parameters.enhancedManualEnabled = true (default: false) and a license key that includes Enhanced Manual. Request a key from Mitek, then:

MiSnapLicenseManager.shared.setLicenseKey(licenseKey)
// optional check:
MiSnapLicenseManager.shared.featureSupported(.enhancedManual)  // true if licensed

let configuration = MiSnapFacialCaptureConfiguration()
    .withCustomParameters { parameters in
        parameters.enhancedManualEnabled = true
    }

You do not need to set parameters.mode = .manual upfront. In the default auto-first flow, if the user picks Manual on the timeout screen after a failed auto session, the SDK switches to manual mode internally and shows hints when Enhanced Manual is enabled. Set parameters.mode = .manual only when the session should start in manual mode.

Advanced IDLive Face Plus settings

For integrators who tuned IDLive Face Plus beyond the defaults. Most have no drop-in MiSnap equivalent.

IDLive Face Plus MiSnap Notes
faceDetectorSettings.useEngines(...) Built-in IQA No nativeVision / faceDetectionSdk / motionDetector selection
useOvalMask(_:) .withCustomGuide MiSnap UX uses an oval guide by default; .withCustomGuide customizes vignette/outline styling — not a 1:1 API swap
// MiSnap guide styling (replaces IDLive Face Plus `useOvalMask` tuning, approximately)
let configuration = MiSnapFacialCaptureConfiguration()
    .withCustomGuide { guide in
        guide.vignette.style = .blur
        guide.outline.alpha = 0.9
    }

C. UX (MiSnapFacialCaptureUX)

IDLive Face Plus MiSnap
Instruction / help screens UX tutorials; disable or replace via delegate
Localization MiSnapFacialCaptureLocalizable.strings
Review screen uxParameters.showReviewScreen, reviewMode — not capture mode
Timeout uxParameters.timeout
Oval / guide styling useOvalMask → .withCustomGuide — see Advanced IDLive Face Plus settings

Localization. All on-screen text comes from MiSnapFacialCaptureLocalizable.strings (keys prefixed misnap_facial_capture_, e.g. misnap_facial_capture_status_not_centered, misnap_facial_capture_ux_tutorial_button_cancel). Edit values per language in your .lproj folders. To use a different bundle or file name:

let configuration = MiSnapFacialCaptureConfiguration()
    .withCustomLocalization { localization in
        localization.bundle = .main           // bundle containing the strings file
        localization.stringsName = "MiSnapFacialCaptureLocalizable"  // override if renamed
    }

Server (unchanged)

Item Detail
Endpoint POST /check_capture_liveness
Body Raw bundle bytes (same as Data from createIADBundle())
Response capture_liveness.probability

IDLive Face Plus examples POST raw Data from createIADBundle() with Content-Type: application/octet-stream. MiSnap returns the same bundle bytes as a base64 String in result.aiBasedRts — decode to Data before upload. The server contract does not change.

Confirm client/server compatibility before production. Upload details and ATS notes for local testing: Migration guide — Step 5.


Delegate mapping

Replace IDCameraControllerDelegate with MiSnapFacialCaptureViewControllerDelegate.

Required callbacks

Callback When it fires Your action
miSnapFacialCaptureSuccess(_:) Capture succeeds — auto mode passes IQA, or user taps shutter in manual mode (or confirms review screen if enabled) Extract IAD bundle from result, continue your flow. The SDK dismisses the capture UI only when uxParameters.autoDismiss = true (default).
miSnapFacialCaptureCancelled(_:) User cancels the session Handle cancellation. Same autoDismiss behavior as success.
miSnapFacialCaptureLicenseStatus(_:) License is not .valid Show an error and stop — session cannot continue. Same autoDismiss behavior as success. Not a general error callback.

IDLive ↔ MiSnap

IDLive Face Plus (IDCameraControllerDelegate) MiSnap (MiSnapFacialCaptureViewControllerDelegate)
cameraController(_:didCaptureImage:) miSnapFacialCaptureSuccess(_:) — SDK dismisses only when uxParameters.autoDismiss = true (default)
cameraControllerUserDidPressResultButton miSnapFacialCaptureShouldBeDismissed() — when uxParameters.autoDismiss = false
cameraController(_:didEncounterError:) No direct equivalent in UX mode — IQA hints are on-screen; license failures use miSnapFacialCaptureLicenseStatus(_:)
(user dismisses capture screen) miSnapFacialCaptureCancelled(_:) — same autoDismiss behavior as success

When uxParameters.autoDismiss = false, it is the integrator's responsibility to dismiss the capture view controller. The SDK calls miSnapFacialCaptureShouldBeDismissed() instead of dismissing itself — see the MiSnap Facial Capture API reference.

Optional callbacks

Callback When it fires
miSnapFacialCaptureShouldBeDismissed() Session finished and uxParameters.autoDismiss = false — you must dismiss the capture VC
miSnapFacialCaptureHelpAction() User taps Help and showHelpScreen = false
miSnapFacialCaptureTimeoutAction() Session times out and showTimeoutScreen = false

miSnapFacialCaptureLicenseStatus(_:) is sent only when the license is not .valid. The SDK ends the session automatically — handle it as a fatal license error, not a log-and-continue callback. It does not replace IDLive Face Plus's cameraController(_:didEncounterError:). For custom UI without MiSnapFacialCaptureUX, use miSnapFacialCaptureAnalyzerError(_:) on MiSnapFacialCaptureAnalyzerDelegate.

IQA guidance during capture (face not centered, too dark, etc.) is shown on-screen by the UX — it does not arrive through these delegate methods.


References