GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
API Reference
v2023-09-01 is in the deprecation process and all prior versions have been deprecated. Click this banner to review our version upgrade guide.

Get all company bank accounts

Returns company bank accounts. Currently, we only support a single default bank account per company.

scope: company_bank_accounts:read

Path Params
string
required

The UUID of the company

Headers
string
Defaults to 2024-04-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Responses

Response body
array of objects
object
string
required

UUID of the bank account

string

UUID of the company

string

Bank account type

Checking Savings

string

The bank account's routing number

string

Masked bank account number

string

The verification status of the bank account.

'awaiting_deposits' means the bank account is just created and money is being transferred.
'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint.
'verified' means the bank account is verified.

awaiting_deposits ready_for_verification verified

string

The verification type of the bank account.

'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits.
'plaid' means the bank account is connected through Plaid.

bank_deposits plaid plaid_external

string | null

The Plaid connection status of the bank account. Only applies when verification type is Plaid.

connected disconnected

string | null

The last fetch balance for the bank account. Please be aware that this amount does not reflect the most up-to-date balance and only applies when the verification type is Plaid.

string | null

The balance fetch date associated with the last_cached_balance. Only applies when verification type is Plaid.

string

Name of bank account

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language
Credentials