Get Forms

GET

/gw/api/v1/forms

GET

/gw/api/v1/forms

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

1 {
2   "error": {
3     "status": 404,
4     "error": "Not Found",
5     "message": "No forms available for the given criteria"
6   },
7   "hasError": true,
8   "errorDescription": "No forms found matching the query parameters",
9   "fileData": {
10     "data": {},
11     "name": "N/A"
12   },
13   "formDetails": [
14     {
15       "formNumber": 1050,
16       "sha1Checksum": "3a7bd3e2360a3d5f8b9c1e2f4d5a6b7c8d9e0f1a",
17       "dateModified": "2024-01-15T09:30:00Z",
18       "fileName": "W-9_Form_2024.pdf",
19       "language": "en",
20       "formName": "W-9 Tax Form",
21       "payload": {
22         "mimeType": "application/pdf",
23         "data": "SGVsbG8gV29ybGQ="
24       },
25       "apiSupportedTask": true,
26       "type": "Tax Document",
27       "action": "Submit",
28       "acceptableDocs": [
29         "PDF",
30         "JPEG"
31       ],
32       "questionnaire": [
33         {
34           "questionId": 101,
35           "question": "Are you a U.S. citizen?",
36           "isMandatoryToAnswer": true,
37           "questionType": "boolean",
38           "answers": [
39             {
40               "answerId": 1,
41               "answer": "Yes",
42               "dependentQuestionId": 102,
43               "dependentAnswerId": 3,
44               "multiAnswerDetail": []
45             },
46             {
47               "answerId": 2,
48               "answer": "No",
49               "dependentQuestionId": 103,
50               "dependentAnswerId": 4,
51               "multiAnswerDetail": []
52             }
53           ]
54         }
55       ],
56       "error": {
57         "status": 0,
58         "error": "",
59         "message": ""
60       },
61       "hasError": false,
62       "errorDescription": "",
63       "fileLength": 24576
64     }
65   ],
66   "timestamp": "2024-01-15T09:30:00Z"
67 }

Get forms

Scope: accounts.read OR forms.read
Security Policy: HTTPS

Query parameters

formNolist of longsOptional

getDocsstringOptional

fromDatestringOptional

toDatestringOptional

languagestringOptional

projectionenumOptionalDefaults to NONE

Allowed values:

Response

Get forms

errorobjectOptional

hasErrorbooleanOptional

errorDescriptionstringOptional

fileDataobjectOptional

formDetailslist of objectsOptional

timestampdatetimeOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error