Easy Integration

The ZenKey SDK uses OpenID Connect (OIDC) to make integration easy and to support developers creating experiences in web and native applications.

Mobile App Integration

  1. Your mobile app will use the ZenKey SDK to make an Auth Code request to the ZenKey app. 
  2. ZenKey will process the request. The user’s wireless provider will authenticate both the SIM and the user, returning an auth code to your redirect URL. 
  3. Your app will then ask your back end to request the token and access UserInfo. 

Android Docs iOS Docs

Web App Integration

  1. Your web app will request discovery. The user’s wireless provider configuration will be returned with a login hint. 
  2. Your web app will request an auth code, passing the login hint. The wireless provider will process the request and send a request to the user’s phone for SIM and user authentication. The auth code will be sent to your redirect URL. 
  3. Your app will then ask your back end to request the token and access UserInfo. 

Web Docs

SIM Tenure API

There are four steps for your server. 

  1. Make a discovery call to ZenKey to identify the user’s mobile provider. 
  2. Receive endpoint information for the user’s mobile provider from ZenKey. 
  3. Launch a SIM Tenure API call to the mobile provider with the user’s Sub ID. 
  4. Receive a response to your SIM Tenure API call directly from the mobile provider. 

SIM Tenure Docs

Trust Alerts

  1. Subscribe to event alerts on the ZenKey developer portal. 
  2. Register an event URI on the developer portal where mobile providers can post alerts you subscribe to. 
  3. Register for at least one or more event types in the developer portal. 
  4. Mobile providers push subscribed event alerts to your endpoint as they are generated. 

Trust Alerts Docs