Data Blocks

Attributes	Data Type
subNumber	Integer
accountNumber	String
registrationType	Registration Type
main	Main
mailingAddress	Mailing Address
primaryOwner	Primary Owner
associatedParties	Associated Parties
electronicDelivery	Electronic Delivery
financialProfile	Financial Profile
trustedContact	Trusted Contact
largeTraders	Large Traders
todBenes	TOD Beneficiaries
retirementBenes	Retirement Beneficiaries

Main

Schema

Attributes	Data Type	Description
repCode	String	StoneX assigned code for the financial representative of the account
proxyDisclosure	Proxy Disclosure	Designates the transmission of proxy information and the disclosure of customer name
sweepIndicator	Boolean	Indicates customer participation in the automatic sweep program
catAccountIdentifier	CAT Account Identifier	Account identification type for CAT reporting
marginIndicator	Boolean	Indicates the account is approved for margin trading (read-only)
optionTradingLevel	Option Trading Level	Indicates the account's option trading level (read-only)

Example

{
  "main": {
    "repCode": "JC01",
    "proxyDisclosure": "L",
    "sweepIndicator": "true",
    "catAccountIdentifier": "Individual",
    "marginIndicator": "false",
    "optionTradingLevel": "1"
  }
}

Mailing Address

See the address object here

Primary Owner

Schema

Attributes	Data Type	Length	Description
nameType	Name Type
name1	String	Min: 2 - Max: 30	Individual: First Name Entity: Name 1 Allowed Symbols: /, -, #
name2	String	Min: 2 - Max: 30	Individual: Middle Name Entity: N/A Allowed Symbols: /, -, #
name3	String	Min: 2 - Max: 30	Individual: Last Name Entity: Name 2 Allowed Symbols: /, -, #
name4	String	Min: 2 - Max: 30	Individual: Suffix Entity: N/A Allowed Symbols: /, -, #
citizenshipCountry	Countries
birthDate	Date Format
email	String	Max: 70
legalAddress	Address
occupation	Occupation
jobTitle	String
jobIndustry	Job Industry
employerName	String
employerPhoneRegionCode	Phone Region Codes
employerPhoneNumber	String	Min: 6 - Max: 15
employerPhoneExtension	String	Min: 1 - Max: 5
employerAddress	Address
taxIdType	US Tax ID Types	Max: 5
taxIdNumber	String	Max: 9
governmentIdentification	Government Identification		For non-citizens of the US, Government ID 1 is a national ID.
sourceOfFunds	Sources of Funds
phoneRegionHome	Phone Region Codes
phoneNumberHome	String	Max: 15
phoneRegionCell	Phone Region Codes
phoneNumberCell	String	Max: 15
phoneRegionBusiness	Phone Region Codes
phoneNumberBusiness	String	Max: 15
phoneExtensionBusiness	String	Max: 5
jointOwnershipPercent	Integer	Max: 100
caisCustomerType	C.A.I.S. Customer Type
institutionalInvestor	Boolean		A bank, savings and loan association, insurance company, registered investment company, investment adviser, or any individual or entity with $50 million or more in assets.
accountsAtOtherBrokerage	String
trustedContact	Trusted Contact
affiliation	Affiliation
maritalStatus	Marital Status
dependents	Integer

Example

