# Verification of Income
source: https://developer.mastercard.com/open-finance-au/documentation/products/voi/index.md
Tip: Accessing user data (account data, transactions, reports, etc.) requires user consent. For more about consent please check the [consent](https://developer.mastercard.com/open-finance-au/documentation/consent/index.md) page.
## Overview {#overview}
The Verification of Income (VOI) report analyzes both active and inactive income streams. It retrieves up to 12 months of validated banking data for an individual customer based on the accounts that they have permission to access. This report only supports deposit account types such as Transactions, Savings, and Term Deposits.
## Participants and Interactions {#participants-and-interactions}
| Participant | Description | Example |
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| Customer | Customers are end users granting Mastercard Open Finance access to their financial accounts. Customers go through the Connect process to connect to their Financial Institutions and grant consent to sharing their account data. | Bank account holder |
| Data Holder | A financial institution or authorized deposit-taking institution (ADI) that holds customer data and is required to transfer this data to an accredited data recipient at the customer's request | Retail banks |
| Business Partner (Integrator) | An entity involved in the Verification of Income process, which could be either an Accredited Data Recipient (ADR) or a CDR Representative. The integrator uses customer data to provide products or services to the customer, in compliance with CDR regulations. Initiates request for Verification of Income through the API endpoint. | Financial institutions, financing and lending companies, technology service providers, data aggregators |
| Mastercard Platform | Serves as an integration point for integrators to offer Verification of income service. | Mastercard |
## How It Works {#how-it-works}
Diagram voi
1. The business partner subscribes to consent notifications.
2. The business partner creates a customer record.
3. The business partner creates a consumer record.
4. The customer applies for a loan.
5. The Connect URL is presented to the customer who can use it to authorize access to their account.
6. The customer links accounts using Connect URL.
7. The business partner requests a Verification of Income Report.
API Reference: `POST /decisioning/customers/{customerId}/voi`
8. The business partner recieves an `inProgress` webhook (see [Report Webhooks](https://developer.mastercard.com/open-finance-au/documentation/connect/webhooks/index.md#report-webhooks) and [Reports Events List](https://developer.mastercard.com/open-finance-au/documentation/connect/webhooks/webhooks-event-report/index.md) for more information).
9. The business partner recieves a `done` webhook.
10. The business partner retrieves a Verification of Income Report.
API Reference: `GET /decisioning/v4/consumers/{consumerId}/reports/{reportId}`
API Reference: `GET /decisioning/v4/customers/{customerId}/reports/{reportId}`
Note: The `PDF` format is not yet currently supported for VOI reports.
Reports are formatted in `JSON`. To specify the format required, use `application/json` for the Accept request headers.
## Refreshing Reports {#refreshing-reports}
If the user's consent is still active and you require an updated verification of income report, you can request a new report by using the APIs rather than re-engaging with the customer.
Note: Since many Financial Institutions only post transactions once per day, calling the refresh reports APIs repeatedly is not recommended.
## Reading a Verification of Income Report {#reading-a-verification-of-income-report}
This section provides a detailed description of the structure and format of the Verification of Income JSON report. A VOI report is a consolidated summary of information about the income streams that have been identified from the accounts that the customer has shared. Within the report, we provide a summary of key information at both the customer level, and at the account level for each account. It explains the key elements, fields, and their usage. Developers should use this as a reference when integrating, parsing, or processing the JSON report. The JSON report is generated to provide data in a structured and machine-readable format.
### Sample JSON {#sample-json}
The JSON sample is an output of the VOI profile profile_voi_002 used in the sandbox.
[OSP_profile_voi_002_monthly-Annually1.json](https://static.developer.mastercard.com/content/open-finance-au/uploads/OSP_profile_voi_002_monthly-Annually1.json) (1MB)
### Verification of Income Attributes {#verification-of-income-attributes}
| Attribute | Definition | Type |
|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| `NET_INCOME` | This is an umbrella attribute that sums: `PAYCHECK_INCOME` `NON_PAYCHECK_INCOME` | Transactional |
| `PAYCHECK_INCOME` | Paycheck income is a regular income from an employer to employee. | Transactional |
| `NON_PAYCHECK_INCOME` | This is an umbrella group that sums: `BONUS_INCOME` `CASH_AND_CHECK_DEPOSIT_INCOME` `CHILD_SUPPORT_INCOME` `DIVIDEND_INCOME` `GOVERNMENT_BENEFIT_INCOME` (Group) `DISABILITY_BENEFIT_INCOME` `OTHER_GOVERNMENT_BENEFIT_INCOME` `SOCIAL_SECURITY_BENEFIT_INCOME` `UNEMPLOYMENT_BENEFIT_INCOME` `INTEREST_INCOME` `INVESTMENT_INCOME` `OTHER_INCOME` `RESIDENTIAL_RENTAL_INCOME` `SELF_EMPLOYMENT_INCOME` | Transactional |
| `BONUS_INCOME` | Bonus Income is a non-paycheck income that a customer receives from its employer as a separate transaction from regular paycheck transactions. | Transactional |
| `SELF_EMPLOYMENT_INCOME` | Self-employment income is a non-paycheck income that a customer receives for doing work that is not mutually exclusive to one employer. | Transactional |
| `CHILD_SUPPORT_INCOME` | Child support income is any money that a customer received by one parent as part of a custody arrangement with the other parent. | Transactional |
| `CASH_AND_CHECK_DEPOSIT_INCOME` | Cash and Check deposit is an income that is deposited to a customer's bank account in the form of a cash or a check deposit. | Transactional |
| `RESIDENTIAL_RENTAL_INCOME` | Residential rent income refers to any payment received for the use or occupation of a residential property | Transactional |
| `RETIREMENT_INCOME` | Retirement income is a superannuation income received from investment sources. | Transactional |
| `DIVIDEND_INCOME` | Dividend income is received as a stock shareholder's right for owning equity in a publicly traded company. | Transactional |
| `INTEREST_INCOME` | Interest income is a form of passive income received from a financial asset. | Transactional |
| `GOVERNMENT_BENEFIT_INCOME` | Government benefit income is a `GROUPING` of four types of identifiable income received by the customer as part of a government benefit program. This is an umbrella attribute which sums: `DISABILITY_BENEFIT_INCOME` `OTHER_GOVERNMENT_BENEFIT_INCOME` `SOCIAL_SECURITY_BENEFIT_INCOME` `UNEMPLOYMENT_BENEFIT_INCOME` | Transactional |
| `DISABILITY_BENEFIT_INCOME` | Disability income is a government benefit income received by customers with disabilities preventing them from working a normal job. | Transactional |
| `UNEMPLOYMENT_BENEFIT_INCOME` | Unemployment income is a government benefit income received by an unemployed person that is without work but meets some minimum criteria to be eligible for the benefit. | Transactional |
| `SOCIAL_SECURITY_BENEFIT_INCOME` | Social Security income is a pension from a government entity. | Transactional |
| `OTHER_GOVERNMENT_BENEFIT_INCOME` | Other Government Benefit Income is a government benefit provided outside of Disability income, Unemployment income, and Social Security income categories. | Transactional |
| `OTHER_INCOME` | `OTHER_INCOME` is any income that does not also fall into the "Paycheck Income" or any other "Non-Paycheck Income" categories. | Transactional |
### Time Interval Types {#time-interval-types}
When assessing income the choice of time interval type in a report impacts how income patterns are presented and understood. Assessing income over different intervals, such as monthly versus annually reveals consistency, trends, and fluctuations in earnings. For example, a person receiving paycheck income may show a high total amount of income over the past year when assessed annually, but lower amounts in more recent months when assessed monthly which indicates recent changes to their income. Choosing the right intervals helps lenders evaluate income stability, match repayment schedules to pay cycles, and apply risk models more accurately.
A report currently supports up to two time interval types. If a partner requests for more than two interval types, the end point gives the error: `More than 2 intervalTypes passed request.` If the time interval type is not specified, the default is `MONTHLY_CALENDAR`. The table shows all possible time interval types for which a partner can request a report.
| Time Interval Type | Description | First (Earliest) period may be partial | First (Most recent) period may be partial | Shortest possible period length | Longest possible period length |
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|-------------------------------------------|---------------------------------|--------------------------------|
| `DAILY` | The report will be broken up into one period for every calendar date in the report time period. | NO | NO | 1 | 1 |
| `WEEKLY_CALENDAR` | The report time period will be broken up into periods of seven calendar dates, with each period beginning on a Monday and ending on a Sunday, with the exception of the first and last periods which may be partial. | YES | YES | 1 | 7 |
| `WEEKLY_ROLLING_7` | The report time period will be broken up into periods of seven calendar dates, counting backwards from the report end date. | YES | NO | 1 | 7 |
| `BI_WEEKLY_CALENDAR` | The report time period will be broken up into periods of 14 calendar dates, with each period beginning on a Monday and ending on the second subsequent Sunday, with the exception of the first and last periods which may be partial. | YES | YES | 1 | 14 |
| `BI_WEEKLY_ROLLING_14` | The report time period will be broken up into periods of 14 calendar dates, counting backwards from the report end date. | YES | NO | 1 | 14 |
| `SEMI_MONTHLY_CALENDAR` | The report time period will be broken up into exactly two periods per calendar month, where both the first and the last period may be partial, and periods will alternate between representing the 1st:15th of the month and the 16th: end of the month. | YES | YES | 1 | 16 |
| `MONTHLY_CALENDAR` | The report time period will be broken up into one period per calendar month. | YES | YES | 1 | 31 |
| `MONTHLY_ROLLING_30` | The report time period will be broken up into 11 periods of 30 calendar dates followed by one period of 35 (or 36 for leap years) calendar dates to make one full calendar year, starting backwards from the report end date. | YES | NO | 1 | 36 |
| `QUARTERLY_CALENDAR` | The report time period will be broken up into one period per three calendar months, where both the first and last period may be partial. | YES | YES | 1 | 92 |
| `QUARTERLY_ROLLING_90` | The report time period will be broken up into three periods of 90 calendar dates followed by one period of 95 (or 96 for leap years) calendar dates to make one full calendar year, starting backwards from the report end date. | YES | NO | 1 | 96 |
| `ANNUALLY` | The report time period will be broken up into periods of 365 calendar dates (or 366 for leap years), starting backwards from the report end date. | YES | NO | 1 | 366 |
| `HISTORICALLY` | The report time period will be represented by exactly one period. | NO | NO | 1 | Duration of report data |
The JSON snippet shows an example of how a time interval type is represented.
* Json
```json
"constraints": {
"analyticsReportData": {
"timeIntervalTypes": [
"MONTHLY_CALENDAR",
"ANNUALLY"
]
}
}
```
### JSON report structure - Analytics section {#json-report-structure---analytics-section}
Analytics will be provided at the account level, grouped by financial institution and at an aggregated customer level, similar to other lend and OBB products. The following examples show a customer with two accounts that contain transactions.
* Json
```json
"accounts": [
{"id": 3034460414},
{"id": 3034460415}
]
```
The analytics section is divided into three sections.
* Transactional attributes
* State attributes
* Streams
**Account-level analytics structure**
This section is for each of the customer accounts.
* Json
```json
"analytics": {
"transactionalAttributes": [...
],
"stateAttributes": [...
],
"streams": [...
]
}
```
**Customer-level analytics structure**
* Json
```json
"customerAnalytics": {
"transactionalAttributes": [...
],
"stateAttributes": [...
],
"streams": [...
]
}
```
#### Transactional attributes {#transactional-attributes}
Transactional attributes are based on a unit of data being a transaction itself. They are evaluated as events in time. A transactional attribute represents some classification or categorization of a customer's underlying transactions. For example, if a customer regularly receives salary payments from an employer, those transactions may be grouped under the `PAYCHECK_INCOME` attribute.
The following sample JSON snippets are for transactional attributes at a accounts and customer level.
* The sample snippets show transaction data of one month for `MONTHLY_CALENDAR` time interval type as an example. The actual report has all transaction stats for all the months.
* The period array for `ANNUALLY` shows aggregated data for all the months between the specified start and end dates.
* Not all attributes are showcased. Refer to the attribute table to view all VOI attributes.
* The data in the snippets are for profile_voi_002 with some modifications.
* Json
```json
"transactionalAttributes": [
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 5,
"endDate": "2024-12-31",
"max": 204.83,
"mean": 122.387463874,
"median": 138.5,
"min": 95.0,
"standardDeviation": 47.3029610588298,
"startDate": "2024-12-01",
"sum": 596.47,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 30,
"endDate": "2024-12-31",
"max": 310.0,
"mean": 222.73333333333332,
"median": 201.5,
"min": 90.0,
"standardDeviation": 83.378473338,
"startDate": "2024-12-01",
"sum": 6682.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "NET_INCOME",
"streamIds": [
"50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"f152bd96-7dbd-4156-bd48-d687a5d0bc32"
],
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420",
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"confidence": "100.0"
},
{
"streamId": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"confidence": "100.0"
}
]
}
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 5,
"endDate": "2024-12-31",
"max": 204.83,
"mean": 122.387463874,
"median": 138.5,
"min": 95.0,
"standardDeviation": 21.3029610588298,
"startDate": "2024-12-01",
"sum": 596.47,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 30,
"endDate": "2024-12-31",
"max": 310.0,
"mean": 222.73333333333332,
"median": 201.5,
"min": 90.0,
"standardDeviation": 37.378473338,
"startDate": "2024-12-01",
"sum": 6682.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "NON_PAYCHECK_INCOME",
"streamIds": [
"50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"f152bd96-7dbd-4156-bd48-d687a5d0bc32"
],
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420",
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"confidence": "100.0"
},
{
"streamId": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"confidence": "100.0"
}
]
}
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 1,
"endDate": "2024-12-31",
"max": 173.0,
"mean": 173.0,
"median": 173.0,
"min": 173.0,
"standardDeviation": 173.0,
"startDate": "2024-12-01",
"sum": 173.0,
"comparedToCohorts": []
},
{
"periods": [
{
"count": 6,
"endDate": "2024-12-31",
"max": 309.26732722,
"mean": 159.66666666666666,
"median": 179.348734,
"min": 102.72632,
"standardDeviation": 61.1671137446873,
"startDate": "2024-12-01",
"sum": 958.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
}
],
"attributeName": "CASH_AND_CHECK_DEPOSIT_INCOME",
"streamIds": [
"50fc5a76-158d-488d-b6a3-1c288fb0a0e5"
],
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"confidence": "100.0"
}
]
},
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 3,
"endDate": "2024-12-31",
"max": 325.0,
"mean": 288.0,
"median": 271.0,
"min": 268.0,
"standardDeviation": 31.4514649273176,
"startDate": "2024-12-01",
"sum": 864.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
}
]
},
{
"periods": [
{
"count": 24,
"endDate": "2024-12-31",
"max": 3326.0,
"mean": 238.5,
"median": 89.5,
"min": 6.0,
"standardDeviation": 665.4514649273176,
"startDate": "2024-12-01",
"sum": 5724.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-06",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "RETIREMENT_INCOME",
"streamIds": [
"f152bd96-7dbd-4156-bd48-d687a5d0bc32"
],
"transactionIds": [
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"confidence": "100.0"
}
]
}
]
```
Note: `NET_INCOME` will have aggregated data of `PAYCHECK_INCOME` and `NON_PAYCHECK_INCOME`. `NON_PAYCHECK_INCOME` will have aggregated data of `CASH_AND_CHECK_DEPOSIT` and `RETIREMENT_INCOME`.
* Json
```json
"transactionalAttributes": [
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 5,
"endDate": "2024-12-31",
"max": 1275.0,
"mean": 1106.2,
"median": 1065.0,
"min": 1016.0,
"standardDeviation": 1245.5455753616686,
"startDate": "2024-12-01",
"sum": 5531.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 33,
"endDate": "2024-12-31",
"max": 6993.0,
"mean": 1073.030303030303,
"median": 807.0,
"min": 605.0,
"standardDeviation": 1567.5455753616686,
"startDate": "2024-12-01",
"sum": 35410.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "NET_INCOME",
"streamIds": [
"8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"f04457a6-c745-4859-95cd-e1abfc42aecd"
],
"transactionIds": [
"496743799",
"496743810",
"496743812",
"496743814",
"496743816",
"496743817",
"496743818",
"496743819",
"496743820",
"496743821",
"496743822",
"496743823",
"496743824",
"496743825",
"496743826",
"496743827",
"496743828",
"496743829",
"496743830",
"496743831",
"496743832",
"496743833",
"496743834",
"496743835",
"496743836",
"496743837",
"496743838",
"496743839",
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"confidence": "100.0"
},
{
"streamId": "f04457a6-c745-4859-95cd-e1abfc42aecd",
"confidence": "100.0"
}
]
}
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 2,
"endDate": "2024-12-31",
"max": 1691.0,
"mean": 1284.0,
"median": 1284.0,
"min": 877.0,
"standardDeviation": 1334.369621099898,
"startDate": "2024-12-01",
"sum": 2568.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 28,
"endDate": "2024-12-31",
"max": 6993.0,
"mean": 1048.7142857142858,
"median": 754.5,
"min": 57.0,
"standardDeviation": 1334.369621099898,
"startDate": "2024-12-01",
"sum": 29364.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "PAYCHECK_INCOME",
"streamIds": [
"f04457a6-c745-4859-95cd-e1abfc42aecd"
],
"transactionIds": [
"496743799",
"496743810",
"496743812",
"496743814",
"496743816",
"496743817",
"496743818",
"496743819",
"496743820",
"496743821",
"496743822",
"496743823",
"496743824",
"496743825",
"496743826",
"496743827",
"496743828",
"496743829",
"496743830",
"496743831",
"496743832",
"496743833",
"496743834",
"496743835",
"496743836",
"496743837",
"496743838",
"496743839"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "f04457a6-c745-4859-95cd-e1abfc42aecd",
"confidence": "100.0"
}
]
}
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 5,
"endDate": "2024-12-31",
"max": 1747.0,
"mean": 1209.2,
"median": 1404.0,
"min": 207.0,
"standardDeviation": 604.2294266253507,
"startDate": "2024-12-01",
"sum": 6046.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
}
]
},
{
"periods": [
{
"count": 5,
"endDate": "2024-12-31",
"max": 1747.0,
"mean": 1209.2,
"median": 1404.0,
"min": 207.0,
"standardDeviation": 604.2294266253507,
"startDate": "2024-12-01",
"sum": 6046.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "NON_PAYCHECK_INCOME",
"streamIds": [
"8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938"
],
"transactionIds": [
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"confidence": "100.0"
}
]
},
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 5,
"endDate": "2024-12-31",
"max": 1747.0,
"mean": 1209.2,
"median": 1404.0,
"min": 207.0,
"standardDeviation": 604.2294266253507,
"startDate": "2024-12-01",
"sum": 6046.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 5,
"endDate": "2024-12-31",
"max": 1747.0,
"mean": 1209.2,
"median": 1404.0,
"min": 207.0,
"standardDeviation": 604.2294266253507,
"startDate": "2024-12-01",
"sum": 6046.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "CASH_AND_CHECK_DEPOSIT_INCOME",
"streamIds": [
"8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938"
],
"transactionIds": [
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"confidence": "100.0"
}
]
}
]
```
Note: Note: `NET_INCOME` will have aggregated data of `PAYCHECK_INCOME` and `NON_PAYCHECK_INCOME`. `NON_PAYCHECK_INCOME` will have aggregated data of `CASH_AND_CHECK_DEPOSIT`.
* Json
```json
"transactionalAttributes": [
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 10,
"endDate": "2024-12-31",
"max": 1275.0,
"mean": 614.8840425531914,
"median": 610.0,
"min": 95.0,
"standardDeviation": 750.7685752999345,
"startDate": "2024-12-01",
"sum": 6127.47,
"comparedToCohorts": []
},
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 63,
"endDate": "2025-03-04",
"max": 6993.0,
"mean": 647.62820512820514,
"median": 997.5,
"min": 90.0,
"standardDeviation": 847.02134191044195,
"startDate": "2024-03-05",
"sum": 42092.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "NET_INCOME",
"streamIds": [
"50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"f04457a6-c745-4859-95cd-e1abfc42aecd"
],
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420",
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177",
"496743799",
"496743810",
"496743812",
"496743814",
"496743816",
"496743817",
"496743818",
"496743819",
"496743820",
"496743821",
"496743822",
"496743823",
"496743824",
"496743825",
"496743826",
"496743827",
"496743828",
"496743829",
"496743830",
"496743831",
"496743832",
"496743833",
"496743834",
"496743835",
"496743836",
"496743837",
"496743838",
"496743839",
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"confidence": "100.0"
},
{
"streamId": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"confidence": "100.0"
},
{
"streamId": "8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"confidence": "100.0"
},
{
"streamId": "f04457a6-c745-4859-95cd-e1abfc42aecd",
"confidence": "100.0"
}
]
},
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 2,
"endDate": "2024-12-31",
"max": 1691.0,
"mean": 1284.0,
"median": 1284.0,
"min": 877.0,
"standardDeviation": 1334.369621099898,
"startDate": "2024-12-01",
"sum": 2568.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 28,
"endDate": "2024-12-31",
"max": 6993.0,
"mean": 1048.7142857142858,
"median": 754.5,
"min": 57.0,
"standardDeviation": 1334.369621099898,
"startDate": "2024-12-01",
"sum": 29364.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "PAYCHECK_INCOME",
"streamIds": [
"f04457a6-c745-4859-95cd-e1abfc42aecd"
],
"transactionIds": [
"496743799",
"496743810",
"496743812",
"496743814",
"496743816",
"496743817",
"496743818",
"496743819",
"496743820",
"496743821",
"496743822",
"496743823",
"496743824",
"496743825",
"496743826",
"496743827",
"496743828",
"496743829",
"496743830",
"496743831",
"496743832",
"496743833",
"496743834",
"496743835",
"496743836",
"496743837",
"496743838",
"496743839"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "f04457a6-c745-4859-95cd-e1abfc42aecd",
"confidence": "100.0"
}
]
},
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 10,
"endDate": "2024-12-31",
"max": 1747.0,
"mean": 665.5030303030302,
"median": 207.0,
"min": 95.0,
"standardDeviation": 312.5529610588298,
"startDate": "2024-12-01",
"sum": 6642.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
},
]
},
{
"periods": [
{
"count": 35,
"endDate": "2025-03-04",
"max": 1747.0,
"mean": 363.55078125,
"median": 135.0,
"min": 90.0,
"standardDeviation": 65.3228407679026,
"startDate": "2024-03-05",
"sum": 126559.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-05",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "NON_PAYCHECK_INCOME",
"streamIds": [
"50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"f152bd96-7dbd-4156-bd48-d687a5d0bc32"
"8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938"
],
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420",
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177",
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"confidence": "100.0"
},
{
"streamId": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"confidence": "100.0"
},
{
"streamId": "8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"confidence": "100.0"
}
]
},
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 6,
"endDate": "2024-12-31",
"max": 1747.07,
"mean": 1036.43,
"median": 827.0,
"min": 173.0,
"standardDeviation": 353.4514649273176,
"startDate": "2024-12-01",
"sum": 6219.0,
"comparedToCohorts": []
},
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
}
]
},
{
"periods": [
{
"count": 11,
"endDate": "2024-12-31",
"max": 1747.07,
"mean": 684.43,
"median": 727.0,
"min": 49.0,
"standardDeviation": 435.4514649273176,
"startDate": "2024-12-01",
"sum": 7004.0,
"comparedToCohorts": []
}
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-06",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "CASH_AND_CHECK_DEPOSIT_INCOME",
"streamIds": [
"50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"50fc5a76-158d-488d-b6a3-1c288fb0a0e5"
],
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420",
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"confidence": "100.0"
},
{
"streamId": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"confidence": "100.0"
}
]
}
{
"aggregatedByTimePeriods": [
{
"periods": [
{
"count": 3,
"endDate": "2024-12-31",
"max": 325.0,
"mean": 288.0,
"median": 271.0,
"min": 268.0,
"standardDeviation": 31.4514649273176,
"startDate": "2024-12-01",
"sum": 864.0,
"comparedToCohorts": []
},
],
"timeIntervalType": "MONTHLY_CALENDAR",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-12-01",
"endDate": "2024-12-31",
"cohortValues": []
}
]
},
{
"periods": [
{
"count": 24,
"endDate": "2024-12-31",
"max": 3326.0,
"mean": 238.5,
"median": 89.5,
"min": 6.0,
"standardDeviation": 665.4514649273176,
"startDate": "2024-12-01",
"sum": 5724.0,
"comparedToCohorts": []
},
],
"timeIntervalType": "ANNUALLY",
"cohortBenchmarkPeriods": [
{
"startDate": "2024-03-06",
"endDate": "2025-03-04",
"cohortValues": []
}
]
}
],
"attributeName": "RETIREMENT_INCOME",
"streamIds": [
"f152bd96-7dbd-4156-bd48-d687a5d0bc32"
],
"transactionIds": [
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177"
],
"projectedValues": [],
"streamConfidences": [
{
"streamId": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"confidence": "100.0"
}
]
}
```
Note: `NET_INCOME` will have aggregated data of `PAYCHECK_INCOME` and `NON_PAYCHECK_INCOME`. `NON_PAYCHECK_INCOME` will have aggregated data of `CASH_AND_CHECK_DEPOSIT` and `RETIREMENT_INCOME`.
**Description of JSON fields**
| Key (Datatype) | Description | Applicable for VOI |
|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| aggregatedByTimePeriods (object) | An object that contains periods object data, comparedToCohorts object data, and time interval type. | Yes |
| periods (object) | Statistics of aggregated transactions over some time period. | Yes |
| count (number) | For the selected time interval type, the number of transaction events that occurred during the period. For example, for monthly time interval, count will be shown for each month of a year. | Yes |
| endDate (string) | For the selected time interval type, the final day (inclusive) of the period being reported. For example, for monthly time interval, endDate will be shown for each month of a year. | Yes |
| max (number) | For the selected time interval type, the maximum value of all transaction amounts in the period. For example, for monthly time interval, max will be shown for each month of a year. | Yes |
| mean (number) | For the selected time interval type, the mean value of all transaction amounts in the period. For example, for monthly time interval, mean will be shown for each month of a year. | Yes |
| median (number) | For the selected time interval type, the median value of all transaction amounts in the period. For example, for monthly time interval, median will be shown for each month of a year. | Yes |
| min (number) | For the selected time interval type, the minimum value of all transaction amounts in the period. For example, for monthly time interval, min will be shown for each month of a year. | Yes |
| standardDeviation (number) | For the selected time interval type, the standard deviation of all transaction amounts in the period. For example, for monthly time interval, standardDeviation will be shown for each month of a year. | Yes |
| startDate (string) | For the selected time interval type, the first day (inclusive) of the period being reported. For example, for monthly time interval, startDate will be shown for each month of a year. | Yes |
| sum (number) | For the selected time interval type, the arithmetic sum of the amounts of all transactions in the period. For example, for monthly time interval, sum will be shown for each month of a year. | Yes |
| comparedToCohorts (object) | An array of elements comparing the customer's income/ spending during this period to the average customer's income/ spending in various cohorts, such as postal code. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| cohortType (string) | Describes the type of cohort being compared to for this period, for example `POSTAL_CODE`. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| totalDifferenceToCohort (number) | Reflects the difference between the customer's income/ spending value for the period minus that of the average income/ spending in this cohort. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| percentageDifferenceToCohort (number) | Reflects the percentage difference between the customer's income/ spending value for the period and the average income/ spending of the cohort. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| timeIntervalType (string) | See Time Interval Types for how each period is defined. | Yes |
| cohortBenchmarkPeriods (object) | A list of objects where each object is a period of the same duration as those in aggregatedByTimePeriods, describing the income/ spending of cohorts in the customer's zip code during that period for an attribute. | No |
| startDate (string) | The first day of the cohort benchmark period. | No |
| endDate (string) | The final day of the cohort benchmark period. | No |
| cohortValues (object) | An object that contains the type and value of a cohort benchmark period. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| cohortType (string) | For each cohort benchmark period, the type of cohort we have a representative metric for, for example `POSTAL_CODE`. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| value (number) | For each cohort benchmark period, the average income/ spending for the cohort during this time period. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| attributeName (string) | Name of the attribute that we are reporting the numbers for. | Yes |
| streamIds | List of stream IDs associated with the attribute. | Yes |
| transactionIds(object) | List of transaction IDs associated with the attribute. | Yes |
| projectedValues (object) | List of projection objects, where each object indicates the projected income/ spending value of the attribute over some coming period of time. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| timeUnit (string) | The unit of time being described, for example MONTHS. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| timeValue (number) | The number of timeUnit units for which we are projecting, for example 12 (for 12 months). This field will be empty as it is not applicable for the VOI product in Australia. | No |
| projectionValue (number) | The predicted sum value of the attribute over the coming timeValue number of timeUnits. This field will be empty as it is not applicable for the VOI product in Australia. | No |
| streamConfidences (object) | List of stream confidences, indicating the confidence in which we believe each stream is correctly associated with this attribute. | Yes |
| streamId (string) | The stream ID we are reporting the confidence for. | Yes |
| confidence (number) | A float value between 0 and 100. | Yes |
#### State Attributes {#state-attributes}
Currently, Verification of Income does not have any state attributes.
#### Streams {#streams}
Streams are groups of transactions that represent a repeated flow of funds for some consistent purpose between two parties (or accounts, if the same entity owns both the source and destination of funds). Examples of streams include: bi-weekly paychecks from an employer to an employee, a customer's monthly phone bill paid to a telecom provider, a customer's monthly transfer from a checking account to an investment account, and so on. Since a stream is a group of transactions, a transactional attribute can assign a list of streams to itself if the transactions in that stream all fit the same classification being described by the attribute.
**JSON snippets of stream attributes:**
* Json
```json
"streams": [
{
"cadence": 14,
"id": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"payee": "Mr Howard Major Carter",
"payor": "bnpl",
"recency": 66,
"earliestObservedDate": "2024-03-09T00:00:00",
"latestObservedDate": "2024-12-28T00:00:00",
"count": 6,
"sum": 958.0,
"status": "inactive",
"min": 49.0,
"max": 705.0,
"mean": 159.666666666,
"median": 50.0,
"standardDeviation": 150.05693724578154,
"minimumCadence": 0,
"maximumCadence": 42,
"medianCadence": 8,
"modeCadence": 7,
"standardDeviationCadence": 267.1671137446873,
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420"
]
},
{
"cadence": 1,
"id": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"payee": "Mr Howard Major Carter",
"payor": "unrecognized entity",
"recency": 51,
"earliestObservedDate": "2024-03-06T00:00:00",
"latestObservedDate": "2025-01-12T00:00:00",
"count": 24,
"sum": 5724.0,
"status": "inactive",
"min": 6.0,
"max": 3326.0,
"mean": 238.5,
"median": 89.5,
"standardDeviation": 665.4514649273176,
"minimumCadence": 0,
"maximumCadence": 6,
"medianCadence": 0,
"modeCadence": 0,
"standardDeviationCadence": 1.3563402407265193,
"transactionIds": [
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177"
]
}
]
```
* Json
```json
"streams": [
{
"cadence": 2,
"id": "8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"payee": "Mr Howard Major Carter",
"payor": "uber",
"recency": 53,
"earliestObservedDate": "2024-03-05T00:00:00",
"latestObservedDate": "2025-01-10T00:00:00",
"count": 5,
"sum": 33326.0,
"status": "inactive",
"min": 207.0,
"max": 1747.0,
"mean": 1209.5,
"median": 1404.0,
"standardDeviation": 604.2294266253507,
"minimumCadence": 0,
"maximumCadence": 8,
"medianCadence": 1,
"modeCadence": 1,
"standardDeviationCadence": 2.068617626733007,
"transactionIds": [
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
]
},
{
"cadence": 1,
"id": "f04457a6-c745-4859-95cd-e1abfc42aecd",
"payee": "Mr Howard Major Carter",
"payor": "unrecognized entity",
"recency": 49,
"earliestObservedDate": "2024-03-06T00:00:00",
"latestObservedDate": "2025-01-14T00:00:00",
"count": 28,
"sum": 29364.0,
"status": "inactive",
"min": 57.0,
"max": 6993.0,
"mean": 1048.7142857142858,
"median": 754.5,
"standardDeviation": 1334.369621099898,
"minimumCadence": 0,
"maximumCadence": 4,
"medianCadence": 1,
"modeCadence": 1,
"standardDeviationCadence": 0.644018570940247,
"transactionIds": [
"496743799",
"496743810",
"496743812",
"496743814",
"496743816",
"496743817",
"496743818",
"496743819",
"496743820",
"496743821",
"496743822",
"496743823",
"496743824",
"496743825",
"496743826",
"496743827",
"496743828",
"496743829",
"496743830",
"496743831",
"496743832",
"496743833",
"496743834",
"496743835",
"496743836",
"496743837",
"496743838",
"496743839"
]
}
]
```
* Json
```json
"streams": [
{
"cadence": 14,
"id": "50fc5a76-158d-488d-b6a3-1c288fb0a0e5",
"payee": "Mr Howard Major Carter",
"payor": "bnpl",
"recency": 66,
"earliestObservedDate": "2024-03-09T00:00:00",
"latestObservedDate": "2024-12-28T00:00:00",
"count": 6,
"sum": 958.0,
"status": "inactive",
"min": 49.0,
"max": 705.0,
"mean": 159.666666666,
"median": 50.0,
"standardDeviation": 150.05693724578154,
"minimumCadence": 0,
"maximumCadence": 42,
"medianCadence": 8,
"modeCadence": 7,
"standardDeviationCadence": 267.1671137446873,
"transactionIds": [
"496744160",
"496744258",
"496744263",
"496744362",
"496744416",
"496744420"
]
},
{
"cadence": 1,
"id": "f152bd96-7dbd-4156-bd48-d687a5d0bc32",
"payee": "Mr Howard Major Carter",
"payor": "unrecognized entity",
"recency": 51,
"earliestObservedDate": "2024-03-06T00:00:00",
"latestObservedDate": "2025-01-12T00:00:00",
"count": 24,
"sum": 5724.0,
"status": "inactive",
"min": 6.0,
"max": 3326.0,
"mean": 238.5,
"median": 89.5,
"standardDeviation": 665.4514649273176,
"minimumCadence": 0,
"maximumCadence": 6,
"medianCadence": 0,
"modeCadence": 0,
"standardDeviationCadence": 1.3563402407265193,
"transactionIds": [
"496744153",
"496744154",
"496744155",
"496744156",
"496744157",
"496744158",
"496744159",
"496744161",
"496744162",
"496744163",
"496744164",
"496744165",
"496744166",
"496744167",
"496744168",
"496744169",
"496744170",
"496744171",
"496744172",
"496744173",
"496744174",
"496744175",
"496744176",
"496744177"
]
},
{
"cadence": 2,
"id": "8260ef2c-fb5c-48e1-ad2d-5a0d6df5e938",
"payee": "Mr Howard Major Carter",
"payor": "uber",
"recency": 53,
"earliestObservedDate": "2024-03-05T00:00:00",
"latestObservedDate": "2025-01-10T00:00:00",
"count": 5,
"sum": 33326.0,
"status": "inactive",
"min": 207.0,
"max": 1747.0,
"mean": 1209.5,
"median": 1404.0,
"standardDeviation": 604.2294266253507,
"minimumCadence": 0,
"maximumCadence": 8,
"medianCadence": 1,
"modeCadence": 1,
"standardDeviationCadence": 2.068617626733007,
"transactionIds": [
"496743740",
"496743741",
"496743742",
"496743743",
"496743744"
]
},
{
"cadence": 1,
"id": "f04457a6-c745-4859-95cd-e1abfc42aecd",
"payee": "Mr Howard Major Carter",
"payor": "unrecognized entity",
"recency": 49,
"earliestObservedDate": "2024-03-06T00:00:00",
"latestObservedDate": "2025-01-14T00:00:00",
"count": 28,
"sum": 29364.0,
"status": "inactive",
"min": 57.0,
"max": 6993.0,
"mean": 1048.7142857142858,
"median": 754.5,
"standardDeviation": 1334.369621099898,
"minimumCadence": 0,
"maximumCadence": 4,
"medianCadence": 1,
"modeCadence": 1,
"standardDeviationCadence": 0.644018570940247,
"transactionIds": [
"496743799",
"496743810",
"496743812",
"496743814",
"496743816",
"496743817",
"496743818",
"496743819",
"496743820",
"496743821",
"496743822",
"496743823",
"496743824",
"496743825",
"496743826",
"496743827",
"496743828",
"496743829",
"496743830",
"496743831",
"496743832",
"496743833",
"496743834",
"496743835",
"496743836",
"496743837",
"496743838",
"496743839"
]
}
]
]
```
**Description of JSON fields**
| Key (Datatype) | Description |
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| cadence (number) | The average number of days elapsed between consecutive transactions in the stream. |
| id (string) | A randomly generated UUID to uniquely identify the stream. |
| payee (string) | The party that is receiving the funds. |
| payor (string) | The party that is sending the funds. |
| recency (number) | The number of days elapsed since the most recent transaction in the stream. |
| earliestObservedDate (string) | The date-time of the first observed transaction in the stream. |
| latestObservedDate (string) | The date-time of the last observed transaction in the stream. |
| status (string) | Active or inactive, depending on if the duration since the last transaction in the stream exceeds the historically observed cadence. |
| minimumCadence (number) | The smallest observed duration of time elapsed between any two consecutive transactions in the stream. |
| maximumCadence (number) | The largest observed duration of time elapsed between any two consecutive transactions in the stream. |
| medianCadence (number) | The median number of days elapsed between consecutive transactions in the stream. |
| modeCadence (number) | The most frequently observed number of days elapsed between consecutive transactions in the stream. |
| standardDeviationCadence (number) | The standard deviation of the number of days elapsed between consecutive transactions in the stream. |
| transactionIds (object) | A list of all the transaction IDs that were assigned to the stream. |
## Resources {#resources}
* See how you can set up [Report Webhooks](https://developer.mastercard.com/open-finance-au/documentation/connect/webhooks/index.md#report-webhooks) to receive notifications about the progress of reports.
* See [Connect Events List](https://developer.mastercard.com/open-finance-au/documentation/connect/webhooks/webhooks-event-connect/index.md) and [Reports Events List](https://developer.mastercard.com/open-finance-au/documentation/connect/webhooks/webhooks-event-report/index.md) complete lists of events that you can retrieve via webhooks from both the Open Finance Connect application, and from the report generation endpoints.