Skip to main content
GET
Get External Accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

businessId
string
required

The unique identifier for the business

Response

List of external accounts linked to a business

id
string

Unique identifier for the external account

Example:

"d43eaff3-bc75-44f6-ac37-3a305192ead6"

last4
string

Last 4 digits of the account number

Example:

"0000"

bankName
string

Name of the bank

Example:

"Example Bank"

status
string

Status of the external account

Example:

"ACTIVE"

hostedVerificationUrl
string

URL for hosted verification if required

provider
string

Provider of the external account link

Example:

"PLAID"