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.

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:

📘

Supported Version

Please use HYPR SDK for Android 6.0.0+ to access all features described in this document.

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

Permissions

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

Customer Authentication

This implementation involves using HYPR SDK for Android to authenticate into a website. This is a full HYPR implementation for direct communication with a HYPR RP Server / HYPR FIDO Server.

InterfaceHyprApiActionAdapter
HyprDbAdapter
Related ComponentsUIAdapter
User Agent
FIDO Client
Authenticator-specific Modules (ASMs)
Authenticators
FunctionalityOut-of-band (OOB) Registration
Website Authentication
FIDO Operations

📘

Learn More

To learn more about OOB Consumer Access and how to integrate it into your app, go to the Web Authentication page.

Workforce Access

This implementation involves using HYPR SDK for Android to authenticate into a workstation. This is a full HYPR implementation for direct communication with a HYPR RP Server / HYPR FIDO Server.

InterfaceHyprInit
HyprApiActionAdapter
HyprDbAdapter
Related ComponentsUIAdapter
User Agent
FIDO Client
ASMs
Authenticators
FunctionalityOOB Registration
Website Authentication
FIDO Operations

📘

Learn More

To learn more about OOB Consumer Access and how to integrate it into your app, go to the Web Authentication page.

FIDO Only

This implementation involves using HYPR SDK for Android to authenticate into an application and does not use any out-of-band authentication. It establishes direct communication with a HYPR RP Server / HYPR FIDO Server.

InterfaceHyprInit
HyprApiActionAdapter
HyprDbAdapter
Related ComponentsUIAdapter
User Agent
FIDO Client
ASMs
Authenticators
FunctionalityFIDO Operations

📘

Learn More about FCA

To learn more about the FIDO Client Adapter and how to integrate it into your app, go to the FIDO Only and FIDO Client Adapter page.

FIDO Client Adapter

This implementation involves using HYPR SDK for Android to authenticate into an Android application. It is a wrapper around the FIDO Client that replaces the User Agent. It is used for implementations where the customer only wants HYPR to generate the raw FIDO Payload. They will then take that raw FIDO payload and manage the server communication themselves. In this implementation there is no direct communication with a HYPR RP Server / HYPR FIDO Server.

InterfaceHyprInit
FIDO Client Adapter
Related ComponentsFIDO Client Adapter
FIDO Client
ASMs
Authenticators
FunctionalityFIDO Operations

📘

Learn More about FCA

To learn more about the FIDO Client Adapter and how to integrate it into your app, go to the FIDO Only and FIDO Client Adapter page.