AddCLPCapability

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

  • Add CLP (Complex Leverage Product) capabilities to an existing account.

  • All customer types.

  • Non-Disclosed: Capabilities are effective immediately.

  • Fully-Disclosed and Advisor Clients: Take 1-2 business day to be processed and reviewed by our compliance team.

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

    • 4155: Risk Disclosure for Complex or Leveraged Exch-Traded Products

  2. Eligibility is validated against users age, Investment Experience, and Financial Information.

  1. For Fully-Disclosed clients; the account holder must have a minimum of two years trading experience with stocks AND either options or futures.

Futures

  • 1 year, 1-10 Trades per year

    • This will not validate

    • Because client has less than two years trading Futures, client must take Futures Exam

  • 2 years, 1-10 Trades per year

    • This will validate if Knowledge level is Good or Extensive

    • Will not validate if Knowledge Level is Limited

Options

  • 1 year, 1-10 Trades per year

    • This will not validate

    • Because client has less than two years trading Options, client must take Options Exam

  • 2 years, 1-10 Trades per year

    • This will validate if Knowledge level is Good or Extensive

    • Will not validate if Knowledge Level is Limited

XSD

Copy 
<xsd:complexType name=" AddCLPCapability" "maxOccurs="unbounded" />
<xsd:sequence>
 <xsd:element name="reference_account_id" type="xsd:string" use="required">
</xsd:sequence>

Attributes

Name

Type

Description

reference_account_id

String

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

Sample

Copy
Non-Disclosed Clients
Non-Disclosed Clients<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
    <AddCLPCapability reference_account_id="U12345678" />
</AcctMgmtRequests>
Fully-Disclosed and Advisor-Clients:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
    <AddCLPCapability reference_account_id="U12345678" >
          <Documents>
          <Document form_no="4155" exec_ts="20200208101201" exec_login_ts="20200208101201">
              <SignedBy>John Smith</SignedBy> 
              <AttachedFile file_name="Form4155.pdf" file_length="32091" sha1_checksum="152817E99D6"/>
          </Document>
          </Documents>
    </AddCLPCapability>

</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
AddCLPCapability String 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"
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>
   <AddCLPCapability  reference_account_id="U2088007" request_status="PROCESSED" message="Status of the request" request_id="50813"/>
</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>
   <AddCLPCapability reference_account_id="U2088007" request_status="ERROR" request_id="50813">
    <Error>Error Message Here</Error>
  </AddCLPCapability>
</Process>