{
  "primaryOwner": {
    "nameType": "individual",
    "name1": "Sam",
    "name2": "Mayer",
    "name3": "Dao",
    "name4": "Jr",
    "citizenshipCountry": "US",
    "birthDate": "1980-05-25",
    "email": "[email protected]",
    "legalAddress": {
      "street": "2 Perimeter Park S",
      "city": "Birmingham",
      "stateProvince": "AL",
      "country": "US",
      "postalCode": "35243"
    },
    "occupation": "accountingOrAuditing",
    "jobTitle": "accountant",
    "jobIndustry": "finance",
    "employerName": "ABC Accounting",
    "employerPhoneRegionCode": "1",
    "employerPhoneNumber": "2051239879",
    "employerPhoneExtension": "1234",
    "employerAddress": {
      "street": "2 Perimeter Park S",
      "city": "Birmingham",
      "stateProvince": "AL",
      "country": "US",
      "postalCode": "35243"
    },
    "taxIdType": "SSN",
    "taxIdNumber": "123456789",
    "governmentIdentification": {
      "governmentId1": {
        "idType": "driverslicense",
        "idNumber": "AL12345",
        "idLocation": "AL",
        "idIssueDate": "2020-01-01",
        "idExpiration": "2030-01-01"
      },
      "governmentId2": {
        "idType": "passport",
        "idNumber": "E00007734",
        "idLocation": "US",
        "idIssueDate": "2020-01-01",
        "idExpiration": "2030-01-01"
      }
    },
    "sourceOfFunds": "gift",
    "phoneRegionCell": "1",
    "phoneNumberCell": "2059871212",
    "phoneRegionHome": "1",
    "phoneNumberHome": "2056961213",
    "phoneRegionBusiness": "1",
    "phoneNumberBusiness": "2056768383",
    "phoneExtensionBusiness": "1234",
    "caisCustomerType": ["Accredited", "Advisor"],
    "institutionalInvestor": "true",
    "accountsAtOtherBrokerage": ["ABC Brokerage", "XYZ Advisors"],
    "trustedContact": {
      "name": "Jane Smith",
      "relationship": "spouse",
      "phoneRegionCode": "1",
      "phoneNumber": "2056786578",
      "email": "[email protected]",
      "address": {
        "street": "2 Perimeter Park S Suite 100W",
        "city": "Birmingham",
        "stateProvince": "AL",
        "country": "US",
        "postalCode": "35243"
      }
    },
    "affiliation": {
      "political": {
        "associated": "true",
        "name": "sam dao",
        "organization": "Political Organization",
        "relationship": "self"
      },
      "industry": {
        "associated": "false"
      },
      "publicCompany": {
        "associated": "false"
      },
      "stonex": {
        "associated": "true",
        "name": "tom dao",
        "position": "advisor",
        "relationship": "self",
        "affiliatedEntity": "SSIA"
      }
    },
    "maritalStatus": "single",
    "dependents": "2"
  }
}

Requirements

Phone Number: At least one pair of phone information must be provided. Home, Business, or Cell phone. PhoneRegionCode and PhoneNumber.

Requirements

Non-Individual Name Type: When the primaryOwner or any associatedParty has a nameType = "NonIndividual" the following fields should not be required.

Fields (Not Required):

• birthDate
• name3
• occupation
• employerName
• employerAddress
• employerPhoneNumber
• employerPhoneCountryCode
• jobTitle
• jobIndustry
• trustedContact

Associated Parties

Schema

Attributes	Data Type	Length	Description
onbCustomerId	String		During staging, the user needs to provide a user-generated onboarding customer ID.
customerID	String		When an account is opened, StoneX gives the user a customer ID.
delete	boolean		Remove the associated party from the account.
role	Associated Party Roles
tradingAuthority	Trading Authority
nameType	Name Type
name1	String	Min: 2 - Max: 30	Individual: First Name Entity: Name 1 Allowed Symbols: /, -, #
name2	String	Min: 2 - Max: 30	Individual: Middle Name Entity: N/A Allowed Symbols: /, -, #
name3	String	Min: 2 - Max: 30	Individual: Last Name Entity: Name 3 Allowed Symbols: /, -, #
name4	String	Min: 2 - Max: 30	Individual: Suffix Entity: N/A Allowed Symbols: /, -, #
citizenshipCountry	Country
birthDate	Date Format	Max: 10
email	String	Max: 70
legalAddress	Address
occupation	Occupation
jobTitle	String
jobIndustry	Job Industry
employerName	String
employerPhoneRegionCode	Phone Region Codes
employerPhoneNumber	String	Max: 15
employerPhoneExtension	String	Max: 5
employerAddress	Address
taxIdType	String	Max: 5
taxIdNumber	String	Max: 9
governmentIdentification	Government Identification		For non-citizens of the US, Government ID 1 is a national ID.
sourceOfFunds	Sources of Funds
phoneRegionHome	Phone Region Codes
phoneNumberHome	String	Max: 15
phoneRegionCell	Phone Region Codes
phoneNumberCell	String	Max: 15
phoneRegionBusiness	Phone Region Codes
phoneNumberBusiness	String	Max: 15
phoneExtensionBusiness	String	Max: 5	Account holder phone extension
jointOwnershipPercent	Integer	Max: 100
caisCustomerType	CAIS CustomerType
institutionalInvestor	boolean
accountsAtOtherBrokerage	String
trustedContact	Trusted Contact
affiliation	Affiliation

