VOA Reports

View reference information from Verification of Assets (VOA) reports.

Verification of Assets (VOA) reports contain information from the user’s accounts. Learn more below about the data provided from reports.

Attributes

The tables below have the values, format, and descriptions for the responses.

AttributeTypeDescription
report_idstringUnique identifier of the report
created_atdate-timeTimestamp when report was created
completed_atdate-timeTimestamp when report was completed
days_requestedintegerNumber of days for requested transactions
large_deposit_thresholdinteger (nullable)Amount that must be met or exceeded for deposits to be marked as large
is_voebooleanIndicates whether the report is a Deposit-based Verification of Employment (DVOE)
borrowerobjectBorrower information, see Borrower object
linksarray of objectsList of assets links, see Links object
summaryobjectBalance summary information for account, see Summary object

Borrower object

Information in the table below is for the borrower object.

AttributeTypeDescription
idstringUnique ID of user
external_user_idstringExternal user ID
first_namestringFirst name
last_namestringLast name
emailstringEmail address
phonestringPhone number
ssnstringSocial Security Number
created_atdate-timeTimestamp when user was created
updated_atdate-timeTimestamp when user was last updated

Links object

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

AttributeTypeDescription
link_idstringUnique identifier of the link
tracking_infostringAdditional optional identifier passed by user
providerstringID of the financial institution
provider_namestringName of the financial institution
accountsarray of objectsList of assets accounts, see Accounts object

Accounts object

The table below covers values in the accounts object.

AttributeTypeDescription
idstringUnique identifier of account
created_atdate-timeDate and time account was created
updated_atdate-timeDate and time account was most recently updated
typestringParent type of the account, example CHECKING or SAVINGS
subtypestringAccount's subtype, example PLAN_401_K, MONEY_MARKET, or HOME_EQUITY
maskstringMasked banking account number associated with account
routing_numberstringBank routing number associated with the account
nicknamestringAlternate name for account
days_availableintegerAvailable number of days for transactions from days_requested
balance_as_ofdate-timeTimestamp for when balance was captured
balancesobjectList of balance information from account, see Balances object
transactionsarray of objectsList of transactions for account, see Transactions object
ownersarray of objectsList of owners for account, see Owners object
summaryarray of objectsBalance summary information for account, see Summary object
same_owner_as_requestedbooleanWhether account owner matches the requested user
direct_deposit_from_employerbooleanWhether account has direct deposit from employer
nsfintegerNSF (Non-sufficient funds) count

Balances object

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

AttributeTypeDescription
currency_codestringThree-character ISO 4217 currency code
balancestringCurrent account balance
available_balancestringAvailable balance for use in checking and savings asset accounts, PENDING transactions may not reflect available balance
credit_limitstringCredit limit associated with account

Transactions object

The values for the transactions object are in the table below.

AttributeTypeDescription
idstringUnique identifier of transaction
external_idstringExternal system transaction identifier
amountstringMonetary amount of transaction
currency_codestringThree-character ISO 4217 currency code
check_numberstringCheck number for transaction
categoriesarray of stringsList of categories assigned to this transaction
descriptionstringHuman-readable transaction description
statusstringStatus of transaction, either POSTED or PENDING
typestringType of transaction, either CREDIT or DEBIT
posted_atdate-timeTimestamp when transaction was posted
transacted_atdate-timeTimestamp when transaction took place
merchant_category_codeint32ISO 18245 category code for transaction
ending_daily_balancenumberDaily ending balance for transaction
is_direct_depositbooleanWhether transaction is direct deposit
is_subscriptionbooleanWhether transaction is subscription

Owners object

The values in this table are for the address object of the company.

AttributeTypeDescription
idstringID of owner
full_namestringFull name
emailstringEmail address
phonestringPhone number
addressobjectAddress object with street, city, state, zip, and country fields
relation_typestringRelationship type for account owner (see below)
Relation types

The table below contains valid relation types for account owners.

Relation TypeDescription
PRIMARYPrimary account holder
BUSINESSBusiness account relationship
JOINTJoint account holder
SECONDARYSecondary account holder
AUTHORIZED_USERAuthorized user on the account
FOR_BENEFIT_OFAccount held for benefit of another person

Summary object

Information in the table below are for the summary object.

AttributeTypeDescription
avg_30stringAverage balance for 30 days
avg_60stringAverage balance for 60 days
avg_90stringAverage balance for 90 days
currency_codestringThree-character ISO 4217 currency code

Endpoints

View more information about the available endpoints for VOA reports below.

Example response

The JSON below is a sample response for the endpoint.

{
  "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"
  }
}