Overview

The sections below cover each of the data values for borrower, accounts, and asset verification endpoints. Use the VOA Reports endpoints to collect the asset verification data.

Data structure

Report-level data
Borrower data
Accounts data
Transactions data
Owners data
Asset verification summary

Example responses

The JSON samples below contain a set of comprehensive responses.

Accounts and balances for asset verification

These values contain information for the user's accounts and their balances for asset verification.

{
  "report_id": "7d4fcb86b81a4880955beea558092391",
  "created_at": "2022-05-04T11:30:00Z",
  "completed_at": "2022-05-04T12:00:00Z",
  "days_requested": 60,
  "large_deposit_threshold": 500,
  "is_voe": true,
  "borrower": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "external_user_id": "12345",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "+14155554193",
    "ssn": "222233333",
    "created_at": "2022-05-04T11:30:00Z",
    "updated_at": "2022-05-04T12:00:00Z"
  },
  "links": [
    {
      "link_id": "150491a20bdb4292bb2a2ad8554fecba",
      "tracking_info": "string",
      "provider": "string",
      "provider_name": "string",
      "accounts": [
        {
          "id": "4d601895417c46ec99633978db12a866",
          "created_at": "2022-05-04T11:30:00Z",
          "updated_at": "2022-05-04T12:00:00Z",
          "type": "string",
          "subtype": "string",
          "mask": "string",
          "routing_number": "55999876",
          "nickname": "string",
          "days_available": 0,
          "balance_as_of": "2025-05-04T12:00:00Z",
          "balances": {
            "currency_code": "string",
            "balance": "string",
            "available_balance": "string",
            "credit_limit": "string"
          },
          "transactions": [
            {
              "id": "7d4fcb86b81a4880955beea558092391",
              "external_id": "string",
              "amount": "string",
              "currency_code": "string",
              "check_number": "string",
              "categories": [
                "string"
              ],
              "description": "string",
              "status": "POSTED",
              "type": "DEBIT",
              "posted_at": "2022-05-05T15:30:00Z",
              "transacted_at": "2022-05-04T12:00:00Z",
              "merchant_category_code": 0,
              "ending_daily_balance": 0,
              "is_direct_deposit": true,
              "is_subscription": true
            }
          ],
          "owners": [
            {
              "id": "2b623fa2fa9e49cea17d9692caa884c5",
              "full_name": "John Doe",
              "email": "[email protected]",
              "phone": "14155554193",
              "address": {
                "street": "1 Morgan Ave",
                "city": "Los Angeles",
                "state": "CA",
                "zip": "90210",
                "country": "US"
              },
              "relation_type": "PRIMARY"
            }
          ],
          "summary": {
            "avg_30": "string",
            "avg_60": "string",
            "avg_90": "string",
            "currency_code": "string",
            "balance": "string"
          },
          "same_owner_as_requested": true,
          "direct_deposit_from_employer": true,
          "nsf": 0
        }
      ]
    }
  ],
  "summary": {
    "avg_30": "string",
    "avg_60": "string",
    "avg_90": "string",
    "currency_code": "string",
    "balance": "string"
  }
}

Report-level data

The table below covers the main report information from VOA reports.

Name	Type	Description
report_id	string	Unique identifier of the report
created_at	string(date-time)	Timestamp when report was created
completed_at	string(date-time)	Timestamp when report was completed
days_requested	integer	Number of days for requested transactions
large_deposit_threshold	integer (nullable)	Amount that must be met or exceeded for deposits to be marked as large
is_voe	boolean	Indicates whether the report is a Deposit-based Verification of Employment (DVOE)
borrower	object	Borrower information, see Borrower data section
links	array of objects	List of assets links, see Links object
summary	object	Balance summary information for account, see Asset verification summary section

Borrower data

The table below covers borrower information from VOA reports.

Name	Type	Description
id	string	Unique ID of user
external_user_id	string	External user ID
first_name	string	First name
last_name	string	Last name
email	string	Email address
phone	string	Phone number
ssn	string	Social Security Number
created_at	date-time	Timestamp when user was created
updated_at	date-time	Timestamp when user was last updated

Links object

The information in this table is for values in the Links object.

Attribute	Type	Description
link_id	string	Unique identifier of the link
tracking_info	string	Additional optional identifier passed by user
provider	string	ID of the financial institution
provider_name	string	Name of the financial institution
accounts	array of objects	List of assets accounts, see Accounts object

Accounts data

This field covers bank account information from connected bank accounts for asset verification.

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 account was most recently updated
type	string (nullable)	General or parent type of the account, example `CHECKING` or `SAVINGS`
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
routing_number	string (nullable)	Bank routing number associated with the account
nickname	string (nullable)	User friendly account name
balance_as_of	string(date-time) (nullable)	Timestamp for when balance was captured
balances	object	List of balance information from account, see Balances object
transactions	array of objects	List of transactions for account, see Transactions object
owners	array of objects	List of owners for account, see Owners object
summary	object	Balance summary information for account, see Asset verification summary section
same_owner_as_requested	boolean (nullable)	Whether account owner matches the requested user
direct_deposit_from_employer	boolean (nullable)	Whether account has direct deposit from employer
nsf	integer (nullable)	NSF (Non-sufficient funds) count

Balances object

The information in the table below refers to values in the balances object.

Attribute	Type	Description
currency_code	string	Three-character ISO 4217 currency code
balance	string	Current account balance
available_balance	string	Available balance for use in checking and savings asset accounts, `PENDING` transactions may not reflect available balance
credit_limit	string	Credit limit associated with account

Transactions data

The table below covers transaction information from connected bank accounts for asset verification.

Name	Type	Description
id	string	Unique identifier of transaction
external_id	string (nullable)	External system transaction identifier
amount	string	Monetary amount of transaction
currency_code	string (nullable)	Three-character ISO 4217 currency code
check_number	string (nullable)	Check number for transaction
categories	array of strings (nullable)	List of categories assigned to this transaction
description	string (nullable)	Human-readable transaction description
status	string	Status of transaction, either `POSTED` or `PENDING`
type	string	Type of transaction, either `CREDIT` or `DEBIT`
posted_at	string(date-time) (nullable)	Timestamp when transaction was posted
transacted_at	string(date-time) (nullable)	Timestamp when transaction took place
merchant_category_code	integer (nullable)	ISO 18245 category code for transaction
ending_daily_balance	number (nullable)	Daily ending balance for transaction
is_direct_deposit	boolean (nullable)	Whether transaction is direct deposit
is_subscription	boolean (nullable)	Whether transaction is subscription

Owners data

The table below covers account owner information from connected bank accounts for asset verification.

Name	Type	Description
id	string	ID of owner
full_name	string (nullable)	Full name
email	string (nullable)	Email address
phone	string (nullable)	Phone number
address	object (nullable)	Address object with street, city, state, zip, and country fields
relation_type	string (nullable)	Relationship type for account owner (e.g., PRIMARY)

Relation types

The table below contains valid relation types for account owners.

Relation Type	Description
PRIMARY	Primary account holder
BUSINESS	Business account relationship
JOINT	Joint account holder
SECONDARY	Secondary account holder
AUTHORIZED_USER	Authorized user on the account
FOR_BENEFIT_OF	Account held for benefit of another person

Asset verification summary

The table below covers asset verification summary data that aggregates balance information over different time periods.

Name	Type	Description
avg_30	string	Average balance over the last 30 days
avg_60	string	Average balance over the last 60 days
avg_90	string	Average balance over the last 90 days
currency_code	string	Three-character ISO 4217 currency code

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