Example

{
  "associatedParties": [
    {
      "onbCustomerId": "1234567",
      "role": "secondary",
      "tradingAuthority": "full",
      "nameType": "Individual",
      "name1": "Smith",
      "name3": "Patel",
      "citizenshipCountry": "US",
      "birthDate": "1980-05-25",
      "email": "[email protected]",
      "taxIdType": "SSN",
      "taxIdNumber": "123456789",
      "governmentIdentification": {
        "governmentId1": {
          "idType": "driversLicense",
          "idNumber": "A7654378",
          "idLocation": "AL",
          "idIssueDate": "2020-01-01",
          "idExpiration": "2024-01-01"
        },
        "governmentId2": {
          "idType": "passport",
          "idNumber": "E00007734",
          "idLocation": "US",
          "idIssueDate": "2020-01-01",
          "idExpiration": "2030-01-01"
        }
      },
      "legalAddress": {
        "country": "US",
        "street": "2 Perimeter Park S Suite 100W",
        "city": "Birmingham",
        "stateProvince": "AL",
        "postalCode": "35243"
      },
      "occupation": "retired",
      "sourceOfFunds": "retirement",
      "phoneRegionCell": "1",
      "phoneNumberCell": "1143907525",
      "caisCustomerType": ["foreign"],
      "institutionalInvestor": false,
      "trustedContact": {
        "name": "Jane Smith",
        "relationship": "spouse",
        "phoneNumber": "2056786578",
        "email": "[email protected]",
        "address": {
          "street": "2 Perimeter Park S Suite 100W",
          "city": "Birmingham",
          "stateProvince": "AL",
          "country": "US",
          "postalCode": "35243"
        }
      },
      "affiliation": {
        "political": {
          "associated": "true",
          "name": "sam dao",
          "organization": "Political Organization",
          "relationship": "self"
        },
        "industry": {
          "associated": "false"
        },
        "publicCompany": {
          "associated": "false"
        },
        "stonex": {
          "associated": "true",
          "name": "david mateo",
          "position": "advisor",
          "relationship": "self",
          "affiliatedEntity": "SSIA"
        }
      }
    },
    {
      "onbCustomerId": "9876543",
      "role": "associate",
      "tradingAuthority": "full",
      "nameType": "Individual",
      "name1": "Robin",
      "name3": "Patel",
      "citizenshipCountry": "US",
      "birthDate": "1985-05-25",
      "email": "[email protected]",
      "taxIdType": "SSN",
      "taxIdNumber": "123456987",
      "governmentIdentification": {
        "governmentId1": {
          "idType": "driversLicense",
          "idNumber": "A7654754",
          "idLocation": "AL",
          "idIssueDate": "2020-01-01",
          "idExpiration": "2024-01-01"
        },
        "governmentId2": {
          "idType": "passport",
          "idNumber": "E00009834",
          "idLocation": "US",
          "idIssueDate": "2020-01-01",
          "idExpiration": "2030-01-01"
        }
      },
      "legalAddress": {
        "country": "US",
        "street": "2 Perimeter Park S Suite 100W",
        "city": "Birmingham",
        "stateProvince": "AL",
        "postalCode": "35243"
      },
      "occupation": "retired",
      "sourceOfFunds": "retirement",
      "phoneRegionCell": "1",
      "phoneNumberCell": "1143907987",
      "caisCustomerType": ["foreign"],
      "institutionalInvestor": false,
      "trustedContact": {
        "name": "Jane Smith",
        "relationship": "spouse",
        "phoneNumber": "2056786578",
        "email": "[email protected]",
        "address": {
          "street": "2 Perimeter Park S Suite 100W",
          "city": "Birmingham",
          "stateProvince": "AL",
          "country": "US",
          "postalCode": "35243"
        }
      },
      "affiliation": {
        "political": {
          "associated": "true",
          "name": "sam dao",
          "organization": "Political Organization",
          "relationship": "self"
        },
        "industry": {
          "associated": "false"
        },
        "publicCompany": {
          "associated": "false"
        },
        "stonex": {
          "associated": "true",
          "name": "david mateo",
          "position": "advisor",
          "relationship": "self",
          "affiliatedEntity": "SSIA"
        }
      }
    }
  ]
}

