Enumerations

Everything enum related.

DriveWealth uses enums in different places to represent specific meanings. Below is a list of
available enums.

👀

Enum, not here?

Our apologies, drop us an email at [email protected] or on the right hand side click on ✏️
Suggest Edits with the specifics of what is missing.

Users

User Status

ENUMDefinition
PENDINGA user is pending approval.
APPROVEDA user has been approved.
REVOKEDA user has been rejected.
CLOSEDA user has been closed.

Identification Types

ENUMDefinition
SSNSocial Security Number
US_TINTax ID Number
FTINForeign Tax ID Number
EINEmployer Identification Number
GIINGlobal Intermediary Identification Number
FTNLOForeign TIN Not Legally Required

Investment profile - Trading Knowledge

Used by investmentOptionsKnowledge and investmentEquitiesKnowledge fields.

ENUMDefinition
NONENo trading knowledge or experience.
LIMITEDLimited trading knowledge or experience.
GOODGood trading knowledge and experience.
EXCELLENTExcellent trading knowledge and extensive experience.

Investment profile - Options Transaction Types

Used by investmentOptionsTransactionTypes to indicate types of options transactions the user has experience with.

ENUMDefinition
COVEREDCovered options strategies (e.g., covered calls).
LONGLong options strategies (e.g., buying calls or puts).
SPREADSSpread options strategies (e.g., vertical or calendar spreads).
NAKED_PUTSNaked (uncovered) put writing.
NAKED_CALLSNaked (uncovered) call writing.

Investment profile - Trading Objectives

Used by investmentObjectives and secondaryInvestmentObjectives to indicate the user's trading objectives.

ENUMDefinition
LONG_TERMLong-term buy and hold strategy.
INFREQUENTInfrequent trading activity.
FREQUENTFrequent trading activity.
ACTIVE_DAILYActive daily trading.
NEWNew to trading with no prior experience.
CAPITAL_PRESERVATIONCapital Preservation
GROWTHGrowth
INCOMEIncome
SPECULATIONSpeculation

Investment profile - Equities Transaction Types

Used by investmentEquitiesTransactionTypes to indicate position types the user has experience with.

ENUMDefinition
LONGLong equity positions.
SHORTShort equity positions.
MARGINMargin trading positions.

Accounts

Account Management Types

ENUMCodeDefinition
SELF0A user directs without any advice trades their own account.
ADVISORY1A user's account is accessible to an Investment Advisor or Investment Advisor Representative, but trades are placed only by the user's authorization.
RIA_MANAGED2An Investment Advisor has discretion to exercise trades in the user's account.
CUSTODIAL3An account for the benefit of a minor.
SMSF7SMSF (Self-Managed Super Fund) Account.
SMSF_MANAGED8Managed SMSF Account.
RESERVE15Credit Reserve Account. A cash management account, only for deposit and not for purchasing securities.
RETIREMENT_TRADITIONAL_SELF17Traditional Retirement Self Directed Account.
RETIREMENT_TRADITIONAL_ADVISORY18Traditional Retirement Managed Account.
RETIREMENT_TRADITIONAL_RIA_MANAGED19Traditional Retirement RIA Managed Account.
RETIREMENT_ROTH_SELF20Roth Retirement Self Directed Account.
RETIREMENT_ROTH_ADVISORY21Roth Retirement Managed Account.
RETIREMENT_ROTH_RIA_MANAGED22Roth Retirement RIA Managed Account.
TRUST_SELF23Self Directed Trust Account.
TRUST_ADVISORY24Trust Managed Account.
TRUST_RIA_MANAGED25Trust RIA Managed Account.
INHERITED_RETIREMENT_TRADITIONAL_SELF27Inherited Traditional Retirement Self Directed Account.
INHERITED_RETIREMENT_ROTH_SELF28Inherited Roth Retirement Self Directed Account.
HSA_SELF29Health Savings Self Directed Account.
HSA_ADVISORY30Health Savings Managed Account.
HSA_RIA_MANAGED31Health Savings RIA Managed Account.
BUSINESS_SELF35Self Directed Business Account.
BUSINESS_ADVISORY36Self Directed Advised Business Account.
BUSINESS_RIA_MANAGED37Robo Advisor Managed Business Account.
TRUMP_SELF41Trump Self Directed Account.

Options Level

Used by optionsLevel and requestedLevel fields on account options features.

