Guide for the Lending Industry
Once a report has been generated you can now use the reportId to retrieve the report. You can pull the report in XML or JSON to be used in your application programmatically. You can also retrieve a PDF version of the report. To retrieve any of these formats you simply pass the accept header value for the type you are looking for. More details in the articles below. A requirement of report retrieval endpoints is you must pass a permissible purpose code as required by CRA regulations.
Permissible Purpose Codes
When retrieving a report you must include a permissible purpose for retrieval. This is part of CRA regulations and enforced on the pull of the report once the report is generated. The permissible purposes you will use is determined by your contract which is based on the industry and use case for the data.
A Finicity Verification of Asset report aggregates account and transaction data and calculates various asset values from this consumer permission data. For a detailed explanation of the entire VOA reports see the article below.
A Finicity Verification of Income report aggregates account and transaction data and calculates various income values from this consumer permission data. For a detailed explanation of the entire VOI reports see the article below.
A Finicity Verification of Income and Employment report aggregates account and transaction and combines them with an extracted and digitized pay statement to verify income and employment. For a detailed explanation of the entire VOI reports see the article below.
Mortgage Industry Reports Details
When submitting Finicity reports to the GSE’s for decsioning you will pass a Finicity portfolioId as found on the report. The portfolioId will associate multiple reports for the same consumer in the case that you need to pass both a VOA and VOIE report. The Portfolio ID will be 12 characters appended with “-[#]-port”. This Portfolio ID will also be included inside each report.
The # represents the revision of the portfolio. Each time a customer generates a report or refreshes an old report, the portfolio revision number will increment.
Each portfolio ID will represent a snapshot of the report collection at the time that portfolio ID was created.