sFOX API
Sign InOpen Account
Connect API
Connect API
  • Introduction
    • Welcome
    • Getting Started
    • Resources
      • Terminology
      • Systems & Operations
      • Integration Options
    • Guides
      • End User Onboarding & KYC
        • Individuals
        • Businesses
        • Enhanced Due Diligence
  • REST API
    • REST Endpoints
    • Authentication
    • End Users
      • Create End User Account
      • Request Verification Code
      • Confirm Verification Code
      • Create User Auth Token(s)
      • Get End User(s)
      • Get EDD Requests
      • Get EDD Prompts
      • Create EDD Responses
        • Uploading Files as Responses
      • Submit Documents
      • Deactivate User
    • Payments
      • Create Bank Account (Plaid)
      • Create Bank Account
      • Get Bank Account
      • Get Plaid Processors
      • Amend Plaid Processors
      • Verify Bank Account
      • Delete Bank Account
      • Get Wire Instructions
      • Get ACH Agreement Status
      • Request ACH Onboarding
      • Get ACH Deposit Limit
    • Withdrawals
      • Confirm Withdrawal
      • Resend Confirmation Code
      • Cancel Withdrawal
    • Transfers
      • Create Transfer
      • Confirm Transfer
      • Resend Confirmation Code
      • Cancel Transfer
      • Get Transfer Permissions
      • Get Transfer History
    • Monetization
      • Create Setting
      • Update Setting
      • Delete Setting
      • Get Settings
      • Get Permissions
      • Get Monetization History
  • WebSocket API
    • Connecting
    • Authentication
    • Subscribing & Unsubscribing
    • Message Format
    • End Users
      • Onboarding
      • Balances
      • Orders
      • Trades
    • Market Data
      • Order Book
      • Trades
      • Ticker
  • Single Sign-On
    • Overview
      • IdP Initiated SSO
    • IdP Data
    • SAML Response Data
  • Errors
    • Error Codes
Powered by GitBook
On this page
  • Enterprise Partner Authentication
  • User Authentication
  1. REST API

Authentication

PreviousREST EndpointsNextEnd Users

Last updated 1 year ago

The API key should be included in all API requests to the server in the Authorization header as a Bearer token:

curl -H 'Authorization: Bearer <API_TOKEN>' 'https://api.sfox.com/v1/...'
const axios = require('axios');

axios({
  method: 'get',
  url: 'https://api.sfox.com/...',
  headers: {
    'Authorization': `Bearer ${process.env['API_KEY']}`
  }
}).then(response => {
  console.log(response)
}).catch(err => {
  console.error(err)
});
import requests
import os

data = requests.get(
  "https://api.sfox.com/...",
  headers={
    "Authorization": f"Bearer {os.environ['API_KEY']}",
  }
)
print(data.json())

Enterprise Partner Authentication

sFOX will provide your enterprise with an “Enterprise Partner” Bearer Token, which will grant your enterprise access to the partner-specific endpoints described in Connect documentation.

Note: all of the REST endpoints described in the Connect documentation require your Enterprise Bearer Token as the Bearer Token for authentication.

To access a specific user’s account, see below.

User Authentication

To access specific users’ accounts on sFOX via any of the endpoints documented , your enterprise will use that user’s Bearer Token provided by the endpoints described in the next section.

here