Link Accounts | Govstack

Link accounts allow you to link integration widgets within Citizen Portal. Here you can add and manage link accounts and define your own fields that you want to use to validate or authenticate a citizen for linking the widget to your systems. There are two types of link accounts that can be added: Citizen Portal link accounts and external link accounts.

Adding a Citizen Portal link account

To add link accounts, you need to:

Select the “Settings” tab from the top of the administrator portal
Select the “Link accounts” tab
Select the “Add link account +” button
Choose "Link account" from the dropdown menu

You will now be able to add details to the link account.

Link account details

Once you’ve added the link account, you can customize the link account. Review each of the fields and learn how to complete the set-up process.

Link account name

Under "Link account name", enter the name for the linked account.

Property dependent checkbox

Select the "Property dependent" checkbox if the link account depends on the user's address. If you select the "Property dependent" checkbox, users will have to link the widget individually for each property. If you choose not to select the "Property dependent" checkbox, then when a user links the widget for one property, that widget will be linked for all properties added by the user.

Field name and type

Under "Field name", enter a name for that field. In the "Field type" dropdown next to it, select what type of field it is.

Add a field

Select “Add field” to add a new field. You can add multiple fields in the same link account.

Select the "Actions" dropdown menu to edit or delete a field. Select "Edit" if you'd like to edit the field and select "Delete" if you'd like to delete the field.

Specify the API endpoint

Under "Endpoint", specify the API endpoint that would be used to validate the user’s credentials. Under "Unlink endpoint", specify the API endpoint that would be used to unlink the account.

Adding an external link account

If using any third party identity provider, you can manage multiple external link accounts for integration widgets. If the integration widget is configured with an external link account, citizens will be redirected to the external link account (third party identity provider like B2C, AWS Cognito, etc.). Upon successful linking, Token and Refreshtoken will be stored along with the External link account and used to retrieve integration widget content appropriately.

To add an external link account:

Select the “Settings” tab from the top of the administrator portal
Select the “Link accounts” tab
Select the “Add link account +” button
Select "External link account" from the dropdown list

You will now be able to add details to the external link account.

Link account details

Once you’ve added the link account, you can customize the link account. Review each of the fields and learn how to complete the set-up process.

Enter the link account name and required fields

Enter the link account name and required fields.

Property dependent checkbox

Select the "Property dependent" checkbox if the external link account depends on the user's address. If you select the "Property dependent" checkbox, users will have to link the widget individually for each property. If you choose not to select the "Property dependent" checkbox, then when a user links the widget for one property, that widget will be linked for all properties added by the user.