Skip to main content
Object The connected external bank account

​
Fields

​
id
required
Unique identifier for the external bank account
​
accountNumber
required
Last four digits of the account number
​
routingNumber
required
Bank routing number
​
nickname
required
Display name for the external bank account
​
type
required
Type of bank account (Checking or Savings)
​
verificationStatus
required
Current verification status of the external account
​
accountStatus
required
Current status of the external account (Active or Inactive)
​
nameOnAccount
required
Name on the external bank account
​
usersWithAccess
required
Users who have been granted access to this external bank account
{
  "id": "72ef289d-77d4-4696-8a08-da83ed15b751",
  "accountNumber": "xyz789",
  "routingNumber": "abc123",
  "nickname": "xyz789",
  "type": "CHECKING",
  "verificationStatus": "UNVERIFIED",
  "accountStatus": "ACTIVE",
  "nameOnAccount": "abc123",
  "usersWithAccess": [
    User
  ]
}