Overview

Mesh APIs allow client applications to connect users to their accounts across brokerages, centralized exchanges, and self-custody wallets. Mesh Link handles credential validation, multi-factor authentication, and error handling when connecting to each account.

After an end user authenticates with their account credentials, clients will be passed authentication tokens to provide access to the account which allows client applications to read account information such as holdings, transactions, and balances, and initiate trades and transfers on behalf of the end user.

Introduction

The starting point for any integration with Mesh is with an account connection, which using the fastest way to get started is by using Link SDKs or cloning the Quickstart React app.

After generating Sandbox and Production API keys, you’ll start by leveraging Link SDKs to facilitate end user authentication.

Call /api/v1/linktoken to create a link token (add URL to guide) that you can use to initiate the Link SDK.
Pass the linkToken to the appropriate Link SDK
Your user will be able to filter and search for the account they want to connect. Mesh will manage the authentication flow and handle MFAs for all supported integrations.
After successful authentication on the Link UI, broker tokens will be passed to the SDK via the onBrokerConnected function.
1. You should securely store the auth_token (and refresh_token) for use in subsequent server requests

{
  "content": {
    "status": "succeeded",
    "equityPositions": [
      {
        "symbol": "AAPL",
        "amount": 3,
        "costBasis": 109
      },
      {
        "symbol": "F",
        "amount": 27,
        "costBasis": 7.05791
      }
    ],
    "notSupportedEquityPositions": [
      {
        "symbol": "CUSIP38259P508",
        "amount": 1
      }
    ],
    "notSupportedCryptocurrencyPositions": [],
    "cryptocurrencyPositions": [
      {
        "symbol": "DOGE",
        "amount": 1503,
        "costBasis": 0.033
      },
      {
        "symbol": "BTC",
        "amount": 3.0001672,
        "costBasis": 18000
      }
    ],
    "nftPositions": [],
    "optionPositions": [],
    "type": "robinhood",
    "accountId": "5FUVPB0",
    "institutionName": "Robinhood",
    "accountName": "Margin account"
  },
  "status": "ok",
  "message": ""
}

Auth + Call Flow Diagram

Examples

Authentication with Full Catalog

Request

curl --request POST \
     --url https://integration-api.getfront.com/api/v1/linktoken \
     --header 'X-Client-Id: xxx-xxxxx-xxxxxx' \
     --header 'X-Client-Secret: xxx-xxxxx-xxxxxx' \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '
{
  "userId": "demo-123242-232422"
}

Response

{
  "content": {
    "linkToken": "xxx-xxxxxx-xxxxxx"
  },
  "status": "ok",
  "message": ""
}

Authentication Direct to Broker (Binance)

Request

curl --request POST \
     --url https://integration-api.getfront.com/api/v1/linktoken \
     --header 'X-Client-Id: xxxxx-xxxxx-xxxxxxx' \
     --header 'X-Client-Secret: xxxx-xxxxx-xxxxxx' \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '
{
  "userId": "demo-2123213--23242",
  "brokerType": "binanceInternationalDirect"
}
'

Response

{
  "content": {
    "linkToken": "xxx-xxxxxx-xxxxxx"
  },
  "status": "ok",
  "message": ""
}