Setting the Redirect URI

After authentication, ZenKey uses your Redirect URI to send users back to your app. Real-time requests must match one of the Redirect URIs in the ZenKey portal.

Redirect URI value

The “Default Redirect URI” uses this format: {client_id}://com.xci.provider.sdk

The Redirect URI field in the ZenKey portal pre-populates itself with a recommended value. The value starts with your client ID. If you change that value and later want to reuse the recommended value, click the button.

The ZenKey mobile SDK assumes that you have included a Redirect URI and that you kept the “Default Redirect URI” from the portal. The mobile SDKs register the Default Redirect URI with the OS to return control to your mobile app during and after the authentication flow. Keep the default Redirect URI unless you are sure it will not be used.

📘

localhost

Only localhost can be used when in Developer Mode.

Supported Redirect URI types

The Redirect URI can be a simple link, a deep link, or a universal link. Redirect URIs also support URLs with variables (e.g. {client_id}://com.xci.provider.sdk/level2/desired_ref/&var=zk).

Multiple Redirect URIs

You may add multiple Redirect URIs for web apps. Additional Redirect URIs are unnecessary for mobile apps. Multiple Redirect URIs can be useful in situations such as the following.

  • To use different Redirect URIs in different environments, like development and production.
  • To use different Redirect URIs on different platforms that share the same Client ID.
  • To receive callbacks at different URLs by authorization type.

For more information about setting up Redirect URIs, see creating a custom redirect URI on Android or creating a custom redirect URI on iOS.


Did this page help you?