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

Shell

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

NodeJS

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)
  });

Python

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_type string	The end user's account type. Possible values: individual, corporation
account_role string	The end user's role. Possible values: Client, Advisor
user_id string	End user's unique ID, defined by you.
advisor_user_id nullable, string	user_id of the end user's, if applicable.
email string	Email address of the user.
first_name string	First name of the user.
last_name string	Last name of the user.
phone_number string	Phone number of the user in E.164 format (e.g. [phone]).
status string	Verification status of the user’s sFOX account. Possible values: PENDING, VERIFIED, UNSUPPORTED
requirements object	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": "[phone]",
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
    }
}