Jump to Content
Documentation, APIs & Portal | ZenKey DeveloperHomeDocsPlaygroundSupport
HomeDocs
HomeDocsPlaygroundSupportZenKey HomeGet ZenKey AppSign InRegister NowDocumentation, APIs & Portal | ZenKey Developer
ZenKey HomeGet ZenKey AppSign InRegister Now
HomeDocs

Introduction

  • Welcome
  • What is ZenKey?
    • Overview
    • Using OpenID Connect
    • Enabling Primary Devices
    • Enabling Secondary Devices
    • Shared User Data
  • Quickstart Videos

For Android Developers

  • Android Quickstart
    • Developer Portal Enrollment
    • Including ZenKey SDK for Android
    • Configuring Client ID for Android
    • Adding ZenKey Button to Android
    • Receiving Authorization for Android
    • Configuring Your Client Server
    • Obtaining Carrier Endpoints for Users
  • Android Integration Guide
    • Developer Portal Enrollment
    • Project Setup on Android
    • Adding the SDK to a project on Android
    • Enabling Internet Access on Android
    • Configuring Client ID on Android
    • Creating UI for Authorization Requests on Android
    • Adding ZenKey Button on Android
    • Setting Scopes for User Info on Android
    • Custom Request Code on Android
    • Displaying Webview for User Login on Android
    • Receiving Authorization Request Response on Android
    • Handling Authorization Responses on Android
    • Creating Custom Redirect URI for Android
    • Overriding Default Redirect URI for Android
    • Custom Redirect URI for ZenKey Button on Android
    • Custom Redirect URI for IdentityProvider on Android
    • Setting HTTP or HTTPS Redirect URI for Android
    • Setting Redirect URI for IdentityProvider on Android
    • Troubleshooting Authorization Errors on Android
    • Enabling Debug Logging on Android
    • Configuring Access Token Requests for Android
    • Access Token Response
    • Decoding the ID Token
    • Requesting User Information

For iOS Developers

  • iOS Quickstart
    • Developer Portal Enrollment
    • Including ZenKey SDK for iOS
    • Configuring Client ID for iOS
    • Adding ZenKey Button to iOS
    • Receiving Authorization Response in iOS
    • Configuring Your Client Server
    • Obtaining Carrier Endpoints for Users
  • iOS Integration Guide
    • Developer Portal Enrollment
    • Setting Up Your iOS Project
    • Configuring Client ID and Creating Redirect URI on iOS
    • Instantiating ZenKey in AppDelegate on iOS
    • Creating UI for Authorization Requests on iOS
    • Adding the ZenKey Button on iOS
    • Receiving Authorization Request Responses on iOS
    • Setting Scopes for User Information on iOS
    • Performing Manual Authorization Requests
    • Troubleshooting Authorization Errors on iOS
    • Enabling Debug Logging on iOS
    • Configuring Access Token Requests
    • Access Token Response
    • Decoding the ID Token
    • Requesting User Information
    • Performing Manual Authorization Requests

For Web Developers

  • Web Integration Guide
    • Integration Options on the Web
    • Authentication Flow Web Demos
    • Implementing the Authentication Flow on the Web
    • Obtain the Carrier OpenID Configuration
    • Obtain the OpenID Configuration Document
    • Requesting Authorization Code on the Web
    • Requesting an Access Token
    • The Access Token Response
    • Decoding the ID Token
    • Requesting User Information
    • Record the Sub as the Primary Identifier of the ZenKey User
    • Add the ZenKey Button on the Web
    • Using the server-initiated flow

Developer Portal

  • Portal User Guide
    • Getting Started in the Portal
    • Request Approval for Your Company to Use ZenKey
    • The Limited Trial Agreement and the Commercial Agreement
    • Working with Developer Mode
    • Working with Launched Mode
    • Viewing Billing Invoices
    • Inviting Others to Join
    • Setting Up a Project
    • Creating a Project Name and Logo
    • Creating Project Links
    • Creating Advanced Project Links
    • Setting the Shareable Attributes
    • Security and Preventing Fraud
    • Reviewing Information Before Submission
    • Describing Your Clients
    • Setting the Redirect URI
    • Obtaining Your Client ID Credentials
    • Verifying Sector URL Domain Control
    • Verification of Redirect URLs
    • Waiting for Carriers to Provision the Client
    • Managing Projects
    • Contacting Portal Support
    • Coming Soon for the Portal

Trust Services

  • Trust Services Guide
    • Background
    • Overview
    • Using Trial Mode
    • Workflow Options
    • The SIM Tenure API
    • Implementing Trust Services
    • The SIM Tenure Option
    • The SIM Swap Event Alert Option

Additional Topics

  • (Coming soon) Managing Carrier Migration
  • Discovery Flows
    • MODRNA-based Discovery Flow
    • Optimized Discovery Flow
  • Consenting to share user information

Developer Playground

  • Developer Playground User Guide
  • View a sample banking app
  • Visit the Developer Playground

Best Practices

  • Introduction to Best Practices
  • Getting Started
    • Basic Concepts
    • Features and Benefits
    • Authentication Flows
  • Managing and Enrolling Users
    • Enrolling New Users
    • Registering Trusted Devices
    • Capturing and Managing User Information
    • Managing Tokens
  • Integrating Apps
    • Auth Code Flow and Carrier Discovery
    • Building an App
    • Test Your App
    • Carrier Apps
    • Trusted Browsers
  • Identity service brand integration guidelines
    • Permitted Uses
    • ZenKey Symbol
    • ZenKey Buttons
  • ZenKey Support

Shared User Data

Suggest Edits

ZenKey shares user info and attributes only by request via your secure backend to that of the user's carrier. Furthermore, information is only shared with consent. Users choose whether to share their data and what data to share with you.

Updated about 1 year ago


What’s Next
  • Android Quickstart
  • Android Integration Guide
  • iOS Quickstart
  • iOS Integration Guide
  • Web Integration Guide
  • Quickstart Videos
Did this page help you?