Help

This is a guide to help new users navigate the Trusted Key Developer Portal.

Getting started


Visit the main page of the Developer Portal. Here, you can get an overview of the Trusted Key offering and various uses cases it can be applied to. There are also tutorials that help you started with Trusted Key. Once you are done familiarizing yourself, click the “SIGN IN” button in the top right of the header, and follow through with the Trusted Key login process.


In order to authenticate using Trusted Key you will need to have downloaded the Trusted Key mobile app. Once, you have Trusted Key app installed and have successfully verified your email address within it, you will be able to confirm login requests to the Developer Portal. Make sure to accept the request to share your "Email" address on the confirmation page in the Trusted Key app.


Once you have logged in to the Developer Portal, you will be able to create and manage your apps.


Logged In Experience

Once logged in, you can create apps under your personal group (useable only by you), or you can create apps under a different group that you create. To create an app, click the "Applications" tab, and then click the "Create an App" link near the top right of the screen. To create a group, click the "Groups" tab, and then click the "Create a Group" link near the top right of the screen.


Groups

On the groups page you can create groups, invite members for each group, and modify user permissions within group.



In order to create a new group, click the "Create a Group" link near the top right of the screen. The only information that is required is the name of the group.



On the group detail page you can view permissions for each member in the group, the names of the apps which belong to your group, and name of your group.



You can edit the group's name, change member permissions, and invite new members to your group on the group edit screen. When you invite a new member you can also select the permission level of the new user (i.e. Owner, Admin, User, or Reader).



The image to the left is the permissions chart for what each permission level can and can’t do. A Reader can view information about apps and groups, but can’t change the information. A User can do everything a Reader can do, and edit an app’s information. An Admin can do everything a User can do, and manage group members, and delete apps. An Owner can do everything an Admin can do, and delete groups.




Apps

On the apps page you can create apps and edit app information (i.e. name, which group it belongs to, additional metadata info, etc.). You can view details about apps at a high level or go in depth and see more detail for each app.


Before you register the app, make sure to implement your OAuth callback url for Trusted Key. The callback URL must be https based. The callback URL is often specific to your OAuth implementation and is typically more than just your website's base URL. It would be your website's base URL + a callback route. The Portal will then provision you with a Client ID and Client Secret to use in your API calls to the Trusted Key Platform.


The process of integrating Trusted Key Relying Party support is made simple using OAuth and OpenID Connect. OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol. In technical terms, OpenID Connect specifies a RESTful HTTP API, using JSON as a data format. Our standards-based implementations allows developers to easily setup Trusted Key Relying Party support to verify the identity of an end-user, as well as to obtain basic profile information.


For more information, developers are encouraged to refer to the OpenID Documentation.


In order to create an app, you need to click the "Register an App" link near the top right of the screen. Basic information, such as name OAuth callback url, and group it belongs to, are required to register the new app. Please make sure to review the privacy policy before you create the app.



Once the app has been created, you can edit the information about the app on the app edit screen. If you want to make your app a wallet app or enable issuing features, please reach out to us or file a support ticket. Otherwise, you are able to change the name and group of the app at your own convenience.




SDKs

If you have been authorized to build a Trusted Key wallet app, you will see an SDK tab in your Developer Portal view.


By clicking the "SDKs" tab, you can view all the past sdk builds made available for developers. By clicking the download icon near the bottom of each card, you can download the ".aar" or the ".zip" file for the build release.




Feature Requests

If you want to enable additional features for your app, you can go to the feature requests page on the devportal. Our staff reviews these requests and approves them after verification on our end. Otherwise, they are rejected, and you will be notified. You can request any of the following features:


Issuing: The app can issue claims to users' wallets.

Wallet: The app becomes a mobile wallet app, which can hold a user's claims.

Point to Wallet: The app's relying party functionality can make requests to other wallets other than the Trusted Key mobile app.

Logo: The app's logo that will show up in the user's wallet app when relying party requests are made.

Public Wallet: If your app is a wallet app, then this feature allows your app to be visible to all trusted key relying party apps in the world.




Support

If you need assistance using this dev portal, or experience any issues, please let us know at the support page.


Issuing Setup Tutorial