/getPendingTasks
https://[domain]/ws/eca/getPendingTasks
-
Service is used to retrieve pending tasks for an existing account.
-
Query by account, custom group of accounts, all accounts associated with master, for accounts created within certain date range, OR pending task.
-
If supporting document was rejected; response will include rejection reason.
-
-
HTTP Request Type: POST
Request Parameters
|
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 |
View for accounts created within certain time period. |
Optional- if querying for accounts created within specific date range. |
|
endDate |
yyyy-mm-dd |
Filter by date when account was created. If start date is provided, end date is mandatory |
If startDate is provided, endDate is mandatory. |
|
formNumber |
Numeric |
Show list of all client accounts associated with master account ID that are assigned the form_no. Include startDate/endDate to query for that specific time range. |
Optional- used to filter list of accounts pending due to specific task or form_no. |
Option 1: By Account(s)
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getPendingTasks -d '{"CSID":"TesterCSID","accountIds":["U11111111","U222222","U333333"]}'Option 2: All Sub Accounts
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getPendingTasks -d '{"CSID":"TesterCSID"}'Option 3: Accounts created within certain date range
{"CSID":"<client-service-id>","startDate":"<yyyy-mm-dd>","endDate":"<yyyy-mm-dd>"}curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getPendingTasks -d '{"CSID":"TesterCSID", "startDate":"2019-11-26","endDate":"2021-05-12"}'Option 4: Pending Task or formNumber
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getPendingTasks -d '{"CSID":"TesterCSID", "formNumber":"8001"}'|
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. |
|
isRequiredForTrading |
Boolean |
If TRUE; no trades can be placed in the account until task has been completed. |
|
isOnlineTask |
Boolean |
If TRUE; user can log into IBKR Portal to complete pending task. |
|
action |
to send to complete to sign |
to send: Submit documents using theDocumentSubmission via the /update endpoint. to complete: Task needs to be completed within the IB Hosted Portal. Task can be completed by the master OR client. to sign: submit the missing form using theDocumentSubmission via /update endpoint. |
|
isRequiredForApproval |
Boolean |
Indicates if the pending_task is required for approval. If TRUE; indicates account will not be approved until the task has been completed. |
|
taskNumber |
Numeric Value |
For IBKR Internal use only |
|
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. |
|
isPendingTaskPresent |
Boolean |
Indicates if Pending_Task 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. |
|
formName |
Name of the required form |
|
|
state |
To Be Sent To Be Signed To Be Submitted To Be Completed Received- Being Processed Rejected .. <Rejection Reason> |
To Be Sent/Signed : Document that needs to be sent to IBKR. Document can be submitted using DocumentSubmission via the /update endpoint. To Be Completed: User needs to log into the IB Application (white branded) and complete the task. Optionally, advisor/broker can complete the pending item on behalf of the client within the IBKR Portal (Contacts > Select Contact > Agenda > Application Task > Upload documents. Received- Being Processed: Document is being reviewed by IBKR. Rejected .. <Rejection Reason> : Document was rejected by IBKR. Submit new document that meets IBKR's requirements. |
JSON Response
{"result" : [
{
"pendingTasks" : [
{
"isRequiredForTrading" : "<true|false>",
"isOnlineTask" : "<true|false>",
"formNumber" : "<form_number>",
"formName" : "<form_name>",
"action" : "<required_action>",
"isRequiredForApproval" : "<true|false>",
"taskNumber" : "<task_number"
}
],
"isError" : "<true|false>",
"isPendingTaskPresent" : "<true|false>,
"acctId" : "<ID1>",
"error" : "<error>"
}
],
"timestamp" : "<time_stamp>"
}Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getPendingTasks -d '{"CSID":"testerCSID", "accountIds":["U99999999"]}'
{
"result" : [ {
"pendingTasks" : [ {
"isRequiredForTrading" : "false",
"isOnlineTask" : "false",
"formNumber" : "8001",
"formName" : "Proof of identity and date of birth",
"action" : "to send",
"isRequiredForApproval" : "true",
"taskNumber" : "307786571"
}, {
"isRequiredForTrading" : "false",
"isOnlineTask" : "false",
"formNumber" : "8002",
"formName" : "Proof of address",
"action" : "to send",
"isRequiredForApproval" : "true",
"taskNumber" : "307786572"
}, {
} ],
"isError" : false,
"isPendingTaskPresent" : true,
"acctId" : "U99999999",
"description" : "New Account",
"error" : "",
"status" : "N"
} ],
"timestamp" : "2019-12-19 10:19:37"
}
