/update
https://[domain]/ws/eca/update
-
Update account information for existing accounts that are already opened AND complete registration tasks for pending accounts.
-
HTTP Request Type: POST

-
Open Accounts
Function
Usage
Fully Disclosed
Advisor-Clients
Non-Disclosed
AccountConfiguration Update account configuration for the account. N Y Update Investor Category for existing account.
Y
N
AddAdditionalAcct Create an additional account linked to the individuals existing user name. Y Y Add CLP capabilities for an existing account.
Y
Y
Add Leverage Forex Capabilities to existing account.
Y
Y
Add MiFIR Data for existing account.
Y
N
Add Trade Permissions for existing account.
Y
Y
ChangeAccountHolderDetail Change account information for existing account. Y
Y
ChangeBaseCurrency Change base currency for existing account. Y
Y
Update Financial information and Investment Experience for existing account
Y
N
Upgrade margin type for existing account
Y
Y
CompleteLoginMessage Complete login message using DAM for an existing account. Y N Enroll in Dividend Reinvestment Program.
Y
N
Enroll in Stock Yield Enhancement Program
Y
N
Unenroll in Dividend Reinvestment Program.
Y
N
Unenroll in Stock Yield Enhancement Program.
Y
N
Remove Trade Permissions for existing account
Y
Y
SecurityQuestions Process Security Questions. Y Y Update account alias for existing account
Y
Y
UpdateBCAN Generate BCAN for existing account. N Y UpdateCredentials Update email address associated with user. Y Y UpdateExternalId Update ExternalId associated with an account. Y Y UpdateWithholdingStatement Update Withholding Statement for existing account.
N Y UpdateTaxForm Update Tax Form for existing account.
Y Y -
Pending Applications
Function |
Usage |
Fully Disclosed Advisor-Clients |
Non-Disclosed |
---|---|---|---|
AbandonAccount | Delete a Pending Application. | Y | Y |
DocumentSubmission |
Submit documents required for approval. Includes agreements, disclosures, Proof of Address, Proof of Identity, etc. |
Y |
Y |
ProhibitedCountryQuestionnaire | Complete Prohibited Country Questionnaire for an account that is pending. | Y | Y |
Questionnaires |
Complete questionnaires that are required for approval (SOW Income Narrative, EDD OR Knowledge Assessment ). |
Y | N |
QuizQuestionnaires |
Complete knowledge assessment questionnaires that are required for approval . |
Y | N |
ResetAbandonedAccount | Reset an application that was previusly deleted. | Y | Y |

Name |
Value |
Description |
Usage |
---|---|---|---|
CSID |
Client Service ID |
Unique identifier issued by Interactive Brokers.
|
Required |
payload |
encrypted and signed archive file, encoded in base64 |
This method should be used irrespective of whether agreements are being submitted or not. We look for a file with an extension .xml in the archive. Refer to Submitting Files via Web-Servicefor instructions on how to encrypt the files. |
Required |
JSON Request
{
"CSID":"<client-service-id>",
"payload":"<encrypted and signed archive file, encoded in base64>"
}
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/update -d '{"CSID":"testerCSID", "payload":" /g/Gye0cQWpqaXp5aUnvUXHOGGVIQAJoJS2TeUymc/Xq5a0DMFCUk/EStTuLSHvxMOLoowBBl8BwueD2iyntVf+6iXGOz+/WAM/+Y/KheszZOWfasdfawe235afuD2Li2LT3RzRuxzlpi7CXgIQvqOVzWsSoB6mn/jK6BRRNWEXPhzmNgQB/gVReN"}'

Name |
Value |
Description |
---|---|---|
timestamp |
YYYY-MM-DD HH:MM:SS |
Date/Time which the request was processed at. |
fileData |
fileData section will provide details in an encrypted XML file, encoded in base64. |
Only included if isProcessed= TRUE |
name |
FirmName_YYYYMMDD_####_####.xml |
File name of the response file. |
data |
Encrypted response XML, encoded in base64 |
Service will return an encrypted XML file, encoded in base64. The XML file will contain results of the update request. |
JSON Response
{
"timestamp": "<timestamp>",
"fileData":" {
"name":"<response-file-name>",
"data":"<encrypted response XML, encoded in base64>"
}
}
Sample
Success
{
"timestamp": "2020-04-27 15:57:33",
"fileData":" {
"name":"IBLLC-US_20200427-111033.xml",
"data":"hQIMAzl3xUTO78dlAQ//Rtaaba/GOOTBFnqqw6bwa6se6JZ+lj1JhIZA4fpYIP"
} "
}