POST
/
api
/
v1
/
linktoken

Authorizations

X-Client-Secret
string
headerrequired

Contact Mesh to get client Secret

X-Client-Id
string
headerrequired

Contact Mesh to get client Id

Body

userId
string
required

A unique Id representing the end user. Typically this will be a user Id from the client application. Personally identifiable information, such as an email address or phone number, should not be used. 50 characters length maximum.

Required string length: 1 - 50
brokerType
enum<string>
deprecated

Type of integration to redirect to. Will redirect to catalog if not provided. Not supported types: DeFiWallet, CryptocurrencyAddress, CryptocurrencyWallet.

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,
revolutConnect
restrictMultipleAccounts
boolean

The final screen of Link allows users to “continue” back to your app or “Link another account.” If this param is present then this button will be hidden.

transferOptions
object

Encapsulates transaction-related parameters, including destination addresses and the amount to transfer in fiat currency.

integrationId
string | null

A unique identifier representing a specific integration obtained from the list of available integrations.

disableApiKeyGeneration
boolean

For direct integrations that also support API keys, Link presents the user with the option to generate an API key for seamless access. If this param is true, this feature will be disabled.

verifyWalletOptions
object

Encapsulates verify DeFi wallet parameters.

subClientId
string | null

Sub Client ID, for B2B2B clients to tailor Link experience for their clients.

Response

200 - application/json
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

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 | null
content
object
Refresh auth token