EnrollInDRIP

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

  • Enroll existing account in Dividend Reinvestment Program (DRIP).

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

  • Eligibility

  • Fully-Disclosed and Advisor Clients: Requests submitted prior to 5pm EST will be effective the following business day.

  • To Enroll in DRIP (Dividend Reinvestment Program)

    • Client will need to request DRIP through the counterparties platform and be presented with the required DRIP agreements/disclosures which they will need to sign.

    • Counterparty will send IBKR-

      • An EnrollInDRIP XML Request

      • For Fully-Disclosed and Advisor Clients Only:

    • The request to EnrollInDRIP must be initiated by the client.

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

    • Required Forms:

      • 9610: Dividend Reinvestment Agreement

    • The payload will include the required forms + XML request. Signature must be recorded in the XML Request.

Name

Type

Description

reference_account_id

String

IBKR account ID of the advisor/broker client account DRIP is being requested for.

XSD

Copy 
<xsd:complexType name="EnrollInDRIP">
<xsd:sequence>
 <xsd:attribute name="reference_account_id" type="xsd:string" use="required">
</xsd:sequence>

Sample

Copy 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
 <EnrollInDRIP reference_account_id="U0000009">
  <Documents>
  <DocumentSubmission reference_account_id="U12345678">
    <Document form_no="9610" exec_ts="20200208101201" exec_login_ts="20200208101201">
     <SignedBy>John Smith</SignedBy>
     <AttachedFile file_name="Form9610.pdf" file_length="43787" sha1_checksum="49bfbf56ebd"/>
    </Document>
  </DocumentSubmission>
  </Documents>
 </EnrollInDRIP>
</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
EnrollInDRIP 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>
   <EnrollInDRIP 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>
   <EnrollInDRIP reference_account_id="U2088007" request_status="ERROR" request_id="50813">
    <Error>Error Message Here</Error>
  </EnrollInDRIP>
</Process>