POST
/
api
/
v1
/
linktoken
curl --request POST \
  --url https://integration-api.getfront.com/api/v1/linktoken \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "userId": "UserId",
  "configurationId": "18a20b11-e47f-43b9-8546-94284e9ee547",
  "restrictMultipleAccounts": true,
  "transferOptions": {
    "toAddresses": [
      {
        "networkId": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
        "symbol": "ETH",
        "address": "0x00000000000000000000000"
      },
      {
        "networkId": "e3c7fdd8-b1fc-4e51-85ae-bb276e075611",
        "symbol": "USDC",
        "address": "0x00000000000000000000000"
      },
      {
        "networkId": "7436e9d0-ba42-4d2b-b4c0-8e4e606b2c12",
        "symbol": "MATIC",
        "address": "0x00000000000000000000000"
      },
      {
        "networkId": "7436e9d0-ba42-4d2b-b4c0-8e4e606b2c12",
        "symbol": "USDC",
        "address": "0x00000000000000000000000"
      }
    ],
    "amountInFiat": 10,
    "isInclusiveFeeEnabled": false
  }
}'
{
  "content": {
    "linkToken": "aHR0cHM6Ly93ZWIuZ2V0ZnJvbnQuY29tL2IyYi1pZnJhbWUve2NsaWVudElkfS9icm9rZXItY29ubmVjdD9hdXRoX2NvZGU9e2F1dGhDb2RlfQ=="
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Authorizations

​
X-Client-Secret
string
header
required

Contact Front to get client Secret

​
X-Client-Id
string
header
required

Contact Front to get client Id

Body

Create Link token request.
​
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
​
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.

Response

200
application/json
Link token created.
​
status
enum<string>
Available options:
ok,
serverFailure,
permissionDenied,
badRequest,
notFound,
conflict,
tooManyRequest,
locked
​
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.

​
content
object
Refresh auth token