Launch on 01/01/2027Licenses available from 01/01/2027
PreviewThis page documents the release that launches on 01/01/2027. Packages, images and sign-up open then, and details may change before it.
Docs / Your own mobile app / Kotlin SDK API reference

Kotlin SDK API reference

At launch
TL;DR

The complete, auto-generated reference for every public symbol in the Android device SDK — rendered from source with Dokka (KDoc), the Android counterpart to the Swift DocC reference. It ships with the package on Maven Central. Android follows iOS, so there is no source to render yet.

Who this is for: the Android engineer who needs the exact signature. It mirrors the Swift reference’s structure and, like it, is generated from source so it never drifts from the artifact.

▪ Preview

The Android package is published at launch. Then this becomes its full per-symbol reference — the KDoc counterpart to the Swift DocC reference, generated the same way and hosted alongside the artifact.

What will be here#

The complete public surface of the Android device SDK, mirroring the Swift symbol groups — device handle, transport, keyring, enrollment and challenge types, and one typed error surface — each rendered from its KDoc.

Generated from source#

Like the Swift reference, the KDoc is rendered straight from the source doc-comments with Dokka, so it stays in lock-step with the shipping artifact:

$ ./gradlew dokkaHtml

At release it publishes with the artifact on Maven Central and re-generates on every version.

Opens on 01/01/2027

Available at launch

Until then, you can try the whole ceremony on your own phone.