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
  • Request
  • Query Parameters
  • Path Parameters
  • Example Requests
  • Response
  • Response Body
  • Responses
  1. REST API
  2. End Users

Get End User(s)

GET

https://api.sfox.com/v1/enterprise/users/:user_id

Returns a list of all your users that exist within sFOX Connect, or optionally, a single specific user.


Request

Query Parameters

Parameter
Type
Description

accountRole

string

Filters the users by either a client or advisor role. Possible values: client or advisor

Path Parameters

Parameter
Type
Description

user_id optional

string

Specific user_id to retrieve

Example Requests

curl -H "Authorization: Bearer ${ENTERPRISE_API_TOKEN}" \
 'https://api.sfox.com/v1/enterprise/users'
const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://api.sfox.com/v1/enterprise/users',
  headers: {
    'Authorization': `Bearer ${process.env.ENTERPRISE_API_TOKEN}`
  }
}

axios(config)
  .then(response => {
    console.log(response.status)
    console.log(respones.data)
  }).catch(err => {
    console.error(err.response.status)
    console.error(err.response.data)
  });
import requests
import os

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

Response

Response Body

Key
Description

account_type

Individual or Corporation

account_role

Advisor or Client

user_id

Unique ID shared between sFOX and you

email

Email address of the user

first_name

First name of the user

last_name

Last name of the user

phone_number

Phone number of the user

advisor_user_id

User ID of the Advisor to this Client, if applicable

status

Verification status of the user’s sFOX account

requirements

The remaining requirements to complete account verification

Responses

200 OK (all users)
All users
{
    "data": [
      {
        "account_type": "individual",
        "account_role": "Client",
        "user_id": "client_account_1",
        "email": "sean_fox@sfox.com",
        "first_name": "Sean",
        "last_name": "Fox",
        "phone_number": "+12345678900",
        "advisor_user_id": "advisor_account_1",
        "status": "PENDING",
        "requirements": {
            "email": true,
            "sms": true
        }
      },
      {
        "account_type": "individual",
        "account_role": "Advisor",
        "user_id": "advisor_account_1",
        "email": "jane_doe@sfox.com",
        "first_name": "Jane",
        "last_name": "Doe",
        "phone_number": "+12345678922",
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
      }
    ]
}

200 OK (specific user)
Specific partnerUserId
{
    "data": {
        "account_type": "individual",
        "account_role": "Client",
        "user_id": "client_account_1",
        "email": "sean_fox@sfox.com",
        "first_name": "Sean",
        "last_name": "Fox",
        "phone_number": "+12345678900",
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
    }
}

PreviousCreate User Auth Token(s)NextGet EDD Requests

Last updated 1 day ago