Getting Started with HYPR SDK
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.
Once you have a copy, if you want to skip all the details and get straight to building, proceed to the Quick Start.
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
-
HYPR Passwordless – For workstations; requires direct communication with a HYPR server
-
FIDO Only – Use FIDO with a HYPR server; requires direct communication with a HYPR server
The main differences between these options are the functionality provided and the required interface components.
Requirements
The following table should be verified and updated if necessary after every SDK version change; the location of each datum is in the table below. Syncing build.gradle with versions other than those listed may result in anomalies.
| Description | Requirement | Found in... |
|---|---|---|
Gradle versions | 8.5+ | Android Studio: File -> Project Structure or Ctrl+Alt+Shift+S |
Android Plugin Version | 8.1.4+ | Android Studio: File -> Project Structure or Ctrl+Alt+Shift+S |
minSdkVersion | 26 | /commonlibraries/build.gradle |
targetSdkVersion | 34 | /commonlibraries/build.gradle |
compileSdkVersion | 34 | /commonlibraries/build.gradle |
Support Library | Android X | In the project-level gradle.properties file: \nandroid.useAndroidX=true |
If you use ProGuard or DexGuard remember to add -keep class kotlin.** { *; } in your rules.
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.
-
If HYPR Adapt is enabled, extra permissions might be needed for the end user at runtime.
SDK for iOS
Available versions include:
-
HYPR SDK for iOS with Fast Identity Online (FIDO)
-
HYPR SDK for iOS XC (XC Frameworks Only)
Once you have a copy, if you want to skip all the details and get straight to building, proceed to the Quick Start.
Also check out the detailed descriptions of the HYPR Passwordless API.
Using HYPR SDK for iOS
HYPR SDK for iOS can be implemented in one of the following ways:
-
Web Authentication – Secure websites and web apps; requires direct communication with a HYPR server
-
HYPR Passwordless – For workstations; requires direct 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.
| Description | Requirement | Found in... |
|---|---|---|
| iOS Deployment Target Version | 12.4+ | |
| Supported Device(s) | iPhone 5s+ | |
| XCode Version | 10.1+ | |
| Supported Architecture(s) | x86_64 arm64 | |
| Programming Language(s) | Objective C (or) Swift | |
| Dependencies | TrustKit.framework | See the TrustKit Reference for more details. |
Permissions
HYPR SDK for iOS makes use of the following permissions:
-
Privacy – Camera: Used to scan QR codes for registration
-
Privacy – Face ID: Used for FaceID biometric authentication