Skip to main content
POST
Get deposit addresses

Authorizations

X-Client-Secret
string
header
required

Contact Mesh to get client Secret

X-Client-Id
string
header
required

Contact Mesh to get client Id

Body

application/json
authToken
string
required

Auth token that allows connecting to the target institution

Minimum string length: 1
type
enum<string>
required

Type of the institution to connect

Available options:
robinhood,
eTrade,
alpaca,
tdAmeritrade,
weBull,
stash,
interactiveBrokers,
public,
coinbase,
kraken,
coinbasePro,
cryptoCom,
openSea,
binanceUs,
gemini,
cryptocurrencyAddress,
cryptocurrencyWallet,
okCoin,
bittrex,
kuCoin,
etoro,
cexIo,
binanceInternational,
bitstamp,
gateIo,
acorns,
okx,
bitFlyer,
coinlist,
huobi,
bitfinex,
deFiWallet,
krakenDirect,
vanguard,
binanceInternationalDirect,
bitfinexDirect,
bybit,
paxos,
coinbasePrime,
btcTurkDirect,
kuCoinDirect,
okxOAuth,
paribuDirect,
robinhoodConnect,
blockchainCom,
bitsoDirect,
binanceConnect,
binanceOAuth,
revolutConnect,
binancePay,
bybitDirect,
paribuOAuth,
payPalConnect,
binanceTrDirect,
coinbaseRamp,
bybitDirectMobile,
sandbox,
cryptoComPay,
bybitEuDirect,
uphold,
binancePayOnchain,
sandboxCoinbase,
bybitPay,
krakenOAuth,
bluvoKrakenOAuth,
cashApp,
sandboxKrakenOAuth,
krakPay,
unlimit,
alchemyPay,
okxPay
symbol
string
required

Symbol of the required cryptocurrency, e.g. ETH or BTC.

Minimum string length: 1
networks
object[] | null

Specifies which networks to use to obtain the deposit address of the Symbol asset.

mfaCode
string | null

Response

Addresses successfully obtained or generation initiated.

status
enum<string>
Available options:
ok,
serverFailure,
permissionDenied,
badRequest,
notFound,
conflict,
tooManyRequest,
locked,
unavailableForLegalReasons
message
string | null

A message generated by the API

displayMessage
string | null

User-friendly display message that can be presented to the end user

errorHash
string | null
read-only

An error grouping hash from string components and caller information. Used by bugsnag on FE for correct error grouping

teamCode
string | null
read-only

Opaque team code for error routing. Resolved from exception origin or caller file path via CODEOWNERS. Format: 2-character code (e.g., "7K", "M2"). Use for alerting/routing, not display.

errorType
string | null

Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.

errorData
unknown
content
object | null