/getLoginMessages

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

  • Service to check whether there are any incomplete login tasks that need to be completed.

  • Query by account, custom group of accounts, all accounts associated with master, for accounts created within certain date range, OR login message type.

  • Service Includes: 

    • W8Ben

    • MiFIR Data

  • HTTP Request Type: POST

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

Required

accountIds

IBKR Client Account Number

List of one or more accounts

Optional- if querying by account ID or custom group of accounts.

startDate

yyyy-mm-dd

 

Optional- if querying for accounts created within specific date range.

endDate

yyyy-mm-dd

 

If startDate is provided, endDate is mandatory.

loginMsgType

W8INFO

MIFIR_INFO

Specify the loginMsg Type.

Optional- used to filter by Login Message Type

Option 1: By Account(s)

Copy
JSON Request
{"CSID":"<client-service-id>","accountIds":["<ID1>","<ID2>","..."]}
Copy
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getLoginMessages -d '{"CSID":"TesterCSID","accountIds":["U11111111","U222222","U333333"]}'

Option 2: All Sub Accounts

Copy
JSON Request
{"CSID":"<client-service-id>"}
Copy
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getLoginMessages -d '{"CSID":"TesterCSID"}'

Option 3: Accounts created within certain date range

Copy
JSON Request
{"CSID":"<client-service-id>","startDate":"<yyyy-mm-dd>","endDate":"<yyyy-mm-dd>"}
Copy
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getLoginMessages -d '{"CSID":"TesterCSID", "startDate":"2019-11-26","endDate":"2021-05-12"}'

Option 4: Login Message

Copy
JSON Request
{"CSID":"<client-service-id>","loginMsgType":"<loginMsgType>"}
Copy
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getLoginMessages -d '{"CSID":"TesterCSID", "loginMsgType":"W8INFO"}'

Name

Value

Description

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

accountIds

IBKR Client Account Number

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.

Msg_Type

String

Login Message Task that needs to be completed.

userName

String

User ID which the login message is assigned to.

recordDate

YYYY-MM-DD

Date which the task was assigned

description

String

Description of the login message.

isError

Boolean

Indicates if there was an error when processing the request.

isLoginMessagePresent

Boolean

Indicates if LoginMessagePresent is included within response file.

accountId

Client Account Number

 

description

A=Abandoned

N= New Account

O= Open

C= Closed

P= Pending

R= Rejected

Description of status

Error

String AND only populated if isError="true"

 

Description of error.

status

A= Abandoned (i.e. application was deleted)

N= New Account / Not Yet Open (pending online steps/pending agreements & disclosures on the account)

O= Open (Considered active accounts)

C= Closed (considered accounts that were once active OR open accounts that were and then closed.)

P= Pending (application steps are completed- pending approval or pending POI/POA submission)

R= Rejected (meaning account was never approved/opened- rejected by Compliance)

Current status of the account.

timestamp

YYYY-MM-DD HH:MM:SS

Date/Time request was submitted.

JSON Response

Copy 
{"result" : [
    {
      "loginMessages" : [ 
      {
         "msgType" : "<String>",
         "userName" : "<String>",
         "recordDate" : "<YYYY-MM-DD>",
         "description" : "<String>",
    
              }
      ],
      "isError" : "<true|false>",
      "isLoginMessagePresent" : "<true|false>,
      "acctId" : "<ID1>",
      "error" : "<error>" 
         "status" : "<String>",
 
    }
  ],
  "timestamp" : "<time_stamp>"
}

Sample

Copy 
curl -k -H "Content-Type:application/json" -X POST https://[domain]/ws/eca/getLoginMessages -d '{"CSID":"testerCSID", "accountIds":["U99999999"]}'                                             {
   "result":[
      {
         "loginMessages":[
            {
               "msgType":"W8INFO",
               "userName":"user09291",
               "recordDate":"2020-10-01",
               "description":"Provide W8 Information"
     
         ],
         "isError":false,
         "isLoginMessagePresent":true,
         "acctId":"U4344809",
         "description":"Open",
         "status":"O"
      }
   ],
   "timestamp":"2020-10-01 08:36:04"
}