UpdateCredentials
https://[domain]/ws/eca/update
-
Update email address associated with account.
- All customer types.
Request Parameters
|
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. |
|
|
String |
New email address |
|
has_access |
true false |
Indicate if the user has access to the current email address. If the user does not have access to the current email address, the user cannot update the email address using DAM. |
|
token |
String |
Confirmation token sent by IBKR to applicant via email. |
Workflow for Fully-Disclosed and Advisor-Clients
Step 1: Send request to update email using /update endpoint
XSD
<xsd:complexType name="UpdateCredentials">
<xsd:sequence>
<xsd:attribute name="reference_user_name" type="xsd:string" use="required">
</xsd:sequence>
<xsd:element name="UpdateEmail">
<xsd:sequence>
<xsd:attribute name="email" type="xsd:string" use="required">
<xsd:attribute name="has_access" type="boolean" use="required">
</xsd:sequence>
Sample
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<UpdateCredentials reference_user_name="tester1234">
<UpdateEmail email="new@gmail.com" has_access="true" />
</UpdateCredentials>
</AcctMgmtRequests>
Step 2: Confirmation token for current email address
-
IBKR will send confirmation token to users current email address.
-
Counterparty instructs user to check email for confirmation token.
-
Counterparty sends confirmation token to IBKR
XSD
<xsd:complexType name="UpdateCredentials">
<xsd:sequence>
<xsd:attribute name="reference_user_name" type="xsd:string" use="required">
</xsd:sequence>
<xsd:element name="UpdateEmail">
<xsd:sequence>
<xsd:attribute name="email" type="xsd:string" use="required">
<xsd:attribute name="token" type="string" use="required">
<xsd:attribute name="has_access" type="boolean" use="required">
</xsd:sequence>
Sample
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<UpdateCredentials reference_user_name="tester1234">
<UpdateEmail email="new@gmail.com" token="1234" has_access="true" />
</UpdateCredentials>
</AcctMgmtRequests>
Step 3: Confirmation token for new email address
-
IBKR will send confirmation token to users new email address.
-
Counterparty instructs user to check email for confirmation token.
-
Counterparty sends confirmation token to IBKR
-
Email address is updated successfully
XSD
<xsd:complexType name="UpdateCredentials">
<xsd:sequence>
<xsd:attribute name="reference_user_name" type="xsd:string" use="required">
</xsd:sequence>
<xsd:element name="UpdateEmail">
<xsd:sequence>
<xsd:attribute name="email" type="xsd:string" use="required">
<xsd:attribute name="token" type="string" use="required">
<xsd:attribute name="has_access" type="boolean" use="required">
</xsd:sequence>
Sample
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<UpdateCredentials reference_user_name="tester1234">
<UpdateEmail email="new@gmail.com" token="3334" has_access="true" />
</UpdateCredentials>
</AcctMgmtRequests>Step 1: Send request to update email using /update endpoint; request will be processed immediately.
XSD
<xsd:complexType name="UpdateCredentials">
<xsd:sequence>
<xsd:attribute name="reference_user_name" type="xsd:string" use="required">
</xsd:sequence>
<xsd:element name="UpdateEmail">
<xsd:sequence>
<xsd:attribute name="email" type="xsd:string" use="required">
<xsd:attribute name="has_access" type="boolean" use="required">
</xsd:sequence>
Sample
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
<UpdateCredentials reference_user_name="tester1234">
<UpdateEmail email="new@gmail.com" has_access="true" />
</UpdateCredentials>
</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 |
| UpdateCredentials | 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
Step 1
<?xml version="1.0" encoding="UTF-8"?>
<Process>
<Execution ECA_XML_XSD_Version="15-Nov-2018">
<Execution_Date>2020/04/17 11:16:24</Execution_Date>
<Process_File>updateEmail.xml</Process_File>
<Client>USBroker</Client>
<Client_Master_Acct>F1234567</Client_Master_Acct>
</Execution>
<UpdateCredentials reference_account_id="U2088007" request_status="PENDING" message="Token sent to CurrentEmail@gmail.com. Pending confirmation token" request_id="50813"/>
</UpdateCredentials>
Step 2
<?xml version="1.0" encoding="UTF-8"?>
<Process>
<Execution ECA_XML_XSD_Version="15-Nov-2018">
<Execution_Date>2020/04/17 11:16:24</Execution_Date>
<Process_File>updateEmail.xml</Process_File>
<Client>USBroker</Client>
<Client_Master_Acct>F1234567</Client_Master_Acct>
</Execution>
<UpdateCredentials reference_account_id="U2088007" request_status="PENDING" message="Token sent to tester@gmail.com. Pending confirmation token" request_id="50813"/>
</UpdateCredentials>
Step 3
<?xml version="1.0" encoding="UTF-8"?>
<Process>
<Execution ECA_XML_XSD_Version="15-Nov-2018">
<Execution_Date>2020/04/17 11:16:24</Execution_Date>
<Process_File>updateEmail.xml</Process_File>
<Client>USBroker</Client>
<Client_Master_Acct>F1234567</Client_Master_Acct>
</Execution>
<UpdateCredentials reference_account_id="U2088007" request_status="PROCESSED" message="Email update processed" request_id="50813"/>
