Create End User Account
Last updated
Last updated
POST
https://api.sfox.com/v1/enterprise/register-account
Create (register) an sFOX account for an end user.
Creating an account is the first step in the end user onboarding flow. In this request, you will provide identification information for your user, whether that user is an individual or a business. sFOX will then register an account on behalf of this end user.
Collect this information from the end user within your platform and submit it to sFOX. Refer to this example onboarding flow in .
account_type required
string
Type of sFOX account to create.
Possible values: individual, corporation
account_role required
string
The primary role of this account.
Possible values: client, advisor
user_id required
string
Unique ID for this user defined by you that will serve as the shared identifier for this account between you and sFOX
advisor_user_id
string
The user_id of an existing account with account_role = advisor, if applicable. Defining the advisor_user_id for an account ties this account to the advisor account.
first_name required
string
User's first name.
last_name required
string
User's last name.
email required
string
phone_country_code required
string
phone_number required
string
account_purpose required
string
Primary purpose or use case for the account.
Possible values for account_type = individual : Trading, Selling only, Other, Online purchases, Online payments, Investing, Buying only, Business
Possible values for account_type = corporation : Treasury Management, Operating, Liquidating Crypto Assets, Investment Fund, Cross Border Payments, Arbitrage Trading, Other
individual
Required if account_type = individual. Include the following parameters in individual{}
business
Required if account_type = corporation . Include the following parameters in business{}
beneficial_owners
Required if account_type = corporation . Include the Beneficial Owner parameters in beneficial_owners[]
dob required
string
residential_country_code required
string
residential_address required
string
Street address of primary residence. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.
residential_city required
string
City of primary residence. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters.
residential_state required
string
State or province of primary residence.
If residential_country_code = US, must be a valid 2 char state code e.g. CA
residential_postal_code required
string
The postal code for the associated residential_address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.
id_type required
string
Form of identification associated with the id_number below.
If residential_country_code <> US, must be passport. Else, passport or ssn
id_number required
string
Social Security Number or Passport Number of the user’s identification.
id_country_code required
string
Issuing country of the identification.
If id_type = ssn, must be US .
entity_name required
string
The legal business entity name
organization_type required
string
The type of business organization.
Possible values: Trust, Sole Proprietor, LLC, Partnership, Corporation, Other
registration_number required
string
The business’s TIN (tax identification number) for US businesses or registration number
principal_place_country required
string
principal_place_state required
string
State or province of the business’ principal place of business operations.
If principal_place_country = US, must be a valid 2 char U.S. state code (e.g. CA)
principal_place_address required
string
Street address of the business’ principal place of business operations. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.
principal_place_city required
string
City of the business’ principal place of business operations. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters.
principal_place_postal_code required
string
The postal code for the associated principal_place_address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.
incorporation_country required
string
incorporation_state required
string
State the entity was incorporated.
If incorporation_country_code = US, must be a valid 2 char U.S. state code (e.g. CA)
incorporation_date required
string
accredited_investor required
boolean
Whether the business qualifies as an accredited investor.
non_agent_intermediary required
boolean
Whether the business has is acting as a non-agent intermediary.
business_type required
string
The type of business this entity conducts.
Possible values: Hedge Fund, Private Equity Fund, Mutual Fund, Proprietary Trading Firm, Personal Investment Company, Individual Retirement Account Holding Company, Money Service Business (MSB), Financial Institution Brokerage, Agency OTC Brokerage, Principle OTC Brokerage, Retail Brokerage, Robo-Advisor, or FX/CFD Provider, Fund of Funds, Pension Fund, Endowment, Exchange Traded Fund, Fund Administrator, Professional Service Provider (Accounting or Law Firm), Software Vendor, Platform Provider, Data Aggregator, Charity Organization or Non-profit, Crypto Exchange, Digital Currency Mining Firm, Merchant
description required
string
A description of the business
website
string
URL to the business’s website
first_name required
string
The first name of the beneficial owner.
middle_name
string
The middle name of the beneficial owner.
last_name required
string
The last name of the beneficial owner.
email required
string
phone_number required
string
dob required
string
address_country_code required
string
address_subdivision required
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_street1 required
string
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 required
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_postal_code required
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 required
string
Form of identification associated with the id_number below.
Possible values: ssn (if residential_country_code = US), passport
id_country_code required
string
id_number required
string
Social Security Number (SSN) or Passport number of the user’s identification.
user_id
The shared unique identifier for the account as defined by you in the request
status
The verification status of the account
Unsupported
Pending
Verified
requirements
The remaining requirements to complete account verification
The user's email address. Must not have leading or trailing spaces and must be compliant.
The country code of the phone number.
The user's phone number in (e.g. +14155552671).
object {}
object {}
[]
User's date of birth in the format YYYY-MM-DD ().
The country code of the primary residence (e.g. US)
The country code of the business’ principal place of business operations (e.g. US).
The country code where the entity was incorporated (e.g. US)
Date that the company was created in the format YYYY-MM-DD ().
The email address of beneficial owner. Must not have leading or trailing spaces and must be compliant.
A valid phone number for the beneficial owner in (e.g. +14155552671).
The date of birth of beneficial owner in the format YYYY-MM-DD ().
The country code of the owner's primary residence (e.g. US)
The country code of the issuing country of the id_type.
If id_type = ssn, must be US