ENUMDefinition
LEVEL_2Level 2 options trading — covered calls and protective puts

Account Status

ENUMNUMDefinition
PENDING1The account is in a pending state, most likely due to KYC.
OPEN2The account is open and trades allowed to be placed into the account.
OPEN_NO_NEW_TRADES3The account is open and no new trades can be placed.
FROZEN4The account is frozen and no new trades can be placed.
CLOSED9The account is closed.

Account Status Change Reason

ENUMCodeDefinition
OTHER0Other
ACAT1ACATS is processing
ACCOUNT_TRANSFERRED2Account has been transferred
COMPLIANCE_RESTRICTED3Partner has restricted the account
DECEASED4The person is deceased
DUPLICATE_ACCOUNT5Duplicate Account
FINRA_RESTRICTIONS6FINRA restriction applied on the account
LEGAL_AML7Legal Restriction (Fraud/AML)
MARGIN_CALLS8Margin call occurred on the account
PARTNER_RESTRICTED9Partner has restricted the account
PAYMENT_FAILURE10Payment failed on the account
PDT_RESTRICTIONS11DEPRECATED. PDT restriction applied on the account

Deposits

Deposit Status

ENUMNUMDefinition
STARTED0A new deposit request was received.
PENDING1The deposit details was accepted.
SUCCESSFUL2The deposit was successful.
FAILED3The deposit was not successful, thus failed.
OTHER4The deposit is in a suspended state.
RETURNED5The deposit was returned to the originating bank.
APPROVED14The deposit was approved.
REJECTED15The deposit was rejected.
ON_HOLD16The deposit details was accepted, but is not ready to be processed.
PROCESSING17The deposit is in Processing status.
--1An error occurred during the deposit.

Ira Contribution Types

ENUMDefinition
CURRENT_YEARCurrent Year Contribution
PRIOR_YEARPrior Year Contribution
POSTPONED_CONTRIBUTIONPostponed Contribution
DIRECT_ROLLOVERDirect Rollover Contribution
INDIRECT_ROLLOVERIndirect Rollover Contribution
DIRECT_TRANSFERDirect Transfer Contribution
CONVERSIONConversion Contribution
RECHARACTERIZATIONRecharacterization Contribution
REPAYMENTRepayment Contribution

Ira Contribution Subtypes

ENUMDefinition
SCThe self certification procedure for a late rollover contribution.
POA rollover of a qualified plan loan offset.
FDDue to a federally designated disaster .
EOCombat zone or hazardous duty area, declared by Executive Order.
PLCombat zone or hazardous duty area, not declared by EO.
QRRepayment of a qualified reservist distribution.
DDRepayment of a qualified disaster recovery distribution.
BARepayment of a qualified birth or adoption distribution.
EPRepayment of an emergency personal expense.
DARepayment of a domestic abuse victim distribution.
TIRepayment of a terminally ill individual distribution.

Trump Contribution Types

ENUMDefinition
SEC_128_EMPLOYEREmployer contribution
OTHER_SOURCEIndividual contributions
QUALIFIED_ROLLOVERTrustee-to-Trustee transfer of entire balance from another Trump Account
PILOT_PROGRAMU.S. Treasury Program
QUALIFIED_GENERALGrants from Govt, Tribes, or 501(c)(3) orgs

Withdrawals

Withdrawals Status

ENUMVARDefinition
STARTED0A new withdrawal was received.
PENDING1The withdrawal details was accepted.
SUCCESSFUL2The withdrawal was successful.
FAILED3The withdrawal was not successful, thus failed.
OTHER4The withdrawal is in a suspended state.
RIA_PENDING11The withdrawal is being handled by the RIA (AutoPilot) and the withdrawal details was accepted.
RIA_APPROVED12The withdrawal is approved when cash has settled against the managed account via AutoPilot.
RIA_REJECTED13The withdrawal is rejected when there is not enough has in the account after the selling of securities to cover the withdrawal request.
APPROVED14The withdrawal was approved.
REJECTED15The withdrawal was rejected.
ON_HOLD16The withdrawal details was accepted, but is not ready to be processed.
--1An error occurred during the withdrawal.

Ira Distribution Types

