Sign InOpen Account

Create End User Account

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 the interactive demo.

Request

Body Parameters

Parameter
Description

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

The user's email address. Must not have leading or trailing spaces and must be RFC 3696 compliant.

phone_country_code required, string

The ISO 3166-1 alpha-2 country code of the phone number.

phone_number required, string

The user's phone number in E.164 format (e.g. +14155552671).

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

source_of_funds string

Primary source of end user's funds transferred to their account. Possible values: EMPLOYMENT, SAVINGS, BUSINESS_INCOME, INVESTOR_CAPITAL, INVESTMENTS, PROPERTY_SALE, LOANS, RETIREMENT, TRADING, MINING, AIRDROPS, GRANTS, DONATIONS_WINNINGS, INHERITANCE_GIFTS, OTHER

source_of_funds_other string

Description of the end user's primary source of funds, if source_of_funds = OTHER. Required if source_of_funds = OTHER

individual object

The individual's identity information, specified in an Individual object. Required if account_type = individual.

business object

The business entity and organizational information, specified in a Business object. Required if account_type = corporation

beneficial_owners [object]

The business' beneficial owners, specified as an array of Beneficial Owner objects. Required if account_type = corporation .

Individual Parameters

Parameter
Description

dob required, string

User's date of birth in the format YYYY-MM-DD (RFC 3339 Section 5.6).

residential_country_code required, string

The ISO 3166-1 alpha-2 country code of the primary residence (e.g. US)

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 .

Business Parameters

Parameter
Description

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

The ISO 3166-1 alpha-2 country code of the business’ principal place of business operations (e.g. US).

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

The ISO 3166-1 alpha-2 country code where the entity was incorporated (e.g. US)

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

Date that the company was created in the format YYYY-MM-DD (RFC 3339 Section 5.6).

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

Beneficial Owner Parameters

Parameter
Description

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

The email address of beneficial owner. Must not have leading or trailing spaces and must be RFC 3696 compliant.

phone_number required, string

A valid phone number for the beneficial owner in E.164 format (e.g. +14155552671).

dob required, string

The date of birth of beneficial owner in the format YYYY-MM-DD (RFC 3339 Section 5.6).

address_country_code required, string

The ISO 3166-1 alpha-2 country code of the owner's primary residence (e.g. US)

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

The ISO 3166-1 alpha-2 country code of the issuing country of the id_type. If id_type = ssn, must be US

id_number required, string

Social Security Number (SSN) or Passport number of the user’s identification.

Example Requests

Individual Accounts

#individual account
curl -X POST \
  -H 'Content-type: application/json' \
  -H 'Authorization: Bearer ${ENTERPRISE_API_KEY}' \
  --data '{
    "account_type": "individual",
    "account_role": "client",
    "user_id": "client_account_1",
    "advisor_user_id": "advisor_account_1",
    "first_name": "Sean",
    "last_name": "Fox",
    "email": "[email protected]",
    "phone_country_code": "US",
    "phone_number": "+12223334444",
    "account_purpose": "Investing",
    "source_of_funds": "EMPLOYMENT",
    "individual": {
      "dob": "1990-10-15",
      "residential_country_code": "US",
      "residential_address": "123 sFOX Lane",
      "residential_city": "Los Angeles",
      "residential_state": "CA",
      "residential_postal_code": "90403",
      "id_type": "passport",
      "id_number": "123456789",
      "id_country_code": "US"
    }
  }'  \
  'https://api.sfox.com/v1/enterprise/register-account'

Business Accounts

#Business account
curl -X POST \
  -H 'Content-type: application/json' \
  -H 'Authorization: Bearer ${ENTERPRISE_API_KEY}' \
  --data '{
    "account_type": "corporation",
    "account_role": "advisor",
    "user_id": "advisor_account_1",
    "first_name": "Sean",
    "last_name": "Fox",
    "email": "[email protected]",
    "phone_country_code": "US",
    "phone_number": "+12223334444",
    "account_purpose": "Operating",
    "source_of_funds": "BUSINESS_INCOME",
    "business": {
      "entity_name": "Sean Fox Hedge Fund",
      "incorporation_country": "US",
      "incorporation_state": "WY",
      "incorporation_date": "2020-10-15",
      "organization_type": "LLC",
      "business_type": "Hedge Fund",
      "registration_number": 123456789,
      "description": "Crypto hedge fund",
      "accredited_investor": true,
      "non_agent_intermediary": true,
      "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": [{
        "first_name": "Sean",
        "middle_name": "",
        "last_name": "Fox",
        "email": "[email protected]",
        "dob": "1990-10-15",
        "phone_number": "+12223334444",
        "id_type": "ssn",
        "id_issuing_country": "US",
        "address_street1": "123 sFOX Lane",
        "address_city": "Los Angeles",
        "address_subdivision": "CA",
        "address_country_code": "US",
        "address_postal_code": "90403",
        "ssn": "123456789"
    }]
}'  \
  'https://api.sfox.com/v1/enterprise/register-account'

Response

Response will include a data object with the following fields:

Response Fields

Field
Description

user_id string

The shared unique identifier for the account as defined by you in the user_id field of the request.

status string

The verification status of the account. Possible values: Unsupported, Pending , Verified

requirements object

An object specifying the remaining requirements to complete account verification.

Responses

202: Accepted
{
    "data": {
        "user_id": "advisor_account_1",
        "status": "Pending",
        "requirements": {
            "email": true,
            "sms": true
        }
    }
}

Interactive Demo

PreviousEnd UsersNextCreate Verification Code

Last updated