Getting Started

HYPR SDK for Android

HYPR SDK for Android offers a generous suite of development options, granting the protection of HYPR True Passwordless authentication while allowing you to customize it to suit your needs. Get your own copy of the HYPR SDK for Android by contacting HYPR Support. Available versions include:

  • HYPR SDK for Android (Base version)
  • HYPR SDK for Android with Fast Identity Online (FIDO)

Once you have a copy, if you want to skip all the details and get straight to building, proceed to the Quick Start. A more thorough list of related articles can be found in the HYPR SDK for Android Overview.

Also check out the detailed descriptions of the HYPR Passwordless API.

Using HYPR SDK for Android

HYPR SDK for Android can be implemented in one of the following ways:

  • Web Authentication – Secure websites and web apps; requires direct communication with a HYPR server
  • Workforce Access – For workstations; requires direct communication with a HYPR server
  • FIDO Only – Use FIDO with a HYPR server; requires direct communication with a HYPR server
  • HYPR FIDO Client Adapter – deliver only the FIDO payload; requires NO communication with a HYPR server

The main differences between these options are the functionality provided and the required interface components.

Requirements

Verify the values shown here before continuing.

DescriptionRequirementFound in...
Gradle versions5.1.1+Android Studio: File -> Project Structure or Ctrl+Alt+Shift+S
Android Plugin Version3.4.2+Android Studio: File -> Project Structure or Ctrl+Alt+Shift+S
minSdkVersion23/commonlibraries/build.gradle
targetSdkVersion31/commonlibraries/build.gradle
compileSdkVersion31/commonlibraries/build.gradle
Support LibraryAndroid XIn the project-level gradle.properties file:
android.useAndroidX=true

If you use ProGuard or DexGuard remember to add -keep class kotlin.** { *; } in your rules.

❗️

VERSION COMPATIBILITY

If the Requirements cited above are used with different versions, you may experience unpredictable behavior, i.e., minSupportedVersion might be raised; crashes could happen; etc.

Permissions

HYPR SDK for Android requires Camera permissions to scan the QR Code.