/create

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

Endpoint is used to create new accounts.
HTTP Request Type: POST

Request Parameters

Name	Value	Description
CSID	Client Service ID	Unique identifier issued by Interactive Brokers.
payload	Encrypted and signed archive file, containing forms and agreements.	Encrypted and signed archive (zip) file, encoded in base64. Refer to Submitting Files via Web-Servicefor instructions on how to encrypt the files. The archive will include the XML Application (See: Sample Applications) + Account Opening Forms (if Applicable). 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. For Fully-Disclosed/FA: If you submit forms at start of day (SOD) using /submitDocuments; the payload (/create) should then only include the XML file + the tax form (5001 nonUS or 5002 US).

Name

Value

Description

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

payload

Encrypted and signed archive file, containing forms and agreements.

Encrypted and signed archive (zip) file, encoded in base64. Refer to Submitting Files via Web-Servicefor instructions on how to encrypt the files.

The archive will include the XML Application (See: Sample Applications) + Account Opening Forms (if Applicable).
- 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.
- For Fully-Disclosed/FA: If you submit forms at start of day (SOD) using /submitDocuments; the payload (/create) should then only include the XML file + the tax form (5001 nonUS or 5002 US).

JSON Request

Copy

{
  "CSID":"<client-service-id>",
  "payload":"<encrypted and signed archive file, encoded in base64>"
}

Sample

Copy

curl -k -H "Content-Type:application/json" -X POST https://[domain]/ws/eca/create -d '{"CSID":"testerCSID", 
"payload":" ye0cQWpqaXp5aUnvUXHOGGVIQAJoJS2TeUymc/Xq5a0DMFCUk/EStTuLSHvxMOLoowBBl8BwueD2iyntVf+6iXGOz+/WAM/+Y/KheszZOWfasdfawe235afuD2Li2LT3RzRuxzlpi7CXgIQvqOVzWsSoB6mn/jK6BRRNWEXPhzmNgQB/gVReN"}'

Response Parameters

Name	Value	Description
timestamp	YYYY-MM-DD HH:MM:SS	Date/Time which the request was processed at.
isProcessed	Boolean	Indicate whether the request has been processed or not. In case request has been processed. true: Indicates the file was successfully submitted to Interactive Brokers. You will receive either Success OR Error fileData section will have account credentials in an encrypted XML file, encoded in base64 false: Indicates the XML format is invalid, incorrect keys are used or encrypt or sign file OR Server is down Sample Responses Error Handling
batchId	BatchId issued by IBKR for a given request.	When you receive the response, you will receive a batch ID.
name	Response-file name	Only included if isProcessed= TRUE
data	Encrypted response XML, encoded in base64	Only included if isProcessed= TRUE

JSON Response

Copy

{
  "timestamp": "<timestamp>",
  "isProcessed":"<true|false>",
  "batchId":"<batchId>",
    "name":"<response-file-name>",
  "fileData":" {
    "data":"<encrypted response XML, encoded in base64>"
  }
}

Sample

Copy

{
  "timestamp": "<2020-02-10 10:19:28>",
  "isProcessed":"true",
  "batchId":"<564654>",
    "name":"Tester_20190408_4564665_654654.xml.report",
  "fileData":" {"data":" hQIMA/mOMVbs3nc3ARAAn39g5AhKKwNVnWjzOSCpH1e+d7FJ2rb6aBMB/e 8X8oTxiA2PXvl8POLNWcu3Ka1tDMpuC9b47FM8g3/UjGDqP+/GRrLj9tJz89/R5BNmrcrAn5YUmRcYcsJx3EL B7G/Tc FqI8XML"
  }
}