v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Linked Bank Accounts

List User Linked Bank Accounts

Retrieves a list of User Linked Bank Accounts by userID.

get/users/{userID}/bank-accounts

Path parameters

userIDstring required

Unique ID of the User to fetch their stored bank accounts.

Response

Retrieving a list of User Linked Bank Accounts was Successful.

idstring

The unique DriveWealth identifier that identifies each linked bank account.

defaultstring

True, if this is the default bank account set by the customer.

status'ACTIVE' | 'DELETED' | 'DISABLED'

The current status of the user's external linked bank account.

createdstring

updatedstring

Example response

[
  {
    "id": "bank_a4656e60-321e-425b-aa0d-a2e75c38885f",
    "bankAccountDetails": {
      "bankAccountNickName": "PREFERRED CHECKING",
      "bankAccountNumber": "****3174",
      "bankRoutingNumber": "110000000"
    },
    "status": "ACTIVE",
    "created": "2022-12-11T22:28:21.810Z",
    "updated": "2022-12-11T22:28:21.810Z"
  }
]