# Verification of Income source: https://developer.mastercard.com/open-finance-us/documentation/products/lend/reports/voi/index.md ## Overview {#overview} Verification of Income (VOI) assesses an applicant's income using up to 24 months of a customer's bank transaction data. The service identifies active and historical income streams from deposits, assigns a confidence score and cadence to each stream, and provides summarized historical and projected income. Learn more about Mastercard's [Income \& Employment](https://developer.mastercard.com/open-finance-us/documentation/products/lend/product-solutions/index.md#income--employment) products. ### Key Product Features {#key-product-features} * **Account Owner:** See the listed account owner name and address to assist in fraud reduction * **Connected Accounts Summary:** Includes information such as the financial institution (FI) name, last four digits of the account number, account type, and balance * **Data History** : Up to 24 months of categorized transaction data based on availability from the FI(s). Length of history is customizable using the `fromDate` and defaults to 24 months * **Deposit Income Streams**: Defaults to include all income streams, but can be adjusted based on your preferences #### Additional Product Information {#additional-product-information} **FI Certification Type** : Verification of Income (VOI). Each FI goes through a certification process to make sure the right data is consistently provided to make the product successful. See [the list of certified FIs](https://developer.mastercard.com/open-finance-us/documentation/financial-institution/supported-institutions/index.md) for this product. * **Report Generation Time (median):** Less than 25 seconds * **Report Refreshes:** This report can be refreshed with new data as long as the accounts are still connected, and consent is active. Refreshes are provided at no cost within 60 days after the first report is created. A report pulled after this period will incur a new charge. * **Supported Account Types**: Checking, Savings, Money Market * **Supported Report Format:** JSON and PDF Note: This report may ONLY be furnished for a Fair Credit Reporting Act (FCRA) purpose such as credit, insurance, or employment, and only pursuant to a permissible purpose certification by the report user. Provision and use of this report is subject to all applicable obligations of the FCRA. ### Use Cases {#use-cases} The VOI product is suitable for the following use cases: * Auto * Credit Card Issuance * Credit Line Management * Customer / Portfolio Monitoring * Debt Collection * Personal Financial Management * Personal Lending * Servicing * Small and Medium Business * Tenant Screening ## How it Works {#how-it-works} ### Prerequisites {#prerequisites} This product is dependent on the customer linking their bank accounts via Data Connect. Refer to [Generating Reports](https://developer.mastercard.com/open-finance-us/documentation/products/lend/generating-reports/index.md) for more information. * [Generate the required credentials](https://developer.mastercard.com/open-finance-us/documentation/quick-start-guide/index.md#generate-your-credentials) * [Create Access Token](https://developer.mastercard.com/open-finance-us/documentation/quick-start-guide/index.md#step-1---create-access-token) * [Create a customer record](https://developer.mastercard.com/open-finance-us/documentation/customer-records/index.md#active-customers) * [Create a consumer record](https://developer.mastercard.com/open-finance-us/documentation/customer-records/index.md#consumers) * [Generate a Data Connect URL](https://developer.mastercard.com/open-finance-us/documentation/connect/generate-2-connect-url-apis/index.md) and [link customer accounts](https://developer.mastercard.com/open-finance-us/documentation/connect/index.md#the-connect-flow) ### Generate VOI Report {#generate-voi-report} To generate or refresh a VOI report, use the following endpoint: API Reference: `POST /decisioning/v2/customers/{customerId}/voi` The response will include the status of the report generation and a report ID. A notification is sent when report generation is finished (see [Report Webhooks](https://developer.mastercard.com/open-finance-us/documentation/webhooks/webhooks-report/index.md)). #### Implementation Notes {#implementation-notes} * Use the `fromDate` parameter to customize the transaction history included in the report. By default, 24 months of history will be aggregated as available. * Customize which accounts are included in the report using the `accountIds` parameter. By default, the report includes all supported account types. * Customize the income streams returned in this report based on the confidence level. This input is called `incomeStreamConfidenceMinimum`. All income streams whose confidence level is greater than or equal to the number requested are provided. * High confidence levels correspond to `confidence` values of 75 and 100. * Moderate confidence levels correspond to a `confidence` value of 50. * Low confidence levels correspond to `confidence` values of 0 and 25. * Streams with confidence levels of Moderate or High are considered income. Streams with a confidence level of Low are considered non-income. Receiving all income streams may be desirable based on the use case. ### Get VOI Report {#get-voi-report} Once the report is generated, retrieve the report using one of the [Get Reports](https://developer.mastercard.com/open-finance-us/documentation/products/lend/get-reports/index.md) endpoints. #### Example Report {#example-report} The Get Report APIs response contains different data depending on the type of report requested. The following example shows what a successful JSON response could look like for this report. Examples are meant for reference only and may lag production changes. ```json { "id": "u4hstnnaewetr-voi", "customerId": 1000006677, "consumerId": "ac39e237c7619a4ecf014b8d399c0696", "consumerSsn": "6789", "disputeStatement": "Invalid data present.", "requesterName": "Decisioning API", "endUser": { "name": "ABC Apartments", "address": "123 Main St", "city": "Murray", "state": "UT", "zip": "84123", "phone": "555-2106", "email": "customerservice@example.com", "url": "example.com" }, "requestId": "sfb7xp4wer", "type": "voi", "status": "success", "createdDate": 1588350269, "customerType": "active", "title": "Mastercard Open Banking Verification of Income", "startDate": 1572625469, "endDate": 1588350269, "days": 200, "seasoned": true, "portfolioId": "dyr6qvqd2erw-1-port", "institutions": { "id": 101732, "name": "FinBank", "urlHomeApp": "https://finbank.prod.fini.city/CCBankImageMFA/login.jsp", "accounts": { "id": 1000023996, "number": "1111", "ownerName": "JOHN DOE", "ownerAddress": "924 GAINSVILLE HIGHWAY SUITE 130 BUFORD, GA 30518", "ownerAsOfDate": 1577986990, "name": "Checking", "type": "checking", "aggregationStatusCode": 0, "incomeStreams": { "id": "dens28i3vsch-voi1", "name": "none", "status": "ACTIVE", "estimateInclusion": "MODERATE", "confidence": 70, "cadence": { "startDate": 1577986990, "stopDate": 1587986990, "days": 14 }, "netMonthly": [ { "month": 1522562400, "net": 2004.77 } ], "netAnnual": 110475.7, "projectedNetAnnual": 0, "estimatedGrossAnnual": 0, "projectedGrossAnnual": 151609, "averageMonthlyIncomeNet": 9206.31, "incomeStreamMonths": 18, "transactions": [ { "id": 100000527471, "amount": 22.21, "postedDate": 1582286400, "description": "FINICITY INC PAYROLL", "memo": "Finicity amount credit", "institutionTransactionId": "100000000", "category": "Paycheck" } ] }, "balance": 714.16, "averageMonthlyBalance": 720.75, "transactions": [], "availableBalance": 714.16, "currentBalance": 714.16, "beginningBalance": 714.77, "miscDeposits": [ { "id": 100000527471, "amount": 22.21, "postedDate": 1582286400, "description": "FINICITY INC PAYROLL", "memo": "Finicity amount credit", "institutionTransactionId": "100000000", "category": "Paycheck" } ] } }, "income": [ { "confidenceType": "MODERATE", "netMonthly": [ { "month": 1522562400, "net": 2004.77 } ], "incomeEstimate": { "netAnnual": 1000.12, "projectedNetAnnual": 1500.23, "estimatedGrossAnnual": 2000.12, "projectedGrossAnnual": 2500.23 } } ] } ``` A human-readable PDF version of the report is available which is great for underwriters or any other manual viewing of the report. How to read a VOI report: [VOI_Report_HTR.pdf](https://static.developer.mastercard.com/content/open-finance-us/uploads/reports/lend/VOI_Report_HTR.pdf) (2MB) ## Testing {#testing} Refer to [Generating Reports -- Testing](https://developer.mastercard.com/open-finance-us/documentation/products/lend/generating-reports/index.md#testing). Ensure you use a test profile that contains supported account types such as [Profile_03](https://developer.mastercard.com/open-finance-us/documentation/integration-and-testing/test-the-apis/index.md#oauth-connection-profiles).