UpdateBCAN

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

  • Generate BCAN for existing client account.

  • SFC regulation requires clients under IBHK with trading permissions to SEHK stocks OR bonds to provide BCAN.

  • Non Disclosed (QI and NonQI) - All Customer Types.

  • Non-Disclosed: Generated immediately.

  • Sub account must be opened

  • BCAN should be less than or equal to 10 digits

  • BCAN cannot start with p0

  • BCAN cannot be 1-99

  • Central entity number should be 6 digit alphanumeric identifier

XSD

Copy 
<xsd:complexType name="UpdateBCAN" "maxOccurs="unbounded" />
<xsd:sequence>
 <xsd:attribute name="reference_account_id" type="xsd:string" use="required">
 <xsd:attribute name="BCAN" type="xsd:String" use="required">
 <xsd:attribute name="CE_number" type="xsd:string" use="required">
</xsd:sequence>

Attributes

Name

Type

Description

reference_account_id

String

IBKR account ID of the advisor/broker client account permissions are being requested for.

BCAN String Broker-to-Client-Assigned-Number (BCAN). It must be 10 digits or less without leading 0 and it cannot be 1-99.
CE_number String Central entity number (CE#) of broker. It must be 6 digit alphanumeric identifier.

Sample

Copy
Non-Disclosed Clients
Non-Disclosed Clients<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AcctMgmtRequests xmlns="http://www.interactivebrokers.com/schemas/IBCust_import">
  <UpdateBCAN reference_account_id="U123456" BCAN="102" CE_number="AAL698"/>
</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
UpdateBCAN 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>2020/02/20 00:44:38</Execution_Date>
    <Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
    <Client>TesterFA</Client>
    <Client_Master_Acct>F1234567</Client_Master_Acct>
  </Execution>
   <UpdateBCAN reference_account_id="U2088007" request_status="PROCESSED" message="BCAN update processed" request_id="50813"/>
</Process>
Copy
Error
<?xml version='1.0' encoding='UTF-8'?>
<Process>
  <Execution ECA_XML_Schema_Version="15-Nov-2018">
    <Execution_Date>2020/02/20 00:44:38</Execution_Date>
    <Process_File>TesterFA_2020-02-20_124438885_761126.xml</Process_File>
    <Client>TesterFA</Client>
    <Client_Master_Acct>F1234567</Client_Master_Acct>
  </Execution>
   <UpdateBCAN reference_account_id="U2088007" request_status="ERROR" request_id="50813">
    <Error>Error Message Here</Error>
  </UpdateBCAN>
</Process>