Deep Linking

Table of Contents

What is Deep Linking? #

Deep linking is a way to open a specific view (or page) within a mobile app using a link. This technique is similar to the way an http hyperlink allows you to open a specific page on a website (e.g., “http://example.com/path/page”). You can click a deep link from inside an email, a website or even another mobile app. Using deep links can make two mobile apps work together seamlessly.

What is the ID123 App deep link URI? #

id123://

What is “iid” and “ctid”? #

VariableDescription
iidshort for Institution ID
ctidshort for Card Template ID

Where to find “iid” and “ctid”? #

“iid” (Institution ID) is located in the ‘Account Information’ page in the IDMS.

“ctid” (Card template ID) is located in the ‘Card Templates’ page in the IDMS. Click on ‘Info’ on the preferred template to see the template ID.

NOTE: “IDMS” is short for ID Management System, which is the administrative web portal for account administrators where they issue and manage digital ID cards.

What deep link views are supported? #

ViewDescription
ProfileLaunches the card holder’s Profile View
Search Institution Results ViewLaunches the Search Institution Results View. Optionally pass search parameters to automatically filter the search when viewing the app page.
Selected Institution ViewLaunches the Selected Institution View with a specific institution selected. If the institution has only one card available, it will redirect the user to the Create Card View. If the institution has more than one card, the user will be asked to select a card offered by the institution.
Create Card ViewLaunches the Create Card View for a specific institution. If the template is Self-Issued, the user will need to fill out card details to create a card. If the template is Institution Issued – Self Provisioned, the user will only need to answer security questions to generate their card.
Launch Installed Card ViewLaunches the Card View of an existing card. If the card does not exist, it defaults to the dashboard screen.
My Profile v1.1

Profile View #

URI: id123://profile123/self

Use Case: This deep link will direct users to the My Identity View when the user is logged into the mobile app.

Search Institution Results

Search Institution Results View #

URI: id123://search123/institutes?type=1&zip=12345&radius=20&search-name=institution

How to generate this link?: Insert your zip code in place of ‘12345’ into the deep link after ‘zip=’. Insert your radius in place of ’20’ into the deep link after ‘radius=’. Insert your search name in place of ‘institution’ into the deep link after ‘search-name=’.

Use Case: This deep link will direct users to the Search Institution Results page for specific search queries. The deep link can contain a zip code and radius, as well as a search name. The radius is should be under 50 miles.

Selected Institution Page

Selected Institution View #

URI: id123://search123/institute?iid=1b52a69bfa13537e4886a3f057f50f767be9ac1d

How to generate this link?: Log into your account in the IDMS, click on ‘Account Information’ located under the ‘Account’ section, copy your Institution ID, and paste it into the deep link after “iid=” in place of ‘1b52a69bfa13537e4886a3f057f50f767be9ac1d’.

Use Case: This deep link will display the Selected Institution View in the app. If there are multiple cards offered by the institution, then they will be prompted to select a card. If there is only one card available for the institution, then the user will be automatically forwarded to create the card. If they are not logged in, the next step will be registration.

Create Card

Create Card View #

URI: “id123://search123/institution/create-card?iid=1b52a69bfa13537e4886a3f057f50f767be9ac1d&ctid=12345fsdadasd”

How to generate this link?:

1. Log into your account in the IDMS, click on ‘Account Information’ located under the ‘Account’ section, copy the Institution ID, and paste it into the deep link after “iid=” in place of ‘1b52a69bfa13537e4886a3f057f50f767be9ac1d’.

2. Log into your account in the IDMS, Click on ‘Info’ on the preferred template in the Card Templates page, copy the Card Template ID, and paste it into the deep link after “ctid=” in place of ‘12345fsdadasd’.

Use Case: This deep link will bring the user to the Create Card View for a specific card. If the template is Self-Issued, the user will need to fill out card details to create a card. If the template is Institution Issued – Self Provisioned, the user will only need to answer security questions to generate their card. This will only happen if the user is logged in, otherwise they will be redirected to the Register/Login page.

card view

Launch Installed Card View #

URI: “id123://card123/view?ctid=12345fsdadasd”

How to generate this link?: Log into your account in the IDMS, Click on ‘Info’ on the preferred template in the Card Templates page, copy the Card Template ID, and paste it into the deep link after ‘ctid=’ in place of ‘12345fsdadasd’.

Use Case: This deep link will launch a previously installed ID card. This will only happen if the user is logged in, otherwise they will be redirected to the Register/Login page.