Finicity Connect is an embeddable HTML application that makes it easy for financial applications to integrate with Finicity’s suite of API’s. Applications will use Finicity Connect to allow their customers to connect their financial accounts. After the accounts are connected the partner application can generate reports on the account financial data for their customers to provide them the required service.
Finicity Connect allows a consumer to sign into their financial institution (FI) and permission Finicity to gather data from their accounts. Finicity completely hosts Finicity Connect. This assures the partner does not have exposure to consumer credentials and authentication information.
Finicity Connect is also required for financial institutions that are secured through OAuth. Connect manages the instructions and proper redirection to the financial institution website. For more details on OAuth connections see our OAuth Connections Guide.
Finicity Connect can be integrated into your application in two different ways:
A Redirected URL
Directly Embedded Into the Application
This guide will describe in detail how to use Finicity Connect, how to integrate it into your application, how to manage and receive Finicity Connect events, and how to manage and receive report generation events.
Create Customer or Use Existing Customer
The first step in connecting a customer is creating a customer record in the Finicity API. A Finicity customer record represents your customer and is the parent record for all other financial data such as account data and transaction data.
If a customer has previously been created to generate another Finicity report (voa, voi, etc), the existing customer ID can be used to Generate a VOIE report.
In addition to creating a customer, to generate financial reports for a customer you must create a consumer record which is attached to that customer. The consumer record on creation will require all of the necessary customer data elements for the customer to be able to review and dispute any reports through the consumer portal.
If a consumer has previously been created to generate another Finicity report (voa, voi, etc), the existing consumer ID can be used to Generate a VOIE report. Accounts previously added for the consumer will show up within the Connect flow for the user to select from. The consumer can also add any additional accounts as necessary.
The next step is generating a Finicity Connect link. This link is specific to the customer, and is used to permission access to the FI and add accounts. The finicity connect link is called for a specific flow or use case (called a Connect “type”). For the lending industry use case you would call for the type “voietxverify”. This flow will allow the customer to upload the their pay statement and allow a customer to connect accounts from a list of lending certified connections to choose from.
Integrate Finicity Connect URL Into Your Application – Web
Having received the Connect URL, you can integrate the Finicity Connect experience into your application. For the web application experience, you can choose to redirect to a new page, or use the SDK to embed it into your application, following the instructions in the link below.
Upon the completion of the connect flow we will begin generating the report that was requested when the connect URL was generated. You will initially get a “started” event and then you will get a “done” event when the report is completed. To receive these events you will need to setup a listener service for the generate report events. Please see the technical articles below for instructions on setting up your listener service and for a full list of webhook events.
We know that while your customer is in the Finicity Connect flow, it is important to understand what they are doing and what their experience is like. To facilitate this we have provided web hook events that will be sent to the webhook URL you pass in the Generate Connect API call. For a detailed guide of the webhook events you will receive, see the webhooks details link below.
In addition to Webhooks events we also provide route events that you can use to receive more immediate updates on application behavior, directly in the browser. Instructions on how to utilize those can be found here.