Ctrl+K

Admin list bank accounts

get/api/accounts/v1/admin/bankaccounts

Admin endpoint to list bank accounts.

Query Parameters

  • bankAccountIdarray[string]
    Min length: >= 1 characters
  • idHasharray[string]
    Min length: >= 1 characters
  • enterpriseIdarray[string]
    Min length: >= 1 characters
  • typestring
    Enum: wire cbit ach blinc swift sepa
  • verificationStatestring
    Enum: approved rejected pending removed revise flaggedBrokerage trustVerification trustVerificationUpdated trustNameVerification ownerNameMismatch requiresScreening preapprovedRoutingNumber screeningFailed screeningApproved
  • namestring
    Min length: >= 1 characters
  • routingNumberstring
    Min length: >= 1 characters
  • accountNumberstring
    Min length: >= 1 characters
  • swiftCodestring
    Min length: >= 1 characters
  • externalIdstring
    Min length: >= 1 characters
  • bitgoOrgstring
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo Sister Trust 1
  • trustOrgstring
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo Sister Trust 1
  • testingPropPayalstring
    Min length: >= 1 characters
  • pageSizestring<integer>
  • pageNumberstring<integer>
  • sortFieldstring
    Enum: updatedAt createdAt
  • sortDirectionstring
    Enum: ASC DESC

200 Response

bankAccountsrequired
jxOmnibus boolean required
virtualDepositOnly boolean required
Whether this account is for virtual deposits only
comments string
Min length: >= 1 characters
type string required
Allowed value: wire
routingNumber string required
accountType
string or null
required
Allowed values: checking saving unknown
id string required
Unique identifier for the bank account
Min length: >= 1 characters
idHash string required
Hashed identifier for the bank account
Min length: >= 1 characters
currency string required
The currency of the bank account
Allowed values: fiatusd fiateur fiatsgd fiataed tfiatusd tfiateur tfiatsgd tfiataed
token string required
Authentication token for bank account operations
Min length: >= 1 characters
name string required
Name of the bank account
Min length: >= 1 characters
shortCountryCode string required
Two-letter ISO country code
Min length: >= 1 characters
accountNumber string required
Bank account number (may be masked)
Min length: >= 1 characters
enterpriseId string required
ID of the enterprise the account belongs to
trustOrg string required
Trust organization associated with this account
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo Sister Trust 1
ownerName string required
Name of the account owner
Min length: >= 1 characters
verificationState string required
Current verification status of the account
Allowed values: approved rejected pending removed revise
createdAt string <date-time>required
Timestamp when the account was created
pendingActivityOne of
Any pending activity on the account
Allowed values: flaggedBrokerage trustVerification trustVerificationUpdated trustNameVerification ownerNameMismatch
fee object
Fee information for the account
feeInfoOne of
Detailed fee configuration for the account
furtherCreditTo string
Further credit recipient information
intermediaryBankName string
Name of intermediary bank if applicable
intermediaryBankId string
Identifier of the intermediary bank
metadata string
Additional metadata for the account
description string
User-provided description of the account
ownerAddressLine1
string or null
First line of owner's address (street number and name)
ownerAddressLine2
string or null
Second line of owner's address (apartment/suite number, etc.)
ownerAddressCityLocality
string or null
City or locality of owner's address
ownerAddressStateProvince
string or null
State or province of owner's address
ownerAddressPostalCode
string or null
Postal code of owner's address
ownerAddressCountryCode
string or null
Two-letter ISO country code of owner's address
bankAddressLine1
string or null
First line of bank's address (street number and name)
bankAddressLine2
string or null
Second line of bank's address (branch information, etc.)
bankAddressCityLocality
string or null
City or locality of bank's address
bankAddressStateProvince
string or null
State or province of bank's address
bankAddressPostalCode
string or null
Postal code of bank's address
bankAddressCountryCode
string or null
Two-letter ISO country code of bank's address, should equal shortCountryCode
owner object deprecated
DEPRECATED - Use normalized address fields instead
address string deprecated
DEPRECATED - Use normalized bank address fields instead
Min length: >= 1 characters
ownerAddress string deprecated
DEPRECATED - Use normalized owner address fields instead
Min length: >= 1 characters
address1 string deprecated
DEPRECATED - Use ownerAddressLine1 instead
address2 string deprecated
DEPRECATED - Use ownerAddressLine2 instead
address3 string deprecated
DEPRECATED - Use additional normalized address fields instead

400 Response

errorName string required
error string required

401 Response

errorName string required
error string required

403 Response

errorName string required
error string required

404 Response

errorName string required
error string required

500 Response

errorName string required
error string required