Skip to navigation
Schema

Introduction

View as MarkdownOpen in Claude

While fields for registration will vary based on various factors including the account type, IB entity, and permissions, the JSON should always include the following:

  • customer
  • accounts
  • users

This section includes information on objects and attributes for client registration, validations, and supported enumerations. List of required fields for client application based on account type can be found here.

Enumerations

The /api/v1/enumerations/{enumerationType} can be used to obtain supported enumerations for select attributes and objects.

Supported Types

TypeDescriptionQuery Filters (Optional)
acatsQuery most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers.
atonQuery most up to date values for brokerId and brokerName. Used if funding via ATON Canada extPositionsTransfers.
business-and-occupationList of occupation AND employerBusiness for employmentDetails.
complex-asset-transferQuery most up to date values for brokerName. Used if submitting a ComplexAssetTransfer (Basic FOP)
countriesList of country codes that are accepted. Contains information from the ISO-3166 database (https://opendatacommons.org/licenses/by/1-0/) which is made available under the ODC Attribution License.
employee-plansView EPA that are linked to master account (applicable IF offering SEP IRA accounts).
employee-trackQuery most up to date companyId for account. For affiliationDetails, if company has an existing IBKR Employee Track account.
exchange-bundlesQuery most up to date list of exchangeGroup for TradingPermissions.
fin-info-rangesQuery most up to date range IDs by currency for annualNetIncome, netWorth, liquidNetWorth.currency ibEntity
market-dataView list of market data subscriptions.
product-country-bundlesQuery most up to date list of product bundles (country and product) for TradingPermissions.
prohibited-countryView the list of prohibited countries. An error will be triggered if a prohibited country is provided for any field except Citizenship or Country of Birth. Applicants who reside in, are employed in, maintain tax residency in, or maintain a phone number in a prohibited country are restricted from opening an account with IBKR.
questionnairesQuery questions associated with EDD (Enhanced Due Diligence) or AVT (Additional Verification) tasks assigned to an account.form-number
quiz-questionsObtain list of questions associated with IBKR knowledge assessment.form-number
security-questionsObtain list of questions supported for IBKR security questions.
statesList of state and province codes that are accepted. Contains information from the ISO-3166 database (https://opendatacommons.org/licenses/by/1-0/) which is made available under the ODC Attribution License.