v4

OpenAPI 3.0.12026-07-3189233676.2 KB

VOA Reports

Retrieve an assets report

The endpoint retrieves an assets report for the user.

get/v1/users/{user_id}/assets/reports/{report_id}/

Query parameters

fmt'json' | 'pdf'

Response format

Response

report_idstring required

Unique identifier of the report.

created_atstring date-time required

Timestamp when the report was created.

completed_atstring date-time required

Timestamp when the report was completed.

days_requestedinteger required

Number of days for which transactions are requested.

as_of_datestring 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.

large_deposit_thresholdinteger nullable required

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

is_voeboolean required

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

Example response

{
  "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,
  "borrower": {
    "id": "24d7e80942ce4ad58a93f70ce4115f5c",
    "external_user_id": "12345",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "+14155554193",
    "ssn": "*****3333",
    "created_at": "2022-05-04T11:30:00Z",
    "updated_at": "2022-05-04T12:00:00Z"
  },
  "links": [
    {
      "link_id": "150491a20bdb4292bb2a2ad8554fecba",
      "accounts": [
        {
          "id": "4d601895417c46ec99633978db12a866",
          "created_at": "2022-05-04T11:30:00Z",
          "updated_at": "2022-05-04T12:00:00Z",
          "routing_number": "55999876",
          "days_available": 365,
          "balance_as_of": "2025-05-04T12:00:00Z",
          "transactions": [
            {
              "id": "7d4fcb86b81a4880955beea558092391",
              "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
            }
          ],
          "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"
            }
          ]
        }
      ]
    }
  ]
}