VOIE Reports with Connect Lite
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 application can retrieve 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.
First step in connecting a customer is creating a customer record in the Finicity API. A Finicity customer record represents your borrower and is the parent record for all other financial data such as account data and transaction data. Use the technical articles below to understand the customer record and how to create customer records.
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.
Uploading Pay Statements
In order to generate a VOIE report, a pay statement is needed. Therefore, a consumer needs to upload a pay statement. The pay statement would then need to be converted to base 64 format to upload. A pay statement can be uploaded with any label, but if the pay statement needs to go through the primary field update process, the label must be lastPayPeriod to indicate the last pay statement for that income source. The file type of the pay statement must be .png, .pdf, or .jpeg
If the consumer has multiple employers, multiple pay statements can be uploaded and used to generate a VOIE report. Currently only the last pay statement for each employer is needed to generate a VOIE report.
Primary Field Update
When the label lastPayPeriod is associated with a stored pay statement and used to generate a VOIE report, the pay statement will go through the primary field update process. This process will update the primary fields of the pay statement in the report before finishing full data extraction. The following fields are the primary fields that will be updated:
Net Pay Current
Gross Pay Current
A webhook event will return when the primary field update is complete. See webhook documentation below for more information.
Display Institutions For Customers To Choose
After a customer gives you a pay statement to upload then the customer will need to connect their financial accounts. They will need to be given a selection of financial institutions for them to choose from. Your application will be responsible for retrieving a list of supported institutions from the Finicity API and then displaying those institutions in a search screen.
To get a list of institutions and their details you will call the “Get Institutions” endpoint. This will give you a list of all available institutions in the finicity system.
With our list of institutions we also certify our connections by the type of service that is being requested. Certification includes making sure the connection is running correctly and assuring the data needed such as transactions is returning properly. You would call the “Get Certified Institutions” service to get the list of institutions and it would list all that are available for lending which includes transactions with the indicator voi. You can also just call for a list of voi certified FI’s by using the filter in the call.
You should store the list of FI’s in your application for use in the search screen. We recommend refreshing that list on a 24 schedule using the finicity API. You should not call for this list every time a customer searches as this will cause delays in the customer experience and cause unnecessary load on both the application and the Finicity API services.
When presenting this list of institutions in the application you should give the ability to search by the Financial Institution Name value as well as the Financial Institution Home URL value. This assures that if a customer searches by either value they will be able to find their institution.
Customer Selects Institution
Once the customer has selected an institution from the search the Financial Institution ID would be captured to be used in the next step of prompting the customer to connect their accounts.
Call For Connect Lite URL
Using the financial institution Id you will call for the connect URL to present to the customer. The specific type you will call for in this flow is the “lite” type. With this “lite” type and the Financial Institution Id you will be given a URL for that customer to add accounts for that specific Institution. See the technical article below on how to call the “Generate Finicity Connect URL” endpoint.
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 links below.
Integrate Finicity Connect URL Into Your Application – Mobile
For mobile integration, please follow these instructions on how to integrate it into your mobile app.
Customer Account Selection
Once the consumer has uploaded all pay statements needed and selects the accounts where their pay check was deposited, a VOIE report can be generated using the asset IDs returned from the Store Customer Pay Statement as well as the accounts indicated.
With the account Id’s from the customer you can now generate the report. You will pass the account Id’s in the constraints for the generate report call and will limit the report data to just those accounts. Use the documentation below to understand how to make the generate report call.
Utilizing 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.
Utilizing Connect Route Events
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.