Get End User

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

Retrieve a single, specific end user. Note, the end user can be of account type individual or corporate.

---

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; see below for individual and corporate account structures.

Individual

Field	Description
account_type	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_namstring	Last name of the user.
phone_numberstring	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 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.
statusstring	Verification status of the user’s sFOX account. Possible values: PENDING, VERIFIED, UNSUPPORTED
requirementsobject	The remaining requirements to complete account verification.

Individual Example

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": "Jane",
        "last_name": "Smith",
        "phone_number": "[phone]",
        "account_purpose": "investing",
        "account_purpose_other": null,
        "source_of_funds": "other",
        "source_of_funds_other": "Salary and investing",
        "id": "e26bcdeb-6406-11f0-a8e5-12e9c04db554",
        "phone_country_code": "US",
        "intermediary_status": null,
        "expected_transfer_volume": null,
        "expected_trade_volume": null,
        "individual": {
            "dob": "1980-01-01",
            "residential_country_code": "US",
            "residential_address": "123 Main St",
            "residential_city": "San Francisco",
            "residential_state": "CA",
            "residential_postal_code": "60622",
            "id_type": "ssn",
            "id_number": "*****6789",
            "id_country_code": "US",
            "employment_status": null,
            "industry": null,
            "occupation": null,
            "job_title": null
        },
        "status": "VERIFIED",
        "requirements": {
            "email": false,
            "sms": false
        }
    }
}

Corporate

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_name string	First name of the user.
last_name string	Last name of the user.
phone_numberstring	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
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).
business object	The business information provided during registration.
beneficial_ownersobject	Beneficial owner array for this account.
statusstring	Verification status of the user’s sFOX account. Possible values: PENDING, VERIFIED, UNSUPPORTED
requirementsobject	The remaining requirements to complete account verification.

Beneficial Owners

Field	Description
id string	This ID is provided by the sFOX system and should be used as a unique identifier for this beneficial owner (or for a corporate account entity) when submitting documents.
email string	The email address of beneficial owner. Must not have leading or trailing spaces and must be RFC 3696 compliant.
first_name string	The first name of the beneficial owner.
middle_name string	The middle name of the beneficial owner.
last_name string	The last name of the beneficial owner.
phone_number string	A valid phone number for the beneficial owner in E.164 format (e.g. [phone]).
dob string	The date of birth of beneficial owner in the format YYYY-MM-DD (RFC 3339 Section 5.6).
ssn string	Social Security Number (SSN) or Passport number of the beneficial owner.
address_street1string	Street address of owner's primary residence. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.
address_city string	City of the owner's primary residence. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters.
address_subdivision string	An ISO 3166-2 subdivision code of primary residence. Related terms would be "state", "province", "prefecture", "zone", "subdivision", etc. If residential_country_code = US, must be a valid 2 char state code (e.g. CA)
address_country_code string	The ISO 3166-1 alpha-2 country code of the owner's primary residence (e.g. US)
address_postal_code string	The postal code for the owner's associated address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.
id_type string	Form of identification associated with the id_number below. Possible values: ssn (if residential_country_code = US), passport
id_country_code string	The ISO 3166-1 alpha-2 country code of the issuing country of the id_type. If id_type = ssn, must be US
job_title string	The owner's current job title or position.
employment_status string	The individual's current working status or working relationship with organization(s). Possible values: full_time_employee, unemployed, retired, student, self_employed, independent_contractor
industry string	The industry or sector that the individual primarily or currently works in. Possible values: agriculture, administrative_support_services, arts_media, consulting, construction, education, entertainment, energy, ecommerce_digital_platforms, financial_services, food_hospitality, government, healthcare, information_media, manufacturing, mining_crypto, mining_extraction, non_profit, professional_services, personal_services, real_estate, retail_trade, social_services, transportation_warehousing, technology_software, utilities, wholesale_trade
occupation string	The individual's primary occupation. Possible values: management_executive, business_financial_operations, computer_mathematical, architecture_engineering, life_physical_social_science, healthcare_practitioners_technical, healthcare_support, legal, education_training_library, arts_design_entertainment_media, community_social_service, protective_service, sales_related, office_administrative_support, food_preparation_serving, personal_care_service, building_grounds_maintenance, construction_extraction, installation_maintenance_repair, production_manufacturing, transportation_material_moving, farming_fishing_forestry, military, student, homemaker_caregiver, unemployed_between_jobs, retired

Corporate Example

200: OK

Response for a single user_id: corp_account_1

{
    "data": {
        "account_type": "corporation",
        "account_role": "Client",
        "user_id": "corp_account_1",
        "advisor_user_id": null,
        "email": "[email protected]",
        "first_name": "Jane",
        "last_name": "Smith",
        "phone_number": "[phone]",
        "account_purpose": "arbitrage trading",
        "account_purpose_other": null,
        "source_of_funds": null,
        "source_of_funds_other": null,
        "phone_country_code": "US",
        "intermediary_status": null,
        "expected_transfer_volume": null,
        "expected_trade_volume": null,
        "business": {
            "entity_name": "Hedge Fund Alpha",
            "incorporation_country": "US",
            "incorporation_state": "WY",
            "organization_type": "LLC",
            "business_type": "Fund Administrator",
            "registration_number": "*****6789",
            "website": null,
            "description": "crypto fund",
            "incorporation_date": "2012-11-15",
            "accredited_investor": true,
            "non_agent_intermediary": false,
            "principal_place_country": "US",
            "principal_place_state": "CA",
            "principal_place_address": "1234 Flower Street",
            "principal_place_city": "Los Angeles",
            "principal_place_postal_code": "90403"
        },
        "beneficial_owners": [
            {
                "id": "207a6d5a-d47b-11f0-a8e5-12e9c04dbb50",
                "email": "[email protected]",
                "first_name": "Benny",
                "middle_name": "S",
                "last_name": "Owner",
                "phone_number": "5559998888",
                "dob": "1982-10-15",
                "ssn": "*****6789",
                "address_street1": "2322 Clover lane",
                "address_city": "Chicago",
                "address_subdivision": "IL",
                "address_country_code": "US",
                "address_postal_code": "60093",
                "id_type": "passport",
                "id_country_code": "US",
                "job_title": null,
                "employment_status": null,
                "industry": null,
                "occupation": null,
            }
        ],
        "status": "PENDING",
        "requirements": {
            "email": true,
            "sms": false
        }
    }
}