/validateXML

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

Used to perform primary validations on the structure of the XML document (ie. mandatory data is missing, etc.) prior to submitting requests to create accounts.
- Does not validate the content of the XML (ie. TradePermissions vs. FinancialInformation, missing forms, etc.)

HTTP Request Type: POST

Request Parameters

Name	Value	Description	Usage
CSID	Client Service ID	Unique identifier issued by Interactive Brokers.	Required
payload	Encrypted and signed archive file, containing the XML file.		Required

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

Required

payload

Encrypted and signed archive file, containing the XML file.

Required

JSON Request

Copy

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

Sample

Copy

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

Response Parameters

Name	Value	Description
isValid	Boolean	Only included if isProcessed= TRUE
batchId	BatchId associated with the request.	When you receive the response, you will receive a batch ID.
timestamp	YYYY-MM-DD HH:MM:SS	Date/Time which the request was processed at.
isError	Boolean	Indicates if there was an error when processing the request.
Error	String AND only populated if isError="true"	Description of error.

JSON Response

Copy

{
  "timestamp": "<timestamp>",
  "fileData":" {
    "name":"<file_name_of_XML_XSD>",
    "data":"<encrypted XML XSD, encoded in base64>"
  }
}

Sample

Copy

{"isValid":true,"batchId":12345,"timestamp":"2020-02-10 10:53:36"}
Success 1 – All required data points are included in the XML
Success 2 – Invalid XML
{"isValid":false,"batchId":305895,"errors":[{"error":"Encryption Error. Please make sure that Payload is encrypted and signed with correct keys."}],"timestamp":"2020-02-11 15:18:54"}Error- Invalid Payload
 
{"isValid":false,"batchId":305525,"errors":[{"error":"Attribute prefix in Customer Node is incorrect. First and sixth characters must be letters in lower case."},{"error":"First Name is missing"},{"error":"Last Name is missing"},{"error":"Country Austria where Driver's License Card was issued is invalid."},{"error":"Email Address for Individual is missing."},{"error":"Multiple Titles only allowed for ORG."},{"error":"Source(s) of Wealth is missing."},{"error":"Investment Objectives are Mandatory."}],"timestamp":"2020-02-10 10:53:36"}