Schema

Documents

View as MarkdownOpen in Claude

Include forms that are required for opening a brokerage account at IBKR. This includes any agreements, disclosures, Tax Form, and supplemental documents such as Proof of ID and Proof of Address documents.

Required forms will vary based on the account configuration and the account type.

  • NonQI / OWD
    • Tax Form
    • Proof of Identity / Proof of Address if Trulioo is NoMatch.
  • Fully-Disclosed / Advisor
    • Tax Form
    • Proof of Identity / Proof of Address if Trulioo is NoMatch.
    • Customer Type (Individual, Joint, IRA etc.)
    • Capabilities (Margin, Portfolio Margin)
    • Trade Permissions (United States Stocks, United States Options, etc.)
    • IBKR Entity the Account is associated with. (ie. IBLLC-US, IB-CAN, IB-UK, IB-IE etc.)

Schema

NameTypeUsage based on form_noDescription
fileNameStringAllFile name of the PDF document submitted to IBKR. fileName included within the documents request must match the fileName of the PDF file that is included within the signed request. Acceptable formats: .jpeg, .jpg, .pdf, .png Max size: 10 MB
fileLengthStringAllFile length associated with document.
sha1ChecksumStringAllSHA-1 is crypto algorithm that is used to verify that a file has been unaltered. This is done by producing a checksum before the file has been transmitted, and then again once it reaches its destination.
formNumberStringAllUse /gw/api/v1/accounts/{accountId}/tasks to view a list of forms that are required for approval.
execTimestampYYYYMMDDHHMMSSAllTimestamp of the execution of the agreement by the customer (i.e. time the client signed the agreement).
execLoginTimestampYYYYMMDDHHMMSSAllLogin timestamp for the session (when the client logged in and acknowledged the agreement.
signedByStringAllsignedBy must match the submitted: name (first + middle initial (if applicable) + last). *Data is case and space sensitive.
proofOfIdentityTypeAll Entities Except for IB-CAN Driver License Passport Alien ID Card National ID Card IB-CAN only Bank Statement Evidence of Ownership of Property Credit Card Statement Utility Bill Brokerage Statement T4 Statement CRA Assessment8001 8205 8053 8057Description of document submitted to salsify proof of identity.
proofOfAddressTypeBank Statement Brokerage Statement Homeowner Insurance Policy Bill Homeowner Insurance Policy Document Renter Insurance Policy bill Renter Insurance Policy Document Security System Bill Government Issued Letters Utility Bill Current Lease Evidence of Ownership of Property Driver License Other Document8002 8001 8205 8053 8057Description of document submitted to salsify proof of address.
validAddresstrue false8001If Driver License is provided as proofOfIdentityType AND validAddress=true, single document can be used to satisfy Proof of Identity and Proof of Address. ]
externalIndividualIdStringIdentifier at the external entity for the individual executing the agreement. Must be an individual listed on the application. Ignored for INDIVIDUAL applications as agreements must be executed by the Account Holder. Required for JOINT accounts created via ECA for POI/POA submission. For the JOINT holder created via ECA, external id of the account holder needs to be provided for which POI/POA is being submitted.
expirationDateYYYY-MM-DDDrivers License OR PassportProvide expiration date of the ID document.
mimeTypeapplication/pdf application/pdf image/png image/jpeg (Includes .jpeg, .jpg)Format of the file.
dataStringIncludes document encoded in base64.

Example

"documents": [
{
"signedBy": [
"Jane M Doe"
],
"attachedFile": {
"fileName": "Form5002.pdf",
"fileLength": 119331,
"sha1Checksum": "06c13ef0c01e831c1b9f0c2c0550812a4c242b3a",
"payload": {
                         "mimeType": "application/pdf",
                         "data": "<DocumentEncodedInBase64>"         }
                   
},
"formNumber": 5002,
"isValidAddress": false,
"execLoginTimestamp": 20240307114436,
"execTimestamp": 20240307114436
},
{
"signedBy": [
"Jane M Doe"
],
"attachedFile": {
"fileName": "POIandPOA.pdf",
"fileLength": 170163,
"sha1Checksum": "76bd4f17da8c8ed0d9ff752b5ffc0a1e38c16bd1"
},
"formNumber": 8001,
"expirationDate": "2029-10-29",
"proofOfIdentityType": "Drivers License",
"isValidAddress": true,
"execLoginTimestamp": 20240307114436,
"execTimestamp": 20240307114436
} ],