Ctrl+K

Add bank account

post/api/v2/bankaccounts

Add a bank account to a BitGo enterprise so you can deposit and withdraw fiat.

Request Body

One of
type string required
Must be 'wire' for domestic wire accounts
Allowed value: wire
routingNumber string required
Routing number for the domestic wire account
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
Min length: >= 1 characters
enterpriseId string
ID of the enterprise the account belongs to
Min length: >= 1 characters
currency string required
The currency of the bank account
Allowed values: fiatusd fiateur fiatsgd fiataed tfiatusd tfiateur tfiatsgd tfiataed
ownerName string required
Name of the account owner
Min length: >= 1 characters
accountType string
Type of bank account (checking, saving, etc.)
Allowed values: checking saving unknown
description string
User-provided description of the account
furtherCreditTo string
Further credit recipient information
intermediaryBankName string
Name of intermediary bank if applicable
intermediaryBankId string
Identifier of the intermediary bank
ownerAddressLine1 string
First line of owner's address (street number and name)
ownerAddressLine2 string
Second line of owner's address (apartment/suite number, etc.)
ownerAddressCityLocality string
City or locality of owner's address
ownerAddressStateProvince string
State or province of owner's address
ownerAddressPostalCode string
Postal code of owner's address
ownerAddressCountryCode string
Two-letter ISO country code of owner's address
bankAddressLine1 string
First line of bank's address (street number and name)
bankAddressLine2 string
Second line of bank's address (branch information, etc.)
bankAddressCityLocality string
City or locality of bank's address
bankAddressStateProvince string
State or province of bank's address
bankAddressPostalCode string
Postal code of bank's address
bankAddressCountryCode string
Two-letter ISO country code of bank's address

200 Response

One of
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
amount string
Min length: >= 1 characters
individualFeesrequired
feeInfoOne of
Detailed fee configuration for the account
coin string required
Allowed values: fiatusd fiateur fiatsgd fiataed tfiatusd tfiateur tfiatsgd tfiataed
bank string required
Allowed values: silvergate silvergate_prime silvergate_v3 silvergate_prime_v3 bcbgroup signature generic customers_api customers_cubix_api customers_sftp lead
type string required
Allowed value: static
amount string required
Min length: >= 1 characters
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
virtualDepositOnly boolean
Whether this account is for virtual deposits only
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
name string deprecated
DEPRECATED - Use ownerName instead
Min length: >= 1 characters
address1 array[string or null] deprecated
DEPRECATED - Use ownerAddressLine1 instead
address2 array[string or null] deprecated
DEPRECATED - Use ownerAddressLine2 instead
address3 array[string or null] deprecated
DEPRECATED - Use additional 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