Overview
Applications

Open and update various types of accounts.

ACH Profiles

Create, update, and verify account ACH profiles.

Transactions

Manage deposit and withdrawal transactions on an account.

Documents

Fetch statements, tax documents and trade confirmations for customers.

Webhooks

Manage and test evented webhooks.

Virtual Accounts

Create and update paper trading accounts.

ACAT Transfers

Manage ACAT Transfers on an account.

Reference

Examples, response types, property details and explanations.

Application

Field Description Type
Id ID number of the submitted Application String
name Primary applicants name String
email Primary applicants email String
status Application status. One of: SUBMITTED, PENDING, APPROVED, REJECTED, ERROR, CANCELLED, VERIFIED, COMPLETED String
account Resulting account number from application. String
branchCode Branch code of the RIA String
repCode Representative code. String
advisorName Advisor name String
advisorIpAddress IP address of the advisor. String
applicantIpAddress IP address of the original applicant String
applicantSubmittedAt Timestamp of original submission Timestamp
createdAt Date/time when the application was created Timestamp
updatedAt Date/time when the application was last updated Timestamp
applicationType The application. See Application Types Object

applicationType

Field Description Type
type Type of the application. String
newAccountForm Form details for the application. Object

newAccountForm

Field Description Type
accountType Type of the account.
One of: CASH, MARGIN
String
customerType Type of customer.
One of: INDIVIDUAL, IRA, JOINT
String
tradeAuthorization.isTradeAuthorization Opt-in to limited trading authorization. One of: YES, NO String
tradeAuthorization.agentName Agent name with trading authorization String
applicants An array of applicants. Array

applicants

Field Description Type
identity Applicant identity information Object
identity.maritalStatus Current marital status.
One of: SINGLE, MARRIED, DIVORCED, WIDOWED
String
identity.name.givenName Given name. String
identity.name.familyName Family name. String
identity.dateOfBirth Date of birth. Date
(YYYY-MM-DD)
identity.citizenshipCountry Citizenship country. String
identity.socialSecurityNumber Social security number. String
identity.birthCountry Birth country. String
disclosures Applicant disclosure information Object
disclosures.isPoliticallyExposed Is applicant politically exposed.
One of: YES, NO
String
disclosures. isAffiliatedExchangeOrFINRA Is applicant affiliated with exchange or FINRA.
One of: YES, NO
String
disclosures.isControlPerson Is applicant a control person.
One of: YES, NO
String
disclosures.companySymbols List of ticker symbols. Array
disclosures.firmName Name of exchange or FINRA affiliation String
disclosures.politicalExposureDetail Details regarding political exposure. Object
disclosures.politicalExposureDetail.
politicalOrganization
Organization of political affiliiation String
disclosures.politicalExposureDetail.
immediateFamily
Family members with political exposure Array
employment Applicant employment information Object
employment.employmentStatus Applicant employment status.
One of: SELF_EMPLOYED, EMPLOYED, RETIRED, STUDENT, UNEMPLOYED
String
employment.yearsEmployed Number of years employed Number
employment.employer Employer String
employment.positionEmployed Current position at employer String
employment.businessAddress Address of current employer Object (See Address)
contact.homeAddress Home address Object (See Address)
contact.mailingAddress Mailing address Object (See Address)
contact.emailAddresses Applicant email addresses (at least 1) Array
contact.phoneNumbers Applicant phone numbers (at least 1) Array
principalApprover.approverName Principal representative who approved the applicant String
applicantSignature.eSigned Customer eSignature. One of: YES, NO String

suitabilityProfile

Field Description Type
timeHorizon Time horizon of the account.
One of: SHORT, AVERAGE, LONGEST
String
liquidityNeeds Liquidity needs of the account.
One of: VERY_IMPORTANT, SOMEWHAT_IMPORTANT,
NOT_IMPORTANT
String

investmentProfile

Field Description Type
riskTolerance Risk tolerance.
One of: LOW, MEDIUM, HIGH
String
investmentObjective Investment objectives.
One of: SPECULATION, GROWTH, INCOME
String
investmentExperience Investment experience of the applicant.
One of: NONE, LIMITED, GOOD, EXTENSIVE
String
annualIncomeUSD.min Annual income minimum amount. Number
annualIncomeUSD.max Annual income maximum amount. Number
liquidNetWorthUSD.min Liquid net worth minimum amount. Number
liquidNetWorthUSD.max Liquid net worth maximum amount. Number
totalNetWorthUSD.min Total net worth minimum amount. Number
totalNetWorthUSD.max Total net worth maximum amount. Number

retirementAccountBeneficiariesForm

Field Description Type
beneficiaries An array of beneficiaries for the retirement account. Array (See Beneficiary)

beneficiary

Field Description Type
name.givenName Beneficiary given name. String
name.familyName Beneficiary family name. String
address Address of this beneficiary. Object (See Address)
beneficiaryType The type of beneficiary. One of: PRIMARY, CONTINGENT String
dateOfBirth Beneficiary date of birth. String
sharePercent Percentage of benefits. Across all beneficiaries, must equal 100. Number
relationship Relationship to this beneficiary. String

Address

Field Description Type
streetAddress Street address. Multiline addresses supported. Array
country Address country. String
city Address city String
state Address state String
postalCode Postal code String

trustedContactForm

Field Description Type
givenName First Name String
familyName Last Name String
emailAddress Email address String
phoneNumber Phone Number String

optionAgreementForm

Field Description Type
riskStandardOptions Date signed the options risk disclosure Date (Ex. 2000-07-31)
uncoveredOptionWriters Date signed the uncovered options writer disclosure Date (Ex. 2000-07-31)
optionApproval Option levels. One through six. Integer (1-6)

marginAgreementForm

Field Description Type
deliveryDateMarginDisclosure Date signed the margin disclosure Date (Ex. 2000-07-31)