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

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

Python

NodeJS

---

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]).
account_purpose string	Primary purpose or use case for the account.
account_purpose_other string	The account purpose free text entry when account_purpose = other.
source_of_funds string	Primary source of end user's funds transferred to their account.
source_of_funds_other string	Source of funds free text entry when source_of_funds = other
id string	This ID is provided by the sFOX system and should be used as a unique ID for this individual in other endpoints.
phone_country_code string	The ISO 3166-1 alpha-2 country code of the phone number.
intermediary_status string	Will the end user be receiving or sending funds on behalf of someone other than themselves.
expected_transfer_volume string	Expected monthly USD notional volume of transfers (sent and received).
expected_trade_volume string	Expected monthly USD notional volume of trading (buys and sells).
individual object	The user's identity information provided during registration.
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
        }
    }
}