Associatedindividual
AssociatedIndividual represents data for individuals that are associated with the account. Required fields for the individual fill vary based on the association and account type.
- Individual: customer > accountHolder > accountHolderDetails
- Retirement:
- customer > accountHolder > accountHolderDetails
- accounts> iraBeneficiaries > primaryBeneficiaries AND contingentBeneficiaries
- Joint: customer > jointHolder > firstHolderDetails and secondHolderDetails
- Trust: customer > trust > grantors AND beneficiaries
- Organization: customer > organization > associatedEntities > associatedIndividuals AND associatedEntities
Required
externalId
Unique identifier associated with the individual defined by counterparty.
- The
externalId,externalUserId, andexternalIndividualIdare unique identifiers which the counterparty assigns. The identifier can be used as a mapping to map the IBKR account with the account/user information within counterparty’s system. externalIdis present within application multiple times including:customer= Represents the customer which the account is associated withaccountHolderDetails, firstHolderDetails, secondHolderDetails: Represents Individuals associated with the account.accountHolder, jointHolder= Represents the account itselfusers(externalUserIdandexternalIndividualId)= Represents users associated with the account.
Sample
Required
name
Legal name of the associated individual.
- The
firstandlastare required. If either are missing, error will be thrown.
Email address of the associated individual.
- Regular Expression (REGEX)
^[A-Z0-9][A-Z0-9._%+-]{0,63}@(?:(?=[A-Z0-9-]{1,63}[.])[A-Z0-9]+(?:-[A-Z0-9]+)*[.]){1,8}[A-Z]{2,63}$ - Error thrown if email address is same as master account.
residenceAddress
Provide the residential address where the individual physically resides.
- If the mailing address is different from the address provided in
residenceAddresselement, THEN you will also includemailingAddresselement. - Post Office Box is not accepted for
residentialAddress. - Our system validates
street1andstreet2included withinresidenceAddressattribute to ensure Post Office Box address is not provided.- An error will be thrown if the below combinations are included within
street1ORstreet2:- PB
- PO Box
- Post Office Box
- P.O. Box
- In care of
- General Delivery
- Regular Expression to validate street_1 and street_2:
- English:
(?:P(?:ost(?:al)?)?[\.\-\s]*(?:(?:O(?:ffice)?[\.\\s]*)?B(?:ox|in|\b|\d)|o(?:ffice|\b)(?:[-\s]*\d)|code)|box[-\s]*\d) - Chinese Simplified:
PO Box (?i)\b((邮政信箱) [0-9]*)\bChinese Traditional: PO Box (?i)\b((郵政信箱) [0-9]*)\b
- English:
- An error will be thrown if the below combinations are included within
Dependent on type
countryOfBirth
Country which the individual was born.
- Accounts are accepted from citizens or residents of all countries except citizens or residents of those countries that are prohibited by the US Office of Foreign Assets Control.
- Click here for a list of all available countries.
- If countryOfBirth is classified as a ‘Prohibited Country’,
prohibitedCountryQuestionnaireis required. - List of Prohibited Countries an be obtained using
/api/v1/enumerations/prohibited-countryendpoint.
dateOfBirth
Date of birth of the associated individual.
- If the YYY-MM-DD < 18 years error will be triggered and the account will not be created.
- If YYYY-MM-DD < 21 the applicant is restricted to opening a CASH account only.
- UGMA and UTMA accounts are available for minors 18 years of age or younger. An individual or entity who manages an account for a minor until that minor reaches a specific age. Available to US residents only.
- This application must be opened using the front-end application which is available within the IBKR Portal.
- Assets held in a single account managed by a single Custodian user.
- Error will be thrown if
dateOfBirthis any value other than YYYY-MM-DD. The below formats will trigger errors:
employmentDetails
Provide the Employment Details of the associated individual if EMPLOYED or SELFEMPLOYED
employmentType: "EMPLOYED"OR “SELFEMPLOYED”- FA and FD clients with IBLLC, IB-IE, IB-CE, and IB-UK: Full
employerAddress(country, state, city, street1, postalCode) is required - All other clients,
countrywithinemployerAddressis required.
- FA and FD clients with IBLLC, IB-IE, IB-CE, and IB-UK: Full
- If
employmentType:"EMPLOYED" employmentType: "SELFEMPLOYED"employerAddresscan be the same asresidenceAddressORmailingAddress.businessDescriptionis required.
- EmploymentType=“EMPLOYED” OR “SELFEMPLOYED”
- When the country included within
residenceAddressnode is different from the country included withinemployerAddressnode, THENemplCountryResCountryDetailsis required within theemploymentDetailsnode.
- When the country included within
employmentType
Employment status of the associated person.
- IF
employmentType= EMPLOYED OR SELFEMPLOYED THEN EmploymentDetails are required.
gender
Gender of the applicant.
- Required for India and EEA applicants that are required to report MiFIR Data.
- MiFIR Transaction Reporting applies to European Economic Area (“EEA”) Investment Firms. As a client of an investment firm that uses the platform, you may be required to provide additional information to allow the proper transaction reports to be filed. More Information
identification
Identification information of the associated individual.
Acceptable id document is dependent the country which associated individual resides.
alienCard
All countries except for USA, CAN, HKG and IND.
"identification": {"citizenship": "MEX", "alienCard": "989444798", "issuingCountry": "MEX"},
driversLicense
Australia
"identification": {"citizenship": "AUS", "driversLicense": "989444798", "issuingCountry": "AUS", "expire": true, "expirationDate": "2029-03-22", "rta":"9999999", "issuingState":"AU-QLD"},
driversLicense
All countries except for USA, CAN, HKG, AUS and IND.
"identification": {"citizenship": "MEX", "driversLicense": "989444798", "issuingCountry": "MEX", "expire": true, "expirationDate": "2029-03-22"},
nationalCard
All countries except for USA, CAN, HKG and IND.
"identification": {"citizenship": "MEX", "nationalCard": "989444798", "issuingCountry": "MEX"},
hkTravelPermit
Macao and HK Travel Permit is accepted as POI for LLC Clients based in China.
"identification": {"citizenship": "CHN", "HKTravelPermit": "HO1234567", "issuingCountry": "CHN", "expire": true, "expirationDate": "2029-03-22"},
panNumber
Required for India Residents, Citizens, and Tax Residents.
"identification": {"citizenship": "IND", "panNumber": "AABPK6504E", "issuingCountry": "IND"}
passport
All countries except for USA, CAN, HKG and IND.
"identification": {"citizenship": "MEX", "passport": "989444798", "issuingCountry": "MEX", "expire": true, "expirationDate": "2029-03-22"},
sin
Required for Canada Residents, Citizens, and Tax Residents.
"identification": {"citizenship": "CAN", "sin": "989444798", "issuingCountry": "CAN"},
ssn
Required for United States Residents, Citizens, and Tax Residents.
"identification": {"citizenship": "USA","SSN": "989444798", "issuingCountry": "USA"}
taxId
All countries except for USA, CAN, HKG and IND.
"identification": {"citizenship": "ESP", "taxId": "989444798", "issuingCountry": "ESP"},
LocalTaxForms
Required when Non-US applicant requests trading permissions for Canada products OR Non-Australia/Non-U.S. applicant requests trading permissions for Australia products.
mailingAddress
Provide the mailing address of the applicant.
- IF
sameMailAaddress: “false” THENmailingAddressis required.
Example
Required
maritalStatus
Marital Status of the applicant
Example
Required
nativeName
Legal name of the associated individual.
- Required for Russia and Israel Applicants.
- Error will be thrown IF first OR last are missing or null value is provided.
- Optional for other countries.
numDependents
Number of dependents for the account holder.
ownershipPercentage
Ownership percentage for individual that is associated with the account.
- Set ownership percentage for each indivdual associated with the account.
- Joint:
ownershipPercentageis ignored unlesstypeistenants_common. - IRA and TRUST:
ownershipPercentageacross all beneficiaries must add up to 100 or else error will be triggered.
- Joint:
phones
Phone number of the associated individual.
- We use Google API to validate the Phone Number. The API allows for country code to be passed along with the phone number.
- Mobile Phone Number will be used for IBKR’s Two-Factor Authentication.
- Interactive Brokers requires all applicants to be enrolled in two-factor authentication.
- Account holders will be prompted to enroll in two factor authentication within 1 month of the account being opened and funded OR after the third login to the white branded Interactive Brokers Online Portal
- We offer HandyKey (mobile application). The application will be branded with your firms Logo.
- iOS/Android – Configured within Mobile Application
- Details: https://ibkr.info/article/2260
- Two-factor authentication cannot be enabled for clients using RESTful Web API
- We offer HandyKey (mobile application). The application will be branded with your firms Logo.
- Two-factor authentication cannot be enabled by the advisor/broker on behalf even if Supplemental Power of Attorney is enabled.
- For joint accounts, error will be thrown if
numberis same for both account holders.
residenceAddress
Provide the residential address where the individual physically resides.
- If the mailing address is different from the address provided in Residence element, THEN you will also include MailingAddress element.
- Post Office Box is not accepted for Residential Address.
- Our system validates street_1 and street_2 included within Residence attribute to ensure Post Office Box address is not provided.
- An error will be thrown if the below combinations are included within street_1 OR street_2:
- PB
- PO Box
- Post Office Box
- P.O. Box
- In care of
- General Delivery
- Regular Expression to validate street_1 and street_2:
- English:
(?:P(?:ost(?:al)?)?[\.\-\s]*(?:(?:O(?:ffice)?[\.\\s]*)?B(?:ox|in|\b|\d)|o(?:ffice|\b)(?:[-\s]*\d)|code)|box[-\s]*\d) - Chinese Simplified:
PO Box (?i)\b((邮政信箱) [0-9]*)\bChinese Traditional: PO Box (?i)\b((郵政信箱) [0-9]*)\b
- English:
- An error will be thrown if the below combinations are included within street_1 OR street_2:
sameMailAddress
Indicate if the mailing address is different from the residential address.
- IF
"sameMailAddress": false,THEN mailingAddress is required
taxResidencies
Tax Residency information of associated individual.
- Provide the tax residency of the associated individual.
- Multiple tax residencies can be provided.
translated
For applications submitted with dual language, indicate if data is translated.
- Indicates if the information is the translated version.
- It is used only when providing information in a different language and English.
- Default values is “false”.
- If
hasTranslationis set totrue,
w8Ben
Tax form for Non-U.S. Applicants only.
- Options for submitting tax form:
- Option 1: Advisor/IBroker collects the tax form records on your website and attaches the corresponding blank form in the JSON.
- Option 2: Advisor/IBroker will display the tax form on your website and client completes and signs the tax form electronically. Advisor/IBroker attaches the electronically completed and sign tax form along with the JSON.
w9
Tax form for U.S. Residents, Citizens, and Taxpayers.
- Options for submitting tax form:
- Option 1: Advisor/IBroker collects the tax form records on your website and attaches the corresponding blank form in the JSON.
- Option 2: Advisor/IBroker will display the tax form on your website and client completes and signs the tax form electronically. Advisor/IBroker attaches the electronically completed and sign tax form along with the JSON.
Specific to AssociatedIndividual for an Organization or Trust
authorizedPerson
For orgs, individual that is completing the application and signing agreements.
- Individual will be required to provide corporate resolution or similar document authorization opening of the account and establishing that the person identified on the page can sign on behalf of he account holder and has authority to do so.
- Applicable for
associatedIndividualslisted on an Org.
authorizedTrader
Indicate if individual is authorized to place trades for the account.
- Required if
entityTrusteeis listed for Trust. - If only
entityTrusteeis provided as Trustee, at least oneemployeefor theentityTrusteemust be authorized to trade. - If both
individualANDentityTrusteeare listed as Trustees, value can be set tofalseandindividualwill be set as the authorized trader
authorizedToSignOnBehalfOfOwner
Indicate if individual is allowed to sign on behalf of the owner.
- Required if
entityTrusteeis listed for Trust. - If only
entityTrusteeis provided as Trustee, at least oneemployeefor theentityTrusteemust be authorized to sign on behalf of the owner. - If both
individualANDentityTrusteeare listed as Trustees, value can be set tofalseandindividualwill be authorized signer.
primaryTrustee
Indicate if the individual is the primary trustee.
- Applicable for Australian Trust Accounts.
- If Non-Australia trust, this is not required.
- Cannot be more than one primary trustee.
- If
entityTrusteeis provided, primary flag should be included for theemployeeassociated with theentityTrustee - If Individual Trustee, include flag for
individual
title
Provide title of the associated individual.
- For Orgs and Trusts, set title for each individual that is associated with the account.
- For ORG if “
authorizedPerson": true, title code should be one of:- DIRECTOR
- OTHER OFFICER
- SECRETARY
- For Trust, at least one trustee must be specified.

