Get Registration Tasks

GET

/gw/api/v1/accounts/:accountId/tasks

GET

/gw/api/v1/accounts/:accountId/tasks

$ curl https://api.ibkr.com/gw/api/v1/accounts/accountId/tasks \
>      -H "Content-Type: application/json"

1 {
2   "accountId": "U1234567",
3   "description": "Account registration tasks pending completion.",
4   "error": {
5     "error": "InvalidRequest",
6     "message": "The request parameters are invalid.",
7     "status": 400
8   },
9   "errorDescription": "Invalid form number provided.",
10   "hasError": true,
11   "registrationTaskPresent": true,
12   "registrationTasks": [
13     {
14       "action": "complete",
15       "dateCompleted": "2024-01-15T09:30:00Z",
16       "externalId": "task-7890",
17       "formName": "W-9 Tax Form",
18       "formNumber": 101,
19       "isCompleted": false,
20       "isDeclined": false,
21       "isRequiredForApproval": true,
22       "questionIds": [
23         12,
24         34,
25         56
26       ],
27       "state": "pending",
28       "warning": "Please review your tax information carefully."
29     }
30   ],
31   "state": "in_progress",
32   "status": "pending"
33 }

Query registration tasks assigned to account and pending tasks that are required for account approval

Scope: accounts.read
Security Policy: HTTPS

Path parameters

accountIdstringRequired

Query parameters

typeenumOptionalDefaults to registration

Allowed values:

Response

Query registration tasks assigned to account and pending tasks that are required for account approval

RegistrationTasksResponseobject

PendingTasksResponseobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error