For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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
Type
Description
Query Filters (Optional)
acats
Query most up to date values for brokerId and brokerName. Used if funding via US ACATS extPositionsTransfers.
aton
Query most up to date values for brokerId and brokerName. Used if funding via ATON Canada extPositionsTransfers.
business-and-occupation
List of occupation AND employerBusiness for employmentDetails.
complex-asset-transfer
Query most up to date values for brokerName. Used if submitting a ComplexAssetTransfer (Basic FOP)
countries
List 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-plans
View EPA that are linked to master account (applicable IF offering SEP IRA accounts).
employee-track
Query most up to date companyId for account. For affiliationDetails, if company has an existing IBKR Employee Track account.
exchange-bundles
Query most up to date list of exchangeGroup for TradingPermissions.
fin-info-ranges
Query most up to date range IDs by currency for annualNetIncome, netWorth, liquidNetWorth.
currency ibEntity
market-data
View list of market data subscriptions.
product-country-bundles
Query most up to date list of product bundles (country and product) for TradingPermissions.
prohibited-country
View 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.
questionnaires
Query questions associated with EDD (Enhanced Due Diligence) or AVT (Additional Verification) tasks assigned to an account.
form-number
quiz-questions
Obtain list of questions associated with IBKR knowledge assessment.
form-number
security-questions
Obtain list of questions supported for IBKR security questions.
states
List 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.
