AddTradingPermissions

https://[domain]/ws/eca/update

  • Add Trade Permissions for existing account.

  • 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)

  • Non-Disclosed: Capabilities are effective immediately.

  • Fully-Disclosed and Advisor Clients:

    • New Regions: Trade Permissions for new regions are effective immediately

    • New Products: New Products take 1-2 business day to be processed and reviewed by our compliance team.

  • Use /getAmRequestStatus to check the status of the request.

  • If the exchange_group requires a form, the request to AddTradePermissions must be initiated by the client.

  • The account holder must be presented with the required form AND sign the required form before the counterparty submits the request to IBKR.

  • If the trading bundle does not require a form, you can submit to IBKR directly as the client does not need to sign a disclosure.

XSD

Copy 
<xsd:complexType name="AddTradingPermissions">
<xsd:sequence>
 <xsd:element name="TradingPermission" type="TradingPermission" maxOccurs="unbounded" />
</xsd:sequence>
<xsd:sequence>
 <xsd:attribute name="reference_account_id" type="xsd:string" use="required">
 <xsd:attribute name="<TradingPermission_Options" type="xsd:string" use="required">
</xsd:sequence>

TradingPermission_Options
 <xsd:attribute name="country" name="product" />
 <xsd:attribute name="exchange_group" />

Attributes

Name

Type

Description

TradingPermission

 

Trading Permission which the user is requesting to add.

  • 2 Options for providing TradingPermission

    • Option 1: Bundle Based (include country and product)

    • Option 2: Provide exchange_group 

 

reference_account_id

String

IBKR account ID of the advisor/broker client account permissions are being requested for.

Sample

Copy
Non-Disclosed Clients
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
    <AddTradingPermissions reference_account_id="U0000009">
        <TradingPermission exchange_group="US-Sec"/>
        <TradingPermission exchange_group="US-MUNIE"/>
    </AddTradingPermissions>
</AcctMgmtRequests>
Copy
Fully-Disclosed and Advisor-Clients
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
 <AddTradingPermissions reference_account_id="U0000009">
        <TradingPermission exchange_group="SecOpt"/>
  <DocumentSubmission reference_account_id="U0000009">
    <Document form_no="4003" exec_ts="20200208101201" exec_login_ts="20200208101201">
      <SignedBy>John Smith</SignedBy>
        <AttachedFile file_name="Form4003.pdf" file_length="43787" sha1_checksum="646asdf54654"/>
    </Document>
    <Document form_no="3076" exec_ts="20200208101201" exec_login_ts="20200208101201">
      <SignedBy>John Smith</SignedBy>
        <AttachedFile file_name="Form3076.pdf" file_length="43787" sha1_checksum="646asdf54654"/>
    </Document>
  </DocumentSubmission>
 </AddTradingPermissions>
</AcctMgmtRequests>

Name

Type

Description

Execution_Date

YYYY/MM/DD HH:MM:SS

Date/Time which the file was processed by IBKR.

Process_File

FirmName_YYYY-MM-DD_######.xml

File name of the request file.

Client

FirmName

Name of the Counterparty

Client_Master_Acct

String

Master account number
AddTradingPermissions sString Status of the request
reference_account_id String IBKR account ID of the advisor/broker client account which the request is being submitted for
request_status

PROCESSED

ERROR

PENDING

 Status of the request
message String Status of the request.
request_id Non-negative integer Unique ID which IBKR assigns to the request. The ID can be used to query status request at a later time using //getAmRequestStatus endpoint
message String Includes details on the status of the request IF status=”PENDING" or "PROCESSED "
Pending_Tasks <Tasks> Includes pending tasks associated with the info change request IF status=”PENDING". If the trading permission already exists, pending tasks will not be returned in the response file.
Errors String Includes error message if status=”ERROR”

Sample

Copy
Success
<?xml version='1.0' encoding='UTF-8'?>
<Process>
  <Execution ECA_XML_Schema_Version="15-Nov-2018">
    <Execution_Date>2020/02/20 00:44:38</Execution_Date>
    <Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
    <Client>TesterFA</Client>
    <Client_Master_Acct>F1234567</Client_Master_Acct>
  </Execution>
<AddTradingPermissions reference_account_id="U2088007" request_status="PROCESSED" message="Status of the request" request_id="50813">
       <TradingPermission exchange_group="US-SecOpt">Access Request Submitted</TradingPermission>    
</AddTradingPermissions>
</Process>
Copy
Error
<?xml version='1.0' encoding='UTF-8'?>
<Process>
  <Execution ECA_XML_Schema_Version="15-Nov-2018">
    <Execution_Date>2020/02/20 00:44:38</Execution_Date>
    <Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
    <Client>TesterFA</Client>
    <Client_Master_Acct>F1234567</Client_Master_Acct>
  </Execution>
<AddTradingPermissions reference_account_id="U2088007" request_status="ERROR" request_id="50813">
       <TradingPermission exchange_group="US-Sec">Access Already Exists</TradingPermission>
    <TradingPermission exchange_group="US-Sec">Access Already Exists</TradingPermission>
</AddTradingPermissions>
</Process>