Retrieve a deposit switch report

The endpoint retrieves a deposit switch report for a user.

get/v1/users/{user_id}/deposit_switch/report/

Response

completed_atstring date-time nullable required

Timestamp when the report was completed.

Example response

{
  "completed_at": "2022-05-04T11:30:00Z",
  "links": [
    {
      "link_id": "150491a20bdb4292bb2a2ad8554fecba",
      "access_token": "99dd17074ac94aa9ace2621d657c7610",
      "provider": {
        "id": "adp",
        "name": "ADP",
        "supported_bank_account_actions": [
          "create"
        ]
      },
      "employer": {
        "id": "meta",
        "name": "Meta"
      },
      "deposit_details": {
        "account_number": "16002600",
        "account_type": "checking",
        "routing_number": "123456789",
        "bank_name": "TD Bank",
        "deposit_type": "entire",
        "deposit_value": "50.00"
      },
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z"
    }
  ]
}

Changes

Changed in 1 of the 12 revisions of this API.6

Jul 26, 2026e58688835e256See the full diff
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ▲
  the response property /// became optional for the status
  response-property-became-optional
- ▲
  the /// response property's maxLength was increased from 128 to 255 for the response status
  response-property-max-length-increased

Full history