Find more information about bank income reports.
Attributes
The table below has the values and descriptions of the bank income report responses.
Attribute | Type | Description |
---|---|---|
status | string | Status of report, possible values success , processing |
completed_at | date-time | Time when report was completed |
days_requested | int32 | Requested number of days for specified transactions |
tracking_info | string | Additional optional identifier passed by user |
provider | string | Data provider identifier |
access_token | string | Access token of existing Link |
companies | array of strings | List of companies person works for |
accounts | array of objects | List of bank accounts, see Accounts object |
income | array of objects | List of bank income sources, see Income object |
summary | array of objects | Bank account information summary, see Summary object |
is_suspicious | Boolean | Status of data from source marked as suspicious, such as if detecting fraud in uploaded documents or user SSN does not match data |
Accounts object
The values in this table are for the Accounts object.
Attribute | Type | Description |
---|---|---|
id | string | Unique identifier of account |
created_at | date-time | Date and time when account was created in Truv |
updated_at | date-time | Date and time when account was last updated in Truv |
type | string | Parent type of account, example CHECKING or SAVINGS |
subtype | string | Account subtype, example PLAN_401_K , MONEY_MARKET , or HOME_EQUITY |
mask | string | Masked banking account number associated with specific account |
nickname | string | Alternate account name |
Income object
This table contains the attributes in the Income object.
Attribute | Type | Description |
---|---|---|
start_date | date | Minimum of all dates within specific income sources in user bank accounts for days requested by client |
end_date | date | Maximum of all dates within specific income sources in user bank accounts for days requested by client |
account_id | string | Unique identifier of account |
income_description | string | Original description for underlying income transactions |
income_category | string | Income category |
pay_rate | number | Recurring direct deposit received per pay frequency, NET PAY |
pay_frequency | string | Frequency of direct deposit posted into bank account, see values belowM - MonthlySM - Semi-monthlyW - WeeklyBW - Bi-weeklyA - AnnuallySA - Semi-annuallyC - Commission |
total_amounts | array of objects | Total amount of earnings for user income in summary, may contain multiple amounts with each amount denominated in single currency, see Total amounts object |
transaction_count | integer | Number of income transactions per end user for specific source |
historical_summary | array of objects | List of bank statements for each period, see Historical summary object |
Historical summary object
The table below contains the attributes from the Historical summary object.
Attribute | Type | Description |
---|---|---|
start_date | date | Start date of period covered in specific monthly summary, value is set to first day of month unless covered month is partial NOTE: Partial months are the first month included in the summary when the requested date range does not begin with the first day of the month. |
end_date | date | End date of period included in specific monthly summary, value is set to last day of the month unless covered month is partial NOTE: Partial months are the last month included in the summary when the requested date range does not end with the last day of the month. |
total_amounts | array of objects | Total amount of earnings for user income in summary, may contain multiple amounts with each amount denominated in single currency, see Total amounts object |
transactions | array of objects | List of transactions, see Transactions object |
Total amounts object
The attributes in the Total amounts object are in the table below.
Attribute | Type | Description |
---|---|---|
amount | string | Value of amount, up to 2 decimal places |
iso_currency_code | string | ISO 4217 currency code of amount or balance |
Transactions object
View information about the attributes in the Income object below.
Attribute | Type | Description |
---|---|---|
amount | string | Settled value of transaction, denominated in transactions currency as stated in iso_currency_code , positive value when money moves out of account and negative otherwise. |
iso_currency_code | string | ISO 4217 currency code of amount or balance |
date | date | Date transaction occurred |
check_number | string | Check number for transaction |
description | string | Human-readable transaction description |
pending | Boolean | Status of transaction as pending or not set |
transaction_id | string | Unique identifier of transaction |
Summary object
View information about the attributes in the Summary object below.
Attribute | Type | Description |
---|---|---|
start_date | date | Minimum of all dates between income sources in user bank accounts for days requested by client |
end_date | date | Maximum of all dates between income sources in user bank accounts for days requested by client |
income_sources_count | integer | Number of income sources per end user |
income_categories_count | integer | Number of income categories per end user |
income_transactions_count | integer | Number of income transactions per end user |
total_amounts | array of objects | Total amount of earnings for user income in summary, may contain multiple amounts with each amount denominated in single currency, see Total amounts object |
Endpoints
View more information about the available endpoints below.
Example response
The JSON sample below is from the bank income response.
{
"status": "success",
"completed_at": "2022-05-04T11:30:00Z",
"days_requested": 61,
"tracking_info": "string",
"provider": "string",
"access_token": "99dd17074ac94aa9ace2621d657c7610",
"companies": [
"string"
],
"accounts": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T12:00:00Z",
"type": "CHECKING",
"subtype": "MONEY_MARKET",
"mask": "string",
"nickname": "My account"
}
],
"income": [
{
"start_date": "2022-05-04",
"end_date": "2022-05-04",
"account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
"income_description": "Paycheck",
"income_category": "Income: Paycheck",
"pay_rate": 0,
"pay_frequency": "SM",
"total_amounts": [
{
"amount": "200.31",
"iso_currency_code": "USD"
}
],
"transaction_count": 7,
"historical_summary": [
{
"start_date": "2022-05-04",
"end_date": "2022-05-04",
"total_amounts": [
{
"amount": "200.31",
"iso_currency_code": "USD"
}
],
"transactions": [
{
"amount": "200.31",
"iso_currency_code": "USD",
"date": "2022-05-04",
"check_number": "string",
"description": "string",
"pending": true,
"transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
]
}
],
"summary": {
"start_date": "2022-05-04",
"end_date": "2022-05-04",
"income_sources_count": 2,
"income_categories_count": 1,
"income_transactions_count": 17,
"total_amounts": [
{
"amount": "200.31",
"iso_currency_code": "USD"
}
]
},
"is_suspicious": false
}