ENUMDefinition
NORMAL_DISTRIBUTIONNormal Distribution
EARLY_DISTRIBUTIONEarly Distribution
EARLY_DISTRIBUTION_PENALTY_EXCEPTIONEarly Distribution - Penalty Exception
DIRECT_ROLLOVERDirect Rollover
INDIRECT_ROLLOVERIndirect Rollover
DIRECT_TRANSFERDirect Transfer
CONVERSIONConversion
RECHARACTERIZATIONRecharacterization
REQUIRED_MINIMUM_DISTRIBUTIONRequired Minimum Distribution
DISTRIBUTION_TO_BENEFICIARYDistribution to Beneficiary
RETURN_OF_EXCESS_CONTRIBUTIONReturn of Excess Contribution
QUALIFIED_CHARITABLE_CONTRIBUTIONQualified Charitable Contribution

Ira Distribution Subtypes

ENUMDefinition
SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72TStructured periodic withdrawals
DISABILITY_OR_DEATHExempt from the penalty for beneficiaries or disabled individuals
HIGHER_EDUCATION_EXPENSESTuition, books, and fees for qualified institutions
FIRST_TIME_HOME_PURCHASEUp to $10,000 for a first home
MEDICAL_EXPENSESIf exceeding 7.5% of adjusted gross income (AGI)
HEALTH_INSURANCE_PREMIUMSIf unemployed for 12+ weeks
RESERVIST_DISTRIBUTIONSFor active-duty military service

Trump Distribution Types

Note: For external account transfers, excess contributions, or distributions due to death or disability,
please contact Partner Support or your Relationship Manager for manual processing.

Orders

Order Status

ENUMNUMDefinition
NEW0A newly created order received by the system.
PARTIAL_FILL1An order was partially filled.
FILL2An order was fully filled.
CANCELED4An order was canceled.
PENDING_CANCEL6An order was submitted to be canceled.
REJECTED8An order was rejected.
SUSPENDED9
PENDING_NEWA
CALCULATEDB
EXPIREDC

Order Type

ENUMVARDefinition
MARKET1A market order.
LIMIT2A limit order.
STOP3A stop order.
STOP_LIMIT4A stop limit order.
MARKET_IF_TOUCHED6A market if touched order.
UNKNOWNmAn unknown order.

TimeInForce type

ENUMVARDefinition
DAY0Order expires at next close.
GTC1Order expires at specified date.
MOO2Market On Open.
GTX5Order placed in extended hours.
MOC7Market On Close.
IOC3Immediate Or Cancel.
FOK4Fill Or Kill.

Exercise Status

ENUMDefinition
SUBMITTEDExercise Request submitted by Ops.
REJECTEDExercise Request Rejected for some reason by Ops.
ACCEPTEDExercise Request Accepted. Need to lock up position / cash.
COMPLETEDExercise Request Completed and entered into ABN - terminal.
ERRORError while submit Exercise Request.

Exercise Type

ENUMDefinition
EARLYEarly Exercise.
EXCEPTIONExercise by Exception.
DNEDo Not Exercise.

Instruments

Instrument Type

ENUMCodeDefinition
EQUITY_INDICES1Represents indices that track the performance of equity markets.
METALS2Represents commodities like gold, silver, and other precious metals.
ENERGY3Represents energy-related commodities like oil and natural gas.
INTEREST_RATES4Represents instruments tied to interest rate movements.
FX5Represents foreign exchange or currency trading.
EQUITIES6Represents individual stocks or shares of companies.
ETFS7Represents Exchange-Traded Funds, which are investment funds traded on stock exchanges.
MUTUAL_FUNDS8Represents pooled investment funds managed by professionals.
CYBER_SECURITY9Represents securities related to cybersecurity companies or technologies.
ETN10Represents Exchange-Traded Notes, which are debt securities.
ADR11Represents American Depositary Receipts, which are stocks of foreign companies traded in the U.S.
ALTERNATIVE_ASSET12Represents non-traditional assets like private equity or hedge funds.
IPO13Represents Initial Public Offerings, where companies go public.
CRYPTO14Represents cryptocurrencies like Bitcoin, Ethereum, etc.
OPTIONS15Represents financial derivatives that give the right to buy or sell an asset.
DEBT16Represents fixed-income securities like bonds or loans.

Instrument Status

ENUMDefinition
INACTIVEInactive
ACTIVEActive
CLOSE_ONLYClosed
EXPIREDExpired

Mutual Funds

Dividend Frequency