Electronic Delivery

Schema

Attributes	Data Type
email	String
statements	Boolean
confirms	Boolean
stonexCommunications	Boolean
investorCommunications	Boolean
prospectus	Boolean
taxDocuments	Boolean

Example

{
  "electronicDelivery": {
    "email": "[email protected]",
    "statements": false,
    "confirms": true,
    "stonexCommunications": true,
    "investorCommunications": true,
    "prospectus": true,
    "taxDocuments": false
  }
}

Email Requirement

If all electronic delivery elections are false, the email is not required.

Financial Profile

Schema

Attributes	Data Type
annualIncome	Income Ranges
netWorth	Income Ranges
liquidNetWorth	Income Ranges
taxBracket	Tax Bracket
liquidityNeed	Liquidity Need
investmentTimeHorizon	Time Horizon
investmentProfile	Investment Profile
investmentExperience.stocksBonds	Investment Experience
investmentExperience.options	Investment Experience
investmentExperience.mutualFunds	Investment Experience
investmentExperience.annuities	Investment Experience
investmentExperience.alternative	Investment Experience

Example

{
  "financialProfile": {
    "annualIncome": "F",
    "netWorth": "D",
    "liquidNetWorth": "C",
    "liquidityNeed": "medium",
    "taxBracket": "twentySixtoThirty",
    "investmentTimeHorizon": "thirteenToFifteen",
    "investmentProfile": "moderate",
    "investmentExperience": {
      "stocksBonds": "extensive",
      "options": "average",
      "mutualFunds": "extensive",
      "annuities": "average",
      "alternative": "average"
    }
  }
}

Trusted Contact

The trustedContact payload stores the details of a designated individual authorized by the account holder. This contact is utilized for account-related purposes in situations such as emergencies, suspected fraud, or scenarios requiring additional verification or communication.

Schema

Field Name	Data Type	Description	Validations	Values Accepted
name	String	The full name of the trusted contact person.	Required field without special characters.	a-Z
relationship	String	The relationship of the trusted contact to the account holder.	Required field with a valid value.	Child, Self, Spouse, Other
phoneNumber	String	The phone number of the trusted contact.	Required field with a valid 10-digit phone number.	Exact 10 digits
email	String	The email address of the trusted contact.	Optional field.	Valid email address, if provided.
address	Object	The mailing address of the trusted contact.	Required field with the mailing address details of the trusted contact.	Refer Mailing Address Rules

Example

{
  "trustedContact": {
     "name": "Jane Smith", //string
     "relationship": "spouse", //string
     "phoneNumber": "2056964444", //string
     "email": "[email protected]", //string
     "address": {
         "country": "US", //string
         "street": "2 Perimeter Park S Suite 100W", //string
         "city": "Birmingham", //string
         "stateProvince": "AL", //string
         "postalCode": "35243" //string
     }
  }
}

