SecurityQuestions

Who is this applicable for?

Fully Disclosed Client (Individual, Joint, Retirement, Org, Trust)
Advisor Client (Individual, Joint, Retirement, Org, Trust)

Processing Time

Changes are effective immediately.

Validations

Only supports submission of security questions. If already answered, cannot be processed again, meaning updates to existing questions cannot be made.
3 security questions are required.
Duplicate question OR answer is not supported, meaning all questions and answers need to be unique.

Request Parameters

XSD

Copy

<xsd:complexType name="SecurityQuestions">
<xsd:sequence>
 <xsd:attribute name="reference_user_name" type="xsd:string" use="required">
 <xsd:attribute name="input_language" type="xsd:string" use="optional">
</xsd:sequence>
<xsd:sequence>
 <xsd:element name="Details" use="required">
 <xsd:attribute name="question" type="xsd:string" use="required">
 <xsd:attribute name="answer" type="xsd:string" use="required">
</xsd:sequence>

Attributes

Name	Type	Description
reference_user_name	String	User name associated with the account. If you do not have the IBKR user name associated with the account, use /getAccountDetail to query user name based on account ID.
question	String	id associated with the security question. Use /getEnumerations 'SECURITY_QUESTIONS' to retrieve the id associated with question.
answer	String; Max 256 characters.	Response to the security question.

Sample

Copy

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<SecurityQuestions reference_user_name="tester1234" input_language="zh-Hans">
<Details question="9161083" answer="answer1" />
<Details question="6688721" answer="demo2" />
<Details question="9161123" answer="text3" />
</SecurityQuestions>
</AcctMgmtRequests>

Response Parameters

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
SecurityQuestions	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/09/16 08:43:26</Execution_Date>
<Process_File>SecurityQuestions.xml</Process_File>
<Client>NewMaster</Client>
<Client_Master_Acct>F123456</Client_Master_Acct>
</Execution>
<SecurityQuestions reference_user_name="test1234" request_status="PROCESSED" request_id="486582" message="Security Questions updated successfully."></SecurityQuestions>
</Process>

Copy

Error

<?xml version="1.0" encoding="UTF-8"?>
<Process>
<Execution ECA_XML_Schema_Version="15-Nov-2018">
<Execution_Date>2024/09/16 08:31:14</Execution_Date>
<Process_File>SecurityQuestion.xml</Process_File>
<Client>NewMaster</Client>
<Client_Master_Acct>F12346</Client_Master_Acct>
</Execution>
<SecurityQuestions reference_user_name="tester12333" request_status="ERROR" request_id="486578">
<Errors>
<Error>You are not allowed to process Security Questions. Please contact Sales Team at dam@ibkr.com.</Error>
</Errors>
</SecurityQuestions>
</Process>