Skip to main content
GET
Retrieve an assets report

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Path Parameters

report_id
string
required
user_id
string
required

Query Parameters

fmt
enum<string>
default:json

Response format

Available options:
json,
pdf

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"