POST
/
api
/
v1
/
token
/
refresh
Refresh auth token
curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/token/refresh \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "refreshToken": "Secret refresh token",
  "type": "coinbase"
}'
{
  "content": {
    "status": "succeeded",
    "expiresInSeconds": 86400,
    "brokerAccountTokens": [
      {
        "accessToken": "New secret token",
        "refreshToken": "New secret refresh token"
      }
    ]
  },
  "status": "ok",
  "message": "",
  "errorHash": "9d3039e805923a44c7bfb5eff261aab0aed7d63b",
  "errorType": ""
}

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
​
type
enum<string>
required
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
​
refreshToken
string
required
Minimum length: 1
​
createNewRefreshToken
boolean | null

Optional, used when we the refresh token should be refreshed. Currently this flow is supported by TD Ameritrade

​
accessToken
string | null

Some institutions may require accessToken to be provided as well. It's currently required by WeBull and Vanguard

​
tradeToken
string | null

Currently used to update WeBull trade token.

​
mfaCode
string | null

Optional, currently used by Vanguard if account has enforced MFA enabled.

​
metadata
object | null

Additional metadata

Response

OK

​
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

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

​
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
any
​
content
object