MobileID SDK

About MobileID SDK

Key features

  • Supports both PIN and fingerprint (Touch ID, Android fingerprint, Samsung fingerprint)
  • Relies on Encap for app security (supports both Android and iOS). Encap is a well established and trusted provider of mobile security solutions.
  • Part of SignicatID. Combine MobileID with other factors as you like.
  • Signing of documents with MobileID is available through Signicat’s signing functionality.

Encap Client API

To get access to Encap Client API artifacts and documentation, please contact support@signicat.com.

Encap Client API versjon
Status
Termination date
3.3.X Recommended
3.1.X Supported November 1st, 2017

Before this date, you must have updated your apps and published them to all your users. We do not give any guarantees for apps using Encap Client API versions for which we have terminated support. Using an unsupported version might render users unable to register and authenticate.

You must not use a newer version of Encap Client API than the one recommended. Using an unsupported version might render users unable to register and authenticate.

Use cases

MobileID is a flexible solution which supports different use cases.

Registration

In order to pair the app and an identity, you need to go through a registration process before you can use the app for authentication. The registration process can either be performed in a browser, or you can integrate it into your app.

Browser-based registration

Do you want to provide a way for your users to connect a device to their account from within your existing web page? Then browser-based registration is what you need.

You need to create an app which handles the Encap-specific part of the registration, but the app implementation will be a bit less involved than for in-app registration.

Learn more about MobileID SDK browser-based registration.

Example flow

Integrated in-app registration

Want your users to do everything in the app? Use in-app registration, where you identify the user before registering PIN/fingerprint.

Learn more about MobileID SDK in-app registration.
Example flow

Authentication

Use your app as a factor in your browser-based authentication flow.

Learn more about MobileID SDK browser-based authentication.

Example flow

In-app authentication

Provide authentication to a new or existing business app. The app can also act as an authenticator (as described above).

Learn more about MobileID SDK in-app authentication.

Example flow

App development

To start developing an app which can be used in Signicat’s MobileID solution, you need to use the Encap Client API.

Depending on what kind of use case you want to support, the implementation will differ.

Example code

Two example applications are available on GitHub:

 

Note: The example applications are only meant to serve as examples, and are not meant for production. Signicat does not take any responsibility for apps created by customers of Signicat, including those based on code from the example apps.

Configuration

Please note that not all the configuration items below are mandatory

Configuration needed in-app

The following configuration will be provided to you by Signicat as part of the establishment process.

Configuration
Format
Description
Mandatory
Encap server URL URL URL to the Encap Server. Configured in Encap Client API in the app. Yes
End-to-end encryption key base64 encoded string Public key for end-to-end encryption. Configured in Encap Client API in the app. Yes
Application ID string Customer’s service name and SignicatID domain separated by an underscore (<servicename>_<domain>). Configured in Encap Client API in the app. Yes
In-app registration URL URL URL for starting the registration process. Load this URL in a web view in your app together with the appropriate prefilled parameters. Only for in-app registration

Configuration needed by Signicat

The following configuration will need to be sent to Signicat as part of the establishment process.

Configuration
Format
Description
Mandatory
GCM API key string For Android push. Google Cloud Messaging (GCM) or Firebase Cloud Messaging (FCM) API server key. To find an existing API key or create a new one, go to https://console.developers.google.com and select “Credentials” from the left side menu. Only for push support
APNS keystore p12 keystore For iOS push notifications. Keystore containing the client SSL key used for sending push notifications. Only for push support
Password for APNS keystore and key password The password needed to use the key in the APNS keystore. The password for the keystore and key must be identical. Only for push support

Support

If you have any further questions, please contact us at support@signicat.com.