Skip to main content
POST
Create an assets report

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

user_id
string
required

Body

application/json

Verification of Assets report parameters.

days_requested
integer
default:60

The specific duration in days for which the report is requested to be generated.

Required range: 30 <= x <= 730
as_of_date
string<date>

The end date for the report period. Start date will be calculated as as_of_date - days_requested. Defaults to current date if not provided.

Example:

"2024-01-01"

large_deposit_threshold
object
is_voe
boolean
default:false

A boolean parameter to request a deposit based Verification of Employment report.

account_ids
string[]

List of bank account IDs to include in VOA report. All accounts will be included if not set.

Required array length: 1 - 100 elements
Maximum string length: 32

Response

report_id
string
required
read-only

Unique identifier of the report.

Maximum string length: 32
Example:

"7d4fcb86b81a4880955beea558092391"

created_at
string<date-time>
required
read-only

Timestamp when the report was created.

Example:

"2022-05-04T11:30:00Z"

completed_at
string<date-time>
required
read-only

Timestamp when the report was completed.

Example:

"2022-05-04T12:00:00Z"

days_requested
integer<int32>
required
read-only

Number of days for which transactions are requested.

Example:

60

large_deposit_threshold
integer<int32> | null
required
read-only

Amount that must be met or exceeded for deposits to be marked as large.

Example:

500

is_voe
boolean
required
read-only

Indicates whether the report is a Deposit-based Verification of Employment (DVOE).

borrower
object
required

List of assets links

summary
object
required
as_of_date
string<date>
read-only

The end date for the report period. Start date will be calculated as as_of_date - days_requested. Defaults to current date if not provided.

Example:

"2022-05-01"