Get Enumerations

View as MarkdownOpen in Claude
Used to query list of enumerations for attributes included within extPositionsTransfers, occupation, employerBusiness, financialInformation, affiliationDetails, tradingPermissions, etc.<br><br>**Scope**: `accounts.read` OR `enumerations.read`<br>**Security Policy**: `HTTPS`

Authentication

AuthorizationBearer

RS256-signed JWT access token signed with your registered private key.

Path parameters

enumerationenumRequired
<ul><li>exchange-bundles - query most up to date list of exchange-bundles for tradingPermissions</li><li>business-and-occupation - list of occupation and employerBusiness for employmentDetails</li><li>employee-track - query most up to date companyId for account. For affiliation details, if company has an existing IBKR Employee Track account</li><li>fin-info-ranges - query most up to date range IDs by currency for annualNetIncome, netWorth, liquidNetWorth</li><li>acats - query most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers</li><li>aton - query most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers</li><li>market-data - query most up to date values for brokerId and brokerName. Used if funding via ATON Canada extPositionsTransfers</li><li>edd-avt - query questions associated with EDD (Enhanced Due Diligence) or AVT (Additional Verification) tasks assigned to an account</li><li>prohibited-country - view list of prohibited countries. Applicants that reside in prohibited country are restricted from opening an account with IBKR. Error will be thrown IF legalResidenceCountry, OR country (included within Residence, mailingAddress and employerAddress, taxResidency node) is a prohibited country</li><li>employee-plans - view EPA that are linked to master account (applicable IF offering SEP IRA accounts)</li><li>questionnaires - obtain list of questionnaires</li><li>security-questions - obtain list of questions supported for IBKR security questions</li><li>quiz-questions - obtain list of questions associated with IBKR knowledge assessment</li><li>wire-instructions - obtain list of wire instructions</li><li>product-country-bundles - obtain list of product country bundles</li><li>countries - obtain list of countries</li><li>states - obtain list of states</li><li>identification - obtain catalog of required ID documents by country (including MiFIR rules). Pass type=mifir and one or more citizenship params to instead obtain the MiFIR-required ID document(s) for the given citizenship(s)</li></ul>
enumerationTypestringRequired

Query parameters

currencystringOptional
ibEntitystringOptional
mdStatusNonProstringOptional
form-numberstringOptional
languageenumOptional
accountIdstringOptional
userNamestringOptional
typestringOptional
citizenshiplist of stringsOptional

Response

Get enumerations
enumerationsTypestringOptional
formNumberstringOptional
jsonDataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error