Integrating with ZenKey is Easy

Whether you need to register first or are ready to access documentation right away, you’ll find everything you need here to quickly integrate ZenKey and enhance your customer experiences.

Here’s how to get started:
register
Register your Company
Register your company, configure your services, and obtain your client credentials.
sdk
Get the SDK
Download the SDKs and sample code for your platform (Android, iOS, and Web).
integration
Integrate your App
Start creating your ZenKey solution (Android, iOS, and Web)

trust
Need additional help to prevent fraud?
Add Trust Services to your ZenKey solution.
trust
Need additional help to prevent fraud?
Add Trust Services to your ZenKey solution.

Discovery Flows

A core design feature of ZenKey is that a subscriber’s carrier will always be the sole party to authenticate and capture user consent. This means a core component to a Service Provider integrating with ZenKey is the routing of the requests to the correct carrier. ZenKey has implemented two different, but complimentary methods to enable a Service Provider to integrate and determine this discovery.

OpenID MODRNA Discovery Flows

The first method is based on OpenID MODRNA discovery flows. This method has two services from ZenKey:

  1. An API layer that, when given the correct discovery variables, will return the configuration for the correct carrier.
  2. An endpoint that is a visual experience for the user. This allows a user with the ZenKey application to setup a binding to a secondary device.

📘

Use MODRNA-Based Discovery if...

You want to use an OIDC compliant implementation. Find more information on the MODRNA-based discovery flow here.

Optimized Discovery Flow

The second method leverages a more common OpenID auth request process. In this case the Service Provider will redirect the user to ZenKey, who will then redirect the user to the correct carrier after discovery is complete. Under this model the Service Provider will still need to contact the ZenKey discovery issuer after the auth code is received so that the Service Provider can route their token and UserInfo API calls to the correct carrier endpoints.

📘

Use Optimized Discovery if...

you are looking to reuse existing OpenID connect logic and code. Find more information on the optimized discovery flow here.

Updated 3 months ago



Discovery Flows


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.