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.

Managing and enrolling users

By integrating ZenKey with your applications, you can offer a safe and secure environment for users of your applications. However, in order for users to benefit from ZenKey's unique security features, they must first enroll by creating a ZenKey account. Since this process only takes a few minutes, below are a few tips for how to enroll and manage users in your application.

Enrolling Users

Once a customer has created a ZenKey account, he or she must now add your application as a Service in ZenKey.

Assigning and Managing User Information

With your application added as a Service in ZenKey, a user may now enroll in your application using the "Sign in with ZenKey" button. At this step, ZenKey will ask for the user's permission to allow their carrier to share certain ZenKey profile information (e.g. name, email, phone) with you. Such profile information is defined by assigning different "scopes", or user attributes, when you integrate the ZenKey SDK (see Section 3.1: Types of Scopes). However, keep in mind that despite whichever scopes you choose, all users can edit, in the ZenKey app, which scopes they wish to share prior to giving consent.

Authorization

You may ask the user for a second factor of authentication (2FA), such as a PIN or Biometric (if enabled). Once 2FA has been provided, the user may then agree, or provide consent, to share information before the ZenKey SDK provides authorization data to your app and issues the authorization request to the carrier.

Managing Tokens

With the user’s consent and an authorization code from the carrier, your server will request an access token from the carrier. This access token will return a unique identifier, scoped to the user, along with other user information. As a result, be sure that your backend is properly configured to provide access and refresh tokens.

Updated 6 months ago


What's Next

Enroll new users

Managing and enrolling users


Suggested Edits are limited on API Reference Pages

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