> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truv.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The User Asset Reports object

> User-level Verification of Assets (VOA) reports that aggregate asset and financial account data across all account links.

User Reports aggregate asset and financial account data across all of a user's account links into a single report.

# Attributes

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

| Attribute                 | Type               | Description                                                                                                                   |    |
| :------------------------ | :----------------- | :---------------------------------------------------------------------------------------------------------------------------- | -- |
| report\_id                | string             | Unique identifier of the report                                                                                               |    |
| created\_at               | date-time          | Timestamp when report was created                                                                                             |    |
| completed\_at             | date-time          | Timestamp when report was completed                                                                                           |    |
| days\_requested           | integer            | Number of days for requested transactions                                                                                     |    |
| as\_of\_date              | date               | End date of the report period. Start date is as\_of\_date minus days\_requested. Defaults to the current date if not provided | \\ |
| 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 object](#borrower-object)                                                                 |    |
| links                     | array of objects   | List of assets links, see [Links object](#links-object)                                                                       |    |
| summary                   | object             | Balance summary information for account, see [Summary object](#summary-object)                                                |    |

## Borrower object

Information in the table below is for the borrower object.

| Attribute          | 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-object) |

### Accounts object

The table below covers values in the accounts object.

| Attribute                       | Type             | Description                                                                       |
| :------------------------------ | :--------------- | :-------------------------------------------------------------------------------- |
| id                              | string           | Unique identifier of account                                                      |
| created\_at                     | date-time        | Date and time account was created                                                 |
| updated\_at                     | date-time        | Date and time account was most recently updated                                   |
| type                            | string           | Parent type of the account, example `CHECKING` or `SAVINGS`                       |
| subtype                         | string           | Account's subtype, example `PLAN_401_K`, `MONEY_MARKET`, or `HOME_EQUITY`         |
| mask                            | string           | Masked banking account number associated with account                             |
| routing\_number                 | string           | Bank routing number associated with the account                                   |
| nickname                        | string           | Alternate name for account                                                        |
| days\_available                 | integer          | Available number of days for transactions from `days_requested`                   |
| balance\_as\_of                 | date-time        | Timestamp for when balance was captured                                           |
| balances                        | object           | List of balance information from account, see [Balances object](#balances-object) |
| transactions                    | array of objects | List of transactions for account, see [Transactions object](#transactions-object) |
| owners                          | array of objects | List of owners for account, see [Owners object](#owners-object)                   |
| summary                         | object           | Balance summary information for account, see [Summary object](#summary-object)    |
| same\_owner\_as\_requested      | boolean          | Whether account owner matches the requested user                                  |
| direct\_deposit\_from\_employer | boolean          | Whether account has direct deposit from employer                                  |
| nsf                             | integer          | 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 object

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

| Attribute                | Type             | Description                                                            |
| :----------------------- | :--------------- | :--------------------------------------------------------------------- |
| id                       | string           | Unique identifier of transaction                                       |
| external\_id             | string           | External system transaction identifier                                 |
| amount                   | string           | Monetary amount of transaction                                         |
| currency\_code           | string           | Three-character ISO 4217 currency code                                 |
| check\_number            | string           | Check number for transaction                                           |
| categories               | array of strings | List of categories assigned to this transaction                        |
| description              | string           | Human-readable transaction description                                 |
| status                   | string           | Status of transaction: `POSTED`, `PENDING`, `AUTHORIZATION`, or `MEMO` |
| type                     | string           | Type of transaction: `CREDIT`, `DEBIT`, or `MEMO`                      |
| posted\_at               | date-time        | Timestamp when transaction was posted                                  |
| transacted\_at           | date-time        | Timestamp when transaction took place                                  |
| merchant\_name           | string           | Merchant name extracted from the transaction description               |
| merchant\_category\_code | int32            | ISO 18245 category code for transaction                                |
| ending\_daily\_balance   | number           | Daily ending balance for transaction                                   |
| is\_direct\_deposit      | boolean          | Whether transaction is direct deposit                                  |
| is\_subscription         | boolean          | Whether transaction is subscription                                    |

#### Owners object

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

| Attribute      | Type   | Description                                                      |
| :------------- | :----- | :--------------------------------------------------------------- |
| id             | string | ID of owner                                                      |
| full\_name     | string | Full name                                                        |
| email          | string | Email address                                                    |
| phone          | string | Phone number                                                     |
| address        | object | Address object with street, city, state, zip, and country fields |
| relation\_type | string | Relationship type for account owner (see below)                  |

##### 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 |
| ACCOUNT\_BENEFICIARY | Beneficiary of the account                 |
| CUSTODIAN            | Custodian of the account                   |
| OTHER                | Other relationship to the account          |

## Account types and subtypes

**Parent types:**

| Type                      | Description                             |
| ------------------------- | --------------------------------------- |
| `ANY`                     | Not provided by data partner or invalid |
| `CHECKING`                | Checking account                        |
| `SAVINGS`                 | Savings account                         |
| `LOAN`                    | Loan account                            |
| `CREDIT_CARD`             | Credit card                             |
| `INVESTMENT`              | Investment account                      |
| `LINE_OF_CREDIT`          | Line of credit                          |
| `MORTGAGE`                | Mortgage                                |
| `PROPERTY`                | Property                                |
| `CASH`                    | Cash account                            |
| `INSURANCE`               | Insurance                               |
| `PREPAID`                 | Prepaid account                         |
| `CHECKING_LINE_OF_CREDIT` | Checking with overdraft line            |

**Subtypes by parent:**

<Accordion title="View all subtypes">
  | 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        |
  | `BOAT`                                      | LOAN        |
  | `POWERSPORTS`                               | LOAN        |
  | `RV`                                        | LOAN        |
  | `HELOC`                                     | 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  |
  | `PLAN_ROTH_401_K`                           | INVESTMENT  |
  | `FIXED_ANNUITY`                             | INVESTMENT  |
  | `VARIABLE_ANNUITY`                          | INVESTMENT  |
  | `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  |
  | `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   |
</Accordion>

#### Summary object

Information in the table below are for the summary object.

| Attribute      | Type   | Description                            |
| :------------- | :----- | :------------------------------------- |
| avg\_30        | string | Average balance for 30 days            |
| avg\_60        | string | Average balance for 60 days            |
| avg\_90        | string | Average balance for 90 days            |
| currency\_code | string | Three-character ISO 4217 currency code |

# Endpoints

Use the endpoints below to manage user-level asset reports.

* [Create an assets report](/api-reference/user-asset-verification-reports/assets-report-create)
* [Retrieve an assets report](/api-reference/user-asset-verification-reports/assets-report-retrieve)

# Example response

The JSON below is a sample response for the endpoint.

```json theme={null}
{
  "report_id": "7d4fcb86b81a4880955beea558092391",
  "created_at": "2022-05-04T11:30:00Z",
  "completed_at": "2022-05-04T12:00:00Z",
  "days_requested": 60,
  "as_of_date": "2022-05-01",
  "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": "john.doe@example.com",
    "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_name": "Starbucks",
              "merchant_category_code": 5967,
              "ending_daily_balance": 0,
              "is_direct_deposit": true,
              "is_subscription": true
            }
          ],
          "owners": [
            {
              "id": "2b623fa2fa9e49cea17d9692caa884c5",
              "full_name": "John Doe",
              "email": "john.doe@example.com",
              "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"
  }
}
```