Large Traders

Schema

Attributes	Data Type
id	String
suffix	String
status	Large Trader Id Status

Example

{
  "largeTraders": [
    {
      "suffix": "0123",
      "status": "active",
      "id": "12345678"
    }
  ]
}

TOD Beneficiaries

TOD Beneficiary Requirement

TOD Beneficiary can be added to the following registration types:

• individual
• individualForeign
• individualJointForeign
• jointWROS

Schema

Attributes	Required	Data Type	Description
onbCustomerId		String	During staging, the user needs to provide a user-generated onboarding customer ID.
customerID		String	When an account is opened, StoneX gives the user a customer ID.
delete		Boolean	Remove the associated party from the account.
nameType	✔️	Name Type
name1	✔️	String	Individual: First Name Entity: Name 1 Allowed Symbols: /, -, #
name2		String	Individual: Middle Name Entity: Name 2 Allowed Symbols: /, -, #
name3		String	Individual: Last Name Entity: Name 3 Allowed Symbols: /, -, #
name4		String	Individual: Suffix Entity: Name 4 Allowed Symbols: /, -, #
primaryContingent		Primary or Contingent
address		Address
birthDate	✔️	Date Format
taxIdType	✔️	Tax ID Types	-
taxId	✔️	String
relationship	✔️	Relationship Type
percentAllocation	✔️	Number	Number with one decimal place
citizenshipCountry		Country	-

Example

{
  "todBeneficiaries": [
    {
      "primaryContingent": "contingent",
      "onbCustomerId": "12345678",
      "nameType": "Individual",
      "name1": "John",
      "name2": "Thomas",
      "name3": "Goldberg",
      "name4": "JR",
      "address": {
        "country": "US",
        "street": "62 Blue Spruce Ln",
        "city": "Ballston Lake",
        "stateProvince": "NY",
        "postalCode": "12019"
      },
      "birthDate": "1980-01-25",
      "taxIdType": "SSN",
      "taxId": "223456789",
      "relationship": "spouse",
      "percentAllocation": "100",
      "citizenshipCountry": "US"
    }
  ]
}

TaxID Requirement

For citizens of non-US countries, a user-generated nine-digit TaxID is necessary.

Retirement Beneficiaries

Schema

Attributes	Data Type	Max Length	Description
delete	Boolean		Remove the associated party from the account.
primaryContingent	Primary Contingent
nameAddressLine1	String	30
nameAddressLine2	String	30
nameAddressLine3	String	30
nameAddressLine4	String	30
nameAddressLine5	String	30
nameAddressLine6	String	30
birthDate	Date Format
taxIdType	Tax ID Types
taxID	String
relationship	Relationship Types
percentageAllocation	Number		Number with two decimal place

Example

{
  "retirementBeneficiaries": [
    {
      "primaryContingent": "primary",
      "nameAddressLine1": "johnny",
      "nameAddressLine2": "bravo",
      "nameAddressLine3": "2 Perimeter Park S",
      "nameAddressLine4": "Suite 100W",
      "nameAddressLine5": "Birmingham",
      "nameAddressLine6": "AL",
      "birthDate": "1991-01-01",
      "taxIdType": "TaxId",
      "taxId": "980125678",
      "relationship": "other",
      "percentageAllocation": "50.30"
    },
    {
      "primaryContingent": "primary",
      "nameAddressLine1": "Timmy John ",
      "nameAddressLine2": "2 Perimeter Park S Suite 100W",
      "nameAddressLine3": "Birmingham",
      "birthDate": "2000-01-01",
      "taxIdType": "TaxId",
      "taxId": "987453211",
      "relationship": "spouse",
      "percentageAllocation": "49.70"
    }
  ]
}

Special Characters

The name & address lines allow for the following characters: /, -, #

Note

Any validation failure will trigger an error message and halt the Account Creation or Updation Process.

Error Scenarios

For any validation failures, refer Standard Errors and Account Related Errors.