Getting Started with Android

Yubico offers two great user experiences on Android employing a simple tap for NFC or a physical connection with USB.

Authentication via NFC is supported by the YubiKey 5 NFC.

Authentication via physical connection is supported by the NFC keys named above and all of the other YubiKeys with the USB connector (see the YubiKey support on Android article for a list of these.

Yubico Android SDK

Yubico Android SDK (YubiKit for Android) is an Android library provided by Yubico to enable interaction between YubiKeys and Android devices. The library supports NFC-enabled and USB YubiKeys.

Documentation for the SDK, such as instructions on adding it to your project and getting started, is available on GitHub.

JavaDoc API’s for the various modules can be found here.

Note

The pre-release version of the YubiKit Android SDK supported a subset of FIDO2 functionality. In this general availability (GA) version, that FIDO2 module has been removed. We recommend developers use the official FIDO2 API for Android provided by Google.

Get Started

  1. Pick up a YubiKey or a Security Key by Yubico.

  2. Use the YubiKit Demo App to learn how to integrate the YubiKit for Android with your app.

  3. Instructions for integrating and using the library are in the README file in the root folder of the yubikit-android page on GitHub.

If you run into any issues during the development process, please fill out a developer support ticket and our team will be happy to assist you.