Used by mutualFundData.dividendFrequency.

ENUMDefinition
DAILYDividends are paid out daily.
WEEKLYDividends are paid out weekly.
FORTNIGHTLYDividends are paid out every two weeks.
MONTHLYDividends are paid out monthly.
BI_MONTHLYDividends are paid out every two months.
EVERY_FOUR_MONTHSDividends are paid out every four months.
QUARTERLYDividends are paid out quarterly.
SEMI_ANNUALLYDividends are paid out twice a year.
ANNUALLYDividends are paid out once a year.
OTHERDividends are paid out at some other frequency.

Fund Frequency

Used by mutualFundData.frequencyValuation, mutualFundData.frequencySubscriptions, and mutualFundData.frequencyRedemptions.

ENUMDefinition
DAILYThe fund operation occurs daily.
WEEKLYThe fund operation occurs weekly.
FORTNIGHTLYThe fund operation occurs every two weeks.
MONTHLYThe fund operation occurs monthly.
QUARTERLYThe fund operation occurs quarterly.
SEMI_ANNUALLYThe fund operation occurs twice a year.
ANNUALLYThe fund operation occurs once a year.

Asset Transfers

Asset Transfer Status

ENUMDefinition
STARTEDAsset transfer request has been initiated.
PENDINGAsset transfer request is pending.
SUCCESSFULAsset transfer request has been successfully completed.
ON_HOLDAsset transfer request is on hold.
FAILEDAsset transfer is failed.

ACAT

ACAT Source Account Type

ENUMDefinition
INDIVIDUALIndividual Account
JOINTJoint Account
CORPORATECorporate or Trust Account
CUSTODIALCustodial/Minor/Teen Account
IRAIndividual Retirement Account
RIA_MANAGEDRobo Advisor Managed Account
TRUMP_ACCOUNTTrump Account

ACAT Transfer type

ENUMDefinition
FULLFull Acats Transfer
PARTIALPartial Acats Transfer

ACAT Transit Type

ENUMDefinition
ACAT_INIncoming ACAT Transfer
ACAT_OUTOutgoing ACAT Transfer

ACAT Settlement Codes

ENUMCode
ACAT_RECEIVED000
ACAT_READY1ED
ACAT_READY_AFTER_CUTOFF1EL
ACAT_SENTTXX
ACAT_SENTTIF
ACAT_SENTTIL
ACAT_ACK100
ACAT_ADJUST110
ACAT_ADJUST120
ACAT_IN_PROGRESS130
ACAT_UNDER_REVIEW200
ACAT_REVIEW_ACK2ED
ACAT_REVIEW_ACK2EL
ACAT_REVIEW_SENT2XX
ACAT_REVIEW_ADJUST210
ACAT_REVIEW_ERROR220
ACAT_REVIEW_ACK22D
ACAT_REVIEW_ACK22L
ACAT_REVIEW_ACK22X
ACAT_REVIEW_ACCEPTED230
ACAT_PTR_IN_PROGRESS500
ACAT_SETTLEMENT_IN_PROGRESS300
ACAT_SETTLED310
ACAT_REJECTED140
ACAT_PURGE400
ACAT_REJECTED600
ACAT_PTR_REJECTED510

ACAT Rejection Codes

ENUMCodeDescription
UNKNOWNUnknownUnknown
SSN_NOT_MATCH01SSN/Tax ID Mismatch
ACCOUNT_NOT_MATCH02Account Title Mismatch
DOC_REQUIRED03Documentation Needed
ACCOUNT_FLAT04Account Flat
BROKER_NOT_MATCH05Invalid Broker Account Number
DUPLICATE_REQUEST06Duplicate
ACCOUNT_IN_TRANSIT07Account in Distribution or Transfer
BROKER_REJECTED08Client Rescinded
MISSING_AUTH_SIGN09Missing Authorized Signature
MISSING_FUND21Insufficient portfolio value to support debit
SYMBOL_NOT_SUPPORTED22Instrument not supported
QUANTITY_MISMATCH23Instrument quantity mismatch

Payment Status Phase

Used by Deposit Event statusPhase.

ENUMDefinition
BUYING_POWER_WITHHELDBuying Power On Hold; Seasoning Period Begins
BUYING_POWER_GRANTEDBuying Power Granted
WITHDRAWAL_POWER_GRANTEDWithdrawal Power Granted