GET
/
api
/
v1
/
authenticate
/
{brokerType}
curl --request GET \
  --url https://integration-api.getfront.com/api/v1/authenticate/{brokerType} \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "content": {
    "status": "redirect",
    "redirectLink": "https://front.org/",
    "linkToken": "Link to the integration's site"
  },
  "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

Path Parameters

​
brokerType
enum<string>
required

Type of the integration 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

Query Parameters

​
userId
string
required

Id of the end-user

Response

200
application/json
Success
​
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
Authenticate user's accountGet transfer history