Questionnaires

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

  • Complete EDD for PENDING application.

  • Supported Questionnaires

    • 9943: SOW Income Narrative

    • EDD Questionnaires

    Use /getEnumerations to view question associated with the task number.

  • All account types.

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

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

XSD

Copy 
<xsd:complexType name="Questionnaires">
<xsd:sequence>
 <xsd:attribute name="reference_account_id" type="xsd:string" use="required">
</xsd:sequence>
<xsd:sequence>
 <xsd:element name="Questionnaire" maxOccurs="1" />
<xsd:attribute name="form_no" type="String" use="Required" />
</xsd:sequence>
<xsd:sequence>
<xsd:element name="Answer" use="Required" />
<xsd:attribute name="id" use="Required" />
<xsd:detail name="id" use="Required" />
</xsd:sequence>

Parameters

Name

Type

Description

reference_account_id

String

IBKR account ID of the advisor/broker which task is being completed for.

form_no String

Form number associated with the Questionnaire. Use /getEnumerations EDD_AVT to obtain questions based on the formNumber.

detail

String

Maximum of 350 Characters.

id String Answer id associated with the question. This can be obtained by /getEnumerations EDD_AVT.

Sample

Copy 
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<Questionnaires reference_account_id="U4091424">
<Questionnaire form_no="3400">
    <Answer id="1100" /> 
    <Answer id="1104" /> 
    <Answer id="1108" /> 
    <Answer id="1112" /> 
    <Answer id="1114" detail="1114 test" /> 
    <Answer id="1280" /> 
    <Answer id="1285" /> 
    <Answer id="1290" /> 
    <Answer id="1292" detail="1292 test"/> 
</Questionnaire>
</Questionnaires>
</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
ChangeFinancialInformation 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>2024/08/01 07:07:43</Execution_Date>
    <Process_File>security_question.xml</Process_File>
    <Client>Ronika</Client>
    <Client_Master_Acct>I1234567</Client_Master_Acct>
  </Execution>
  <Questionnaires reference_account_id="U123456" status="PROCESSED" request_id="456615" message="Questionnaire updated successfully."></Questionnaires>