Customize Link programmatically

Learn how to customize Link using code.

Learn how to customize your Argyle Link instance programmatically by editing the Link configuration file. This page demonstrates how each config parameter appears on Link.

For a list of all parameters and their usage, please refer to our Customizing Link guide.

Change the company name#

• companyName (string) optional — Your company or app name to display in the UI of Argyle Link—for example, "your account is now successfully connected to companyName". The default value is your company name as entered in the Company Details section of the Argyle Console.

Show / hide categories#

• showCategories (boolean) optional — Show/hide category tabs (for example: All, Employer, Gig, Payroll). Defaults to true.

Exclude categories#

• excludeCategories (array of strings) optional — Excludes one or more categories (and their respective Link items) from the Search screen. Possible values: employer, gig, payroll.

Exclude Link items#

• excludeLinkItems (array of strings) optional — Use this parameter to limit the number of Link items that your users can connect to. Provide an array of Link item IDs you want Argyle Link to exclude in the Search screen.

Change the title of "Can't find your income source?" button#

• cantFindLinkItemTitle (boolean) optional — Change the title for the "Can't find your income source?" button when no Link item is available.
  This button is shown by default but can be disabled by setting showCantFindLinkItemAtTop to false.

Questionnaire#

When a user clicks the "Can't find your income source?" button, they are redirected to a questionnaire to provide their employer name and associated payroll platform (if available).

If the payroll platform selected is already supported by Argyle, the user can log in to that specific payroll platform directly.

If the payroll platform selected is not supported and the user continues to submit the questionnaire, there are two possible scenarios for the users:

1. If document upload is disabled, the user will quit the Argyle flow:

   

2. If document upload feature is enabled, the user will be asked to upload their income verification documents:

   

Display the "Can't find your income source?" button at the top of the search results list#

• showCantFindLinkItemAtTop (boolean) optional — If set to true, the "Can't find your income source?" button is displayed at the top of the search results list. This works only when the user enters at least four characters in the search box. Otherwise, the button remains at the bottom of the search results list. By default, the button is always displayed at the bottom of the list, and the default value is false.

Change button texts in the Success Screen#

• showBackToSearchButton (boolean) optional — If set to false, hides the Return to search button in the Success Screen. Default value is true.

• backToSearchButtonTitle (string) optional — Change the title for the Return to search button in the Success Screen.

• exitButtonTitle (string) optional — The provided value will override the default title of the Done button shown on the Success Screen.

Remove the close button#

• showCloseButton (boolean) optional — Toggles the visibility of the Close button. This flag works only on the web implementation of Argyle Link (and not on the mobile SDKs). Hide the "X" by setting this to false.

Disable closing Link on outside click#

• closeOnOutsideClick (boolean) optional — Toggles the closing of Link when a user clicks outside the bounds of the UI element provided by Argyle. This flag works only on the web implementation of Argyle Link (and not on the mobile SDKs). Default value is true. When set to false, clicking outside of Link will not close Link.