Configuration Parameters
Learn how to configure Argyle Link.
Argyle Link provides multiple configuration options and callbacks that customize how this UI element functions within your application. The only argument that is mandatory when invoking Argyle Link is the linkKey, which can be found in the Argyle Console.
Initial configuration#
For instructions on initial configuration and basic configuration examples, see:
- Instructions for Web integrations
- Instructions for iOS integrations
- Instructions for Android integrations
- Instructions for React Native integrations
By default, anytime Argyle Link is initialized, it is treated as a new session for a new user. To ensure your users retain their previous state in Argyle Link when it is re-initialized for them, your application must use the userToken parameter. See our Returning Users Guide for further guidance.
Essential parameters#
| Attribute | Type | Description |
|---|---|---|
linkKey | string (uuid) required | Your Link key, which can be found in the Link keys section of the Argyle Console. |
linkItems | string optional | Use this parameter to limit the number of Link items that your users can connect. Provide an array of Link item IDs you want Argyle Link to display on the Search screen. The order in which you list the IDs defines the order in which they are displayed on the UI. If you provide a single Link item ID, the Search screen is skipped and the user is navigated directly to the Link item Login screen. |
apiHost | string optional (required for iOS) | The API host that Argyle Link should use. Defaults to production API. |
userToken | string (uuid) optional | By default, anytime Argyle Link is initialized, Argyle will treat this as a new session for a new user. To ensure your users retain their previous state in Argyle Link when it is re-initialized for them, your application must use the userToken parameter. |
UI elements parameters#
You can customize Argyle Link using Flows in Console or by editing Link's configuration parameters programmatically.
| Attribute | Type | Description |
|---|---|---|
customizationId | string optional | The customization ID, which can be found in the Flows area of Console. |
Direct deposit parameters#
| Attribute | Type | Description |
|---|---|---|
payDistributionConfig | string optional | Argyle Link will initiate a direct deposit update flow if a payDistributionConfig is provided. Visit our direct deposit switching guide or our DDS Configurations Reference for more information. |
payDistributionUpdateFlow | boolean optional | If payDistributionUpdateFlow is set to true and the payDistributionConfig parameter is provided, the direct deposit update flow will be initiated right after an account is connected.If this is set to true but the payDistributionConfig is not set, Link will not initialize properly. The default value is false. |
payDistributionAutoTrigger | boolean optional | If set to true, the deep linked returning users are taken directly to the Direct deposit opened screen, if a payDistributionConfig is provided. The default value is false. |
payDistributionItemsOnly *DEPRECATED | boolean optional | When set to true, only Link items that support pay distribution will be shown. For more information on updating a pay distribution, refer to Direct deposit switching. If a payDistributionConfig is provided, then only the Link items that match the parameters in the config will be shown. For example, if the payDistributionConfig allows only amount allocations and a Link item supports percent allocations only, then that Link item will not be shown. If no payDistributionConfig is provided then all Link items that have some pay distribution support (amount and/or percent) will be shown. The default value is false. |