You can change the financial institutions (FI) displayed in the search list for a Connect session. By default, all public institutions are displayed. However, you can change the FIs search list to display only the one you want by passing the institutionSettings parameter in the body of the request for the Generate Connect 2.0 URL APIs.
Client Institution Settings
Client institution settings are specific institution settings for your implementation. All public online institutions are displayed by default in connect and in the institution’s list. There are three partner-specific configuration options you can set for your environment.
Finicity sales engineers can help set this up for you.
Hidden – If you would like to hide a specific institution(s) from the search list.
Visible – We can make new connections that may be in testing visible to you that otherwise would be hidden.
Replace – We can replace legacy institutions with a new connection. This is typically used when we launch new OAuth connections and will be done automatically on your behalf.
autoReplace – This setting determines if a customer has used the legacy institution or not. If they have connected accounts with the legacy institution they will not see the new OAuth FI that replaces it. If they have not legacy accounts they will be presented with the new OAuth FI.
Generally regarding OAuth connections this gives us the ability to manage your preference whether that be early adoption of a new OAuth connection or later adoption during the final migration.
Finicity Connect Institution Settings
The institutionSettings in the General Connect 2.0 URLs, allows you to temporarily override the client institution settings per connect session.
hidden: Hide FIs
You can hide an individual institution or a set of institutions for a specific connect session.
visible: Change Hidden FIs to Visible
When new OAuth connections become available, you can internally test the connection by making the FI visible in Connect’s search list for institutions. If the OAuth connection is new and the legacy connection is still available, then two FIs with the same name will display in the search list.
replace: Override Legacy Institutions
When a new OAuth institution goes live, eventually all of your customers will automatically migrate to the new OAuth connection. If you want to opt-in for early adoption of the OAuth connection, and override all legacy FIs per a Connect session, then pass in the value; replace for the [av_fin_code_in_para fin_code_in_para=’institutionSetting’ av_uid=’av-8v6j1l’ custom_class=” parameter in the body of the Generate Connect 2.0 API request call.
Auto Replace Legacy Institutions
This setting gives flexibility in implementing a new OAuth institution connection. When this setting is set for a new OAuth institution if a customer already has accounts from the previous legacy institution(s) it will not display the new OAuth institution. This allows for legacy users to be carefully migrated and handled before being exposed to the new connection. For all new customer that have no legacy institution it will display the new OAuth institution in the list so they can benefit from the new connection.
Example of institutionSettings Request Call