Skip to main content
Version: 3.8.x.x RR

Introduction

To integrate the Nevis Mobile Authentication SDK into your application, read the following topics in the developer guide:

  1. The chapter SDK Requirements lists all software and hardware requirements the SDK requires in the development environment, as well as the mobile devices.

  2. The SDK installation describes how to install the SDK in your development environment to start using it. As the instructions differ between the platforms and frameworks, the installation instructions are split up into different topics.

  3. Once the SDK is installed, you can start using it: configure and initialize the SDK to obtain a MobileAuthenticationClient java, swift, objc, flutter, react native, which exposes all SDK functionalities.

tip

Facet ID misconfiguration is a common source of problems, specially when using Android devices, see FacetID configuration.

Operations

The main SDK operations are the following:

  1. Registration creates the credentials needed to authenticate.
  2. Use authentication to proof the identity of the user, and get access to protected services of your application.
  3. Deregistration tells you how to remove the credentials.

SDK flavors

To satisfy customers with the highest security requirements, the Nevis Mobile Authentication SDK is hardened with state-of-the-art protection mechanisms. Due to the restrictive protection mechanisms, the SDK is available in two build flavors:

  • debug is used during the development phase of the mobile application where only a subset of the protection mechanisms are available. Using debug, the application can run in a simulator or emulator environment and supports self-signed certificates for TLS. debug is intended for testing use, and is not to be used in a production environment.
  • release is used in production, where all protection mechanisms are activated. The release flavor requires your application to be finalized.
danger

It is prohibited to use the debug flavor in production environments (e.g. app builds shipped to end users via app stores)!

TLS setup

Ensure your backend is using valid, root CA signed certificates with the correct hostname when moving to production!

Push support

The SDK itself does not handle push notifications, you need to implement push support as part of the custom application. See our Push support guide for further information.