Skip to main content
Every SDK exposes the same operations over the same data types. This page is the cross-language map; each SDK guide has the full, idiomatic signatures and examples for one platform.

Operations across SDKs

OperationSwiftC#Kotlin / JavaCTypeScript
CreateMBKYC.create(...)MBKYC.Create(...)MBKYC.create(...)mbkyc_create(...)new MBKYCClient() + init(...)
DestroydeinitDisposeclose() (AutoCloseable)mbkyc_destroydeInit()
List smart card readerslistSmartcardReadersListSmartcardReadersAsynclistSmartcardReadersmbkyc_list_smartcard_readerslistSmartcardReaders
List fingerprint readerslistFingerprintReadersListFingerprintReadersAsynclistFingerprintReadersmbkyc_list_fingerprint_readerslistFingerprintReaders
Register deviceregisterDevice(name:)RegisterDeviceAsyncregisterDevicembkyc_register_deviceregisterDevice
Check registrationcheckRegistrationCheckRegistrationAsynccheckRegistrationmbkyc_check_registrationcheckRegistration
Validatevalidate(_:)ValidateAsyncvalidatembkyc_validatevalidate
Export logsexportLogs(to:)ExportLogsAsyncexportLogsmbkyc_export_logsexportLogs
Cancel in-flight opTask cancelCancellationTokencoroutine cancelCancellationTokenHandle + mbkyc_cancel_*cancel()
Host info (web only)getInfo()

What each operation does

OperationReturnsNotes
CreatehandleValidates config and initializes the SDK. On the web, getInfo() is the only call usable before init().
List readersReaderInfo[]Enumerates connected smart card readers / fingerprint sensors.
Register devicevoidCall once per device before validating. See Devices.
Check registrationRegistrationStatusactive / inactive / not_found.
ValidateVerificationResultTakes one validation request; the shape selects the method.
Export logsvoidBundles SDK + connected-service logs into a single tar.zst archive for support.
DestroyvoidReleases resources. Always call it (or use the language’s scoped form).

Async model

PlatformModel
Swiftasync/await + callback overloads
C#Task (async/await), honours CancellationToken
Kotlinsuspend functions + coroutines
JavaCompletableFuture
Ccallback-based (on_success / on_error / on_cancelled)
TypeScriptPromises

Results & errors

  • Kotlin / Java return an MBKYCResult<T> (Ok / Err); getOrThrow() converts to exceptions.
  • Swift throws MBKYCError; C# throws MBKYCException; the web SDK rejects with MBKYCError.
  • C returns/owns an MBKYC_Error* the caller must free.
All of them carry the same error codes.

Cancellation

Every long-running operation can be cancelled:
  • Swift / Kotlin — cancel the surrounding Task / coroutine.
  • C# — pass a CancellationToken; cancelling resolves the task with TaskCanceledException.
  • C — create an MBKYC_CancellationTokenHandle, pass it to the call, and mbkyc_cancel_token_cancel(token).
  • Web — call client.cancel().