Get End User

GET

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

Retrieve a single, specific end user.

Retrieve a list of multiple end users by executing a Get Multiple End Users request.

Request

Path Parameters

Parameter

Description

user_id required, string

user_id of the specific end user to retrieve.

Example Requests

curl -H "Authorization: Bearer ${ENTERPRISE_API_KEY}" \
 'https://api.sfox.com/v1/enterprise/users/${USER_ID}'

const axios = require('axios');

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

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/${USER_ID}",
  headers={
    "Authorization": f"Bearer {os.environ['ENTERPRISE_API_KEY']}"
  }
)
print(data.status_code)
print(data.json())

Response

Returns a data object with the following response fields.

Response Fields

Field

Description

account_typestring

The end user's account type. Possible values: individual, corporation

account_rolestring

The end user's role. Possible values: Client, Advisor

user_idstring

End user's unique ID, defined by you.

advisor_user_idnullable, string

user_id of the end user's, if applicable.

emailstring

Email address of the user.

first_namestring

First name of the user.

last_namestring

Last name of the user.

phone_numberstring

Phone number of the user in E.164 format (e.g. +14155552671).

statusstring

Verification status of the user’s sFOX account. Possible values: PENDING, VERIFIED, UNSUPPORTED

requirementsobject

The remaining requirements to complete account verification.

Responses

200: OK

Response for a single user_id: client_account_1

{
    "data": {
        "account_type": "individual",
        "account_role": "Client",
        "user_id": "client_account_1",
        "advisor_user_id": null,
        "email": "[email protected]",
        "first_name": "Sean",
        "last_name": "Fox",
        "phone_number": "+12345678900",
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
    }
}

PreviousCreate Multiple User Auth Tokens NextGet Multiple End Users

Last updated 4 months ago