Data Reference for Financial Account Aggregation
View the reference data for verifying identity, accounts, transactions, and asset information.
Overview
The sections below cover each of the data values for identity and transactions endpoints. Use the transactions endpoint and identity endpoint to collect the data.
Data structure
Example responses
The JSON samples below contain a set of comprehensive responses.
Identity
The response below covers identification values.
{
"id": "383cac95017d451ba0e353684c521c66",
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"middle_initials": null,
"email": "[email protected]",
"ssn": null,
"date_of_birth": null,
"home_address": {
"zip": "94062",
"city": "Redwood City",
"state": "CA",
"street": "35 Dry Ridge Rd",
"country": "US"
}
}
Accounts and transactions
These values contain information for the user's accounts and transactions.
{
"count": 10,
"next": "https://prod.truv.com/v1/link/0000000000/transactions?page=2",
"previous": "https://prod.truv.com/v1/link/0000000000/transactions?page=1",
"accounts": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T12:00:00Z",
"type": "CHECKING",
"subtype": "",
"mask": "6789",
"nickname": "My account",
"balances": {
"currency_code": "USD",
"balance": "100.00"
}
}
],
"transactions": [
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T12:00:00Z",
"account_id": "68a7e80942ce4ad58a93f70ce411549a",
"external_id": "external_key_243901",
"amount": "100.00",
"currency_code": "USD",
"check_number": "123456",
"categories": [
"Transfer"
],
"description": "Some transaction",
"status": "POSTED",
"type": "DEBIT",
"posted_at": "2022-05-04T11:30:00Z",
"transacted_at": "2022-05-04T11:30:00Z",
"memo": "",
"merchant_category_code": 5967,
"location": {
"latitude": "13.45",
"longitude": "12.34"
}
}
]
}
Identity data
The table below is a summary of personal employee information from the payroll provider.
Name | Type | Description |
---|---|---|
first_name | string | First name |
last_name | string | Last name |
middle_initials | string (nullable) | Middle initials |
ssn | string (nullable) | Social Security Number, full or last 4 digits |
string(email) (nullable) | Personal or work email address | |
date_of_birth | string(date) (nullable) | Date of birth |
home_address | object (nullable) | Home address |
street | string (nullable) | Street |
city | string (nullable) | City |
state | string (nullable) | State |
zip | string (nullable) | Zip code |
Accounts data
This field covers bank account information from connected bank accounts.
Name | Type | Description |
---|---|---|
id | string | Unique ID for the account |
created_at | string | Timestamp of when account data was pulled |
updated_at | string | Date and time for when account was most recently updated |
external_id | string (nullable) | Unique identifier for account at the financial Institution |
type | string (nullable) | General or parent type of the account |
subtype | string (nullable) | Account’s subtype, example PLAN_401_K , MONEY_MARKET , or HOME_EQUITY |
mask | string | Last 4 digits of the account number associated with the account |
nickname | string (nullable) | User friendly account name |
currency_code | string (nullable) | Three-character ISO 4217 currency code |
balance | string (nullable) | Current account balance,PENDING transactions may not be updated with the current balance.Asset-type accounts ( CHECKING , SAVINGS , INVESTMENT ) may have a negative balance if they are marked as overdraft. Debt-type accounts (CREDIT_CARD , LOAN , LINE_OF_CREDIT , MORTGAGE ) may have a negative balance if overpaid. |
available_balance | Balance available in asset accounts, such as checking and savings, PENDING transactions may not be updated with the current balance.All account types have a positive value for available_balance as determined from the balance field. | |
credit_limit | string (nullable) | Credit limit associated with the account |
Account types and subtypes
The tables below contain valid fields and groups for the user's account.
Parent types |
---|
ANY (not provided by data partner or invalid number provided) |
CHECKING |
SAVINGS |
LOAN |
CREDIT_CARD |
INVESTMENT |
LINE_OF_CREDIT |
MORTGAGE |
PROPERTY |
CASH |
INSURANCE |
PREPAID |
CHECKING_LINE_OF_CREDIT |
Subtype | Parent type |
---|---|
MONEY_MARKET | SAVINGS |
CERTIFICATE_OF_DEPOSIT | SAVINGS |
AUTO | LOAN |
STUDENT | LOAN |
SMALL_BUSINESS | LOAN |
PERSONAL | LOAN |
PERSONAL_WITH_COLLATERAL | LOAN |
HOME_EQUITY | LOAN |
PLAN_401_K | INVESTMENT |
PLAN_403_B | INVESTMENT |
PLAN_529 | INVESTMENT |
IRA | INVESTMENT |
ROLLOVER_IRA | INVESTMENT |
ROTH_IRA | INVESTMENT |
TAXABLE | INVESTMENT |
NON_TAXABLE | INVESTMENT |
BROKERAGE | INVESTMENT |
TRUST | INVESTMENT |
UNIFORM_GIFTS_TO_MINORS_ACT | INVESTMENT |
PLAN_457 | INVESTMENT |
PENSION | INVESTMENT |
EMPLOYEE_STOCK_OWNERSHIP_PLAN | INVESTMENT |
SIMPLIFIED_EMPLOYEE_PENSION | INVESTMENT |
SIMPLE_IRA | INVESTMENT |
BOAT | LOAN |
POWERSPORTS | LOAN |
RV | LOAN |
HELOC | LOAN |
PLAN_ROTH_401_K | INVESTMENT |
FIXED_ANNUITY | INVESTMENT |
VARIABLE_ANNUITY | INVESTMENT |
VEHICLE_INSURANCE | INSURANCE |
DISABILITY | INSURANCE |
HEALTH | INSURANCE |
LONG_TERM_CARE | INSURANCE |
PROPERTY_AND_CASUALTY | INSURANCE |
UNIVERSAL_LIFE | INSURANCE |
TERM_LIFE | INSURANCE |
WHOLE_LIFE | INSURANCE |
ACCIDENTAL_DEATH_AND_DISMEMBERMENT | INSURANCE |
VARIABLE_UNIVERSAL_LIFE | INSURANCE |
HSA | INVESTMENT |
TAX_FREE_SAVINGS_ACCOUNT | INVESTMENT |
INDIVIDUAL | INVESTMENT |
REGISTERED_RETIREMENT_INCOME_FUND | INVESTMENT |
CASH_MANAGEMENT_ACCOUNT | INVESTMENT |
EMPLOYEE_STOCK_PURCHASE_PLAN | INVESTMENT |
REGISTERED_EDUCATION_SAVINGS_PLAN | INVESTMENT |
PROFIT_SHARING_PLAN | INVESTMENT |
UNIFORM_TRANSFER_TO_MINORS_ACT | INVESTMENT |
PLAN_401_A | INVESTMENT |
SARSEP_IRA | INVESTMENT |
FIXED_ANNUITY_TRADITIONAL_IRA | INVESTMENT |
VARIABLE_ANNUITY_TRADITIONAL_IRA | INVESTMENT |
SEPP_IRA | INVESTMENT |
INHERITED_TRADITIONAL_IRA | INVESTMENT |
FIXED_ANNUITY_ROTH_IRA | INVESTMENT |
VARIABLE_ANNUITY_ROTH_IRA | INVESTMENT |
INHERITED_ROTH_IRA | INVESTMENT |
COVERDELL | INVESTMENT |
ADVISORY_ACCOUNT | INVESTMENT |
BROKERAGE_MARGIN | INVESTMENT |
CHARITABLE_GIFT_ACCOUNT | INVESTMENT |
CHURCH_ACCOUNT | INVESTMENT |
CONSERVATORSHIP | INVESTMENT |
CUSTODIAL | INVESTMENT |
DEFINED_BENEFIT_PLAN | INVESTMENT |
DEFINED_CONTRIBUTION_PLAN | INVESTMENT |
EDUCATIONAL | INVESTMENT |
ESTATE | INVESTMENT |
EXECUTOR | INVESTMENT |
GROUP_RETIREMENT_SAVINGS_PLAN | INVESTMENT |
GUARANTEED_INVESTMENT_CERTIFICATE | INVESTMENT |
HRA | INVESTMENT |
INDEXED_ANNUITY | INVESTMENT |
INVESTMENT_CLUB | INVESTMENT |
IRREVOCABLE_TRUST | INVESTMENT |
JOINT_TENANTS_BY_ENTIRITY | INVESTMENT |
JOINT_TENANTS_COMMUNITY_PROPERTY | INVESTMENT |
JOINT_TENANTS_IN_COMMON | INVESTMENT |
JOINT_TENANTS_WITH_RIGHTS_OF_SURVIVORSHIP | INVESTMENT |
KEOUGH_PLAN | INVESTMENT |
LIFE_INCOME_FUND | INVESTMENT |
LIVING_TRUST | INVESTMENT |
LOCKED_IN_RETIREMENT_ACCOUNT | INVESTMENT |
LOCKED_IN_RETIREMENT_INVESTMENT_FUND | INVESTMENT |
LOCKED_IN_RETIREMENT_SAVINGS_ACCOUNT | INVESTMENT |
MONEY_PURCHASE_PLAN | INVESTMENT |
PARTNERSHIP | INVESTMENT |
PLAN_409_A | INVESTMENT |
PLAN_ROTH_403_B | INVESTMENT |
REGISTERED_DISABILITY_SAVINGS_PLAN | INVESTMENT |
REGISTERED_LOCKED_IN_SAVINGS_PLAN | INVESTMENT |
REGISTERED_PENSION_PLAN | INVESTMENT |
REGISTERED_RETIREMENT_SAVINGS_PLAN | INVESTMENT |
REVOCABLE_TRUST | INVESTMENT |
ROTH_CONVERSION | INVESTMENT |
SOLE_PROPRIETORSHIP | INVESTMENT |
SPOUSAL_IRA | INVESTMENT |
SPOUSAL_ROTH_IRA | INVESTMENT |
TESTAMENTARY_TRUST | INVESTMENT |
THRIFT_SAVINGS_PLAN | INVESTMENT |
INHERITED_ANNUITY | INVESTMENT |
CORPORATE_ACCOUNT | INVESTMENT |
LIMITED_LIABILITY_ACCOUNT | INVESTMENT |
Transactions
The table below covers transaction history for the connected bank accounts.
Name | Type | Description |
---|---|---|
id | string | Unique ID for the transaction |
created_at | string | Timestamp of when transaction was retrieved |
updated_at | string | Date and time at when transaction was most recently updated |
account_id | string | Unique ID for the account where transaction occurred |
external_id | string (nullable) | Unique identifier of transaction at the financial institution |
amount | string (nullable) | Transaction amount |
currency_code | string (nullable) | Three-character ISO 4217 currency code |
check_number | string (nullable) | Check number associated with transaction |
categories | string | Transaction category, view the complete Transaction category list below |
description | string | Original description of transaction as provided by data provider |
status | string | Transaction status, either POSTED or PENDING |
type | string | Transaction type of transaction, either CREDIT or DEBIT |
posted_at | string | Date and time transaction posted to the account |
transacted_at | string | Date and time transaction took place |
memo | string (nullable) | Additional transaction description |
merchant_category_code | Integer | ISO 18245 transaction category code |
location | object | Location where transaction occurred, contains latitude and longitude |
Transaction categories
The list below contains all valid transaction categories.
- Auto & Transport
- Auto Insurance
- Auto Payment
- Gas
- Parking
- Public Transportation
- Service & Parts
- Bills & Utilities
- Domain Names
- Fraud Protection
- Home Phone
- Hosting
- Internet
- Mobile Phone
- Television
- Utilities
- Business Services
- Advertising
- Legal
- Office Supplies
- Printing
- Shipping
- Education
- Books & Supplies
- Student Loan
- Tuition
- Entertainment
- Amusement
- Arts
- Movies & DVDs
- Music
- Newspapers & Magazines
- Fees & Charges
- ATM Fee
- Banking Fee
- Finance Charge
- Late Fee
- Service Fee
- Trade Commissions
- Financial
- Financial Advisor
- Life Insurance
- Food & Dining
- Alcohol & Bars
- Coffee Shops
- Fast Food
- Groceries
- Restaurants
- Gifts & Donations
- Charity
- Gift
- Health & Fitness
- Dentist
- Doctor
- Eyecare
- Gym
- Health Insurance
- Pharmacy
- Sports
- Home
- Furnishings
- Home Improvement
- Home Insurance
- Home Services
- Home Supplies
- Lawn & Garden
- Mortgage & Rent
- Income
- Bonus
- Interest Income
- Paycheck
- Reimbursement
- Rental Income
- Returned Purchase
- Investments
- Buy
- Deposit
- Dividend & Cap Gains
- Sell
- Withdrawal
- Kids
- Allowance
- Baby Supplies
- Babysitter & Daycare
- Child Support
- Kids Activities
- Toys
- Personal Care
- Hair
- Laundry
- Spa & Massage
- Pets
- Pet Food & Supplies
- Pet Grooming
- Veterinary
- Shopping
- Books
- Clothing
- Hobbies
- Sporting Goods
- Taxes
- Federal Tax
- Local Tax
- Property Tax
- Sales Tax
- State Tax
- Transfer
- Credit Card Payment
- Transfer for Cash Spending
- Mortgage Payment
- Travel
- Air Travel
- Hotel
- Rental Car & Taxi
- Vacation
- Uncategorized
- Cash
- Check
Updated over 1 year ago