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_requestedint32Number of days for requested transactions
borrowerobjectBorrow information, see Borrower object
linksarray of objectsList of employment links, see Links object
summaryarray of objectsBalance 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
providerstringData provider ID
identitiesarray of objectsList of person's identity information, see Identities object
accountsarray of objectsList of assets accounts, see Accounts object

Identities object

The values below are references for the identities object.

AttributeTypeDescription
idstringID of object
created_atstringISO 8601 value for first time retrieving person's identity info
updated_atstringISO 8601 value for last time retrieving person's identity info
first_namestringFirst name
last_namestringLast name
full_namestringFull name
middle_initialsstringMiddle initials
emailstringEmail address
ssnstringSocial Security Number, full or last 4 digits
date_of_birthdateDate of birth
home_addressobjectHome address, see Address object

Address object

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

AttributeTypeDescription
streetstringStreet
citystringCity
statestringState
zipstringZip
countrystringCountry

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
nicknamestringAlternate name for account
days_availableintegerAvailable number of days for transactions from days_requested
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

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
transacted_atdate-timeTimestamp when transaction took place
merchant_category_codeint32ISO 18245 category code for transaction

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, see Address object

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2022-05-04T11:30:00Z",
  "completed_at": "2022-05-04T12:00:00Z",
  "days_requested": 61,
  "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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tracking_info": "string",
      "provider": "string",
      "identities": [
        {
          "id": "48427a36d43c4d5aa6324bc06c692456",
          "created_at": "2022-06-07T15:00:00Z",
          "updated_at": "2022-06-31T15:00:00Z",
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "middle_initials": "K",
          "email": "[email protected]",
          "ssn": "123456789",
          "date_of_birth": "1992-03-03",
          "home_address": {
            "street": "1 Morgan Ave",
            "city": "Los Angeles",
            "state": "CA",
            "zip": "90210",
            "country": "US"
          }
        }
      ],
      "accounts": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "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,
          "balances": {
            "currency_code": "string",
            "balance": "string",
            "available_balance": "string",
            "credit_limit": "string"
          },
          "transactions": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "external_id": "string",
              "amount": "string",
              "currency_code": "string",
              "check_number": "string",
              "categories": [
                "string"
              ],
              "description": "string",
              "status": "POSTED",
              "type": "DEBIT",
              "transacted_at": "2022-05-04T12:00:00Z",
              "merchant_category_code": 0,
              "ending_daily_balance": "string"
            }
          ],
          "owners": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "full_name": "string",
              "email": "[email protected]",
              "phone": "string",
              "address": {
                "street": "1 Morgan Ave",
                "city": "Los Angeles",
                "state": "CA",
                "zip": "90210",
                "country": "US"
              }
            }
          ],
          "summary": {
            "avg_30": "string",
            "avg_60": "string",
            "avg_90": "string",
            "currency_code": "string"
          }
        }
      ]
    }
  ],
  "summary": {
    "avg_30": "string",
    "avg_60": "string",
    "avg_90": "string",
    "currency_code": "string"
  }
}