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.
Attribute | Type | Description |
---|---|---|
report_id | string | Unique identifier of the report |
created_at | date-time | Timestamp when the report was created |
completed_at | date-time | Timestamp when the report was completed |
days_requested | int32 | Number of days for requested transactions |
links | array of objects | List of employment links, see Links object |
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 | Data provider ID |
identities | array of objects | List of person's identity information, see Identities object |
accounts | array of objects | List of assets accounts, see Accounts object |
Identities object
The values below are references for the identities object.
Attribute | Type | Description |
---|---|---|
id | string | ID of object |
created_at | string | ISO 8601 value for first time retrieving person's identity info |
updated_at | string | ISO 8601 value for last time retrieving person's identity info |
first_name | string | First name |
last_name | string | Last name |
full_name | string | Full name |
middle_initials | string | Middle initials |
string | Email address | |
ssn | string | Social Security Number, full or last 4 digits |
date_of_birth | date | Date of birth |
home_address | object | Home address |
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 |
nickname | string | Alternate name for account |
days_available | integer | Available number of days for transactions from days_requested |
balances | object | List of balance information from account, see Balances object |
transactions | array of objects | List of transactions for account, see Transactions object |
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, either POSTED or PENDING |
type | string | Type of transaction, either CREDIT or DEBIT |
transacted_at | date-time | Timestamp when transaction took place |
merchant_category_code | int32 | ISO 18245 category code for transaction |
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,
"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",
"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
}
]
}
]
}
]
}