VOIE Reports - Connect Lite
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.
Generate Finicity Connect URL - Lite
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.
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.