QuizQuestionnaires

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

  • Complete knowledge assessment.

    • 2430: FUND Knowledge Quiz

    • 2424: BOND Knowledge Quiz:

    • 2426: CFD Knowledge Quiz

    • 2428: CLP Knowledge Quiz

    • 2432: FUT Knowledge Quiz

    • 2436: MRGN Knowledge Quiz

    • 2438: OPT Knowledge Quiz
  • Fully-disclosed clients associated with EEA based entities.

  • IBKR will process request in real-time and return real-time response.

  • Submit application for applicant that is in scope of knowledge assessment.

    • The knowledge_level within AssetExperience will be ignored for all products with exception of Stocks.

  • For successful request, IBKR will process application and assign knowledge assessment to the account

    • Response returned by IBKR will include account credentials and pending tasks required for approval (Eg. Knowledge assessment IF complex products are requested).

    • The knowledge assessment can be obtained from Pending_Tasks section of the response file, see example below:

    • Copy 
      <Pending_Tasks>
      <Task Form_Number="2430" Form_Name="FUND Knowledge Quiz" Is_Required_For_Approval="true" Is_Required_For_Trading="true" Is_Online_Task="true">
      <Question_ID>3</Question_ID>
      <Question_ID>10</Question_ID>
      <Question_ID>9</Question_ID>
      <Question_ID>5</Question_ID>
      <Question_ID>6</Question_ID>
      <Question_ID>4</Question_ID>
      <Question_ID>7</Question_ID>
      <Question_ID>2</Question_ID>
      <Question_ID>8</Question_ID>
      <Question_ID>1</Question_ID>
      </Task>

  • Present questions to the user and collect response.

  • Submit client response to IBKR using QuizQuestionnaires

    • Client has 3 attempts to complete the questions

      • Each attempt, quiz response is recorded and evaluated to knowledge level.

    • If sufficient experience; task will be marked as complete and IBKR will proceed with adding the capabilities.

    • If insufficient experience; task will remain assigned and user can resubmit responses.

      • Client has 3 attempts to complete the questions

      • After the third attempt, IBKR will assign risk disclosure to user. If user accepts risk disclosure, IBKR will proceed with adding the capabilities. Otherwise, IBKR will remove capability and proceed with processing of the application.

XSD

Copy 
<xsd:complexType name="QuizQuestionnaires">
<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="question_id" use="Required" />
<xsd:attribute 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 QUIZ_QUESTIONS.

question_id

String

ID associated with the question. Use /getEnumerations QUIZ_QUESTIONS.
id String Answer id associated with the question. This can be obtained by /getEnumerations QUIZ_QUESTIONS
status

true

false

 If user receives insufficient score on the assessment, they will need to accept risk disclosure to proceed with adding of the permission.

Sample for Completion of Questionnaire

Copy 
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<QuizQuestionnaires reference_account_id="U1234567" >
<Questionnaire form_no="2432">
<Answer question_id="1" id="1" />
<Answer question_id="2" id="1" />
<Answer question_id="3" id="1" />
<Answer question_id="4" id="1" />
<Answer question_id="5" id="1" />
<Answer question_id="6" id="1" />
<Answer question_id="7" id="1" />
<Answer question_id="8" id="1" />
<Answer question_id="9" id="1" />
<Answer question_id="10" id="1" />
</Questionnaire>
<Questionnaire form_no="2430">
<Answer question_id="1" id="1" />
<Answer question_id="2" id="1" />
<Answer question_id="3" id="1" />
<Answer question_id="4" id="1" />
<Answer question_id="5" id="1" />
<Answer question_id="6" id="1" />
<Answer question_id="7" id="1" />
<Answer question_id="8" id="1" />
<Answer question_id="9" id="1" />
<Answer question_id="10" id="1" />
</Questionnaire>
<Questionnaire form_no="2438">
<Answer question_id="1" id="3" />
<Answer question_id="2" id="3" />
<Answer question_id="3" id="1" />
<Answer question_id="4" id="1" />
<Answer question_id="5" id="3" />
<Answer question_id="6" id="1" />
<Answer question_id="7" id="2" />
<Answer question_id="8" id="4" />
<Answer question_id="9" id="1" />
<Answer question_id="10" id="1" />
</Questionnaire>
</QuizQuestionnaires>
</AcctMgmtRequests>

Sample for Acceptance of Risk Assessment

Copy 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<QuizQuestionnaires reference_account_id="U1234567" >
    <Task form_no="2431" status="false" /><!--FUND-->
    <Task form_no="2433" status="true"/> <!--FUT-->
</QuizQuestionnaires>

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>
<QuizQuestionnaires reference_account_id="U123456" status="PROCESSED" request_id="2587723">
<Questionnaire form_no="2432" status="PENDING" message="Insufficient score. Kindly retake the quiz."></Questionnaire>
<Questionnaire form_no="2438" status="PROCESSED" message="Quiz Questionnaires has been accepted."></Questionnaire>
<Questionnaire form_no="2430" status="PENDING" message="Insufficient score. Kindly retake the quiz."></Questionnaire>
<Pending_Tasks>
<Task Form_Number="2432" Form_Name="FUT Knowledge Quiz" Is_Required_For_Approval="true" Is_Required_For_Trading="true" Is_Online_Task="true">
<Question_ID>3</Question_ID>
<Question_ID>1</Question_ID>
<Question_ID>6</Question_ID>
<Question_ID>5</Question_ID>
<Question_ID>2</Question_ID>
<Question_ID>7</Question_ID>
<Question_ID>8</Question_ID>
<Question_ID>4</Question_ID>
<Question_ID>9</Question_ID>
<Question_ID>10</Question_ID>
</Task>
<Task Form_Number="2430" Form_Name="FUND Knowledge Quiz" Is_Required_For_Approval="true" Is_Required_For_Trading="true" Is_Online_Task="true">
<Question_ID>10</Question_ID>
<Question_ID>7</Question_ID>
<Question_ID>1</Question_ID>
<Question_ID>4</Question_ID>
<Question_ID>3</Question_ID>
<Question_ID>6</Question_ID>
<Question_ID>8</Question_ID>
<Question_ID>5</Question_ID>
<Question_ID>2</Question_ID>
<Question_ID>9</Question_ID>
</Task>
</Pending_Tasks>
</QuizQuestionnaires>
</Process>