Institution Settings

Set up and choose institution settings when using Finicity Connect

Overview

This article will cover the following subjects surrounding institutions:

  • 1

    Partner Institution Settings

  • 2

    Finicity Connect Institution Settings

Partner Institution Settings

Partner institution settings are specific institution settings for your implementation. All public online institutions are displayed by default in connect and in the institutions list. There are three partner specific options we can configure for your environment via reach out to your account manager or systems engineer.

  • 1

    Hidden – If you would like to hide a specific institution(s) from the search list.

  • 2

    Visible – We can make new connections that may be in testing visible to you that otherwise would be hidden.

  • 3

    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.

  • 4

    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 Overview

With Finicity Connect institutionSettings you can temporarily, for an individual connect session generated via Generate Connect URL, override the default and Partner Institution Settings for institutions.

Generate Connect

POST
/connect/v1/generate

Hide A Financial Institution

If you would like to hide an institution or set of institutions for the specific connect session you would use the following setting:

Example
 "institutionSettings": {
"5": "hidden",
"1407": "hidden"
}

Make A Hidden Financial Institution Visible

In this scenario when a new OAuth connection becomes available it can be tested by making it visible in the search list of institutions. Please note this means that the new OAuth connection and the legacy connection will be present together in the list so you would see two FI’s with the same name. This is why this scenario is only recommended for internal testing or piloting purposes.

Example
 "institutionSettings": {
"102224": "visible"
}

Replace Legacy Institutions With It’s Replacement Institution

When a new OAuth institution becomes live at a certain point all partners will be automatically migrated over to the new FI. If there is a use case where you would like to show an OAuth institution and replace all the legacy institutions for use during early adoption then you can override a specific session using the following setting:

Example
 "institutionSettings": {
"102224": "replace"
}

Auto Replace Legacy Institutions With It’s Replacement Institution

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
 "institutionSettings": {
"102224": "autoReplace"
}

Full Generate Finicity Connect URL Example With Multiple Options

Example
 {
"partnerId": "1445585709680",
"customerId": "1005061234",
"type": "aggregation",
"institutionSettings": {
"5": "hidden",
"1407": "hidden",
"102224": "autoReplace"
}
}