Customer
Who is this required for?
-
Fully Disclosed Client (Individual, Joint, Retirement, Org, Trust)
-
Advisor Client (Individual, Joint, Retirement, Org, Trust)
-
Non-Disclosed- NonQI Client (Individual, Joint, Org, Trust)
-
Non-Disclosed- QI Client with Trading (Individual, Joint, Org, Trust)
-
Non-Disclosed- QI Client with No Trading (Individual, Joint, Org, Trust)
Attributes
XSD
<xsd:complexType name="Customer" use="Required" minOccurs="1" maxOccurs="1" />
<xsd:sequence>
<xsd:attribute name="external_id" type="String" use="Required" />
<xsd:attribute name="prefix" type="prefix" use="Required" />
<xsd:attribute name="type" type="type" use="Required" />
<xsd:attribute name="email" type="String" use="Required" />
<xsd:attribute name="md_status_nonpro" type="Boolean" use="optional" />
<xsd:attribute name="user_name" type="String" use="Optional" />
<xsd:attribute name="robo_fa_client" type="Boolean" use="Required Robo-Advisor clients only." />
<xsd:attribute name="preferred_primary_language" type="Boolean" use="Required Robo-Advisor clients only." />
<xsd:attribute name="preferred_secondary_language" type="Boolean" use="Required Robo-Advisor clients only." />
</xsd:sequence>Parameters
|
Name |
Type |
Description |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
external_id |
String; max 64 characters |
Identifier for the account. This will be specified by the counterparty.
|
||||||||||
|
prefix |
3-6 lowercase letters. |
Prefix will be used when creating the user ID. IBKR will assign 3-6 numbers to the end of the prefix. If prefix includes the following, you will receive an error: • symbols or numeric values • Upper case letters • Prefix is less than 3 letters or more than 6 letters *This should be same prefix entered in the Users node. |
||||||||||
|
type |
INDIVIDUAL JOINT TRUST ORG |
INDIVIDUAL: Used for Individual Accounts and Retirement accounts. JOINT: An Interactive Brokers account owned by two individuals TRUST ORG
|
||||||||||
|
|
String |
Primary email address of the applicant. |
||||||||||
|
md_status_nonpro |
true false |
Indicate if the applicant is classified as Professional or Non-Professional user. Prices for live data will vary based on if the use is Pro OR Non-Professional. md_status_nonpro=FALSE IF any of the conditions outlined in the below link are met: https://ibkr.info/article/2369 |
||||||||||
|
user_name |
Alphanumeric
|
By default, IBKR will generate a user ID using the prefix that is specified in the Customer and User node. If the user would like to select the exact user name, this can be done with user_name. user_name allows the counterparty to specify the exact user ID for the IBKR portal. To utilize user_name, please contact dam@ibkr.com.
/isUserNameAvailablecan be used see if the userName is available. |
||||||||||
|
robo__fa_client |
true false |
Applicable for Robo-Advisors only. |
||||||||||
|
preferred_primary_language |
|
Specify Preferred Language for Communication sent by IBKR and for IBKR Systems including Portal and TWS.
|
||||||||||
|
preferred_secondary_language |
|
Specify Second Preferred Language for Communication sent by IBKR and for IBKR Systems including Portal and TWS. |
Sample
<Customer external_id="Paulina20200420" type="INDIVIDUAL" prefix="tester" email="dam@ibkr.com" md_status_nonpro="true" >
XSD
<xsd:element name="Customer" use="Required" minOccurs="1" maxOccurs="1" />
<xsd:sequence>
<xsd:attribute name="external_id" type="String" use="Required" />
<xsd:attribute name="prefix" type="prefix" use="Required" />
<xsd:attribute name="type" type="type" use="Required" />
<xsd:attribute name="email" type="String" use="Required" />
<xsd:attribute name="md_status_nonpro" type="Boolean" use="optional" />
<xsd:attribute name="meet_aml_standard" type="Boolean" use="Required for Non-Disclosed only." />
<xsd:attribute name="has_direct_trading_access" type="Boolean" use="Required for Non-Disclosed only." />
<xsd:attribute name="legal_residence_country" type="legal_residence_coountry" use="Required for NDIB" />
</xsd:sequence>Parameters
|
Name |
Type |
Description |
|---|---|---|
|
external_id |
String |
Identifier for the account. This will be specified by the counterparty.
|
|
prefix |
5-6 lowercase letters. |
Prefix will be used when creating the user ID. IBKR will assign 4-5 numbers to the end of the prefix. |
|
type |
INDIVIDUAL JOINT TRUST ORG |
INDIVIDUAL: Used for Individual Accounts and Retirement accounts. JOINT: An Interactive Brokers account owned by two individuals TRUST ORG
|
|
|
String |
Primary email address of the applicant. |
|
md_status_nonpro |
true false |
Indicate if the applicant is classified as Professional or Non-Professional user. Prices for live data will vary based on if the use is Pro OR Non-Professional. md_status_nonpro=FALSE IF any of the conditions outlined here are met. |
|
meet_aml_standard |
true false |
Customer meets anti-money laundering standards. Required for Non-Disclosed Clients only. |
|
has_direct_trading_access |
true false |
Indicate if the applicant will have direct access to placing trades. Required for Non-Disclosed Clients only. |
|
legal_residence_country |
Country of legal residence of the customer. Only relevant for Non-Disclosed Broker Clients. |
|
|
user_name |
Alphanumeric
|
By default, IBKR will generate a user ID using the prefix that is specified in the Customer and User node. If the user would like to select the exact user name, this can be done with user_name. user_name allows the counterparty to specify the exact user ID for the IBKR portal. To utilize user_name, please contact dam@ibkr.com.
/isUserNameAvailablecan be used see if the userName is available. |
Sample
<Customer external_id="NonDisclosed-Pauilna" type="INDIVIDUAL" prefix="tester" email="dam@ibkr.com" legal_residence_country="USA" meet_aml_standard="true" has_direct_trading_access="true" md_status_nonpro="true" >
