{"openapi":"3.0.2","info":{"title":"Money Movement APIs","version":"2026-10-06","contact":{"email":"producteng@drivewealth.tech"}},"servers":[{"url":"https://bo-api.drivewealth.io/back-office","description":"Sandbox (No Real World Financial/Trading Impact)"},{"url":"https://bo-api.drivewealth.net/back-office","description":"Production"}],"security":[{"bearerAuth":[]}],"x-readme":{"explorer-enabled":false,"headers":[{"key":"dw-client-app-key","value":"{{yourAppKey}}"}]},"tags":[{"name":"Linked Bank Accounts"},{"name":"Virtual Bank Accounts"},{"name":"Deposits"},{"name":"Contribution Limits"},{"name":"Withdrawals"},{"name":"Payments"},{"name":"Withholding Defaults"},{"name":"Asset Transfer"},{"name":"Settlements"},{"name":"Subscriptions"}],"paths":{"/settlements":{"get":{"tags":["Settlements"],"summary":"List Bulk Funding Settlements","description":"Retrieves a list of Bulk Funding Settlements.","parameters":[{"in":"query","name":"from","schema":{"type":"string"},"required":true,"example":"2022-12-08","description":"The date to start from."},{"in":"query","name":"to","schema":{"type":"string"},"required":true,"example":"2022-12-25","description":"The date to end at."},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/singleSettlementStatus"},"required":false,"description":"Filters, the settlements by the status."},{"in":"query","name":"settlementProfileID","schema":{"$ref":"#/components/schemas/settlementProfileID"},"required":false,"description":"Filters, the settlements by the settlement profile."},{"in":"query","name":"limit","schema":{"type":"integer","default":50,"maximum":200},"required":false,"description":"The number of items to return."},{"in":"query","name":"offset","schema":{"type":"string","default":null},"required":false,"description":"Used for pagination. Set this to the first/last id value of your payload to get the prev/next page of results respectively."},{"in":"query","name":"direction","schema":{"type":"string","enum":["prev","next"],"x-enumDescriptions":{"prev":"Fetch the previous page of results.","next":"Fetch the next page of results."}},"required":false,"description":"The direction of the pagination."}],"responses":{"200":{"description":"Retrieving a list of Bulk Funding Settlements was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSettlementReports"}}}}}}},"/settlements/{settlementID}":{"get":{"tags":["Settlements"],"summary":"Get Bulk Funding Settlement","description":"Retrieves a Bulk Funding Settlement by settlementID.","parameters":[{"in":"path","name":"settlementID","schema":{"$ref":"#/components/schemas/singleSettlementID"},"required":true}],"responses":{"200":{"description":"Retrieving a Bulk Funding Settlement by settlementID was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSettlementByID"}}}},"404":{"description":"The Bulk Funding Settlement for the given settlementID doesn't exist."}}},"patch":{"tags":["Settlements"],"x-audience":"beta","summary":"Update Bulk Funding Settlement","description":"![beta](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDY0IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtQkVUQSIgeDE9IjAiIHkxPSIwIiB4Mj0iMCIgeTI9IjEiPjxzdG9wIG9mZnNldD0iMCUiIHN0b3AtY29sb3I9InJnYmEoMTQsMTY1LDIzMywwLjIyKSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0icmdiYSgxNCwxNjUsMjMzLDAuMDYpIi8+PC9saW5lYXJHcmFkaWVudD48ZmlsdGVyIGlkPSJnbG93LUJFVEEiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iNjIiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjMGVhNWU5IiBmaWx0ZXI9InVybCgjZ2xvdy1CRVRBKSIgb3BhY2l0eT0iMC41NSIvPjxyZWN0IHg9IjAuNSIgeT0iMC41IiB3aWR0aD0iNjMiIGhlaWdodD0iMTkiIHJ4PSIxMCIgZmlsbD0idXJsKCNncmFkLUJFVEEpIiBzdHJva2U9IiMwZWE1ZTkiIHN0cm9rZS13aWR0aD0iMSIvPjxjaXJjbGUgY3g9IjEwIiBjeT0iMTAiIHI9IjQuNSIgZmlsbD0iIzBlYTVlOSIgZmlsdGVyPSJ1cmwoI2dsb3ctQkVUQSkiIG9wYWNpdHk9IjAuNSIvPjxjaXJjbGUgY3g9IjEwIiBjeT0iMTAiIHI9IjMiIGZpbGw9IiMwZWE1ZTkiLz48dGV4dCB4PSIxOCIgeT0iMTMuNSIgZm9udC1mYW1pbHk9IkhlbHZldGljYSwgQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTAiIGZvbnQtd2VpZ2h0PSI3MDAiIGxldHRlci1zcGFjaW5nPSIwLjYiIGZpbGw9IiMwYzhlZTAiPkJFVEE8L3RleHQ+PC9zdmc+)\nUpdates a Bulk Funding Settlement by settlementID.","parameters":[{"in":"path","name":"settlementID","schema":{"$ref":"#/components/schemas/singleSettlementID"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleSettlementUpdate"}}}},"responses":{"202":{"description":"Updating a Bulk Funding Settlement by settlementID was Successful."},"404":{"description":"The Bulk Funding Settlement for the given settlementID doesn't exist."}}}},"/settlements/{settlementID}/attest":{"patch":{"tags":["Settlements"],"summary":"Attest Bulk Funding Settlement","description":"Attests a Bulk Funding Settlement if it is in a successful state and not already attested. Only available if the attestation feature is enabled for the partner.","parameters":[{"name":"settlementID","in":"path","required":true,"schema":{"$ref":"#/components/schemas/singleSettlementID"},"description":"The ID of the Bulk Funding Settlement to attest"}],"responses":{"200":{"description":"Attestation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttestSettlementResponse"},"example":{"id":"sett_123e4567-e89b-12d3-a456-000000000060_settle-profile-usa_20221224","settlementDate":"2024-04-17","status":"SUCCESSFUL","statusComment":"Finished processing breakdown","amount":{"total":5000.45,"credits":6000.45,"debits":-1000},"breakdownReport":"https://d111111abcdef8.cloudfront.net/singleSettlementReport....","partnerID":"123e4567-e89b-12d3-a456-000000000005","settlementProfileID":"settlement-profile-bank-account-1","createdAt":"2024-04-15T22:28:21.810Z","updatedAt":"2024-04-17T22:28:21.810Z","attestedBy":"123e4567-e89b-12d3-a456-000000000167","attestedAt":"2024-04-17T22:28:21.810Z"}}}},"400":{"description":"Bad request (already attested, not allowed, or other error)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"AlreadyAttested":{"summary":"Already attested","value":{"errorCode":"E020","message":"Value already exists. Details: Bulk Funding Settlement has already been attested"}}}}}},"404":{"description":"Bulk Funding Settlement not found or not accessible","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"NotFound":{"summary":"Not found","value":{"errorCode":"E050","message":"The resource you were trying to retrieve was not found. Not Found: settlementID: sett_123e4567-e89b-12d3-a456-00000000014f_20250904"}}}}}}}}},"/asset-transfers/acats":{"post":{"tags":["Asset Transfer"],"summary":"Create ACATS Transfer","responses":{"200":{"description":"Initiating a transfer was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ACATSTransferCreatedResponseModel"},"examples":{"ACATS Transfer (Full)":{"value":{"id":"acats_123e4567-e89b-12d3-a456-000000000019","source":"BROKER0001","sourceAccountID":"123e4567-e89b-12d3-a456-00000000001a.1234567890129","destination":"QQQQ000016","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","clearingNo":"0001","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"positions":[],"metadata":{},"auditDetails":[{"timestamp":"2023-07-28T23:56:10.507Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-07-28T23:56:10.645Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"<string>"}],"created":"2023-07-28T23:56:10.491Z","updated":"2023-07-28T23:56:10.667Z"}},"ACATS Transfer (Partial)":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000001c","source":"FOLIO123","sourceAccountID":"123e4567-e89b-12d3-a456-00000000001a.1234567890129","destination":"LLLL000011","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","clearingNo":"0001","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"cash":10,"positions":[{"symbol":"META","instrumentID":"123e4567-e89b-12d3-a456-00000000001d","quantity":1}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Invalid accountNo on request body":{"value":{"errorCode":"A012","message":"A required accountNo is missing or invalid. Refer to the API documentation for details.","errorDetails":{"field":"destination","type":"STRING"}}},"Source and Destination are same":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Source can't be DW account"}},"Destination account is not approved":{"value":{"errorCode":"T005","message":"ACAT Transfer cannot initiate. Destination account is not approved."}},"Invalid Symbol":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Symbol is not active or invalid.","errorDetails":{"field":"positions.symbol","type":"ARRAY"}}},"Invalid clearing broker":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"detail":"Refer supported DTCC Broker list on API documentation. ","field":"brokerCode","type":"STRING"}}},"Cash Should be Greater Than 0 400 Bad":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"detail":"cash should greater than 0","field":"cash","type":"DECIMAL"}}},"Invalid Symbol in Partial Acats Transfer 400 Bad":{"value":{"errorCode":"I019","message":"Invalid symbol(s) in the request body.","errorDetails":{"detail":"Invalid value for AMZ","field":"positions.symbol","type":"STRING"}}},"Positions Required on Partial Acat Transfer 400 Bad":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"field":"positions","type":"OBJECT"}}},"Acat Type is Missing 400 Bad":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"detail":"PARTIAL, FULL","field":"acatType","type":"ENUM"}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"ACAT Transfer permission has been denied":{"value":{"errorCode":"P075","message":"User does not have permissions to perform this operation. Contact your administrator. Forbidden: Create ACATS transfer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcatsCreateRequestModel"},"examples":{"ACAT Partial":{"value":{"sourceAccountType":"INDIVIDUAL","acatType":"PARTIAL","source":"ContraBroker001","destination":"FFFF000031","comment":"Hey! Welcome to DriveWealth Developer Docs!","metadata":{"myCustomKey":"myCustomValue"},"clearingNo":"0001","cash":0,"positions":[{"symbol":"MS","instrumentID":"123e4567-e89b-12d3-a456-000000000006","quantity":1}]}},"ACAT Cash Partial":{"value":{"sourceAccountType":"INDIVIDUAL","acatType":"PARTIAL","source":"ContraBroker001","destination":"FFFF000031","comment":"Hey! Welcome to DriveWealth Developer Docs!","metadata":{"myCustomKey":"myCustomValue"},"clearingNo":"0001","cash":10000}},"ACAT Full":{"value":{"sourceAccountType":"INDIVIDUAL","acatType":"FULL","source":"ContraBroker001","destination":"FFFF000031","comment":"Hey! Welcome to DriveWealth Developer Docs!","metadata":{"myCustomKey":"myCustomValue"},"clearingNo":"0001"}}}}}},"description":"The Automated Customer Account Transfer Service (ACATS) is a system that facilitates the transfer of securities from one trading account to another at a different brokerage firm or bank."},"patch":{"tags":["Asset Transfer"],"summary":"Update ACAT Transfer","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AcatsTransferGetResponseModel"}]},"examples":{"ACATS Transfer (Full)":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000001e","source":"ABC001","destination":"GGGG000006","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001f.1234567890131","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000005","name":"Stark House"},"incomingCash":1000,"positions":[],"incomingPositions":[{"symbol":"US023135AP19","cusip":"023135AP1","instrumentID":"123e4567-e89b-12d3-a456-000000000020","quantity":1,"instrumentType":"DEBT"},{"symbol":"GOOGL","cusip":"02079K305","instrumentID":"123e4567-e89b-12d3-a456-000000000021","quantity":1,"instrumentType":"EQUITY"},{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000022","quantity":1,"instrumentType":"EQUITY"},{"symbol":"US002824BH26","cusip":"002824BH2","instrumentID":"123e4567-e89b-12d3-a456-000000000023","quantity":1,"instrumentType":"DEBT"},{"symbol":"","cusip":"L6954L204","quantity":1},{"symbol":"SNOW","cusip":"833445109","instrumentID":"123e4567-e89b-12d3-a456-000000000024","quantity":1,"instrumentType":"EQUITY"}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250604131224","status724":"2ED","status":"ACAT_REVIEW_ERROR","positions":{"accepted":["000000000","833445109","02079K305"],"excluded":{"L6954L204":"Offshore MF found and excluded."}},"cash":1000},"rejectionInfo":{"rejectionCode":"SYMBOL_NOT_SUPPORTED","rejectionReason":"Instrument not supported","positions":{"023135AP1":"US023135AP19 is not supported. DEBT is not supported by Partner.","002824BH2":"US002824BH26 is not supported. DEBT is not supported by Partner."}},"auditDetails":[{"timestamp":"2025-06-04T16:43:49.039Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue","updatedBy":"123e4567-e89b-12d3-a456-000000000025"},{"timestamp":"2025-06-04T16:47:07.114Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created","updatedBy":"ACAT_SUBMISSION_SYSTEM"},{"timestamp":"2025-06-04T17:11:50.082Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer sent. Full Transfer without comma","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-06-04T17:12:57.327Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"TIF","comment":"Transfer sent. Full Transfer without comma","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-06-04T17:13:42.677Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"200","comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-06-04T18:56:25.499Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"220","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"}],"created":"2025-06-04T16:43:49.029Z","updated":"2025-06-04T18:56:25.499Z"}},"ACATS Transfer (Partial)":{"value":{"id":"acats_123e4567-e89b-12d3-a456-000000000026","source":"RR0069","destination":"XXXX000023","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","clearingNo":"0158","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming Acats Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"incomingCash":0,"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3},{"symbol":"SBSI","cusip":"84470P109","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":56}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013533","status724":"310","status":"ACAT_SETTLED","positions":{"accepted":["000000000"]}},"positions":[{"symbol":"AMD","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3},{"symbol":"SBSI","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":56}],"metadata":{},"auditDetails":[{"timestamp":"2023-10-20T13:02:50.970Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-10-20T15:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created","updatedBy":"ACAT_TRANSFER_SYSTEM"},{"timestamp":"2023-10-20T17:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"230","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"},{"timestamp":"2023-10-20T18:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"500","comment":"Partial transfer in progress","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2023-10-21T00:01:19.340Z","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"status724":"310","comment":"Transfer Settled","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"}],"created":"2023-10-20T13:02:50.960Z","updated":"2023-10-21T00:01:19.340Z"}},"ACATS Transfer accepted":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002a","source":"RR0069","destination":"DWWFP000907","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890132","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":0,"positions":[],"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013533","status724":"230","status":"ACAT_REVIEW_ACCEPTED","positions":{"accepted":["000000000"]}},"auditDetails":[{"timestamp":"2025-03-20T15:39:19.319Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T15:43:09.252Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created","updatedBy":"ACAT_TRANSFER_SYSTEM"},{"timestamp":"2025-03-20T15:44:26.852Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-03-20T15:45:03.041Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"230","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"}],"created":"2025-03-20T15:39:19.226Z","updated":"2025-03-20T15:44:27.029Z"}},"ACATS Transfer rejected, symbol unsupported":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002d","source":"FAKE001","destination":"DWWHA000914","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890133","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":100,"positions":[{"symbol":"BIOLQ","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"incomingPositions":[{"symbol":"BIOLQ","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013538","status724":"220","status":"ACAT_REVIEW_ERROR","cash":100},"rejectionInfo":{"rejectionCode":"SYMBOL_NOT_SUPPORTED","rejectionReason":"Instrument not supported","positions":{"000000000":"BIOLQ is not supported. TradeStatus is not active."}},"auditDetails":[{"timestamp":"2025-03-20T18:54:32.953Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T18:54:41.967Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created"},{"timestamp":"2025-03-20T18:56:19.001Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer is under review"},{"timestamp":"2025-03-20T18:56:27.547Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"220","comment":"ACAT auto-review completed. Ready for sending to DTCC."}],"created":"2025-03-20T18:54:32.914Z","updated":"2025-03-20T18:56:19.148Z"}},"ACATS Transfer rejected, Asset type unsupported":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002d","source":"FAKE001","destination":"DWWHA000914","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890133","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":100,"incomingPositions":[{"symbol":"US084664DA63","cusip":"084664DA6","instrumentID":"123e4567-e89b-12d3-a456-00000000002e","quantity":15},{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3},{"symbol":"SBSI","cusip":"84470P109","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":56}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013538","status724":"220","status":"ACAT_REVIEW_ERROR","cash":100,"accepted":["000000000","84470P109"]},"rejectionInfo":{"rejectionCode":"SYMBOL_NOT_SUPPORTED","rejectionReason":"Instrument not supported","positions":{"000000000":"BIOLQ is not supported. DEBT is not supported by Partner.."}},"auditDetails":[{"timestamp":"2025-03-20T18:54:32.953Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T18:54:41.967Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created"},{"timestamp":"2025-03-20T18:56:19.001Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer is under review"},{"timestamp":"2025-03-20T18:56:27.547Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"220","comment":"ACAT auto-review completed. Ready for sending to DTCC."}],"created":"2025-03-20T18:54:32.914Z","updated":"2025-03-20T18:56:19.148Z"}},"ACATS Transfer rejected, debit balance":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002f","source":"FAKE001","destination":"DWWNE000902","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890134","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"cash":500,"incomingCash":-700,"positions":[{"symbol":"AMD","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013541","status724":"220","status":"ACAT_REVIEW_ERROR","positions":{"accepted":["000000000"]}},"rejectionInfo":{"rejectionCode":"MISSING_FUND","rejectionReason":"Partial transfer cannot have debit balance.","cash":-700},"auditDetails":[{"timestamp":"2025-03-20T19:49:18.653Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T19:50:08.062Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"200","comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-03-20T19:50:32.102Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"220","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"}],"created":"2025-03-20T19:49:18.627Z","updated":"2025-03-20T19:50:08.308Z"}},"ACATS Transfer with excluded securities":{"value":{"id":"acats_123e4567-e89b-12d3-a456-000000000030","source":"FF-12-001","destination":"DWWNE000901","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890135","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":100,"positions":[{"symbol":"AMD","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15},{"symbol":"","cusip":"L7066G104","quantity":21},{"symbol":"","cusip":"L8066G104","quantity":21},{"symbol":"","cusip":"L9066G104","quantity":21}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013540","status724":"230","status":"ACAT_REVIEW_ACCEPTED","positions":{"accepted":["000000000"],"excluded":{"L7066G104":"Offshore MF found and excluded.","L8066G104":"Offshore MF found and excluded.","L9066G104":"Offshore MF found and excluded."}},"cash":100},"auditDetails":[{"timestamp":"2025-03-20T19:42:38.877Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T19:43:32.377Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"200","comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-03-20T19:43:56.113Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"230","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"}],"created":"2025-03-20T19:42:38.799Z","updated":"2025-03-20T19:43:32.611Z"}},"Minor Graduation":{"value":{"id":"grad_123e4567-e89b-12d3-a456-000000000031","source":"EEEE000030","destination":"FFFF000031","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"acatType":{"name":"FULL","description":"Full ACATs Transfer"},"type":{"name":"TEEN","description":"Teen Account Transfer"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"auditDetails":[{"timestamp":"2023-07-26T14:05:18.518Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"}],"created":"2023-07-26T14:05:18.518Z"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcatsUpdateRequestModel"},"examples":{"ACAT review: Reject Asset":{"value":{"reviewPositions":{"reject":[{"cusip":"023135AP1","comment":"US023135AP19 is not supported. DEBT is not supported by Partner."},{"cusip":"002824BH2","comment":"US002824BH26 is not supported. DEBT is not supported by Partner."}]}}}}}}},"description":"Review ACAT transfer request. This endpoint is used to reject securities from the transfer."}},"/asset-transfers/minor-graduation":{"post":{"tags":["Asset Transfer"],"summary":"Create Minor Graduation Transfer","responses":{"200":{"description":"Initiating a transfer was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericTransferResponseModel"},"examples":{"Minor Graduation Created":{"value":{"id":"grad_123e4567-e89b-12d3-a456-000000000031","source":"EEEE000030","destination":"FFFF000031","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"type":{"name":"TEEN","description":"Teen Account Transfer"},"created":"2023-07-26T14:05:18.518Z"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Validate Source accountNo 400 Bad":{"value":{"errorCode":"E033","message":"Invalid parameter in message body. Refer to the API documentation for details.","errorDetails":{"field":"source","type":"STRING"}}},"Validate Destination accountNo 400 Bad":{"value":{"errorCode":"E033","message":"Invalid parameter in message body. Refer to the API documentation for details.","errorDetails":{"field":"destination","type":"STRING"}}},"Source and Destination account can't be same in transfer 400 Bad":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Source and Destination accounts can't be same."}},"Destination account should be OPEN 400 Bad":{"value":{"errorCode":"U072","message":"User is not allowed to access this resource. Forbidden: XXXX009501 should be OPEN in order to initiate the transfer."}},"Source account should be OPEN 400 Bad":{"value":{"errorCode":"T004","message":"Assets Transfer cannot initiate. Details: YYYY009502 has PENDING account status, user can't initiate the transfer. Please contact support."}},"Source account has no cash and positions both 400 Bad":{"value":{"errorCode":"T004","message":"Assets Transfer cannot initiate. Details: ZZZZ009503 has no cash or positions, user can't initiate the transfer. Please contact support."}},"Missing Authorized User on Teen Account 400 Bad":{"value":{"errorCode":"A022","message":"Authorized user on account is missing. Refer to the API documentation for the details."}},"Duplicate Minor Asset Transfer Request 400 Bad":{"value":{"errorCode":"E020","message":"Value already exists. Details: Assets transfer request is already exist for AAAA009504"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinorCreateRequestModel"},"examples":{"Minor Graduation":{"value":{"source":"EEEE000030","destination":"FFFF000031","comment":"Migrating Teen account to Individual account.","metadata":{}}}}}}},"description":"If an Account is opened for the purpose of allowing a minor to invest, this API will allow for the transfer of assets from this account to the minor's own named account once they reach the age of majority."}},"/users/{userID}/bank-accounts":{"get":{"tags":["Linked Bank Accounts"],"summary":"List User Linked Bank Accounts","description":"Retrieves a list of User Linked Bank Accounts by userID.","parameters":[{"in":"path","name":"userID","schema":{"type":"string"},"required":true,"example":"123e4567-e89b-12d3-a456-000000000004","description":"Unique ID of the User to fetch their stored bank accounts."}],"responses":{"200":{"description":"Retrieving a list of User Linked Bank Accounts was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountsArray"}}}}}}},"/asset-transfers/{assetTransferID}":{"parameters":[{"schema":{"type":"string"},"name":"assetTransferID","in":"path","required":true}],"get":{"tags":["Asset Transfer"],"summary":"Retrieve Transfer","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AcatsTransferGetResponseModel"},{"$ref":"#/components/schemas/GenericTransferResponseModel"}]},"examples":{"ACATS Transfer (Full)":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002a","source":"FA-IJKE001","destination":"DWWFP000907","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890132","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":10000,"positions":[],"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":8},{"symbol":"SBSI","cusip":"84470P109","instrumentID":"123e4567-e89b-12d3-a456-000000000032","quantity":7},{"symbol":"TSLA","cusip":"88160R101","instrumentID":"123e4567-e89b-12d3-a456-000000000033","quantity":9}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013533","status724":"310","status":"ACAT_SETTLED","positions":{"accepted":["000000000","84470P109","88160R101"]},"cash":10000},"auditDetails":[{"timestamp":"2025-03-20T15:39:19.319Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T15:43:09.252Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created","updatedBy":"ACAT_TRANSFER_SYSTEM"},{"timestamp":"2025-03-20T15:44:26.852Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-03-20T15:45:03.041Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"230","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"},{"timestamp":"2023-10-20T18:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"500","comment":"Partial transfer in progress","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2023-10-21T00:01:19.340Z","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"status724":"310","comment":"Transfer Settled","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"}],"created":"2025-03-20T15:39:19.226Z","updated":"2025-03-20T15:44:27.029Z"}},"ACATS Transfer (Partial)":{"value":{"id":"acats_123e4567-e89b-12d3-a456-000000000026","source":"RR0069","destination":"XXXX000023","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","clearingNo":"0158","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming Acats Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"incomingCash":0,"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3},{"symbol":"SBSI","cusip":"84470P109","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":56}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013533","status724":"310","status":"ACAT_SETTLED","positions":{"accepted":["000000000"]}},"positions":[{"symbol":"AMD","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3},{"symbol":"SBSI","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":56}],"metadata":{},"auditDetails":[{"timestamp":"2023-10-20T13:02:50.970Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-10-20T15:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created","updatedBy":"ACAT_TRANSFER_SYSTEM"},{"timestamp":"2023-10-20T17:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"230","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"},{"timestamp":"2023-10-20T18:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"500","comment":"Partial transfer in progress","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2023-10-21T00:01:19.340Z","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"status724":"310","comment":"Transfer Settled","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"}],"created":"2023-10-20T13:02:50.960Z","updated":"2023-10-21T00:01:19.340Z"}},"ACATS Transfer accepted":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002a","source":"RR0069","destination":"DWWFP000907","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890132","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":0,"positions":[],"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013533","status724":"230","status":"ACAT_REVIEW_ACCEPTED","positions":{"accepted":["000000000"]}},"auditDetails":[{"timestamp":"2025-03-20T15:39:19.319Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T15:43:09.252Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created","updatedBy":"ACAT_TRANSFER_SYSTEM"},{"timestamp":"2025-03-20T15:44:26.852Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-03-20T15:45:03.041Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"230","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"}],"created":"2025-03-20T15:39:19.226Z","updated":"2025-03-20T15:44:27.029Z"}},"ACATS Transfer rejected, symbol unsupported":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002d","source":"FAKE001","destination":"DWWHA000914","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890133","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":100,"positions":[{"symbol":"BIOLQ","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"incomingPositions":[{"symbol":"BIOLQ","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013538","status724":"220","status":"ACAT_REVIEW_ERROR","cash":100},"rejectionInfo":{"rejectionCode":"SYMBOL_NOT_SUPPORTED","rejectionReason":"Instrument not supported","positions":{"000000000":"BIOLQ is not supported. TradeStatus is not active."}},"auditDetails":[{"timestamp":"2025-03-20T18:54:32.953Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T18:54:41.967Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created"},{"timestamp":"2025-03-20T18:56:19.001Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer is under review"},{"timestamp":"2025-03-20T18:56:27.547Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"220","comment":"ACAT auto-review completed. Ready for sending to DTCC."}],"created":"2025-03-20T18:54:32.914Z","updated":"2025-03-20T18:56:19.148Z"}},"ACATS Transfer rejected, Asset tye unsupported":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002d","source":"FAKE001","destination":"DWWHA000914","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890133","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":100,"incomingPositions":[{"symbol":"US084664DA63","cusip":"084664DA6","instrumentID":"123e4567-e89b-12d3-a456-00000000002e","quantity":15},{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":3},{"symbol":"SBSI","cusip":"84470P109","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":56}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013538","status724":"220","status":"ACAT_REVIEW_ERROR","cash":100,"accepted":["000000000","84470P109"]},"rejectionInfo":{"rejectionCode":"SYMBOL_NOT_SUPPORTED","rejectionReason":"Instrument not supported","positions":{"000000000":"BIOLQ is not supported. DEBT is not supported by Partner.."}},"auditDetails":[{"timestamp":"2025-03-20T18:54:32.953Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T18:54:41.967Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created"},{"timestamp":"2025-03-20T18:56:19.001Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer is under review"},{"timestamp":"2025-03-20T18:56:27.547Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"220","comment":"ACAT auto-review completed. Ready for sending to DTCC."}],"created":"2025-03-20T18:54:32.914Z","updated":"2025-03-20T18:56:19.148Z"}},"ACATS Transfer rejected, debit balance":{"value":{"id":"acats_123e4567-e89b-12d3-a456-00000000002f","source":"FAKE001","destination":"DWWNE000902","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890134","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"cash":500,"incomingCash":-700,"positions":[{"symbol":"AMD","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013541","status724":"220","status":"ACAT_REVIEW_ERROR","positions":{"accepted":["000000000"]}},"rejectionInfo":{"rejectionCode":"MISSING_FUND","rejectionReason":"Partial transfer cannot have debit balance.","cash":-700},"auditDetails":[{"timestamp":"2025-03-20T19:49:18.653Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T19:50:08.062Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"200","comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-03-20T19:50:32.102Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"220","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"}],"created":"2025-03-20T19:49:18.627Z","updated":"2025-03-20T19:50:08.308Z"}},"ACATS Transfer with excluded securities":{"value":{"id":"acats_123e4567-e89b-12d3-a456-000000000030","source":"FF-12-001","destination":"DWWNE000901","destinationAccountID":"123e4567-e89b-12d3-a456-00000000002b.1234567890135","clearingNo":"0123","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming ACAT Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-00000000002c","name":"Stark House"},"incomingCash":100,"positions":[{"symbol":"AMD","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15}],"incomingPositions":[{"symbol":"AMD","cusip":"000000000","instrumentID":"123e4567-e89b-12d3-a456-000000000028","quantity":15},{"symbol":"","cusip":"L7066G104","quantity":21},{"symbol":"","cusip":"L8066G104","quantity":21},{"symbol":"","cusip":"L9066G104","quantity":21}],"outgoingPositions":[],"settlementInfo":{"controlNo":"20250320013540","status724":"230","status":"ACAT_REVIEW_ACCEPTED","positions":{"accepted":["000000000"],"excluded":{"L7066G104":"Offshore MF found and excluded.","L8066G104":"Offshore MF found and excluded.","L9066G104":"Offshore MF found and excluded."}},"cash":100},"auditDetails":[{"timestamp":"2025-03-20T19:42:38.877Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2025-03-20T19:43:32.377Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"200","comment":"Transfer is under review","updatedBy":"ACAT_STATUS_UPDATE_SYSTEM"},{"timestamp":"2025-03-20T19:43:56.113Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"status724":"230","comment":"ACAT auto-review completed. Ready for sending to DTCC.","updatedBy":"ACAT_REVIEW_SYSTEM"}],"created":"2025-03-20T19:42:38.799Z","updated":"2025-03-20T19:43:32.611Z"}},"Minor Graduation":{"value":{"id":"grad_123e4567-e89b-12d3-a456-000000000031","source":"EEEE000030","destination":"FFFF000031","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"acatType":{"name":"FULL","description":"Full ACATs Transfer"},"type":{"name":"TEEN","description":"Teen Account Transfer"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"auditDetails":[{"timestamp":"2023-07-26T14:05:18.518Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"}],"created":"2023-07-26T14:05:18.518Z"}}}}}}},"description":"Get a Transfer's current details."}},"/bank-accounts":{"post":{"tags":["Linked Bank Accounts"],"summary":"Link Bank Account","description":"Links an external Bank Account. The `bankAccountNickname` cannot be the same as the bank account number.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/linkBankAccountReq"}}}},"responses":{"200":{"description":"Links an external Bank Account to a User was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/linkBankAccountRes"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"bankAccountNickname same as bankAccountNumber":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: bankAccountNickname cannot be the same as bankAccountNumber"}}}}}}}}},"/bank-accounts/{bankAccountID}":{"get":{"summary":"Retrieve Linked Bank Account","description":"Retrieves a Linked Bank Account by bankAccountID.","tags":["Linked Bank Accounts"],"parameters":[{"in":"path","name":"bankAccountID","schema":{"$ref":"#/components/schemas/bankAccountID"},"required":true}],"responses":{"200":{"description":"Retrieving a Linked Bank Account was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/linkBankAccountRes"}}}}}},"patch":{"summary":"Update Linked Bank Account","description":"Updates a Linked Bank Account by bankAccountID. The `bankAccountNickname` cannot be the same as the bank account number.","tags":["Linked Bank Accounts"],"parameters":[{"in":"path","name":"bankAccountID","schema":{"$ref":"#/components/schemas/bankAccountID"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updatedLinkedBankAccountReq"}}}},"responses":{"200":{"description":"Updating a Linked Bank Account was Successful."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"bankAccountNickname same as bankAccountNumber":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: bankAccountNickname cannot be the same as bankAccountNumber"}}}}}}}},"delete":{"summary":"Delete Linked Bank Account","description":"Removes a Linked Bank Account by bankAccountID.","tags":["Linked Bank Accounts"],"parameters":[{"in":"path","name":"bankAccountID","schema":{"$ref":"#/components/schemas/bankAccountID"},"required":true}],"responses":{"204":{"description":"Deleting a Linked Bank Account was Accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Bank account has an active recurring deposit":{"value":{"errorCode":"K100","message":"Bank account error. Details: Bank account cannot be deleted because active recurring deposits exist. Please delete them first."}}}}}}}}},"/asset-transfers":{"get":{"summary":"List Transfers","tags":["Asset Transfer"],"description":"Lists all of your Transfers across all Accounts. This can be filtered by type of Transfer.","parameters":[{"schema":{"$ref":"#/components/schemas/AssetTransferStatus"},"in":"query","name":"status","description":"A status to filter by"},{"schema":{"$ref":"#/components/schemas/AssetTransferType"},"in":"query","name":"type","description":"A Transfer type to filter by","required":true},{"in":"query","name":"limit","description":"Maximum number of records to be returned","schema":{"type":"string"}},{"in":"query","name":"offset","description":"Specify an identifier from last API response to go to the next page or prev page","schema":{"type":"string"}},{"in":"query","name":"direction","description":"Go to the next page or prev page","schema":{"type":"string","enum":["prev","next"],"x-enumDescriptions":{"prev":"Fetch the previous page of results.","next":"Fetch the next page of results."}}}],"responses":{"200":{"description":"Listing Transfers was successful","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/AcatsTransferListResponseModel"},{"$ref":"#/components/schemas/GenericTransferResponseModel"}]}},"nextPageOffset":{"type":"string","description":"The next page offset."},"prevPageOffset":{"type":"string","description":"The previous page offset."}}},"examples":{"List Assets Transfers [TEEN]":{"value":{"data":[{"id":"grad_123e4567-e89b-12d3-a456-000000000034","source":"HHHH000007","destination":"RRRR000017","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"type":{"name":"TEEN","description":"Teen Account Transfer"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"auditDetails":[{"timestamp":"2023-10-25T16:00:42.126Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-10-25T16:00:42.257Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer process started"},{"timestamp":"2023-10-27T21:00:07.959Z","status":{"name":"ON_HOLD","description":"Asset transfer request is on hold."},"comment":"Transfer is on hold for HHHH000007. Settlement is not finished yet."},{"timestamp":"2023-10-28T14:00:02.453Z","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"comment":"Transfer Completed"}],"created":"2023-10-25T16:00:42.126Z","updated":"2023-10-28T14:00:02.453Z"},{"id":"grad_123e4567-e89b-12d3-a456-000000000035","source":"PPPP000015","destination":"KKKK000010","status":{"name":"ON_HOLD","description":"Asset transfer request is on hold."},"type":{"name":"TEEN","description":"Teen Account Transfer"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"auditDetails":[{"timestamp":"2023-10-29T04:00:56.167Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-10-29T04:00:56.309Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Transfer process started"},{"timestamp":"2023-11-01T21:00:02.207Z","status":{"name":"ON_HOLD","description":"Asset transfer request is on hold."},"comment":"Transfer is on hold for PPPP000015. Settlement is not finished yet."}],"created":"2023-10-29T04:00:56.167Z","updated":"2023-11-01T21:00:02.207Z"}],"nextPageOffset":"123e4567-e89b-12d3-a456-000000000027#grad_123e4567-e89b-12d3-a456-000000000035#2023-07-28T23:55:34.142Z","prevPageOffset":""}},"List Assets Transfers [ACAT]":{"value":{"data":[{"id":"acats_123e4567-e89b-12d3-a456-000000000036","source":"RR0069","sourceAccountID":"123e4567-e89b-12d3-a456-00000000001a.1234567890129","destination":"XXXX000023","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","clearingNo":"1111","status":{"name":"PENDING","description":"Asset transfer request is pending"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"acatTransit":{"name":"ACAT_IN","description":"Incoming Acats Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"cash":12345.67,"positions":[{"symbol":"SBSI","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":213}],"metadata":{},"auditDetails":[{"timestamp":"2023-10-20T13:18:42.383Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-10-20T15:00:04.207Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created"}],"created":"2023-10-20T13:18:42.347Z","updated":"2023-10-20T15:00:04.216Z"},{"id":"acats_123e4567-e89b-12d3-a456-000000000026","source":"RR0069","sourceAccountID":"123e4567-e89b-12d3-a456-00000000001a.1234567890129","destination":"XXXX000023","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","clearingNo":"1111","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"PARTIAL","description":"Partial Acats Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"positions":[{"symbol":"ACHN","instrumentID":"123e4567-e89b-12d3-a456-000000000037","quantity":1},{"symbol":"SBSI","instrumentID":"123e4567-e89b-12d3-a456-000000000029","quantity":56}],"metadata":{},"auditDetails":[{"timestamp":"2023-10-20T13:02:50.970Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-10-20T15:00:04.185Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"TIF has been created"},{"timestamp":"2023-11-02T00:01:19.340Z","status":{"name":"SUCCESSFUL","description":"Asset transfer request has been successfully completed"},"comment":"Transfer Settled"}],"created":"2023-10-20T13:02:50.960Z","updated":"2023-11-02T00:01:19.340Z"},{"id":"acats_123e4567-e89b-12d3-a456-000000000038","source":"RR0069","sourceAccountID":"123e4567-e89b-12d3-a456-00000000001a.1234567890129","destination":"YYYY000024","destinationAccountID":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","clearingNo":"1111","status":{"name":"FAILED","description":"Asset transfer is failed."},"type":{"name":"ACAT","description":"ACAT transfer"},"acatType":{"name":"FULL","description":"Full Acats Transfer"},"sourceAccountType":{"name":"INDIVIDUAL","description":"Individual Account"},"partner":{"id":"123e4567-e89b-12d3-a456-000000000027","name":"Stark House"},"positions":[],"metadata":{"customer_id":"12345"},"rejectionInfo":{"rejectionCode":"ACCOUNT_NOT_MATCH","rejectionReason":"Account Title Mismatch"},"auditDetails":[{"timestamp":"2023-08-28T11:30:26.367Z","status":{"name":"STARTED","description":"Asset transfer request has been initiated."},"comment":"Transfer request has been submitted in queue"},{"timestamp":"2023-09-12T15:55:03.294Z","status":{"name":"PENDING","description":"Asset transfer request is pending"},"comment":"Request has been submitted for ACAT transfer"},{"timestamp":"2023-11-02T00:01:34.330Z","status":{"name":"FAILED","description":"Asset transfer is failed."},"comment":"Full Transfer Rejected. Contact Clearing Broker for further information"}],"created":"2023-08-28T11:30:25.805Z","updated":"2023-11-02T00:01:34.330Z"}],"nextPageOffset":"123e4567-e89b-12d3-a456-000000000027#acats_123e4567-e89b-12d3-a456-000000000038#2023-08-28T11:30:25.805Z","prevPageOffset":""}}}}}}}}},"/users/{userID}/funding/deposits":{"get":{"tags":["Deposits"],"summary":"List User Deposits","description":"Retrieves a list of User Deposits by userID.","parameters":[{"in":"path","name":"userID","schema":{"type":"string"},"required":true,"example":"123e4567-e89b-12d3-a456-000000000004","description":"The User's unique identifier."},{"in":"query","name":"status","schema":{"type":"string"},"example":"Successful,Pending","description":"Comma separated payment statuses"},{"in":"query","name":"type","schema":{"type":"string"},"example":"ACH,WIRE,BULK_FUNDING","description":"Comma separated deposit types"},{"in":"query","name":"limit","schema":{"type":"integer","default":25},"example":50,"description":"The number of deposits to be returned per page. Minimum=1, Maximum=100"},{"in":"query","name":"offset","schema":{"type":"string"},"example":"11AA000001-1234567890128-RJJLU","description":"Should either be null or the last payment result in the previous request"}],"responses":{"200":{"description":"Retrieving a list User Deposits by userID was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositsArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Limit should be greater than 0":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."}},"Limit should be less than or equal to 100":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"}}}}}}}}},"/accounts/{accountID}/funding/deposit-instructions":{"get":{"tags":["Virtual Bank Accounts"],"parameters":[{"in":"path","name":"accountID","schema":{"$ref":"#/components/schemas/accountID"},"required":true}],"summary":"Retrieve Account Virtual Bank Account","description":"Retrieves an Account Virtual Bank Account details by accountID.","responses":{"200":{"description":"Retrieving Virtual Bank Account details by accountID was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualAccountRes"}}}}}}},"/asset-transfers/transfers":{"post":{"tags":["Asset Transfer"],"summary":"Create Internal Asset Transfer","responses":{"200":{"description":"Initiating a transfer was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalTransferCreatedResponseModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Invalid source accountNo":{"value":{"errorCode":"E033","message":"Invalid parameter in message body. Refer to the API documentation for details.","errorDetails":{"field":"source","type":"STRING"}}},"Invalid destination accountNo":{"value":{"errorCode":"A012","message":"A required accountNo is missing or invalid. Refer to the API documentation for details.","errorDetails":{"field":"destination","type":"STRING"}}},"Invalid or missing transferType":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"detail":"FULL, PARTIAL, ALL_CASH, ALL_POSITIONS","field":"transferType","type":"ENUM"}}},"Positions are not allowed for ALL_CASH transfer":{"value":{"errorCode":"T004","message":"Assets Transfer cannot initiate.","errorDetails":{"detail":"Positions are not allowed for ALL_CASH transfer.","field":"positions","type":"ARRAY"}}},"Cash should not be provided for ALL_CASH transfer":{"value":{"errorCode":"T004","message":"Assets Transfer cannot initiate.","errorDetails":{"detail":"Cash should not be provided for ALL_CASH transfer.","field":"cash","type":"DECIMAL"}}},"Positions are not allowed for ALL_POSITIONS transfer":{"value":{"errorCode":"T004","message":"Assets Transfer cannot initiate.","errorDetails":{"detail":"Positions must not be provided for ALL_POSITIONS transfer.","field":"positions","type":"ARRAY"}}},"Cash should not be provided for ALL_POSITIONS transfer":{"value":{"errorCode":"T004","message":"Assets Transfer cannot initiate.","errorDetails":{"detail":"Cash should not be provided for ALL_POSITIONS transfer.","field":"cash","type":"DECIMAL"}}},"Negative cash is not acceptable":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"detail":"Negative cash is not acceptable.","field":"cash","type":"DECIMAL"}}},"Insufficient cash in source account":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"detail":"Insufficient cash in the account.","field":"cash","type":"DECIMAL"}}},"Duplicate symbol in positions":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details.","errorDetails":{"detail":"security AMD is duplicated, please remove duplicate and re-send transfer request","field":"positions","type":"ARRAY"}}},"Cash transfer outside sweep window":{"value":{"errorCode":"T004","message":"Assets Transfer cannot initiate. Details: Transfers involving cash for sweep-enabled accounts are only allowed between 4:30 AM and 1:30 PM ET."}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Internal Transfer permission has been denied":{"value":{"errorCode":"P075","message":"User does not have permissions to perform this operation. Contact your administrator. Forbidden: Create Internal transfer"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalTransfersCreateRequestModel"},"examples":{"Partial":{"value":{"source":"sourceAccountNo","destination":"destinationAccountNo","transferType":"PARTIAL","comment":"Partial Transfer","metadata":{},"cash":500,"positions":[{"symbol":"AMD","quantity":14}]}},"Full":{"value":{"source":"sourceAccountNo","destination":"destinationAccountNo","transferType":"FULL","comment":"Full Transfer","metadata":{}}},"All Cash":{"value":{"source":"sourceAccountNo","destination":"destinationAccountNo","transferType":"ALL_CASH","comment":"All Cash Transfer","metadata":{}}},"All Positions":{"value":{"source":"sourceAccountNo","destination":"destinationAccountNo","transferType":"ALL_POSITIONS","comment":"All Positions Transfer","metadata":{}}}}}}},"description":"The Internal Transfers API is a system that facilitates the transfer of cash and/or securities from one account to another at the same brokerage firm or bank. The transfers are permitted only if both accounts are under the same ownership."}},"/users/{userID}/recurring-deposits":{"get":{"tags":["Deposits"],"summary":"List User Recurring Deposits","description":"Retrieves a list of User Recurring Deposits by userID.","parameters":[{"in":"path","name":"userID","schema":{"type":"string"},"required":true,"example":"123e4567-e89b-12d3-a456-000000000004","description":"The User's unique identifier."}],"responses":{"200":{"description":"Fetching All User's Recurring Deposits was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringDepositsByUserID"}}}}}}},"/contribution-limits":{"get":{"tags":["Contribution Limits"],"operationId":"getContributionLimits","summary":"Retrieve contribution limits","description":"Retrieves standard contribution limits and age-based catch-up parameters for Traditional IRAs, Roth IRAs, and Trump Accounts for a given tax year.\n\nTraditional and Roth IRAs share one combined limit: a client holding both has a single allowance across the two, not the full limit in each.","parameters":[{"in":"query","name":"taxYear","required":false,"schema":{"type":"integer","example":2026},"description":"The tax year to retrieve limits for. Defaults to the current calendar year when omitted."}],"responses":{"200":{"description":"Retrieving contribution limits was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContributionLimitsResponse"},"examples":{"Contribution limits for 2026":{"value":{"taxYear":2026,"contributionLimits":{"ira":{"accountTypes":["TRADITIONAL_IRA","ROTH_IRA"],"standardLimit":7500,"catchUpAge":50,"catchUpAllowance":1000,"maximumAllowedLimit":8500,"note":"Traditional and Roth IRA contributions share this combined limit; it is not a separate limit per account type."},"trumpAccount":{"accountTypes":["TRUMP_ACCOUNT"],"standardLimit":5000,"maximumAge":17,"maximumAllowedLimit":5000,"contributionTypes":[{"contributionType":"SEC_128_EMPLOYER","description":"Employer contribution; tax-free to the employee.","subLimit":{"cumulativeAmount":2000,"limitApplied":2500,"remainingAllowance":500,"isLimitReached":false},"countsTowardLimit":true},{"contributionType":"OTHER_SOURCE","description":"Individual contributions (parent, grandparent, or other person), made with after-tax dollars.","subLimit":null,"countsTowardLimit":true},{"contributionType":"QUALIFIED_ROLLOVER","description":"Trustee-to-trustee transfer of the entire balance from another Trump Account.","subLimit":null,"countsTowardLimit":false,"note":"Not expected to occur under current product scope; included here for completeness."},{"contributionType":"PILOT_PROGRAM","description":"U.S. Treasury $1,000 grant for eligible children born 2025–2028.","subLimit":null,"countsTowardLimit":false},{"contributionType":"QUALIFIED_GENERAL","description":"Grants from government entities, tribes, or 501(c)(3) organizations.","subLimit":null,"countsTowardLimit":false}]}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Malformed taxYear":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: taxYear. Must be a four-digit year."}},"Limits not published for tax year":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: taxYear. Limits are not published for the requested tax year."}},"taxYear out of supported range":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: taxYear. Must be between 2025 and the current tax year."}}}}}}}}},"/funding/deposits":{"post":{"tags":["Deposits"],"summary":"Create Deposit","description":"Creates a Deposit.","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"type":"string","example":"a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6"},"required":false,"description":"A unique key (UUID) that is used to prevent duplicate requests. Should a network interruption occur, or you otherwise lost a response from the API, you can safely perform the request provided that you send the same value as the Idempotency-Key. DriveWealth Idempotency Keys are saved for 4 days. Within this time period, sending any request with a duplicate key will return the exact same response as the original request, including the same status code and payload."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositRequestReq"},"examples":{"Individual ACH Deposit":{"value":{"accountNo":"IIII000008","amount":100.25,"currency":"USD","type":"ACH","bankAccountID":"bank_123e4567-e89b-12d3-a456-00000000004a"}},"Bulk Deposit":{"value":{"accountNo":"IIII000008","amount":100.25,"currency":"USD","type":"BULK_FUNDING"}}}}}},"responses":{"200":{"description":"Creating a User's Account Deposit was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deposit"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Amount greater then maxDeposit set for partner":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Deposit amount exceeds maximum daily deposit amount limit of 100"}},"Missing bankAccountID":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Missing bankAccountID."}},"Enter only positive amounts":{"value":{"errorCode":"Custom","message":"Invalid amount. Enter only positive amounts."}},"Unknown accountNo":{"value":{"errorCode":"Custom","message":"Could not find [accountNo:  NOPE00000]"}},"bankAccountID does not exist":{"value":{"errorCode":"Custom","message":"Bank account not found [bankAccountID=bank_123e4567-e89b-12d3-a456-00000000004a]"}},"bankAccountID not linked to this account":{"value":{"errorCode":"K050","message":"Bank account temporarily disabled or not found. Contact customer support.","errorDetails":{"detail":"Bank account not found on the user.","field":"bankAccountID","type":"UUID"}}}}}}}}},"get":{"tags":["Deposits"],"summary":"List Deposits","description":"Retrieves a list of Deposits.","parameters":[{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/depositStatus"},"required":true,"description":"The current status of the deposit to filter by."},{"in":"query","name":"type","schema":{"$ref":"#/components/schemas/depositTypes"},"required":true,"description":"The type of deposit to filter by."},{"in":"query","name":"from","schema":{"type":"string"},"required":true,"example":"2022-12-08","description":"The date to start from."},{"in":"query","name":"to","schema":{"type":"string"},"required":true,"example":"2022-12-25","description":"The date to end at."},{"in":"query","name":"direction","schema":{"type":"string","enum":["prev","next"],"x-enumDescriptions":{"prev":"Fetch the previous page of results.","next":"Fetch the next page of results."}},"required":false,"example":"prev","description":"The direction of pagination."},{"in":"query","name":"parentIBID","schema":{"$ref":"#/components/schemas/partnerID"},"required":false,"description":"Filters the deposits list by the partnerID."}],"responses":{"200":{"description":"Retrieving a list of Deposits was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllDepositsForTheFirm"}}}}}}},"/funding/deposits/{depositID}":{"get":{"tags":["Deposits"],"summary":"Retrieve Deposit","description":"Retrieves Deposit details by depositID.","parameters":[{"in":"path","name":"depositID","schema":{"$ref":"#/components/schemas/depositID"},"required":true,"description":"A unique identifier for the user's account deposit."}],"responses":{"200":{"description":"Retrieving a Deposit by depositID was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveDepositResponse"}}}}}}},"/users/{userID}/annual-contribution-tally":{"get":{"tags":["Contribution Limits"],"operationId":"getAnnualContributionTally","summary":"Retrieve annual contribution tally","description":"Retrieves a user's contributions to date against the applicable tax-year limits, across all Traditional IRA, Roth IRA, and Trump Accounts they hold with DriveWealth.","parameters":[{"in":"path","name":"userID","schema":{"type":"string"},"required":true,"example":"123e4567-e89b-12d3-a456-00000000005a","description":"The user's unique identifier. The tally spans every eligible account held under this user."},{"in":"query","name":"taxYear","schema":{"type":"integer"},"example":2026,"description":"The tax year to tally contributions against. Defaults to the current calendar year."}],"responses":{"200":{"description":"Retrieving the contribution tally was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/annualContributionTallyResponse"},"examples":{"IRAs, under 50":{"summary":"IRAs, under 50","description":"Contributed past the ceiling, so `remainingAllowance` is negative. Partners displaying headroom should clamp at zero or surface the excess explicitly.","value":{"userID":"123e4567-e89b-12d3-a456-00000000005a","taxYear":2026,"ira":{"limitApplied":7500,"cumulativeAmount":7600,"remainingAllowance":-100,"isLimitReached":true,"accounts":[{"accountID":"123e4567-e89b-12d3-a456-000000000058.1234567890141","accountType":"TRADITIONAL_IRA","amount":4000},{"accountID":"123e4567-e89b-12d3-a456-000000000152.1234567890196","accountType":"ROTH_IRA","amount":3600}]}}},"IRAs, 50 and over":{"summary":"IRAs, 50 and over","description":"Same $7,600 contributed as the under-50 example, but the catch-up lifts `limitApplied` to $8,500, so this user still has room.","value":{"userID":"123e4567-e89b-12d3-a456-000000000153","taxYear":2026,"ira":{"limitApplied":8500,"cumulativeAmount":7600,"remainingAllowance":900,"isLimitReached":false,"accounts":[{"accountID":"123e4567-e89b-12d3-a456-000000000154.1234567890197","accountType":"TRADITIONAL_IRA","amount":5000},{"accountID":"123e4567-e89b-12d3-a456-000000000155.1234567890198","accountType":"ROTH_IRA","amount":2600}]}}},"Trump Account":{"summary":"Trump Account","description":"The Pilot Program grant is listed but excluded from `cumulativeAmount`. Employer funding appears as a `SEC_128_EMPLOYER` line item in `contributions`.","value":{"userID":"123e4567-e89b-12d3-a456-000000000156","taxYear":2026,"trumpAccount":{"accountID":"123e4567-e89b-12d3-a456-000000000059.1234567890142","limitApplied":5000,"cumulativeAmount":4800,"remainingAllowance":200,"isLimitReached":false,"contributions":[{"contributionType":"SEC_128_EMPLOYER","amount":2500,"countsTowardLimit":true},{"contributionType":"OTHER_SOURCE","amount":2300,"countsTowardLimit":true},{"contributionType":"PILOT_PROGRAM","amount":1000,"countsTowardLimit":false}]}}},"IRAs and Trump Account":{"summary":"IRAs and Trump Account","description":"Both blocks present. Parsers that assume one key or the other will break here — this is the case worth testing against.","value":{"userID":"123e4567-e89b-12d3-a456-000000000157","taxYear":2026,"ira":{"limitApplied":7500,"cumulativeAmount":3000,"remainingAllowance":4500,"isLimitReached":false,"accounts":[{"accountID":"123e4567-e89b-12d3-a456-000000000158.1234567890199","accountType":"ROTH_IRA","amount":3000}]},"trumpAccount":{"accountID":"123e4567-e89b-12d3-a456-000000000159.1234567890200","limitApplied":5000,"cumulativeAmount":1200,"remainingAllowance":3800,"isLimitReached":false,"contributions":[{"contributionType":"OTHER_SOURCE","amount":1200,"countsTowardLimit":true}]}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"userID not found":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: userID. No user found for the supplied identifier."}},"taxYear is malformed":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: taxYear. Must be a four-digit year."}},"No eligible accounts for this user":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: The user holds no IRA or Trump Account eligible for a contribution tally."}}}}}}}}},"/users/{userID}/funding/redemptions":{"get":{"tags":["Withdrawals"],"summary":"List User Withdrawals","description":"Retrieves a list of User Withdrawals by userID.","parameters":[{"in":"path","name":"userID","schema":{"$ref":"#/components/schemas/userID"},"required":true,"example":"123e4567-e89b-12d3-a456-000000000004","description":"The User's unique identifier."},{"in":"query","name":"status","schema":{"type":"string"},"example":"Successful,Pending","description":"Comma separated payment statuses"},{"in":"query","name":"type","schema":{"type":"string"},"example":"ACH,WIRE,BULK_FUNDING","description":"Comma separated deposit types"},{"in":"query","name":"limit","schema":{"type":"integer","default":25},"example":50,"description":"The number of deposits to be returned per page. Minimum=1, Maximum=100"},{"in":"query","name":"offset","schema":{"type":"string"},"example":"11AA000001-1234567890128-RJJLU","description":"Should either be null or the last payment result in the previous request"}],"responses":{"200":{"description":"Retrieving a list of User Withdrawals by userID was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redemptions"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Limit should be greater than 0":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."}},"Limit should be less than or equal to 100":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"}}}}}}}}},"/accounts/{accountID}/funding/deposits":{"get":{"tags":["Deposits"],"parameters":[{"in":"path","name":"accountID","schema":{"$ref":"#/components/schemas/accountID"},"required":true},{"in":"query","name":"status","schema":{"type":"string"},"example":"Successful,Pending","description":"Comma separated payment statuses"},{"in":"query","name":"type","schema":{"type":"string"},"example":"ACH,WIRE,BULK_FUNDING","description":"Comma separated deposit types"},{"in":"query","name":"limit","schema":{"type":"integer","default":25},"example":50,"description":"The number of deposits to be returned per page. Minimum=1, Maximum=100"},{"in":"query","name":"offset","schema":{"type":"string"},"example":"11AA000001-1234567890128-RJJLU","description":"Should either be null or the last payment result in the previous request"}],"summary":"List Account Deposits","description":"Retrieves a list of Account Deposits by accountID.","responses":{"200":{"description":"Retrieving a list of Account Deposits was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/depositsByUserIDObject"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Limit should be greater than 0":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."}},"Limit should be less than or equal to 100":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"}}}}}}}}},"/funding/deposits/{depositID}/achSettlement":{"patch":{"tags":["Deposits"],"x-audience":"beta","summary":"Update Deposit ACH Settlement","description":"![beta](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDY0IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtQkVUQSIgeDE9IjAiIHkxPSIwIiB4Mj0iMCIgeTI9IjEiPjxzdG9wIG9mZnNldD0iMCUiIHN0b3AtY29sb3I9InJnYmEoMTQsMTY1LDIzMywwLjIyKSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0icmdiYSgxNCwxNjUsMjMzLDAuMDYpIi8+PC9saW5lYXJHcmFkaWVudD48ZmlsdGVyIGlkPSJnbG93LUJFVEEiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iNjIiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjMGVhNWU5IiBmaWx0ZXI9InVybCgjZ2xvdy1CRVRBKSIgb3BhY2l0eT0iMC41NSIvPjxyZWN0IHg9IjAuNSIgeT0iMC41IiB3aWR0aD0iNjMiIGhlaWdodD0iMTkiIHJ4PSIxMCIgZmlsbD0idXJsKCNncmFkLUJFVEEpIiBzdHJva2U9IiMwZWE1ZTkiIHN0cm9rZS13aWR0aD0iMSIvPjxjaXJjbGUgY3g9IjEwIiBjeT0iMTAiIHI9IjQuNSIgZmlsbD0iIzBlYTVlOSIgZmlsdGVyPSJ1cmwoI2dsb3ctQkVUQSkiIG9wYWNpdHk9IjAuNSIvPjxjaXJjbGUgY3g9IjEwIiBjeT0iMTAiIHI9IjMiIGZpbGw9IiMwZWE1ZTkiLz48dGV4dCB4PSIxOCIgeT0iMTMuNSIgZm9udC1mYW1pbHk9IkhlbHZldGljYSwgQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTAiIGZvbnQtd2VpZ2h0PSI3MDAiIGxldHRlci1zcGFjaW5nPSIwLjYiIGZpbGw9IiMwYzhlZTAiPkJFVEE8L3RleHQ+PC9zdmc+)\nUpdates the ACH settlement dates for a deposit by depositID.","parameters":[{"in":"path","name":"depositID","schema":{"$ref":"#/components/schemas/depositID"},"required":true,"description":"A unique identifier for the user's account deposit."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchSettlementUpdate"}}}},"responses":{"200":{"description":"Updating the ACH Settlement dates was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositByDepositID"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Invalid settlement date":{"value":{"errorCode":"E032","message":"Invalid ACH settlement date format in request body."}}}}}}}}},"/accounts/{accountID}/funding/payments":{"get":{"tags":["Payments"],"summary":"List Account Payments","description":"Retrieves a unified, chronological list of an account's deposits and redemptions.","parameters":[{"in":"path","name":"accountID","schema":{"$ref":"#/components/schemas/accountID"},"required":true},{"in":"query","name":"from","schema":{"type":"string"},"required":true,"example":"2026-09-01T00:00:00Z","description":"Start of the search window (inclusive). Accepts a bare date (`YYYY-MM-DD`) or a full ISO-8601 timestamp."},{"in":"query","name":"to","schema":{"type":"string"},"required":true,"example":"2026-09-16T00:00:00Z","description":"End of the search window (inclusive). Accepts a bare date (`YYYY-MM-DD`, treated as the end of that day) or a full ISO-8601 timestamp."},{"in":"query","name":"category","schema":{"type":"array","items":{"type":"string","enum":["DEPOSIT","REDEMPTION"]}},"style":"form","explode":false,"example":["DEPOSIT","REDEMPTION"],"description":"Payment categories to filter by (comma separated for multiple)."},{"in":"query","name":"status","schema":{"type":"string"},"example":"Successful,Pending","description":"Comma separated payment statuses to filter by."},{"in":"query","name":"type","schema":{"type":"string"},"example":"ACH,WIRE","description":"Comma separated payment (vendor) types to filter by."},{"in":"query","name":"sort","schema":{"type":"string","enum":["timestamp","-timestamp"],"default":"-timestamp"},"example":"-timestamp","description":"Sort by `timestamp`, ascending (`timestamp`) or descending (`-timestamp`, the default/newest-first)."},{"in":"query","name":"limit","schema":{"type":"integer","default":25,"minimum":1,"maximum":100},"example":50,"description":"The number of payments to be returned per page. Minimum=1, Maximum=100."},{"in":"query","name":"offset","schema":{"$ref":"#/components/schemas/paymentID"},"example":"11AA000001-1234567890128-RJJLU","description":"The `paymentID` of the last payment in the previous page (the response's `page.nextCursor`). Omit for the first page."},{"in":"query","name":"amount[gt]","schema":{"type":"number","minimum":0},"example":100,"description":"Amount magnitude strictly greater than this value. Mutually exclusive with `amount[gte]`."},{"in":"query","name":"amount[gte]","schema":{"type":"number","minimum":0},"example":100,"description":"Amount magnitude greater than or equal to this value. Mutually exclusive with `amount[gt]`."},{"in":"query","name":"amount[lt]","schema":{"type":"number","minimum":0},"example":500,"description":"Amount magnitude strictly less than this value. Mutually exclusive with `amount[lte]`."},{"in":"query","name":"amount[lte]","schema":{"type":"number","minimum":0},"example":500,"description":"Amount magnitude less than or equal to this value. Mutually exclusive with `amount[lt]`."}],"responses":{"200":{"description":"Retrieving a list of Account Payments was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsSearchResponse"},"examples":{"Successful":{"value":{"pageSize":2,"limit":25,"payments":[{"id":"11AA000001-1234567890128-RJJLU","paymentID":"11AA000001-1234567890128-RJJLU","accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890125","category":"DEPOSIT","type":"WIRE_DIRECT2BANK","amount":250.25,"currency":{"name":"USD","description":"US Dollar","symbol":"$"},"details":{"sequencerFlow":"CLM_INTERIM"},"status":{"id":2,"message":"Successful","comment":"Valid request. Auto-move to Successful","updated":"2026-09-15T18:28:11.267Z"},"userDetails":{"userID":"123e4567-e89b-12d3-a456-000000000004","username":"ttc.user.john","firstName":"John","lastName":"Doe","email":"john.doe@example.com","parentIB":{"id":"123e4567-e89b-12d3-a456-000000000005","name":"Tendies Trading Company"},"wlpID":"TTC"},"accountDetails":{"accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890125","accountNo":"FFFF000005","accountType":{"name":"LIVE","description":"Live Account"},"accountManagementType":{"name":"SELF","description":"Self Directed Account"}},"fees":[],"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-000000000136","transactionCode":{"code":"RECEIPT_OTHER","type":"CSR","description":"Cash Receipt - Other e.g. TransferWise, Currencycloud, etc."},"finTranReference":"NI.123e4567-e89b-12d3-a456-000000000137","note":"Wire deposit","timestamp":"2026-09-15T18:28:11.267Z"},{"id":"FFFF000005-1234567890188-K3F9L","paymentID":"FFFF000005-1234567890188-K3F9L","accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890125","category":"REDEMPTION","type":"ACH","amount":-100,"currency":{"name":"USD","description":"US Dollar","symbol":"$"},"details":{"beneficiaryRoutingNumber":"****0000","beneficiaryAccountNumber":"****2227","bankAccountNickname":"John's checking account","beneficiaryName":"John Doe","beneficiaryBankCountry":"USA","sequencerFlow":"CLM_INTERIM"},"status":{"id":2,"message":"Successful","comment":"Valid request. Auto-move to Successful","updated":"2026-09-15T18:30:00.000Z"},"userDetails":{"userID":"123e4567-e89b-12d3-a456-000000000004","username":"ttc.user.john","firstName":"John","lastName":"Doe","email":"john.doe@example.com","parentIB":{"id":"123e4567-e89b-12d3-a456-000000000005","name":"Tendies Trading Company"},"wlpID":"TTC"},"accountDetails":{"accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890125","accountNo":"FFFF000005","accountType":{"name":"LIVE","description":"Live Account"},"accountManagementType":{"name":"SELF","description":"Self Directed Account"}},"fees":[{"type":"FEE_ACH","description":"Fee - ACH","amount":-0.25,"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-000000000138","transactionCode":"FEE_ACH","created":"2026-09-15T18:29:59.000Z","currency":"USD","symbol":"$"}],"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-000000000139","transactionCode":{"code":"DISBURSEMENT_ACH_MT","type":"CSD","description":"Cash Disbursement - ACH MT"},"note":"ACH withdrawal","timestamp":"2026-09-15T18:30:00.000Z"}],"page":{"hasMore":false}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"from is required":{"value":{"errorCode":"E030","message":"Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: from is required"}},"to is required":{"value":{"errorCode":"E030","message":"Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: to is required"}},"Invalid category":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: category must be DEPOSIT or REDEMPTION: NONSENSE"}},"Invalid sort":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: sort must be 'timestamp' (ascending) or '-timestamp' (descending): amount"}},"Limit should be greater than 0":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."}},"Limit should be less than or equal to 100":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"}},"Redundant amount bound":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: specify only one of amount[gt] or amount[gte], not both"}},"Invalid amount range":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: amount range is invalid: lower bound 500 is not below upper bound 500"}},"Unknown offset paymentID":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid offset: payment not found for paymentId not-a-real-payment-id"}}}}}}}}},"/users/{userID}/funding/payments":{"get":{"tags":["Payments"],"summary":"List User Payments","description":"Retrieves a unified, chronological list of a user's deposits and redemptions across all of their accounts.","parameters":[{"in":"path","name":"userID","schema":{"$ref":"#/components/schemas/userID"},"required":true},{"in":"query","name":"from","schema":{"type":"string"},"required":true,"example":"2026-09-01T00:00:00Z","description":"Start of the search window (inclusive). Accepts a bare date (`YYYY-MM-DD`) or a full ISO-8601 timestamp."},{"in":"query","name":"to","schema":{"type":"string"},"required":true,"example":"2026-09-16T00:00:00Z","description":"End of the search window (inclusive). Accepts a bare date (`YYYY-MM-DD`, treated as the end of that day) or a full ISO-8601 timestamp."},{"in":"query","name":"category","schema":{"type":"array","items":{"type":"string","enum":["DEPOSIT","REDEMPTION"]}},"style":"form","explode":false,"example":["DEPOSIT","REDEMPTION"],"description":"Payment categories to filter by (comma separated for multiple)."},{"in":"query","name":"status","schema":{"type":"string"},"example":"Successful,Pending","description":"Comma separated payment statuses to filter by."},{"in":"query","name":"type","schema":{"type":"string"},"example":"ACH,WIRE","description":"Comma separated payment (vendor) types to filter by."},{"in":"query","name":"sort","schema":{"type":"string","enum":["timestamp","-timestamp"],"default":"-timestamp"},"example":"-timestamp","description":"Sort by `timestamp`, ascending (`timestamp`) or descending (`-timestamp`, the default/newest-first)."},{"in":"query","name":"limit","schema":{"type":"integer","default":25,"minimum":1,"maximum":100},"example":50,"description":"The number of payments to be returned per page. Minimum=1, Maximum=100."},{"in":"query","name":"offset","schema":{"$ref":"#/components/schemas/paymentID"},"example":"11AA000001-1234567890128-RJJLU","description":"The `paymentID` of the last payment in the previous page (the response's `page.nextCursor`). Omit for the first page."},{"in":"query","name":"amount[gt]","schema":{"type":"number","minimum":0},"example":100,"description":"Amount magnitude strictly greater than this value. Mutually exclusive with `amount[gte]`."},{"in":"query","name":"amount[gte]","schema":{"type":"number","minimum":0},"example":100,"description":"Amount magnitude greater than or equal to this value. Mutually exclusive with `amount[gt]`."},{"in":"query","name":"amount[lt]","schema":{"type":"number","minimum":0},"example":500,"description":"Amount magnitude strictly less than this value. Mutually exclusive with `amount[lte]`."},{"in":"query","name":"amount[lte]","schema":{"type":"number","minimum":0},"example":500,"description":"Amount magnitude less than or equal to this value. Mutually exclusive with `amount[lt]`."}],"responses":{"200":{"description":"Retrieving a list of User Payments was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsSearchResponse"},"examples":{"Successful":{"value":{"pageSize":1,"limit":25,"payments":[{"id":"PPPP000067-1234567890189-RDT0V","paymentID":"PPPP000067-1234567890189-RDT0V","accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890190","category":"REDEMPTION","type":"ACH","amount":-20,"currency":{"name":"USD","description":"US Dollar","symbol":"$"},"details":{"beneficiaryRoutingNumber":"****0000","beneficiaryAccountNumber":"****2227","bankAccountNickname":"John's checking account","beneficiaryName":"John Doe","beneficiaryBankCountry":"USA","sequencerFlow":"CLM_INTERIM"},"status":{"id":2,"message":"Successful","comment":"Valid request. Auto-move to Successful","updated":"2026-09-15T17:02:52.975Z"},"userDetails":{"userID":"123e4567-e89b-12d3-a456-000000000004","username":"ttc.user.john","firstName":"John","lastName":"Doe","email":"john.doe@example.com","parentIB":{"id":"123e4567-e89b-12d3-a456-000000000005","name":"Tendies Trading Company"},"wlpID":"TTC"},"accountDetails":{"accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890190","accountNo":"PPPP000067","accountType":{"name":"LIVE","description":"Live Account"},"accountManagementType":{"name":"RETIREMENT_TRADITIONAL_SELF","description":"Traditional Retirement Self Directed Account"}},"fees":[{"type":"FEE_ACH","description":"Fee - ACH","amount":-0.25,"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-000000000138","transactionCode":"FEE_ACH","created":"2026-09-15T17:02:52.413Z","currency":"USD","symbol":"$"}],"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-000000000139","transactionCode":{"code":"RETIREMENT_DISTRIBUTION_ACH_API","type":"CSD","description":"IRA Withdrawal - ACH Push"},"note":"IRA withdrawal","timestamp":"2026-09-15T17:02:52.851Z","iraDistribution":"EARLY_DISTRIBUTION_PENALTY_EXCEPTION","iraDistributionSubType":"HIGHER_EDUCATION_EXPENSES"}],"page":{"hasMore":false}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"from is required":{"value":{"errorCode":"E030","message":"Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: from is required"}},"to is required":{"value":{"errorCode":"E030","message":"Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: to is required"}},"Invalid category":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: category must be DEPOSIT or REDEMPTION: NONSENSE"}},"Invalid sort":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: sort must be 'timestamp' (ascending) or '-timestamp' (descending): amount"}},"Limit should be greater than 0":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."}},"Limit should be less than or equal to 100":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"}},"Redundant amount bound":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: specify only one of amount[gt] or amount[gte], not both"}},"Invalid amount range":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: amount range is invalid: lower bound 500 is not below upper bound 500"}},"Unknown offset paymentID":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid offset: payment not found for paymentId not-a-real-payment-id"}}}}}}}}},"/funding/recurring-deposits/{recurringID}":{"get":{"tags":["Deposits"],"summary":"Retrieve Recurring Deposits","description":"Retrieves Recurring Deposits details by recurringID.","parameters":[{"in":"path","name":"recurringID","schema":{"type":"string"},"required":true,"example":"recurring_123e4567-e89b-12d3-a456-00000000004d","description":"A unique identifier for the user's recurring bank deposit."}],"responses":{"200":{"description":"Fetching recurring deposit schedule was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringDeposit"}}}}}},"patch":{"tags":["Deposits"],"summary":"Update Recurring Deposit","description":"Updates Recurring Deposit details by recurringID.","parameters":[{"in":"path","name":"recurringID","schema":{"type":"string"},"required":true,"example":"recurring_123e4567-e89b-12d3-a456-00000000004d","description":"A unique identifier for the user's recurring bank deposit."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringDepositUpdate"}}}},"responses":{"200":{"description":"Updating a User's recurring deposit was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringDepositUpdate"}}}}}},"delete":{"tags":["Deposits"],"summary":"Delete Recurring Deposit","description":"Deactivates Recurring Deposit details by recurringID.","parameters":[{"in":"path","name":"recurringID","schema":{"type":"string"},"required":true,"example":"recurring_123e4567-e89b-12d3-a456-00000000004d","description":"A unique identifier for the user's recurring bank deposit."}],"responses":{"200":{"description":"Deactivating Recurring Deposit was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringDepositDeleteResponse"}}}}}}},"/funding/payments":{"get":{"tags":["Payments"],"summary":"List Partner Payments","description":"Retrieves a unified, chronological list of deposits and redemptions across every account under a partner.","parameters":[{"in":"query","name":"partnerID","schema":{"$ref":"#/components/schemas/partnerID"},"description":"Filters payments by partnerID. Defaults to the caller's own partnerID; only DriveWealth's own parentIB caller may pass a different one."},{"in":"query","name":"from","schema":{"type":"string"},"required":true,"example":"2026-09-01T00:00:00Z","description":"Start of the search window (inclusive). Accepts a bare date (`YYYY-MM-DD`) or a full ISO-8601 timestamp."},{"in":"query","name":"to","schema":{"type":"string"},"required":true,"example":"2026-09-16T00:00:00Z","description":"End of the search window (inclusive). Accepts a bare date (`YYYY-MM-DD`, treated as the end of that day) or a full ISO-8601 timestamp."},{"in":"query","name":"category","schema":{"type":"array","items":{"type":"string","enum":["DEPOSIT","REDEMPTION"]}},"style":"form","explode":false,"example":["DEPOSIT","REDEMPTION"],"description":"Payment categories to filter by (comma separated for multiple)."},{"in":"query","name":"status","schema":{"type":"string"},"example":"Successful,Pending","description":"Comma separated payment statuses to filter by."},{"in":"query","name":"type","schema":{"type":"string"},"example":"ACH,WIRE","description":"Comma separated payment (vendor) types to filter by."},{"in":"query","name":"sort","schema":{"type":"string","enum":["timestamp","-timestamp"],"default":"-timestamp"},"example":"-timestamp","description":"Sort by `timestamp`, ascending (`timestamp`) or descending (`-timestamp`, the default/newest-first)."},{"in":"query","name":"limit","schema":{"type":"integer","default":25,"minimum":1,"maximum":100},"example":50,"description":"The number of payments to be returned per page. Minimum=1, Maximum=100."},{"in":"query","name":"offset","schema":{"$ref":"#/components/schemas/paymentID"},"example":"11AA000001-1234567890128-RJJLU","description":"The `paymentID` of the last payment in the previous page (the response's `page.nextCursor`). Omit for the first page."},{"in":"query","name":"amount[gt]","schema":{"type":"number","minimum":0},"example":100,"description":"Amount magnitude strictly greater than this value. Mutually exclusive with `amount[gte]`."},{"in":"query","name":"amount[gte]","schema":{"type":"number","minimum":0},"example":100,"description":"Amount magnitude greater than or equal to this value. Mutually exclusive with `amount[gt]`."},{"in":"query","name":"amount[lt]","schema":{"type":"number","minimum":0},"example":500,"description":"Amount magnitude strictly less than this value. Mutually exclusive with `amount[lte]`."},{"in":"query","name":"amount[lte]","schema":{"type":"number","minimum":0},"example":500,"description":"Amount magnitude less than or equal to this value. Mutually exclusive with `amount[lt]`."}],"responses":{"200":{"description":"Retrieving a list of Partner Payments was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentsSearchResponse"},"examples":{"Successful":{"value":{"pageSize":2,"limit":25,"payments":[{"id":"PPPP000067-1234567890191-DGPKR","paymentID":"PPPP000067-1234567890191-DGPKR","accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890190","category":"DEPOSIT","type":"ACH","amount":25,"currency":{"name":"USD","description":"US Dollar","symbol":"$"},"details":{"country":"USA","bankAccountNickname":"John's checking account","bankRoutingNumber":"****0000","bankAccountNumber":"****2227","accountHolderName":"John Doe","sequencerFlow":"CLM_INTERIM"},"status":{"id":14,"message":"Approved","comment":"Payment successfully submitted. Moved to Approved","updated":"2026-09-15T17:02:53.172Z"},"userDetails":{"userID":"123e4567-e89b-12d3-a456-000000000004","username":"ttc.user.john","firstName":"John","lastName":"Doe","email":"john.doe@example.com","parentIB":{"id":"123e4567-e89b-12d3-a456-000000000005","name":"Tendies Trading Company"},"wlpID":"TTC"},"accountDetails":{"accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890190","accountNo":"PPPP000067","accountType":{"name":"LIVE","description":"Live Account"},"accountManagementType":{"name":"RETIREMENT_TRADITIONAL_SELF","description":"Traditional Retirement Self Directed Account"}},"fees":[],"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-00000000013a","transactionCode":{"code":"RETIREMENT_CONTRIBUTION_ACH_API","type":"CSR","description":"IRA Deposit - ACH Pull"},"note":"IRA contribution","timestamp":"2026-09-15T17:02:52.011Z","iraContribution":"PROMOTIONAL_EARNING","iraContributionSubType":"SU"},{"id":"PPPP000067-1234567890189-RDT0V","paymentID":"PPPP000067-1234567890189-RDT0V","accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890190","category":"REDEMPTION","type":"ACH","amount":-20,"currency":{"name":"USD","description":"US Dollar","symbol":"$"},"details":{"beneficiaryRoutingNumber":"****0000","beneficiaryAccountNumber":"****2227","bankAccountNickname":"John's checking account","beneficiaryName":"John Doe","beneficiaryBankCountry":"USA","sequencerFlow":"CLM_INTERIM"},"status":{"id":2,"message":"Successful","comment":"Valid request. Auto-move to Successful","updated":"2026-09-15T17:02:52.975Z"},"userDetails":{"userID":"123e4567-e89b-12d3-a456-000000000004","username":"ttc.user.john","firstName":"John","lastName":"Doe","email":"john.doe@example.com","parentIB":{"id":"123e4567-e89b-12d3-a456-000000000005","name":"Tendies Trading Company"},"wlpID":"TTC"},"accountDetails":{"accountID":"123e4567-e89b-12d3-a456-000000000004.1234567890190","accountNo":"PPPP000067","accountType":{"name":"LIVE","description":"Live Account"},"accountManagementType":{"name":"RETIREMENT_TRADITIONAL_SELF","description":"Traditional Retirement Self Directed Account"}},"fees":[{"type":"FEE_ACH","description":"Fee - ACH","amount":-0.25,"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-000000000138","transactionCode":"FEE_ACH","created":"2026-09-15T17:02:52.413Z","currency":"USD","symbol":"$"}],"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-000000000139","transactionCode":{"code":"RETIREMENT_DISTRIBUTION_ACH_API","type":"CSD","description":"IRA Withdrawal - ACH Push"},"note":"IRA withdrawal","timestamp":"2026-09-15T17:02:52.851Z","iraDistribution":"EARLY_DISTRIBUTION_PENALTY_EXCEPTION","iraDistributionSubType":"HIGHER_EDUCATION_EXPENSES"}],"page":{"hasMore":false}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"from is required":{"value":{"errorCode":"E030","message":"Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: from is required"}},"to is required":{"value":{"errorCode":"E030","message":"Invalid or missing parameters in the request URL. Refer to the API documentation for details. Details: to is required"}},"Invalid category":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: category must be DEPOSIT or REDEMPTION: NONSENSE"}},"Invalid sort":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: sort must be 'timestamp' (ascending) or '-timestamp' (descending): amount"}},"Limit should be greater than 0":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."}},"Limit should be less than or equal to 100":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"}},"Redundant amount bound":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: specify only one of amount[gt] or amount[gte], not both"}},"Invalid amount range":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: amount range is invalid: lower bound 500 is not below upper bound 500"}},"Unknown offset paymentID":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid offset: payment not found for paymentId not-a-real-payment-id"}},"partnerID mismatch":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: partnerID must match the authenticated partner"}},"partnerID not a UUID":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: partnerID must be a valid UUID"}}}}}}}}},"/funding/reconciliations":{"get":{"tags":["Settlements"],"summary":"List Cashless Reconciliations","description":"Fetches a list of daily reconciliations for a firm using cashless settlement.","parameters":[{"in":"query","name":"to","schema":{"type":"string"},"required":true,"example":"2022-12-25T18:36:40.609Z","description":"The date and time in which to end at."},{"in":"query","name":"from","schema":{"type":"string"},"required":true,"example":"2022-12-08T18:36:40.609Z","description":"The date and time in which to start from."},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/reconciliationStatus"},"required":false,"description":"Filters the reconciliations reports by the status of reconciliation."}],"responses":{"200":{"description":"Fetching a list of daily reconciliations for a firm was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfDailyReconciliations"}}}}}}},"/funding/redemptions":{"post":{"tags":["Withdrawals"],"summary":"Create Withdrawal","description":"Creates a Withdrawal.","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"type":"string","example":"a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6"},"required":false,"description":"A unique key (UUID) that is used to prevent duplicate requests. Should a network interruption occur, or you otherwise lost a response from the API, you can safely perform the request provided that you send the same value as the Idempotency-Key. DriveWealth Idempotency Keys are saved for 4 days. Within this time period, sending any request with a duplicate key will return the exact same response as the original request, including the same status code and payload."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalFromUserAccountReq"}}}},"responses":{"200":{"description":"Creating a User's Account Withdrawal was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalFromUserAccount"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Missing amount":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Missing amount."}},"ACH redemption missing bankAccountID":{"value":{"errorCode":"E032","message":"Invalid or missing parameters in the request body. Refer to the API documentation for details. Details: Missing redemption details."}},"Unknown accountNo":{"value":{"errorCode":"A050","message":"The account you were trying to retrieve was not found. Please check the Account ID or Account No. and try again Details: Invalid accountNo: NOPE00000"}},"bankAccountID not linked to this account":{"value":{"errorCode":"K050","message":"Bank account temporarily disabled or not found. Contact customer support. Details: Bank account not found on the user. id: bank_123e4567-e89b-12d3-a456-00000000004a"}}}}}}}},"get":{"tags":["Withdrawals"],"summary":"List Withdrawals","description":"Retrieves a list of Withdrawals.","parameters":[{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/withdrawalStatus"},"required":true,"description":"The current status of the withdrawal to filter by."},{"in":"query","name":"type","schema":{"$ref":"#/components/schemas/withdrawalTypes"},"required":true,"description":"The type of withdrawal to filter by."},{"in":"query","name":"from","schema":{"type":"string"},"required":true,"example":"2022-12-08","description":"The date to start from."},{"in":"query","name":"to","schema":{"type":"string"},"required":true,"example":"2022-12-25","description":"The date to end at."},{"in":"query","name":"direction","schema":{"type":"string","enum":["prev","next"],"x-enumDescriptions":{"prev":"Fetch the previous page of results.","next":"Fetch the next page of results."}},"required":false,"example":"prev","description":"The direction of pagination."},{"in":"query","name":"parentIBID","schema":{"$ref":"#/components/schemas/partnerID"},"required":false,"description":"Filters the withdrawals list by the partnerID."}],"responses":{"200":{"description":"Retrieving a list of Withdrawals was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllWithdrawalsForTheFirm"}}}}}}},"/accounts/{accountID}/funding/redemptions":{"get":{"tags":["Withdrawals"],"parameters":[{"in":"path","name":"accountID","schema":{"$ref":"#/components/schemas/accountID"},"required":true},{"in":"query","name":"status","schema":{"type":"string"},"example":"Successful,Pending","description":"Comma separated payment statuses"},{"in":"query","name":"type","schema":{"type":"string"},"example":"ACH,WIRE,BULK_FUNDING","description":"Comma separated deposit types"},{"in":"query","name":"limit","schema":{"type":"integer","default":25},"example":50,"description":"The number of deposits to be returned per page. Minimum=1, Maximum=100"},{"in":"query","name":"offset","schema":{"type":"string"},"example":"11AA000001-1234567890128-RJJLU","description":"Should either be null or the last payment result in the previous request"}],"summary":"List Account Withdrawals","description":"Retrieves a list of Account Withdrawals by accountID","responses":{"200":{"description":"Retrieving a list of Account Withdrawals was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Redemptions"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Limit should be greater than 0":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0."}},"Limit should be less than or equal to 100":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100"}}}}}}}}},"/funding/redemptions/{redemptionID}":{"get":{"tags":["Withdrawals"],"summary":"Retrieve Withdrawal","description":"Retrieves a Withdrawal by redemptionID.","parameters":[{"in":"path","name":"redemptionID","schema":{"$ref":"#/components/schemas/redemptionID"},"required":true,"example":"123e4567-e89b-12d3-a456-000000000004","description":"A unique identifier for the user's account redemption/withdrawal."}],"responses":{"200":{"description":"Retrieving a Withdrawal by redemptionID was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalByRedemptionID"}}}}}},"patch":{"tags":["Withdrawals"],"summary":"Update Withdrawal","description":"Updates a Withdrawal by redemptionID.","parameters":[{"in":"path","name":"redemptionID","schema":{"$ref":"#/components/schemas/redemptionID"},"required":true,"example":"FFFF009007-1234567890194-R5WCJ","description":"A unique identifier for the user's account redemption/withdrawal."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithdrawalUpdateReq"},"examples":{"Reject withdrawal":{"summary":"Reject a pending withdrawal","value":{"status":"REJECTED","statusComment":"Rejected: Beneficiary bank country ES does not match with user country BR."}},"Approve withdrawal (transactionCode)":{"summary":"Approve a withdrawal and assign its transaction type using the preferred transactionCode field","value":{"status":"APPROVED","statusComment":"Approved","fees":[],"transactionCode":"DISBURSEMENT_ACH_SVB"}},"Approve withdrawal (legacy wlpFinTranTypeID)":{"summary":"Approve a withdrawal using the deprecated wlpFinTranTypeID field. Kept as an example because this is still the field's real-world payload shape today; prefer transactionCode for new integrations.","value":{"status":"APPROVED","statusComment":"Approved","fees":[],"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-00000000014a"}},"Approve withdrawal with a fee (legacy top-level wlpFinTranTypeID)":{"summary":"Approve a withdrawal and attach a fee line item. The top-level wlpFinTranTypeID is deprecated (prefer transactionCode); the fee's own wlpFinTranTypeID is a separate, currently non-deprecated field.","value":{"status":"APPROVED","statusComment":"approved","fees":[{"amount":-10,"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-00000000014b"}],"wlpFinTranTypeID":"123e4567-e89b-12d3-a456-00000000014c"}},"Update withdrawal amount":{"summary":"Change the withdrawal amount before it is submitted for processing","value":{"amount":10.19}}}}}},"responses":{"204":{"description":"Updating the Withdrawal was successful. No content is returned."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Request body missing":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details."}},"Not a withdrawal":{"value":{"errorCode":"Y050","message":"The redemption you were trying to retrieve was not found."}},"Invalid status for this action":{"value":{"errorCode":"E035","message":"Invalid action in message body. Refer to the API documentation for details."}}}}}}}}},"/funding/reconciliations/{reconciliationID}":{"get":{"tags":["Settlements"],"summary":"Get Cashless Reconciliation","description":"Fetches reconciliation details for a firm using cashless settlement.","parameters":[{"in":"path","name":"reconciliationID","schema":{"$ref":"#/components/schemas/reconciliationID"},"required":true,"description":"The unique identifier of the reconciliation report."}],"responses":{"200":{"description":"Fetching a firm's reconciliation details was successful.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReconciliationDetails"}]}}}}}},"patch":{"tags":["Settlements"],"summary":"Update Cashless Reconciliation","description":"Updates a Cashless Reconciliation by reconciliationID.","parameters":[{"in":"path","name":"reconciliationID","schema":{"$ref":"#/components/schemas/reconciliationID"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliationUpdate"},"example":{"status":"Successful","statusComment":"Manually approving reconciliation for testing purposes."}}}},"responses":{"200":{"description":"Updating the Cashless Reconciliations was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReconciliationResponse"}}}}}}},"/users/{userID}/subscriptions":{"get":{"deprecated":true,"tags":["Subscriptions"],"summary":"List Subscriptions by User","description":"Retrieves all User's Subscriptions by User\n\nThis API is now deprecated as the Subscriptions product is no longer supported.","parameters":[{"in":"path","name":"userID","schema":{"type":"string"},"required":true,"example":"123e4567-e89b-12d3-a456-000000000004","description":"The User's unique identifier."}],"responses":{"200":{"description":"Retrieving all User's Subscription was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSubscriptions"}}}}}}},"/funding/reconciliations/{reconciliationID}/attest":{"patch":{"tags":["Settlements"],"summary":"Attest Cashless Reconciliation","description":"Attests a reconciliation report if it is in a successful state and not already attested. Only available if the attestation feature is enabled for the partner.","operationId":"attestReconciliation","parameters":[{"name":"reconciliationID","in":"path","required":true,"schema":{"type":"string"},"description":"The ID of the reconciliation report to attest"}],"responses":{"200":{"description":"Attestation successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttestReconciliationResponse"},"example":{"id":"123e4567-e89b-12d3-a456-000000000005_20240417","date":"2024-04-17","status":"SUCCESSFUL","statusComment":"Finished processing breakdown","amounts":{"total":-1263.56,"purchases":-1680.07,"sales":416.51,"dividends":0,"fees":0,"other":0},"transferAmounts":{"currency":"USD","payablesToDW":1263.56,"receivablesFromDW":0},"partnerID":"123e4567-e89b-12d3-a456-000000000005","settlementProfileID":"settlement-profile-bank-account-1","created":"2024-04-15T22:28:21.810Z","updated":"2024-04-17T22:28:21.810Z","attestedBy":"123e4567-e89b-12d3-a456-000000000167","attestedAt":"2024-04-17T22:28:21.810Z"}}}},"400":{"description":"Bad request (already attested, not allowed, or other error)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"AlreadyAttested":{"summary":"Already attested","value":{"errorCode":"E020","message":"Value already exists. Details: Reconciliation report has already been attested"}}}}}},"404":{"description":"Reconciliation report not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"NotFound":{"summary":"Not found","value":{"errorCode":"E050","message":"The resource you were trying to retrieve was not found. Not Found: reconciliationID: 123e4567-e89b-12d3-a456-000000000148_20250620_notfound"}}}}}}}}},"/subscriptions":{"post":{"deprecated":true,"tags":["Subscriptions"],"summary":"Create Subscription","description":"Creates a Subscription charge for a User's Linked Bank Account.\n\nThis API is now deprecated as the Subscriptions product is no longer supported.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionRequest"}}}},"responses":{"200":{"description":"Creating a Subscription for a User's Linked Bank Account was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}}}}},"/subscriptions/{subscriptionID}":{"delete":{"deprecated":true,"tags":["Subscriptions"],"summary":"Delete Subscription","description":"Removes a User's Subscription by Subscription.\n\nThis API is now deprecated as the Subscriptions product is no longer supported.","parameters":[{"in":"path","name":"subscriptionID","schema":{"$ref":"#/components/schemas/subscriptionID"},"required":true,"description":"The unique identifier that identifies the user's subscription."}],"responses":{"201":{"description":"User's Subscription removal was Received."}}}},"/withholding-defaults":{"get":{"tags":["Withholding Defaults"],"summary":"Retrieve withholding defaults","description":"Retrieves the federal and state-specific default withholding percentages applied to retirement distributions for a given tax year.\n\nThese are the rates DriveWealth applies when a distribution request carries no withholding election of its own. This endpoint is a read-only reference lookup — calling it does not create, set, or change a withholding election for any client, and the values returned are not scoped to an individual. To submit an election, set it on the distribution request itself.","parameters":[{"in":"query","name":"taxYear","required":false,"schema":{"type":"integer","example":2026},"description":"The tax year to retrieve defaults for. Defaults to the current calendar year when omitted."},{"in":"query","name":"state","required":false,"schema":{"type":"string","example":"VT"},"description":"Two-letter U.S. state code. Narrows the response to a single state. Omit to return defaults for all states."}],"responses":{"200":{"description":"Retrieving withholding defaults was successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WithholdingDefaultsResponse"},"examples":{"Single state (state=VT)":{"value":{"taxYear":2026,"federalDefaultPercentage":0.1,"stateSpecificItems":[{"state":"VT","stateDefaultPercentage":0.3,"isWithholdingMandatory":true}]}},"All states":{"description":"Abbreviated to six states. The live response includes all 50 states and DC, sorted by state code.","value":{"taxYear":2026,"federalDefaultPercentage":0.1,"stateSpecificItems":[{"state":"AL","stateDefaultPercentage":0,"isWithholdingMandatory":false},{"state":"CA","stateDefaultPercentage":0.1,"isWithholdingMandatory":true},{"state":"IA","stateDefaultPercentage":0.038,"isWithholdingMandatory":true},{"state":"OK","stateDefaultPercentage":0.0475,"isWithholdingMandatory":true},{"state":"VT","stateDefaultPercentage":0.3,"isWithholdingMandatory":true},{"state":"WY","stateDefaultPercentage":0,"isWithholdingMandatory":false}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseModel"},"examples":{"Invalid state code":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: state. Must be a two-letter U.S. state code."}},"Malformed taxYear":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: taxYear. Must be a four-digit year."}},"Defaults not published for tax year":{"value":{"errorCode":"E025","message":"Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: taxYear. Defaults are not published for the requested tax year."}}}}}}}}},"/accounts/{accountID}/reports/daily-trade-summary":{"post":{"tags":["Settlements"],"summary":"Create DVP RVP Report","description":"Creates a job to generate a DVP RVP Report.","parameters":[{"in":"path","name":"accountID","schema":{"$ref":"#/components/schemas/accountID"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDVPRVP"}}}},"responses":{"200":{"description":"Creating the job to generate a DVP RVP Report was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDVPRVPRes"}}}}}},"get":{"tags":["Settlements"],"summary":"List DVP RVP Reports","description":"Lists DVP RVP reports.","parameters":[{"in":"path","name":"accountID","schema":{"$ref":"#/components/schemas/accountID"},"required":true},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/DVPRVPStatus"},"description":"Filters the results by the status of the DVP RVP report."},{"in":"query","name":"from","schema":{"$ref":"#/components/schemas/from"},"required":true},{"in":"query","name":"to","schema":{"$ref":"#/components/schemas/to"},"required":true}],"responses":{"200":{"description":"Fetching the list of DVP RVP Reports was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDVPRVP"}}}}}}},"/accounts/{accountID}/reports/daily-trade-summary/{reportID}":{"get":{"summary":"Get DVP RVP Report","description":"Gets a DVP RVP Report by reportID.","tags":["Settlements"],"parameters":[{"in":"path","name":"accountID","schema":{"$ref":"#/components/schemas/accountID"},"required":true},{"in":"path","name":"reportID","schema":{"type":"string","example":"bsr_123e4567-e89b-12d3-a456-000000000150.1234567890195_20210604","description":"The DVP RVP report identifier."},"required":true}],"responses":{"200":{"description":"Retrieving the DVP RVP Report was Successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DVPRVPDetails"}}}}}}}},"components":{"schemas":{"ErrorCode":{"type":"string","description":"The error code that is returned when an error occurs.","example":"E032"},"ErrorCodeMessage":{"type":"string","description":"The error message that is returned when an error occurs."},"ErrorDetails":{"type":"object","properties":{"field":{"type":"string","description":"JSON field name from the request body that caused an error"},"type":{"type":"string","enum":["STRING","ARRAY","INT","DECIMAL","BOOL","TEXT","UUID","DATE","MAP","OBJECT","ENUM"],"description":"Expected data type of the field","x-enumDescriptions":{"STRING":"The value is a string.","ARRAY":"The value is an array.","INT":"The value is an integer.","DECIMAL":"The value is a decimal number.","BOOL":"The value is a boolean.","TEXT":"The value is free-form text.","UUID":"The value is a UUID.","DATE":"The value is a date.","MAP":"The value is a key-value map.","OBJECT":"The value is an object.","ENUM":"The value is one of a fixed set of enumerated values."}},"allowedValues":{"type":"string","description":"Example values which are allowed in the field"},"detail":{"type":"string","description":"Additional validation or error details for the field"}}},"ErrorResponseModel":{"type":"object","description":"The error response model that is returned when an error occurs.","required":["errorCode","message"],"properties":{"errorCode":{"$ref":"#/components/schemas/ErrorCode"},"message":{"$ref":"#/components/schemas/ErrorCodeMessage"},"errorDetails":{"$ref":"#/components/schemas/ErrorDetails"}}},"userID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"A unique identifier created for each User on DriveWealth's platform."},"depositID":{"type":"string","example":"YYYY009000-1234567890136-1A2B3","description":"A unique identifier for the Deposit."},"orderID":{"type":"string","example":"IC.123e4567-e89b-12d3-a456-000000000049","description":"A unique DriveWealth order identifier created when an order is placed."},"orderNo":{"type":"string","example":"ZZZZ000025","description":"A unique, human-readable DriveWealth order number."},"orderStatus":{"type":"string","example":"FILLED","description":"The current status of the order.","enum":["NEW","FILLED","PARTIAL_FILL","PENDING_CANCEL","CANCELED","REJECTED"],"x-enumDescriptions":{"NEW":"The order has been received but not yet processed.","FILLED":"The order has been completely filled.","PARTIAL_FILL":"The order has been partially filled.","PENDING_CANCEL":"A cancel request has been submitted and is awaiting confirmation.","CANCELED":"The order has been canceled.","REJECTED":"The order was rejected."}},"orderStatusNumber":{"type":"number","example":2,"description":"The current status of the order, represented as a number.","enum":[0,1,2,4,6,7,8],"x-enumDescriptions":{"0":"New — the order has been received but not yet processed.","1":"Partial fill — the order has been partially filled.","2":"Filled — the order has been completely filled.","4":"Canceled — the order has been canceled.","6":"Pending cancel — a cancel request has been submitted and is awaiting confirmation.","8":"Rejected — the order was rejected."}},"stopPrice":{"type":"number","example":200,"description":"The stop price of a limit order."},"orderTypes":{"type":"string","example":"MARKET","description":"The type of the Order.","enum":["MARKET","LIMIT","STOP","STOP_LIMIT","MARKET_IF_TOUCHED"],"x-enumDescriptions":{"MARKET":"Execute immediately at the best available price.","LIMIT":"Execute only at a specified price or better.","STOP":"Becomes a market order once a specified stop price is reached.","STOP_LIMIT":"Becomes a limit order once a specified stop price is reached.","MARKET_IF_TOUCHED":"Becomes a market order once a specified trigger price is touched."}},"orderTypesRequest":{"type":"string","example":"MARKET","description":"The type of the Order.","enum":["MARKET","LIMIT","STOP","MARKET_IF_TOUCHED"],"x-enumDescriptions":{"MARKET":"Execute immediately at the best available price.","LIMIT":"Execute only at a specified price or better.","STOP":"Becomes a market order once a specified stop price is reached.","MARKET_IF_TOUCHED":"Becomes a market order once a specified trigger price is touched."}},"bankAccountID":{"type":"string","example":"bank_123e4567-e89b-12d3-a456-00000000004a","description":"The unique DriveWealth identifier that identifies each linked bank account."},"accountID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004.1234567890125","description":"The user's unique account identifier."},"accountNo":{"type":"string","example":"FFFF000005","description":"The user's unique account number, that is human readable."},"booksAndRecordsAccountID":{"type":"string","example":"CCCC000002","description":"The unique identifier for the account as maintained in the books and records system."},"sourceAccountID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000001a.1234567890129","description":"It's a unique source account id, that is human readable."},"destinationAccountID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000001b.1234567890130","description":"It's a unique destination account id, that is human readable."},"accountType":{"type":"string","example":"LIVE","description":"The type of account that has been created.","enum":["LIVE"],"x-enumDescriptions":{"LIVE":"A live, production trading account."}},"accountTypeObject":{"type":"object","properties":{"name":{"type":"string","example":"LIVE","description":"The type of account that has been created."},"description":{"type":"string","example":"Live Account","description":"A custom description of the account type."}}},"accountManagementType":{"type":"string","example":"SELF","description":"The type of account who has trading authority.","enum":["SELF","ADVISORY","MANAGED","RIA_MANAGED","CUSTODIAL","CUSTODIAL_MANAGED","RESERVE","HSA_SELF","HSA_ADVISORY","HSA_RIA_MANAGED","BUSINESS_SELF","BUSINESS_ADVISORY","BUSINESS_RIA_MANAGED","TRUST_SELF","TRUST_ADVISORY","TRUST_RIA_MANAGED","TRUMP_SELF"]},"accountHolderType":{"type":"string","example":"I","description":"A classification for the type of the account holder. US broker-dealers must utilize this field for CAIS compliance. If unset, a default value of `I` will be assumed for CAIS reporting. Please refer to CAIS documentation and instructions for more information on the allowed values.","enum":["E","I","A","F","O","V","P","X"],"x-enumDescriptions":{"E":"Employee — an employee or associated person of the partner's firm and/or an employee or associated person of the affiliated group companies.","I":"Individual — an account that does not meet FINRA Rule 4215(c), or a proprietary trading account.","A":"Institutional — an institutional account as defined in FINRA Rule 4512(c).","F":"Foreign — a non-broker-dealer foreign affiliate or non-reporting foreign broker-dealer.","O":"Market — see CAT FAQ C5 and CAT FAQ B68.","V":"Firm — an agency average price account.","P":"Other — proprietary.","X":"Error — an error account of the firm."}},"accountManagementTypeObject":{"type":"object","properties":{"name":{"type":"string","example":"SELF","description":"The type of account who has trading authority.","enum":["SELF","ADVISORY","RIA_MANAGED","CUSTODIAL","CUSTODIAL_MANAGED","RESERVE","RETIREMENT_TRADITIONAL_SELF","RETIREMENT_TRADITIONAL_ADVISORY","RETIREMENT_TRADITIONAL_RIA_MANAGED","RETIREMENT_ROTH_SELF","RETIREMENT_ROTH_ADVISORY","RETIREMENT_ROTH_RIA_MANAGED","TRUST_SELF","TRUST_ADVISORY","TRUST_RIA_MANAGED","HSA_SELF","HSA_ADVISORY","HSA_RIA_MANAGED","BUSINESS_SELF","BUSINESS_ADVISORY","BUSINESS_RIA_MANAGED","TRUMP_SELF"],"x-enumDescriptions":{"SELF":"A user directs trades in their own account without advice.","ADVISORY":"An Investment Advisor or Investment Advisor Representative has access to the account, but trades are placed only with the user's authorization.","RIA_MANAGED":"An Investment Advisor has discretion to place trades in the account.","CUSTODIAL":"An account held for the benefit of a minor.","CUSTODIAL_MANAGED":"A custodial account with discretionary trading managed by an advisor.","RESERVED":"Reserved for future use; not currently assigned.","RETIREMENT_TRADITIONAL_SELF":"A self-directed Traditional IRA retirement account.","RETIREMENT_TRADITIONAL_ADVISORY":"A Traditional IRA retirement account accessible to an advisor, with trades placed only by the user's authorization.","RETIREMENT_TRADITIONAL_RIA_MANAGED":"A Traditional IRA retirement account with discretionary trading managed by an advisor.","RETIREMENT_ROTH_SELF":"A self-directed Roth IRA retirement account.","RETIREMENT_ROTH_ADVISORY":"A Roth IRA retirement account accessible to an advisor, with trades placed only by the user's authorization.","RETIREMENT_ROTH_RIA_MANAGED":"A Roth IRA retirement account with discretionary trading managed by an advisor.","TRUST_SELF":"A self-directed Trust account.","TRUST_ADVISORY":"A Trust account accessible to an advisor, with trades placed only by the user's authorization.","TRUST_RIA_MANAGED":"A Trust account with discretionary trading managed by an advisor.","HSA_SELF":"A self-directed Health Savings Account.","HSA_ADVISORY":"A Health Savings Account accessible to an advisor, with trades placed only by the user's authorization.","HSA_RIA_MANAGED":"A Health Savings Account with discretionary trading managed by an advisor.","BUSINESS_SELF":"A self-directed Business account.","BUSINESS_ADVISORY":"A Business account accessible to an advisor, with trades placed only by the user's authorization.","BUSINESS_RIA_MANAGED":"A Business account with discretionary trading managed by an advisor.","TRUMP_SELF":"A self-directed Trump account."}},"description":{"type":"string","example":"Self Directed Account","description":"A custom description of the account management type."}}},"accountHolderTypeObject":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/accountHolderType"},"description":{"type":"string","example":"An account that does not meet FINRA Rule 4215(c) or a proprietary trading account","description":"A custom description of the account holder type."}}},"tradingType":{"type":"string","example":"CASH","description":"The type of trading the account will participate in.","enum":["CASH","MARGIN"],"x-enumDescriptions":{"CASH":"A cash account; trades settle using available cash only.","MARGIN":"A margin account; trades may be placed using borrowed funds."}},"created":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":""},"updated":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":""},"assetTransferID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000004b","description":"The unique identifier of the asset transfer."},"batch":{"type":"boolean","example":true},"transactionCode":{"type":"string","example":"JOURNAL","enum":["JOURNAL","FEE_ACH","DISBURSEMENT_ACH_SVB"],"x-enumDescriptions":{"JOURNAL":"An internal journal entry moving funds or securities without external settlement.","FEE_ACH":"A fee charged via ACH.","DISBURSEMENT_ACH_SVB":"A disbursement sent via ACH through Silicon Valley Bank (SVB)."}},"transactionCodeType":{"type":"string","example":"CSR","enum":["CSR","CSD"],"x-enumDescriptions":{"CSR":"Cash receipt.","CSD":"Cash disbursement."}},"transactionCodeObject":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/transactionCode"},"type":{"$ref":"#/components/schemas/transactionCodeType"},"description":{"type":"string","example":"Cash Receipt - ACH","description":"A custom description about the transaction code."}}},"bankAccountNickName":{"type":"string","example":"PREFERRED CHECKING","description":"The linked bank account nickname defined by the user."},"note":{"type":"string","example":"Hey! Welcome to DriveWealth Developer Docs!","description":"A way to store a message/comment on the this object."},"remittanceInformation":{"type":"string","example":"Withdrawal from investment account","description":"For ACH, this field will be passed through on an addenda record used for additional remittance details to make it easier for a recipient to identify and apply payments. For wire payments, the field will be passed through as the \"Originator to Beneficiary Information\", also known as OBI or Fedwire tag 6000. This tag provides specific details about the purpose of the payment to the beneficiary. Character limit vary by bank and rail. Typical limits are 80 characters for ach payments and 140 characters for wire payments."},"accountHolderName":{"type":"string","example":"John Doe","description":"The full name of the user on the external bank account."},"bankAccountType":{"type":"string","example":"CHECKING","description":"The type of the user's external bank account.","enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"A checking account.","SAVINGS":"A savings account."}},"bankAccountNumber":{"type":"string","example":"7442393174","description":"The account number of the user's external bank account."},"bankRoutingNumber":{"type":"string","example":"123456789","description":"The routing number of the user's external bank."},"bankAccountDefault":{"type":"boolean","example":true,"description":"True, if the bank account is the user's default bank account. Only one bank account can be set to true."},"bankAccountNumberLastFour":{"type":"string","example":"****3174","description":"The last four digits of the user's external bank account number."},"bankRoutingNumberLastFour":{"type":"string","example":"****0000","description":"The last four digits of the user's external bank routing number."},"bankAccountCountry":{"type":"string","example":"USA","description":"The country where the user's external bank is located."},"instrumentSymbol":{"type":"string","nullable":true,"example":"MS","description":"The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their `instrumentID` or `ISIN`."},"instrumentISIN":{"description":"An `International Securities Identification Number` (ISIN) uniquely identifies a security. Its structure is defined in ISO 6166. ISINs are commonly used when an Instrument does not have a `symbol`, such as Debt Instruments and Global Mutual Funds.","type":"string","minLength":12,"maxLength":14,"example":"US023135BX34"},"instrumentCUSIP":{"description":"CUSIP stands for `Committee on Uniform Securities Identification Procedures`.\nA CUSIP number identifies most financial instruments, including: stocks of all registered U.S. and Canadian companies, commercial paper, and U.S. government and municipal bonds.\nThe CUSIP system facilitates the clearance and settlement process of securities.\nCUSIP numbers consist of nine characters (including letters and numbers) that uniquely identify a company or issuer and the type of financial instrument.\nA similar system is used to identify foreign securities (`CUSIP International Numbering System or CINS`).\nCINS employs the same nine character identifier as CUSIP, but also contains a letter in the first position to signify the issuer's country or geographic region.\n","type":"string","minLength":9,"maxLength":9,"example":"E09876AA7"},"instrumentType":{"type":"string","example":"EQUITY","description":"The classification of the instrument.","enum":["EQUITY","ALTERNATIVE_ASSET","MUTUAL_FUND","DEBT","OPTION","CRYPTO"],"x-enumDescriptions":{"EQUITY":"A stock or share of a company.","ALTERNATIVE_ASSET":"A non-traditional asset, such as private equity or a hedge fund interest.","MUTUAL_FUND":"A pooled investment fund managed by professionals.","DEBT":"A fixed-income security, such as a bond.","OPTION":"A financial derivative giving the right to buy or sell an underlying asset.","CRYPTO":"A cryptocurrency."}},"instrumentStatus":{"type":"string","example":"ACTIVE","description":"The current status of the instrument.","enum":["ACTIVE","INACTIVE","CLOSE_ONLY","HALTED"],"x-enumDescriptions":{"ACTIVE":"The instrument is tradable.","INACTIVE":"The instrument is not tradable.","CLOSE_ONLY":"Existing positions may be closed, but no new positions may be opened.","HALTED":"Trading in the instrument is halted."}},"instrumentID":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-000000000006","description":"A unique ID created by DriveWealth to identify a specific instrument."},"rootId":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000006","description":"A unique ID created by DriveWealth to identify a specific Instrument that this Option is derived from."},"optionType":{"type":"string","example":"PUT","description":"The type of Option.","enum":["CALL","PUT"],"x-enumDescriptions":{"CALL":"A call option, giving the right to buy the underlying instrument.","PUT":"A put option, giving the right to sell the underlying instrument."}},"openPrice":{"type":"number","example":86.53,"description":"Most recent opening price of the instrument."},"limitType":{"type":"string","enum":["PRICE","YIELD"],"description":"Whether the limit price represents a unit price, or a yield. Only applicable to Orders for debt Instruments.","example":"PRICE","x-enumDescriptions":{"PRICE":"The limit represents a unit price.","YIELD":"The limit represents a yield."}},"side":{"type":"string","example":"BUY","description":"Whether an order is to purchase or sell. Generally, the value should be set to `BUY` or `SELL`. For Options orders, `BUY_OPEN`, `BUY_CLOSE`, `SELL_OPEN`, `SELL_CLOSE` should be used.","enum":["BUY","SELL","BUY_OPEN","BUY_CLOSE","SELL_OPEN","SELL_CLOSE"],"x-enumDescriptions":{"BUY":"Purchase the instrument.","SELL":"Sell the instrument.","BUY_OPEN":"Open a new long options position.","BUY_CLOSE":"Close an existing short options position by buying.","SELL_OPEN":"Open a new short options position.","SELL_CLOSE":"Close an existing long options position by selling."}},"commissionRate":{"type":"number","format":"BigDecimal","description":"The commission rate is a percentage charge to the total amount of the order.","example":0.3,"minimum":0.0001,"maximum":1},"preventQueuing":{"type":"boolean","example":false,"description":"If set to `true`, Orders received when the market is closed will not be queued for the next market open, and will be rejected. Please pay attention to the spelling of queuing as there are two valid spellings of this word."},"extendedHours":{"type":"boolean","example":false,"description":"Whether the order is eligible for Extended Hours Trading. The `timeInForce` must be set to `GTX` when this field is `true`. Only applicable to Equity Orders."},"timeInForce":{"type":"string","example":"GTC","description":"Set to \"GTC\" for a good-til-canceled order. Set to \"GTX\" for extended hours orders. When this property is not set, market and limit orders will be good-for-day by default, while stops and market-if-touched orders will be assumed good-til-canceled.","enum":["GTC","GTX","DAY","FILL_OR_KILL"],"x-enumDescriptions":{"GTC":"Good-til-canceled — the order remains active until executed or canceled.","GTX":"Extended-hours eligible order.","DAY":"Good for the current trading day only.","FILL_OR_KILL":"The order must execute immediately in full or be canceled."}},"executionInstructions":{"type":"array","items":{"type":"string","enum":["AON"],"example":"AON","description":"An execution instruction for an order. AON instructions are currently only accepted for Fixed Income orders","x-enumDescriptions":{"AON":"All-or-none — the order must be filled in its entirety or not at all."}},"description":"A list of execution instructions for an order. Currently only supported for Fixed Income orders."},"expiration":{"type":"string","format":"date","example":"YYYY-MM-DD","description":"The date of expiration for a good-til-canceled order, in “YYYY-MM-DD” format. The order will be canceled if not executed by the market close on this date. If not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day."},"bidPrice":{"type":"number","example":86.12,"description":"The current price buyers are prepared to pay for a security."},"askPrice":{"type":"number","example":85.14,"description":"The current price sellers are prepared to sell a security."},"lowPrice":{"type":"number","example":85.83,"description":"The lowest price in the current trading day."},"highPrice":{"type":"number","example":86.85,"description":"The highest price in the current trading day."},"wlpFinTranTypeID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000004c","description":"A unique identifier to id different type of transactions."},"depositStatusNumber":{"type":"number","example":1,"description":"The current status of the user's deposit in integer form.","enum":[0,1,2,3,4,14,15,16,17,5,-1],"x-enumDescriptions":{"0":"Started — a new deposit request was received.","1":"Pending — the deposit details were accepted.","2":"Successful — the deposit was successful.","3":"Failed — the deposit was not successful.","4":"Other — the deposit is in a suspended state.","5":"Returned — the deposit was returned to the originating bank.","14":"Approved — the deposit was approved.","15":"Rejected — the deposit was rejected.","16":"On hold — the deposit details were accepted, but it is not yet ready to be processed.","17":"Processing — the deposit is being processed.","-1":"An error occurred during the deposit."}},"depositStatus":{"type":"string","example":"PENDING","description":"The current status of the user's deposit.","enum":["STARTED","PENDING","PROCESSING","SUCCESSFUL","FAILED","OTHER","APPROVED","REJECTED","ON_HOLD","PROCESSING","RETURNED","-"],"x-enumDescriptions":{"STARTED":"A new deposit request was received.","PENDING":"The deposit details were accepted.","PROCESSING":"The deposit is being processed.","SUCCESSFUL":"The deposit was successful.","FAILED":"The deposit was not successful.","OTHER":"The deposit is in a suspended state.","APPROVED":"The deposit was approved.","REJECTED":"The deposit was rejected.","ON_HOLD":"The deposit details were accepted, but it is not yet ready to be processed.","RETURNED":"The deposit was returned to the originating bank.","-":"An error occurred during the deposit."}},"depositSeasoningStatusStatus":{"type":"number","example":2,"description":"The current status of the payment ach settlement."},"depositsSeasoningStatusMessage":{"type":"string","example":"SEASONING","description":"A custom message about the current status of the payment ach settlement."},"seasoningPeriodExpires":{"type":"string","example":"2026-01-09T22:28:21.810Z","description":""},"depositBuyingPowerHoldExpires":{"type":"string","example":"2026-01-09T22:28:21.810Z","description":""},"withdrawalStatusNumber":{"type":"number","example":1,"description":"The current status of the user's redemption/withdrawal in integer form.","enum":[1,2,3,4,11,12,13,14,15,16,-1],"x-enumDescriptions":{"1":"Pending — the withdrawal details were accepted.","2":"Successful — the withdrawal was successful.","3":"Failed — the withdrawal was not successful.","4":"Other — the withdrawal is in a suspended state.","11":"RIA pending — the withdrawal is being handled by the RIA (AutoPilot) and the details were accepted.","12":"RIA approved — approved once cash has settled against the managed account via AutoPilot.","13":"RIA rejected — rejected because there is not enough cash in the account after selling securities to cover the withdrawal.","14":"Approved — the withdrawal was approved.","15":"Rejected — the withdrawal was rejected.","16":"On hold — the withdrawal details were accepted, but it is not yet ready to be processed.","-1":"An error occurred during the withdrawal."}},"withdrawalStatus":{"type":"string","example":"PENDING","description":"The current status of the user's redemption/withdrawal.","enum":["STARTED","PENDING","SUCCESSFUL","FAILED","OTHER","RIA_PENDING","RIA_APPROVED","RIA_REJECTED","APPROVED","REJECTED","-"],"x-enumDescriptions":{"STARTED":"A new withdrawal request was received.","PENDING":"The withdrawal details were accepted.","SUCCESSFUL":"The withdrawal was successful.","FAILED":"The withdrawal was not successful.","OTHER":"The withdrawal is in a suspended state.","RIA_PENDING":"The withdrawal is being handled by the RIA (AutoPilot) and the details were accepted.","RIA_APPROVED":"Approved once cash has settled against the managed account via AutoPilot.","RIA_REJECTED":"Rejected because there is not enough cash in the account after selling securities to cover the withdrawal.","APPROVED":"The withdrawal was approved.","REJECTED":"The withdrawal was rejected.","-":"An error occurred during the withdrawal."}},"recurringID":{"type":"string","example":"recurring_123e4567-e89b-12d3-a456-00000000004d","description":"A unique identifier of the recurring deposit."},"recurringFrequency":{"type":"string","example":"MONTHLY_FIRST","description":"The recurring deposit frequency; only available for ACH deposits. Note: For retirement accounts, recurring schedules are restricted to CURRENT_YEAR contributions only.","enum":["BIWEEKLY","DAILY","MONTHLY","MONTHLY_FIRST","MONTHLY_MIDDLE","QUARTERLY"],"x-enumDescriptions":{"BIWEEKLY":"Every two weeks.","DAILY":"Every day.","MONTHLY":"Once a month.","MONTHLY_FIRST":"Once a month, on the first business day.","MONTHLY_MIDDLE":"Once a month, around the middle of the month.","QUARTERLY":"Once every three months."}},"currency":{"type":"string","example":"USD","description":"The name of the currency in abbreviation form.","enum":["USD"],"x-enumDescriptions":{"USD":"U.S. Dollar."}},"deptType":{"type":"string","example":"ATS","description":"The name of the department in abbreviation form.","enum":["A","ATS","DMA","SA","T","O"],"x-enumDescriptions":{"A":"Agency.","ATS":"Alternative Trading System.","DMA":"Direct Market Access.","SA":"Sponsored Access.","T":"Test.","O":"Other."}},"currencySymbol":{"type":"string","example":"$","description":"The currency symbol.","enum":["$"],"x-enumDescriptions":{"$":"U.S. Dollar symbol."}},"currencyObject":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/currency"},"description":{"type":"string","example":"US Dollar","description":"A custom description about the currency."},"symbol":{"$ref":"#/components/schemas/currencySymbol"}}},"depositStatusObject":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/depositStatusNumber"},"message":{"$ref":"#/components/schemas/depositStatus"},"updated":{"$ref":"#/components/schemas/updated","description":"The last updated timestamp of the status of the user's deposit."}}},"userType":{"type":"string","example":"INDIVIDUAL_TRADER","description":"The type of user being onboarded.","enum":["INDIVIDUAL_TRADER","CUSTODIAL","BENEFICIARY"],"x-enumDescriptions":{"INDIVIDUAL_TRADER":"An individual retail trader.","CUSTODIAL":"A custodian onboarding an account on behalf of a minor.","BENEFICIARY":"A beneficiary of another user's account."}},"finTranReference":{"type":"string","example":"HG.123e4567-e89b-12d3-a456-00000000004e","description":"The unique identifier that references back to the specific transaction."},"reconciliationStatus":{"type":"string","example":"APPROVED","description":"The current status of the reconciliation report.","enum":["PENDING","APPROVED","PROCESSING","SUCCESSFUL","FAILED"],"x-enumDescriptions":{"PENDING":"The reconciliation report has not yet started processing.","APPROVED":"The reconciliation report has been approved.","PROCESSING":"The reconciliation report is being processed.","SUCCESSFUL":"The reconciliation report completed successfully.","FAILED":"The reconciliation report failed."}},"redemptionID":{"type":"string","example":"ZZZZ009001-1234567890137-4X5Y6","description":"A unique identifier for the user's account redemption/withdrawal."},"redemptionStatusObject":{"type":"object","properties":{"id":{"type":"number","example":1,"description":"The current status of the user's brokerage account withdraw in integer form."},"message":{"type":"string","example":"PENDING","description":"The current status of the user's brokerage account redemption/withdrawal.","enum":["STARTED","PENDING","SUCCESSFUL","FAILED","OTHER","RIA_PENDING","RIA_APPROVED","RIA_APPROVED","APPROVED","REJECTED","-"],"x-enumDescriptions":{"STARTED":"A new withdrawal request was received.","PENDING":"The withdrawal details were accepted.","SUCCESSFUL":"The withdrawal was successful.","FAILED":"The withdrawal was not successful.","OTHER":"The withdrawal is in a suspended state.","RIA_PENDING":"The withdrawal is being handled by the RIA (AutoPilot) and the details were accepted.","RIA_APPROVED":"Approved once cash has settled against the managed account via AutoPilot.","APPROVED":"The withdrawal was approved.","REJECTED":"The withdrawal was rejected.","-":"An error occurred during the withdrawal."}},"updated":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The last updated timestamp of the status of the user's brokerage account redemption/withdrawal."}}},"allocationID":{"type":"string","example":"JF.allocation.TendiesTradingCo.123e4567-e89b-12d3-a456-00000000004f","description":"The unique identifier that identifies the lot of the allocation."},"allocationStatus":{"type":"string","example":"NEW","description":"The current status of the lot of allocation.","enum":["NEW","ACCEPTED","PART_COMPLETE","COMPLETED","REJECTED"],"x-enumDescriptions":{"NEW":"The allocation has been created but not yet processed.","ACCEPTED":"The allocation has been accepted.","PART_COMPLETE":"The allocation is partially complete.","COMPLETED":"The allocation is complete.","REJECTED":"The allocation was rejected."}},"sideAbbreviated":{"type":"string","example":"B","description":"The side of the order.","enum":["B","S","BUY_OPEN","BUY_CLOSE","SELL_OPEN","SELL_CLOSE"],"x-enumDescriptions":{"B":"Buy.","S":"Sell.","BUY_OPEN":"Open a new long options position.","BUY_CLOSE":"Close an existing short options position by buying.","SELL_OPEN":"Open a new short options position.","SELL_CLOSE":"Close an existing long options position by selling."}},"orderAveragePrice":{"type":"number","example":1038.81,"description":"The average price of the security being transacted in the order."},"orderQuantity":{"type":"number","example":0.7219,"description":"The amount of the instrument in shares."},"orderCumulativeQuantity":{"type":"number","example":0.7219,"description":"The amount of shares currently being transacted; larger orders may execute in chunks."},"allocatedQuantity":{"type":"number","example":0.7219,"description":"The amount of allocated shares."},"unallocatedNotional":{"type":"number","example":5320,"description":"The notional value of the shares that have not been allocated to sub accounts."},"unallocatedQuantity":{"type":"number","example":302,"description":"The remaining amount of shares that have not been allocated to the sub accounts."},"allocationsRequested":{"type":"number","example":500,"description":"The amount of sub account allocations passed to the system.","minimum":1,"maximum":10000},"allocationsCompleted":{"type":"number","example":25,"description":"The amount of completed sub account allocations.","minimum":1,"maximum":10000},"allocationUrl":{"type":"string","example":"/back-office/managed/allocations/JF.TENDIESTRADINGCO_20221225_120000_MOD_AUTO_LIQUIDATE","description":"A specific URL that contains the full break down of the allocation."},"OrderAllocations":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/allocationID"},"url":{"$ref":"#/components/schemas/allocationUrl"},"created":{"type":"string","example":"2022-12-22T16:04:46.724Z","description":"The date and time of the allocation creation."},"status":{"$ref":"#/components/schemas/allocationStatus"},"allocationsRequested":{"$ref":"#/components/schemas/allocationsRequested"},"allocationsCompleted":{"$ref":"#/components/schemas/allocationsCompleted"},"unallocatedQuantity":{"$ref":"#/components/schemas/unallocatedQuantity"},"unallocatedNotional":{"$ref":"#/components/schemas/unallocatedNotional"},"comment":{"type":"string","example":"All allocated and accounted for. 1::1::0 client note[empty], . timeMs=667 ratePerSec=1.50 msPerItem=667.00","description":"A custom comment generated by DriveWealth."}}},"accountStatus":{"type":"string","example":"OPEN","description":"The current status of the user's account.","enum":["PENDING","OPEN","OPEN_NO_NEW_TRADES","FROZEN","CLOSED"],"x-enumDescriptions":{"PENDING":"The account is in a pending state, most likely due to KYC.","OPEN":"The account is open and trades may be placed.","OPEN_NO_NEW_TRADES":"The account is open, but no new trades may be placed.","FROZEN":"The account is frozen; no new trades may be placed.","CLOSED":"The account is closed."}},"statusChangeReason":{"type":"string","example":"DECEASED","description":"Change account status with reason","enum":["DUPLICATE_ACCOUNT","DECEASED","PARTNER_RESTRICTED","ACCOUNT_REOPENING"],"x-enumDescriptions":{"DUPLICATE_ACCOUNT":"The account was a duplicate of another account.","DECEASED":"The account holder is deceased.","PARTNER_RESTRICTED":"The partner has restricted the account.","ACCOUNT_REOPENING":"The account is being reopened."}},"statusChangeReasonObject":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/statusChangeReasonInternal"},"description":{"type":"string","example":"Partner has restricted the account","description":"A custom description of the status change reason."}}},"statusChangeReasonInternal":{"type":"string","example":"PARTNER_RESTRICTED","description":"Reason for the account status change","enum":["ACAT","ACCOUNT_TRANSFERRED","COMPLIANCE_RESTRICTED","DUPLICATE_ACCOUNT","DECEASED","FINRA_RESTRICTIONS","LEGAL_AML","MARGIN_CALLS","PAYMENT_FAILURE","PARTNER_RESTRICTED","PDT_RESTRICTIONS","ACCOUNT_REOPENING"],"x-enumDescriptions":{"ACAT":"An ACATS transfer is processing.","ACCOUNT_TRANSFERRED":"The account has been transferred.","COMPLIANCE_RESTRICTED":"Compliance has restricted the account.","DUPLICATE_ACCOUNT":"The account was a duplicate of another account.","DECEASED":"The account holder is deceased.","FINRA_RESTRICTIONS":"A FINRA restriction has been applied to the account.","LEGAL_AML":"A legal restriction (fraud/AML) has been applied to the account.","MARGIN_CALLS":"A margin call occurred on the account.","PAYMENT_FAILURE":"A payment failed on the account.","PARTNER_RESTRICTED":"The partner has restricted the account.","PDT_RESTRICTIONS":"A Pattern Day Trader restriction was applied to the account. Deprecated — no longer used.","ACCOUNT_REOPENING":"The account is being reopened."}},"statusUpdatedBy":{"type":"string","example":"ACAT_SYSTEM","description":"A free string, which can be UUID of Backoffice user or any other system which updated the status."},"statusChangeHistory":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/accountStatus"},"statusChangeReason":{"$ref":"#/components/schemas/statusChangeReasonInternal"},"statusUpdatedBy":{"$ref":"#/components/schemas/statusUpdatedBy"}}},"fundID":{"type":"string","example":"fund_123e4567-e89b-12d3-a456-000000000050","description":"The unique identifier of a fund."},"fundName":{"type":"string","example":"Large Capitalization Fund","description":"A user defined name that describes the underlying fund."},"clientFundID":{"type":"string","example":"AAABBB-1222-3344.123456789","description":"A user defined identifier attached to the fund."},"fundDescription":{"type":"string","example":"This fund is comprised of large cap stocks weight like the S&P 500.","description":"A user defined description that describes the underlying fund."},"fundType":{"type":"string","example":"FUND","description":"The type of fund.","enum":["FUND","CASH_RESERVE"],"x-enumDescriptions":{"FUND":"A managed fund position.","CASH_RESERVE":"A cash reserve position, held for liquidity rather than invested."}},"fundTarget":{"type":"number","example":0.75,"description":"The individual targeted weight of the instrument."},"fundMaxAllowed":{"type":"number","example":0.05,"description":"The total drift amount for this instrument."},"fundLowerBound":{"type":"number","example":0.1},"fundUpperLowerBound":{"type":"number","example":0.25},"triggerTypes":{"type":"string","example":"TOTAL_DRIFT","description":"The type of trigger associated to the fund as a whole or an individual instrument.","enum":["TOTAL_DRIFT","RELATIVE_DRIFT","ABSOLUTE_DRIFT"],"x-enumDescriptions":{"TOTAL_DRIFT":"Triggers when the fund's overall drift threshold is exceeded.","RELATIVE_DRIFT":"Triggers based on a percentage deviation relative to the target allocation.","ABSOLUTE_DRIFT":"Triggers based on an absolute deviation from the target allocation."}},"portfolioID":{"type":"string","example":"portfolio_123e4567-e89b-12d3-a456-000000000051","description":"The unique identifier of a portfolio."},"portfolioName":{"type":"string","example":"Go Getter Portfolio","description":"A user defined name that describes the underlying portfolio."},"clientPortfolioID":{"type":"string","example":"AAABBB-1222-3344.123456789","description":"A user defined identifier attached to the portfolio."},"portfolioDescription":{"type":"string","example":"This portfolio is comprised different funds that make up an aggressive portfolio.","description":"A user defined description that describes the underlying portfolio."},"portfolioMaxAllowed":{"type":"number","example":0.05,"description":"The total drift amount for this fund or cash."},"portfolioLowerBound":{"type":"number","example":0.1},"portfolioUpperLowerBound":{"type":"number","example":0.25},"autoPilotRebalanceID":{"type":"string","example":"ria_rebalance_123e4567-e89b-12d3-a456-000000000052","description":"The unique identifier of the auto pilot re-balance run."},"autoPilotStatus":{"type":"string","example":"REBALANCE_NOT_STARTED","description":"The current status of the re-balance run.","enum":["REBALANCE_NOT_STARTED","REBALANCE_ABORTED","REBALANCE_REVIEW_COMPLETED","REBALANCE_NO_ORDERS_GENERATED","REBALANCE_10","REBALANCE_20","REBALANCE_30","REBALANCE_40","REBALANCE_50","REBALANCE_60","REBALANCE_70","REBALANCE_80","REBALANCE_90","REBALANCE_COMPLETED","REBALANCE_FAILED","AMOUNTCASH_ORDERS_AGGREGATED","ORDERQTY_ORDERS_AGGREGATED","ORDERQTY_ORDERS_PREPARED","AMOUNTCASH_ORDERS_PREPARED","SELL_ORDERQTY_ORDERS_SUBMITTED","SUBACCOUNT_ORDERS_ADJUSTED","SELL_AMOUNTCASH_ORDERS_SUBMITTED","SELL_AMOUNTCASH_ORDERS_COMPLETED","SELL_AMOUNTCASH_ORDERS_FAILED","SELL_AMOUNTCASH_ORDERS_TIMEDOUT","SELL_ORDERQTY_ORDERS_COMPLETED","SELL_ORDERQTY_ORDERS_FAILED","SELL_ORDERQTY_ORDERS_TIMEDOUT","BUY_ORDERQTY_ORDERS_SUBMITTED","BUY_ORDERQTY_ORDERS_COMPLETED","BUY_ORDERQTY_ORDERS_FAILED","BUY_ORDERQTY_ORDERS_TIMEDOUT","BUY_AMOUNTCASH_ORDERS_SUBMITTED","BUY_AMOUNTCASH_ORDERS_COMPLETED","BUY_AMOUNTCASH_ORDERS_FAILED","BUY_AMOUNTCASH_ORDERS_TIMEDOUT","ORDERS_CLEANEDUP","RIA_NEXT_REBALANCE_UPDATED","ALLOCATION_PREPARED","ALLOCATION_SUBMITTED","ALLOCATION_NOT_STARTED","ALLOCATION_10","ALLOCATION_20","ALLOCATION_30","ALLOCATION_40","ALLOCATION_50","ALLOCATION_60","ALLOCATION_70","ALLOCATION_80","ALLOCATION_90","ALLOCATION_COMPLETED","ALLOCATION_FAILED","ALLOCATION_TIMEDOUT","SUBACCOUNT_HOLDINGS_UPDATED","SUBACCOUNT_HOLDINGS_UPDATE_FAILED","SUCCESS"],"x-enumDescriptions":{"REBALANCE_NOT_STARTED":"The rebalance has not started.","REBALANCE_ABORTED":"The rebalance was aborted.","REBALANCE_REVIEW_COMPLETED":"The rebalance review step has completed.","REBALANCE_NO_ORDERS_GENERATED":"The rebalance completed with no orders needed.","REBALANCE_10":"The rebalance is 10% complete.","REBALANCE_20":"The rebalance is 20% complete.","REBALANCE_30":"The rebalance is 30% complete.","REBALANCE_40":"The rebalance is 40% complete.","REBALANCE_50":"The rebalance is 50% complete.","REBALANCE_60":"The rebalance is 60% complete.","REBALANCE_70":"The rebalance is 70% complete.","REBALANCE_80":"The rebalance is 80% complete.","REBALANCE_90":"The rebalance is 90% complete.","REBALANCE_COMPLETED":"The rebalance has completed.","REBALANCE_FAILED":"The rebalance failed.","AMOUNTCASH_ORDERS_AGGREGATED":"Cash-amount orders have been aggregated.","ORDERQTY_ORDERS_AGGREGATED":"Quantity-based orders have been aggregated.","ORDERQTY_ORDERS_PREPARED":"Quantity-based orders have been prepared.","AMOUNTCASH_ORDERS_PREPARED":"Cash-amount orders have been prepared.","SELL_ORDERQTY_ORDERS_SUBMITTED":"Sell orders by quantity have been submitted.","SUBACCOUNT_ORDERS_ADJUSTED":"Sub-account orders have been adjusted.","SELL_AMOUNTCASH_ORDERS_SUBMITTED":"Sell orders by cash amount have been submitted.","SELL_AMOUNTCASH_ORDERS_COMPLETED":"Sell orders by cash amount have completed.","SELL_AMOUNTCASH_ORDERS_FAILED":"Sell orders by cash amount failed.","SELL_AMOUNTCASH_ORDERS_TIMEDOUT":"Sell orders by cash amount timed out.","SELL_ORDERQTY_ORDERS_COMPLETED":"Sell orders by quantity have completed.","SELL_ORDERQTY_ORDERS_FAILED":"Sell orders by quantity failed.","SELL_ORDERQTY_ORDERS_TIMEDOUT":"Sell orders by quantity timed out.","BUY_ORDERQTY_ORDERS_SUBMITTED":"Buy orders by quantity have been submitted.","BUY_ORDERQTY_ORDERS_COMPLETED":"Buy orders by quantity have completed.","BUY_ORDERQTY_ORDERS_FAILED":"Buy orders by quantity failed.","BUY_ORDERQTY_ORDERS_TIMEDOUT":"Buy orders by quantity timed out.","BUY_AMOUNTCASH_ORDERS_SUBMITTED":"Buy orders by cash amount have been submitted.","BUY_AMOUNTCASH_ORDERS_COMPLETED":"Buy orders by cash amount have completed.","BUY_AMOUNTCASH_ORDERS_FAILED":"Buy orders by cash amount failed.","BUY_AMOUNTCASH_ORDERS_TIMEDOUT":"Buy orders by cash amount timed out.","ORDERS_CLEANEDUP":"Generated orders have been cleaned up.","RIA_NEXT_REBALANCE_UPDATED":"The next scheduled rebalance date has been updated.","ALLOCATION_PREPARED":"The allocation has been prepared.","ALLOCATION_SUBMITTED":"The allocation has been submitted.","ALLOCATION_NOT_STARTED":"The allocation has not started.","ALLOCATION_10":"The allocation is 10% complete.","ALLOCATION_20":"The allocation is 20% complete.","ALLOCATION_30":"The allocation is 30% complete.","ALLOCATION_40":"The allocation is 40% complete.","ALLOCATION_50":"The allocation is 50% complete.","ALLOCATION_60":"The allocation is 60% complete.","ALLOCATION_70":"The allocation is 70% complete.","ALLOCATION_80":"The allocation is 80% complete.","ALLOCATION_90":"The allocation is 90% complete.","ALLOCATION_COMPLETED":"The allocation has completed.","ALLOCATION_FAILED":"The allocation failed.","ALLOCATION_TIMEDOUT":"The allocation timed out.","SUBACCOUNT_HOLDINGS_UPDATED":"Sub-account holdings have been updated.","SUBACCOUNT_HOLDINGS_UPDATE_FAILED":"The sub-account holdings update failed.","SUCCESS":"The run completed successfully."}},"physicalDocumentTypes":{"type":"string","example":"DRIVER_LICENSE","description":"The type of physical document.","enum":["DRIVER_LICENSE","PASSPORT","NATIONAL_ID_CARD","VOTER_ID","WORK_PERMIT","VISA","RESIDENCE_PERMIT","ACATS_IN","ACATS_OUT","TRANSFER_ON_DEATH","BENEFICIARY_DOCUMENT","BUSINESS_DOCUMENT","TRUST_DOCUMENTS"],"x-enumDescriptions":{"DRIVER_LICENSE":"A driver's license.","PASSPORT":"A passport.","NATIONAL_ID_CARD":"A national identity card.","VOTER_ID":"A voter identification card.","WORK_PERMIT":"A work permit.","VISA":"A visa.","RESIDENCE_PERMIT":"A residence permit.","ACATS_IN":"Supporting document for an incoming ACATS transfer.","ACATS_OUT":"Supporting document for an outgoing ACATS transfer.","TRANSFER_ON_DEATH":"A Transfer on Death (TOD) designation document.","BENEFICIARY_DOCUMENT":"A beneficiary designation document.","BUSINESS_DOCUMENT":"A supporting document for a business entity.","TRUST_DOCUMENTS":"Supporting documents for a trust."}},"physicalDocumentSides":{"type":"string","example":"FRONT","description":"The actual side of the physical document."},"physicalDocumentBase64":{"type":"string","example":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4QCMR","description":"The Base64 encoded string of the document.","maximum":10},"physicalDocumentID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000053","description":"The unique identifier of the document."},"physicalDocumentStatus":{"type":"string","example":"NOT_SUBMITTED","description":"The current status of the physical document.","enum":["NOT_SUBMITTED","PENDING","APPROVED","REJECTED"],"x-enumDescriptions":{"NOT_SUBMITTED":"The document has not been submitted.","PENDING":"The document is pending review.","APPROVED":"The document has been approved.","REJECTED":"The document has been rejected."}},"physicalDocumentStatusObject":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/physicalDocumentStatus"},"description":{"type":"string","example":"Document has not been submitted for approval.","description":"A custom description that describes the document current status."}}},"fileKey":{"type":"string","example":"2022122502","description":"A unique identifier for the specific account document."},"fileURL":{"type":"string","example":"https://d111111abcdef8.cloudfront.net/123e4567-e89b-12d3-a456-426614174000.1234567890123/Stmt_DRVW_001_DWJM000000_Jan2000.pdf?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZDExMTExMWFiY2RlZjguY2xvdWRmcm9udC5uZXQvMTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDAwLjEyMzQ1Njc4OTAxMjMvU3RtdF9EUlZXXzAwMV9EV0pNMDAwMDAwX0phbjIwMDAucGRmIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxMjM0NTY3ODkwfSwiSXBBZGRyZXNzIjp7IkFXUzpTb3VyY2VJcCI6IjAuMC4wLjAvMCJ9fX1dfQ__&Signature=EXAMPLEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&Key-Pair-Id=APKAEXAMPLE00000000","description":"A short-lived URL that can be accessed to download the file."},"withdrawalTypes":{"type":"string","example":"ACH","description":"The method/form in which the redemption/withdrawal will be sent back to the user's external account.","enum":["ACH","WIRE","CASH_TRANSFER","BULK_FUNDING"],"x-enumDescriptions":{"ACH":"Sent via ACH transfer.","WIRE":"Sent via wire transfer.","CASH_TRANSFER":"Sent via cash transfer.","BULK_FUNDING":"Sent via bulk funding."}},"beneficiaryBankCity":{"type":"string","example":"New York City","description":"The user's external bank city."},"beneficiaryBankProvince":{"type":"string","example":"New York","description":"The user's external bank state or province."},"beneficiaryBankZip":{"type":"string","example":"10038","description":"The user's external bank postal code."},"beneficiaryBankCountry":{"type":"string","example":"USA","description":"The user's external bank country."},"depositTypes":{"type":"string","example":"ACH","description":"The method/form in which the funds will be arriving to the user's account.","enum":["ACH","BULK_FUNDING","CASH_PROMOTION","CASH_TRANSFER"],"x-enumDescriptions":{"ACH":"Arriving via ACH transfer.","BULK_FUNDING":"Arriving via bulk funding.","CASH_PROMOTION":"A promotional cash credit.","CASH_TRANSFER":"Arriving via cash transfer."}},"beneficiaryBankAddress":{"type":"string","example":"222 BROADWAY","description":"The user's external bank street address."},"withdrawalDetailsObject":{"type":"object","properties":{"beneficiaryName":{"type":"string","example":"John Doe","description":"The full name of the user at the external bank."},"beneficiaryAccountNumber":{"type":"string","example":"12345678901234567890123","description":"The user's external bank account number."},"beneficiaryAccountType":{"type":"string","example":"CHECKING","description":"The user's external bank account type.","enum":["CHECKING","SAVINGS"],"x-enumDescriptions":{"CHECKING":"A checking account.","SAVINGS":"A savings account."}},"beneficiaryRoutingNumber":{"type":"string","example":"123456789","description":"The user's external bank account routing number."},"beneficiarySwiftABA":{"type":"string","example":"BOFAUS3NXXX","description":"The user's external bank SWIFT code or ABA number."},"beneficiaryBankName":{"type":"string","example":"Bank of America","description":"The user's external bank name."},"beneficiaryBankAddress":{"$ref":"#/components/schemas/beneficiaryBankAddress"},"beneficiaryBankCity":{"$ref":"#/components/schemas/beneficiaryBankCity"},"beneficiaryBankProvince":{"$ref":"#/components/schemas/beneficiaryBankProvince"},"beneficiaryBankZip":{"$ref":"#/components/schemas/beneficiaryBankZip"},"beneficiaryBankCountry":{"$ref":"#/components/schemas/beneficiaryBankCountry"},"intermediarySwift":{"type":"string","example":"CHASUS3AXXX","description":"The SWIFT code of the intermediary bank that is facilitating the international wire transfer."},"intermediaryBankName":{"type":"string","example":"J.P Morgan Chase & Co.","description":"The full name of the intermediary bank that is facilitating the international wire transfer."}}},"iraDistribution":{"type":"string","example":"EARLY_DISTRIBUTION_PENALTY_EXCEPTION","description":"The type of redemption/withdrawal from an IRA type of account.\n\nNote: Trump accounts follow specific requirements for external account transfers or distributions. Click [here](https://developer.drivewealth.com/apis/v1.82.0/reference/enums?isFramePreview=true#trump-distribution-types) for more details.","enum":["NORMAL_DISTRIBUTION","EARLY_DISTRIBUTION","EARLY_DISTRIBUTION_PENALTY_EXCEPTION","DIRECT_ROLLOVER","DIRECT_TRANSFER","REQUIRED_MINIMUM_DISTRIBUTION","DISTRIBUTION_TO_BENEFICIARY","RETURN_OF_EXCESS_CONTRIBUTION","QUALIFIED_CHARITABLE_CONTRIBUTION"],"x-enumDescriptions":{"NORMAL_DISTRIBUTION":"A normal distribution.","EARLY_DISTRIBUTION":"An early distribution, subject to penalty.","EARLY_DISTRIBUTION_PENALTY_EXCEPTION":"An early distribution that qualifies for a penalty exception.","DIRECT_ROLLOVER":"A direct rollover to another retirement account.","DIRECT_TRANSFER":"A direct transfer to another retirement account.","REQUIRED_MINIMUM_DISTRIBUTION":"A required minimum distribution (RMD).","DISTRIBUTION_TO_BENEFICIARY":"A distribution to a beneficiary.","RETURN_OF_EXCESS_CONTRIBUTION":"A return of an excess contribution.","QUALIFIED_CHARITABLE_CONTRIBUTION":"A qualified charitable distribution (QCD)."}},"iraDistributionSubType":{"type":"string","example":"SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T","description":"These types are only applicable for the distribution type EARLY_DISTRIBUTION_PENALTY_EXCEPTION. Click [here](https://developer.drivewealth.com/apis/reference/enums#ira-distribution-subtypes) for more details.\",","enum":["SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T","DISABILITY_OR_DEATH","HIGHER_EDUCATION_EXPENSES","FIRST_TIME_HOME_PURCHASE","MEDICAL_EXPENSES","HEALTH_INSURANCE_PREMIUMS","RESERVIST_DISTRIBUTIONS"],"x-enumDescriptions":{"SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T":"Structured periodic withdrawals under Section 72(t).","DISABILITY_OR_DEATH":"Exempt from the early-distribution penalty due to disability or death.","HIGHER_EDUCATION_EXPENSES":"Used for tuition, books, and fees at a qualified institution.","FIRST_TIME_HOME_PURCHASE":"Up to $10,000 used toward a first home purchase.","MEDICAL_EXPENSES":"Used for unreimbursed medical expenses exceeding 7.5% of adjusted gross income.","HEALTH_INSURANCE_PREMIUMS":"Used for health insurance premiums while unemployed for 12+ weeks.","RESERVIST_DISTRIBUTIONS":"A distribution for a qualified reservist called to active duty."}},"iraTaxWithHoldings":{"type":"object","properties":{"federalTaxPercentage":{"type":"number","example":0.1,"description":"The percentage amount that should be withheld for federal taxes."},"stateTaxPercentage":{"type":"number","example":0.1,"description":"The percentage amount that should be withheld for state taxes."}}},"withdrawalID":{"type":"string","example":"AAAA009002-1234567890139-RIUIN","description":"The unique identifier of the redemption/withdrawal."},"withdrawalCategories":{"type":"string","example":"REDEMPTION","description":"The category of the withdrawal."},"username":{"type":"string","example":"ttc.user.john","description":"The username of the user."},"parentIBIDObject":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000005","description":"The unique identifier of an associated organization."},"name":{"type":"string","example":"Tendies Trading Company","description":"The organization name."}}},"firstName":{"type":"string","example":"John","description":"The first name of the user."},"lastName":{"type":"string","example":"Smith","description":"The last (family) name of the user."},"email":{"type":"string","example":"john.doe@example.com","description":"The user's email address."},"wlpID":{"type":"string","example":"TTC","description":"The wlpID is a deep backoffice ID that identifies each partner from each other."},"walletSettlementProfileID":{"type":"string","example":"bank-profile-1","description":"The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile for eligible partners."},"updatedBy":{"type":"string","example":"SYSTEM","enum":["SYSTEM REPORT SERVICE","INSTANT FUNDING BREAKDOWN JOB"],"x-enumDescriptions":{"SYSTEM REPORT SERVICE":"Updated automatically by the system report service.","INSTANT FUNDING BREAKDOWN JOB":"Updated automatically by the instant funding breakdown batch job."}},"withdrawalStatusHistoryObject":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/withdrawalStatusNumber"},"statusMessage":{"$ref":"#/components/schemas/withdrawalStatus"},"created":{"$ref":"#/components/schemas/created","description":"The date and time the withdrawal move into this step."},"updatedBy":{"$ref":"#/components/schemas/updatedBy"},"comment":{"type":"string","example":"New redemption request from the back-office","description":"A custom description that describes the current status of the redemption/withdrawal."}}},"riaID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000167","description":"This is the parentIBID or userID of the registered investment advisor creating the re-balance run."},"managedAccountsUserID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000167","description":"The unique identifier of the registered investment advisors account."},"leverage":{"type":"number","example":1,"description":"The amount of leverage an account is allowed to trade with."},"accountNickname":{"type":"string","example":"Steve's Robo Advisor Managed Account","description":"A description or nickname for an account."},"taxProfileObject":{"type":"object","properties":{"taxStatusCode":{"type":"string","example":"W-9","description":"The tax code of the accounts associated user."},"taxRecipientCode":{"type":"string","example":"INDIVIDUAL","description":"The type of tax filing of the accounts associated user."}}},"commissionID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000017","description":"The unique identifier associated with a specific commission related to the account."},"beneficiariesOption":{"type":"boolean","example":false,"description":"True if the account has associated beneficiaries."},"restricted":{"type":"boolean","example":false,"description":"If true, the account cannot trade on unsettled funds."},"gfvRestricted":{"type":"boolean","example":false,"description":"True, when the account cannot trade on unsettled funds."},"goodFaithViolations":{"type":"number","example":0,"description":"The total number of good faith violations."},"pdtRestricted":{"type":"boolean","example":false,"description":"True, when the account is PDT restricted, and can only sell.","deprecated":true},"patternDayTrader":{"type":"boolean","example":false,"description":"True, when the account is designated as a Pattern Day Trader.","deprecated":true},"patternDayTrades":{"type":"number","example":0,"description":"The total number of pattern day trades.","deprecated":true},"freeTradeBalance":{"type":"number","example":0,"description":"The total number of free trades left for the account."},"gfvPdtExempt":{"type":"boolean","example":false,"description":"True if the account exempt from trading violations."},"buyingPowerOverride":{"type":"boolean","example":false,"description":"True if the account is required to have sufficient buying power to enter a trade."},"bod":{"type":"object","description":"Beginning of day balances in the account.","properties":{"moneyMarket":{"type":"number","example":0,"description":"Beginning of day money market value."},"equityValue":{"type":"number","example":0,"description":"Beginning of day equity value."},"cashAvailableForWithdrawal":{"type":"number","example":0,"description":"Total amount of settled funds that can be withdrawn."},"cashAvailableForTrading":{"type":"number","example":0,"description":"Total amount of settled funds that can be traded."},"cashBalance":{"type":"number","example":0,"description":"The current account cash balance."}}},"productID":{"type":"string","example":"product_123e4567-e89b-12d3-a456-000000000013","description":"The unique identifier associated with an RIA managed product."},"riaObject":{"type":"object","properties":{"advisorID":{"$ref":"#/components/schemas/riaID"},"productID":{"$ref":"#/components/schemas/productID"}}},"sweepInd":{"type":"boolean","example":true,"description":"Are the funds swept into a money market account?"},"interestFree":{"type":"boolean","example":false,"description":"Is the interest generated from money market deposited back into account?"},"openedWhen":{"type":"string","example":"2022-12-22T06:07:41Z","description":"A timestamp of when the account was opened."},"ignoreMarketHoursForTest":{"type":"boolean","example":false,"description":"Can the account ignore market hours in the UAT environment?"},"flaggedForACATS":{"type":"boolean","example":false,"description":"True if the account is flagged for an Automated Customer Account Transfer (ACATS)."},"finTranID":{"type":"string","example":"EF.123e4567-e89b-12d3-a456-000000000055","description":"The internal and unique transaction identification number."},"finTranTypeID":{"type":"string","example":"JNLC","description":"The abbreviated transaction type identifier.","enum":["CSR","CSD","FEE","JNLC","CADJ","INT","SPUR","SSAL","MERGER_ACQUISITION","DIV","DIVTAX","DIVNRA","STCK","COMM","SPINOFF","STOCK_SPLIT","ACATS_CASH","ACATS_STOCK","CCPUR","CCSAL","SLIP","DIVM","PTP_WITHHOLDING"],"x-enumDescriptions":{"CSR":"Cash receipt.","CSD":"Cash disbursement.","FEE":"Fee.","JNLC":"Journaled cash entry.","CADJ":"Cash adjustment.","INT":"Interest.","SPUR":"Stock purchase.","SSAL":"Stock sale.","MERGER_ACQUISITION":"A merger or acquisition corporate action.","DIV":"A dividend payment.","DIVTAX":"Tax withheld on a dividend payment.","DIVNRA":"Non-resident alien tax withheld on a dividend payment.","STCK":"A stock movement.","COMM":"A commission charge.","SPINOFF":"A spinoff corporate action.","STOCK_SPLIT":"A stock split corporate action.","ACATS_CASH":"An ACATS cash transfer.","ACATS_STOCK":"An ACATS stock transfer.","CCPUR":"A cash concentration purchase.","CCSAL":"A cash concentration sale.","SLIP":"A settlement slip adjustment.","DIVM":"A manufactured dividend payment.","PTP_WITHHOLDING":"Withholding on income from a Publicly Traded Partnership (PTP)."}},"dividend":{"type":"object","properties":{"type":{"type":"string","example":"CASH","description":"The dividend type, whether a cash or stock dividend.","enum":["CASH","STOCK","RETURN_OF_CAPITAL","DISTRIBUTION_LONG","DISTRIBUTION_SHORT","OTHER"],"x-enumDescriptions":{"CASH":"A cash dividend.","STOCK":"A stock dividend.","RETURN_OF_CAPITAL":"A distribution treated as a return of capital rather than income.","DISTRIBUTION_LONG":"A distribution taxed as a long-term capital gain.","DISTRIBUTION_SHORT":"A distribution taxed as a short-term capital gain.","OTHER":"Another distribution type."}},"amountPerShare":{"type":"number","example":0.65,"description":"The amount of the dividend issued, per share."},"taxCode":{"type":"string","example":"FULLY_TAXABLE","description":"Whether the dividend is taxable or not.","enum":["FULLY_TAXABLE","NON_TAXABLE","TAX_EXEMPT","null"],"x-enumDescriptions":{"FULLY_TAXABLE":"The dividend is fully taxable.","NON_TAXABLE":"The dividend is not taxable.","TAX_EXEMPT":"The dividend is tax-exempt.","null":"The tax code has not been determined."}}}},"assignmentCriteria":{"type":"object","properties":{"wplID":{"$ref":"#/components/schemas/wlpID"},"countries":{"type":"string","example":"USA","description":"Clients from this country will be assigned this commission."},"defaultStatus":{"type":"boolean","example":true,"description":"The default commission to be applied if no other criteria matches."},"accountMgmtType":{"type":"string","example":null,"description":"NEEDS DESCRIPTION"}}},"ratesObject":{"type":"object","properties":{"rate":{"type":"number","example":1.49,"description":"Commission rate in USD."},"passThroughFees":{"type":"boolean","example":true,"description":"If true, SEC and TAF fees are passed through to the client."},"shareAmountRounding":{"type":"string","example":"CEIL","description":"Share amount rounding method. Options:`FLOOR` - Share quantity rounded down `CEIL` - Share quantity rounded up `NEAREST` - Share quantity rounded to nearest integer.","enum":["FLOOR","CEIL","NEAREST"],"x-enumDescriptions":{"FLOOR":"The share quantity is rounded down.","CEIL":"The share quantity is rounded up.","NEAREST":"The share quantity is rounded to the nearest integer."}},"minimumRate":{"type":"number","example":1.49,"description":"Minimum commission rate."}}},"name":{"type":"string","example":"Tom Ace","description":"Full name or entity name of type."},"EntityBeneficiariesReqObject":{"type":"object","required":["type","name","percentage","primaryContact","formationDate","relationship","idType","idNo","address","formationCountry"],"description":"An object containing the request information of a beneficiary.","properties":{"type":{"type":"string","example":"ENTITY","description":"Type of beneficiary.","enum":["ENTITY"],"x-enumDescriptions":{"ENTITY":"The beneficiary is a legal entity."}},"name":{"$ref":"#/components/schemas/name"},"percentage":{"type":"number","example":0.25,"description":"Percentage ownership beneficiary has in the account. Must total 1 (aka 100%) across all beneficiaries."},"email":{"type":"string","example":"tom@example.com","description":"The email of the beneficiary."},"formationDate":{"type":"string","example":"2010-10-25","description":"Entity formation date. Must follow the YYYY-MM-DD format."},"primaryContact":{"type":"string","example":"5555550100","description":"Primary phone contact of entity."},"phone":{"type":"string","example":"5555550100","description":"Phone number of beneficiary."},"address":{"type":"string","example":"123 Main Street, New York, NY 10001","description":"Address of the beneficiary."},"relationship":{"type":"string","example":"Trust","description":"Relationship to account holder.","enum":["Trust","Organization"],"x-enumDescriptions":{"Trust":"A trust.","Organization":"An organization."}},"idType":{"type":"string","example":"EIN","description":"Type of identification.","enum":["EIN","FTIN","OTHER"],"x-enumDescriptions":{"EIN":"Employer Identification Number.","FTIN":"Foreign Tax Identification Number.","OTHER":"Another identification type."}},"idNo":{"type":"string","example":"123456789","description":"Identification number. For EIN, must be 9 digit numbers only."},"formationCountry":{"type":"string","example":"USA","description":"Country of formation in ISO3 format (3-letter country code)."}}},"PersonBeneficiariesReqObject":{"type":"object","required":["type","name","percentage","dob","relationship","idType","idNo","address","citizenship"],"description":"An object containing the request information of a beneficiary.","properties":{"type":{"type":"string","example":"PERSON","description":"Type of beneficiary.","enum":["PERSON"],"x-enumDescriptions":{"PERSON":"The beneficiary is an individual."}},"name":{"$ref":"#/components/schemas/name"},"percentage":{"type":"number","example":0.25,"description":"Percentage ownership beneficiary has in the account. Must total 1 (aka 100%) across all beneficiaries."},"dob":{"type":"string","example":"1999-10-10","description":"Date of birth of the beneficiary."},"email":{"type":"string","example":"tom@example.com","description":"The email of the beneficiary."},"phone":{"type":"string","example":"5555550100","description":"Phone number of beneficiary."},"address":{"type":"string","example":"123 Main Street, New York, NY 10001","description":"Address of the beneficiary."},"relationship":{"type":"string","example":"Spouse","description":"Relationship to account holder.","enum":["Spouse","Children","Grandchildren","Parents","Other"],"x-enumDescriptions":{"Spouse":"The beneficiary is the account holder's spouse.","Children":"The beneficiary is the account holder's child.","Grandchildren":"The beneficiary is the account holder's grandchild.","Parents":"The beneficiary is the account holder's parent.","Other":"Another relationship to the account holder."}},"idType":{"type":"string","example":"SSN","description":"Type of identification.","enum":["SSN","FTIN","OTHER"],"x-enumDescriptions":{"SSN":"Social Security Number.","FTIN":"Foreign Tax Identification Number.","OTHER":"Another identification type."}},"idNo":{"type":"string","example":"123456789","description":"Identification number. For SSN, must be 9 digit numbers only."},"citizenship":{"type":"string","example":"USA","description":"Citizenship in ISO3 format (3-letter country code)."},"documentID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000056","description":"Identifier of the uploaded/associated document record (for example, the UUID returned when the document was uploaded)."}}},"beneficiariesResObject":{"type":"object","description":"An object containing the response information of a beneficiary.","properties":{"type":{"type":"string","example":"ENTITY","description":"Type of beneficiary.","enum":["PERSON","ENTITY"],"x-enumDescriptions":{"PERSON":"The beneficiary is an individual.","ENTITY":"The beneficiary is a legal entity."}},"name":{"$ref":"#/components/schemas/name"},"percentage":{"type":"number","example":"0.25","description":"Percentage ownership beneficiary has in the account. Must total 1 (aka 100%) across all beneficiaries."},"dob":{"type":"string","example":"1999-10-10","description":"Date of birth of the beneficiary. Only required if type: `PERSON`."},"email":{"type":"string","example":"tom@example.com","description":"The email of the entity."},"formationDate":{"type":"string","example":"2010-10-25","description":"Entity formation date. Must follow the YYYY-MM-DD format. Only required if type: `ENTITY`."},"primaryContact":{"type":"string","example":"5555550100","description":"Primary phone contact of entity. Only required if type: `ENTITY`"},"phone":{"type":"string","example":"5555550100","description":"Phone number of beneficiary."},"created":{"type":"string","example":"2022-12-29T18:32:15.533Z","description":"The when the beneficiary was added to the account."},"address":{"type":"string","example":"123 Main Street, New York, NY 10001","description":"Address of the beneficiary."},"relationship":{"type":"string","example":"Trust","description":"Relationship to account holder. For ENTITY type: Trust, Organization. For PERSON type: Spouse, Children, Grandchildren, Parents, Other.","enum":["Trust","Organization","Spouse","Children","Grandchildren","Parents","Other"],"x-enumDescriptions":{"Trust":"A trust (for an ENTITY beneficiary).","Organization":"An organization (for an ENTITY beneficiary).","Spouse":"The account holder's spouse (for a PERSON beneficiary).","Children":"The account holder's child (for a PERSON beneficiary).","Grandchildren":"The account holder's grandchild (for a PERSON beneficiary).","Parents":"The account holder's parent (for a PERSON beneficiary).","Other":"Another relationship to the account holder."}},"idType":{"type":"string","example":"EIN","description":"Type of identification. For ENTITY type: EIN, FTIN, OTHER. For PERSON type: SSN, FTIN, OTHER.","enum":["SSN","EIN","FTIN","OTHER"],"x-enumDescriptions":{"SSN":"Social Security Number (for a PERSON beneficiary).","EIN":"Employer Identification Number (for an ENTITY beneficiary).","FTIN":"Foreign Tax Identification Number.","OTHER":"Another identification type."}},"idNo":{"type":"string","example":"123456789","description":"Identification number. For SSN and EIN, must be 9 digit numbers only."},"citizenship":{"type":"string","example":"USA","description":"Citizenship in ISO3 format (3-letter country code). Only required if type: `PERSON`."},"formationCountry":{"type":"string","example":"USA","description":"Country of formation in ISO3 format (3-letter country code). Only required if type: `ENTITY`."},"documentID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000056","description":"Document identification number. Only valid if type: `PERSON`."}}},"bankName":{"type":"string","example":"JP Morgan Chase","description":"The name of the user's bank."},"bankAddress":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/beneficiaryBankAddress"},"city":{"$ref":"#/components/schemas/beneficiaryBankCity"},"stateProvince":{"$ref":"#/components/schemas/beneficiaryBankProvince"},"zipPostalCode":{"$ref":"#/components/schemas/beneficiaryBankZip"},"country":{"$ref":"#/components/schemas/beneficiaryBankCountry"}}},"wireDetails":{"type":"object","properties":{"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumber"},"bankName":{"$ref":"#/components/schemas/bankName"},"bankSwiftCode":{"type":"string","example":"CHASUS33","description":"Bank accounts swift code."},"bankAddress":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/beneficiaryBankAddress"},"city":{"$ref":"#/components/schemas/beneficiaryBankCity"},"stateProvince":{"$ref":"#/components/schemas/beneficiaryBankProvince"},"zipPostalCode":{"$ref":"#/components/schemas/beneficiaryBankZip"},"country":{"$ref":"#/components/schemas/beneficiaryBankCountry"}}},"beneficiaryName":{"$ref":"#/components/schemas/name"},"beneficiaryAddress":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/beneficiaryBankAddress"},"city":{"$ref":"#/components/schemas/beneficiaryBankCity"},"stateProvince":{"$ref":"#/components/schemas/beneficiaryBankProvince"},"zipPostalCode":{"$ref":"#/components/schemas/beneficiaryBankZip"},"country":{"$ref":"#/components/schemas/beneficiaryBankCountry"}}},"virtualAccountID":{"type":"string","example":"bfa2e...","description":"A unique DriveWealth virtual account identifier."},"paymentType":{"type":"string","example":"WIRE","description":"The type of payment.","enum":["WIRE","ACH"],"x-enumDescriptions":{"WIRE":"A wire transfer.","ACH":"An ACH transfer."}}}},"achDetails":{"type":"object","properties":{"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumber"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumber"},"bankName":{"$ref":"#/components/schemas/bankName"},"bankAddress":{"$ref":"#/components/schemas/bankAddress"},"bankRoutingNumberType":{"type":"string","example":"aba","description":"The type of routing being used.","enum":["ABA","ACH"],"x-enumDescriptions":{"ABA":"An ABA (American Bankers Association) routing number.","ACH":"An ACH routing number."}},"beneficiaryName":{"$ref":"#/components/schemas/name"},"beneficiaryAddress":{"$ref":"#/components/schemas/bankAddress"},"virtualAccountID":{"type":"string","example":"bfa2e...","description":"A unique DriveWealth virtual account identifier."},"paymentType":{"type":"string","example":"ACH","description":"The type of payment.","enum":["WIRE","ACH"],"x-enumDescriptions":{"WIRE":"A wire transfer.","ACH":"An ACH transfer."}}}},"wireDomesticDetails":{"type":"object","properties":{"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumber"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumber"},"bankName":{"$ref":"#/components/schemas/bankName"},"bankAddress":{"$ref":"#/components/schemas/bankAddress"},"bankRoutingNumberType":{"type":"string","example":"aba","description":"The type of routing being used.","enum":["ABA","ACH"],"x-enumDescriptions":{"ABA":"An ABA (American Bankers Association) routing number.","ACH":"An ACH routing number."}},"beneficiaryName":{"$ref":"#/components/schemas/name"},"beneficiaryAddress":{"$ref":"#/components/schemas/bankAddress"},"virtualAccountID":{"type":"string","example":"bfa2e...","description":"A unique DriveWealth virtual account identifier."},"paymentType":{"type":"string","example":"WIRE","description":"The type of payment.","enum":["WIRE","ACH"],"x-enumDescriptions":{"WIRE":"A wire transfer.","ACH":"An ACH transfer."}}}},"portfolioHoldings":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/fundID"},"type":{"$ref":"#/components/schemas/fundType"},"name":{"$ref":"#/components/schemas/fundName"},"target":{"$ref":"#/components/schemas/fundTarget"},"actual":{"type":"number","example":0.3054,"description":"The percentage weight of a Fund in a Portfolio."},"value":{"type":"number","example":33604.12,"description":"The current value of the Fund in a Portfolio in USD."},"rebalanceRequired":{"type":"boolean","example":true,"description":"A flag that determines if a re-balance is required based on total drift."},"holdings":{"$ref":"#/components/schemas/holdings"}}},"holdings":{"type":"array","description":"A list of the securities held in a Fund.","items":{"oneOf":[{"$ref":"#/components/schemas/holdingsObject"}]}},"holdingsObject":{"type":"object","description":"An object in the holdings array that holds the instrumentID and target.","properties":{"instrumentID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000003","description":"A unique ID created by DriveWealth to identify a specific instrument."},"target":{"type":"number","example":0.5,"description":"The target percentage for the specific instrumentID within a fund."}}},"cashSettlementTime":{"type":"object","properties":{"utcTime":{"type":"string","example":"2021-04-26T13:30:00.001Z","description":"The timestamp (UTC) when the pending cash is settled and released."},"cash":{"type":"number","example":439.7,"description":"The amount of cash settling at the specified utcTime."}}},"statementObj":{"type":"object","properties":{"displayName":{"type":"string","example":"Apr 28, 2017 Statement","description":"Description of account statement file."},"fileKey":{"type":"string","example":"2017042802","description":"Key to be used to retrieve account statement PDF. Reference [Get Statement File](https://developer.drivewealth.com/reference/get-statement-file) for retrieving an account statement."}}},"taxStatementObj":{"type":"object","properties":{"displayName":{"type":"string","example":"2015 Tax Year 1099-B","description":"Description of account tax statement file."},"fileKey":{"type":"string","example":"2015123103","description":"Key to be used to retrieve account tax statement PDF. Reference [Get Statement File](https://developer.drivewealth.com/reference/get-statement-file) for retrieving an account statement."}}},"tradeConfirmObj":{"type":"object","properties":{"displayName":{"type":"string","example":"Jun 02, 2017 Trade Confirm","description":"Description of trade confirmation file."},"fileKey":{"type":"string","example":"2017060201","description":"Key to be used to retrieve trade confirmation PDF. Reference [Get Statement File](https://developer.drivewealth.com/reference/get-statement-file) for retrieving an account statement."}}},"marginObj":{"type":"object","properties":{"marginRequirement":{"type":"number","example":1,"description":"Leverage amounts. 0.5 = 2:1 Leverage. 1 = 1:1 Leverage","enum":[0.5,1],"x-enumDescriptions":{"1":"1:1 leverage (no margin).","0.5":"2:1 leverage."}},"longMarketValue":{"type":"number","example":0,"description":"A real-time dollar value of current holdings."},"debitBalance":{"type":"number","example":0,"description":"Real-time dollar value of debt; positive dollar amount is a debit balance, negative dollar amount is a credit balance."},"equity":{"type":"number","example":0,"description":"Real-time dollar value of equity; calculated as longMarketValue – debitBalance."},"equityFraction":{"type":"number","example":0,"description":"Equity as a fraction of long market value; calculated as equity ÷ longMarketValue."},"equityRequired":{"type":"number","example":1,"description":"Minimum equity required to stay above a HOUSE margin call. If the account is in a margin call (HOUSE or EXCHANGE) this field will not appear here, but instead appear in the marginCall object."},"accruedInterest":{"type":"number","example":0,"description":"NEEDS DESCRIPTION"},"bodDTBP":{"type":"number","example":10000,"description":"The Day Trading Buying Power (DTBP) in dollars at the beginning of day.","nullable":true},"patternDayTrader":{"type":"boolean","example":false,"description":"True when the account is designated as a Pattern Day Trader.","deprecated":true},"restricted":{"type":"boolean","example":false,"description":"Account becomes restricted (set to true) if equity is less than 50% of long market value (this is essentially a warning, at 35% the account will be in HOUSE margin call)."},"daySMA":{"type":"number","example":0,"description":"Current SMA using traditional calculations – Start with beginning of day SMA and update with deposits and withdrawals as well as stock buys and sells during the day. Deposits increase and withdrawals decrease SMA dollar for dollar. Buys increase and sells decrease SMA by 50% of trade dollar value."},"rtExcessEquity":{"type":"number","example":0,"description":"Equity in excess of equityRequired calculated in real time (more is good)."},"effectiveSMA":{"type":"number","example":0,"description":"The lower of margin.daySMA and margin.rtExcessEquity. This is risk protection for the user as well as DriveWealth. Using only margin.daySMA for lending on margin has the disadvantage that the SMA can become inflated if the market drops from start of day. If user's were to use their entire daySMA to buy stock on a day when the market drops, they are immediately placed into a HOUSE CALL. The margin.rtExcessEquity prevents that from happening by lending them only a (reduced) amount that would place them above a HOUSE margin call. That is the risk protection provided to both parties."},"noBuyingPowerReason":{"type":"string","example":null,"description":"Reason indicating why the user has no buying power: `MIN_MARGIN_EQUITY_NOT_MET` - margin.equity is less than $2,000 and margin.debitBalance is greater than $0 `EFFECTIVE_SMA_ZERO` - `SMA` is $0 `HOUSE_CALL` - margin.equityfFaction is less than 35% (required house equity) `EXCHANGE_CALL` - margin.equityfFaction is less than 25% (required exchange equity) * `RESTING_ORDERS_WILL_TRIGGER_HOUSE_MARGIN_CALL` - Market dropped after resting orders were placed, and will trigger house call if filled."},"marginCall":{"type":"object","description":"Object of margin call calculations. Will only appear if noBuyingPowerReason is equal to `MIN_MARGIN_EQUITY_NOT_MET` or `HOUSE_CALL` or `EXCHANGE_CALL`"},"restingOrders":{"type":"number","example":0,"description":"Total dollar value committed in resting orders that reduces the effectiveSMA"}}},"equityValue":{"type":"number","format":"double","example":34275565.44,"description":"The current total market value of the account's open equity positions."},"optionsValue":{"type":"number","format":"double","example":12345.67,"description":"The current total market value of the account's open option positions."},"debtValue":{"type":"number","format":"double","example":12345.67,"description":"The current total market value of the account's open debt positions."},"positionsValue":{"type":"number","format":"double","example":34287911.11,"description":"The current total market value of the account's open positions."},"equityPositionsObj":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"openQty":{"type":"number","example":31.65120151,"description":"Quantity of shares owned by the account."},"costBasis":{"type":"number","example":975.98,"description":"Cost basis of the position."},"marketValue":{"type":"number","example":4540.36,"description":"Current market value of the position."},"side":{"type":"string","example":"B","description":"In this case, Side distinguishes the type of position. This will always return 'long'(B).","enum":["B"],"x-enumDescriptions":{"B":"Long position."}},"priorClose":{"type":"number","example":144.29,"description":"The prior closing price of the security."},"availableForTradingQty":{"type":"number","example":31.65120151,"description":"The quantity of the security available for sale."},"avgPrice":{"type":"number","example":30.84,"description":"The average price of the position."},"mktPrice":{"type":"number","example":143.45,"description":"The current market price of the position."},"unrealizedPL":{"type":"number","example":3564.38,"description":"Unrealized profit and loss for position."},"unrealizedDayPLPercent":{"type":"number","example":-0.58,"description":"Unrealized day profit and loss for position in percent."},"unrealizedDayPL":{"type":"number","example":-26.59,"description":"Unrealized day profit and loss for position."}}},"optionsPositionsObj":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"openQty":{"type":"number","example":31.65120151,"description":"Quantity of shares owned by the account."},"costBasis":{"type":"number","example":975.98,"description":"Cost basis of the position."},"marketValue":{"type":"number","example":4540.36,"description":"Current market value of the position."},"side":{"type":"string","example":"B","description":"In this case, Side distinguishes the type of position. This will always return 'long'(B).","enum":["B"],"x-enumDescriptions":{"B":"Long position."}},"priorClose":{"type":"number","example":144.29,"description":"The prior closing price of the security."},"availableForTradingQty":{"type":"number","example":31.65120151,"description":"The quantity of the security available for sale."},"avgPrice":{"type":"number","example":30.84,"description":"The average price of the position."},"mktPrice":{"type":"number","example":440.75,"description":"The current market price of the position."},"unrealizedPL":{"type":"number","example":14.24,"description":"The unrealized profit and loss for the position."},"unrealizedDayPLPercent":{"type":"number","example":1.65,"description":"The unrealized day profit and loss for position in percent."},"unrealizedDayPL":{"type":"number","example":0.54,"description":"The unrealized day profit and loss for the position."}}},"mutualFundsPositionsObj":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"openQty":{"type":"number","example":31.65120151,"description":"Quantity of shares owned by the account."},"costBasis":{"type":"number","example":975.98,"description":"Cost basis of the position."},"marketValue":{"type":"number","example":4540.36,"description":"Current market value of the position."},"side":{"type":"string","example":"B","description":"In this case, Side distinguishes the type of position. This will always return 'long'(B).","enum":["B"],"x-enumDescriptions":{"B":"Long position."}},"priorClose":{"type":"number","example":144.29,"description":"The prior closing price of the security."},"availableForTradingQty":{"type":"number","example":31.65120151,"description":"The quantity of the security available for sale."},"avgPrice":{"type":"number","example":30.84,"description":"The average price of the position."}}},"debtPositionsObj":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"openQty":{"type":"number","example":31.65120151,"description":"Quantity of shares owned by the account."},"costBasis":{"type":"number","example":975.98,"description":"Cost basis of the position."},"marketValue":{"type":"number","example":4540.36,"description":"Current market value of the position."},"side":{"type":"string","example":"B","description":"In this case, Side distinguishes the type of position. This will always return 'long'(B).","enum":["B"],"x-enumDescriptions":{"B":"Long position."}},"priorClose":{"type":"number","example":144.29,"description":"The prior closing price of the security."},"availableForTradingQty":{"type":"number","example":31.65120151,"description":"The quantity of the security available for sale."},"avgPrice":{"type":"number","example":30.84,"description":"The average price of the position."},"unrealizedPL":{"type":"number","example":3564.38,"description":"Unrealized profit and loss for position."}}},"limitPrice":{"type":"number","example":null,"description":"The price set for the limit order."},"ordersObj":{"type":"object","properties":{"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"createdWhen":{"$ref":"#/components/schemas/created"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"cumQty":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"orderStatus":{"$ref":"#/components/schemas/orderStatus"},"orderType":{"$ref":"#/components/schemas/orderTypes"},"orderQty":{"$ref":"#/components/schemas/orderQuantity"},"isoTimeRestingOrderExpires":{"type":"string","example":null,"description":"The time when the limit order expires."},"limitPrice":{"$ref":"#/components/schemas/limitPrice"},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"orderCashAmt":{"type":"number","example":null,"description":"The amount of cash requested for an order (fractional shares only)."},"stopPrice":{"$ref":"#/components/schemas/stopPrice"}}},"transactionSumObj":{"type":"object","properties":{"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"createdWhen":{"$ref":"#/components/schemas/created"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"cumQty":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"orderStatus":{"$ref":"#/components/schemas/orderStatus"},"orderType":{"$ref":"#/components/schemas/orderTypes"},"orderQty":{"$ref":"#/components/schemas/orderQuantity"},"isoTimeRestingOrderExpires":{"type":"string","example":null,"description":"The time when the limit order expires."},"limitPrice":{"type":"number","example":null,"description":"The price set for the limit order."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"orderCashAmt":{"type":"number","example":null,"description":"The amount of cash requested for an order (fractional shares only)."},"stopPrice":{"type":"number","example":200,"description":"The stop price of a limit order."},"realizedPL":{"type":"number","example":3564.38,"description":"Realized profit and loss for position."},"executedWhen":{"type":"string","example":"017-06-16T15:35:27.856Z","description":"The time when the transaction was executed."},"updatedWhen":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"NEEDS DESCRIPTION"},"updatedReason":{"type":"string","example":"market_order-buy-new","description":"A reason for the update."},"commissions":{"type":"number","example":0,"description":"Commission for the transaction if applicable."},"commissionDesc":{"type":"string","example":"Free","description":"A short description about the commission."}}},"performanceObj":{"type":"object","properties":{"realizedDayPL":{"type":"number","example":100.5,"description":"The actual profit or loss on the day in USD."},"unrealizedDayPL":{"type":"number","example":3564.38,"description":"Current unrealized profit and loss for open positions in account."},"cumRealizedPL":{"type":"number","example":10,"description":"The cumulative realized profit/loss from inception of account, each day adds to previous days."},"date":{"type":"string","example":"2018-09-18","description":"the date of the performance arrays values."},"equity":{"type":"number","example":9941.59,"description":"Invested equity (excluding cash) for this day (see performance.date). For Total `Equity` add performance.equity and performance.cash"},"cash":{"type":"number","example":439.7,"description":"The total cash balance (settled and unsettled) for this day (see performance.date)."},"deposits":{"type":"number","example":0,"description":"The total amount of deposits calculated from 4pm of previous day until current time."},"withdrawals":{"type":"number","example":0,"description":"The total amount of withdrawals calculated from 4pm of previous day until current time."},"fees":{"type":"number","example":0,"description":"The total amount of fees calculated from 4pm of previous day until current time."}}},"violationsObj":{"type":"object","properties":{"goodFaithViolations":{"type":"object","properties":{"count":{"$ref":"#/components/schemas/goodFaithViolations"}}},"patternDayTrades":{"type":"object","deprecated":true,"properties":{"count":{"$ref":"#/components/schemas/patternDayTrades"}}},"details":{"type":"string","example":"/back-office/accounts/123e4567-e89b-12d3-a456-000000000057.1234567890140/violations","description":"A string containing the direct path to the [violations API](https://developer.drivewealth.com/apis/reference/get_accounts-accountid-violations) for further detail"}}},"patternDayTradesObj":{"type":"object","deprecated":true,"properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"qty":{"$ref":"#/components/schemas/orderQuantity"},"amount":{"type":"number","example":100,"description":"The amount of shares being transacted."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"createdWhen":{"$ref":"#/components/schemas/created"},"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"violationSells":{"type":"array","description":"An array which orders are in violation.","items":{"oneOf":[{"$ref":"#/components/schemas/violationSells"}]}},"legacyGoodFaithViolations":{"type":"number","example":0,"description":"NEEDS DESCRIPTION"},"message":{"type":"string","example":"This transaction resulted in your third Pattern Day Trade.  Note that pending orders (such as limits) may trigger a 4th Pattern Day Trade.  If you have 4 or more day trades in a 5 day period, your account will be designated as a Pattern Day Trader and must maintain equity of at least $25,000.  Failure to do so will put your account on 90-Restriction. You will receive an email notification with more details.","description":"A description of the violation."}}},"accountEquityBreakdownObj":{"type":"object","properties":{"longMarketValue":{"type":"number","example":30000,"description":"The current long market value."},"debitBalance":{"type":"number","example":2000,"description":"The current debit balance."},"accountEquity":{"type":"number","example":28000,"description":"The current total account equity (longMarketValue - debitBalance)."}}},"violationSells":{"type":"object","properties":{"qty":{"$ref":"#/components/schemas/orderQuantity"},"amount":{"type":"number","example":20,"description":"The amount of shares being transacted."},"createdWhen":{"$ref":"#/components/schemas/created"},"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"side":{"$ref":"#/components/schemas/sideAbbreviated"}}},"transactionObj":{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"cumQty":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"orderStatus":{"$ref":"#/components/schemas/orderStatusNumber"},"orderType":{"type":"string","example":"1","description":"The type of order that is placed.","enum":["0","1","2","3","4","6","7","m"],"x-enumDescriptions":{"1":"A market order.","2":"A limit order.","3":"A stop order.","4":"A stop limit order.","6":"A market-if-touched order.","m":"An unknown order type."}},"orderQty":{"$ref":"#/components/schemas/orderQuantity"},"limitPrice":{"$ref":"#/components/schemas/limitPrice"},"stopPrice":{"$ref":"#/components/schemas/stopPrice"},"executedPrice":{"type":"number","example":122.47,"description":"The price at which the order was executed."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"createdWhen":{"$ref":"#/components/schemas/created"},"updatedWhen":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"NEEDS DESCRIPTION"},"updatedReason":{"type":"string","example":"market_order-buy-new","description":"A reason for the update."},"commission":{"type":"number","example":0,"description":"Commission for the transaction if applicable."},"commissionDesc":{"type":"string","example":"Free","description":"A short description about the commission."},"isoTimeRestingOrderExpires":{"type":"string","example":null,"description":"The time when the limit order expires."},"executedWhen":{"type":"string","example":"017-06-16T15:35:27.856Z","description":"The time when the transaction was executed."},"realizedPL":{"type":"number","example":3564.38,"description":"Realized profit and loss for position."},"orderCashAmt":{"type":"number","example":null,"description":"The amount of cash requested for an order (fractional shares only)."},"salesCredit":{"$ref":"#/components/schemas/SalesCredit"},"currency":{"$ref":"#/components/schemas/currency"}}},"FundingUserDetails":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"username":{"$ref":"#/components/schemas/username"},"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"email":{"$ref":"#/components/schemas/email"},"parentIBID":{"$ref":"#/components/schemas/parentIBIDObject"},"wlpID":{"$ref":"#/components/schemas/wlpID"},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"}}},"FundingSeasoningDetails":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/depositSeasoningStatusStatus"},"statusMessage":{"$ref":"#/components/schemas/depositsSeasoningStatusMessage"},"seasoningPeriodExpires":{"$ref":"#/components/schemas/seasoningPeriodExpires"},"depositBuyingPowerHoldExpires":{"$ref":"#/components/schemas/depositBuyingPowerHoldExpires"}}},"withdrawalAccountDetails":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountType":{"$ref":"#/components/schemas/accountTypeObject"},"accountManagementType":{"$ref":"#/components/schemas/accountManagementTypeObject"}}},"reconciliationID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000005_20240417","description":"The unique identifier of the reconciliation report."},"parentIBID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000005","description":"The unique identifier of the firm."},"bankAccountStatus":{"type":"string","example":"ACTIVE","description":"The current status of the user's external linked bank account.","enum":["ACTIVE","DELETED","DISABLED"],"x-enumDescriptions":{"ACTIVE":"The linked bank account is active.","DELETED":"The linked bank account has been deleted.","DISABLED":"The linked bank account has been disabled."}},"iraContribution":{"type":"string","example":"POSTPONED_CONTRIBUTION","description":"The type of contribution deposit for retirement accounts.\n\nNote: Trump accounts have their own enums. Click [here](https://developer.drivewealth.com/apis/v1.82.0/reference/enums?isFramePreview=true#trump-contribution-types) for more details.","enum":["CURRENT_YEAR","PRIOR_YEAR","POSTPONED_CONTRIBUTION","REPAYMENT","SEC_128_EMPLOYER","OTHER_SOURCE","QUALIFIED_ROLLOVER","PILOT_PROGRAM","QUALIFIED_GENERAL","PROMOTIONAL_EARNING"],"x-enumDescriptions":{"CURRENT_YEAR":"A contribution for the current tax year.","PRIOR_YEAR":"A contribution for the prior tax year.","POSTPONED_CONTRIBUTION":"A postponed contribution.","REPAYMENT":"A repayment contribution.","SEC_128_EMPLOYER":"An employer contribution (Trump account).","OTHER_SOURCE":"An individual contribution (Trump account).","QUALIFIED_ROLLOVER":"A trustee-to-trustee transfer of the entire balance from another Trump account.","PILOT_PROGRAM":"A contribution under the U.S. Treasury pilot program (Trump account).","QUALIFIED_GENERAL":"A grant from a government, tribe, or 501(c)(3) organization (Trump account).","PROMOTIONAL_EARNING":"A promotional earning contribution."}},"iraContributionSubType":{"type":"string","example":"SC","description":"The sub type to be used for POSTPONED_CONTRIBUTION, REPAYMENT, or PROMOTIONAL_EARNING contributions for retirement accounts. Click [here](https://developer.drivewealth.com/apis/reference/enums#ira-contribution-subtypes) for more details.","enum":["SC","PO","FD","EO","PL","QR","DD","BA","EP","DA","TI","SU","FR"],"x-enumDescriptions":{"SC":"The self-certification procedure for a late rollover contribution.","PO":"A rollover of a qualified plan loan offset.","FD":"Due to a federally designated disaster.","EO":"Combat zone or hazardous duty area, declared by Executive Order.","PL":"Combat zone or hazardous duty area, not declared by Executive Order.","QR":"Repayment of a qualified reservist distribution.","DD":"Repayment of a qualified disaster recovery distribution.","BA":"Repayment of a qualified birth or adoption distribution.","EP":"Repayment of an emergency personal expense distribution.","DA":"Repayment of a domestic abuse victim distribution.","TI":"Repayment of a terminally ill individual distribution.","SU":"A signup bonus (account opening bonus).","FR":"A fee reimbursement (e.g. prior broker exit fee)."}},"reportableTaxYear":{"type":"integer","example":2026,"nullable":true,"description":"The tax year the IRA contribution deposit is reportable for, derived from the transaction date and iraContribution type. `null` for deposits that are not retirement-account contributions."},"iraAccountType":{"type":"string","example":"TRADITIONAL_IRA","description":"TRADITIONAL_IRA or ROTH_IRA.","enum":["TRADITIONAL_IRA","ROTH_IRA"],"x-enumDescriptions":{"TRADITIONAL_IRA":"A Traditional IRA.","ROTH_IRA":"A Roth IRA."}},"iraContributionAccountObj":{"type":"object","description":"Per-account breakdown of the rollup.","properties":{"accountID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000058.1234567890141","description":"Identifier for the individual IRA."},"accountType":{"$ref":"#/components/schemas/iraAccountType"},"amount":{"type":"number","example":4000,"description":"Contributed to this account for the tax year."}}},"iraContributionTally":{"type":"object","description":"Combined rollup across all Traditional and Roth IRAs held with DriveWealth. The IRS enforces the limit on this combined total, not per account. Present only if the user holds an IRA.","properties":{"limitApplied":{"type":"number","example":7500,"description":"Ceiling in force, including the catch-up allowance if the user is 50 or over."},"cumulativeAmount":{"type":"number","example":7600,"description":"Total contributed across all IRAs for the tax year."},"remainingAllowance":{"type":"number","example":-100,"description":"Headroom left. Negative on an excess contribution."},"isLimitReached":{"type":"boolean","example":true,"description":"Whether the combined ceiling has been met or exceeded."},"accounts":{"type":"array","description":"Per-account breakdown of the rollup.","items":{"$ref":"#/components/schemas/iraContributionAccountObj"}}}},"trumpContributionLineItem":{"type":"object","description":"A funding source and the amount contributed from it for the tax year.","properties":{"contributionType":{"$ref":"#/components/schemas/iraContribution"},"amount":{"type":"number","example":2500,"description":"Contributed from this source for the tax year."},"countsTowardLimit":{"type":"boolean","example":true,"description":"Whether this amount is included in `cumulativeAmount`."}}},"trumpAccountContributionTally":{"type":"object","description":"Single Trump Account entry. No rollup, as a beneficiary may hold only one. Present only if the user holds one.","properties":{"accountID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000059.1234567890142","description":"Identifier for the Trump Account."},"limitApplied":{"type":"number","example":5000,"description":"Ceiling in force for the tax year."},"cumulativeAmount":{"type":"number","example":4800,"description":"Total from counting sources only. Exempt sources are excluded."},"remainingAllowance":{"type":"number","example":200,"description":"Headroom left against the account ceiling."},"isLimitReached":{"type":"boolean","example":false,"description":"Whether the account ceiling has been met or exceeded."},"contributions":{"type":"array","description":"Every funding source with a nonzero amount, including exempt ones. Listed for transparency; exempt sources do not move `cumulativeAmount`.","items":{"$ref":"#/components/schemas/trumpContributionLineItem"}}}},"annualContributionTallyResponse":{"type":"object","description":"A user's contributions to date against the applicable tax-year limits. Both `ira` and `trumpAccount` are optional and either, or both, may be present depending on the accounts the user holds.","properties":{"userID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000005a","description":"The user the tally was computed for."},"taxYear":{"type":"integer","example":2026,"description":"The tax year the tally covers."},"ira":{"$ref":"#/components/schemas/iraContributionTally"},"trumpAccount":{"$ref":"#/components/schemas/trumpAccountContributionTally"}}},"subscriptionID":{"type":"string","example":"subscription_123e4567-e89b-12d3-a456-00000000005b","description":"The unique identifier that identifies the user's subscription."},"subscriptionStatus":{"type":"string","example":"ACTIVE","description":"The current status of the user's subscription.","enum":["ACTIVE","CANCELLED"],"x-enumDescriptions":{"ACTIVE":"The subscription is active.","CANCELLED":"The subscription has been cancelled."}},"date":{"type":"string","example":"2022-12-25","description":""},"phoneNumber":{"type":"string","example":"18005550100","description":"The phone number of the user."},"userTaxID":{"type":"string","example":"1223334444","description":"The user's national identification number or tax identification number."},"userTaxIDLastFour":{"type":"string","example":"****-4444","description":"The user's last 4 digits of their national identification number or tax identification number."},"userTaxIDType":{"type":"string","example":"SSN","description":"The type of national identification number or tax identification number. **Note:** `FTNLO` is deprecated and should not be used for new integrations.","enum":["SSN","EIN","FTIN","PASSPORT","ALIEN_ID","OTHER"],"x-enumDescriptions":{"SSN":"Social Security Number.","EIN":"Employer Identification Number.","FTIN":"Foreign Tax Identification Number.","PASSPORT":"A passport number used as a tax identifier.","ALIEN_ID":"An alien identification number.","OTHER":"Another identification type."}},"userCountry":{"type":"string","example":"USA","description":"The user's country."},"country":{"type":"string","example":"US","description":"The ISO standard country alpha-2 code."},"userMaritalStatus":{"type":"string","example":"SINGLE","description":"The marital status of the user.","enum":["SINGLE","DIVORCED","MARRIED","WIDOWED","PARTNER"],"x-enumDescriptions":{"SINGLE":"Single.","DIVORCED":"Divorced.","MARRIED":"Married.","WIDOWED":"Widowed.","PARTNER":"Domestic partnership."}},"userStreet1":{"type":"string","example":"123 Main Street","description":"The user's current street address, where they live."},"userStreet2":{"type":"string","example":"Suite 1000","description":"The user's additional details of an address i.e. an apartment number."},"userCity":{"type":"string","example":"New York","description":"The user's current city, where they live."},"userProvince":{"type":"string","example":"NY","description":"The user's current state/province/territory, where they live."},"userPostalCode":{"type":"string","example":10001,"description":"The user's current postal code (zip code), where they live."},"userStatus":{"type":"string","example":"PENDING","description":"The user's current status.","enum":["PENDING","APPROVED"],"x-enumDescriptions":{"PENDING":"The user is pending approval.","APPROVED":"The user has been approved."}},"firmName":{"type":"string","example":"Tendies Trading Company","description":"The firm name."},"feeObject":{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","example":"FEE_ACH","description":"The type of fee that is being applied.","enum":["FEE_ACH"],"x-enumDescriptions":{"FEE_ACH":"A fee charged via ACH."}},"description":{"type":"string","example":"Fee - ACH","description":"A custom description that describes the fee type."},"amount":{"type":"number","example":-5.99,"description":"The amount of the fee that is being applied."},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"transactionCode":{"$ref":"#/components/schemas/transactionCode"},"finTranReference":{"$ref":"#/components/schemas/finTranReference"},"created":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp of when the fee was charged."},"currency":{"$ref":"#/components/schemas/currency"},"symbol":{"$ref":"#/components/schemas/currencySymbol"}}},"clientListID":{"type":"string","example":"SUMS_CUSTOM_ALLOCATION_TEST","description":"An advisor created identifier for a specific allocation."},"allocationNote":{"type":"string","example":"Allocating via api allocation test","description":"A note for the type of allocation happening."},"depositsByUserIDObject":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/depositID"},"paymentID":{"$ref":"#/components/schemas/depositID"},"amount":{"type":"number","example":125.22,"description":"The amount of the deposit"},"currency":{"$ref":"#/components/schemas/currencyObject"},"status":{"$ref":"#/components/schemas/depositStatusObject"},"accountDetails":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountType":{"$ref":"#/components/schemas/accountTypeObject"},"accountManagementType":{"$ref":"#/components/schemas/accountManagementTypeObject"}}},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"note":{"$ref":"#/components/schemas/note"}}},"Redemption":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/redemptionID"},"paymentID":{"$ref":"#/components/schemas/redemptionID"},"amount":{"type":"number","example":250.25,"description":"The amount that will be withdraw from the user's brokerage account."},"currency":{"$ref":"#/components/schemas/currencyObject"},"status":{"$ref":"#/components/schemas/redemptionStatusObject"},"accountDetails":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountType":{"$ref":"#/components/schemas/accountTypeObject"},"accountManagementType":{"$ref":"#/components/schemas/accountManagementTypeObject"}}},"fees":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/feeObject"}]}},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"finTranReference":{"$ref":"#/components/schemas/finTranReference"},"timestamp":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time of when the redemption was created."}}},"Redemptions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Redemption"}]}},"Account":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000005c.1234567890143","description":"The user's unqiue account identifier."},"accountNo":{"type":"string","example":"FFFF000005","description":"The user's unqiue account number, that is human readable."},"nickname":{"type":"string","example":"John's Self Directed Account"},"status":{"type":"object","properties":{"name":{"type":"string","example":"PENDING","description":"The status of the user's account."},"description":{"type":"string","example":"Pending","description":"A custom description about status of the user's account."}}},"accountType":{"type":"string","example":"LIVE","description":"The type of account that has been created."},"accountManagementType":{"type":"string","example":"SELF","description":"The type of account who has trading authority.","enum":["SELF","ADVISORY","RIA_MANAGED","CUSTODIAL","CUSTODIAL_MANAGED","RESERVE","HSA_SELF","HSA_ADVISORY","HSA_RIA_MANAGED","BUSINESS_SELF","BUSINESS_ADVISORY","BUSINESS_RIA_MANAGED"],"x-enumDescriptions":{"SELF":"A user directs trades in their own account without advice.","ADVISORY":"An Investment Advisor or Investment Advisor Representative has access to the account, but trades are placed only with the user's authorization.","RIA_MANAGED":"An Investment Advisor has discretion to place trades in the account.","CUSTODIAL":"An account held for the benefit of a minor.","CUSTODIAL_MANAGED":"A custodial account with discretionary trading managed by an advisor.","RESERVED":"Reserved for future use; not currently assigned.","HSA_SELF":"A self-directed Health Savings Account.","HSA_ADVISORY":"A Health Savings Account accessible to an advisor, with trades placed only by the user's authorization.","HSA_RIA_MANAGED":"A Health Savings Account with discretionary trading managed by an advisor.","BUSINESS_SELF":"A self-directed Business account.","BUSINESS_ADVISORY":"A Business account accessible to an advisor, with trades placed only by the user's authorization.","BUSINESS_RIA_MANAGED":"A Business account with discretionary trading managed by an advisor."}},"tradingType":{"type":"object","properties":{"name":{"type":"string","example":"CASH","description":"The type of trading ocurring in the account.","enum":["CASH","MARGIN","CRYPTO"],"x-enumDescriptions":{"CASH":"A cash account; trades settle using available cash only.","MARGIN":"A margin account; trades may be placed using borrowed funds.","CRYPTO":"A crypto account."}},"description":{"type":"string","example":"Cash Account","description":"A custom description about the type of account."}}},"leverage":{"type":"number","example":1,"description":"The leverage that is applied to the user's account."},"commissionID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000005d","description":"The unique identifier for the assiocated commission schedule."},"userID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"The user's unique identifier."},"restricted":{"type":"boolean","example":false,"description":"True, if the user is restricted from trading."},"goodFaithViolations":{"type":"number","example":0,"description":"The amount of times that a user buy a security and sell it before paying for the inital purchase in full with settled funds."},"patternDayTrades":{"type":"number","example":0,"description":"The number of times a user buys and sells the same security in the same day over a seven-day period.","deprecated":true},"freeTradeBalance":{"type":"number","example":0},"gfvPdtExempt":{"type":"boolean","example":false},"buyingPowerOverride":{"type":"boolean","example":false,"description":"True, if buying power check turned off."},"bod":{"type":"object","description":"Beginning of Day Information, *⚠️ Only updated at the beginning of day, this information will not change interaday.*","properties":{"moneyMarket":{"type":"number","example":3028.98,"description":"The amount of money the user's has in money market for this account."},"equityValue":{"type":"number","example":12071.5,"description":"The value of the sum of all equities in the account."},"cashAvailableForWithdrawal":{"type":"number","example":3028.98,"description":"The amount of money available for withdrawal."},"cashAvailableForTrading":{"type":"number","example":3028.98,"description":"The amount of money available for trading."},"updatedWhen":{"type":"string","example":"2022-12-12T21:13:12.391Z","description":"The date and time the dob job was run."}}},"cashBalance":{"type":"number","example":3028.98,"description":"The amount of settled cash in the account."},"sweepInd":{"type":"boolean","example":true,"description":"True, if the user's account cash is set to move into a bank sweep or money market account."},"interestFree":{"type":"boolean","example":false,"description":"True, if the user will not be paid interest on the money in a bank sweep or money market account."},"createdWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The createdWhen is the date and time the user's account was created."},"updatedWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The updatedWhen is the last date and time the user's account was updated."},"lastActivityDate":{"$ref":"#/components/schemas/lastActivityDate"},"interestedParties":{"type":"array","items":{"$ref":"#/components/schemas/interestedParty"}}}},"AccountDetails":{"type":"array","description":"A list of all the user's accounts at DriveWealth.","items":{"oneOf":[{"$ref":"#/components/schemas/Account"}]}},"Transaction":{"type":"object","properties":{"accountAmount":{"type":"number","example":-890.12,"description":"The amount of the transaction."},"accountBalance":{"type":"number","example":49984.44,"description":"The cash balance of the account at the time of the transaction."},"accountType":{"$ref":"#/components/schemas/accountType"},"dividend":{"$ref":"#/components/schemas/dividend"},"dividendTax":{"type":"object","description":"An object containing details of a dividend withholding.","properties":{"rate":{"type":"number","description":"The Witholding rate associated with the dividend payment.","example":0.15},"type":{"type":"string","description":"The type of tax associated with the withholding","example":"FOREIGN_TAX","enum":["FOREIGN_TAX","NON_RESIDENTIAL_ALIEN","OTHER"],"x-enumDescriptions":{"FOREIGN_TAX":"Foreign tax withheld on the dividend.","NON_RESIDENTIAL_ALIEN":"U.S. non-resident alien tax withheld on the dividend.","OTHER":"Another type of tax withholding."}}}},"dnb":{"type":"boolean","example":false,"description":"If false, the transaction was sent to inteliclear. Default is false."},"comment":{"type":"string","example":"Buy 0.0259 shares of AMZN at 1003.13 FULL fill","description":"A comment describing the transaction"},"finTranID":{"$ref":"#/components/schemas/finTranID"},"finTranTypeID":{"$ref":"#/components/schemas/finTranTypeID"},"feeSec":{"type":"number","description":"The sec fee charged to an applicable sell order. Reference your fee schedule for SEC fee amounts per share.","example":0.01},"feeTaf":{"type":"number","description":"Trading activity fee (TAF) for an applicable sell order. Reference your fee schedule for TAF fee amounts per share.","example":0.01},"feeBase":{"type":"number","description":"The net fee amount of TAF and SEC Fees for a given sell order.","example":0.02},"feeXtraShares":{"type":"number","description":"Commission charged when the share quantity is greater than the base share amount. Reference your commission schedule for more info.","example":0.05},"feeExchange":{"type":"number","description":"An Exchange Fee applied to an order.","example":0.02},"fillQty":{"type":"number","description":"The quantity of shares filled for a transaction.","example":1.02387115},"fillPx":{"type":"number","description":"The fill price of the order for the given transaction.","example":17.44},"orderID":{"$ref":"#/components/schemas/orderID"},"mergerAcquisition":{"type":"object","description":"An object containing details of a corporate event, such as a merger or an acquisition.","properties":{"type":{"type":"string","description":"The transaction result of the corporate event","example":"EXCHANGE STOCK_CASH","enum":["EXCHANGE_STOCK_CASH","ADD_SHARES","ADD_SHARES_CASH","ADD_SHARES_REMOVE_CASH","REMOVE_SHARES","REMOVE_SHARES_CASH","REMOVE_SHARES_ADD_CASH"],"x-enumDescriptions":{"EXCHANGE_STOCK_CASH":"Shares were exchanged for a combination of stock and cash.","ADD_SHARES":"Additional shares were added, with no cash impact.","ADD_SHARES_CASH":"Additional shares were added along with a cash payment.","ADD_SHARES_REMOVE_CASH":"Additional shares were added and cash was removed.","REMOVE_SHARES":"Shares were removed, with no cash impact.","REMOVE_SHARES_CASH":"Shares were removed along with a cash payment.","REMOVE_SHARES_ADD_CASH":"Shares were removed and cash was added."}},"acquirer":{"type":"object","description":"Object containing details of the acquiring company","properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"type":"string","description":"The instrument ticker symbol.","example":"AAPL"},"name":{"type":"string","description":"The name of the acquiring company","example":"Apple"}}},"acquiree":{"type":"object","description":"Object containing details of the company being acquired","properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"type":"string","description":"The instrument ticker symbol.","example":"TSLA"},"name":{"type":"string","description":"The name of the company being acquired","example":"TSLA"}}}}},"positionDelta":{"type":"number","description":"The delta in the number of shares due to the corporate action.","example":0.18}}},"TransactionRes":{"type":"array","description":"A list of transactions.","items":{"oneOf":[{"$ref":"#/components/schemas/Transaction"}]}},"DepositByUserID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/recurringID"},"currency":{"$ref":"#/components/schemas/currency"},"amount":{"type":"number","example":1075.25,"description":"The amount of the recurring deposit."},"frequency":{"$ref":"#/components/schemas/recurringFrequency"},"bankAccountID":{"$ref":"#/components/schemas/bankAccountID"},"active":{"type":"boolean","example":true,"description":"True, if the recurring deposit is active."},"nextDeposit":{"type":"string","example":"2019-01-15","description":"The date of when the next recurring deposit will be triggered."},"accountID":{"$ref":"#/components/schemas/accountID"},"created":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time the recurring deposit was created for the user's external bank account."},"updated":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time the recurring deposit was updated for the user's external bank account."},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000005e","description":"The user identifier whom created the recurring deposit."}}},"RecurringDepositsByUserID":{"type":"array","description":"A list of the all the user's recurring deposits.","items":{"oneOf":[{"$ref":"#/components/schemas/DepositByUserID"}]}},"PendingOrders":{"type":"object","description":"A list of pending orders.","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updated":{"type":"string","example":"2021-04-23T18:41:32.440Z","description":"The time of the last update to the Pending Orders Object."},"orders":{"type":"array","description":"An array that holds a list of currently pending orders.","items":{"oneOf":[{"type":"object","properties":{"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"createdWhen":{"$ref":"#/components/schemas/created"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"cumQty":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"orderStatus":{"type":"string","example":"2","description":"The current status of the order.","enum":["0","1","2","3","4","6","7","8","9","A","B","C"],"x-enumDescriptions":{"0":"New — the order has been received but not yet processed.","1":"Partial fill — the order has been partially filled.","2":"Filled — the order has been completely filled.","4":"Canceled — the order has been canceled.","6":"Pending cancel — a cancel request has been submitted and is awaiting confirmation.","8":"Rejected — the order was rejected.","9":"Suspended.","A":"Pending new — the order has been submitted but not yet acknowledged.","B":"Calculated.","C":"Expired."}},"orderType":{"type":"string","example":"1","description":"The type of order that is placed.","enum":["0","1","2","3","4","6","7","m"],"x-enumDescriptions":{"1":"A market order.","2":"A limit order.","3":"A stop order.","4":"A stop limit order.","6":"A market-if-touched order.","m":"An unknown order type."}},"orderQty":{"$ref":"#/components/schemas/orderQuantity"},"isoTimeRestingOrderExpires":{"type":"string","example":null,"description":"The time when the limit order expires."},"limitPrice":{"type":"number","example":null,"description":"The price set for the limit order."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"orderCashAmt":{"type":"number","example":null,"description":"The amount of cash requested for an order (fractional shares only)."},"stopPrice":{"type":"number","example":200,"description":"The stop price of a limit order."},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"salesCredit":{"$ref":"#/components/schemas/SalesCredit"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"}}}]}}}},"SalesCredit":{"type":"object","description":"If set, the unit price will be marked up or marked down based on the prescribed amount. Only applicable to Orders for Debt Instruments.","properties":{"currency":{"$ref":"#/components/schemas/currency"},"amount":{"type":"integer","example":14,"description":"The sales credit amount in cents."}}},"UserSubscriptions":{"type":"array","description":"A list of the user's current subscriptions.","items":{"oneOf":[{"$ref":"#/components/schemas/UserSubscription"}]}},"UserSubscription":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/subscriptionID"},"accountDetails":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountType":{"$ref":"#/components/schemas/accountType"},"accountManagementType":{"$ref":"#/components/schemas/accountManagementTypeObject"},"status":{"$ref":"#/components/schemas/subscriptionStatus"},"paymentSource":{"type":"object","properties":{"source":{"type":"string"},"sourceType":{"$ref":"#/components/schemas/bankAccountID"}}},"plan":{"type":"object","properties":{"planID":{"type":"string","example":"plan_123e4567-e89b-12d3-a456-00000000005f","description":"The unique identifier that identifies the plan schedule."},"name":{"type":"string","example":"Monthly Subscription","description":"The name of the global name of the planned subscription."},"interval":{"type":"string","example":"MONTH","description":"The interval in which the user's linked bank account will be charged.","enum":["MONTHLY","QUARTERLY"],"x-enumDescriptions":{"MONTHLY":"Charged every month.","QUARTERLY":"Charged every three months."}},"intervalCount":{"type":"number","example":1,"description":"The interval in which the user's linked bank account will be charged represented as an integer value.","enum":[1,3],"x-enumDescriptions":{"1":"Charged every month.","3":"Charged every three months (quarterly)."}},"amount":{"type":"number","example":4.99,"description":"The amount the user's linked bank account will be charged."},"currency":{"$ref":"#/components/schemas/currency"}}},"created":{"$ref":"#/components/schemas/created","description":"The date and time that the subscription was created for the user's linked bank account."},"started":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time that the subscription started."},"expires":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time that the subscription will expire; and stop charging the user's linked bank account."},"transactionHistory":{"type":"array","example":[],"description":"A list of all this historical subscriptions transactions charged to the user's linked bank account.","items":{"oneOf":[{"$ref":"#/components/schemas/TransactionRes"}]}}}}}},"Documents":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/physicalDocumentID"},"type":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/physicalDocumentTypes"},"description":{"type":"string","example":"Driver License","description":"A custom description about the classification of the document."}}},"status":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/physicalDocumentStatus"},"description":{"type":"string","example":"The document has not been submitted for approval.","description":"A custom description to describe the status."}}}}},"DocumentsArray":{"type":"array","description":"An array of uploaded documents","items":{"oneOf":[{"$ref":"#/components/schemas/Documents"}]}},"DepositsArray":{"type":"array","description":"A list of deposits","items":{"oneOf":[{"$ref":"#/components/schemas/DepositsByUserID"}]}},"DepositsByUserID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/depositID"},"paymentID":{"$ref":"#/components/schemas/depositID"},"amount":{"type":"number","example":125.22,"description":"The amount of the deposit"},"currency":{"$ref":"#/components/schemas/currencyObject"},"status":{"$ref":"#/components/schemas/depositStatusObject"},"accountDetails":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountType":{"$ref":"#/components/schemas/accountTypeObject"},"accountManagementType":{"$ref":"#/components/schemas/accountManagementTypeObject"}}},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"note":{"$ref":"#/components/schemas/note"}}},"authorizedUser":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"permissions":{"type":"array","description":"Permission assigned to the authorized user.","example":["ORDERS_CREATE","MINOR_GRADUATION_TRANSFER"],"items":{"oneOf":[{"$ref":"#/components/schemas/permissions"}]}}}},"permissions":{"type":"string","example":"MINOR_GRADUATION_TRANSFER","enum":["ORDERS_CREATE","MINOR_GRADUATION_TRANSFER"],"x-enumDescriptions":{"ORDERS_CREATE":"Permission to create orders.","MINOR_GRADUATION_TRANSFER":"Permission to transfer a minor's custodial account once the minor reaches the age of majority."}},"interestedParty":{"type":"object","properties":{"type":{"type":"string","description":"The type of interested party.","enum":["AUTHORIZED_USER","CUSTODIAN"],"x-enumDescriptions":{"AUTHORIZED_USER":"A user authorized to act on the account.","CUSTODIAN":"The custodian of the account."}},"data":{"type":"array","description":"The list of interested parties. The shape of each item is determined by the sibling `type` field: when `type` is `AUTHORIZED_USER`, each item follows `interestedPartyAuthorizedUser`; when `type` is `CUSTODIAN`, each item follows `interestedPartyCustodian`. The item itself does not repeat the `type` field.","items":{"oneOf":[{"$ref":"#/components/schemas/interestedPartyAuthorizedUser"},{"$ref":"#/components/schemas/interestedPartyCustodian"}]}}}},"interestedPartyAuthorizedUser":{"type":"object","required":["id","reportingRole","tradeDiscretion","from"],"properties":{"id":{"$ref":"#/components/schemas/userID"},"reportingRole":{"type":"string","description":"The role of the interested party of the ID.","enum":["AUTH3RD","AUTHREP","NTHOLDER","TRDHOLDER"],"x-enumDescriptions":{"AUTH3RD":"Third Party.","AUTHREP":"Authorized Representative.","NTHOLDER":"Non-Holder.","TRDHOLDER":"Trading Holder."}},"tradeDiscretion":{"type":"boolean","description":"The trade discretion of the interested party of the ID."},"from":{"type":"string","format":"date-time","pattern":"yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2022-12-25T22:28:21.810Z","description":"Time when the interested party role started"},"to":{"type":"string","format":"date-time","pattern":"yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2022-12-26T22:28:21.810Z","description":"Time when the interested party role ended"},"endReason":{"type":"string","description":"The reason the interested party role ended.","enum":["CORRECTION","ENDED","INACTIVE","REPLACED","OTHER","TRANSFER"],"x-enumDescriptions":{"CORRECTION":"Ended due to a data correction.","ENDED":"The role ended normally.","INACTIVE":"The role ended because the party became inactive.","REPLACED":"The role ended because the party was replaced.","OTHER":"Another reason.","TRANSFER":"The role ended due to an account transfer."}}}},"interestedPartyCustodian":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/components/schemas/userID"}}},"from":{"type":"string","format":"date","pattern":"yyyy-MM-dd","example":"2022-12-25","description":"A filter, the start date."},"to":{"type":"string","format":"date","pattern":"yyyy-MM-dd","example":"2022-12-26","description":"A filter, the end date."},"TaxLot":{"type":"object","properties":{"taxLotID":{"$ref":"#/components/schemas/taxLotID"}}},"taxLotID":{"type":"string","example":"0123456789abcdef0123456789abcdef00000000","description":"A unique tax lot identifier."},"investmentSuitability":{"type":"object","properties":{"experience":{"type":"string","example":"LIMITED","description":"Trading experience level.","enum":["LIMITED","NONE","GOOD","EXCELLENT"],"x-enumDescriptions":{"LIMITED":"Limited trading knowledge or experience.","NONE":"No trading knowledge or experience.","GOOD":"Good trading knowledge and experience.","EXCELLENT":"Excellent trading knowledge and extensive experience."}},"years":{"type":"string","example":"YRS_10_PLUS","description":"Number of years equity trading experience.","enum":["YRS_1_LESS","YRS_1_2","YRS_3_5","YRS_6_9","YRS_10_PLUS"],"x-enumDescriptions":{"YRS_1_LESS":"Less than 1 year.","YRS_1_2":"1 to 2 years.","YRS_3_5":"3 to 5 years.","YRS_6_9":"6 to 9 years.","YRS_10_PLUS":"10 or more years."}},"tradesPerYear":{"type":"string","example":"YRS_10_14","description":"Total number of trades per year.","enum":["YRS_0_9","YRS_10_14","YRS_15_24","YRS_25_74","YRS_75_PLUS"],"x-enumDescriptions":{"YRS_0_9":"0 to 9 trades per year.","YRS_10_14":"10 to 14 trades per year.","YRS_15_24":"15 to 24 trades per year.","YRS_25_74":"25 to 74 trades per year.","YRS_75_PLUS":"75 or more trades per year."}},"averageTradeSize":{"type":"string","example":"AVG_0_9999","description":"Average per trade size.","enum":["AVG_0_9999","AVG_10000_24999","AVG_25000_PLUS"],"x-enumDescriptions":{"AVG_0_9999":"$0 to $9,999.","AVG_10000_24999":"$10,000 to $24,999.","AVG_25000_PLUS":"$25,000 or more."}}}},"investmentSuitabilityCommon":{"type":"object","properties":{"knowledge":{"type":"string","example":"LIMITED","description":"Trading experience level.","enum":["LIMITED","NONE","GOOD","EXCELLENT"],"x-enumDescriptions":{"LIMITED":"Limited trading knowledge or experience.","NONE":"No trading knowledge or experience.","GOOD":"Good trading knowledge and experience.","EXCELLENT":"Excellent trading knowledge and extensive experience."}},"yearsOfExperience":{"type":"number","example":10,"description":"Number of years of trading experience."},"tradesPerYear":{"type":"number","example":50,"description":"Total number of trades per year."},"averageTradeValue":{"type":"number","example":150.31,"description":"Average USD value per trade."}}},"investmentSuitabilityEquities":{"type":"object","allOf":[{"$ref":"#/components/schemas/investmentSuitabilityCommon"},{"type":"object","properties":{"transactionTypes":{"type":"array","description":"The types of transactions the user has experience with.","items":{"type":"string","enum":["LONG","SHORT","MARGIN"],"x-enumDescriptions":{"LONG":"Long equity positions.","SHORT":"Short equity positions.","MARGIN":"Margin trading positions."}},"example":["LONG","MARGIN"]}}}]},"investmentSuitabilityOptions":{"type":"object","allOf":[{"$ref":"#/components/schemas/investmentSuitabilityCommon"},{"type":"object","properties":{"transactionTypes":{"type":"array","description":"The types of transactions the user has experience with.","items":{"type":"string","enum":["COVERED","LONG","SPREADS","NAKED_PUTS","NAKED_CALLS"],"x-enumDescriptions":{"COVERED":"Covered options strategies, such as covered calls.","LONG":"Long options strategies, such as buying calls or puts.","SPREADS":"Spread options strategies, such as vertical or calendar spreads.","NAKED_PUTS":"Naked (uncovered) put writing.","NAKED_CALLS":"Naked (uncovered) call writing."}},"example":["LONG","NAKED_CALLS"]}}}]},"investmentSuitabilityDeclineToAnswer":{"type":"object","oneOf":[{"$ref":"#/components/schemas/investmentSuitabilityCommon","title":"Suitability Answers"},{"title":"Decline to Answer","type":"object","properties":{"declineToAnswer":{"type":"boolean","description":"Indicates whether the user declined to answer the suitability question.","example":true}}}]},"partnerID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000005","description":"The partner's unique identifier."},"partner":{"type":"object","properties":{"partnerID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000005","description":"The partner's unique identifier."},"partnerName":{"type":"string","example":"DriveWealth","description":"The partner's name."}}},"metadata":{"type":"object","example":{"myCustomKey":"myCustomValue"},"description":"The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes."},"metadataMoneyMovement":{"type":"object","example":{"myCustomKey":"myCustomValue"},"description":"The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes."},"settlementProfileID":{"type":"string","example":"settlement-profile-bank-account-1","description":"A settlement profile identifier that links to a specific bank account for fund settlement."},"externalBankName":{"type":"string","example":"Bank of America","description":"The bank name of the linked account."},"externalBankAddress":{"type":"string","example":"222 Broadway, New York City, NY, 10038","description":"The full address of the bank where the account is linked."},"externalBankCountry":{"type":"string","example":"USA","description":"The country of the bank where the account is linked."},"externalAccountHolderAddress":{"type":"string","example":"123 Main Street, New York, NY, 10001","description":"The home address of the linked account holder."},"externalAccountHolderCountry":{"type":"string","example":"USA","description":"The country of the linked account holder."},"singleSettlementStatus":{"type":"string","example":"PENDING","description":"The current status of the settlement.","enum":["PENDING","APPROVED","SUCCESSFUL"],"x-enumDescriptions":{"PENDING":"The settlement is pending.","APPROVED":"The settlement has been approved.","SUCCESSFUL":"The settlement completed successfully."}},"singleSettlementID":{"type":"string","example":"sett_123e4567-e89b-12d3-a456-000000000060_settle-profile-usa_20221224","description":"A unique identifier that identifies the settlement."},"CashSettlementFields":{"type":"object","properties":{"cashBalance":{"type":"number","example":25000.75,"description":"Cash balance in the partner's settlement account. Only present if the partner is enabled for automated settlements processing."},"cashSettlementAccountID":{"$ref":"#/components/schemas/accountID","description":"Account ID of the cash settlement account tied to this settlement/reconciliation. Only present if the partner is enabled for automated settlements processing."},"cashSettlementAccountNo":{"type":"string","example":"DW123456789","description":"Account number of the cash settlement account. Only present if the partner is enabled for automated settlements processing."}}},"lastActivityDate":{"type":"string","example":"2024-07-23","description":"The date indicating the last recorded activity of the account, across the partner's ecosystem. It's important to update this field regularly, as activity recency may impact functions like escheatment, and there may be activity occuring outside of the DriveWealth APIs."},"directorRoleType":{"type":"string","example":"CONTROL_PERSON","description":"The type of director role.","enum":["CONTROL_PERSON","BENEFICIAL_OWNER","TRUSTEE","GRANTOR","BENEFICIARY"],"x-enumDescriptions":{"CONTROL_PERSON":"A person with control over the entity.","BENEFICIAL_OWNER":"A beneficial owner of the entity.","TRUSTEE":"A trustee of the entity.","GRANTOR":"A grantor of the entity.","BENEFICIARY":"A beneficiary of the entity."}},"kycProcessStatus":{"type":"string","example":"KYC_READY","description":"The status of the KYC process.","enum":["KYC_NOT_READY","KYC_READY","KYC_PROCESSING","KYC_INFO_REQUIRED","KYC_DOC_REQUIRED","KYC_MANUAL_REVIEW","KYC_DENIED","KYC_APPROVED"],"x-enumDescriptions":{"KYC_NOT_READY":"KYC is not ready to be processed.","KYC_READY":"KYC is ready to be processed.","KYC_PROCESSING":"KYC is being processed.","KYC_INFO_REQUIRED":"Additional information is required to complete KYC.","KYC_DOC_REQUIRED":"Additional documentation is required to complete KYC.","KYC_MANUAL_REVIEW":"KYC requires manual review.","KYC_DENIED":"KYC was denied.","KYC_APPROVED":"KYC was approved."}},"kybStatus":{"type":"string","example":"KYB_READY","description":"The status of the KYB process.","enum":["KYB_NOT_READY","KYB_READY","KYB_PROCESSING_DIRECTORS","KYB_PROCESSING_ENTITY","KYB_INFO_REQUIRED","KYB_DOC_REQUIRED","KYB_DENIED","KYB_APPROVED","KYB_MANUAL_REVIEW"],"x-enumDescriptions":{"KYB_NOT_READY":"KYB is not ready to be processed.","KYB_READY":"KYB is ready to be processed.","KYB_PROCESSING_DIRECTORS":"KYB is processing the entity's directors.","KYB_PROCESSING_ENTITY":"KYB is processing the entity.","KYB_INFO_REQUIRED":"Additional information is required to complete KYB.","KYB_DOC_REQUIRED":"Additional documentation is required to complete KYB.","KYB_DENIED":"KYB was denied.","KYB_APPROVED":"KYB was approved.","KYB_MANUAL_REVIEW":"KYB requires manual review."}},"taxStatus":{"type":"string","example":"TAX_READY","description":"The status of the tax information.","enum":["TAX_NOT_READY","TAX_READY","TAX_PROCESSING","TAX_MANUAL_REVIEW","TAX_INVALID","TAX_EXPIRED","TAX_APPROVED"],"x-enumDescriptions":{"TAX_NOT_READY":"Tax information is not ready to be processed.","TAX_READY":"Tax information is ready to be processed.","TAX_PROCESSING":"Tax information is being processed.","TAX_MANUAL_REVIEW":"Tax information requires manual review.","TAX_INVALID":"Tax information is invalid.","TAX_EXPIRED":"Tax information has expired.","TAX_APPROVED":"Tax information was approved."}},"businessStatus":{"type":"string","example":"PENDING","description":"The status of the business entity.","enum":["PENDING","APPROVED","REJECTED","REVOKED","CLOSED"],"x-enumDescriptions":{"PENDING":"The business entity is pending approval.","APPROVED":"The business entity has been approved.","REJECTED":"The business entity has been rejected.","REVOKED":"The business entity's approval has been revoked.","CLOSED":"The business entity has been closed."}},"factaStatus":{"type":"string","example":"ACTIVE_NFFE","description":"The tax chapter4 status.","enum":["ACTIVE_NFFE","PASSIVE_NFFE","PARTICIPATING_FFI","NONPARTICIPATING_FFI","REPORTING_MODEL_1_FFI","REPORTING_MODEL_2_FFI","REGISTERED_DEEMED_COMPLIANT_FFI","SPONSORED_FFI","NOT_FINANCIAL_ACCOUNT","COMPLIANT_NONREGISTERING_LOCAL_BANK","COMPLIANT_FFI_LOW_VALUE_ACCOUNTS","CLOSED_HELD_INVESTMENT_VEHICLE","LIMITED_LIFE_DEBT_INVESTMENT_ENTITY","INVESTMENT_ENTITIES_NO_FINANCIAL_ACCOUNTS","RESTRICTED_DISTRIBUTOR","NONREPORTING_IGA_FFI","FOREIGN_GOVERNMENT_OR_CENTRAL_BANK","INTERNATIONAL_ORGANIZATION","EXEMPT_RETIREMENT_PLANS","ENTITY_WHOLELY_OWNED_BENEFICIAL_OWNERS","TERRITORY_FINANCIAL_INSTITUTION","EXCEPTED_NONFINANCIAL_STARTUP_COMPANY","EXCEPTED_NONFINANCIAL_ENTITY_LIQUIDATION_BANKRUPTCY","ORGANIZATION_501C","NONPROFIT_ORGANIZATION","PUBLICLY_TRADED_NFFE_OR_AFFILIATE","EXCEPTED_TERRITORY_NFFE","EXCEPTED_INTER_AFFILIATE_FFI","DIRECT_REPORTING_NFFE","SPONSORED_DIRECT_REPORTING_NFFE","EXCEPTED_NONFINANCIAL_GROUP_ENTITY","OWNER_DOCUMENTED_FFI","FOREIGN_CENTRAL_BANK_OF_ISSUE","NOT_AVAILABLE"],"x-enumDescriptions":{"ACTIVE_NFFE":"Active Non-Financial Foreign Entity.","PASSIVE_NFFE":"Passive Non-Financial Foreign Entity.","PARTICIPATING_FFI":"A Foreign Financial Institution that has agreed to FATCA reporting.","NONPARTICIPATING_FFI":"A Foreign Financial Institution that has not agreed to FATCA compliance.","REPORTING_MODEL_1_FFI":"An FFI reporting under a Model 1 intergovernmental agreement (IGA).","REPORTING_MODEL_2_FFI":"An FFI reporting under a Model 2 intergovernmental agreement (IGA).","REGISTERED_DEEMED_COMPLIANT_FFI":"An FFI registered as deemed-compliant.","SPONSORED_FFI":"An FFI that is compliant via a sponsoring entity.","NOT_FINANCIAL_ACCOUNT":"The account is not classified as a financial account under FATCA.","COMPLIANT_NONREGISTERING_LOCAL_BANK":"A certified deemed-compliant nonregistering local bank.","COMPLIANT_FFI_LOW_VALUE_ACCOUNTS":"A certified deemed-compliant FFI with only low-value accounts.","CLOSED_HELD_INVESTMENT_VEHICLE":"A certified deemed-compliant closely held investment vehicle.","LIMITED_LIFE_DEBT_INVESTMENT_ENTITY":"A certified deemed-compliant limited life debt investment entity.","INVESTMENT_ENTITIES_NO_FINANCIAL_ACCOUNTS":"An investment entity that does not maintain financial accounts.","RESTRICTED_DISTRIBUTOR":"A restricted distributor of debt or equity interests.","NONREPORTING_IGA_FFI":"An FFI treated as deemed-compliant under an applicable IGA.","FOREIGN_GOVERNMENT_OR_CENTRAL_BANK":"A foreign government or central bank of issue.","INTERNATIONAL_ORGANIZATION":"An international organization.","EXEMPT_RETIREMENT_PLANS":"An exempt retirement plan.","ENTITY_WHOLELY_OWNED_BENEFICIAL_OWNERS":"An entity wholly owned by exempt beneficial owners.","TERRITORY_FINANCIAL_INSTITUTION":"A financial institution organized in a U.S. territory.","EXCEPTED_NONFINANCIAL_STARTUP_COMPANY":"An excepted nonfinancial start-up company.","EXCEPTED_NONFINANCIAL_ENTITY_LIQUIDATION_BANKRUPTCY":"An excepted nonfinancial entity in liquidation or bankruptcy.","ORGANIZATION_501C":"A tax-exempt organization under IRC Section 501(c).","NONPROFIT_ORGANIZATION":"A non-profit organization.","PUBLICLY_TRADED_NFFE_OR_AFFILIATE":"A publicly traded NFFE, or an affiliate of one.","EXCEPTED_TERRITORY_NFFE":"An excepted territory NFFE.","EXCEPTED_INTER_AFFILIATE_FFI":"An excepted inter-affiliate FFI.","DIRECT_REPORTING_NFFE":"A direct reporting NFFE.","SPONSORED_DIRECT_REPORTING_NFFE":"A sponsored direct reporting NFFE.","EXCEPTED_NONFINANCIAL_GROUP_ENTITY":"An excepted nonfinancial group entity.","OWNER_DOCUMENTED_FFI":"An owner-documented FFI.","FOREIGN_CENTRAL_BANK_OF_ISSUE":"A foreign central bank of issue.","NOT_AVAILABLE":"The status is not available."}},"taxRecipientCode":{"type":"string","example":"CORPORATION","description":"The tax chapter3 status.","enum":["UNKNOWN","INDIVIDUAL","CORPORATION","WITHHOLDING_FOREIGN_PARTNERSHIP","WITHHOLDING_FOREIGN_PARTNERSHIP_TRUST","TRUST","GOVERNMENT_INTERNATIONAL_ORGANIZATION","TAX_EXEMPT_ORGNIZATION","PRIVATE_FOUNDATION","ARTIST_ATHLETE","ESTATE","US_BRANCH_TREATED_PERSON","QUALIFIED_INTERMEDIARY","PRIVATE_INTERMEDIARY_WITHHOLDING_GENERAL","PRIVATE_INTERMEDIARY_WITHHOLDING_EXEMPT_ORG","QUALIFIED_INTERMEDIARY_WITHHOLDING_GENERAL","QUALIFIED_INTERMEDIARY_WITHHOLDING_EXEMPT_ORG","AUTHORIZED_FOREIGN_AGENT","PUBLIC_PENSION_FUND","UNKNOWN_RECIPIENT","QUALIFIED_SECURITIES_LENDER_INTERMEDIARY","QUALIFIED_SECURITIES_LENDER_OTHER","SIMPLE_TRUST","CENTRAL_BANK_OF_ISSUE","GRANTOR_TRUST","TAX_EXEMPT_ORGANIZATION","DISREGARDED_ENTITY","COMPLEX_TRUST","INTERNATIONAL_ORGANIZATION","PARTNERSHIP","FOREIGN_GOVERNMENT_CONTROLLED_ENTITY","FOREIGN_GOVERNMENT_INTEGRAL_PART","QI","NONQUALIFIED_INTERMEDIARY","TERRITORY_FINANCIAL_INSTITUTION","US_BRANCH","FOREIGN_PARTNERSHIP_WITHHOLDING","WITHHOLDING_FOREIGN_TRUST","NONWITHHOLDING_FOREIGN_PARTNERSHIP","NONWITHHOLDING_FOREIGN_SIMPLE_TRUST","NONWITHHOLDING_FOREIGN_GRANTOR_TRUST"],"x-enumDescriptions":{"UNKNOWN":"An unknown recipient type.","INDIVIDUAL":"An individual.","CORPORATION":"A corporation.","WITHHOLDING_FOREIGN_PARTNERSHIP":"A withholding foreign partnership.","WITHHOLDING_FOREIGN_PARTNERSHIP_TRUST":"A withholding foreign trust.","TRUST":"A trust.","GOVERNMENT_INTERNATIONAL_ORGANIZATION":"A government or international organization.","TAX_EXEMPT_ORGNIZATION":"A tax-exempt organization.","PRIVATE_FOUNDATION":"A private foundation.","ARTIST_ATHLETE":"An artist or athlete.","ESTATE":"An estate.","US_BRANCH_TREATED_PERSON":"A U.S. branch treated as a U.S. person.","QUALIFIED_INTERMEDIARY":"A qualified intermediary.","PRIVATE_INTERMEDIARY_WITHHOLDING_GENERAL":"A private arrangement intermediary withholding rate pool — general.","PRIVATE_INTERMEDIARY_WITHHOLDING_EXEMPT_ORG":"A private arrangement intermediary withholding rate pool — exempt organizations.","QUALIFIED_INTERMEDIARY_WITHHOLDING_GENERAL":"A qualified intermediary withholding rate pool — general.","QUALIFIED_INTERMEDIARY_WITHHOLDING_EXEMPT_ORG":"A qualified intermediary withholding rate pool — exempt organizations.","AUTHORIZED_FOREIGN_AGENT":"An authorized foreign agent.","PUBLIC_PENSION_FUND":"A public pension fund.","UNKNOWN_RECIPIENT":"An unknown recipient.","QUALIFIED_SECURITIES_LENDER_INTERMEDIARY":"A qualified securities lender acting as a qualified intermediary.","QUALIFIED_SECURITIES_LENDER_OTHER":"A qualified securities lender, other.","SIMPLE_TRUST":"A simple trust.","CENTRAL_BANK_OF_ISSUE":"A central bank of issue.","GRANTOR_TRUST":"A grantor trust.","TAX_EXEMPT_ORGANIZATION":"A tax-exempt organization.","DISREGARDED_ENTITY":"A disregarded entity.","COMPLEX_TRUST":"A complex trust.","INTERNATIONAL_ORGANIZATION":"An international organization.","PARTNERSHIP":"A partnership other than a withholding foreign partnership.","FOREIGN_GOVERNMENT_CONTROLLED_ENTITY":"An entity controlled by a foreign government.","FOREIGN_GOVERNMENT_INTEGRAL_PART":"An integral part of a foreign government.","QI":"A qualified intermediary.","NONQUALIFIED_INTERMEDIARY":"A nonqualified intermediary.","TERRITORY_FINANCIAL_INSTITUTION":"A U.S. territory financial institution.","US_BRANCH":"A U.S. branch not treated as a U.S. person.","FOREIGN_PARTNERSHIP_WITHHOLDING":"A withholding foreign partnership.","WITHHOLDING_FOREIGN_TRUST":"A withholding foreign trust.","NONWITHHOLDING_FOREIGN_PARTNERSHIP":"A nonwithholding foreign partnership.","NONWITHHOLDING_FOREIGN_SIMPLE_TRUST":"A nonwithholding foreign simple trust.","NONWITHHOLDING_FOREIGN_GRANTOR_TRUST":"A nonwithholding foreign grantor trust."}},"taxStatusCode":{"type":"string","description":"The tax form type.","enum":["W8BEN","W8BENE","W8ECI","W8EXPL","W8IMY","W9"],"x-enumDescriptions":{"W8BEN":"Form W-8BEN — a foreign individual.","W8BENE":"Form W-8BEN-E — a foreign entity.","W8ECI":"Form W-8ECI — income effectively connected with a U.S. trade or business.","W8EXPL":"Form W-8EXP — a foreign government, international organization, or other exempt entity.","W8IMY":"Form W-8IMY — a foreign intermediary or flow-through entity.","W9":"Form W-9 — a U.S. person."}},"identifications":{"type":"object","properties":{"ein":{"type":"string","description":"The Employer Identification Number of the entity.","example":"12-3456789"},"ftin":{"type":"string","description":"The Foreign Tax Identification Number of the entity.","example":"12-3456789"},"giin":{"type":"string","description":"The Global Intermediary Identification Number of the entity.","example":"123456.12345.12.12.123"},"ftnlo":{"type":"boolean","description":"indicates if FTIN is not legally required for the entity.","example":false},"ssn":{"type":"string","description":"Social Security Number of the grantor for trust entity (must be exactly 9 digits with no hyphens).","example":"900123456","pattern":"^\\d{9}$"}}},"accountPurpose":{"type":"string","example":"MASTER_TRADING","description":"The business purpose or classification of the account.","enum":["UNKNOWN","MASTER_TRADING","ESCROW","CLEANUP","HOUSE","INSTANT_FUNDING","INSTANT_WITHDRAWAL","ERROR","OMNIBUS","SUSPENSE","CASH_PROMOTION_ACCOUNT","SHARE_PROMOTION_ACCOUNT","TAX_WITHHOLDING","FEES","CASH_TRANSFER_DEPOSITS","CASH_TRANSFER_WITHDRAWALS","FX_TREASURY","FX_HOUSE","OMNIBUS_MASTER_TRADING","CLEARING_DEPOSIT","SETTLEMENT","PROP","BUY_IN","ESCHEATMENT","FIRM","TEST","OMNIBUS_DVP","PAB","WORTHLESS","PARTNER_HOUSE","OMNIBUS_EXECUTION","OMNIBUS_CASHLESS","OMNIBUS_CUSTODY","PARTNER_ERROR","OPTIONS_PREFUNDING","CLIENT_PREFUNDING"],"x-enumDescriptions":{"UNKNOWN":"The account's purpose has not been classified.","MASTER_TRADING":"The firm's primary trading account.","ESCROW":"An escrow account holding funds in trust for a pending transaction.","CLEANUP":"An account used to reconcile or clean up stray balances.","HOUSE":"The firm's own house account, not a customer account.","INSTANT_FUNDING":"An account used to fund the instant-deposit feature.","INSTANT_WITHDRAWAL":"An account used to fund the instant-withdrawal feature.","ERROR":"An account used to book erroneous trades pending correction.","OMNIBUS":"An omnibus account holding aggregated customer positions.","SUSPENSE":"A suspense account holding unresolved or unallocated transactions.","CASH_PROMOTION_ACCOUNT":"An account funding cash promotional bonuses.","SHARE_PROMOTION_ACCOUNT":"An account funding share/stock promotional bonuses.","TAX_WITHHOLDING":"An account holding withheld tax amounts.","FEES":"An account collecting fees.","CASH_TRANSFER_DEPOSITS":"An account used to process cash-transfer deposits.","CASH_TRANSFER_WITHDRAWALS":"An account used to process cash-transfer withdrawals.","FX_TREASURY":"The firm's FX treasury account.","FX_HOUSE":"The firm's FX house account.","OMNIBUS_MASTER_TRADING":"An omnibus account used for master trading.","CLEARING_DEPOSIT":"A clearing firm deposit account.","SETTLEMENT":"An account used to settle transactions.","PROP":"A proprietary trading account.","BUY_IN":"An account used to process buy-ins.","ESCHEATMENT":"An account holding escheated (unclaimed) property.","FIRM":"The firm's own account.","TEST":"A test account, not used for real customer activity.","OMNIBUS_DVP":"An omnibus delivery-versus-payment (DVP) account.","PAB":"A proprietary account of a broker-dealer (PAB).","WORTHLESS":"An account used to write off worthless securities.","PARTNER_HOUSE":"A partner's house account.","OMNIBUS_EXECUTION":"An omnibus account used for trade execution.","OMNIBUS_CASHLESS":"An omnibus account used for cashless transactions.","OMNIBUS_CUSTODY":"An omnibus account used for custody.","PARTNER_ERROR":"A partner's error account, used to book erroneous trades pending correction.","OPTIONS_PREFUNDING":"An account used to prefund options trades.","CLIENT_PREFUNDING":"An account to pre-fund for holidays where clients cannot send funds on a settlement date."}},"accountPurposeObject":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/accountPurpose"},"description":{"type":"string","example":"Master Account. All trading for associated Sub-accounts.","description":"A custom description of the account purpose."}}},"company":{"type":"string","description":"Broker company name","example":"BM Broker"},"commissionGroupID":{"type":"string","description":"Commission group ID for the partner.","example":"123e4567-e89b-12d3-a456-000000000161"},"contactPhoneMobile":{"type":"string","example":"5555550100"},"contactPhoneWork":{"type":"string","example":"5555550101"},"contraSubAccount":{"description":"Sub account in Inteliclear setup","type":"string","example":"11"},"inteliclearReports":{"type":"integer","example":1},"languageID":{"type":"string","example":"en_US"},"marginDefault":{"type":"number","format":"float","example":0.5},"prefix":{"description":"Prefix will use to generate accountNo under Partners. Should be 2 characters only. Example:<prefix>QH002404 i.e BMQH002404","type":"string","example":"BM"},"prefixPractice":{"description":"Prefix will use to generate accountNo under Partners for practice accounts. Should be 2 characters only. Example:<prefix>QH002404 i.e BMQH002404","type":"string","example":"BP"},"clearingFirmMPID":{"description":"MPID of the clearing firm.","type":"string","example":"DRIV"},"fixedIncomeClearingFirmMPID":{"description":"MPID of the clearing firm for fixed income.","type":"string","example":"DRIV"},"optionsClearingFirmMPID":{"description":"MPID of the clearing firm for options.","type":"string","example":"DRIV"},"clearingCode":{"description":"MPID of the clearing firm for options.","type":"string","example":"DRIV"},"supportedAssetTypes":{"type":"array","description":"Supported asset types for the partner. Only used for ACAT review system for now.","items":{"anyOf":[{"$ref":"#/components/schemas/instrumentType"}]}},"defaultIb":{"type":"object","properties":{"username":{"type":"string","example":"ib.{{company}}"},"password":{"type":"string","example":"passw0rd"},"userType":{"type":"string","example":"IB"},"documents":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"BASIC_INFO"},"data":{"type":"object","properties":{"firstName":{"type":"string","example":"{{name}}"},"lastName":{"type":"string","example":"IB"},"country":{"type":"string","example":"USA"},"phone":{"type":"string","example":"5555550100"},"emailAddress":{"type":"string","example":"myemail@example.com"},"language":{"type":"string","example":"en_US"},"company":{"type":"string","example":"MyBroker, LLC."}}}}}}}},"WlpCreateRequestModel":{"type":"object","required":["company","wlpID","countryID","commissionGroupID","contraSubAccount","prefix","defaultIb"],"properties":{"company":{"$ref":"#/components/schemas/company"},"wlpID":{"$ref":"#/components/schemas/wlpID"},"countryID":{"$ref":"#/components/schemas/country"},"currencyID":{"$ref":"#/components/schemas/currency"},"commissionGroupID":{"$ref":"#/components/schemas/commissionGroupID"},"contactPhoneMobile":{"$ref":"#/components/schemas/contactPhoneMobile"},"contactPhoneWork":{"$ref":"#/components/schemas/contactPhoneWork"},"contraSubAccount":{"$ref":"#/components/schemas/contraSubAccount"},"inteliclearReports":{"$ref":"#/components/schemas/inteliclearReports"},"languageID":{"$ref":"#/components/schemas/languageID"},"marginDefault":{"$ref":"#/components/schemas/marginDefault"},"prefix":{"$ref":"#/components/schemas/prefix"},"prefixPractice":{"$ref":"#/components/schemas/prefixPractice"},"clearingFirmMPID":{"$ref":"#/components/schemas/clearingFirmMPID"},"fixedIncomeClearingFirmMPID":{"$ref":"#/components/schemas/fixedIncomeClearingFirmMPID"},"optionsClearingFirmMPID":{"$ref":"#/components/schemas/optionsClearingFirmMPID"},"clearingCode":{"$ref":"#/components/schemas/clearingCode"},"defaultIb":{"$ref":"#/components/schemas/defaultIb"},"supportedAssetTypes":{"$ref":"#/components/schemas/supportedAssetTypes"}}},"WlpUpdateReqResModel":{"type":"object","properties":{"wlpID":{"$ref":"#/components/schemas/wlpID"},"active":{"type":"boolean","example":true},"company":{"$ref":"#/components/schemas/company"},"clearingCode":{"$ref":"#/components/schemas/clearingCode"},"contactPhoneMobile":{"$ref":"#/components/schemas/contactPhoneMobile"},"contactPhoneWork":{"$ref":"#/components/schemas/contactPhoneWork"},"countryID":{"$ref":"#/components/schemas/country"},"currencies":{"type":"array","items":{"type":"string","example":"USD"}},"commissionGroupID":{"$ref":"#/components/schemas/commissionGroupID"},"contraSubAccount":{"$ref":"#/components/schemas/contraSubAccount"},"inteliclearReports":{"$ref":"#/components/schemas/inteliclearReports"},"languageID":{"$ref":"#/components/schemas/languageID"},"marginDefault":{"$ref":"#/components/schemas/marginDefault"},"marginMin":{"type":"number","format":"float","example":0.5},"prefix":{"$ref":"#/components/schemas/prefix"},"prefixPractice":{"$ref":"#/components/schemas/prefixPractice"},"instrumentGroupID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000162","description":"Instrument group ID for the partner. Default to Master if not present."},"fixedIncomeClearingFirmMPID":{"$ref":"#/components/schemas/fixedIncomeClearingFirmMPID"},"optionsClearingFirmMPID":{"$ref":"#/components/schemas/optionsClearingFirmMPID"},"clearingFirmMPID":{"$ref":"#/components/schemas/clearingFirmMPID"},"supportedAssetTypes":{"$ref":"#/components/schemas/supportedAssetTypes"},"defaultIb":{"$ref":"#/components/schemas/defaultIb"}}},"UpdatePartnerProfile":{"type":"object","properties":{"omnibusAccountIDs":{"type":"array","description":"A list of omnibus account ids associated to the partner profile.","items":{"oneOf":[{"$ref":"#/components/schemas/accountID"}]}}}},"CreateAuthToken":{"type":"object","properties":{"username":{"type":"string","example":"bo.sample.api","description":"The B2B (business to business) back office username."},"authToken":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000003d.2018-07-26T14:45:47.391Z","description":"The B2B (business to business) back office session token."},"expiresAt":{"type":"string","example":"2022-12-28T01:09:33.714Z","description":"The date and time the session token expires."},"security":{"type":"object","properties":{"description":{"type":"string","example":"Partner Principal","description":"A custom description that describes the permission set."},"permissionSet":{"type":"array","description":"A list of the permissions the back office permissions assigned.","example":["ACCOUNTS_CREATE_LIVE","ACCOUNTS_CREATE_MANAGED","ACCOUNTS_CREATE_MARGIN","ACCOUNTS_CREATE_PRACTICE","ACCOUNTS_CREATE_RIA_MANAGED","ACCOUNTS_EDIT"]},"permissionID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000003e","description":"A unique identifier for the permission set."}}},"userID":{"$ref":"#/components/schemas/userID"},"firstName":{"type":"string","example":"Tendies Trading Company","description":"The Firm Name."},"lastName":{"type":"string","example":"LLC","description":"The Firm Type."},"parentIBID":{"$ref":"#/components/schemas/userID"}}},"CreateAuthTokenReq":{"type":"object","required":["username","password","appTypeID"],"properties":{"username":{"type":"string","example":"bo.sample.api","description":"The B2B (business to business) back office username."},"password":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000003f","description":"The B2B (business to business) back office password."},"appTypeID":{"type":"number","example":4,"description":"The version type identifier."}}},"CreateSessToken":{"type":"object","properties":{"token_type":{"type":"string","example":"Bearer","description":"The type of token that was generated.","enum":["Bearer"],"x-enumDescriptions":{"Bearer":"A Bearer token, used in the Authorization header."}},"expires_in":{"type":"string","example":"3600","description":"The length of time in seconds for which the session token is valid."},"access_token":{"type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c","description":"The session token."},"scope":{"type":"string","example":"all_trading","description":"The scope of permission set for the JSON Web Token (JWT)."}}},"CreateSessTokenReq":{"type":"object","required":["clientID","clientSecret"],"properties":{"clientID":{"type":"string","example":"0oafccTendies67BTx113","description":"The identifier of the client accessing the DriveWealth system."},"clientSecret":{"type":"string","example":"8WfNzC4oTendiesTradingCompanyPuQNwg7BPByWqQOj","description":"The secret of the client accessing the DriveWealth system."}}},"userNoteCategory":{"type":"string","enum":["USERS","ACCOUNTS","ORDERS","ACATS","KYC","CORPORATE_ACTIONS","INSTRUMENTS","PAYMENTS","TRANSACTIONS","TAX","STATEMENTS","SUBSCRIPTIONS","PORTFOLIO","GFV","FPSL","POSITIONS","PDT","TEFRA","OTHER"],"description":"The area of the business a note relates to.","x-enumDescriptions":{"USERS":"Relates to the user's profile or identity.","ACCOUNTS":"Relates to one of the user's accounts.","ORDERS":"Relates to order entry or execution.","ACATS":"Relates to an ACATS (Automated Customer Account Transfer Service) transfer.","KYC":"Relates to Know Your Customer identity verification.","CORPORATE_ACTIONS":"Relates to a corporate action (e.g. a stock split or merger).","INSTRUMENTS":"Relates to a tradable instrument.","PAYMENTS":"Relates to a deposit, withdrawal, or other payment.","TRANSACTIONS":"Relates to a ledger transaction.","TAX":"Relates to tax reporting or withholding.","STATEMENTS":"Relates to an account statement.","SUBSCRIPTIONS":"Relates to a recurring subscription.","PORTFOLIO":"Relates to portfolio or managed-allocation activity.","GFV":"Relates to a Good Faith Violation.","FPSL":"Relates to Fully Paid Securities Lending.","POSITIONS":"Relates to a held position.","PDT":"Relates to Pattern Day Trading status or restrictions.","TEFRA":"Relates to TEFRA (Tax Equity and Fiscal Responsibility Act) withholding.","OTHER":"Doesn't fit any other category."}},"userNoteVisibility":{"type":"string","enum":["INTERNAL","EXTERNAL"],"description":"`INTERNAL` notes are visible only within DriveWealth; `EXTERNAL` notes are also visible to the partner.","x-enumDescriptions":{"INTERNAL":"Visible only to DriveWealth-internal callers.","EXTERNAL":"Visible to DriveWealth-internal callers and the partner."}},"UserNoteReq":{"type":"object","required":["subject"],"properties":{"subject":{"type":"string","example":"Called client re: KYC docs","description":"A short title for the note."},"note":{"type":"string","example":"Client confirmed documents will be uploaded by Friday.","description":"The note body. Required when creating a note; optional when editing one."},"category":{"$ref":"#/components/schemas/userNoteCategory"},"visibility":{"allOf":[{"$ref":"#/components/schemas/userNoteVisibility"}],"example":"EXTERNAL","description":"On create (`POST`): a value of `INTERNAL` from any caller outside DriveWealth is silently treated as `EXTERNAL` - no error is raised, unlike the `GET` list filter's 403 for the same case. On edit (`PUT`/`PATCH`): this field is not honored at all - a note's visibility is fixed at creation and cannot be changed by editing it, for any caller."}}},"UserNoteCreateReq":{"description":"Request body for creating a new user note. Same shape as `UserNoteReq`, but `note` is also required.","allOf":[{"$ref":"#/components/schemas/UserNoteReq"},{"type":"object","required":["note"]}]},"UserNoteRes":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000165","description":"The note's unique identifier."},"created":{"type":"string","format":"date-time","example":"2026-06-15T14:22:01.000Z","description":"When the note was created."},"subject":{"type":"string","example":"Called client re: KYC docs"},"note":{"type":"string","example":"Client confirmed documents will be uploaded by Friday."},"createdBy":{"type":"string","example":"jsmith","description":"The username of whoever created the note."},"category":{"$ref":"#/components/schemas/userNoteCategory"},"partner":{"type":"object","description":"The partner the note was created under.","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000005"},"name":{"type":"string","example":"Acme Brokerage"}}},"visibility":{"allOf":[{"$ref":"#/components/schemas/userNoteVisibility"}],"example":"EXTERNAL","description":"Omitted from the response to any caller outside DriveWealth - consistently across GET, POST, PUT, and PATCH. Present only for DriveWealth-internal callers."}}},"UserStatusChangeRequest":{"type":"object","description":"Requests an Ops-initiated transition of a User's status. See PATCH /users/{userID}/status for the transitions this endpoint supports.","required":["status"],"properties":{"status":{"type":"string","enum":["APPROVED","REJECTED"],"description":"The status being requested for the user.","x-enumDescriptions":{"APPROVED":"Approve the user.","REJECTED":"Reject the user."}},"statusComment":{"type":"string","maxLength":256,"description":"Free-text reason for the status change, recorded as an internal note on the user (e.g. an incident or ticket reference)."}}},"OptionsReEvaluationRequest":{"type":"object","required":["userIDs"],"properties":{"userIDs":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string"},"description":"The Users to re-evaluate. Must contain between 1 and 1000 userIDs.","example":["123e4567-e89b-12d3-a456-000000000004","123e4567-e89b-12d3-a456-00000000015a"]}}},"OptionsReEvaluationResponse":{"type":"object","properties":{"correlationID":{"type":"string","description":"Unique identifier for this batch, used to correlate the queued re-evaluations in the audit trail.","example":"123e4567-e89b-12d3-a456-00000000015b"},"usersQueued":{"type":"integer","description":"The number of Users queued for re-evaluation.","example":2}}},"BankAccount":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/bankAccountID"},"bankAccountDetails":{"type":"object","properties":{"bankAccountNickName":{"$ref":"#/components/schemas/bankAccountNickName"},"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumberLastFour"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumber"}}},"default":{"type":"string","example":true,"description":"True, if this is the default bank account set by the customer."},"status":{"$ref":"#/components/schemas/bankAccountStatus"},"created":{"$ref":"#/components/schemas/created","description":"The date and time the User's bank account was linked."},"updated":{"$ref":"#/components/schemas/updated","description":"The date and time the User's bank account was updated."}}},"UsersReq":{"required":["userType","documents"],"type":"object","properties":{"username":{"type":"string","example":"sampleuser"},"password":{"type":"string","example":"samplepassword"},"userType":{"$ref":"#/components/schemas/userType"},"wlpID":{"type":"string","example":"TTCC","description":"The wlpID is a deep backoffice ID that identifies each partner from each other.\n\n *⚠️ Only require to pass if your existing partner before **10/1/22**.","deprecated":true},"parentIBID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000015c","description":"The parentIBID is a identifier that identifies a partners different business segments.\n\n *⚠️ Only require to pass if your existing partner before **10/1/22**.","deprecated":true},"walletSettlementProfileID":{"type":"string","example":"bank-profile-1","description":"The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile.\n\n *⚠️ This is optional and only users for certain partners are eligible."},"documents":{"type":"array","description":"The personal identifiable information & digital signatures.","items":{"$ref":"#/components/schemas/Document_Item"}},"metadata":{"$ref":"#/components/schemas/metadata"}}},"Document_Item":{"discriminator":{"propertyName":"type","mapping":{"BASIC_INFO":"#/components/schemas/Basic_Info","IDENTIFICATION_INFO":"#/components/schemas/Identification_Info","TAX_INFO":"#/components/schemas/Tax_Info","PERSONAL_INFO":"#/components/schemas/Personal_Info","ADDRESS_INFO":"#/components/schemas/Address_Info","KYC_VERIFICATION_INFO":"#/components/schemas/KYC_Verification_Info","EMPLOYMENT_INFO":"#/components/schemas/Employment_Info","INVESTOR_PROFILE_INFO":"#/components/schemas/Investor_Profile_Info","COMPLIANCE_AML_INFO":"#/components/schemas/Compliance_AML_Info","DISCLOSURES":"#/components/schemas/Disclosures","MARGIN_DISCLOSURE":"#/components/schemas/Margin_Disclosure","FPSL_DISCLOSURE":"#/components/schemas/FPSL_Disclosure","CUSTODIAN_INFO":"#/components/schemas/Custodian_Info","DIRECTOR_INFO":"#/components/schemas/Director_Info","INSTITUTIONAL_INFO":"#/components/schemas/Institutional_Info","TRUST_INFO":"#/components/schemas/Trust_Info"}},"oneOf":[{"$ref":"#/components/schemas/Basic_Info"},{"$ref":"#/components/schemas/Identification_Info"},{"$ref":"#/components/schemas/Tax_Info"},{"$ref":"#/components/schemas/Personal_Info"},{"$ref":"#/components/schemas/Address_Info"},{"$ref":"#/components/schemas/KYC_Verification_Info"},{"$ref":"#/components/schemas/Employment_Info"},{"$ref":"#/components/schemas/Investor_Profile_Info"},{"$ref":"#/components/schemas/Compliance_AML_Info"},{"$ref":"#/components/schemas/Disclosures"},{"$ref":"#/components/schemas/Margin_Disclosure"},{"$ref":"#/components/schemas/FPSL_Disclosure"},{"$ref":"#/components/schemas/Custodian_Info"},{"$ref":"#/components/schemas/Director_Info"},{"$ref":"#/components/schemas/Institutional_Info"},{"$ref":"#/components/schemas/Trust_Info"}]},"KYC_Verification_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"KYC_VERIFICATION_INFO","enum":["KYC_VERIFICATION_INFO"],"x-enumDescriptions":{"KYC_VERIFICATION_INFO":"Partner-supplied KYC verification result."}},"data":{"type":"object","properties":{"verification":{"type":"string","example":"APPROVED","enum":["APPROVED","FAILED"],"x-enumDescriptions":{"APPROVED":"The KYC verification was approved.","FAILED":"The KYC verification failed."}},"verificationIDType":{"type":"string","example":"DRIVER_LICENSE","enum":["DRIVER_LICENSE","NATIONAL_ID","RESIDENCE_PERMIT","PASSPORT","VISA","TAX_ID","VOTER_ID","WORK_PERMIT","TRUST","TRUST_CORP","CORPORATE"],"x-enumDescriptions":{"DRIVER_LICENSE":"A driver's license.","NATIONAL_ID":"A national identity card.","RESIDENCE_PERMIT":"A residence permit.","PASSPORT":"A passport.","VISA":"A visa.","TAX_ID":"A tax identification document.","VOTER_ID":"A voter identification card.","WORK_PERMIT":"A work permit.","TRUST":"A trust formation document.","TRUST_CORP":"A corporate trustee formation document.","CORPORATE":"A corporate formation document."}},"verificationFullName":{"type":"string","example":"John Doe","description":"The name of the customer that was passed during the KYC verification."},"verificationTimestamp":{"type":"string","example":"2022-12-22T16:04:46.724Z","description":"The ISO 8601 timestamp of when the KYC verification was completed by the partner."},"verificationTransactionID":{"type":"string","example":"","description":"A unique identifier passed to reference the KYC verification was completed by the partner."},"customField1":{"example":"customFieldValue1"},"customField2":{"example":"customFieldValue2"},"customField3":{"example":"customFieldValue3"},"customField4":{"example":"customFieldValue4"},"customField5":{"example":"customFieldValue5"}}}}},"KYC_Verification_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"KYC_VERIFICATION_INFO","enum":["KYC_VERIFICATION_INFO"],"x-enumDescriptions":{"KYC_VERIFICATION_INFO":"Partner-supplied KYC verification result."}},"data":{"type":"object","properties":{"verification":{"type":"string","example":"APPROVED","enum":["APPROVED","FAILED"],"x-enumDescriptions":{"APPROVED":"The KYC verification was approved.","FAILED":"The KYC verification failed."}},"verificationIDType":{"type":"string","example":"DRIVER_LICENSE","enum":["DRIVER_LICENSE","NATIONAL_ID","RESIDENCE_PERMIT","PASSPORT","VISA","TAX_ID","VOTER_ID","WORK_PERMIT","TRUST","TRUST_CORP","CORPORATE"],"x-enumDescriptions":{"DRIVER_LICENSE":"A driver's license.","NATIONAL_ID":"A national identity card.","RESIDENCE_PERMIT":"A residence permit.","PASSPORT":"A passport.","VISA":"A visa.","TAX_ID":"A tax identification document.","VOTER_ID":"A voter identification card.","WORK_PERMIT":"A work permit.","TRUST":"A trust formation document.","TRUST_CORP":"A corporate trustee formation document.","CORPORATE":"A corporate formation document."}},"verificationFullName":{"type":"string","example":"John Doe","description":"The name of the customer that was passed during the KYC verification."},"verificationTimestamp":{"type":"string","example":"2022-12-22T16:04:46.724Z","description":"The ISO 8601 timestamp of when the KYC verification was completed by the partner."},"verificationTransactionID":{"type":"string","example":"","description":"A unique identifier passed to reference the KYC verification was completed by the partner."},"customField1":{"example":"customFieldValue1"},"customField2":{"example":"customFieldValue2"},"customField3":{"example":"customFieldValue3"},"customField4":{"example":"customFieldValue4"},"customField5":{"example":"customFieldValue5"}}}}},"Trust_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"TRUST_INFO","enum":["TRUST_INFO"],"x-enumDescriptions":{"TRUST_INFO":"Trust name, date established, and trustee authority."}},"data":{"type":"object","properties":{"name":{"type":"string","example":"John's Trust","description":"The name of the trust."},"dateEstablished":{"type":"string","example":"2014-09-29","description":"The inception date of the trust."},"stateEstablished":{"type":"string","example":"NY","description":"The state or province where the trust was established."},"street1":{"type":"string","example":"123 Main Street","description":"The physical street address where the institution is located."},"street2":{"type":"string","example":"Unit 1100"},"city":{"type":"string","example":"NY","description":"The institutuion physical city."},"province":{"type":"string","example":"New York","description":"The institutuion physical state or province."},"postalCode":{"type":"string","example":"10001","description":"The institutuion physical postal or zip code."},"primaryTrusteeAuthority":{"type":"string","example":"TRUSTEE_ONLY","description":"The permissions the primary trustee has over the trust.","enum":["TRUSTEE_ONLY","TRUSTEE_AND_GRANTOR","MODIFY_TRUSTEES","MODIFY_TRUST"],"x-enumDescriptions":{"TRUSTEE_ONLY":"The primary trustee may act alone on behalf of the trust.","TRUSTEE_AND_GRANTOR":"The primary trustee must act jointly with the grantor.","MODIFY_TRUSTEES":"The primary trustee may add or remove other trustees.","MODIFY_TRUST":"The primary trustee may modify the terms of the trust."}},"tin":{"type":"string","example":"123456789","description":"The tax identification number of the trust."}}}}},"Trust_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"TRUST_INFO","enum":["TRUST_INFO"],"x-enumDescriptions":{"TRUST_INFO":"Trust name, date established, and trustee authority."}},"data":{"type":"object","properties":{"name":{"type":"string","example":"John's Trust","description":"The name of the trust."},"dateEstablished":{"type":"string","example":"2014-09-29","description":"The inception date of the trust."},"stateEstablished":{"type":"string","example":"NY","description":"The state or province where the trust was established."},"street1":{"type":"string","example":"123 Main Street","description":"The physical street address where the institution is located."},"street2":{"type":"string","example":"Unit 1100"},"city":{"type":"string","example":"NY","description":"The institutuion physical city."},"province":{"type":"string","example":"New York","description":"The institutuion physical state or province."},"postalCode":{"type":"string","example":"10001","description":"The institutuion physical postal or zip code."},"primaryTrusteeAuthority":{"type":"string","example":"TRUSTEE_ONLY","description":"The permissions the primary trustee has over the trust.","enum":["TRUSTEE_ONLY","TRUSTEE_AND_GRANTOR","MODIFY_TRUSTEES","MODIFY_TRUST"],"x-enumDescriptions":{"TRUSTEE_ONLY":"The primary trustee may act alone on behalf of the trust.","TRUSTEE_AND_GRANTOR":"The primary trustee must act jointly with the grantor.","MODIFY_TRUSTEES":"The primary trustee may add or remove other trustees.","MODIFY_TRUST":"The primary trustee may modify the terms of the trust."}},"tin":{"type":"string","example":"123456789","description":"The tax identification number of the trust."}}}}},"Margin_Disclosure":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"MARGIN_DISCLOSURE","enum":["MARGIN_DISCLOSURE"],"x-enumDescriptions":{"MARGIN_DISCLOSURE":"Acceptance of the DriveWealth Margin Agreement."}},"data":{"type":"object","required":["marginAgreement"],"properties":{"marginAgreement":{"type":"boolean","example":true,"description":"A User's acceptance of DriveWealth's Margin Agreement."}}}}},"FPSL_Disclosure":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"FPSL_DISCLOSURE","enum":["FPSL_DISCLOSURE"],"x-enumDescriptions":{"FPSL_DISCLOSURE":"Acceptance of the Fully Paid Securities Lending (FPSL) Agreement."}},"data":{"type":"object","required":["fpslAgreement"],"properties":{"fpslAgreement":{"type":"boolean","example":true,"description":"A User's acceptance of DriveWealth's Fully Paid Securities Lending (FPSL) Agreement."}}}}},"Margin_Disclosure_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"MARGIN_DISCLOSURE","enum":["MARGIN_DISCLOSURE"],"x-enumDescriptions":{"MARGIN_DISCLOSURE":"Acceptance of the DriveWealth Margin Agreement."}},"data":{"type":"object","properties":{"marginAgreement":{"type":"boolean","example":true,"description":"A User's acceptance of DriveWealth's Margin Agreement."}}}}},"FPSL_Disclosure_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"FPSL_DISCLOSURE","enum":["FPSL_DISCLOSURE"],"x-enumDescriptions":{"FPSL_DISCLOSURE":"Acceptance of the Fully Paid Securities Lending (FPSL) Agreement."}},"data":{"type":"object","properties":{"fpslAgreement":{"type":"boolean","example":true,"description":"A User's acceptance of DriveWealth's Fully Paid Securities Lending (FPSL) Agreement."}}}}},"Custodian_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"CUSTODIAN_INFO","enum":["CUSTODIAN_INFO"],"x-enumDescriptions":{"CUSTODIAN_INFO":"Custodian user for custodial accounts."}},"data":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"}}}}},"Custodian_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"CUSTODIAN_INFO","enum":["CUSTODIAN_INFO"],"x-enumDescriptions":{"CUSTODIAN_INFO":"Custodian user for custodial accounts."}},"data":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"}}}}},"Director_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"DIRECTOR_INFO","enum":["DIRECTOR_INFO"],"x-enumDescriptions":{"DIRECTOR_INFO":"Directors/beneficial owners for institutional accounts."}},"data":{"type":"object","properties":{"directorList":{"type":"array","items":{"$ref":"#/components/schemas/directors"}}}}}},"directors":{"type":"object","properties":{"title":{"type":"string","example":"Chief Innovation Officer","description":"The title of the director."},"controlContact":{"type":"boolean","example":true,"description":"True, if the director has control over the account."},"institutionalID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000015d","description":"The unique identifier of the institution director should assioacted with.."},"roles":{"type":"array","items":{"type":"string","example":"CONTROL_PERSON","enum":["CONTROL_PERSON","BENEFICIAL_OWNER","TRUSTEE","GRANTOR","BENEFICIARY"],"description":"The role in which the director serves in the institution.","x-enumDescriptions":{"CONTROL_PERSON":"A person with control over the entity.","BENEFICIAL_OWNER":"A beneficial owner of the entity.","TRUSTEE":"A trustee of the entity.","GRANTOR":"A grantor of the entity.","BENEFICIARY":"A beneficiary of the entity."}}},"percentage":{"type":"number","example":0.52,"description":"The percentage of ownership the director has in the institution. Value must be greater than 0 and up to 1 (representing 0-100%), with a maximum of 2 decimal places."}}},"Institutional_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"INSTITUTIONAL_INFO","enum":["INSTITUTIONAL_INFO"],"x-enumDescriptions":{"INSTITUTIONAL_INFO":"Physical address and structure for institutional accounts."}},"data":{"type":"object","properties":{"physicalAddressLine1":{"type":"string","example":"123 Main Street","description":"The physical street address where the institution is located."},"physicalAddressLine2":{"type":"string","example":"Unit 1100"},"physicalCity":{"type":"string","example":"New York","description":"The institutuion physical city."},"physicalStateProvince":{"type":"string","example":"NY","description":"The institutuion physical state or province."},"physicalZipPostalCode":{"type":"string","example":"10001","description":"The institutuion physical postal or zip code."},"physicalCountryID":{"type":"string","example":"USA","description":"The institutuion physical country of origin."},"companyOrganizedAs":{"type":"string","example":"LLC","description":"The institutuion orginizational structure.","enum":["NON_CORP","INC","CLUB","LLC","LLLP","LLP","LP","PARTNERSHIP","SOLE_PROPRIETOR"],"x-enumDescriptions":{"NON_CORP":"A non-corporate organization.","INC":"A corporation (Inc.).","CLUB":"An investment club.","LLC":"A Limited Liability Company.","LLLP":"A Limited Liability Limited Partnership.","LLP":"A Limited Liability Partnership.","LP":"A Limited Partnership.","PARTNERSHIP":"A general partnership.","SOLE_PROPRIETOR":"A sole proprietorship."}},"usaBranch":{"type":"boolean","example":true,"description":"True, if the institutuion is registered in side of the United States."},"foreignBank":{"type":"boolean","example":false,"description":"True, if the institution is a foreign bank."},"foreignFinancialInstitution":{"type":"boolean","example":false,"description":"True, if the institution is maintained for a foreign finanical institution."},"directorCount":{"type":"number","example":"15","description":"The number of directors to be added to institutional account."}}}}},"Institutional_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"INSTITUTIONAL_INFO","enum":["INSTITUTIONAL_INFO"],"x-enumDescriptions":{"INSTITUTIONAL_INFO":"Physical address and structure for institutional accounts."}},"data":{"type":"object","properties":{"physicalAddressLine1":{"type":"string","example":"123 Main Street","description":"The physical street address where the institution is located."},"physicalAddressLine2":{"type":"string","example":"Unit 1100"},"physicalCity":{"type":"string","example":"New York","description":"The institutuion physical city."},"physicalStateProvince":{"type":"string","example":"NY","description":"The institutuion physical state or province."},"physicalZipPostalCode":{"type":"string","example":"10001","description":"The institutuion physical postal or zip code."},"physicalCountryID":{"type":"string","example":"USA","description":"The institutuion physical country of origin."},"companyOrganizedAs":{"type":"string","example":"LLC","description":"The institutuion orginizational structure.","enum":["NON_CORP","INC","CLUB","LLC","LLLP","LLP","LP","PARTNERSHIP","SOLE_PROPRIETOR"],"x-enumDescriptions":{"NON_CORP":"A non-corporate organization.","INC":"A corporation (Inc.).","CLUB":"An investment club.","LLC":"A Limited Liability Company.","LLLP":"A Limited Liability Limited Partnership.","LLP":"A Limited Liability Partnership.","LP":"A Limited Partnership.","PARTNERSHIP":"A general partnership.","SOLE_PROPRIETOR":"A sole proprietorship."}},"usaBranch":{"type":"boolean","example":true,"description":"True, if the institutuion is registered in side of the United States."},"foreignBank":{"type":"boolean","example":false,"description":"True, if the institution is a foreign bank."},"foreignFinancialInstitution":{"type":"boolean","example":false,"description":"True, if the institution is maintained for a foreign finanical institution."},"directorCount":{"type":"number","example":"15","description":"The number of directors to be added to institutional account."}}}}},"Basic_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","description":"The type of data object.","example":"BASIC_INFO","enum":["BASIC_INFO"],"x-enumDescriptions":{"BASIC_INFO":"Basic personal information (name, country, phone, email)."}},"data":{"type":"object","required":["firstName","lastName","country","phone","emailAddress"],"properties":{"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"country":{"type":"string","example":"USA","description":"The country where the User is residing."},"phone":{"$ref":"#/components/schemas/phoneNumber"},"emailAddress":{"$ref":"#/components/schemas/email"}}}}},"Identification_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","description":"The type of data object.","example":"IDENTIFICATION_INFO","enum":["IDENTIFICATION_INFO"],"x-enumDescriptions":{"IDENTIFICATION_INFO":"Government-issued identification (SSN, FTIN, passport, etc.)."}},"data":{"type":"object","required":["value","type","citizenship"],"properties":{"value":{"$ref":"#/components/schemas/userTaxID"},"type":{"$ref":"#/components/schemas/userTaxIDType"},"citizenship":{"$ref":"#/components/schemas/userCountry","description":"The country where the User has citizenship."},"issuingCountry":{"$ref":"#/components/schemas/userCountry","description":"The country where the identification was issued. Only required for PASSPORT, ALIEN_ID, and OTHER id types."},"issuingProvince":{"$ref":"#/components/schemas/userProvince","description":"The state or province where the identification was issued."},"issueDate":{"$ref":"#/components/schemas/date","description":"The date when the identification was issued in YYYY-MM-DD format."},"expiryDate":{"$ref":"#/components/schemas/date","description":"The date when the identification expires in YYYY-MM-DD format."},"description":{"type":"string","example":"Foreign Passport","description":"Additional information about the identification type provided."}}}}},"Tax_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","description":"The type of data object.","example":"TAX_INFO","enum":["TAX_INFO"],"x-enumDescriptions":{"TAX_INFO":"Tax treaty and taxpayer status information."}},"data":{"type":"object","required":["taxTreatyWithUS"],"properties":{"taxTreatyWithUS":{"type":"boolean","example":true,"description":"True, if the user lives in a treaty country and is claiming tax treaty with the United States."},"usTaxpayer":{"type":"boolean","example":true,"description":"True if the party is a US Tax payer"}}}}},"Personal_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","description":"The type of data object.","example":"PERSONAL_INFO","enum":["PERSONAL_INFO"],"x-enumDescriptions":{"PERSONAL_INFO":"Date of birth and marital status."}},"data":{"type":"object","required":["birthDay","birthMonth","birthYear","politicallyExposedNames"],"properties":{"birthDay":{"type":"number","example":3,"description":"The User's born day."},"birthMonth":{"type":"number","example":12,"description":"The User's born month."},"birthYear":{"type":"number","example":2000,"description":"The User's born year."},"dateOfDeath":{"type":"string","example":"2025-12-04","description":"The User's date of death in YYYY-MM-DD format."},"politicallyExposedNames":{"type":"string","example":"Nancy Pelosi","description":"The names of the people whom are political exposes, separated by a comma.\n\n *⚠️ Can be set to 'NULL' if not politically exposed"},"marital":{"$ref":"#/components/schemas/userMaritalStatus"}}}}},"Address_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","description":"The type of data object.","example":"ADDRESS_INFO","enum":["ADDRESS_INFO"],"x-enumDescriptions":{"ADDRESS_INFO":"Residential address."}},"data":{"type":"object","required":["street1","city","province","postalCode","country"],"properties":{"street1":{"$ref":"#/components/schemas/userStreet1"},"street2":{"$ref":"#/components/schemas/userStreet2"},"city":{"$ref":"#/components/schemas/userCity"},"province":{"$ref":"#/components/schemas/userProvince"},"postalCode":{"$ref":"#/components/schemas/userPostalCode"},"country":{"$ref":"#/components/schemas/userCountry"}}}}},"Employment_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"EMPLOYMENT_INFO","enum":["EMPLOYMENT_INFO"],"x-enumDescriptions":{"EMPLOYMENT_INFO":"Employment status, employer, and industry details."}},"data":{"type":"object","required":["status","broker","directorOf"],"properties":{"status":{"type":"string","example":"EMPLOYED","description":"The User current employment status.","enum":["EMPLOYED","RETIRED","STUDENT","UNEMPLOYED","SELF_EMPLOYED"],"x-enumDescriptions":{"EMPLOYED":"Employed.","RETIRED":"Retired.","STUDENT":"Student.","UNEMPLOYED":"Unemployed.","SELF_EMPLOYED":"Self-employed."}},"company":{"type":"string","example":"DriveWealth LLC","description":"The User's current employer name.\n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED & type is not being provided*"},"companyID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"A unique identifier created for each Institution or entity on DriveWealth's platform.*"},"from":{"type":"string","example":"2014-09-29","description":"The User's start date at the employment."},"to":{"type":"string","example":"2022-12-25","description":"The User's end date at the employment."},"type":{"type":"string","example":"FINANCE","description":"The User's current employer type.\n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED & company is not being provided*","enum":["AGRICULTURE","MINING","UTILITIES","CONSTRUCTION","MANUFACTURING","WHOLESALE","RETAIL","TRANSPORT","INFORMATION","FINANCE","REAL_ESTATE","PROFESSIONAL","MANAGEMENT","EDUCATION","HEALTH","ART","FOOD","PUBLIC","WASTE"],"x-enumDescriptions":{"AGRICULTURE":"Agriculture.","MINING":"Mining.","UTILITIES":"Utilities.","CONSTRUCTION":"Construction.","MANUFACTURING":"Manufacturing.","WHOLESALE":"Wholesale trade.","RETAIL":"Retail trade.","TRANSPORT":"Transportation.","INFORMATION":"Information and technology.","FINANCE":"Finance and insurance.","REAL_ESTATE":"Real estate.","PROFESSIONAL":"Professional, scientific, or technical services.","MANAGEMENT":"Management of companies.","EDUCATION":"Education.","HEALTH":"Health care and social assistance.","ART":"Arts, entertainment, and recreation.","FOOD":"Food service and accommodation.","PUBLIC":"Public administration.","WASTE":"Waste management and remediation."}},"position":{"type":"string","example":"ENGINEER","description":" The User's current role at the employment.\n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED & using Drivewealth's Market Data Offering*","enum":["ACCOUNTANT","ACTUARY","ADJUSTER","ADMINISTRATOR","ADVERTISER","AGENT","ATC","AMBASSADOR","ANALYST","APPRAISER","ARCHITECT","ARTIST","ASSISTANT","ATHLETE","ATTENDANT","ATTORNEY","AUCTIONEER","AUDITOR","BARBER","BROKER","BUSINESS_EXEC","BUSINESS_OWNER","CAREGIVER","CARPENTER","CASHIER","CHEF","CHIROPRACTOR","CIVIL","CLERGY","CLERK","COMPLIANCE","CONSULTANT","CONTRACTOR","COUNSELOR","CUSTOMER_SERVICE","DEALER","DEVELOPER","DISTRIBUTOR","DOCTOR","DRIVER","ENGINEER","EXAMINER","EXTERMINATOR","FACTORY","FARMER","FINANCIAL","FISHERMAN","FLIGHT","HR","IMPEX","INSPECTOR","INTERN","INVESTMENT","INVESTOR","IT","JANITOR","JEWELER","LABORER","LANDSCAPER","LENDING","MANAGER","MECHANIC","MILITARY","MORTICIAN","NURSE","NUTRITIONIST","OFFICE","PHARMACIST","PHYSICAL","PILOT","POLICE","POLITICIAN","PM","REP","RESEARCHER","SAILOR","SALES","SCIENTIST","SEAMSTRESS","SECURITY","SOCIAL","TEACHER","TECHNICIAN","TELLER","TRADESPERSON","TRAINER","TRANSPORTER","UNDERWRITER","WRITER"],"x-enumDescriptions":{"ACCOUNTANT":"Accountant/CPA/Bookkeeper/Controller.","ACTUARY":"Actuary.","ADJUSTER":"Adjuster.","ADMINISTRATOR":"Administrator.","ADVERTISER":"Advertiser/Marketer/PR Professional.","AGENT":"Agent.","ATC":"Air Traffic Controller.","AMBASSADOR":"Ambassador/Consulate Professional.","ANALYST":"Analyst.","APPRAISER":"Appraiser.","ARCHITECT":"Architect/Designer.","ARTIST":"Artist/Performer/Actor/Dancer.","ASSISTANT":"Assistant.","ATHLETE":"Athlete.","ATTENDANT":"Attendant.","ATTORNEY":"Attorney/Judge/Legal Professional.","AUCTIONEER":"Auctioneer.","AUDITOR":"Auditor.","BARBER":"Barber/Beautician/Hairstylist.","BROKER":"Broker.","BUSINESS_EXEC":"Business Executive (VP, Director, etc.).","BUSINESS_OWNER":"Business Owner.","CAREGIVER":"Caregiver.","CARPENTER":"Carpenter/Construction Worker.","CASHIER":"Cashier.","CHEF":"Chef/Cook.","CHIROPRACTOR":"Chiropractor.","CIVIL":"Civil Servant.","CLERGY":"Clergy.","CLERK":"Clerk.","COMPLIANCE":"Compliance/Regulatory Professional.","CONSULTANT":"Consultant.","CONTRACTOR":"Contractor.","COUNSELOR":"Counselor/Therapist.","CUSTOMER_SERVICE":"Customer Service Representative.","DEALER":"Dealer.","DEVELOPER":"Developer.","DISTRIBUTOR":"Distributor.","DOCTOR":"Doctor/Dentist/Veterinarian/Surgeon.","DRIVER":"Driver.","ENGINEER":"Engineer.","EXAMINER":"Examiner.","EXTERMINATOR":"Exterminator.","FACTORY":"Factory/Warehouse Worker.","FARMER":"Farmer/Rancher.","FINANCIAL":"Financial Planner.","FISHERMAN":"Fisherman.","FLIGHT":"Flight Attendant.","HR":"Human Resources Professional.","IMPEX":"Importer/Exporter.","INSPECTOR":"Inspector/Investigator.","INTERN":"Intern.","INVESTMENT":"Investment Advisor/Investment Manager.","INVESTOR":"Investor.","IT":"IT Professional/IT Associate.","JANITOR":"Janitor.","JEWELER":"Jeweler.","LABORER":"Laborer.","LANDSCAPER":"Landscaper.","LENDING":"Lending Professional.","MANAGER":"Manager.","MECHANIC":"Mechanic.","MILITARY":"Military, officer, or associated personnel.","MORTICIAN":"Mortician/Funeral Director.","NURSE":"Nurse.","NUTRITIONIST":"Nutritionist.","OFFICE":"Office Associate.","PHARMACIST":"Pharmacist.","PHYSICAL":"Physical Therapist.","PILOT":"Pilot.","POLICE":"Police Officer/Firefighter/Law Enforcement Professional.","POLITICIAN":"Politician.","PM":"Project Manager.","REP":"Registered Rep.","RESEARCHER":"Researcher.","SAILOR":"Sailor/Seaman.","SALES":"Salesperson.","SCIENTIST":"Scientist.","SEAMSTRESS":"Seamstress/Tailor.","SECURITY":"Security Guard.","SOCIAL":"Social Worker.","TEACHER":"Teacher/Professor.","TECHNICIAN":"Technician.","TELLER":"Teller.","TRADESPERSON":"Tradesperson/Craftsperson.","TRAINER":"Trainer/Instructor.","TRANSPORTER":"Transporter.","UNDERWRITER":"Underwriter.","WRITER":"Writer/Journalist/Editor."}},"broker":{"type":"boolean","example":true,"description":"True, if the User's current employer is broker."},"directorOf":{"type":"string","example":"AAPL, SQ","description":"The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company.\n\n *⚠️ Can be set to 'NULL' if not applicable*"}}}}},"Investor_Profile_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"INVESTOR_PROFILE_INFO","enum":["INVESTOR_PROFILE_INFO"],"x-enumDescriptions":{"INVESTOR_PROFILE_INFO":"Investment objectives, risk tolerance, and experience."}},"data":{"type":"object","required":["investmentExperience","annualIncome","networthTotal","riskTolerance","investmentObjectives","networthLiquid"],"properties":{"investmentExperience":{"type":"string","example":"YRS_10_","description":"The User's current investment expertise.\n\n *⚠️ Can be defaulted to 'YRS_1_2' for all asset classes, except Options.*","enum":["NONE","YRS_1_2","YRS_3_5","YRS_5_10","YRS_10_"],"x-enumDescriptions":{"NONE":"None.","YRS_1_2":"1-2 years.","YRS_3_5":"3-5 years.","YRS_5_10":"5-10 years.","YRS_10_":"10+ years."}},"annualIncome":{"type":"number","example":1000000,"description":"The User's current annalized income over one year."},"networthTotal":{"type":"number","example":2500000,"description":"The user's current networth. This calculation is the User's assets - liabilities."},"riskTolerance":{"type":"string","example":"HIGH","description":"The User's risk ceiling.\n\n *⚠️ Can be defaulted to 'LOW' for all asset classes, except Options.*","enum":["LOW","MODERATE","SPECULATION","HIGH"],"x-enumDescriptions":{"LOW":"Low risk tolerance.","MODERATE":"Moderate risk tolerance.","SPECULATION":"Speculative risk tolerance.","HIGH":"High risk tolerance."}},"investmentObjectives":{"type":"string","example":"CAPITAL_PRESERVATION","description":"The User's current investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY.\n\n *⚠️ Can be defaulted to 'CAPITAL_PRESERVATION' for all asset classes, except Options.*","enum":["LONG_TERM","INFREQUENT","FREQUENT","ACTIVE_DAILY","NEW","CAPITAL_PRESERVATION","GROWTH","INCOME","SPECULATION"],"x-enumDescriptions":{"LONG_TERM":"Long-term buy and hold strategy. Deprecated — replaced by CAPITAL_PRESERVATION and/or GROWTH.","INFREQUENT":"Infrequent trading activity. Deprecated — replaced by CAPITAL_PRESERVATION and/or INCOME.","FREQUENT":"Frequent trading activity. Deprecated — replaced by GROWTH and/or INCOME.","ACTIVE_DAILY":"Active daily trading. Deprecated — replaced by GROWTH and/or SPECULATION.","NEW":"New to trading with no prior experience.","CAPITAL_PRESERVATION":"Capital preservation.","GROWTH":"Growth.","INCOME":"Income.","SPECULATION":"Speculation."}},"secondaryInvestmentObjectives":{"type":"array","description":"The User's secondary investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY.","items":{"type":"string","example":"INCOME","enum":["LONG_TERM","INFREQUENT","FREQUENT","ACTIVE_DAILY","NEW","CAPITAL_PRESERVATION","GROWTH","INCOME","SPECULATION"],"x-enumDescriptions":{"LONG_TERM":"Long-term buy and hold strategy. Deprecated — replaced by CAPITAL_PRESERVATION and/or GROWTH.","INFREQUENT":"Infrequent trading activity. Deprecated — replaced by CAPITAL_PRESERVATION and/or INCOME.","FREQUENT":"Frequent trading activity. Deprecated — replaced by GROWTH and/or INCOME.","ACTIVE_DAILY":"Active daily trading. Deprecated — replaced by GROWTH and/or SPECULATION.","NEW":"New to trading with no prior experience.","CAPITAL_PRESERVATION":"Capital preservation.","GROWTH":"Growth.","INCOME":"Income.","SPECULATION":"Speculation."}}},"networthLiquid":{"type":"number","example":300000,"description":"The user's liquid net worth. The amount of cash or near cash equivalents of the User's net worth.\n\n *⚠️ Can be defaulted to '-1' for all asset classes, except Options.*"},"dependents":{"type":"number","example":"4","description":"Total number of dependents the account holder has.\n\n *⚠️ Required for Options Onboarding.*"},"optionsSuitability":{"type":"object","deprecated":true,"description":"Details about the User's suitability for trading options, including their experience with options and equities.\n\n *⚠️ Required for Options Onboarding.*","properties":{"equitiesExperience":{"$ref":"#/components/schemas/investmentSuitability","description":"An object containing fields that evaluate the User's experience and suitability for equities trading."},"optionsExperience":{"$ref":"#/components/schemas/investmentSuitability","description":"An object containing fields that evaluate the User's experience and suitability for options trading."}}},"equitiesExperience":{"$ref":"#/components/schemas/investmentSuitabilityEquities","description":"An object containing fields that evaluate the User's experience and suitability for equities trading.\n\n *⚠️ Required for Options Onboarding.*"},"optionsExperience":{"$ref":"#/components/schemas/investmentSuitabilityOptions","description":"An object containing fields that evaluate the User's experience and suitability for options trading.\n\n *⚠️ Required for Options Onboarding.*"},"fixedIncomeExperience":{"$ref":"#/components/schemas/investmentSuitabilityDeclineToAnswer","description":"An object containing fields that evaluate the User's experience and suitability for fixed income trading."},"commodityExperience":{"$ref":"#/components/schemas/investmentSuitabilityDeclineToAnswer","description":"An object containing fields that evaluate the User's experience and suitability for commodity trading."},"otherFinancialExperience":{"$ref":"#/components/schemas/investmentSuitabilityDeclineToAnswer","description":"An object containing fields that evaluate the User's experience and suitability for other financial instruments trading."}}}}},"Compliance_AML_Info":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","description":"The type of data object.","example":"COMPLIANCE_AML_INFO","enum":["COMPLIANCE_AML_INFO"],"x-enumDescriptions":{"COMPLIANCE_AML_INFO":"Funding sources and expected transfer activity for AML compliance."}},"data":{"type":"object","required":["fundingSources"],"properties":{"fundingSources":{"type":"array","description":"A list of the User's funding sources.","items":{"type":"string","enum":["EMP","GIFT","TRUST","INVESTMENT","SAVINGS","RETIRE","GAMBLING","LEGAL","FAMILY","UNEMP","ROLLOVER","RENT","SALE","INSURANCE"],"x-enumDescriptions":{"EMP":"Employment income.","GIFT":"Gift.","TRUST":"Trust.","INVESTMENT":"Investment income.","SAVINGS":"Savings.","RETIRE":"Retirement income.","GAMBLING":"Gambling winnings.","LEGAL":"Legal settlement.","FAMILY":"Family support.","UNEMP":"Unemployment benefits.","ROLLOVER":"Retirement rollover.","RENT":"Rental income.","SALE":"Sale of assets.","INSURANCE":"Insurance proceeds."}},"example":["EMP","SAVINGS"]},"transferFrequencyPerMonth":{"type":"integer","description":"The expected number of transfers per month.","example":7},"transferTotalExpected":{"type":"number","writeOnly":true,"description":"The expected total transfer amount. Only accepted on write; DriveWealth maps it to `transferTotalExpectedRange` for the response.","example":45350},"transferTotalExpectedRange":{"type":"string","readOnly":true,"description":"A range mapping for the expected total transfer amount, computed by DriveWealth.","enum":["$0_9999","$10K_49999","$50K_99999","$100K_249999","$250K_499999","$500K_"],"example":"$10K_49999","x-enumDescriptions":{"$0_9999":"$0 - $9,999.","$10K_49999":"$10,000 - $49,999.","$50K_99999":"$50,000 - $99,999.","$100K_249999":"$100,000 - $249,999.","$250K_499999":"$250,000 - $499,999.","$500K_":"$500,000+."}},"investmentHistory12M":{"type":"integer","description":"The number of investment transactions in the last 12 months.","example":12}}}}},"Disclosures":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"DISCLOSURES","enum":["DISCLOSURES"],"x-enumDescriptions":{"DISCLOSURES":"Acceptance of standard DriveWealth agreements."}},"data":{"type":"object","required":["termsOfUse","marketDataAgreement","customerAgreement","rule14b","privacyPolicy","dataSharing","signedBy"],"properties":{"extendedHoursAgreement":{"type":"boolean","example":false,"description":"True, if the User accepts DriveWealth's Extended Hours Agreement."},"termsOfUse":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Terms of Use."},"customerAgreement":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Customer Agreement."},"iraAgreement":{"type":"boolean","example":false,"description":"True, if the User accepts DriveWealth's Individual Retirement Account (IRA) Agreement. *⚠ Only for opening IRA accounts.*"},"marketDataAgreement":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Market Data Agreement."},"optionsAgreement":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Options trading Agreement."},"oddLinkAgreement":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's ODD Link Agreement."},"rule14b":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Rule 14b1(c)."},"privacyPolicy":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Privacy Policy."},"dataSharing":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Data Sharing Policy."},"signedBy":{"type":"string","example":"John Doe","description":"The User's digital signature (full name)."}}}}},"Basic_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"BASIC_INFO","enum":["BASIC_INFO"],"x-enumDescriptions":{"BASIC_INFO":"Basic personal information (name, country, phone, email)."}},"data":{"type":"object","properties":{"firstName":{"type":"string","example":"John","description":"The first name of the User."},"lastName":{"type":"string","example":"Smith","description":"The last (family) name of the User."},"country":{"type":"string","example":"USA","description":"The country where the User is residing."},"phone":{"type":"string","example":"18005550100","description":"The phone number of the User."},"emailAddress":{"type":"string","example":"john.doe@example.com","description":"The email address of the User."}}}}},"Identification_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"IDENTIFICATION_INFO","enum":["IDENTIFICATION_INFO"],"x-enumDescriptions":{"IDENTIFICATION_INFO":"Government-issued identification (SSN, FTIN, passport, etc.)."}},"data":{"type":"object","properties":{"value":{"type":"string","example":"1223334444","description":"The User's national identification number or tax identification number."},"type":{"type":"string","example":"SSN","description":"The type of national identification number. **Note:** `FTNLO` is deprecated and should not be used for new integrations.","enum":["SSN","EIN","FTIN","PASSPORT","ALIEN_ID","OTHER"],"x-enumDescriptions":{"SSN":"Social Security Number.","EIN":"Employer Identification Number.","FTIN":"Foreign Tax Identification Number.","PASSPORT":"A passport number used as a tax identifier.","ALIEN_ID":"An alien identification number.","OTHER":"Another identification type."}},"citizenship":{"type":"string","example":"USA","description":"The country where the User has citizenship."},"issuingCountry":{"$ref":"#/components/schemas/userCountry","description":"The country where the identification was issued. Only required for PASSPORT, ALIEN_ID, and OTHER id types."},"issuingProvince":{"$ref":"#/components/schemas/userProvince","description":"The state or province where the identification was issued."},"issueDate":{"$ref":"#/components/schemas/date","description":"The date when the identification was issued in YYYY-MM-DD format."},"expiryDate":{"$ref":"#/components/schemas/date","description":"The date when the identification expires in YYYY-MM-DD format."},"description":{"type":"string","example":"Foreign Passport","description":"Additional information about the identification type provided."}}}}},"Tax_Info_Patch":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"TAX_INFO","enum":["TAX_INFO"],"x-enumDescriptions":{"TAX_INFO":"Tax treaty and taxpayer status information."}},"data":{"type":"object","properties":{"taxTreatyWithUS":{"type":"boolean","example":true,"description":"True, if the User's country has a tax treaty with the United States."},"attestation":{"type":"object","properties":{"signedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000015e","description":"The user ID of the person who signed the attestation."}}},"usTaxpayer":{"type":"boolean","example":true,"description":"True if the party is a US Tax payer"}}}}},"Personal_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"PERSONAL_INFO","enum":["PERSONAL_INFO"],"x-enumDescriptions":{"PERSONAL_INFO":"Date of birth and marital status."}},"data":{"type":"object","properties":{"birthDay":{"type":"number","example":3,"description":"The User's born day."},"birthMonth":{"type":"number","example":12,"description":"The User's born month."},"birthYear":{"type":"number","example":2000,"description":"The User's born year."},"dateOfDeath":{"type":"string","example":"2025-12-04","description":"The User's date of death in YYYY-MM-DD format."},"politicallyExposedNames":{"type":"string","example":"Nancy Pelosi","description":"The names of the people whom are politicaly exposes, separated by a comma.\n\n *⚠️ Can be set to 'NULL' if not politically exposed*"},"marital":{"type":"string","example":"SINGLE","description":"The marital status of the User.","enum":["SINGLE","DIVORCED","MARRIED","WIDOWED","PARTNER"],"x-enumDescriptions":{"SINGLE":"Single.","DIVORCED":"Divorced.","MARRIED":"Married.","WIDOWED":"Widowed.","PARTNER":"Domestic partnership."}}}}}},"Director_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"DIRECTOR_INFO","enum":["DIRECTOR_INFO"],"x-enumDescriptions":{"DIRECTOR_INFO":"Directors/beneficial owners for institutional accounts."}},"data":{"type":"object","properties":{"directorList":{"type":"array","items":{"$ref":"#/components/schemas/directors"}}}}}},"Address_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"ADDRESS_INFO","enum":["ADDRESS_INFO"],"x-enumDescriptions":{"ADDRESS_INFO":"Residential address."}},"data":{"type":"object","properties":{"street1":{"type":"string","example":"123 Main Street","description":"The User's current street address, where they live."},"street2":{"type":"string","example":"Suite 1000","description":"The User's additional details of an address i.e. an apartment number."},"city":{"type":"string","example":"New York","description":"The User's current city, where they live."},"province":{"type":"string","example":"NY","description":"The User's current state/province/territory, where they live."},"postalCode":{"type":"string","example":10001,"description":"The User's current postal code (zip code)."},"country":{"type":"string","example":"USA","description":"The User's current country, where they live."}}}}},"Employment_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"EMPLOYMENT_INFO","enum":["EMPLOYMENT_INFO"],"x-enumDescriptions":{"EMPLOYMENT_INFO":"Employment status, employer, and industry details."}},"data":{"type":"object","properties":{"status":{"type":"string","example":"EMPLOYED","description":"The User's current employment status.","enum":["EMPLOYED","RETIRED","STUDENT","UNEMPLOYED","SELF_EMPLOYED"],"x-enumDescriptions":{"EMPLOYED":"Employed.","RETIRED":"Retired.","STUDENT":"Student.","UNEMPLOYED":"Unemployed.","SELF_EMPLOYED":"Self-employed."}},"company":{"type":"string","example":"DriveWealth LLC","description":"The User's current employer name.\n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED & type is not being provided*"},"companyID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"A unique identifier created for each Institution or entity on DriveWealth's platform.*"},"from":{"type":"string","example":"2014-09-29","description":"The User's start date at the employment."},"to":{"type":"string","example":"2022-12-25","description":"The User's end date at the employment."},"type":{"type":"string","example":"FINANCE","description":"The User's current employer type.\n\n *⚠️ Only required when status equal to EMPLOYED or SELF_EMPLOYED & company is not being provided*","enum":["AGRICULTURE","MINING","UTILITIES","CONSTRUCTION","MANUFACTURING","WHOLESALE","RETAIL","TRANSPORT","INFORMATION","FINANCE","REAL_ESTATE","PROFESSIONAL","MANAGEMENT","EDUCATION","HEALTH","ART","FOOD","PUBLIC","WASTE"],"x-enumDescriptions":{"AGRICULTURE":"Agriculture.","MINING":"Mining.","UTILITIES":"Utilities.","CONSTRUCTION":"Construction.","MANUFACTURING":"Manufacturing.","WHOLESALE":"Wholesale trade.","RETAIL":"Retail trade.","TRANSPORT":"Transportation.","INFORMATION":"Information and technology.","FINANCE":"Finance and insurance.","REAL_ESTATE":"Real estate.","PROFESSIONAL":"Professional, scientific, or technical services.","MANAGEMENT":"Management of companies.","EDUCATION":"Education.","HEALTH":"Health care and social assistance.","ART":"Arts, entertainment, and recreation.","FOOD":"Food service and accommodation.","PUBLIC":"Public administration.","WASTE":"Waste management and remediation."}},"position":{"type":"string","example":"ENGINEER","description":" The User's current role at the employment. *⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED & using Drivewealth's Market Data Offering*","enum":["ACCOUNTANT","ACTUARY","ADJUSTER","ADMINISTRATOR","ADVERTISER","AGENT","ATC","AMBASSADOR","ANALYST","APPRAISER","ARCHITECT","ARTIST","ASSISTANT","ATHLETE","ATTENDANT","ATTORNEY","AUCTIONEER","AUDITOR","BARBER","BROKER","BUSINESS_EXEC","BUSINESS_OWNER","CAREGIVER","CARPENTER","CASHIER","CHEF","CHIROPRACTOR","CIVIL","CLERGY","CLERK","COMPLIANCE","CONSULTANT","CONTRACTOR","COUNSELOR","CUSTOMER_SERVICE","DEALER","DEVELOPER","DISTRIBUTOR","DOCTOR","DRIVER","ENGINEER","EXAMINER","EXTERMINATOR","FACTORY","FARMER","FINANCIAL","FISHERMAN","FLIGHT","HR","IMPEX","INSPECTOR","INTERN","INVESTMENT","INVESTOR","IT","JANITOR","JEWELER","LABORER","LANDSCAPER","LENDING","MANAGER","MECHANIC","MILITARY","MORTICIAN","NURSE","NUTRITIONIST","OFFICE","PHARMACIST","PHYSICAL","PILOT","POLICE","POLITICIAN","PM","REP","RESEARCHER","SAILOR","SALES","SCIENTIST","SEAMSTRESS","SECURITY","SOCIAL","TEACHER","TECHNICIAN","TELLER","TRADESPERSON","TRAINER","TRANSPORTER","UNDERWRITER","WRITER"],"x-enumDescriptions":{"ACCOUNTANT":"Accountant/CPA/Bookkeeper/Controller.","ACTUARY":"Actuary.","ADJUSTER":"Adjuster.","ADMINISTRATOR":"Administrator.","ADVERTISER":"Advertiser/Marketer/PR Professional.","AGENT":"Agent.","ATC":"Air Traffic Controller.","AMBASSADOR":"Ambassador/Consulate Professional.","ANALYST":"Analyst.","APPRAISER":"Appraiser.","ARCHITECT":"Architect/Designer.","ARTIST":"Artist/Performer/Actor/Dancer.","ASSISTANT":"Assistant.","ATHLETE":"Athlete.","ATTENDANT":"Attendant.","ATTORNEY":"Attorney/Judge/Legal Professional.","AUCTIONEER":"Auctioneer.","AUDITOR":"Auditor.","BARBER":"Barber/Beautician/Hairstylist.","BROKER":"Broker.","BUSINESS_EXEC":"Business Executive (VP, Director, etc.).","BUSINESS_OWNER":"Business Owner.","CAREGIVER":"Caregiver.","CARPENTER":"Carpenter/Construction Worker.","CASHIER":"Cashier.","CHEF":"Chef/Cook.","CHIROPRACTOR":"Chiropractor.","CIVIL":"Civil Servant.","CLERGY":"Clergy.","CLERK":"Clerk.","COMPLIANCE":"Compliance/Regulatory Professional.","CONSULTANT":"Consultant.","CONTRACTOR":"Contractor.","COUNSELOR":"Counselor/Therapist.","CUSTOMER_SERVICE":"Customer Service Representative.","DEALER":"Dealer.","DEVELOPER":"Developer.","DISTRIBUTOR":"Distributor.","DOCTOR":"Doctor/Dentist/Veterinarian/Surgeon.","DRIVER":"Driver.","ENGINEER":"Engineer.","EXAMINER":"Examiner.","EXTERMINATOR":"Exterminator.","FACTORY":"Factory/Warehouse Worker.","FARMER":"Farmer/Rancher.","FINANCIAL":"Financial Planner.","FISHERMAN":"Fisherman.","FLIGHT":"Flight Attendant.","HR":"Human Resources Professional.","IMPEX":"Importer/Exporter.","INSPECTOR":"Inspector/Investigator.","INTERN":"Intern.","INVESTMENT":"Investment Advisor/Investment Manager.","INVESTOR":"Investor.","IT":"IT Professional/IT Associate.","JANITOR":"Janitor.","JEWELER":"Jeweler.","LABORER":"Laborer.","LANDSCAPER":"Landscaper.","LENDING":"Lending Professional.","MANAGER":"Manager.","MECHANIC":"Mechanic.","MILITARY":"Military, officer, or associated personnel.","MORTICIAN":"Mortician/Funeral Director.","NURSE":"Nurse.","NUTRITIONIST":"Nutritionist.","OFFICE":"Office Associate.","PHARMACIST":"Pharmacist.","PHYSICAL":"Physical Therapist.","PILOT":"Pilot.","POLICE":"Police Officer/Firefighter/Law Enforcement Professional.","POLITICIAN":"Politician.","PM":"Project Manager.","REP":"Registered Rep.","RESEARCHER":"Researcher.","SAILOR":"Sailor/Seaman.","SALES":"Salesperson.","SCIENTIST":"Scientist.","SEAMSTRESS":"Seamstress/Tailor.","SECURITY":"Security Guard.","SOCIAL":"Social Worker.","TEACHER":"Teacher/Professor.","TECHNICIAN":"Technician.","TELLER":"Teller.","TRADESPERSON":"Tradesperson/Craftsperson.","TRAINER":"Trainer/Instructor.","TRANSPORTER":"Transporter.","UNDERWRITER":"Underwriter.","WRITER":"Writer/Journalist/Editor."}},"broker":{"type":"boolean","example":true,"description":"True, if the User's current employer is broker.*⚠️ Only required when staus equal to EMPLOYED or SELF_EMPLOYED*"},"directorOf":{"type":"string","example":"Apple Inc, AAPL","description":"The company name, ticker of the company; if the user is a director or owns more than 10% of a publicly traded company.\n\n *⚠️ Can be set to 'NULL' if not applicable*"}}}}},"Investor_Profile_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"INVESTOR_PROFILE_INFO","enum":["INVESTOR_PROFILE_INFO"],"x-enumDescriptions":{"INVESTOR_PROFILE_INFO":"Investment objectives, risk tolerance, and experience."}},"data":{"type":"object","properties":{"investmentExperience":{"type":"string","example":"YRS_10_","description":"The User's current investment expertise.\n\n *⚠️ Can be defaulted to 'YRS_1_2' for all asset classes, except Options.*","enum":["NONE","YRS_1_LESS","YRS_1_2","YRS_3_5","YRS_5_10","YRS_10_"],"x-enumDescriptions":{"NONE":"None.","YRS_1_LESS":"Less than 1 year.","YRS_1_2":"1-2 years.","YRS_3_5":"3-5 years.","YRS_5_10":"5-10 years.","YRS_10_":"10+ years."}},"annualIncome":{"type":"number","example":1000000,"description":"The User's current annalized income over one year."},"networthTotal":{"type":"number","example":2500000,"description":"The user's current networth. This calculation is the User's assets - liabilities."},"riskTolerance":{"type":"string","example":"HIGH","description":"The User's risk ceiling.\n\n *⚠️ Can be defaulted to 'LOW' for all asset classes, except Options.*","enum":["LOW","MODERATE","HIGH","SPECULATION"],"x-enumDescriptions":{"LOW":"Low risk tolerance.","MODERATE":"Moderate risk tolerance.","HIGH":"High risk tolerance.","SPECULATION":"Speculative risk tolerance."}},"investmentObjectives":{"type":"string","example":"CAPITAL_PRESERVATION","description":"The User's current investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY.\n\n *⚠️ Can be defaulted to 'CAPITAL_PRESERVATION' for all asset classes, except Options.*","enum":["LONG_TERM","INFREQUENT","FREQUENT","ACTIVE_DAILY","NEW","CAPITAL_PRESERVATION","GROWTH","INCOME","SPECULATION"],"x-enumDescriptions":{"LONG_TERM":"Long-term buy and hold strategy. Deprecated — replaced by CAPITAL_PRESERVATION and/or GROWTH.","INFREQUENT":"Infrequent trading activity. Deprecated — replaced by CAPITAL_PRESERVATION and/or INCOME.","FREQUENT":"Frequent trading activity. Deprecated — replaced by GROWTH and/or INCOME.","ACTIVE_DAILY":"Active daily trading. Deprecated — replaced by GROWTH and/or SPECULATION.","NEW":"New to trading with no prior experience.","CAPITAL_PRESERVATION":"Capital preservation.","GROWTH":"Growth.","INCOME":"Income.","SPECULATION":"Speculation."}},"secondaryInvestmentObjectives":{"type":"array","description":"The User's secondary investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY.","items":{"type":"string","example":"INCOME","enum":["LONG_TERM","INFREQUENT","FREQUENT","ACTIVE_DAILY","NEW","CAPITAL_PRESERVATION","GROWTH","INCOME","SPECULATION"],"x-enumDescriptions":{"LONG_TERM":"Long-term buy and hold strategy. Deprecated — replaced by CAPITAL_PRESERVATION and/or GROWTH.","INFREQUENT":"Infrequent trading activity. Deprecated — replaced by CAPITAL_PRESERVATION and/or INCOME.","FREQUENT":"Frequent trading activity. Deprecated — replaced by GROWTH and/or INCOME.","ACTIVE_DAILY":"Active daily trading. Deprecated — replaced by GROWTH and/or SPECULATION.","NEW":"New to trading with no prior experience.","CAPITAL_PRESERVATION":"Capital preservation.","GROWTH":"Growth.","INCOME":"Income.","SPECULATION":"Speculation."}}},"networthLiquid":{"type":"number","example":300000,"description":"The user's liquid net worth. The amount of cash or near cash equivalents of the User's net worth.\n\n *⚠️ Can be defaulted to '-1' for all asset classes, except Options.*"},"dependents":{"type":"number","example":"4","description":"Total number of dependents the account holder has.\n\n *⚠️ Required for Options Onboarding.*"},"suitabilityEquities":{"$ref":"#/components/schemas/investmentSuitability","description":"An object containing required fields for options approval"},"suitabilityOptions":{"$ref":"#/components/schemas/investmentSuitability","description":"An object containing required fields for options approval"},"equitiesExperience":{"$ref":"#/components/schemas/investmentSuitabilityEquities","description":"An object containing fields that evaluate the User's experience and suitability for equities trading.\n\n *⚠️ Required for Options Onboarding.*"},"optionsExperience":{"$ref":"#/components/schemas/investmentSuitabilityOptions","description":"An object containing fields that evaluate the User's experience and suitability for options trading.\n\n *⚠️ Required for Options Onboarding.*"},"fixedIncomeExperience":{"$ref":"#/components/schemas/investmentSuitabilityDeclineToAnswer","description":"An object containing fields that evaluate the User's experience and suitability for fixed income trading."},"commodityExperience":{"$ref":"#/components/schemas/investmentSuitabilityDeclineToAnswer","description":"An object containing fields that evaluate the User's experience and suitability for commodity trading."},"otherFinancialExperience":{"$ref":"#/components/schemas/investmentSuitabilityDeclineToAnswer","description":"An object containing fields that evaluate the User's experience and suitability for other financial instruments trading."}}}}},"Compliance_AML_Info_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","description":"The type of data object.","example":"COMPLIANCE_AML_INFO","enum":["COMPLIANCE_AML_INFO"],"x-enumDescriptions":{"COMPLIANCE_AML_INFO":"Funding sources and expected transfer activity for AML compliance."}},"data":{"type":"object","properties":{"fundingSources":{"type":"array","description":"A list of the User's funding sources.","items":{"type":"string","enum":["EMP","GIFT","TRUST","INVESTMENT","SAVINGS","RETIRE","GAMBLING","LEGAL","FAMILY","UNEMP","ROLLOVER","RENT","SALE","INSURANCE"],"x-enumDescriptions":{"EMP":"Employment income.","GIFT":"Gift.","TRUST":"Trust.","INVESTMENT":"Investment income.","SAVINGS":"Savings.","RETIRE":"Retirement income.","GAMBLING":"Gambling winnings.","LEGAL":"Legal settlement.","FAMILY":"Family support.","UNEMP":"Unemployment benefits.","ROLLOVER":"Retirement rollover.","RENT":"Rental income.","SALE":"Sale of assets.","INSURANCE":"Insurance proceeds."}},"example":["EMP","SAVINGS"]},"transferFrequencyPerMonth":{"type":"integer","description":"The expected number of transfers per month.","example":7},"transferTotalExpected":{"type":"number","writeOnly":true,"description":"The expected total transfer amount. Only accepted on write; DriveWealth maps it to `transferTotalExpectedRange` for the response.","example":45350},"transferTotalExpectedRange":{"type":"string","readOnly":true,"description":"A range mapping for the expected total transfer amount, computed by DriveWealth.","enum":["$0_9999","$10K_49999","$50K_99999","$100K_249999","$250K_499999","$500K_"],"example":"$10K_49999","x-enumDescriptions":{"$0_9999":"$0 - $9,999.","$10K_49999":"$10,000 - $49,999.","$50K_99999":"$50,000 - $99,999.","$100K_249999":"$100,000 - $249,999.","$250K_499999":"$250,000 - $499,999.","$500K_":"$500,000+."}},"investmentHistory12M":{"type":"integer","description":"The number of investment transactions in the last 12 months.","example":12}}}}},"Disclosures_Optional":{"type":"object","required":["type","data"],"properties":{"type":{"type":"string","example":"DISCLOSURES","enum":["DISCLOSURES"],"x-enumDescriptions":{"DISCLOSURES":"Acceptance of standard DriveWealth agreements."}},"data":{"type":"object","properties":{"extendedHoursAgreement":{"type":"boolean","example":false,"description":"The User accepts DriveWealth's Extended Hours Agreement."},"termsOfUse":{"type":"boolean","example":true,"description":"The User accepts DriveWealth's Terms of Use."},"customerAgreement":{"type":"boolean","example":true,"description":"The User accepts DriveWealth's Customer Agreement.\n\n*⚠ Only for opening regular brokerage accounts.*"},"iraAgreement":{"type":"boolean","example":false,"description":"The User accepts DriveWealth's Individual Retirement Account (IRA) Agreement.\n\n*⚠ Only for opening IRA accounts.*"},"marginAgreement":{"type":"boolean","example":false,"description":"The User accepts DriveWealth's Margin Agreement.\n\n*⚠ Only for opening Margin (leveraged) accounts.*"},"cryptoAgreements":{"type":"boolean","example":false,"description":"The User accepts DriveWealth's Digital Assets Agreement.\n\n*⚠ Only for opening Digital Assets accounts.*"},"marketDataAgreement":{"type":"boolean","example":true,"description":"The User accepts DriveWealth's Market Data Agreement."},"optionsAgreement":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Options trading Agreement."},"oddLinkAgreement":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's ODD Link Agreement."},"rule14b":{"type":"boolean","example":true,"description":"The User accepts DriveWealth's Rule 14b1(c)."},"privacyPolicy":{"type":"boolean","example":true,"description":"The User accepts DriveWealth's Privacy Policy."},"dataSharing":{"type":"boolean","example":true,"description":"The User accepts DriveWealth's Data Sharing Policy."},"signedBy":{"type":"string","example":"John Doe","description":"The User's digital signature (full name)."}}}}},"UserResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/userID"},"userType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/userType"},"description":{"type":"string","example":"Individual Trader","description":"A custom description of the User type."}}},"status":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/userStatus"},"description":{"type":"string","example":"User is pending approval.","description":"A custom description of the User's status."}}},"parentIBID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/parentIBID"},"name":{"$ref":"#/components/schemas/firmName"}}},"documents":{"type":"array","description":"The personal identifiable information & digital signatures.","items":{"$ref":"#/components/schemas/Document_Item"}},"wlpID":{"$ref":"#/components/schemas/wlpID"},"walletSettlementProfileID":{"$ref":"#/components/schemas/walletSettlementProfileID"},"referralCode":{"type":"string","example":"71J000","description":"The associated referral program associated to the User."},"createdWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The createdWhen is the date and time the User was created."},"updatedWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The updatedWhen is the last date and time the User was updated."}}},"UserObject":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/userID"},"ackSignedWhen":{"type":"string","example":"2022-12-11T22:28:21.666Z","description":"The date and time the User signed the digital documents."},"addressLine1":{"$ref":"#/components/schemas/userStreet1"},"addressLine2":{"$ref":"#/components/schemas/userStreet2"},"city":{"$ref":"#/components/schemas/userCity"},"countryID":{"$ref":"#/components/schemas/userCountry"},"displayName":{"type":"string","example":"JDoe","description":"The User's display name. *By default this is firstName inital followed by last name.*"},"dob":{"type":"string","example":"2000-12-3","description":"The User's date of birth in this format YYYY-MM-DD"},"dateOfDeath":{"type":"string","example":"2025-12-04","description":"The User's date of death in YYYY-MM-DD format."},"email":{"$ref":"#/components/schemas/email"},"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"parentIB":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/parentIBID"},"name":{"$ref":"#/components/schemas/firmName"}}},"phone":{"$ref":"#/components/schemas/phoneNumber"},"referralCode":{"type":"string","example":"71J000","description":"The assiocated referral program assiocated to the User."},"stateProvince":{"$ref":"#/components/schemas/userProvince"},"wlpID":{"$ref":"#/components/schemas/wlpID"},"walletSettlementProfileID":{"$ref":"#/components/schemas/walletSettlementProfileID"},"zipPostalCode":{"type":"string","example":10001,"description":"The User's current postal code (zip code)."},"idNo":{"$ref":"#/components/schemas/userTaxIDLastFour"},"idIssuingCountry":{"$ref":"#/components/schemas/userCountry","description":"The country where the identification was issued."},"idIssuingProvince":{"$ref":"#/components/schemas/userProvince","description":"The state or province where the identification was issued."},"idIssueDate":{"$ref":"#/components/schemas/date","description":"The date when the identification was issued in YYYY-MM-DD format.."},"idExpiryDate":{"$ref":"#/components/schemas/date","description":"The date when the identification expires in YYYY-MM-DD format.."},"institutionalDirectorInfo":{"type":"object","description":"A map of institutional director information, where keys are director IDs (strings) and values are director details.","additionalProperties":{"$ref":"#/components/schemas/directors"},"example":{"123e4567-e89b-12d3-a456-00000000015f":{"title":"Chief Innovation Officer","controlContact":false,"institutionalID":"123e4567-e89b-12d3-a456-00000000015f","percentage":0.5,"roles":["TRUSTEE","GRANTOR","BENEFICIARY"]}}},"status":{"type":"object","properties":{"name":{"type":"string","example":"PENDING","description":"The user's current know your User (KYC) status.","enum":["PENDING","APPROVED"],"x-enumDescriptions":{"PENDING":"The user is pending approval.","APPROVED":"The user has been approved."}},"description":{"type":"string","example":"User is pending approval.","description":"A custom description of the User's status."}}},"userType":{"type":"object","properties":{"name":{"type":"string","example":"INDIVIDUAL_TRADER","description":"The name that describes the type of User.","enum":["INDIVIDUAL_TRADER","CUSTODIAL"],"x-enumDescriptions":{"INDIVIDUAL_TRADER":"An individual retail trader.","CUSTODIAL":"A custodian onboarding an account on behalf of a minor."}},"description":{"type":"string","example":"Individual Trader","description":"A custom description of the User type."}}},"usCitizen":{"type":"boolean","example":true,"description":"True, if a the User is a United States Citizen"},"updatedWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The updatedWhen is the last date and time the User was updated."},"brandAmbassador":{"type":"boolean","example":false},"employerBusiness":{"type":"string","example":"FINANCE","description":"The User's current employer type."},"employmentStatus":{"type":"object","properties":{"name":{"type":"string","example":"EMPLOYED","description":"The User's current employment status."},"description":{"type":"string","example":"Employed","description":"A description of the employment status."}}},"citizenship":{"$ref":"#/components/schemas/userCountry"},"createdWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The createdWhen is the date and time the User was created."},"marginDefault":{"type":"number","example":0},"maritalStatus":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/userMaritalStatus"},"description":{"type":"string","example":"Single","description":"A description of the marital status of the User."}}},"ackCustomerAgreement":{"type":"boolean","example":true,"description":"True, if the User accepted DriveWealth's Customer Agreement."},"ackFindersFee":{"type":"boolean","example":false,"description":"True, if the User accepted DriveWealth's Finders Fee Agreement."},"ackForeignFindersFee":{"type":"boolean","example":false,"description":"True, if the User accepted DriveWealth's Foreign Finders Fee Agreement."},"ackJointCustomerAgreement":{"type":"boolean","example":true,"description":"True, if the User accepted DriveWealth's Customer Agreement."},"ackJointFindersFee":{"type":"boolean","example":false,"description":"True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner."},"ackJointForeignFindersFee":{"type":"boolean","example":false,"description":"True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner."},"ackJointMarketData":{"type":"boolean","example":false,"description":"True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner."},"ackMarketData":{"type":"boolean","example":false,"description":"True, if the User has accepted DriveWealth's Market Data Agreement."},"ackExtendedHoursAgreement":{"type":"boolean","example":false,"description":"True, if the User has accepted DriveWealth's Extended Hours Agreement."},"ackOptionsAgreement":{"type":"boolean","example":true,"description":"True, if the User accepts DriveWealth's Options trading Agreement."},"dependents":{"type":"number","example":0,"description":"The amount of children or dependents assiocated with the User."},"termsOfUse":{"type":"boolean","example":true,"description":"True, if the User has accepted DriveWealth's Terms of Use Agreement."},"badPasswordCount":{"type":"boolean","example":0},"director":{"type":"boolean","example":false,"description":"True, if the User is a director at a public traded company or owns 10% or more of a public company."},"employerCompany":{"type":"string","example":"DriveWealth LLC","description":"The name of the User's employer."},"employerCompanyID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"A unique identifier created for each Institution or entity on DriveWealth's platform.*"},"employerCompanyStartDate":{"type":"string","example":"2014-09-29","description":"The User's start date at the employment."},"employerCompanyEndDate":{"type":"string","example":"2022-12-25","description":"The User's end date at the employment."},"employerIsBroker":{"type":"boolean","example":true,"description":"True, if the User's employer is a brokerage firm."},"employmentPosition":{"type":"string","example":"ENGINEER","description":"The User's current employment job type."},"employmentYears":{"type":"number","example":0,"description":"The amount of years the User has been employed with the employer."},"jointEmployerIsBroker":{"type":"boolean","example":false},"investmentObjectives":{"type":"object","properties":{"name":{"type":"string","example":"CAPITAL_PRESERVATION","description":"The User's current investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY."},"description":{"type":"string","example":"Capital Preservation","description":"A custom description of the investment objective."}}},"investmentExperience":{"type":"object","properties":{"name":{"type":"string","example":"YRS_10_","description":"The User's current investment expertise."},"description":{"type":"string","example":"10+ yrs","description":"A custom description of investment expertise."}}},"politicallyExposed":{"type":"boolean","example":false,"description":"True, if the User is politically exposed to another person.\n\n *⚠️ Can be set to 'NULL' if not politically exposed"},"riskTolerance":{"type":"string","example":"HIGH","description":"The User's risk ceiling.","enum":["LOW","MODERATE","SPECULATION","HIGH"],"x-enumDescriptions":{"LOW":"Low risk tolerance.","MODERATE":"Moderate risk tolerance.","SPECULATION":"Speculative risk tolerance.","HIGH":"High risk tolerance."}},"userNoteQty":{"type":"number","example":0,"description":"Total number of notes on the user."},"validTaxForm":{"type":"boolean","example":true,"description":"True, if the user has verified/updated tax information."},"w8received":{"type":"string","example":"2026-02-06","description":"The date W8 is received"},"w8expires":{"type":"string","example":"2029-12-31","description":"The date W8 expires"},"validTaxFormWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The validTaxForm is the date and time the validTaxForm was changed."},"taxTreatyWithUS":{"type":"boolean","example":true,"description":"True, if the user lives in a treaty country and is claiming tax treaty with the United States."},"taxCountry":{"type":"string","example":"AUS","description":"Tax residence country code (ISO 3166-1 alpha-3) on Tax Treaty Benefits with the United States."},"taxAttestation":{"type":"object","properties":{"signedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000015e","description":"The user ID of the person who signed the attestation."},"signedWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when attestation was signed."}}},"avatarURL":{"type":"string","example":"https://secure.gravatar.com/avatar/00000000000000000000000000000000.jpg","description":"The User's avatar."},"annualIncomeRange":{"type":"string","example":"$0 - $24,999","description":"The User's annual income range, in dollar form.","enum":["Unknown","$0 - $24,999","$25,000 - $49,999","$50,000 - $99,999","$100,000 - $199,999","$200,000 - $499,999","$500,000 - $999,999","$1,000,000 - $4,999,999","$5,000,000 - $9,999,999","$10,000,000+"],"x-enumDescriptions":{"Unknown":"Income range not provided.","$0 - $24,999":"$0 to $24,999.","$25,000 - $49,999":"$25,000 to $49,999.","$50,000 - $99,999":"$50,000 to $99,999.","$100,000 - $199,999":"$100,000 to $199,999.","$200,000 - $499,999":"$200,000 to $499,999.","$500,000 - $999,999":"$500,000 to $999,999.","$1,000,000 - $4,999,999":"$1,000,000 to $4,999,999.","$5,000,000 - $9,999,999":"$5,000,000 to $9,999,999.","$10,000,000+":"$10,000,000 or more."}},"ackDisclosureRule14b":{"type":"boolean","example":true,"description":"True, if the User has accepted DriveWealth's Rule 14b Agreement."},"ackJointDisclosureRule14b":{"type":"boolean","example":false,"description":"True, if the User has accepted a Joint Rule 14b Agreement with DriveWealth & the parnter."},"networthLiquidRange":{"type":"string","example":"$0 - $24,999","description":"The user's liquid net worth range. The amount of cash or near cash equivalents of the User's net worth.","enum":["Unknown","$0 - $4,999","$5,000 - $24,999","$25,000 - $49,999","$50,000 - $99,999","$100,000 - $199,999","$200,000 - $499,999","$500,000 - $999,999","$1,000,000 - $4,999,999","$5,000,000 - $9,999,999","$10,000,000+"],"x-enumDescriptions":{"Unknown":"Net worth range not provided.","$0 - $4,999":"$0 to $4,999.","$5,000 - $24,999":"$5,000 to $24,999.","$25,000 - $49,999":"$25,000 to $49,999.","$50,000 - $99,999":"$50,000 to $99,999.","$100,000 - $199,999":"$100,000 to $199,999.","$200,000 - $499,999":"$200,000 to $499,999.","$500,000 - $999,999":"$500,000 to $999,999.","$1,000,000 - $4,999,999":"$1,000,000 to $4,999,999.","$5,000,000 - $9,999,999":"$5,000,000 to $9,999,999.","$10,000,000+":"$10,000,000 or more."}},"networthTotalRange":{"type":"string","example":"$0 - $24,999","description":"The User's net total net worth range.","enum":["Unknown","$0 - $4,999","$5,000 - $24,999","$25,000 - $49,999","$50,000 - $99,999","$100,000 - $199,999","$200,000 - $499,999","$500,000 - $999,999","$1,000,000 - $4,999,999","$5,000,000 - $9,999,999","$10,000,000+"],"x-enumDescriptions":{"Unknown":"Net worth range not provided.","$0 - $4,999":"$0 to $4,999.","$5,000 - $24,999":"$5,000 to $24,999.","$25,000 - $49,999":"$25,000 to $49,999.","$50,000 - $99,999":"$50,000 to $99,999.","$100,000 - $199,999":"$100,000 to $199,999.","$200,000 - $499,999":"$200,000 to $499,999.","$500,000 - $999,999":"$500,000 to $999,999.","$1,000,000 - $4,999,999":"$1,000,000 to $4,999,999.","$5,000,000 - $9,999,999":"$5,000,000 to $9,999,999.","$10,000,000+":"$10,000,000 or more."}},"investmentEquitiesExperience":{"type":"string","example":"LIMITED","description":"Trading experience level.","enum":["LIMITED","NONE","GOOD","EXCELLENT"],"x-enumDescriptions":{"LIMITED":"Limited trading knowledge or experience.","NONE":"No trading knowledge or experience.","GOOD":"Good trading knowledge and experience.","EXCELLENT":"Excellent trading knowledge and extensive experience."}},"investmentEquitiesYears":{"type":"string","example":"YRS_10_PLUS","description":"Number of years equity trading experience.","enum":["YRS_1_LESS","YRS_1_2","YRS_3_5","YRS_6_9","YRS_10_PLUS"],"x-enumDescriptions":{"YRS_1_LESS":"Less than 1 year.","YRS_1_2":"1 to 2 years.","YRS_3_5":"3 to 5 years.","YRS_6_9":"6 to 9 years.","YRS_10_PLUS":"10 or more years."}},"investmentEquitiesTradesPerYear":{"type":"string","example":"YRS_10_14","description":"Total number of trades per year.","enum":["YRS_0_9","YRS_10_14","YRS_15_24","YRS_25_74","YRS_75_PLUS"],"x-enumDescriptions":{"YRS_0_9":"0 to 9 trades per year.","YRS_10_14":"10 to 14 trades per year.","YRS_15_24":"15 to 24 trades per year.","YRS_25_74":"25 to 74 trades per year.","YRS_75_PLUS":"75 or more trades per year."}},"investmentEquitiesAverageTradeSize":{"type":"string","example":"AVG_0_9999","description":"Average per trade size","enum":["AVG_0_9999","AVG_10000_24999","AVG_25000_PLUS"],"x-enumDescriptions":{"AVG_0_9999":"$0 to $9,999.","AVG_10000_24999":"$10,000 to $24,999.","AVG_25000_PLUS":"$25,000 or more."}},"investmentOptionsExperience":{"type":"string","example":"LIMITED","description":"Trading experience level.","enum":["LIMITED","NONE","GOOD","EXCELLENT"],"x-enumDescriptions":{"LIMITED":"Limited trading knowledge or experience.","NONE":"No trading knowledge or experience.","GOOD":"Good trading knowledge and experience.","EXCELLENT":"Excellent trading knowledge and extensive experience."}},"investmentOptionsYears":{"type":"string","example":"YRS_10_PLUS","description":"Number of years equity trading experience.","enum":["YRS_1_LESS","YRS_1_2","YRS_3_5","YRS_6_9","YRS_10_PLUS"],"x-enumDescriptions":{"YRS_1_LESS":"Less than 1 year.","YRS_1_2":"1 to 2 years.","YRS_3_5":"3 to 5 years.","YRS_6_9":"6 to 9 years.","YRS_10_PLUS":"10 or more years."}},"investmentOptionsTradesPerYear":{"type":"string","example":"YRS_10_14","description":"Total number of trades per year.","enum":["YRS_0_9","YRS_10_14","YRS_15_24","YRS_25_74","YRS_75_PLUS"],"x-enumDescriptions":{"YRS_0_9":"0 to 9 trades per year.","YRS_10_14":"10 to 14 trades per year.","YRS_15_24":"15 to 24 trades per year.","YRS_25_74":"25 to 74 trades per year.","YRS_75_PLUS":"75 or more trades per year."}},"investmentOptionsAverageTradeSize":{"type":"string","example":"AVG_0_9999","description":"A unique identifier for the Deposit.","enum":["AVG_0_9999","AVG_10000_24999","AVG_25000_PLUS"],"x-enumDescriptions":{"AVG_0_9999":"$0 to $9,999.","AVG_10000_24999":"$10,000 to $24,999.","AVG_25000_PLUS":"$25,000 or more."}},"investmentEquitiesKnowledge":{"type":"string","example":"LIMITED","description":"Self assessed knowledge level of equity trading.","enum":["LIMITED","NONE","GOOD","EXCELLENT"],"x-enumDescriptions":{"LIMITED":"Limited trading knowledge or experience.","NONE":"No trading knowledge or experience.","GOOD":"Good trading knowledge and experience.","EXCELLENT":"Excellent trading knowledge and extensive experience."}},"investmentOptionsKnowledge":{"type":"string","example":"LIMITED","description":"Self assessed knowledge level of options trading.","enum":["LIMITED","NONE","GOOD","EXCELLENT"],"x-enumDescriptions":{"LIMITED":"Limited trading knowledge or experience.","NONE":"No trading knowledge or experience.","GOOD":"Good trading knowledge and experience.","EXCELLENT":"Excellent trading knowledge and extensive experience."}},"investmentEquitiesYearsOfExperience":{"type":"number","example":3,"description":"Number of years of experience trading equities."},"investmentEquitiesTradesPerYearV2":{"type":"number","example":15,"description":"Number of equity trades per year."},"investmentEquitiesAverageTransactionAmount":{"type":"number","example":5000,"description":"Average transaction amount of equity trades."},"investmentEquitiesTransactionTypes":{"type":"array","description":"Types of equity transactions the user has experience with.","items":{"type":"string","example":"LONG","enum":["LONG","SHORT","MARGIN"],"x-enumDescriptions":{"LONG":"Long equity positions.","SHORT":"Short equity positions.","MARGIN":"Margin trading positions."}}},"investmentOptionsYearsOfExperience":{"type":"number","example":2,"description":"Number of years of experience trading options."},"investmentOptionsTradesPerYearV2":{"type":"number","example":10,"description":"Number of options trades per year."},"investmentOptionsAverageTransactionAmount":{"type":"number","example":3000,"description":"Average transaction amount of options trades."},"investmentOptionsTransactionTypes":{"type":"array","description":"Types of options transactions the user has experience with.","items":{"type":"string","example":"LONG","enum":["COVERED","LONG","SPREADS","NAKED_PUTS","NAKED_CALLS"],"x-enumDescriptions":{"COVERED":"Covered options strategies, such as covered calls.","LONG":"Long options strategies, such as buying calls or puts.","SPREADS":"Spread options strategies, such as vertical or calendar spreads.","NAKED_PUTS":"Naked (uncovered) put writing.","NAKED_CALLS":"Naked (uncovered) call writing."}}},"investmentFixedIncomeDeclinedToAnswer":{"type":"boolean","example":false,"description":"True, if the user declined to answer questions regarding fixed income trading."},"investmentCommodityDeclinedToAnswer":{"type":"boolean","example":false,"description":"True, if the user declined to answer questions regarding commodity trading."},"investmentOtherFinancialDeclinedToAnswer":{"type":"boolean","example":false,"description":"True, if the user declined to answer questions regarding other financial trading."},"secondaryInvestmentObjectives":{"type":"array","description":"The User's secondary investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY.","items":{"type":"string","example":"INCOME","enum":["LONG_TERM","INFREQUENT","FREQUENT","ACTIVE_DAILY","NEW","CAPITAL_PRESERVATION","GROWTH","INCOME","SPECULATION"],"x-enumDescriptions":{"LONG_TERM":"Long-term buy and hold strategy. Deprecated — replaced by CAPITAL_PRESERVATION and/or GROWTH.","INFREQUENT":"Infrequent trading activity. Deprecated — replaced by CAPITAL_PRESERVATION and/or INCOME.","FREQUENT":"Frequent trading activity. Deprecated — replaced by GROWTH and/or INCOME.","ACTIVE_DAILY":"Active daily trading. Deprecated — replaced by GROWTH and/or SPECULATION.","NEW":"New to trading with no prior experience.","CAPITAL_PRESERVATION":"Capital preservation.","GROWTH":"Growth.","INCOME":"Income.","SPECULATION":"Speculation."}}}}},"Documents_Patch":{"type":"object","properties":{"documents":{"type":"array","description":"The personal identifiable information & digital signatures that will be updated.","items":{"discriminator":{"propertyName":"type","mapping":{"BASIC_INFO":"#/components/schemas/Basic_Info_Optional","IDENTIFICATION_INFO":"#/components/schemas/Identification_Info_Optional","TAX_INFO":"#/components/schemas/Tax_Info_Patch","PERSONAL_INFO":"#/components/schemas/Personal_Info_Optional","ADDRESS_INFO":"#/components/schemas/Address_Info_Optional","EMPLOYMENT_INFO":"#/components/schemas/Employment_Info_Optional","DIRECTOR_INFO":"#/components/schemas/Director_Info_Optional","INVESTOR_PROFILE_INFO":"#/components/schemas/Investor_Profile_Info_Optional","COMPLIANCE_AML_INFO":"#/components/schemas/Compliance_AML_Info_Optional","DISCLOSURES":"#/components/schemas/Disclosures_Optional","KYC_VERIFICATION_INFO":"#/components/schemas/KYC_Verification_Info_Optional","MARGIN_DISCLOSURE":"#/components/schemas/Margin_Disclosure_Optional","FPSL_DISCLOSURE":"#/components/schemas/FPSL_Disclosure_Optional","CUSTODIAN_INFO":"#/components/schemas/Custodian_Info_Optional","INSTITUTIONAL_INFO":"#/components/schemas/Institutional_Info_Optional","TRUST_INFO":"#/components/schemas/Trust_Info_Optional"}},"oneOf":[{"$ref":"#/components/schemas/Basic_Info_Optional"},{"$ref":"#/components/schemas/Identification_Info_Optional"},{"$ref":"#/components/schemas/Tax_Info_Patch"},{"$ref":"#/components/schemas/Personal_Info_Optional"},{"$ref":"#/components/schemas/Address_Info_Optional"},{"$ref":"#/components/schemas/Employment_Info_Optional"},{"$ref":"#/components/schemas/Director_Info_Optional"},{"$ref":"#/components/schemas/Investor_Profile_Info_Optional"},{"$ref":"#/components/schemas/Compliance_AML_Info_Optional"},{"$ref":"#/components/schemas/Disclosures_Optional"},{"$ref":"#/components/schemas/KYC_Verification_Info_Optional"},{"$ref":"#/components/schemas/Margin_Disclosure_Optional"},{"$ref":"#/components/schemas/FPSL_Disclosure_Optional"},{"$ref":"#/components/schemas/Custodian_Info_Optional"},{"$ref":"#/components/schemas/Institutional_Info_Optional"},{"$ref":"#/components/schemas/Trust_Info_Optional"}]}}}},"FetchUserKYCResponse":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"identity":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/userTaxIDLastFour"},"dob":{"type":"string","example":"2000-12-03","description":"The User's date of birth in this format YYYY-MM-DD"}}},"accounts":{"type":"array","description":"A list of all the User's accounts.","items":{"oneOf":[{"$ref":"#/components/schemas/AccountsRequest"}]}},"kyc":{"type":"object","properties":{"status":{"type":"object","properties":{"name":{"type":"string","example":"KYC_INFO_REQUIRED","description":"The current kyc status of the User.","enum":["KYC_NOT_READY","KYC_READY","KYC_PROCESSING","KYC_APPROVED","KYC_INFO_REQUIRED","KYC_DOC_REQUIRED","KYC_MANUAL_REVIEW","KYC_DENIED"],"x-enumDescriptions":{"KYC_NOT_READY":"KYC is not ready to be processed.","KYC_READY":"KYC is ready to be processed.","KYC_PROCESSING":"KYC is being processed.","KYC_APPROVED":"KYC was approved.","KYC_INFO_REQUIRED":"Additional information is required to complete KYC.","KYC_DOC_REQUIRED":"Additional documentation is required to complete KYC.","KYC_MANUAL_REVIEW":"KYC requires manual review.","KYC_DENIED":"KYC was denied."}},"code":{"type":"string","example":"K102"},"description":{"type":"string","example":"User's PII not matched. Please revisit user's PII Info.","description":"A custom description about the User's KYC status."}}},"approved":{"type":"object","properties":{"timestamp":{"type":"string","example":"2022-12-12T21:13:12.391Z","description":"The date and time the User's KYC was approved."},"approvedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000160","description":"The identifier of the backoffice user that approved the User's KYC."}}},"accepted":{"type":"object","properties":{"acceptedBy":{"type":"string","example":"SYSTEM PRINCIPAL APPROVER","description":"The name of the role who approved the User's kyc."},"timeStamp":{"type":"string","example":"2022-12-12T21:13:12.391Z","description":"The date and time the role who approved the User's kyc."}}}}},"status":{"type":"object","properties":{"name":{"type":"string","example":"APPROVED","description":"The User's current status.","enum":["PENDING","APPROVED"],"x-enumDescriptions":{"PENDING":"The user is pending approval.","APPROVED":"The user has been approved."}},"description":{"type":"string","example":"User approved.","description":"A custom description of the User's status."}}},"partnerID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/parentIBID"},"name":{"$ref":"#/components/schemas/firmName"}}},"documents":{"type":"array","example":[],"description":"Please call the user's endpoint to get the User's documents."}}},"AccountsRequest":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000005c.1234567890143","description":"The User's unqiue account identifier."},"accountNo":{"type":"string","example":"FFFF000005","description":"The User's unqiue account number, that is human readable."},"nickname":{"type":"string","example":"John's Self Directed Account"},"accountStatus":{"type":"object","properties":{"name":{"type":"string","example":"PENDING","description":"The status of the User's account."},"description":{"type":"string","example":"Pending","description":"A custom description about status of the User's account."}}},"accountType":{"type":"string","example":"LIVE","description":"The type of account that has been created."},"accountManagementType":{"type":"string","example":"SELF","description":"The type of account who has trading authority.","enum":["SELF","ADVISORY","RIA_MANAGED","CUSTODIAL","CUSTODIAL_MANAGED","RESERVE","HSA_SELF","HSA_ADVISORY","HSA_RIA_MANAGED","BUSINESS_SELF","BUSINESS_ADVISORY","BUSINESS_RIA_MANAGED"],"x-enumDescriptions":{"SELF":"A user directs trades in their own account without advice.","ADVISORY":"An Investment Advisor or Investment Advisor Representative has access to the account, but trades are placed only with the user's authorization.","RIA_MANAGED":"An Investment Advisor has discretion to place trades in the account.","CUSTODIAL":"An account held for the benefit of a minor.","CUSTODIAL_MANAGED":"A custodial account with discretionary trading managed by an advisor.","RESERVED":"Reserved for future use; not currently assigned.","HSA_SELF":"A self-directed Health Savings Account.","HSA_ADVISORY":"A Health Savings Account accessible to an advisor, with trades placed only by the user's authorization.","HSA_RIA_MANAGED":"A Health Savings Account with discretionary trading managed by an advisor.","BUSINESS_SELF":"A self-directed Business account.","BUSINESS_ADVISORY":"A Business account accessible to an advisor, with trades placed only by the user's authorization.","BUSINESS_RIA_MANAGED":"A Business account with discretionary trading managed by an advisor."}},"tradingType":{"type":"string","example":"CASH","description":"The type of trading ocurring in the account.","enum":["CASH","MARGIN","CRYPTO"],"x-enumDescriptions":{"CASH":"A cash account; trades settle using available cash only.","MARGIN":"A margin account; trades may be placed using borrowed funds.","CRYPTO":"A crypto account."}},"leverage":{"type":"number","example":1,"description":"The leverage that is applied to the User's account."}}},"Allocation":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/allocationID"},"clientListID":{"$ref":"#/components/schemas/note"},"status":{"$ref":"#/components/schemas/allocationStatus"},"allocationsRequested":{"$ref":"#/components/schemas/allocationsRequested"},"allocationsCompleted":{"$ref":"#/components/schemas/allocationsCompleted"},"unallocatedNotional":{"$ref":"#/components/schemas/unallocatedNotional"},"unallocatedQuantity":{"$ref":"#/components/schemas/unallocatedQuantity"},"comment":{"type":"string","example":"All allocated and accounted for. 1::1::0 client note[empty], . timeMs=667 ratePerSec=1.50 msPerItem=667.00","description":"A custom comment generated by DriveWealth."},"createdWhen":{"type":"string","example":"2022-12-22T16:04:46.724Z","description":"The date and time of the allocation creation."}}},"Allocations":{"type":"array","description":"A list of a User's sub account allocations.","items":{"oneOf":[{"$ref":"#/components/schemas/Allocation"}]}},"OrdersAllocationSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/allocationID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"date":{"type":"string","example":"2022-12-25","description":"The specific date requested in the inbound API request."},"orders":{"type":"array","description":"A list of order and allocations.","items":{"oneOf":[{"$ref":"#/components/schemas/OrdersAllocationsSummary"}]}}}},"ListOrdersAllocationsByUserID.Orders":{"type":"object","properties":{"riaID":{"$ref":"#/components/schemas/userID"},"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"orderType":{"$ref":"#/components/schemas/orderTypes"},"createdWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The createdWhen is the date and time the order was created."},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"orderQty":{"$ref":"#/components/schemas/orderQuantity"},"cumQty":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"avgPx":{"$ref":"#/components/schemas/orderAveragePrice"},"allocations":{"type":"array","description":"A list of a User's sub account allocations.","items":{"oneOf":[{"$ref":"#/components/schemas/ListOrdersAllocationsByUserID.Orders.Allocation"}]}}}},"ListOrdersAllocationsByUserID.Orders.Allocation":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/allocationID"},"status":{"$ref":"#/components/schemas/allocationStatus"},"unallocatedNotional":{"$ref":"#/components/schemas/unallocatedNotional"},"unallocatedQuantity":{"$ref":"#/components/schemas/unallocatedQuantity"}}},"ListOrdersAllocationsByUserID":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ListOrdersAllocationsByUserID.Orders"}]}},"FundByUserID.Triggers":{"type":"object","properties":{"child":{"$ref":"#/components/schemas/instrumentID"},"maxAllowed":{"$ref":"#/components/schemas/fundMaxAllowed"},"lowerBound":{"$ref":"#/components/schemas/fundLowerBound"},"upperBound":{"$ref":"#/components/schemas/fundUpperLowerBound"},"type":{"$ref":"#/components/schemas/triggerTypes"}}},"FundByUserID.Holdings":{"type":"object","properties":{"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"target":{"$ref":"#/components/schemas/fundTarget"}}},"FundByUserID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/fundID"},"userID":{"$ref":"#/components/schemas/userID"},"name":{"$ref":"#/components/schemas/fundName"},"type":{"$ref":"#/components/schemas/fundType"},"clientFundID":{"$ref":"#/components/schemas/clientFundID"},"description":{"$ref":"#/components/schemas/fundDescription"},"holdings":{"type":"array","description":"A list of instruments to make up the fund.","items":{"oneOf":[{"$ref":"#/components/schemas/FundByUserID.Holdings"}]}},"triggers":{"type":"array","description":"A list of the individual triggers for each instrument.","items":{"oneOf":[{"$ref":"#/components/schemas/FundByUserID.Triggers"}]}}}},"FundsByUserID":{"type":"array","description":"A list of individual funds holdings.","items":{"oneOf":[{"$ref":"#/components/schemas/FundByUserID"}]}},"PortfolioByUserID.Holdings.CashReserve":{"type":"object","properties":{"type":{"type":"string","example":"CASH_RESERVE","description":"The type of collection making up the portfolio","enum":["CASH_RESERVE","FUND"],"x-enumDescriptions":{"CASH_RESERVE":"A cash reserve position, held for liquidity rather than invested.","FUND":"A managed fund position."}},"target":{"type":"string","example":0.25,"description":"The individual targeted weight of the cash portion of the portfolio."}}},"PortfolioByUserID.Triggers":{"type":"object","properties":{"child":{"$ref":"#/components/schemas/fundID"},"maxAllowed":{"$ref":"#/components/schemas/portfolioMaxAllowed"},"lowerBound":{"$ref":"#/components/schemas/portfolioLowerBound"},"upperBound":{"$ref":"#/components/schemas/portfolioUpperLowerBound"},"type":{"$ref":"#/components/schemas/triggerTypes"}}},"PortfolioByUserID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/portfolioID"},"name":{"$ref":"#/components/schemas/portfolioName"},"description":{"$ref":"#/components/schemas/portfolioDescription"},"clientPortfolioID":{"$ref":"#/components/schemas/clientPortfolioID"},"holdings":{"type":"array","description":"A list of all the individual funds making up the portfolio.","items":{"oneOf":[{"$ref":"#/components/schemas/PortfolioByUserID.Holdings.CashReserve"},{"$ref":"#/components/schemas/FundByUserID"}]}},"userID":{"$ref":"#/components/schemas/userID"},"triggers":{"type":"array","description":"A list of the individual triggers for each fund and or cash.","items":{"$ref":"#/components/schemas/PortfolioByUserID.Triggers"}}}},"PortfoliosByUserID":{"type":"array","description":"A list of portfolios by userID.","items":{"oneOf":[{"$ref":"#/components/schemas/PortfolioByUserID"}]}},"AutoPilotRunByUserID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/autoPilotRebalanceID"},"created":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time that the autopilot re-balance was created."},"status":{"$ref":"#/components/schemas/autoPilotStatus"},"moneyMovement":{"type":"string","example":true,"description":"True, if the re-balance was apart of a funding or withdrawal process."},"regularRebalance":{"type":"string","example":false,"description":"True, if the re-balance was apart of the regularly scheduled re-balancing cycle."}}},"AutoPilotRunsByUserID":{"type":"array","description":"A list of autopilot runs by userID.","items":{"oneOf":[{"$ref":"#/components/schemas/AutoPilotRunByUserID"}]}},"OrdersAllocationsSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"type":{"$ref":"#/components/schemas/orderTypes"},"status":{"$ref":"#/components/schemas/orderStatus"},"created":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time the order was created."},"instrument":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"}}},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"averagePrice":{"$ref":"#/components/schemas/orderAveragePrice"},"orderQuantity":{"$ref":"#/components/schemas/orderQuantity"},"cumulativeQuantity":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"allocatedQuantity":{"$ref":"#/components/schemas/allocatedQuantity"},"unallocatedQuantity":{"$ref":"#/components/schemas/unallocatedQuantity"},"unallocatedNotional":{"$ref":"#/components/schemas/unallocatedNotional"},"allocations":{"type":"array","description":"A list of sub account allocations.","items":{"oneOf":[{"$ref":"#/components/schemas/OrderAllocations"}]}}}},"BankAccountsArray":{"type":"array","description":"A list of all the User's linked bank accounts.","items":{"oneOf":[{"$ref":"#/components/schemas/BankAccount"}]}},"beginningOfDay":{"type":"object","properties":{"url":{"type":"string","example":"'https://d111111abcdef8.cloudfront.net/_bod...","format":"url","description":"The url to the beginning of day json file."}}},"CreateDVPRVP":{"type":"object","required":["tradeDate"],"properties":{"tradeDate":{"type":"string","format":"date","example":"2021-06-04","pattern":"yyyy-MM-dd","description":"The date to generate the DVP RVP report for."},"note":{"$ref":"#/components/schemas/note"}}},"CreateDVPRVPRes":{"type":"object","properties":{"id":{"type":"string","example":"bsr_123e4567-e89b-12d3-a456-000000000150.1234567890195_20210604","description":"The DVP RVP report identifier."},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradeDate":{"type":"string","format":"date","example":"2021-06-04","pattern":"yyyy-MM-dd","description":"The date for which the DVP RVP was run."},"note":{"$ref":"#/components/schemas/note"},"partnerID":{"$ref":"#/components/schemas/partnerID"}}},"DVPRVPStatus":{"type":"string","example":"Processing","enum":["Processing","Successful"],"x-enumDescriptions":{"Processing":"The report is being processed.","Successful":"The report completed successfully."}},"DVPRVP":{"type":"object","properties":{"id":{"type":"string","example":"bsr_123e4567-e89b-12d3-a456-000000000150.1234567890195_20210604","description":"The DVP RVP report identifier."},"tradeDate":{"type":"string","format":"date","example":"2021-06-04","pattern":"yyyy-MM-dd","description":"The date for which the DVP RVP was run."},"status":{"type":"string","example":"SUCCESSFUL","description":"The status of the generated report.","enum":["PROCESSING","SUCCESSFUL"],"x-enumDescriptions":{"PROCESSING":"The report is being processed.","SUCCESSFUL":"The report completed successfully."}},"note":{"$ref":"#/components/schemas/note"},"partnerID":{"$ref":"#/components/schemas/partnerID"},"created":{"$ref":"#/components/schemas/created"},"updated":{"$ref":"#/components/schemas/updated"},"updatedBy":{"$ref":"#/components/schemas/updatedBy"},"source":{"type":"string","example":"MANUAL","enum":["MANUAL","SYSTEM"],"description":"The method type in which the report was generated.","x-enumDescriptions":{"MANUAL":"The report was generated manually.","SYSTEM":"The report was generated automatically by the system."}}}},"ListDVPRVP":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DVPRVP"}]}},"DVPRVPDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/DVPRVP"},{"type":"object","properties":{"amount":{"type":"object","properties":{"totalBuy":{"type":"object","properties":{"quantity":{"type":"number","example":10.71358941,"description":"The amount of shares that were purchased."},"notional":{"type":"number","example":144.26,"description":"The total amount in USD value of the instruments."},"orders":{"type":"number","example":30,"description":"The total amount of orders assiocated to the amount of shares purchased."}}},"totalSell":{"type":"object","properties":{"quantity":{"type":"number","example":0,"description":"The amount of shares that were sold."},"notional":{"type":"number","example":0,"description":"The total amount in USD value of the instruments."},"orders":{"type":"number","example":0,"description":"The total amount of orders assiocated to the amount of shares sold."}}}}},"breakdownJson":{"type":"string","format":"url","description":"A json file of the trade breakdown of all the purchases and sale transactions.","example":"https://d111111abcdef8.cloudfront.net/buySellTradesReport...."}}}]},"SingleSettlementDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/CashSettlementFields"}],"properties":{"id":{"$ref":"#/components/schemas/singleSettlementID"},"settlementDate":{"$ref":"#/components/schemas/date","description":"The date for which the settlement was generated."},"partnerID":{"$ref":"#/components/schemas/parentIBID"},"status":{"$ref":"#/components/schemas/singleSettlementStatus"},"totalAmount":{"type":"number","example":-14250,"description":"The total aggregated sum of all underlying accounts and transactions."},"createdAt":{"$ref":"#/components/schemas/created","description":"The date and time the settlement was created."},"updatedAt":{"$ref":"#/components/schemas/updated","description":"The date and time the settlement was last updated."},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"attestedAt":{"type":"string","example":"2024-04-17T22:28:21.810Z","description":"The date and time when the settlement report was attested."}}},"SingleSettlementReports":{"type":"object","properties":{"pageSize":{"type":"integer","example":1,"description":"The amount of results on the page."},"limit":{"type":"integer","example":50,"description":"The maximum number of results per page."},"settlements":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SingleSettlementDetails"}]}}}},"SingleSettlementUpdate":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESSFUL","description":"The status to update the settlement to.","enum":["SUCCESSFUL"],"x-enumDescriptions":{"SUCCESSFUL":"The settlement completed successfully."}}}},"SingleSettlementByID":{"type":"object","allOf":[{"$ref":"#/components/schemas/CashSettlementFields"}],"properties":{"id":{"$ref":"#/components/schemas/singleSettlementID"},"settlementDate":{"$ref":"#/components/schemas/date","description":"The date the settlement was generated for."},"status":{"$ref":"#/components/schemas/singleSettlementStatus"},"statusComment":{"type":"string","example":"Finished processing breakdown","description":"A custom comment about the current status of the settlement."},"amount":{"type":"object","properties":{"total":{"type":"number","example":5000.45,"description":"The aggregated sum of all the transactions settling on the settlement date."},"credits":{"type":"number","example":6000.45,"description":"The aggregated sum of all the credit transactions settling on the settlement date."},"debits":{"type":"number","example":-1000,"description":"The aggregated sum of all the debit transactions settling on the settlement date."}}},"breakdownReport":{"type":"string","format":"url","example":"https://d111111abcdef8.cloudfront.net/singleSettlementReport....","description":"A breakdown of all the deposits or withdrawals across sub accounts over the course of the settlement date."},"partnerID":{"$ref":"#/components/schemas/partnerID"},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"updatedBy":{"$ref":"#/components/schemas/updatedBy"},"createdAt":{"$ref":"#/components/schemas/created","description":"The date and time of when the settlement was created."},"updatedAt":{"$ref":"#/components/schemas/updated","description":"The date and time of when the settlement was last updated."},"attestedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000167","description":"User ID of the person who attested the settlement report."},"attestedAt":{"type":"string","example":"2024-04-17T22:28:21.810Z","description":"The date and time when the settlement report was attested."}}},"AttestSettlementResponse":{"allOf":[{"$ref":"#/components/schemas/SingleSettlementByID"},{"type":"object","properties":{"status":{"type":"string","example":"SUCCESSFUL","description":"The status of the attested settlement.","enum":["SUCCESSFUL"],"x-enumDescriptions":{"SUCCESSFUL":"The settlement completed successfully."}}}}]},"ExpirationAnalysisReq":{"type":"object","required":["partners","outOfTheMoneyPercentage"],"properties":{"partners":{"type":"array","description":"Array of partners IBID","example":["123e4567-e89b-12d3-a456-00000000014e","123e4567-e89b-12d3-a456-00000000014d"],"items":{"oneOf":[{"$ref":"#/components/schemas/parentIBID"}]}},"outOfTheMoneyPercentage":{"type":"number","example":3,"description":"The out of money percentage."}}},"ExpirationAnalysisRes":{"type":"object","properties":{"requestId":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000014d","description":"The unique request Id for each analysis request."}}},"ExpirationAnalysisStatusRes":{"type":"object","properties":{"requestId":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000014d","description":"The unique request Id for each analysis request"},"statusId":{"type":"string","example":"COMPLETED","description":"The status of the expiration analysis request","enum":["PENDING","COMPLETED","FAILED"],"x-enumDescriptions":{"PENDING":"The expiration analysis is pending.","COMPLETED":"The expiration analysis completed.","FAILED":"The expiration analysis failed."}}}},"ClosingPositionsPaginated":{"type":"object","properties":{"requestId":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000014d","description":"The unique request Id for each analysis request"},"pageInfo":{"type":"object","description":"Page Info","properties":{"page":{"type":"number","example":1},"pageSize":{"type":"number","example":10},"totalRecords":{"type":"number","example":26},"sortOrder":{"type":"string","example":"asc"}}},"closingPositionsList":{"type":"array","description":"A list of expiring positions.","items":{"oneOf":[{"$ref":"#/components/schemas/ClosingPosition"}]}}}},"ClosingPosition":{"type":"object","properties":{"partnerIbid":{"$ref":"#/components/schemas/parentIBID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"quantity":{"type":"number","example":"10.234","description":"The quantity of the closing position."},"partnerName":{"$ref":"#/components/schemas/wlpID"},"accountId":{"$ref":"#/components/schemas/accountID"}}},"SetAutoLiquidationReq":{"type":"object","properties":{"disabled":{"$ref":"#/components/schemas/autoLiquidationDisabled"}}},"GetAutoLiquidationResp":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/autoLiquidationEffectiveDate"},"disabled":{"$ref":"#/components/schemas/autoLiquidationDisabled"}}},"autoLiquidationEffectiveDate":{"type":"string","example":"2024-06-18","description":"The effective date of the Auto Liquidation job."},"autoLiquidationDisabled":{"type":"boolean","example":"true","description":"True, when the Auto Liquidation is disabled."},"CreateOrderRequest":{"type":"object","required":["accountNo","orderType","side"],"properties":{"accountNo":{"type":"string","example":"DDDD000003","description":"The user's assiocated account number."},"orderType":{"$ref":"#/components/schemas/orderTypesRequest"},"limitType":{"$ref":"#/components/schemas/limitType"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"side":{"$ref":"#/components/schemas/side"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"quantity":{"type":"number","format":"double","example":5,"description":"The unit quantity to purchase or sell. Required if `amountCash` is null."},"amountCash":{"$ref":"#/components/schemas/amountCash"},"price":{"type":"number","format":"double","example":160.12,"description":"The price for non-`MARKET` Order types. This would be required if placing a `LIMIT`, `STOP`, or `MARKET_IF_TOUCHED` order."},"currency":{"$ref":"#/components/schemas/currency"},"commission":{"type":"number","format":"double","example":4,"description":"A USD amount to charge as commission for an Order. This defaults to using an Account's assigned Commission Schedule if unset. For example, `4` will result in a $4.00 commission charge, regardless of the assigned Commission Schedule."},"commissionRate":{"$ref":"#/components/schemas/commissionRate"},"clientNotes":{"type":"string","example":"Manual limit order.","description":"Client facing notes that can be added to a request."},"preventQueuing":{"$ref":"#/components/schemas/preventQueuing"},"extendedHours":{"$ref":"#/components/schemas/extendedHours"},"metadata":{"$ref":"#/components/schemas/metadata"},"timeInForce":{"$ref":"#/components/schemas/timeInForce"},"executionInstructions":{"$ref":"#/components/schemas/executionInstructions"},"expiration":{"$ref":"#/components/schemas/expiration"},"salesCredit":{"$ref":"#/components/schemas/SalesCredit"},"dccs":{"$ref":"#/components/schemas/dccs"},"taxLotDisposition":{"$ref":"#/components/schemas/LotDisposition"},"travelRuleBankAccountID":{"type":"string","example":"bank_123e4567-e89b-12d3-a456-00000000012e","description":"The travel rule bank account ID. Supported By MARKET, LIMIT, STOP, MARKET_IF_TOUCHED orders. Only if partner enabled to send travel rule."},"traderID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"The trader ID of the individual creating the order."},"clientOrderTransactionTime":{"$ref":"#/components/schemas/clientOrderTransactionTime"},"clientOrderRouteTime":{"$ref":"#/components/schemas/clientOrderRouteTime"},"clientOrderID":{"$ref":"#/components/schemas/clientOrderID"},"deptType":{"$ref":"#/components/schemas/deptType"},"clientID":{"$ref":"#/components/schemas/clientID"}}},"LotDisposition":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/TaxLot"}]}},"CreateOrderResponse":{"type":"object","properties":{"orderId":{"type":"string","example":"EF.123e4567-e89b-12d3-a456-000000000133","description":"A unique identifier for the order."},"orderNo":{"type":"string","example":"TTTT000019","description":"A human readable order identifier."}}},"OrderStatusResponse":{"type":"object","description":"Order details for a fixed income asset trade","properties":{"id":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"type":{"$ref":"#/components/schemas/orderTypes"},"side":{"$ref":"#/components/schemas/side"},"status":{"$ref":"#/components/schemas/localOrderStatus"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"CUSIP":{"$ref":"#/components/schemas/instrumentCUSIP"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"averagePrice":{"$ref":"#/components/schemas/orderAveragePrice"},"currency":{"$ref":"#/components/schemas/currency"},"totalOrderAmount":{"type":"number","format":"double","example":800,"description":"Total amount paid for the order."},"cumulativeQuantity":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"quantity":{"$ref":"#/components/schemas/orderQuantity"},"fees":{"type":"number","format":"double","example":0.01,"description":"Cost of the order."},"ptpWithholdingFee":{"type":"number","format":"double","example":0.01,"description":"The publicly traded partnership (PTP) withholding fee for the order."},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"userID of the individual creating the order."},"userID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"userID of the account holder the order relates to."},"accountID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004.1234567890187","description":"accountID for the account the order relates to."},"accountNo":{"type":"string","example":"DDDD000003","description":"accountNo for the account the order related to."},"created":{"type":"string","example":"2019-02-14T18:56:07.411Z","description":"The time at which the order was created."},"statusMessage":{"type":"object","description":"If the Order was unsuccessful, this object will be present with additional details regarding why.","properties":{"errorCode":{"type":"object","example":null,"description":"A DriveWealth error code."},"message":{"type":"string","example":null,"description":"Description of the error code."},"reason":{"type":"string","example":null,"description":"A longer reason for the error."}}},"amountCash":{"$ref":"#/components/schemas/amountCash"},"OrderExpires":{"type":"string","example":null,"description":"The date of expiration for a good-til-canceled order, in “YYYY-MM-DD” format. The order will be canceled if not executed by the market close on this date. If not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day."},"salesCredit":{"$ref":"#/components/schemas/SalesCredit"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"dccs":{"$ref":"#/components/schemas/dccs"},"openQuantity":{"$ref":"#/components/schemas/openQuantity"},"availableForTradingQuantity":{"$ref":"#/components/schemas/availableForTradingQuantity"},"travelRuleBankAccountID":{"type":"string","example":"bank_123e4567-e89b-12d3-a456-00000000012e","description":"Displays travel rule bank account ID which set while creating order"},"clientOrderTransactionTime":{"$ref":"#/components/schemas/clientOrderTransactionTime"},"clientOrderID":{"$ref":"#/components/schemas/clientOrderID"},"executionInstructions":{"$ref":"#/components/schemas/executionInstructions"}}},"CancelOrder":{"type":"object","required":["method"],"properties":{"method":{"type":"string","example":"CANCEL","enum":["CANCEL"],"description":"The method in which is requested.","x-enumDescriptions":{"CANCEL":"Cancel the order."}},"traderID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004","description":"The trader ID of the individual."},"clientOrderTransactionTime":{"$ref":"#/components/schemas/clientOrderTransactionTime"},"clientOrderID":{"$ref":"#/components/schemas/clientOrderID"},"cancelDetails":{"$ref":"#/components/schemas/cancelDetails"}}},"CancelOrderResponse":{"type":"object","properties":{"orderId":{"type":"string","example":"EF.123e4567-e89b-12d3-a456-000000000133","description":"A unique identifier for the order."},"orderNo":{"type":"string","example":"TTTT000019","description":"A human readable order identifier."}}},"RFQrequest":{"type":"object","required":["accountID","symbol","side","quotedCurrency","ipAddress"],"properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"symbol":{"type":"string","example":"BTC","description":"The symbol of the cryptocurrency."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"quantity":{"$ref":"#/components/schemas/orderQuantity"},"amountCash":{"type":"number","example":null,"description":"Order quantity in USD cash amount for \"MARKET\" and \"STOP\" order types. Only required if `quantity` is null."},"quotedCurrency":{"type":"string","example":"USD","description":"The currency symbol of the requested quote. Must be in USD."},"ipAddress":{"type":"string","example":"","description":"IP address of the user that is sending this request."}}},"RDQresponse":{"type":"object","properties":{"expires":{"type":"string","example":"2019-06-12T23:59:59Z","description":"The time at which the RFQ will expire yyyy-mm-dd."},"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000134","description":"A unique identifier associated with the quote."}}},"openQuantity":{"type":"number","example":1,"description":"The number of units currently represented by the position in the Account."},"availableForTradingQuantity":{"type":"number","example":1,"description":"The number of units that can currently be traded by the Account holder."},"commissionOverrideType":{"type":"string","enum":["NO_OVERRIDE","RAW_COMMISSION"],"example":"RAW_COMMISSION","description":"The type of commission override applied to the order","x-enumDescriptions":{"NO_OVERRIDE":"No commission override is applied.","RAW_COMMISSION":"The raw commission amount overrides the standard rate."}},"commissionOverrideDesc":{"type":"string","example":"Standard Commission","description":"The description of commission override applied to the order"},"amountCash":{"type":"number","format":"double","example":null,"description":"The USD-denominated amount to purchase or sell."},"localOrderStatus":{"type":"string","example":"FILLED","description":"The current status of the order.","enum":["NEW","FILLED","PARTIAL_FILL","REJECTED","CANCELED","PENDING_CANCEL"],"x-enumDescriptions":{"NEW":"The order has been received but not yet processed.","FILLED":"The order has been completely filled.","PARTIAL_FILL":"The order has been partially filled.","REJECTED":"The order was rejected.","CANCELED":"The order has been canceled.","PENDING_CANCEL":"A cancel request has been submitted and is awaiting confirmation."}},"localSide":{"type":"string","example":"BUY","description":"The side of the order.","enum":["BUY","SELL"],"x-enumDescriptions":{"BUY":"Purchase the instrument.","SELL":"Sell the instrument."}},"auditLog":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/localOrderStatus"},"quantities":{"type":"object","properties":{"cumulativeQuantity":{"example":0},"filledQuantity":{"example":0},"remainingQuantity":{"example":0}}},"pricing":{"type":"object","properties":{"averagePrice":{"example":0},"averagePriceRaw":{"example":0},"lastPrice":{"example":0},"rateAsk":{"example":0},"rateBid":{"example":0}}},"commissionAndFees":{"type":"object","properties":{"commission":{"example":0},"feeSec":{"example":0},"feeTaf":{"example":0},"feeBase":{"example":0},"feeXtraShares":{"example":0},"feeExchange":{"example":0}}},"pnl":{"example":0},"transactTime":{"$ref":"#/components/schemas/updated"},"comment":{"$ref":"#/components/schemas/note"},"eventID":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000135","description":"EventID sent to client"},"createdWhen":{"$ref":"#/components/schemas/created"}}},"dccs":{"type":"boolean","example":true,"description":"True, when the Mutual Fund HSA is classified as Defined Contribution Clearing and Settlement (DCC&S) order."},"commissionOverride":{"oneOf":[{"type":"object","properties":{"commissionOverrideType":{"$ref":"#/components/schemas/commissionOverrideType"},"commissionID":{"$ref":"#/components/schemas/commissionID"},"commissionOverrideDesc":{"$ref":"#/components/schemas/commissionOverrideDesc"}}},{"type":"object","properties":{"commissionOverrideType":{"$ref":"#/components/schemas/commissionOverrideType"},"commissionID":{"$ref":"#/components/schemas/commissionID"},"commissionOverrideDesc":{"$ref":"#/components/schemas/commissionOverrideDesc"},"commissionAmount":{"example":3.5},"secOverride":{"example":0.01},"tafOverride":{"example":0.01}}},{"type":"object","properties":{"commissionOverrideType":{"example":"#/components/schemas/commissionOverrideType"},"commissionID":{"$ref":"#/components/schemas/commissionID"},"commissionOverrideDesc":{"example":"#/components/schemas/commissionOverrideDesc"},"commissionRate":{"example":0.5},"secOverride":{"example":0.01},"tafOverride":{"example":0.01}}}]},"OrderAuditResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"quantities":{"type":"object","properties":{"requestedQuantity":{"type":"number","example":1,"description":"The amount of shares requested in the order."},"totalFilledQuantity":{"type":"number","example":1,"description":"The amount of shares filled in the order."}}},"ordStatus":{"$ref":"#/components/schemas/localOrderStatus"},"side":{"$ref":"#/components/schemas/localSide"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"ordType":{"$ref":"#/components/schemas/orderTypes"},"amountCash":{"$ref":"#/components/schemas/amountCash"},"violationExempt":{"type":"boolean","example":true},"preventQueuing":{"$ref":"#/components/schemas/preventQueuing"},"extendedHours":{"$ref":"#/components/schemas/extendedHours"},"orderExpires":{"type":"string","format":"date","example":"YYYY-MM-DDTHH:MM:SS.sssZ","description":"The date of expiration for a good-til-canceled order, in ISO format. The order will be canceled if not executed by the market close on this date. If not set, a good-til-canceled Stop and MIT order will be assumed to expire 90 days after creation. If not set, a limit order will be considered GTD and will cancel at the end of the trading day."},"openQuantity":{"$ref":"#/components/schemas/openQuantity"},"availableForTradingQuantity":{"$ref":"#/components/schemas/availableForTradingQuantity"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"pricing":{"type":"object","properties":{"avgPxRaw":{"example":33.66},"avgPx":{"example":33.66},"stopPx":{"example":0},"minTriggerPrice":{"example":0}}},"commissionOverride":{"$ref":"#/components/schemas/commissionOverride"},"commissionAndFees":{"type":"object","properties":{"total":{"example":2.99},"tefra":{"example":0},"ptp":{"example":0}}},"auditLog":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/auditLog"}]}},"clientOrderTransactionTime":{"$ref":"#/components/schemas/clientOrderTransactionTime"},"clientOrderID":{"$ref":"#/components/schemas/clientOrderID"}}},"OptionsLiquidationResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"type":{"$ref":"#/components/schemas/orderTypes"},"side":{"$ref":"#/components/schemas/localSide"},"status":{"$ref":"#/components/schemas/localOrderStatus"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"CUSIP":{"$ref":"#/components/schemas/instrumentCUSIP"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"averagePrice":{"type":"number","format":"double","example":160,"description":"The average price of the security being transacted in the order."},"currency":{"$ref":"#/components/schemas/currency"},"totalOrderAmount":{"type":"number","format":"double","example":800,"description":"The total amount paid for the order."},"cumulativeQuantity":{"type":"number","format":"double","example":5,"description":"The number of shares currently being transacted."},"quantity":{"type":"number","format":"double","example":5,"description":"The total number of shares requested."},"fees":{"type":"number","format":"double","example":0.01,"description":"The cost of the order."},"ptpWithholdingFee":{"type":"number","format":"double","example":0.01,"description":"The publicly traded partnership (PTP) withholding fee for the order."},"createdBy":{"$ref":"#/components/schemas/userID"},"userID":{"$ref":"#/components/schemas/userID"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"created":{"type":"string","example":"2019-02-14T18:56:07.411Z","description":"The time at which the order was created."},"statusMessage":{"type":"object","properties":{"errorCode":{"type":"object","example":"0802","description":"The error code produced."},"message":{"type":"string","example":"System market data unavailable","description":"The description of the error code."},"reason":{"type":"string","example":"0105 Order quantity exceeds quantity available for sale.  Cannot SELL SHORT. null","description":"The reason for the error."}}},"amountCash":{"type":"number","example":800,"description":"The cash amount requested for the order."},"OrderExpires":{"type":"string","example":null,"description":"The ending period of when the order will/has expired."},"salesCredit":{"$ref":"#/components/schemas/SalesCredit"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"dccs":{"$ref":"#/components/schemas/dccs"},"openQuantity":{"$ref":"#/components/schemas/openQuantity"},"availableForTradingQuantity":{"$ref":"#/components/schemas/availableForTradingQuantity"},"partner":{"$ref":"#/components/schemas/parentIBIDObject"}}},"ExerciseCreateReq":{"type":"object","required":["accountNo","exerciseType","symbol","quantity"],"properties":{"accountNo":{"$ref":"#/components/schemas/accountNo"},"exerciseType":{"type":"string","example":"EARLY","description":"The types of Option exercise.","enum":["EARLY","EXCEPTION","DNE"],"x-enumDescriptions":{"EARLY":"Early exercise.","EXCEPTION":"Exercise by exception.","DNE":"Do not exercise."}},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"quantity":{"type":"number","example":"10.234","description":"The amount of the instrument in shares."}}},"ExerciseRes":{"type":"object","properties":{"exerciseStatus":{"type":"string","example":"SUBMITTED","description":"The exercise status type.","enum":["SUBMITTED","REJECTED","ACCEPTED","COMPLETED","ERROR"],"x-enumDescriptions":{"SUBMITTED":"The exercise request was submitted by Ops.","REJECTED":"The exercise request was rejected by Ops.","ACCEPTED":"The exercise request was accepted; the position/cash needs to be locked up.","COMPLETED":"The exercise request completed and was entered into ABN (terminal state).","ERROR":"An error occurred submitting the exercise request."}},"status":{"type":"string","example":"SUCCESS","description":"The Option exercise status.","enum":["SUCCESS","FAILED"],"x-enumDescriptions":{"SUCCESS":"The request succeeded.","FAILED":"The request failed."}}}},"clientOrderTransactionTime":{"type":"string","example":"2024-07-30T22:13:18.000Z","description":"The date with a valid timestamp of when a partner received the order from the customer."},"clientOrderRouteTime":{"type":"string","example":"2024-07-30T22:13:18.000Z","description":"The date with a valid timestamp of when DW received the order from the partner."},"clientOrderID":{"type":"string","example":"5a1762d5-4562","description":"A unique identifier that represents the order, as defined by the partner. This detail will be reported to the CAT system for US brokers to more easily reconcile reported information."},"clientID":{"type":"string","example":"1abc234xyz789","description":"A unique identifier from the partner's platform that represents the customer who placed this order. This detail should be supplied for orders in an omnibus account."},"cancelDetails":{"type":"object","description":"Additional details to clarify when and how the cancel request was received. US broker-dealers must utilize this field for CAT compliance.","properties":{"initiator":{"type":"string","nullable":true,"example":"C","description":"The individual responsible for initiating the cancellation of an order. Please refer to CAT documentation and instructions for more information on the allowed values.","enum":["C","F"],"x-enumDescriptions":{"C":"The customer initiated the cancel request.","F":"DriveWealth initiated the cancel request, or the US broker-dealer partner initiated the request."}},"requestedTimestamp":{"type":"string","nullable":true,"example":"2023-07-30T22:13:18.000Z","description":"The requested timestamp in ISO format by user to cancel an order"},"manualCancel":{"type":"boolean","nullable":true,"example":true,"description":"Whether an order cancellation request was received from a human, manually. A false value represents that an automated system initiated the cancel."},"comment":{"type":"string","nullable":true,"example":"This order has been cancelled","description":"A freeform comment to attach to the cancel request"}}},"AccountReq":{"type":"object","required":["userID","accountType","accountManagementType"],"properties":{"userID":{"$ref":"#/components/schemas/userID"},"accountType":{"$ref":"#/components/schemas/accountType"},"accountManagementType":{"$ref":"#/components/schemas/accountManagementType"},"accountHolderType":{"$ref":"#/components/schemas/accountHolderType"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"finra3210ComplianceEntity":{"$ref":"#/components/schemas/finra3210ComplianceEntity"},"riaUserID":{"$ref":"#/components/schemas/riaID"},"riaProductID":{"type":"string","example":"","description":"RIA product identifier (legacy)"},"riaPortfolioID":{"$ref":"#/components/schemas/portfolioID","description":"A unique ID associated with an RIA managed portfolio. If set, a portfolio will be assigned to this account for automatic rebalancing."},"authorizedUsers":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/authorizedUser"}]}},"ignoreBuyingPower":{"type":"boolean","example":false,"description":"If true, the accounts cash balance can go negative."},"violationsExempt":{"type":"boolean","example":false,"description":"Instruct the GFV/PDT system to not process for this account. Available only in sandbox."},"ignoreMarketHoursForTest":{"type":"boolean","example":true,"description":"If set to `true` trades will execute in DriveWealth's UAT environment after market hours. If you are attempting to test Mutual Fund orders this flag needs to be set to `false`."},"extendedHoursEnrolled":{"type":"boolean","example":false,"description":"`true` or `false` if the account is enrolled in and able to access Extended Hours Trading"},"classActionsEnrolled":{"type":"boolean","example":false,"description":"Indicates whether the account is enrolled in class actions settlement claim filing service. Set to `false` if the client explicitly opts out. If omitted or `null`, the account is treated as enrolled."},"metadata":{"$ref":"#/components/schemas/metadata"},"leverage":{"$ref":"#/components/schemas/leverage"},"accountFeatures":{"$ref":"#/components/schemas/accountFeatures"},"accountFundingType":{"$ref":"#/components/schemas/accountFundingType"},"interestedParties":{"type":"array","items":{"$ref":"#/components/schemas/interestedParty"}},"trustedContact":{"$ref":"#/components/schemas/trustedContact"}}},"AccountRes":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountType":{"type":"object","properties":{"name":{"type":"string","example":"LIVE","description":"The type of account."},"description":{"type":"string","example":"Live Account","description":"A description of the type of account."}}},"accountMgmtType":{"$ref":"#/components/schemas/accountManagementTypeObject"},"accountHolderType":{"$ref":"#/components/schemas/accountHolderTypeObject"},"status":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/accountStatus"},"description":{"type":"string","example":"Open","description":"A description of the account status."}}},"tradingType":{"type":"object","properties":{"name":{"type":"string","example":"CASH","description":"The type of trading ocurring in the account.","enum":["CASH","MARGIN","CRYPTO"],"x-enumDescriptions":{"CASH":"A cash account; trades settle using available cash only.","MARGIN":"A margin account; trades may be placed using borrowed funds.","CRYPTO":"A crypto account."}},"description":{"type":"string","example":"Cash Account","description":"A custom description about the type of account."}}},"leverage":{"$ref":"#/components/schemas/leverage"},"nickname":{"$ref":"#/components/schemas/accountNickname"},"parentIB":{"$ref":"#/components/schemas/parentIBIDObject"},"taxProfile":{"$ref":"#/components/schemas/taxProfileObject"},"commissionID":{"$ref":"#/components/schemas/commissionID"},"beneficiaries":{"$ref":"#/components/schemas/beneficiariesOption"},"userID":{"$ref":"#/components/schemas/userID","description":"The userID associated with the account. This will be the userID of your customer."},"restricted":{"$ref":"#/components/schemas/restricted"},"goodFaithViolations":{"$ref":"#/components/schemas/goodFaithViolations"},"patternDayTrades":{"allOf":[{"$ref":"#/components/schemas/patternDayTrades"}],"deprecated":true},"freeTradeBalance":{"$ref":"#/components/schemas/freeTradeBalance"},"gfvPdtExempt":{"$ref":"#/components/schemas/gfvPdtExempt"},"buyingPowerOverride":{"$ref":"#/components/schemas/buyingPowerOverride"},"bod":{"$ref":"#/components/schemas/bod"},"ria":{"$ref":"#/components/schemas/riaObject"},"sweepInd":{"$ref":"#/components/schemas/sweepInd"},"interestFree":{"$ref":"#/components/schemas/interestFree"},"openedWhen":{"$ref":"#/components/schemas/openedWhen"},"ignoreMarketHoursForTest":{"$ref":"#/components/schemas/ignoreMarketHoursForTest"},"flaggedForACATS":{"$ref":"#/components/schemas/flaggedForACATS"},"fpslEnrolled":{"$ref":"#/components/schemas/fpslEnrolled"},"accountFeatures":{"$ref":"#/components/schemas/accountFeaturesResp"},"accountFundingType":{"$ref":"#/components/schemas/accountFundingType"},"interestedParties":{"type":"array","items":{"$ref":"#/components/schemas/interestedParty"}},"trustedContact":{"$ref":"#/components/schemas/trustedContact"}}},"AccountDetailRes":{"type":"object","properties":{"account":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"booksAndRecordsAccountID":{"$ref":"#/components/schemas/booksAndRecordsAccountID"},"accountType":{"type":"object","properties":{"name":{"type":"string","example":"LIVE","description":"The type of account."},"description":{"type":"string","example":"Live Account","description":"A description of the type of account."}}},"accountMgmtType":{"$ref":"#/components/schemas/accountManagementTypeObject"},"accountHolderType":{"$ref":"#/components/schemas/accountHolderTypeObject"},"finra3210ComplianceEntity":{"$ref":"#/components/schemas/finra3210ComplianceEntity"},"status":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/accountStatus"},"description":{"type":"string","example":"Open","description":"A description of the account status."}}},"tradingType":{"type":"object","properties":{"name":{"type":"string","example":"CASH","description":"The type of trading ocurring in the account.","enum":["CASH","MARGIN","CRYPTO"],"x-enumDescriptions":{"CASH":"A cash account; trades settle using available cash only.","MARGIN":"A margin account; trades may be placed using borrowed funds.","CRYPTO":"A crypto account."}},"description":{"type":"string","example":"Cash Account","description":"A custom description about the type of account."}}},"leverage":{"$ref":"#/components/schemas/leverage"},"nickname":{"$ref":"#/components/schemas/accountNickname"},"parentIB":{"$ref":"#/components/schemas/parentIBIDObject"},"taxProfile":{"$ref":"#/components/schemas/taxProfileObject"},"commissionID":{"$ref":"#/components/schemas/commissionID"},"beneficiaries":{"$ref":"#/components/schemas/beneficiariesOption"},"userID":{"$ref":"#/components/schemas/userID","description":"The userID associated with the account. This will be the userID of your customer."},"restricted":{"$ref":"#/components/schemas/restricted","description":"True, when the account cannot trade on unsettled funds.","deprecated":true},"gfvRestricted":{"$ref":"#/components/schemas/gfvRestricted"},"goodFaithViolations":{"$ref":"#/components/schemas/goodFaithViolations"},"pdtRestricted":{"allOf":[{"$ref":"#/components/schemas/pdtRestricted"}],"deprecated":true},"patternDayTrader":{"allOf":[{"$ref":"#/components/schemas/patternDayTrader"}],"deprecated":true},"patternDayTrades":{"allOf":[{"$ref":"#/components/schemas/patternDayTrades"}],"deprecated":true},"freeTradeBalance":{"$ref":"#/components/schemas/freeTradeBalance"},"gfvPdtExempt":{"$ref":"#/components/schemas/gfvPdtExempt"},"buyingPowerOverride":{"$ref":"#/components/schemas/buyingPowerOverride"},"bod":{"$ref":"#/components/schemas/bod"},"ria":{"$ref":"#/components/schemas/riaObject"},"sweepInd":{"$ref":"#/components/schemas/sweepInd"},"interestFree":{"$ref":"#/components/schemas/interestFree"},"accountFeatures":{"$ref":"#/components/schemas/accountFeaturesResp"},"accountFundingType":{"$ref":"#/components/schemas/accountFundingType"},"statusChangeReason":{"$ref":"#/components/schemas/statusChangeReasonObject"},"statusUpdatedBy":{"$ref":"#/components/schemas/statusUpdatedBy"},"statusChangeHistory":{"$ref":"#/components/schemas/statusChangeHistory"},"createdWhen":{"type":"string","example":"2022-12-22T06:07:41.773Z","description":"A timestamp of when the account was created."},"openedWhen":{"$ref":"#/components/schemas/openedWhen"},"updatedWhen":{"type":"string","example":"2022-12-22T16:04:47.140Z","description":"A timestamp of when the account was last updated."},"ignoreMarketHoursForTest":{"$ref":"#/components/schemas/ignoreMarketHoursForTest"},"flaggedForACATS":{"$ref":"#/components/schemas/flaggedForACATS"},"extendedHoursEnrolled":{"type":"boolean","example":false,"description":"Is the account enrolled in extended hours trading?"},"classActionsEnrolled":{"type":"boolean","example":false,"description":"Indicates whether the account is enrolled in class actions settlement claim filing service. Set to `false` if the client explicitly opts out. If omitted or `null`, the account is treated as enrolled."},"fpslEnrolled":{"$ref":"#/components/schemas/fpslEnrolled"},"lastActivityDate":{"$ref":"#/components/schemas/lastActivityDate"},"interestedParties":{"type":"array","items":{"$ref":"#/components/schemas/interestedParty"}},"trustedContact":{"$ref":"#/components/schemas/trustedContact"},"regTConversionConsent":{"type":"boolean","example":true,"description":"Whether the client has confirmed consent to convert this account from LPMA to Regulation T margin. Only ever set to `true`, and only once an LPMA-to-Reg-T conversion has actually occurred on this account."}}}}},"UpdateAcctReq":{"type":"object","properties":{"leverage":{"$ref":"#/components/schemas/leverage"},"nickname":{"$ref":"#/components/schemas/accountNickname"},"status":{"$ref":"#/components/schemas/accountStatus","items":{"anyOf":[{"required":["statusChangeReason"]}]}},"accountHolderType":{"$ref":"#/components/schemas/accountHolderType"},"statusComment":{"type":"string","example":"Closing the Account.","description":"A reason for updating the account status, not required when editing other attributes."},"statusChangeReason":{"$ref":"#/components/schemas/statusChangeReason"},"restricted":{"$ref":"#/components/schemas/restricted"},"ignoreMarketHoursForTest":{"$ref":"#/components/schemas/ignoreMarketHoursForTest"},"accountFeatures":{"$ref":"#/components/schemas/accountFeatures"},"accountFundingType":{"$ref":"#/components/schemas/accountFundingType"},"authorizedUsers":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/authorizedUser"}]}},"finra3210ComplianceEntity":{"$ref":"#/components/schemas/finra3210ComplianceEntity"},"lastActivityDate":{"$ref":"#/components/schemas/lastActivityDate"},"interestedParties":{"type":"array","items":{"$ref":"#/components/schemas/interestedParty"}},"trustedContact":{"$ref":"#/components/schemas/trustedContact"},"classActionsEnrolled":{"type":"boolean","example":false,"description":"Indicates whether the account is enrolled in class actions settlement claim filing service. Set to `false` if the client explicitly opts out. If omitted or `null`, the account is treated as enrolled."},"regTConversionConsent":{"type":"boolean","example":true,"description":"Client's confirmed consent to convert an existing LPMA margin account to a Regulation T margin account. Must be `true` when this request converts the account's `accountFeatures.margin.methodology` to `REG_T`; any other edit ignores this field. A `false` or omitted value is never persisted as a revoked-consent state."}}},"CommissionsRes":{"type":"array","items":{"$ref":"#/components/schemas/CommissionObject"}},"CommissionObject":{"type":"object","properties":{"active":{"type":"boolean","example":true,"description":"Commission group status."},"commissionID":{"$ref":"#/components/schemas/commissionID"},"description":{"type":"string","example":"Free","description":"A short description about the commission."},"assignmentCriteria":{"$ref":"#/components/schemas/assignmentCriteria"},"rates":{"type":"object","description":"This object contains the details of the commission rates.","properties":{"fractional":{"type":"object","description":"Object provides commission rates on order quantities between 0.0001 and 0.9999 (aka fractional shares).","properties":{"schema":{"$ref":"#/components/schemas/ratesObject"}}},"default":{"type":"object","description":"Object provided commission rates on full share order quantities.","properties":{"schema":{"$ref":"#/components/schemas/ratesObject"}}}}}}},"BeneficiaryReq":{"type":"object","required":["primary"],"properties":{"primary":{"type":"array","description":"An array of objects containing the primary beneficiary details","minItems":1,"items":{"oneOf":[{"$ref":"#/components/schemas/EntityBeneficiariesReqObject"},{"$ref":"#/components/schemas/PersonBeneficiariesReqObject"}]}},"contingent":{"type":"array","description":"An array of objects containing the contingent beneficiary details.","items":{"oneOf":[{"$ref":"#/components/schemas/EntityBeneficiariesReqObject"},{"$ref":"#/components/schemas/PersonBeneficiariesReqObject"}]}}}},"BeneficiaryRes":{"type":"object","properties":{"primary":{"type":"array","description":"An array of objects containing the primary beneficiary details","items":{"oneOf":[{"$ref":"#/components/schemas/beneficiariesResObject"}]}},"contingent":{"type":"array","description":"An array of objects containing the contingent beneficiary details.","items":{"oneOf":[{"$ref":"#/components/schemas/beneficiariesResObject"}]}}}},"VirtualAccountRes":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/bankAccountID"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"wireDetails":{"$ref":"#/components/schemas/wireDetails"},"achDetails":{"$ref":"#/components/schemas/achDetails"},"wireDomesticDetails":{"$ref":"#/components/schemas/wireDomesticDetails"}}},"AccountDepositRes":{"$ref":"#/components/schemas/depositsByUserIDObject"},"AccountRedemptionsRes":{"$ref":"#/components/schemas/Redemptions"},"PortfolioStatusRes":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/portfolioID"},"equity":{"type":"number","example":11003.76,"description":"The account value of the customers account."},"totalDrift":{"type":"number","example":0.012,"description":"Total drift away from target."},"rebalanceRequired":{"type":"boolean","example":true,"description":"A flag that determines if a re-balance is required based on total drift."},"nextPortfolioRebalance":{"type":"string","example":"2018-12-11T15:00:00.846Z","description":"The date of the next portfolio re-balance."},"lastPortfolioRebalance":{"type":"string","example":"2017-12-11T15:00:00.846Z","description":"The date of the last portfolio rebalance."},"holdings":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/portfolioHoldings"}]}}}},"MoneyDetailsRes":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updated":{"type":"string","example":"2021-04-23T18:41:32.440Z","description":"Timestamp of the last time the deposit was updated."},"cash":{"type":"object","properties":{"cashAvailableForTrade":{"type":"number","example":0,"description":"Total cash available for trading (buying power), reduced by pending orders."},"cashAvailableForTradeNonMarginable":{"type":"number","example":0,"description":"Total cleared cash available to trade includes settled cash and sales, excludes unsettled buys and pending orders."},"cashAvailableForWithdrawal":{"type":"number","example":0,"description":"Total settled cash available for withdrawal."},"cashBalance":{"type":"number","example":-12043.23,"description":"Total cash balance, including settled and unsettled funds."},"noBuyingPowerReason":{"type":"array","description":"List of reasons buying power is zero or restricted."},"cashSettlement":{"type":"array","description":"Settlement events for cash proceeds from sales, including settlement time and amount.","items":{"oneOf":[{"$ref":"#/components/schemas/cashSettlementTime"}]}},"cashPendingSettlement":{"type":"number","description":"Total unsettled cash awaiting settlement (e.g. from recent sales).","example":500},"pendingPaymentsAmount":{"type":"number","example":0,"description":"The total amount of money from recent deposits that is still pending.","deprecated":true}}},"payments":{"type":"object","properties":{"buyingPower":{"type":"object","properties":{"pendingDepositsAmountAvailable":{"type":"number","example":20802.71,"description":"The current buying power of an account based on recent deposit requests."},"pendingDepositsAmountNotAvailable":{"type":"number","example":0,"description":"Recent deposits that are not included in buying power."}}},"redemptions":{"type":"object","properties":{"amountWithheldFromRedemptions":{"type":"number","example":60,"description":"Total dollar amount not included in `cashAvailableForWithdrawal` due to seasoning period on deposit"}}}}}}},"StatementListRes":{"type":"array","description":"An array that holds the reference details to an accounts statements.","items":{"oneOf":[{"$ref":"#/components/schemas/statementObj"}]}},"ListTaxDocsRes":{"type":"array","description":"An array that holds the reference details to an accounts tax documents.","items":{"oneOf":[{"$ref":"#/components/schemas/taxStatementObj"}]}},"ListTradeConfirmsRes":{"type":"array","description":"An array that holds the reference details to an accounts trade confirmations.","items":{"oneOf":[{"$ref":"#/components/schemas/tradeConfirmObj"}]}},"SummaryRes":{"type":"object","properties":{"accountSummary":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"lastUpdated":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"Time of last update."},"cash":{"$ref":"#/components/schemas/MoneyDetailsRes/properties/cash"}}},"margin":{"$ref":"#/components/schemas/marginObj"},"equity":{"type":"object","properties":{"equityValue":{"$ref":"#/components/schemas/equityValue"},"equityPositions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/equityPositionsObj"}]}}}},"orders":{"type":"array","description":"An array of pending orders.","items":{"oneOf":[{"$ref":"#/components/schemas/ordersObj"}]}},"transactions":{"type":"array","description":"An array of account transactions","items":{"oneOf":[{"$ref":"#/components/schemas/transactionSumObj"}]}}}},"PositionsRes":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updated":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"Time of last update."},"equityValue":{"$ref":"#/components/schemas/equityValue"},"optionsValue":{"$ref":"#/components/schemas/optionsValue"},"debtValue":{"$ref":"#/components/schemas/debtValue"},"positionsValue":{"$ref":"#/components/schemas/positionsValue"},"equityPositions":{"type":"array","description":"An array of the positions in the account.","items":{"$ref":"#/components/schemas/equityPositionsObj"}},"optionsPositions":{"type":"array","description":"An array of the options positions in the account.","items":{"$ref":"#/components/schemas/optionsPositionsObj"}},"mutualFundsPositions":{"type":"array","description":"An array of the mutual funds positions in the account.","items":{"$ref":"#/components/schemas/mutualFundsPositionsObj"}},"debtPositions":{"type":"array","description":"An array of the debt positions in the account.","items":{"$ref":"#/components/schemas/debtPositionsObj"}}}},"ViolationListRes":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updated":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"Time of last update."},"violations":{"$ref":"#/components/schemas/violationsObj"}}},"ViolationDetailsRes":{"type":"object","properties":{"goodFaithViolations":{"$ref":"#/components/schemas/violationsObj/properties/goodFaithViolations"},"patternDayTrades":{"type":"array","description":"An array of pattern day trade violations.","deprecated":true,"items":{"oneOf":[{"$ref":"#/components/schemas/patternDayTradesObj"}]}},"accountEquityBreakdown":{"$ref":"#/components/schemas/accountEquityBreakdownObj"}}},"MarginRes":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updated":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"Time of last update."},"margin":{"$ref":"#/components/schemas/marginObj"}}},"OrderHistoryRes":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updated":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"Time of last update."},"orders":{"type":"array","description":"An array that holds a list of completed orders.","items":{"oneOf":[{"type":"object","properties":{"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"createdWhen":{"$ref":"#/components/schemas/created"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"cumQty":{"$ref":"#/components/schemas/orderCumulativeQuantity"},"orderStatus":{"$ref":"#/components/schemas/orderStatusNumber"},"orderType":{"$ref":"#/components/schemas/orderTypes"},"orderQty":{"$ref":"#/components/schemas/orderQuantity"},"isoTimeRestingOrderExpires":{"type":"string","example":null,"description":"The time when the limit order expires."},"limitPrice":{"type":"number","example":null,"description":"The price set for the limit order."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"mitTriggerPrice":{"type":"number","example":0,"description":"Market If Touched trigger price. For MIT orders."},"triggered":{"type":"number","example":0,"description":"The trigger price for limit orders."},"averagePriceRaw":{"type":"number","example":147.45,"description":"The average price of purchase for the order."},"orderCashAmt":{"type":"number","example":null,"description":"The amount of cash requested for an order (notional orders only)."},"stopPrice":{"type":"number","example":200,"description":"The stop price of a limit order."},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"}}}]}}}},"finra3210ComplianceEntity":{"type":"string","example":"COMPLYSCI","description":"The regulatory system that the account will be reported to.","enum":["","COMPLYSCI","MCO"],"x-enumDescriptions":{"":"Not reported to any compliance monitoring system.","COMPLYSCI":"Reported to ComplySci.","MCO":"Reported to MyComplianceOffice (MCO)."}},"TransactionSummaryRes":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updated":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"Time of last update."},"transactions":{"type":"array","description":"An Array of transactions.","items":{"oneOf":[{"$ref":"#/components/schemas/transactionObj"}]}}}},"docs":{"type":"object","properties":{"displayName":{"type":"string","example":"2023 Privacy Policy","description":"The description of the regulatory document."},"fileKey":{"type":"string","example":"2023092751","description":"The file key identifier."}}},"RegulatoryInsertsRes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/docs"}]}},"AccountPositionLots":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"positions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PositionLots"}]}}}},"PositionLots":{"type":"object","properties":{"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"currency":{"$ref":"#/components/schemas/currency"},"costBasis":{"type":"number","example":19,"description":"The cost basis of the position."},"quantity":{"type":"number","example":0.16707001,"description":"The total amount of securities held in this position."},"currentMarketPrice":{"type":"number","example":90.16,"description":"The current market price of the instrument."},"currentMarketValue":{"type":"number","example":15.06,"description":"The average price of the the total position."},"unrealizedPnL":{"type":"number","example":-3.94,"description":"The unrealized profit/loss of the position."},"effectiveCostPerShare":{"type":"number","example":1.09,"description":"The effective cost per share of the position."},"side":{"type":"string","example":"B","description":"The parent side of the position, which can be 'B' for Long or 'S' for Short."},"taxLots":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PositionLegs"}]}}}},"PositionLegs":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/taxLotID"},"created":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"The timestamp when the position was created."},"initialQuantity":{"type":"number","example":0.17583963,"description":"The initial quantity of shares for position leg."},"openQuantity":{"type":"number","example":10.1,"description":"The total amount of shares that are currently held in this position leg."},"effectiveCostPerShare":{"type":"number","example":113.74,"description":"The effective cost per share of the position leg."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"comment":{"$ref":"#/components/schemas/note"}}},"Position":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"costBasis":{"type":"number","example":975.98,"description":"The cost basis of the position."},"effectivePx":{"type":"number","example":975.98,"description":"The effective price of the position."},"execID":{"type":"string","example":"100000000000000000000","description":"The execution ID of the position."},"initPx":{"type":"number","example":975.98,"description":"The initial price of the position."},"initQty":{"type":"number","example":0.01,"description":"The initial quantity of the position."},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"openQty":{"type":"number","example":10,"description":"The quantity of shares owned by the account."},"comment":{"type":"string","example":"TOP","description":"A comment describing the position"}}},"Instrument":{"type":"object","properties":{"rootSymbol":{"type":"string","example":"AAPL","description":"The ticker symbol of the underlying Instrument from which this Option is derived."},"rootId":{"$ref":"#/components/schemas/rootId"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"optionType":{"$ref":"#/components/schemas/optionType"},"marketPrice":{"type":"number","example":16.5,"description":"The market price of the option."},"strikePrice":{"type":"number","example":16.5,"description":"The strike price of the option."}}},"OptPosition":{"type":"object","properties":{"expirationDate":{"type":"string","example":"2018-09-18","description":"The date the Option contract will expire.","format":"date"},"position":{"$ref":"#/components/schemas/Position"},"instrument":{"$ref":"#/components/schemas/Instrument"}}},"OptPositionRes":{"type":"object","properties":{"data":{"type":"array","description":"An array of the options positions in the account.","items":{"oneOf":[{"$ref":"#/components/schemas/OptPosition"}]}},"nextPageOffset":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"The next page offset."},"prevPageOffset":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"The previous page offset."}}},"batchID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000018","description":"A unique transaction batch identifier, generated by the platform."},"BatchCreateRequest":{"type":"object","required":["type","data"],"properties":{"type":{"$ref":"#/components/schemas/BatchRequestType"},"data":{"type":"array","description":"Array of batch request","example":{"Option Order":{"value":{"accountNo":"IIII000008","orderType":"LIMIT","timeInForce":"GTC","expiration":"2023-08-01","symbol":"AAPL230818C00195000","side":"BUY_OPEN","quantity":1,"price":3.42}}},"items":{"oneOf":[{"$ref":"#/components/schemas/BatchCreateOrderRequest"}]}}}},"BatchResponse":{"type":"object","properties":{"batchID":{"$ref":"#/components/schemas/batchID"},"type":{"$ref":"#/components/schemas/BatchRequestType"},"status":{"type":"string","description":"The status of Transaction Batch.","example":"COMPLETED","enum":["NOT_STARTED","PROCESSED_10","PROCESSED_20","PROCESSED_30","PROCESSED_40","PROCESSED_50","PROCESSED_60","PROCESSED_70","PROCESSED_80","PROCESSED_90","PROCESSED_100","COMPLETED","COMPLETED_WITH_ERRORS","PARTIAL","PARTIAL_WITH_ERRORS","FAILED","OPS_REVIEW"],"x-enumDescriptions":{"NOT_STARTED":"The batch has not started processing.","PROCESSED_10":"The batch is 10% processed.","PROCESSED_20":"The batch is 20% processed.","PROCESSED_30":"The batch is 30% processed.","PROCESSED_40":"The batch is 40% processed.","PROCESSED_50":"The batch is 50% processed.","PROCESSED_60":"The batch is 60% processed.","PROCESSED_70":"The batch is 70% processed.","PROCESSED_80":"The batch is 80% processed.","PROCESSED_90":"The batch is 90% processed.","PROCESSED_100":"The batch is 100% processed.","COMPLETED":"The batch completed successfully.","COMPLETED_WITH_ERRORS":"The batch completed, but some items had errors.","PARTIAL":"The batch partially completed.","PARTIAL_WITH_ERRORS":"The batch partially completed, with some items having errors.","FAILED":"The batch failed.","OPS_REVIEW":"The batch requires operations review."}},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/orderAddBatchItems"}]}}}},"orderAddBatchItems":{"type":"object","properties":{"accountNo":{"$ref":"#/components/schemas/accountNo"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"quantity":{"type":"number","example":"10.234","description":"The amount of the instrument in shares."},"status":{"type":"string","example":"SUCCESS","description":"The status of batch transactions.","enum":["SUCCESS","WARN","ERROR"],"x-enumDescriptions":{"SUCCESS":"The batch item succeeded.","WARN":"The batch item succeeded with a warning.","ERROR":"The batch item failed."}},"orderType":{"$ref":"#/components/schemas/orderTypes"},"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"partnerIBID":{"$ref":"#/components/schemas/parentIBID"},"partnerName":{"$ref":"#/components/schemas/wlpID"}}},"BatchCreateOrderRequest":{"type":"object","properties":{"accountNo":{"$ref":"#/components/schemas/accountNo"},"orderType":{"$ref":"#/components/schemas/orderTypes"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"side":{"type":"string","example":"SELL_CLOSE","description":"The side of the order.","enum":["BUY","SELL","BUY_OPEN","SELL_CLOSE"],"x-enumDescriptions":{"BUY":"Purchase the instrument.","SELL":"Sell the instrument.","BUY_OPEN":"Open a new long options position.","SELL_CLOSE":"Close an existing long options position by selling."}},"timeInForce":{"type":"string","example":"GTC","description":"The specific amount abbreviated of time the order will exist, until execution or cancellation.","enum":["GTC","GTX","DAY","FILL_OR_KILL"],"x-enumDescriptions":{"GTC":"Good-til-canceled — the order remains active until executed or canceled.","GTX":"Extended-hours eligible order.","DAY":"Good for the current trading day only.","FILL_OR_KILL":"The order must execute immediately in full or be canceled."}},"quantity":{"type":"number","example":"10.234","description":"The amount of the instrument in shares."},"expiration":{"type":"string","format":"date","example":"YYYY-MM-DD","description":"The ending period of when the order will/has expired."},"price":{"type":"number","format":"double","example":160.12,"description":"The amount in dollars for the order."}}},"BatchRequestType":{"type":"string","description":"The type of the Transaction Batch.","example":"OPTIONS_LIQUIDATION","enum":["FINTRAN_ADD","ORDER_ADD","ORDER_STATUS","ORDER_CANCEL","OPTIONS_LIQUIDATION"],"x-enumDescriptions":{"FINTRAN_ADD":"Add a financial transaction.","ORDER_ADD":"Create an order.","ORDER_STATUS":"Check an order's status.","ORDER_CANCEL":"Cancel an order.","OPTIONS_LIQUIDATION":"Liquidate an options position."}},"accountFeatures":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/AccountFeatureOptions"},"mutualFunds":{"$ref":"#/components/schemas/AccountFeatureMutualFunds"},"fixedIncome":{"$ref":"#/components/schemas/AccountFeatureFixedIncome"},"equities":{"$ref":"#/components/schemas/AccountFeatureEquities"}}},"accountFeaturesResp":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/AccountFeatureOptionsResp"},"mutualFunds":{"$ref":"#/components/schemas/AccountFeatureMutualFunds"},"fixedIncome":{"$ref":"#/components/schemas/AccountFeatureFixedIncome"},"equities":{"$ref":"#/components/schemas/AccountFeatureEquities"}}},"AccountFeatureFixedIncome":{"type":"object","description":"Account features related to Fixed Income","properties":{"enrolled":{"description":"Indicates if this account is enrolled for trading fixed income assets","type":"boolean","default":false,"example":true}}},"AccountFeatureEquities":{"type":"object","description":"Account features related to equities","properties":{"dividendReinvestment":{"type":"boolean","example":true,"description":"True, if equity dividends are reinvested."},"dividendReinvestmentOptInWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted for equity dividend reinvestment.","readOnly":true},"dividendReinvestmentOptOutWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted out of equity dividend reinvestment.","readOnly":true},"capitalGainsReinvestment":{"type":"boolean","example":true,"description":"True, if equity capital gains are reinvested."},"capitalGainsReinvestmentOptInWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted for equity capital gains reinvestment.","readOnly":true},"capitalGainsReinvestmentOptOutWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted out of equity capital gains reinvestment","readOnly":true},"overnightHoursEnrolled":{"type":"boolean","example":true,"description":"True, if the account is enrolled for trading during overnight hours."}}},"AccountFeatureOptions":{"type":"object","properties":{"enrolled":{"type":"boolean","description":"User requested option trading be allowed for their account","example":true},"optionsLevel":{"type":"string","description":"The level of options trading the customer requested","example":"LEVEL_2","enum":["LEVEL_2"],"x-enumDescriptions":{"LEVEL_2":"Level 2 options trading — covered calls and protective puts."}},"rop":{"type":"object","description":"Registered Options Principal (ROP) information for the representative who approved the account for options enrollment. Required for US brokers; optional for foreign brokers.","properties":{"name":{"type":"string","description":"The name of the ROP representative","example":"Joe Smith"},"licenseType":{"type":"string","description":"The type of license the ROP representative holds","example":"Series 3"},"licenseNo":{"type":"string","description":"The license number of the ROP representative","example":"1234567"},"approvedWhen":{"type":"string","format":"date-time","description":"The UTC timestamp when the account was approved by the ROP for options trading","example":"2022-12-11T22:28:21.810Z"}}}}},"AccountFeatureOptionsResp":{"type":"object","properties":{"enrolled":{"type":"boolean","description":"Whether the account is enrolled for options trading. This may be different from the value sent in the request if the account is pending approval for options trading or if the account was previously enrolled but has since been unenrolled.","example":true},"optionsLevel":{"type":"string","description":"The level of options trading the customer is approved for. This may be different from the value sent in the request if the account is pending approval for options trading or if the account was previously approved for a different level of options trading.","example":"LEVEL_2","enum":["LEVEL_2"],"x-enumDescriptions":{"LEVEL_2":"Level 2 options trading — covered calls and protective puts."}},"requestedLevel":{"type":"string","description":"The level of options trading the customer requested. This value is only returned if the account is pending approval for options trading and may be used to differentiate between accounts that are pending approval for new options trading and accounts that are pending approval for changes to existing options trading.","example":"LEVEL_2","enum":["LEVEL_2"],"x-enumDescriptions":{"LEVEL_2":"Level 2 options trading — covered calls and protective puts."}},"evaluatedAt":{"type":"string","description":"The timestamp when the account's options trading features were last evaluated for approval.","example":"2022-12-11T22:28:21.810Z","readOnly":true},"rop":{"type":"object","description":"Registered Options Principal (ROP) information for the representative who approved the account for options enrollment. Required for US brokers; optional for foreign brokers.","properties":{"name":{"type":"string","description":"The name of the ROP representative","example":"Joe Smith"},"licenseType":{"type":"string","description":"The type of license the ROP representative holds","example":"Series 3"},"licenseNo":{"type":"string","description":"The license number of the ROP representative","example":"1234567"},"approvedWhen":{"type":"string","format":"date-time","description":"The UTC timestamp when the account was approved by the ROP for options trading","example":"2022-12-11T22:28:21.810Z"}}}}},"AccountFeatureMutualFunds":{"type":"object","properties":{"dividendReinvestment":{"type":"boolean","example":true,"description":"True, if dividends are reinvested."},"dividendReinvestmentOptInWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted for dividend reinvestment.","readOnly":true},"dividendReinvestmentOptOutWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted out of dividend reinvestment.","readOnly":true},"capitalGainsReinvestment":{"type":"boolean","example":true,"description":"True, if capital gains are reinvested."},"capitalGainsReinvestmentOptInWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted for capital gains reinvestment.","readOnly":true},"capitalGainsReinvestmentOptOutWhen":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The timestamp when the account has opted out of capital gains reinvestment","readOnly":true}}},"accountFundingType":{"type":"string","description":"The method used to provide liquidity to the account. 'CASH' indicates accounts receive cash deposits and/or maintains a cash balance. 'CASHLESS' indicates accounts do not maintain cash balance.","example":"CASH","enum":["CASH","CASHLESS"],"x-enumDescriptions":{"CASH":"The account receives cash deposits and/or maintains a cash balance.","CASHLESS":"The account does not maintain a cash balance."}},"fpslEnrolled":{"type":"boolean","example":true,"description":"Indicates whether the account is enrolled in Fully Paid Securities Lending (FPSL) program."},"trustedContact":{"type":"object","description":"A trusted contact for the account. This information is typically collected for account holders who are seniors or vulnerable adults.","properties":{"firstName":{"type":"string","example":"John","description":"The first name of the trusted contact."},"lastName":{"type":"string","example":"Smith","description":"The last name of the trusted contact."},"email":{"type":"string","example":"hello@example.com","description":"The email address of the trusted contact."},"address":{"type":"string","example":"123 Main Street","description":"The address of the trusted contact."},"phoneNumber":{"type":"string","example":"+15555550100","description":"The phone number of the trusted contact."}}},"PendingAmountsResponse":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"current":{"$ref":"#/components/schemas/PendingAmounts"},"reconciled":{"$ref":"#/components/schemas/PendingAmounts"}}},"PendingAmountsUpdateResponse":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"updated":{"$ref":"#/components/schemas/PendingAmounts"}}},"PendingAmounts":{"type":"object","properties":{"pendingDepositsAmount":{"type":"number","format":"double","example":100.1,"description":"Pending deposit amount. May be lower than expected amount if partner enforces an upper limit."},"pendingDepositsAmountNotAvailable":{"type":"number","format":"double","example":100,"description":"Pending deposit amount withheld due to partner-enforced upper limit."},"pendingDepositsAmountTotal":{"type":"number","format":"double","example":200.1,"description":"Total pending deposit amount."},"pendingRedemptionsAmount":{"type":"number","format":"double","example":100,"description":"Pending redemption amount."},"settlingDepositsAmount":{"type":"number","format":"double","example":100,"description":"Settling deposits amount."}}},"UploadUserPhysicalDocument":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/physicalDocumentID"},"type":{"$ref":"#/components/schemas/physicalDocumentTypes"},"status":{"$ref":"#/components/schemas/physicalDocumentStatusObject"},"side":{"$ref":"#/components/schemas/physicalDocumentSides"}}},"UploadUserPhysicalDocumentReq":{"type":"object","required":["userID","type","document"],"properties":{"userID":{"$ref":"#/components/schemas/userID"},"type":{"$ref":"#/components/schemas/physicalDocumentTypes"},"document":{"$ref":"#/components/schemas/physicalDocumentBase64"},"side":{"$ref":"#/components/schemas/physicalDocumentSides"}}},"GetUserPhysicalDocumentByID":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/fileURL"}}},"Escheatment":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"partner":{"$ref":"#/components/schemas/partner"},"escheatmentDate":{"type":"string","description":"The date the Escheatment was created.","example":"2025-01-01"},"escheatmentStatus":{"type":"string","description":"The status of the Escheatment.","enum":["REVERSED","COMPLETED"],"example":"COMPLETED","x-enumDescriptions":{"REVERSED":"The escheatment was reversed.","COMPLETED":"The escheatment is complete."}},"created":{"$ref":"#/components/schemas/created"},"updated":{"$ref":"#/components/schemas/updated"},"escheatmentStatusHistoryList":{"type":"array","description":"A list of status changes for the Escheatment.","items":{"type":"object","properties":{"status":{"type":"string","description":"The status of the Escheatment.","enum":["REVERSED","COMPLETED"],"example":"COMPLETED","x-enumDescriptions":{"REVERSED":"The escheatment was reversed.","COMPLETED":"The escheatment is complete."}},"escheatmentDate":{"type":"string","description":"The date of the escheatment.","example":"2025-01-01"},"updated":{"$ref":"#/components/schemas/updated"},"updatedBy":{"$ref":"#/components/schemas/updatedBy"},"reversalReason":{"type":"string","description":"The reason for the reversal of the Escheatment.","example":"Account Closed"},"reversalDate":{"type":"string","description":"The date the Escheatment was reversed.","example":"2025-01-01"}}}}}},"CreateEntityRequestModel":{"type":"object","required":["ibID","type","attributes","identifications","contact"],"properties":{"ibID":{"$ref":"#/components/schemas/parentIBID"},"type":{"type":"string","example":"CORPORATION","description":"The type of the entity.","enum":["CORPORATION","LLC","TRUST","PARTNERSHIP"],"x-enumDescriptions":{"CORPORATION":"A corporation.","LLC":"A Limited Liability Company.","TRUST":"A trust.","PARTNERSHIP":"A partnership."}},"subType":{"type":"string","example":"C_CORPORATION","description":"The subtype of the entity. Applicable only when 'type' is 'CORPORATION', 'LLC', or 'PARTNERSHIP'. Valid values by type — CORPORATION: S_CORPORATION, C_CORPORATION; LLC: LLC_SINGLE_MEMBER, LLC_C_CORPORATION, LLC_S_CORPORATION, LLC_PARTNERSHIP; PARTNERSHIP: PARTNERSHIP_GENERAL, PARTNERSHIP_LIMITED; TRUST: SMSF.","enum":["S_CORPORATION","C_CORPORATION","LLC_SINGLE_MEMBER","LLC_C_CORPORATION","LLC_S_CORPORATION","LLC_PARTNERSHIP","PARTNERSHIP_GENERAL","PARTNERSHIP_LIMITED","SMSF"],"x-enumDescriptions":{"S_CORPORATION":"An S corporation.","C_CORPORATION":"A C corporation.","LLC_SINGLE_MEMBER":"A single-member LLC.","LLC_C_CORPORATION":"An LLC taxed as a C corporation.","LLC_S_CORPORATION":"An LLC taxed as an S corporation.","LLC_PARTNERSHIP":"An LLC taxed as a partnership.","PARTNERSHIP_GENERAL":"A general partnership.","PARTNERSHIP_LIMITED":"A limited partnership.","SMSF":"A Self-Managed Super Fund (SMSF) trust."}},"attributes":{"$ref":"#/components/schemas/EntitiesAttributesRequestModel"},"identifications":{"$ref":"#/components/schemas/identifications"},"contact":{"$ref":"#/components/schemas/AddressRequestModel"},"metadata":{"type":"object","example":{"myCustomKey":"myCustomValue"},"description":"Additional metadata for the entity."},"kyb":{"$ref":"#/components/schemas/EntityKybInputModel","type":"object"},"disclosures":{"$ref":"#/components/schemas/EntityDisclosuresModel"},"investorProfile":{"$ref":"#/components/schemas/EntityInvestorProfile"},"financialAffiliations":{"type":"array","items":{"type":"string"},"example":["Bank of Narnia","Gringotts Bank"],"description":"List of financial affiliations."},"industryClassification":{"type":"object","properties":{"NAICS":{"type":"object","properties":{"code":{"type":"integer","example":111110,"description":"The NAICS code representing the industry classification."}}},"OTHER":{"type":"object","properties":{"code":{"type":"string","example":"ENERGY","description":"The industry classification code that is not part of NAICS."}}}},"description":"Industry classification details."}}},"UpdateEntityRequestModel":{"type":"object","description":"Request body for a partial update (PATCH) of an entity. All fields are optional — include only the top-level fields you want to change, and each is applied independently of the others. When a top-level object (for example `attributes` or `contact`) is provided, its own required sub-fields still apply.","properties":{"ibID":{"$ref":"#/components/schemas/parentIBID"},"type":{"type":"string","example":"CORPORATION","description":"The type of the entity.","enum":["CORPORATION","LLC","TRUST","PARTNERSHIP"],"x-enumDescriptions":{"CORPORATION":"A corporation.","LLC":"A Limited Liability Company.","TRUST":"A trust.","PARTNERSHIP":"A partnership."}},"subType":{"type":"string","example":"C_CORPORATION","description":"The subtype of the entity. Required for 'CORPORATION', 'LLC', and 'PARTNERSHIP'; optional for 'TRUST'. Valid values by type — CORPORATION: S_CORPORATION, C_CORPORATION; LLC: LLC_SINGLE_MEMBER, LLC_C_CORPORATION, LLC_S_CORPORATION, LLC_PARTNERSHIP; PARTNERSHIP: PARTNERSHIP_GENERAL, PARTNERSHIP_LIMITED; TRUST: SMSF.","enum":["S_CORPORATION","C_CORPORATION","LLC_SINGLE_MEMBER","LLC_C_CORPORATION","LLC_S_CORPORATION","LLC_PARTNERSHIP","PARTNERSHIP_GENERAL","PARTNERSHIP_LIMITED","SMSF"],"x-enumDescriptions":{"S_CORPORATION":"An S corporation.","C_CORPORATION":"A C corporation.","LLC_SINGLE_MEMBER":"A single-member LLC.","LLC_C_CORPORATION":"An LLC taxed as a C corporation.","LLC_S_CORPORATION":"An LLC taxed as an S corporation.","LLC_PARTNERSHIP":"An LLC taxed as a partnership.","PARTNERSHIP_GENERAL":"A general partnership.","PARTNERSHIP_LIMITED":"A limited partnership.","SMSF":"A Self-Managed Super Fund (SMSF) trust."}},"attributes":{"$ref":"#/components/schemas/EntitiesAttributesRequestModel"},"identifications":{"$ref":"#/components/schemas/identifications"},"contact":{"$ref":"#/components/schemas/AddressRequestModel"},"metadata":{"type":"object","example":{"myCustomKey":"myCustomValue"},"description":"Additional metadata for the entity."},"kyb":{"$ref":"#/components/schemas/EntityKybInputModel","type":"object"},"disclosures":{"$ref":"#/components/schemas/EntityDisclosuresModel"},"investorProfile":{"$ref":"#/components/schemas/EntityInvestorProfile"},"financialAffiliations":{"type":"array","items":{"type":"string"},"example":["Bank of Narnia","Gringotts Bank"],"description":"List of financial affiliations."},"industryClassification":{"type":"object","properties":{"NAICS":{"type":"object","properties":{"code":{"type":"integer","example":111110,"description":"The NAICS code representing the industry classification."}}},"OTHER":{"type":"object","properties":{"code":{"type":"string","example":"ENERGY","description":"The industry classification code that is not part of NAICS."}}}},"description":"Industry classification details."}}},"EntityResponseModel":{"type":"object","description":"Entity representation returned by the API. Note the key casing differs from the request body: `identifications` keys are returned uppercase (EIN, FTIN, GIIN, FTNLO, SSN) and address types are returned uppercase (PRIMARY), whereas requests use lowercase (ein, ftin, ..., primary).","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000168","description":"The unique identifier of the entity."},"ibID":{"$ref":"#/components/schemas/parentIBID"},"wlpID":{"type":"string","example":"DW","description":"The WLP identifier of the entity."},"type":{"type":"string","example":"CORPORATION","description":"The type of the entity.","enum":["CORPORATION","LLC","TRUST","PARTNERSHIP"],"x-enumDescriptions":{"CORPORATION":"A corporation.","LLC":"A Limited Liability Company.","TRUST":"A trust.","PARTNERSHIP":"A partnership."}},"subType":{"type":"string","example":"C_CORPORATION","description":"The subtype of the entity.","enum":["S_CORPORATION","C_CORPORATION","LLC_SINGLE_MEMBER","LLC_C_CORPORATION","LLC_S_CORPORATION","LLC_PARTNERSHIP","PARTNERSHIP_GENERAL","PARTNERSHIP_LIMITED","SMSF"],"x-enumDescriptions":{"S_CORPORATION":"An S corporation.","C_CORPORATION":"A C corporation.","LLC_SINGLE_MEMBER":"A single-member LLC.","LLC_C_CORPORATION":"An LLC taxed as a C corporation.","LLC_S_CORPORATION":"An LLC taxed as an S corporation.","LLC_PARTNERSHIP":"An LLC taxed as a partnership.","PARTNERSHIP_GENERAL":"A general partnership.","PARTNERSHIP_LIMITED":"A limited partnership.","SMSF":"A Self-Managed Super Fund (SMSF) trust."}},"attributes":{"$ref":"#/components/schemas/EntitiesAttributesRequestModel"},"identifications":{"$ref":"#/components/schemas/IdentificationsResponse"},"contact":{"$ref":"#/components/schemas/AddressResponseModel"},"metadata":{"type":"object","example":{"myCustomKey":"myCustomValue"},"description":"Additional metadata for the entity."},"disclosures":{"$ref":"#/components/schemas/EntityDisclosuresModel"},"financialAffiliations":{"type":"array","items":{"type":"string"},"example":["Bank of Narnia","Gringotts Bank"],"description":"List of financial affiliations."},"industryClassification":{"type":"object","properties":{"NAICS":{"type":"object","properties":{"code":{"type":"integer","example":111110,"description":"The NAICS code representing the industry classification."}}},"OTHER":{"type":"object","properties":{"code":{"type":"string","example":"ENERGY","description":"The industry classification code that is not part of NAICS."}}}},"description":"Industry classification details."},"directors":{"type":"array","items":{"$ref":"#/components/schemas/EntityDirectorsResponseModel"},"description":"A list of directors of the entity."},"taxData":{"$ref":"#/components/schemas/TaxData"},"investorProfile":{"$ref":"#/components/schemas/EntityInvestorProfile"},"kyb":{"$ref":"#/components/schemas/EntityKybResponseModel"},"tax":{"type":"object","properties":{"status":{"type":"string","example":"TAX_READY","description":"The tax status of the entity."},"message":{"type":"string","example":"Entity is ready for tax processing","description":"A message providing additional information about the tax status."}}},"status":{"$ref":"#/components/schemas/businessStatus"},"createdAt":{"type":"string","example":"2024-12-12T02:40:18.452756Z","description":"The date and time when the entity was created."},"updatedAt":{"type":"string","example":"2024-12-16T22:51:23.340323Z","description":"The date and time when the entity was last updated."},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000066","description":"The user who created the entity."},"updatedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000066","description":"The user who last updated the entity."}}},"TaxData":{"type":"object","properties":{"fatcaData":{"$ref":"#/components/schemas/FATCAData"},"vendor":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Vendor"},"example":{"COMPLY_EXCHANGE":{"name":"Comply Exchange","taxFormUrl":"www.tax.com","formUrlDate":"2023-11-01T12:34:56Z"}},"description":"A map of vendor name to vendor information."},"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TaxInformation"},"example":{"W8BENE":{"formType":"W8BENE","status":"TAX_APPROVED","statusWhen":"2025-09-29T17:28:31.047Z","statusBy":"COMPLY_EXCHANGE","receivedFrom":"Comply Exchange","receivedWhen":"2025-09-29T17:28:31.047Z","expiresWhen":"2028-12-31","taxTreatyBenefitClaimed":true,"chapter3StatusW8":"CORPORATION","chapter4StatusW8":"ACTIVE_NFFE","chapter3Status1042S":"15","chapter4Status1042S":"22"}},"description":"A map of tax status code to tax information."}}},"FATCAData":{"type":"object","properties":{"applicable":{"type":"boolean","example":true,"description":"Indicates if FATCA data is applicable."},"applicableFrom":{"type":"string","example":"2024-12-12T02:40:18.421371Z","description":"The date and time when FATCA data became applicable."},"setBy":{"type":"string","example":"SYSTEM","description":"The source that set the FATCA data."}}},"Vendor":{"type":"object","properties":{"name":{"type":"string","example":"Comply Exchange","description":"The name of the vendor."},"taxFormUrl":{"type":"string","example":"www.tax.com","description":"The URL to the tax form."},"formUrlDate":{"type":"string","example":"2023-11-01T12:34:56Z","description":"The date when the URL was set."}}},"TaxInformation":{"type":"object","properties":{"formType":{"$ref":"#/components/schemas/taxStatusCode"},"status":{"type":"string","example":"TAX_READY","description":"The status of the tax information."},"statusWhen":{"type":"string","example":"2024-08-08","description":"The date and time when the status was set."},"statusBy":{"type":"string","example":"COMPLY_EXCHANGE","description":"The entity that set the status."},"statusMessage":{"type":"string","example":"tax form received","description":"The message associated with the status."},"receivedFrom":{"type":"string","example":"Comply Exchange","description":"The entity from which the information was received."},"receivedWhen":{"type":"string","example":"2014-10-19","description":"The date and time when the information was received."},"expiresWhen":{"type":"string","example":"2027-10-18","description":"The date and time when the information expires."},"taxTreatyBenefitClaimed":{"type":"boolean","example":true,"description":"Indicates if a tax treaty benefit was claimed."},"chapter3Status":{"$ref":"#/components/schemas/taxRecipientCode"},"chapter4Status":{"$ref":"#/components/schemas/factaStatus"}}},"EntityDirectorsResponseModel":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000065","description":"The ID of the director"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/directorRoleType"},"description":"List of director roles"},"title":{"type":"string","example":"DevDirector","description":"Title of the director"},"firstName":{"type":"string","example":"Manoj","description":"First name of the director"},"lastName":{"type":"string","example":"Krishna","description":"Last name of the director"},"percentage":{"type":"number","example":0.25,"description":"The percentage of ownership the director has in the institution. Value must be greater than 0 and up to 1 (representing 0-100%), with a maximum of 2 decimal places."},"controlContact":{"type":"boolean","example":true,"description":"Indicates if the director is a control contact."},"kycStatus":{"$ref":"#/components/schemas/kycProcessStatus"}}},"EntitiesAttributesRequestModel":{"type":"object","required":["name","incorporationCountry"],"properties":{"name":{"type":"string","example":"Better Investment","description":"The name of the entity."},"dba":{"type":"string","example":"BI","description":"The doing business as (DBA) name of the entity."},"incorporationCountry":{"type":"string","example":"USA","description":"The country of incorporation."},"incorporationProvince":{"type":"string","example":"NY","description":"The province or state of incorporation."},"incorporationDate":{"type":"string","format":"date","example":"2019-01-01","description":"The date of incorporation."}}},"AddressType":{"type":"string","example":"primary","description":"The address type.","enum":["primary"],"x-enumDescriptions":{"primary":"The entity's primary address."}},"PrimaryAddressRequestModel":{"type":"object","required":["street1","city","province","zipcode","country"],"properties":{"street1":{"type":"string","example":"105 Main Street","description":"The first line of the street address."},"street2":{"type":"string","example":"suite 101","description":"The second line of the street address."},"city":{"type":"string","example":"Wilmington","description":"The city of the address."},"province":{"type":"string","example":"DE","description":"The province of the address."},"zipcode":{"type":"string","example":"19801","description":"The postal code of the address."},"country":{"type":"string","example":"USA","description":"The country of the address."}}},"AddressRequestModel":{"type":"object","required":["addresses","phone","email"],"properties":{"addresses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PrimaryAddressRequestModel"},"example":{"primary":{"street1":"123 Main Street","street2":"suite 101","city":"Wilmington","province":"DE","zipcode":"19801","country":"USA"}},"description":"A map of address type to address details."},"phone":{"type":"string","example":"+15555550100","description":"The phone number associated with the entity in E.164 format."},"email":{"type":"string","example":"hello@example.com","description":"The email address associated with the entity."},"website":{"type":"string","example":"www.acme.com","description":"The website associated with the entity."}}},"AddressResponseModel":{"type":"object","description":"Contact details as returned in responses. Address types are keyed uppercase (e.g. PRIMARY), unlike the lowercase keys used in requests.","required":["addresses","phone","email"],"properties":{"addresses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PrimaryAddressRequestModel"},"example":{"PRIMARY":{"street1":"123 Main Street","street2":"suite 101","city":"Wilmington","province":"DE","zipcode":"19801","country":"USA"}},"description":"A map of address type to address details. Keys are returned uppercase (e.g. PRIMARY)."},"phone":{"type":"string","example":"+15555550100","description":"The phone number associated with the entity in E.164 format."},"email":{"type":"string","example":"hello@example.com","description":"The email address associated with the entity."},"website":{"type":"string","example":"www.acme.com","description":"The website associated with the entity."}}},"IdentificationsResponse":{"type":"object","description":"Entity identification numbers as returned in responses. Keys are uppercase, unlike the lowercase keys used in requests.","properties":{"EIN":{"type":"string","description":"The Employer Identification Number of the entity.","example":"12-3456789"},"FTIN":{"type":"string","description":"The Foreign Tax Identification Number of the entity.","example":"12-3456789"},"GIIN":{"type":"string","description":"The Global Intermediary Identification Number of the entity.","example":"123456.12345.12.12.123"},"FTNLO":{"type":"boolean","description":"indicates if FTIN is not legally required for the entity.","example":false},"SSN":{"type":"string","description":"Social Security Number of the grantor for trust entity (must be exactly 9 digits with no hyphens).","example":"900123456","pattern":"^\\d{9}$"}}},"DisclosureRequestModel":{"type":"object","properties":{"agreed":{"type":"boolean","example":true,"description":"Indicates if the disclosure has been agreed to."},"signedBy":{"type":"string","example":"John Doe","description":"The name of the person who signed the disclosure."},"signedWhen":{"type":"string","example":"2024-09-09T15:20:05Z","description":"The date and time when the disclosure was signed."}}},"EntityKybInputModel":{"type":"object","properties":{"status":{"type":"string","enum":["KYB_APPROVED","KYB_DENIED"],"example":"KYB_APPROVED","description":"The KYB status of the entity.","x-enumDescriptions":{"KYB_APPROVED":"KYB was approved.","KYB_DENIED":"KYB was denied."}},"statusWhen":{"type":"string","example":"2024-09-09T15:20:05Z","description":"The date and time when the KYB was done."},"verificationKey":{"type":"string","example":"VERIFICATION_KEY_12345","description":"The verification key provided by the KYB vendor."}}},"EntityKybResponseModel":{"type":"object","properties":{"status":{"type":"string","example":"KYB_APPROVED","description":"The KYB status of the entity."},"statusWhen":{"type":"string","example":"2024-09-09T15:20:05Z","description":"The date and time when the KYB was done."},"verificationKey":{"type":"string","example":"VERIFICATION_KEY_12345","description":"The verification key provided by the KYB vendor."},"statusBy":{"type":"string","example":"{{partner ID}}","description":"The UUID of who set the KYB status."},"reasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"P201","description":"The reason code for the KYB status."},"description":{"type":"string","example":"KYB has been approved based on information provided by the partner.","description":"A descriptive message about the reason."}}},"description":"A list of reasons associated with the KYB status."}}},"EntityDisclosuresModel":{"type":"object","properties":{"termsOfUse":{"$ref":"#/components/schemas/DisclosureRequestModel"},"customerAgreement":{"$ref":"#/components/schemas/DisclosureRequestModel"},"rule14b":{"$ref":"#/components/schemas/DisclosureRequestModel"},"extendedHoursAgreement":{"$ref":"#/components/schemas/DisclosureRequestModel"},"marginAgreement":{"$ref":"#/components/schemas/DisclosureRequestModel"},"fpslAgreement":{"$ref":"#/components/schemas/DisclosureRequestModel"},"privacyPolicy":{"$ref":"#/components/schemas/DisclosureRequestModel"}}},"MonthlyTransactionAmount":{"type":"string","example":"$50K_TO_$250K","description":"Anticipated monthly transaction volumes in dollar amount per instrument.","enum":["UNDER_$1K","$1K_TO_$10K","$10K_TO_$50K","$50K_TO_$250K","$250K_TO_$1M","OVER_$1M"],"x-enumDescriptions":{"UNDER_$1K":"Under $1,000.","$1K_TO_$10K":"$1,000 to $10,000.","$10K_TO_$50K":"$10,000 to $50,000.","$50K_TO_$250K":"$50,000 to $250,000.","$250K_TO_$1M":"$250,000 to $1,000,000.","OVER_$1M":"Over $1,000,000."}},"InvestmentExperience":{"type":"string","example":"YRS_5_10","description":"The investment experience in years.","enum":["NONE","YRS_1_2","YRS_3_5","YRS_5_10","YRS_10_"],"x-enumDescriptions":{"NONE":"None.","YRS_1_2":"1-2 years.","YRS_3_5":"3-5 years.","YRS_5_10":"5-10 years.","YRS_10_":"10+ years."}},"EntityInvestorProfile":{"type":"object","properties":{"annualRevenue":{"type":"number","minimum":0,"example":1000000,"description":"The annual revenue of the entity in USD."},"netWorthTotal":{"type":"number","minimum":0,"example":5000000,"description":"The total net worth of the entity in USD."},"investmentObjective":{"type":"string","example":"GROWTH","description":"The investment objective of the entity.","enum":["CAPITAL_PRESERVATION","INCOME","GROWTH","SPECULATION"],"x-enumDescriptions":{"CAPITAL_PRESERVATION":"Capital preservation.","INCOME":"Income.","GROWTH":"Growth.","SPECULATION":"Speculation."}},"riskTolerance":{"type":"string","example":"HIGH","description":"The risk tolerance of the entity.","enum":["LOW","MODERATE","HIGH","SPECULATION"],"x-enumDescriptions":{"LOW":"Low risk tolerance.","MODERATE":"Moderate risk tolerance.","HIGH":"High risk tolerance.","SPECULATION":"Speculative risk tolerance."}},"liquidityNeeds":{"type":"string","example":"LOW","description":"The degree to which the entity requires the ability to quickly and easily convert investments into cash without significant loss of value, penalties, or costs.","enum":["IMMEDIATE","SHORT_TERM","MODERATE_TERM","LONG_TERM"],"x-enumDescriptions":{"IMMEDIATE":"Funds may be needed immediately.","SHORT_TERM":"Funds may be needed in the short term.","MODERATE_TERM":"Funds may be needed in the moderate term.","LONG_TERM":"Funds are not needed for the long term."}},"investmentExperience":{"$ref":"#/components/schemas/InvestmentExperience"},"timeHorizon":{"type":"string","example":"LONG_TERM","description":"Expected investment duration","enum":["SHORT_TERM","MEDIUM_TERM","LONG_TERM"],"x-enumDescriptions":{"SHORT_TERM":"A short investment time horizon.","MEDIUM_TERM":"A medium investment time horizon.","LONG_TERM":"A long investment time horizon."}},"equities":{"type":"object","properties":{"monthlyTransactionAmount":{"$ref":"#/components/schemas/MonthlyTransactionAmount"},"investmentExperience":{"$ref":"#/components/schemas/InvestmentExperience"}},"description":"Equity investment profile"},"fixedIncome":{"type":"object","properties":{"monthlyTransactionAmount":{"$ref":"#/components/schemas/MonthlyTransactionAmount"},"investmentExperience":{"$ref":"#/components/schemas/InvestmentExperience"}}}}},"disclosureID":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-000000000061","description":"The id of a disclosure"},"disclosureName":{"type":"string","pattern":"^[a-zA-Z0-9_]+$","example":"OPTIONS_AGREEMENT_V1","description":"The name of the disclosure"},"documentID":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-000000000061","description":"The id of a document"},"url":{"type":"string","format":"url","example":"https://d111111abcdef8.cloudfront.net/xxxxcxxx-yyyy-zzzz-wwww-wwwwwwwwwwww.jpeg?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZDExMTExMWFiY2RlZjguY2xvdWRmcm9udC5uZXQveHh4eGN4eHgteXl5eS16enp6LXd3d3ctd3d3d3d3d3d3d3d3LmpwZWciLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjEyMzQ1Njc4OTB9LCJJcEFkZHJlc3MiOnsiQVdTOlNvdXJjZUlwIjoiMC4wLjAuMC8wIn19fV19&Signature=EXAMPLEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&Key-Pair-Id=APKAEXAMPLE00000000","description":"The url of the disclosure document"},"version":{"type":"string","format":"^[0-9]{1,3}([.])[0-9]{1,3}([.])[0-9]{1,3}$","example":"1.1.0","description":"Version of the disclosure"},"obligation":{"type":"string","example":"DELIVERY","description":"Indicates the legal obligation of the disclosure","enum":["ACKNOWLEDGE","DELIVERY"],"x-enumDescriptions":{"ACKNOWLEDGE":"The user must acknowledge receipt of the disclosure.","DELIVERY":"The disclosure only needs to be delivered, not acknowledged."}},"effectiveDate":{"type":"string","format":"date","pattern":"yyyy-MM-dd","example":"2023-06-14","description":"Indicates the effective date of the disclosure"},"product":{"type":"string","example":"EQUITY","description":"The applicable product if the disclosure is product specific","enum":["ALL","EQUITY","CRYPTO","MUTUAL_FUNDS","DRIVEHUB"],"x-enumDescriptions":{"ALL":"Applies to all products.","EQUITY":"Applies to equity trading.","CRYPTO":"Applies to crypto trading.","MUTUAL_FUNDS":"Applies to mutual fund trading.","DRIVEHUB":"Applies to the DriveHub product."}},"subProduct":{"type":"string","example":"OPTIONS","description":"The applicable sub product within the product if the disclosure is sub product specific","enum":["ALL","OPTIONS","REINVESTMENT","OMNI_OPTIONS","TERMS","MARGIN"],"x-enumDescriptions":{"ALL":"Applies to all sub-products.","OPTIONS":"Applies to options trading.","REINVESTMENT":"Applies to dividend reinvestment.","OMNI_OPTIONS":"Applies to Omni options trading.","TERMS":"Applies to terms and conditions acceptance.","MARGIN":"Applies to margin trading."}},"status":{"type":"string","example":"ACTIVE","description":"A disclosure can be active or no longer supported","enum":["ACTIVE","INACTIVE"],"x-enumDescriptions":{"ACTIVE":"The disclosure is currently in effect.","INACTIVE":"The disclosure is no longer supported."}},"acknowledged":{"type":"boolean","example":true,"description":"Indicates whether the end user acknowledged or declined the disclosure agreement"},"signedAt":{"type":"string","format":"timestamp","example":"2023-06-14T15:07:24Z","description":"Timestamp of when the customer acknowledged or declined the disclosure agreement"},"Disclosure":{"type":"object","properties":{"disclosureID":{"$ref":"#/components/schemas/disclosureID"},"name":{"$ref":"#/components/schemas/disclosureName"},"documentID":{"$ref":"#/components/schemas/documentID"},"url":{"$ref":"#/components/schemas/url"},"version":{"$ref":"#/components/schemas/version"},"obligation":{"$ref":"#/components/schemas/obligation"},"effectiveDate":{"$ref":"#/components/schemas/effectiveDate"},"product":{"$ref":"#/components/schemas/product"},"subProduct":{"$ref":"#/components/schemas/subProduct"},"status":{"$ref":"#/components/schemas/status"},"created":{"$ref":"#/components/schemas/created"},"updated":{"$ref":"#/components/schemas/updated"}}},"Acknowledgment":{"type":"object","properties":{"disclosureID":{"$ref":"#/components/schemas/disclosureID"},"acknowledged":{"$ref":"#/components/schemas/acknowledged"},"signedAt":{"$ref":"#/components/schemas/signedAt"}}},"CreateDisclosureInput":{"type":"object","required":["name","documentID","version","obligation","effectiveDate","product","subProduct","status"],"properties":{"name":{"$ref":"#/components/schemas/disclosureName"},"documentID":{"$ref":"#/components/schemas/documentID"},"version":{"$ref":"#/components/schemas/version"},"obligation":{"$ref":"#/components/schemas/obligation"},"effectiveDate":{"$ref":"#/components/schemas/effectiveDate"},"product":{"$ref":"#/components/schemas/product"},"subProduct":{"$ref":"#/components/schemas/subProduct"},"status":{"$ref":"#/components/schemas/status"}}},"CreateDisclosureOutput":{"$ref":"#/components/schemas/Disclosure"},"UpdateDisclosureInput":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/disclosureName"},"documentID":{"$ref":"#/components/schemas/documentID"},"version":{"$ref":"#/components/schemas/version"},"obligation":{"$ref":"#/components/schemas/obligation"},"effectiveDate":{"$ref":"#/components/schemas/effectiveDate"},"product":{"$ref":"#/components/schemas/product"},"subProduct":{"$ref":"#/components/schemas/subProduct"},"status":{"$ref":"#/components/schemas/status"}}},"UpdateDisclosureOutput":{"$ref":"#/components/schemas/Disclosure"},"CreateAcknowledgmentInput":{"$ref":"#/components/schemas/Acknowledgment","required":["disclosureID","signedAt","acknowledged"]},"ListOfDisclosures":{"type":"object","description":"A list of disclosures","properties":{"disclosures":{"type":"array","items":{"$ref":"#/components/schemas/Disclosure"}}}},"ListOfAcknowledgments":{"type":"object","description":"A list of disclosure acknowledgments","properties":{"acknowledgments":{"type":"array","items":{"$ref":"#/components/schemas/Acknowledgment"}}}},"ListOfAllowedCountry":{"type":"object","properties":{"id":{"type":"string","example":"ALA","description":"The abbreviated identifier of a country."},"name":{"type":"string","example":"Aland Islands","description":"The full name of the country"},"code2":{"type":"string","example":"AX","description":"An alternative abbreviated identifier of a country."},"code3":{"type":"string","example":"ALA","description":"An alternative abbreviated identifier of a country."},"active":{"type":"boolean","example":true,"description":"True, if a user can be onboarded from this country."},"expatsAllowed":{"type":"boolean","example":false,"description":"True, if a user who resides outside of their country can be onboarded from the listed country."},"foreignTINNotRequired":{"type":"boolean","example":false,"description":"True, if a user's tax identifier is NOT required during onboarding."},"fpslProhibited":{"type":"boolean","example":false},"supportDomicile":{"type":"boolean","example":false},"taxTreatyCountry":{"type":"boolean","example":false,"description":"True, if the country has a tax treaty with the United States."}}},"ListOfAllowedCountries":{"type":"array","description":"A list of allowed countries.","items":{"oneOf":[{"$ref":"#/components/schemas/ListOfAllowedCountry"}]}},"BidPrice":{"type":"object","description":"Bid Price","example":{"bidPrice":98.992,"bidSize":10000,"bidYield":4.799,"minQty":150},"properties":{"bidPrice":{"type":"number","format":"double","example":130.529,"description":"Bid value","readOnly":true},"bidSize":{"type":"number","format":"double","example":150,"description":"Bid size","readOnly":true},"bidYield":{"type":"number","format":"double","example":4.799,"description":"Bid yield","readOnly":true},"minQty":{"type":"number","format":"double","example":150,"description":"Minimum quantity","readOnly":true}}},"AskPrice":{"type":"object","description":"Ask Price","example":{"askPrice":98.992,"askSize":10000,"askYield":4.799,"minQty":150},"properties":{"askPrice":{"type":"number","format":"double","example":98.884,"description":"Ask value","readOnly":true},"askSize":{"type":"number","format":"double","example":150,"description":"Ask size","readOnly":true},"askYield":{"type":"number","format":"double","example":4.793,"description":"Ask yield","readOnly":true},"minQty":{"type":"number","format":"double","example":150,"description":"Minimum quantity","readOnly":true}}},"RecentTrade":{"type":"object","description":"Recent Trade","properties":{"price":{"type":"number","format":"double","example":98.884,"description":"Trade price"},"quantity":{"type":"number","format":"double","example":150,"description":"Trade size/quantity"},"yield":{"type":"number","format":"double","example":4.793,"description":"Trade yield"},"date":{"type":"string","format":"date-time","description":"Asset's trade time.","example":"2017-07-21T17:32:28Z"},"side":{"type":"string","example":"sell","description":"The side of order that is being placed.","enum":["buy","sell"],"x-enumDescriptions":{"buy":"A buy order.","sell":"A sell order."}}},"example":{"price":98.992,"size":10000,"yield":4.799,"side":"buy","dateTime":"2017-07-21T17:32:28Z"}},"MarketQuoteRequest":{"type":"object","description":"Trade Quote Request for Fixed Income Securities","required":["instrumentID","quantity"],"properties":{"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"quantity":{"type":"number","format":"double","example":3.14,"description":"The quantity of bonds user wishes to trade.","minimum":0},"salesCredit":{"$ref":"#/components/schemas/SalesCredit"}}},"MarketQuoteResponse":{"type":"object","description":"Trade Quote Response for Fixed Income Orders","example":{"MarketQuoteResponseSuccess":{"id":"123e4567-e89b-12d3-a456-000000000147","instrumentID":"123e4567-e89b-12d3-a456-000000000144","ISIN":"US459058GX53","CUSIP":"US6174464486","salesCredit":{"currency":"USD","amount":14},"bidPrices":[{"bidPrice":98.992,"bidSize":10000,"bidYield":4.799}],"askPrices":[{"askPrice":98.992,"askSize":10000,"askYield":4.799,"minQty":150}],"effectiveBidPrices":[{"bidPrice":98.992,"bidSize":10000,"bidYield":4.799,"minQty":112}],"effectiveAskPrices":[{"askPrice":98.992,"askSize":10000,"askYield":4.799,"minQty":150}],"recentTrades":[{"price":98.992,"size":10000,"yield":4.799,"side":"buy","date":"2017-07-21T17:32:28Z"}]}},"properties":{"id":{"type":"string","description":"Quote id in the DriveWealth System","format":"uuid","example":"123e4567-e89b-12d3-a456-000000000147","readOnly":true},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN","readOnly":true},"CUSIP":{"$ref":"#/components/schemas/instrumentCUSIP","readOnly":true},"quantity":{"type":"number","format":"double","example":150,"description":"Trade size/quantity"},"salesCredit":{"$ref":"#/components/schemas/SalesCredit"},"bidPrices":{"type":"array","description":"bid prices without sales credit","items":{"$ref":"#/components/schemas/BidPrice"}},"askPrices":{"type":"array","description":"ask prices without sales credit","items":{"$ref":"#/components/schemas/AskPrice"}},"effectiveBidPrices":{"type":"array","description":"prices include any sales credit provided in the request","items":{"$ref":"#/components/schemas/BidPrice"}},"effectiveAskPrices":{"type":"array","description":"prices include any sales credit provided in the request","items":{"$ref":"#/components/schemas/AskPrice"}},"recentTrades":{"type":"array","description":"Recent Trades","items":{"$ref":"#/components/schemas/RecentTrade"}}}},"NBBO":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"bid":{"$ref":"#/components/schemas/bidPrice"},"ask":{"$ref":"#/components/schemas/askPrice"},"open":{"$ref":"#/components/schemas/openPrice"},"high":{"$ref":"#/components/schemas/highPrice"},"low":{"$ref":"#/components/schemas/lowPrice"},"timeOffset":{"type":"number","example":"1234567890193"},"volume":{"type":"number","example":2779731,"description":"The total trading volume of the security for the current day in quantity of shares."},"askSize":{"type":"number","example":3,"description":"The ask size is the number of shares investors are trying to sell at a given price for a particular security."},"bidSize":{"type":"number","example":4,"description":"The bid size is the number of shares investors are trying to buy at a given price for a particular security."},"change":{"type":"number","example":-1.33,"description":"The percentage change in trade price relative to the previous days close."},"lastTradeExchange":{"type":"string","example":"DX","description":"The last exchange the symbol was traded on."},"bestBidExchange":{"type":"string","example":"N","description":"The exchange that is offering the best bid for the current symbol."},"bestAskExchange":{"type":"string","example":"Q","description":"The exchange that is offering best ask for the symbol."},"lastTrade":{"type":"number","example":86.47,"description":"The NBBO quote of the most recent trade."},"lastTradeSize":{"type":"number","example":2,"description":"The quantity of shares of the last trade."},"marketCondition":{"type":"string","example":"NORMAL","description":"The trading status of the symbol.","enum":["NORMAL","TRADING_HALT","UNKNOWN"],"x-enumDescriptions":{"NORMAL":"The symbol is trading normally.","TRADING_HALT":"Trading in the symbol is halted.","UNKNOWN":"The trading status is unknown."}},"tradeCount":{"type":"number","example":29565,"description":"The number of trades placed for the symbol during the current trading day."},"close":{"type":"number","example":0,"description":"The close price populated after market close, price updates overnight if a corporate action occurs."},"priorClose":{"type":"number","example":86.86,"description":"The closing price of the current symbol for the prior trading day."}}},"Referential":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EquityQuote"},{"$ref":"#/components/schemas/FixedIncomeQuote"}]}},"EquityQuote":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"bid":{"$ref":"#/components/schemas/bidPrice"},"ask":{"$ref":"#/components/schemas/askPrice"},"lastTrade":{"type":"number","example":86.47,"description":"The NBBO quote of the most recent trade."},"change":{"type":"number","example":-1.33,"description":"The percentage change in trade price relative to the previous days close."},"open":{"$ref":"#/components/schemas/openPrice"},"high":{"$ref":"#/components/schemas/highPrice"},"low":{"$ref":"#/components/schemas/lowPrice"},"close":{"type":"number","example":0,"description":"The close price populated after market close, price updates overnight if a corporate action occurs."},"priorClose":{"type":"number","example":86.86,"description":"The closing price of the current symbol for the prior trading day."},"volume":{"type":"number","example":2779731,"description":"The total trading volume of the security for the current day in quantity of shares."},"marketCondition":{"type":"string","example":"NORMAL","description":"The trading status of the symbol.","enum":["NORMAL","TRADING_HALT","UNKNOWN"],"x-enumDescriptions":{"NORMAL":"The symbol is trading normally.","TRADING_HALT":"Trading in the symbol is halted.","UNKNOWN":"The trading status is unknown."}},"dataProvider":{"type":"string","example":"NYSE","description":"The exchange venue providing the quote."}}},"FixedIncomeQuote":{"type":"array","properties":{"instrumentID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000143","description":"The unique identifier of the instrument."},"isin":{"type":"string","example":"US912810RC45","description":"The International Securities Identification Number (ISIN) of the instrument."},"bidYield":{"type":"number","example":4.220776,"description":"The yield at which the buyer is willing to buy the security."},"askYield":{"type":"number","example":4.207803,"description":"The yield at which the seller is willing to sell the security."},"bid":{"type":"number","example":92.276,"description":"The price at which the buyer is willing to buy the security."},"ask":{"type":"number","example":92.436,"description":"The price at which the seller is willing to sell the security."},"priorClose":{"type":"number","example":92.3085938,"description":"The closing price of the current symbol for the prior trading day."},"askSize":{"type":"number","example":0,"description":"The ask size is the number of shares investors are trying to sell at a given price for a particular security."},"bidSize":{"type":"number","example":0,"description":"The bid size is the number of shares investors are trying to buy at a given price for a particular security."},"lastTradeSize":{"type":"number","example":0,"description":"The quantity of shares of the last trade."},"tradeCount":{"type":"number","example":0,"description":"The number of trades placed for the symbol during the current trading day."},"marketCondition":{"type":"string","example":"NORMAL","description":"The trading status of the symbol.","enum":["NORMAL","TRADING_HALT","UNKNOWN"],"x-enumDescriptions":{"NORMAL":"The symbol is trading normally.","TRADING_HALT":"Trading in the symbol is halted.","UNKNOWN":"The trading status is unknown."}},"dataProvider":{"type":"string","example":"ICE BondPoint","description":"The exchange venue providing the quote."},"timeOffset":{"type":"number","example":0}}},"Bars":{"type":"object","properties":{"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"compression":{"type":"number","example":9,"description":"The compression value represents the time increments of the chart data. Refer to the compression table for the value descriptions.","enum":[0,1,4,8,9,10],"x-enumDescriptions":{"0":"Daily.","1":"1 minute.","4":"5 minutes.","8":"30 minutes.","9":"1 hour.","10":"Weekly."}},"dateStart":{"type":"string","example":"2022-11-10T00:00:00Z","description":"The start date of the chart data."},"dateEnd":{"type":"string","example":"2022-11-18T23:59:00Z","description":"The end date of the chart data."},"data":{"type":"string","example":"2022-11-10T15:00:00Z,86.87,87.96,86.78,87.91,95568|2022-11-10T16:00:00Z,87.875,87.96,86.9,87.36,107004|2022-11-10T17:00:00Z,87.41,88.09,87.27,88.03,85171|2022-11-10T18:00:00Z,88.03,88.12,87.755,87.755,44808|2022-11-10T19:00:00Z,87.74,88.35,87.74,88.28,45755|2022-11-10T20:00:00Z,88.27,88.47,88.12,88.46,44391|2022-11-10T21:00:00Z,88.44,88.98,88.4,88.79,177251|2022-11-11T15:00:00Z,89.15,90.22,89.13,90.19,65167|2022-11-11T16:00:00Z,90.15,91.68,89.81,91.35,122906|2022-11-11T17:00:00Z,91.47,91.51,90.01,90.26,60692|2022-11-11T18:00:00Z,90.22,90.31,89.895,90.28,34462|2022-11-11T19:00:00Z,90.28,90.9,90.28,90.9,33509|2022-11-11T20:00:00Z,90.93,91.44,90.91,91.38,72687|2022-11-11T21:00:00Z,91.37,91.37,90.7,90.79,123926|2022-11-14T15:00:00Z,90.11,90.62,89.97,90.23,28369|2022-11-14T16:00:00Z,90.4,90.62,90.02,90.45,50923|2022-11-14T17:00:00Z,90.47,90.63,90.05,90.33,37863|2022-11-14T18:00:00Z,90.4,90.9,90.27,90.86,34006|2022-11-14T19:00:00Z,90.85,91.345,90.85,91.345,28538|2022-11-14T20:00:00Z,91.33,91.35,90.7,90.77,40253|2022-11-14T21:00:00Z,90.72,90.85,89.79,89.82,52283|2022-11-15T15:00:00Z,91.06,91.83,90.77,91.49,67238|2022-11-15T16:00:00Z,91.5,91.69,91.06,91.06,67885|2022-11-15T17:00:00Z,91.01,91.35,90.9,90.97,36514|2022-11-15T18:00:00Z,91.02,91.06,90.68,90.89,33116|2022-11-15T19:00:00Z,90.88,90.96,89.39,90.03,68627|2022-11-15T20:00:00Z,89.99,90.82,89.82,90.585,71247|2022-11-15T21:00:00Z,90.63,90.71,90.2,90.485,81118|2022-11-16T15:00:00Z,90.22,90.34,89.81,89.89,34416|2022-11-16T16:00:00Z,89.915,90.31,89.42,89.43,55055|2022-11-16T17:00:00Z,89.43,89.83,89.08,89.83,40326|2022-11-16T18:00:00Z,89.82,90.08,89.6,89.86,24222|2022-11-16T19:00:00Z,89.77,89.77,89.56,89.56,22107|2022-11-16T20:00:00Z,89.54,89.82,89.47,89.77,28389|2022-11-16T21:00:00Z,89.75,89.91,89.43,89.82,65605|2022-11-17T15:00:00Z,88.6,88.76,87.58,87.58,27525|2022-11-17T16:00:00Z,87.56,88.24,87.53,87.83,77796|2022-11-17T17:00:00Z,87.81,88.46,87.78,88.43,49492|2022-11-17T18:00:00Z,88.59,89.06,88.52,89.05,25378|2022-11-17T19:00:00Z,89.07,89.07,88.75,88.78,21474|2022-11-17T20:00:00Z,88.79,88.9,88.56,88.68,27020|2022-11-17T21:00:00Z,88.66,88.97,88.37,88.95,62714|2022-11-18T15:00:00Z,90.27,90.28,89.49,89.55,21160|2022-11-18T16:00:00Z,89.57,89.57,89.16,89.21,44798|2022-11-18T17:00:00Z,89.23,89.46,89.06,89.17,28915|2022-11-18T18:00:00Z,89.18,89.18,88.6,88.82,38268|2022-11-18T19:00:00Z,88.85,89.23,88.81,88.94,19097|2022-11-18T20:00:00Z,89.0,89.39,89.0,89.2,45037|2022-11-18T21:00:00Z,89.19,89.53,88.96,89.23,93566","description":"The `data` attribute holds each chart value separated by a pipe '|'. Each data set is preceded by the date, followed by the pricing data in the following order: Open, High, Low, Close, Volume."}}},"FixHeader":{"type":"object","description":"Standard FIX header. All FIX messages must include this section; all tags within it are required, except DeliverToCompID<128>, which is required only for Bloomberg EMSxNet/FixNet connections.","required":["beginString","bodyLength","msgSeqNum","msgType","senderCompID","sendingTime","targetCompID"],"properties":{"beginString":{"type":"string","x-fix-tag":8,"description":"FIX 4.2","enum":["FIX.4.2"],"x-enumDescriptions":{"FIX.4.2":"FIX protocol version 4.2."}},"bodyLength":{"type":"integer","x-fix-tag":9,"description":"Length of message body"},"msgSeqNum":{"type":"integer","x-fix-tag":34,"description":"FIX message sequence number. See Sequence handling in the protocol overview: a seq num greater than expected triggers a Resend Request (35=2, BeginSeqNo(7)=<last processed>, EndSeqNo(16)=0/Infinity); less than expected gets a session-level Reject and connection close (messages with PossDup(43)=Y are ignored)."},"msgType":{"$ref":"#/components/schemas/FixMsgType"},"senderCompID":{"type":"string","x-fix-tag":49,"description":"Sender Company ID, provided by DW"},"sendingTime":{"type":"string","x-fix-tag":52,"description":"GMT date/time the message was sent, in millisecond resolution. Upon being received by DriveWealth, this timestamp must be within the last 60 seconds."},"targetCompID":{"type":"string","x-fix-tag":56,"description":"Target Company ID, provided by DW"},"deliverToCompID":{"type":"string","x-fix-tag":128,"description":"Bloomberg EMSxNet/FixNet connections only. DriveWealth's broker ID with Bloomberg FixNet (DWTH) — a different value than DriveWealth's broker ID for EMSxNet, which is DRIV. Partners using Bloomberg must follow the Bloomberg FIX spec for hybrid broker destinations in addition to this spec, and must include this tag on every message header."}}},"FixTrailer":{"type":"object","description":"Standard FIX trailer. All FIX messages must include this section; the tag within it is required.","required":["checkSum"],"properties":{"checkSum":{"type":"string","x-fix-tag":10,"description":"Standard FIX checksum"}}},"FixMsgType":{"type":"string","x-fix-tag":35,"description":"FIX message type.","enum":["0","1","2","3","4","5","8","9","A","D","F","G"],"x-enumDescriptions":{"0":"Heartbeat","1":"Test Request","2":"Resend Request","3":"Message Reject","4":"Sequence Reset","5":"Logout","8":"Execution Report","9":"Cancel Reject","A":"Logon","D":"New Order","F":"Cancel Request","G":"Cancel/Replace Request"}},"FixSide":{"type":"string","x-fix-tag":54,"enum":["1","2"],"x-enumDescriptions":{"1":"Buy","2":"Sell Long"}},"FixOrdType":{"type":"string","x-fix-tag":40,"enum":["1","2","3","4","5","B"],"x-enumDescriptions":{"1":"Market","2":"Limit","3":"Stop","4":"Stop limit","5":"MOC","B":"LOC"}},"FixTimeInForce":{"type":"string","x-fix-tag":59,"enum":["0","2","3","5","7"],"x-enumDescriptions":{"0":"Day","2":"At the Opening","3":"IOC - Immediate or Cancel","5":"GTX - extended hours eligible (deprecated — see TradingSessionID<336>)","7":"At the Close"}},"FixExecType":{"type":"string","x-fix-tag":150,"description":"Also used to represent OrdStatus<39>, which shares the same value range.","enum":["0","1","2","3","4","5","6","8","E"],"x-enumDescriptions":{"0":"Accepted (\"New\")","1":"Partial Fill","2":"Filled","3":"Done for Day","4":"Canceled","5":"Replaced","6":"Pending Cancel (not enabled by default; DriveWealth can configure upon request)","8":"Rejected","E":"Pending Replace (not enabled by default; DriveWealth can configure upon request)"}},"FixSettlementType":{"type":"string","x-fix-tag":63,"enum":["0"],"x-enumDescriptions":{"0":"Regular"}},"FixIDSource":{"type":"string","x-fix-tag":22,"description":"If sending SecurityID<48>, the type of value. Either Symbol<55> or SecurityID<48>+IDSource<22> must be defined.","enum":["2","4","5"],"x-enumDescriptions":{"2":"SEDOL","4":"ISIN","5":"RIC"}},"FixExecInst":{"type":"string","x-fix-tag":18,"description":"Execution instruction.","enum":["1","5"],"x-enumDescriptions":{"1":"Not Held","5":"Held"}},"FixHandlInstr":{"type":"string","x-fix-tag":21,"description":"21=3 will be rejected.","enum":["2"],"x-enumDescriptions":{"2":"Automated Execution; Broker intervention okay"}},"FixOrderCapacity":{"type":"string","x-fix-tag":47,"enum":["A"],"x-enumDescriptions":{"A":"Agency"}},"FixTradingSessionID":{"type":"string","x-fix-tag":336,"description":"The sessions for which this order is eligible. Used to execute orders in the extended or overnight sessions. If ExDestination<100> is not specified, DriveWealth determines how to process the order according to the requested sessions. Must be 8, 9, or 10 for orders to automatically roll from the overnight session into the pre-market session. Default is \"Core\" (2) only. Must be unset if the order is an algorithmic order or auction (on-open, on-close) order.","enum":["1","2","3","4","5","6","7","8","9","10"],"x-enumDescriptions":{"1":"Pre","2":"Core","3":"Pre + Core","4":"Post","5":"Core + Post","6":"Overnight","7":"Pre + Core + Post","8":"Overnight + Pre","9":"Overnight + Pre + Core","10":"Overnight + Pre + Core + Post"}},"FixAlgoStrategy":{"type":"string","x-fix-tag":6102,"description":"The type of algo strategy.","enum":["VWAP","TWAP"],"x-enumDescriptions":{"VWAP":"Volume-Weighted Average Price algo strategy.","TWAP":"Time-Weighted Average Price algo strategy."}},"FixExecTransType":{"type":"string","x-fix-tag":20,"enum":["0","1"],"x-enumDescriptions":{"0":"New (i.e. new execution report)","1":"Cancel (Bust)"}},"FixLastCapacity":{"type":"string","x-fix-tag":29,"enum":["1","4","5"],"x-enumDescriptions":{"1":"Agent","4":"Principal","5":"Riskless Principal"}},"FixMiscFeeType":{"type":"string","x-fix-tag":139,"description":"Set to 1 (Regulatory) when MiscFeeAmt<137> is set.","enum":["1"],"x-enumDescriptions":{"1":"Regulatory"}},"FixCxlRejResponseTo":{"type":"string","x-fix-tag":434,"description":"Identifies the type of request that a Cancel Reject is in response to.","enum":["1","2"],"x-enumDescriptions":{"1":"Cancel Request","2":"Cancel/Replace Request"}},"NewOrderSingle":{"description":"New Order - Single (MsgType<35> = D). Sent together with FixHeader/FixTrailer.","allOf":[{"$ref":"#/components/schemas/FixHeader"},{"$ref":"#/components/schemas/FixTrailer"},{"type":"object","required":["account","clOrdId","ordType","side","timeInForce","transactTime","clientID"],"properties":{"msgType":{"allOf":[{"$ref":"#/components/schemas/FixMsgType"}],"enum":["D"],"x-enumDescriptions":{"D":"New Order — Single (FIX MsgType D)."}},"account":{"type":"string","x-fix-tag":1,"description":"Account number as provided by DriveWealth"},"clOrdId":{"type":"string","x-fix-tag":11,"maxLength":45,"description":"Trading-day-unique order ID as assigned by the client. Note that if sending messages through an order routing network, the network will likely prepend each ClOrdId value with a few characters."},"execInst":{"allOf":[{"$ref":"#/components/schemas/FixExecInst"}],"description":"Optional."},"handlInstr":{"allOf":[{"$ref":"#/components/schemas/FixHandlInstr"}],"description":"Optional."},"idSource":{"allOf":[{"$ref":"#/components/schemas/FixIDSource"}],"description":"Optional unless SecurityID<48> is sent."},"orderQty":{"type":"number","x-fix-tag":38,"description":"The total intended quantity of the order in shares. Either OrderQty<38> or CashOrderQty<152> must be defined."},"ordType":{"$ref":"#/components/schemas/FixOrdType"},"price":{"type":"number","x-fix-tag":44,"description":"Limit price, in dollars per share. Minimum price resolution is one cent for prices of a dollar and higher, one hundredth of a cent for prices below a dollar. Maximum numerical value is 1,000,000. Must be present for Limit orders."},"orderCapacity":{"allOf":[{"$ref":"#/components/schemas/FixOrderCapacity"}],"description":"Optional."},"securityID":{"type":"string","x-fix-tag":48,"description":"A security identifier. See IDSource<22> for the types of identifiers you can use in this tag. If specifying a symbol, use Symbol<55> instead. Either Symbol<55> or SecurityID<48>+IDSource<22> must be defined."},"side":{"$ref":"#/components/schemas/FixSide"},"symbol":{"type":"string","x-fix-tag":55,"description":"Ticker symbol (without suffix — any suffix should be sent as SymbolSfx<65>). Either Symbol<55> or SecurityID<48>+IDSource<22> must be defined."},"text":{"type":"string","x-fix-tag":58,"maxLength":20,"description":"Client is free to append arbitrary text."},"timeInForce":{"$ref":"#/components/schemas/FixTimeInForce"},"transactTime":{"type":"string","x-fix-tag":60,"description":"Time this order request was initiated/released by the client system. GMT date/time in millisecond resolution or better. Upon being received by DriveWealth, this timestamp must be within the last 60 seconds — otherwise a Reject message is sent with \"Stale Order\" as Text<58>."},"settlementType":{"allOf":[{"$ref":"#/components/schemas/FixSettlementType"}],"description":"Optional."},"symbolSfx":{"type":"string","x-fix-tag":65,"description":"Symbol suffix for NYSE listed securities in CMS format"},"stopPx":{"type":"number","x-fix-tag":99,"description":"Stop price, in dollars per share. Minimum price resolution is one cent for prices of a dollar and higher, one hundredth of a cent for prices below a dollar. Must be present for Stop orders."},"exDestination":{"type":"string","x-fix-tag":100,"description":"Set to send an order to a specific destination. Supported values: 100 = BLUE (routes to Blue Ocean ATS — see the Overnight orders notes), 100 = TEST — both documented under the same code point in DriveWealth's published spec; confirm the intended values with DriveWealth before relying on this field."},"clientID":{"type":"string","x-fix-tag":109,"maxLength":64,"description":"A unique identifier of the User/Trader who created the order."},"cashOrderQty":{"type":"number","x-fix-tag":152,"description":"Specifies approximate order quantity desired in monetary units, i.e. Notional value, vs. number of shares. If set, DriveWealth will estimate share quantity in OrderQty<38>. Either OrderQty<38> or CashOrderQty<152> must be defined."},"tradingSessionID":{"allOf":[{"$ref":"#/components/schemas/FixTradingSessionID"}],"description":"Optional."},"algoStrategy":{"allOf":[{"$ref":"#/components/schemas/FixAlgoStrategy"}],"description":"Optional."},"algoStartTime":{"type":"string","x-fix-tag":6103,"description":"The time the algo order is activated. GMT date/time in millisecond resolution or better. Defaults to the start of the core trading session."},"algoEndTime":{"type":"string","x-fix-tag":6104,"description":"The time by which the algo must complete or be canceled. GMT date/time in millisecond resolution or better. Defaults to the end of the core session hours."},"algoMaxPercentVol":{"type":"integer","x-fix-tag":6106,"minimum":1,"maximum":100,"description":"Maximum percentage of volume. Integer values 1-100 for 1%-100%. Defaults to 100%."}}}]},"ExecutionReport":{"description":"Execution Report (MsgType<35> = 8). Sent together with FixHeader/FixTrailer.","allOf":[{"$ref":"#/components/schemas/FixHeader"},{"$ref":"#/components/schemas/FixTrailer"},{"type":"object","required":["clOrdId","execId","execTransType","orderId","orderQty","ordStatus","ordType","side","symbol","timeInForce","transactTime","execType","leavesQty"],"properties":{"msgType":{"allOf":[{"$ref":"#/components/schemas/FixMsgType"}],"enum":["8"],"x-enumDescriptions":{"8":"Execution Report (FIX MsgType 8)."}},"avgPrice":{"type":"number","x-fix-tag":6,"description":"Average price in dollars per share of all fills on this order. Set on execution reports with filled quantities."},"clOrdId":{"type":"string","x-fix-tag":11,"description":"Reflection of the ClOrdId of the New Order, Cancel Request, or Cancel/Replace Request message."},"cumQty":{"type":"number","x-fix-tag":14,"description":"Total number of shares filled on this order."},"execId":{"type":"string","x-fix-tag":17,"description":"DW-generated unique ID of the execution report. Example: 1803468687151267841"},"execRefId":{"type":"string","x-fix-tag":19,"description":"For busts, the ExecId<17> of the fill being busted."},"execTransType":{"$ref":"#/components/schemas/FixExecTransType"},"lastCapacity":{"allOf":[{"$ref":"#/components/schemas/FixLastCapacity"}],"description":"Optional."},"lastPrice":{"type":"number","x-fix-tag":31,"description":"The price in dollars per share of the most recent fill. Set on execution reports with at least one fill."},"lastShares":{"type":"number","x-fix-tag":32,"description":"The number of shares of the most recent fill. Set on execution reports with at least one fill."},"orderId":{"type":"string","x-fix-tag":37,"description":"Day-unique, cross-line unique ID of the order generated by DriveWealth."},"orderQty":{"type":"number","x-fix-tag":38,"description":"Reflected from the order request."},"ordStatus":{"allOf":[{"$ref":"#/components/schemas/FixExecType"}],"x-fix-tag":39,"description":"Status of the order — same value range as ExecType<150>."},"ordType":{"$ref":"#/components/schemas/FixOrdType"},"origClOrdId":{"type":"string","x-fix-tag":41,"description":"The previous ClOrdId of the order. Required for responses to Cancel Requests and Canceled messages."},"price":{"type":"number","x-fix-tag":44,"description":"Reflected from the order request."},"side":{"$ref":"#/components/schemas/FixSide"},"symbol":{"type":"string","x-fix-tag":55,"description":"Reflected from the order request."},"text":{"type":"string","x-fix-tag":58,"description":"Text description may be provided on some execution reports."},"timeInForce":{"$ref":"#/components/schemas/FixTimeInForce"},"transactTime":{"type":"string","x-fix-tag":60,"description":"The time the execution report was initiated by the DW system. GMT date/time in millisecond resolution or better."},"settlementType":{"allOf":[{"$ref":"#/components/schemas/FixSettlementType"}],"description":"Reflected from the order request."},"symbolSfx":{"type":"string","x-fix-tag":65,"description":"Reflected from the order request."},"stopPx":{"type":"number","x-fix-tag":99,"description":"Reflected from the order request."},"miscFeeAmt":{"type":"number","x-fix-tag":137,"description":"Sent on the final message on an order, such as fully filled or Partial then Canceled."},"miscFeeType":{"allOf":[{"$ref":"#/components/schemas/FixMiscFeeType"}],"description":"Optional."},"execType":{"$ref":"#/components/schemas/FixExecType"},"leavesQty":{"type":"number","x-fix-tag":151,"description":"Amount of shares open for further execution. Will be 0 for cancels or rejects. For fills, LeavesQty<151> = OrderQty<38> - CumQty<14>."},"cashOrderQty":{"type":"number","x-fix-tag":152,"description":"Reflected from the order request."}}}]},"CancelRequest":{"description":"Cancel Request (MsgType<35> = F). Sent together with FixHeader/FixTrailer.","allOf":[{"$ref":"#/components/schemas/FixHeader"},{"$ref":"#/components/schemas/FixTrailer"},{"type":"object","required":["clOrdId","origClOrdId","side","transactTime"],"properties":{"msgType":{"allOf":[{"$ref":"#/components/schemas/FixMsgType"}],"enum":["F"],"x-enumDescriptions":{"F":"Order Cancel Request (FIX MsgType F)."}},"account":{"type":"string","x-fix-tag":1,"description":"Identification of account as assigned by the client."},"clOrdId":{"type":"string","x-fix-tag":11,"description":"A new day-unique order ID as assigned by the client."},"orderId":{"type":"string","x-fix-tag":37,"description":"Reflection of the OrderID<37> received from DW in execution reports. Clients are encouraged to send this tag, but do not need to if they have not received any execution reports yet."},"origClOrdId":{"type":"string","x-fix-tag":41,"description":"ClOrdId of the order to cancel."},"securityID":{"type":"string","x-fix-tag":48,"description":"Must match the original order. Must be set if it was set on the original order."},"side":{"$ref":"#/components/schemas/FixSide"},"symbol":{"type":"string","x-fix-tag":55,"description":"Must match the original order. Must be set if it was set on the original order."},"text":{"type":"string","x-fix-tag":58,"description":"Client is free to append arbitrary text."},"transactTime":{"type":"string","x-fix-tag":60,"description":"The time this cancel request was initiated/released by the client system. GMT date/time in millisecond resolution or better."},"symbolSfx":{"type":"string","x-fix-tag":65,"description":"Must match the original order. Must be set if it was set on the original order."}}}]},"CancelReplaceRequest":{"description":"Cancel/Replace Request (MsgType<35> = G). Sent together with FixHeader/FixTrailer. `x-fix-change-eligible` on each field: true = mutable via this request, false = must match the original order, null = not applicable (identity/timing fields).","allOf":[{"$ref":"#/components/schemas/FixHeader"},{"$ref":"#/components/schemas/FixTrailer"},{"type":"object","required":["clOrdId","handlInstr","ordType","origClOrdId","price","side","transactTime"],"properties":{"msgType":{"allOf":[{"$ref":"#/components/schemas/FixMsgType"}],"enum":["G"],"x-enumDescriptions":{"G":"Order Cancel/Replace Request (FIX MsgType G)."}},"account":{"type":"string","x-fix-tag":1,"x-fix-change-eligible":false},"clOrdId":{"type":"string","x-fix-tag":11,"x-fix-change-eligible":null,"description":"Must be different from the ClOrdId used in sending the original New Order - Single."},"handlInstr":{"allOf":[{"$ref":"#/components/schemas/FixHandlInstr"}],"x-fix-change-eligible":false},"idSource":{"allOf":[{"$ref":"#/components/schemas/FixIDSource"}],"x-fix-change-eligible":false},"orderQty":{"type":"number","x-fix-tag":38,"x-fix-change-eligible":true},"ordType":{"allOf":[{"$ref":"#/components/schemas/FixOrdType"}],"x-fix-change-eligible":false},"origClOrdId":{"type":"string","x-fix-tag":41,"x-fix-change-eligible":null,"description":"The ClOrdId used in sending the original New Order - Single."},"price":{"type":"number","x-fix-tag":44,"x-fix-change-eligible":true},"orderCapacity":{"allOf":[{"$ref":"#/components/schemas/FixOrderCapacity"}],"x-fix-change-eligible":false},"securityID":{"type":"string","x-fix-tag":48,"x-fix-change-eligible":false,"description":"Must be set if it was set on the original order."},"side":{"allOf":[{"$ref":"#/components/schemas/FixSide"}],"x-fix-change-eligible":false},"symbol":{"type":"string","x-fix-tag":55,"x-fix-change-eligible":false,"description":"Must be set if it was set on the original order."},"text":{"type":"string","x-fix-tag":58,"x-fix-change-eligible":false},"timeInForce":{"allOf":[{"$ref":"#/components/schemas/FixTimeInForce"}],"x-fix-change-eligible":false},"transactTime":{"type":"string","x-fix-tag":60,"x-fix-change-eligible":null,"description":"Must represent the Cancel/Replace Request time."},"settlementType":{"allOf":[{"$ref":"#/components/schemas/FixSettlementType"}],"x-fix-change-eligible":false},"symbolSfx":{"type":"string","x-fix-tag":65,"x-fix-change-eligible":false,"description":"Must be set if it was set on the original order."},"stopPx":{"type":"number","x-fix-tag":99,"x-fix-change-eligible":true},"exDestination":{"type":"string","x-fix-tag":100,"x-fix-change-eligible":false},"clientID":{"type":"string","x-fix-tag":109,"x-fix-change-eligible":false},"cashOrderQty":{"type":"number","x-fix-tag":152,"x-fix-change-eligible":false},"tradingSessionID":{"allOf":[{"$ref":"#/components/schemas/FixTradingSessionID"}],"x-fix-change-eligible":false},"algoStrategy":{"allOf":[{"$ref":"#/components/schemas/FixAlgoStrategy"}],"x-fix-change-eligible":false},"algoStartTime":{"type":"string","x-fix-tag":6103,"x-fix-change-eligible":true},"algoEndTime":{"type":"string","x-fix-tag":6104,"x-fix-change-eligible":true},"algoMaxPercentVol":{"type":"integer","x-fix-tag":6106,"minimum":1,"maximum":100,"x-fix-change-eligible":true}}}]},"CancelReject":{"description":"Cancel Reject (MsgType<35> = 9). Sent together with FixHeader/FixTrailer.","allOf":[{"$ref":"#/components/schemas/FixHeader"},{"$ref":"#/components/schemas/FixTrailer"},{"type":"object","required":["clOrdId","orderId","ordStatus","origClOrdId","transactTime","cxlRejResponseTo"],"properties":{"msgType":{"allOf":[{"$ref":"#/components/schemas/FixMsgType"}],"enum":["9"],"x-enumDescriptions":{"9":"Order Cancel Reject (FIX MsgType 9)."}},"clOrdId":{"type":"string","x-fix-tag":11,"description":"Reflection of the ClOrdId<11> from the Cancel Request."},"orderId":{"type":"string","x-fix-tag":37,"description":"The OrderId<37> that represents the order when receiving an Execution Report."},"ordStatus":{"allOf":[{"$ref":"#/components/schemas/FixExecType"}],"x-fix-tag":39,"description":"The current status of the order, which was unaffected by the failed Cancel Request. See possible values in Execution Report."},"origClOrdId":{"type":"string","x-fix-tag":41,"description":"Reflection of the OrigClOrdId<41> from the Cancel Request."},"text":{"type":"string","x-fix-tag":58,"description":"Reason why the request could not be satisfied."},"transactTime":{"type":"string","x-fix-tag":60,"description":"The time this cancel request was rejected. GMT date/time in millisecond resolution or better."},"cxlRejResponseTo":{"$ref":"#/components/schemas/FixCxlRejResponseTo"}}}]},"Exchange":{"type":"object","required":["id","exchangeNo","status","sellSymbol","sellOrderId","sellOrderNo","buySymbol","buyOrderId","buyOrderNo","sellAveragePrice","sellCumulativeQuantity","buyAveragePrice","buyCumulativeQuantity","amountCash","fees","createdBy","userID","accountID","accountNo","created","orderExpires"],"properties":{"id":{"type":"string","description":"The specific id of the exchange"},"exchangeNo":{"type":"string","description":"The specific exchange number"},"status":{"type":"string","description":"The state of the exchange.","enum":["NEW","FILLED","REJECTED","PENDING_CANCEL","CANCELED","FILLED"],"x-enumDescriptions":{"NEW":"The order has been received but not yet processed.","FILLED":"The order has been completely filled.","REJECTED":"The order was rejected.","PENDING_CANCEL":"A cancel request has been submitted and is awaiting confirmation.","CANCELED":"The order has been canceled."}},"sellSymbol":{"type":"string","description":"This will be the ticker of the mutual fund you will be liquidating"},"sellOrderId":{"type":"string","description":"The order ID corresponding to the sell transaction"},"sellOrderNo":{"type":"string","description":"The order number corresponding to the sell transaction"},"buySymbol":{"type":"string","description":"This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation"},"buyOrderId":{"type":"string","description":"The order ID corresponding to the buy transaction"},"buyOrderNo":{"type":"string","description":"The order number corresponding to the buy transaction"},"sellAveragePrice":{"type":"number","description":"The price the sell order was filled at."},"sellCumulativeQuantity":{"type":"number","description":"The total quantity the sell was for."},"buyAveragePrice":{"type":"number","description":"The price the buy order was filled at."},"buyCumulativeQuantity":{"type":"number","description":"The total quantity the buy was for."},"amountCash":{"type":"integer","description":"This is the total notional amount you exchange from the sellSymbol to the buySymbol."},"fees":{"type":"integer","description":"The total fees for both the buy and sell order of the exchange."},"createdBy":{"type":"string","description":"The user, who created the order."},"userID":{"$ref":"#/components/schemas/userID"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"created":{"type":"string","example":"2019-03-29T20:00:00.000Z","description":"The timestamp the order was created."},"orderExpires":{"type":"string","example":"2019-03-29T20:00:00.000Z","description":"The timestamp the exchange expires."}}},"AllocationRequest":{"type":"object","required":["userID","orders"],"properties":{"userID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000167","description":"The unique identifier of the registered investment advisors account."},"clientListID":{"$ref":"#/components/schemas/clientListID"},"note":{"$ref":"#/components/schemas/allocationNote"},"orders":{"type":"array","description":"An array of objects that hold the specific order and allocation details.","required":["orderID","allocations"],"items":{"oneOf":[{"$ref":"#/components/schemas/order"}]}}}},"AllocationResponse":{"type":"object","properties":{"id":{"type":"string","example":"JL.allocation.SomeRIACompany.123e4567-e89b-12d3-a456-000000000009","description":"The unique allocation identifier associated to a specific allocation."}}},"order":{"type":"object","properties":{"orderID":{"type":"string","example":"JL.123e4567-e89b-12d3-a456-00000000000d","description":"The orderID of a filled order being used in an allocation."},"allocations":{"type":"array","description":"An array that holds relevant information about how and where to distribute securities from a recent order.","required":["accountID","accountNo","qty","useClientFunds"],"items":{"oneOf":[{"$ref":"#/components/schemas/allocation"}]}}}},"allocation":{"type":"object","properties":{"accountID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000004.1234567890125","description":"The unique account identifier of the end user receiving an allocation."},"accountNo":{"type":"string","example":"VVVV000073","description":"The account number of the end user receiving an allocation."},"qty":{"type":"string","example":"27","description":"The number of shares allocated to a users account."},"useClientFunds":{"type":"boolean","example":true,"description":"True, if allocations should use client funds."},"comment":{"type":"string","example":"Suds boapi test to 1st","description":"A note created by the RIA upon creating an allocation."}}},"allocationDetailObject":{"type":"object","description":"Contains details for a user associated with an allocation.","properties":{"accountID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000000e.1234567890126","description":"The account identifier for an end user associated with an allocation."},"accountNo":{"type":"string","example":"VVVV000073","description":"The account number of an end user associated with an allocation."},"status":{"type":"string","example":"FILLED","description":"The status of the allocation.","enum":["NEW","FILLED","REJECTED"],"x-enumDescriptions":{"NEW":"The allocation has been created but not yet processed.","FILLED":"The allocation has been filled.","REJECTED":"The allocation was rejected."}},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"clientComment":{"type":"string","example":"Foo test allocation","description":"A note for the type of allocation happening."},"qtyRequested":{"type":"number","example":10,"description":"Quantity of shares requested to allocate to a users account."},"qtyAllocated":{"type":"number","example":10,"description":"Quantity of shares allocated to a users account."},"avgPx":{"type":"number","example":126.52,"description":"The average price of the security being allocated."},"fees":{"$ref":"#/components/schemas/fees"}}},"fees":{"type":"object","description":"The fees associated with an allocation.","properties":{"total":{"type":"number","example":"0","description":"The sum of all fees."},"sec":{"type":"number","example":"0","description":"The Securities and Exchange Commission Fee."},"taf":{"type":"number","example":"0","description":"The Trading Activity Fees."},"commission":{"type":"number","example":"0","description":"The commissions for the allocation"},"other":{"type":"number","example":"0","description":"Any miscellaneous fees associated with the allocation."}}},"AllocationDetails":{"type":"object","properties":{"id":{"type":"string","example":"JL.allocation.SomeRIACompany.123e4567-e89b-12d3-a456-000000000009","description":"The unique allocationID associated with a specific allocation."},"status":{"type":"string","example":"COMPLETE","description":"Overall status of an allocation.","enum":["NEW","ACCEPTED","PART_COMPLETE","COMPLETE","REJECTED"],"x-enumDescriptions":{"NEW":"The allocation has been created but not yet processed.","ACCEPTED":"The allocation has been accepted.","PART_COMPLETE":"The allocation is partially complete.","COMPLETE":"The allocation is complete.","REJECTED":"The allocation was rejected."}},"clientListID":{"$ref":"#/components/schemas/clientListID"},"accountID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000000f.1234567890127","description":"The account identifier for the RIA master trading account."},"accountNo":{"type":"string","example":"UUUU000072","description":"The account number for the RIA master trading account."},"createdWhen":{"type":"string","example":"2022-12-22T16:04:46.724Z","description":"Date and time of allocation creation."},"allocations":{"type":"array","description":"An array of allocation objects that hold details of the allocation.","items":{"oneOf":[{"$ref":"#/components/schemas/allocationDetailObject"}]}},"comment":{"type":"string","example":"All allocated and accounted for. 1::1::0 client note[allocating via bo api 1st allocation test]. timeMs=423 ratePerSec=2.36 msPerItem=423.00","description":"A note created by the RIA upon creating an allocation."}}},"fundsRequest":{"type":"object","required":["userID","name","clientFundID","description","holdings","triggers"],"properties":{"userID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000167","description":"The unique identifier of the registered investment advisors account."},"name":{"type":"string","example":"TECH","description":"A name given to the Fund by the RIA."},"clientFundID":{"$ref":"#/components/schemas/clientListID"},"description":{"type":"string","example":"Top 10 US Tech","description":"A short description for the Fund."},"holdings":{"type":"array","description":"An array of objects that hold the type of securities in a Fund.","items":{"$ref":"#/components/schemas/holdingsObject"}},"triggers":{"type":"array","description":"An array of objects that hold information on when to trigger a rebalance in a Fund.","items":{"$ref":"#/components/schemas/triggersObject"}}}},"triggersObject":{"type":"object","description":"An object that holds the details of when to trigger a rebalance of the Fund.","required":["type","child","maxAllowed","lowerBound","upperBound"],"properties":{"type":{"type":"string","example":"TOTAL_DRIFT","description":"The type of trigger specified to enable a rebalance.","enum":["TOTAL_DRIFT","RELATIVE_DRIFT","ABSOLUTE_DRIFT"],"x-enumDescriptions":{"TOTAL_DRIFT":"Triggers when the fund's overall drift threshold is exceeded.","RELATIVE_DRIFT":"Triggers based on a percentage deviation relative to the target allocation.","ABSOLUTE_DRIFT":"Triggers based on an absolute deviation from the target allocation."}},"maxAllowed":{"type":"number","example":0.05,"description":"The maximum allowed drift for the Fund."},"child":{"type":"string","example":null},"lowerBound":{"type":"number","example":0.01,"description":"The lowest bound range of the drift parameters."},"upperBound":{"type":"number","example":0.02,"description":"The highest bound range of the drift parameter."}}},"fundsResponse":{"type":"object","properties":{"id":{"type":"string","example":"fund_123e4567-e89b-12d3-a456-000000000010","description":"The unique identifier associated with the Fund."},"userID":{"$ref":"#/components/schemas/managedAccountsUserID"},"name":{"type":"string","example":"TECH","description":"A name given to the Fund by the RIA."},"type":{"type":"string","example":"FUND"},"clientFundID":{"$ref":"#/components/schemas/clientFundID"},"description":{"type":"string","example":"Top 10 US Tech","description":"A short description for the Fund."},"holdings":{"type":"array","description":"An array of objects that hold the type of securities in a Fund.","items":{"$ref":"#/components/schemas/holdingsObject"}},"triggers":{"type":"array","description":"An array of objects that hold information on when to trigger a rebalance.","items":{"$ref":"#/components/schemas/triggersObject"}},"isInstrumentTargetsChanged":{"type":"boolean","example":false},"instrumentTargetsChanged":{"type":"boolean","example":false}}},"portfolioReq":{"type":"object","required":["userID","name","clientPortfolioID","description","holdings","triggers"],"properties":{"userID":{"$ref":"#/components/schemas/managedAccountsUserID"},"name":{"type":"string","example":"Recession Proof","description":"A name given to the Portfolio by the RIA."},"clientPortfolioID":{"$ref":"#/components/schemas/clientPortfolioID"},"description":{"type":"string","example":"Mix of sectors","description":"A short description for the portfolio."},"holdings":{"type":"array","description":"An array of objects that hold a list of Funds in a portfolio.","items":{"$ref":"#/components/schemas/portfolioReqHoldings"}},"triggers":{"type":"array","description":"An array of objects that hold a list if triggers associated with a portfolio.","items":{"$ref":"#/components/schemas/portfolioTriggers"}}}},"portfolioRes":{"type":"object","properties":{"id":{"type":"string","example":"portfolio_123e4567-e89b-12d3-a456-00000000000b","description":"The unique identifier associated with a portfolio."},"name":{"type":"string","example":"Recession Proof","description":"A name given to the Portfolio by the RIA."},"clientPortfolioID":{"$ref":"#/components/schemas/clientPortfolioID"},"description":{"type":"string","example":"A portifolio description","description":"A short description for the Portfolio."},"holdings":{"type":"array","description":"An array of objects that hold the type of Funds in the Portfolio.","items":{"$ref":"#/components/schemas/portfolioResHoldingsObject"}},"userID":{"$ref":"#/components/schemas/managedAccountsUserID"},"triggers":{"type":"array","description":"An array of objects that hold information on when to trigger a rebalance in the Portfolio.","items":{"$ref":"#/components/schemas/portfolioTriggers"}},"isFundTargetsChanged":{"type":"boolean","example":false},"fundsTargetsChanged":{"type":"boolean","example":false}}},"portfolioReqHoldings":{"type":"object","required":["type","target"],"properties":{"type":{"type":"string","example":"FUND","description":"The type of asset in a Portfolio.","enum":["FUND","CASH_RESERVE"],"x-enumDescriptions":{"FUND":"A managed fund position.","CASH_RESERVE":"A cash reserve position, held for liquidity rather than invested."}},"id":{"type":"string","example":"fund_123e4567-e89b-12d3-a456-000000000011","description":"The unique fundID."},"target":{"type":"number","example":0.95,"description":"The percentage of a Fund within a Portfolio."}}},"portfolioTriggers":{"type":"object","description":"An object that holds the details of when to trigger a rebalance of a Portfolio.","required":["type","child","maxAllowed","lowerBound","upperBound"],"properties":{"type":{"type":"string","example":"TOTAL_DRIFT","description":"The type of trigger specified to enable a rebalance.","enum":["TOTAL_DRIFT","RELATIVE_DRIFT","ABSOLUTE_DRIFT"],"x-enumDescriptions":{"TOTAL_DRIFT":"Triggers when the fund's overall drift threshold is exceeded.","RELATIVE_DRIFT":"Triggers based on a percentage deviation relative to the target allocation.","ABSOLUTE_DRIFT":"Triggers based on an absolute deviation from the target allocation."}},"maxAllowed":{"type":"number","example":0.05,"description":"The maximum allowed drift for the Portfolio."},"child":{"type":"string","example":null},"lowerBound":{"type":"number","example":0.01,"description":"The lowest bound range of the drift parameters."},"upperBound":{"type":"number","example":0.02,"description":"The highest bound range of the drift parameter."}}},"portfolioResHoldingsObject":{"type":"object","description":"An array of objects that hold details of a Fund in a Portfolio.","properties":{"id":{"type":"string","example":"fund_123e4567-e89b-12d3-a456-000000000011","description":"The unique FundID."},"name":{"type":"string","example":"TECH","description":"A name given to the Fund by the RIA."},"type":{"type":"string","example":"FUND","description":"The type of asset in the Portfolio.","enum":["FUND","CASH_RESERVE"],"x-enumDescriptions":{"FUND":"A managed fund position.","CASH_RESERVE":"A cash reserve position, held for liquidity rather than invested."}},"clientFundID":{"$ref":"#/components/schemas/clientFundID"},"description":{"type":"string","example":"Top 10 US Tech","description":"A short description for the Fund."},"target":{"type":"number","example":0.95,"description":"The percentage of a Fund within a Portfolio."},"holdings":{"type":"array","description":"A list of the securities held in a Fund.","items":{"$ref":"#/components/schemas/holdingsObject"}},"triggers":{"type":"array","description":"The triggers associated with a Portfolio.","items":{"$ref":"#/components/schemas/triggersObject"}}}},"autopilotReq":{"type":"object","required":["reviewOnly","forceRebalance"],"properties":{"reviewOnly":{"type":"boolean","example":true,"description":"True, if a review should occur without a forced rebalance."},"forceRebalance":{"type":"boolean","example":true,"description":"True, if a forces rebalance should occur."},"subAccounts":{"type":"array","description":"A list of user's accountIDs to be rebalanced.","items":{"oneOf":[{"$ref":"#/components/schemas/accountID"}]}}}},"autopilotRes":{"type":"object","properties":{"id":{"type":"string","example":"ria_rebalance_123e4567-e89b-12d3-a456-000000000012","description":"The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance."},"created":{"type":"string","example":"2022-12-27T06:06:28.955Z","description":"A timestamp of when the re-balance run was created."},"status":{"type":"string","example":"REBALANCE_NOT_STARTED","description":"Status of the re-balance run. See [Autopilot Run Status](https://developer.drivewealth.com/reference/get-autopilot-run-status) for status values."},"riaID":{"$ref":"#/components/schemas/riaID"}}},"runStatusRes":{"type":"object","properties":{"id":{"type":"string","example":"ria_rebalance_123e4567-e89b-12d3-a456-000000000012","description":"The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance."},"riaID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000167","description":"This is the parentIBID or userID of the registered investment advisor creating the re-balance run."},"status":{"type":"string","example":"REBALANCE_NOT_STARTED","description":"Status of the re-balance run. See [Autopilot Run Status](https://developer.drivewealth.com/reference/get-autopilot-run-status) for status values."},"updated":{"type":"string","example":"2022-12-27T06:07:28.955Z","description":"A timestamp of when the re-balance run was updated."},"created":{"type":"string","example":"2022-12-27T06:06:28.955Z","description":"A timestamp of when the re-balance run was created."},"moneyMovement":{"type":"boolean","example":true,"description":"Was this run part of the regular AutoPilot money movement process?"},"regularRebalance":{"type":"boolean","example":true,"description":"Was this run part of the regular AutoPilot rebalancing process?"},"reviewOnly":{"type":"boolean","example":true},"orders":{"type":"object","description":"An object containing the details of submitted orders for the re-balance.","properties":{"total":{"type":"number","example":0,"description":"Total number of orders submitted."},"submitted":{"type":"string","example":"https://example-bucket.s3.amazonaws.com/44304da9....","description":"Amazon S3 download containing the details of each submitted order."},"outcome":{"type":"string","example":"https://example-bucket.s3....","description":"Amazon S3 download containing the status and final outcome of the orders that were submitted."},"amountBuys":{"type":"number","example":-1059.35,"description":"An aggregate value of all buy orders. Expect a negative number."},"amountSells":{"type":"number","example":862.69,"description":"An aggregate value of all sell orders."},"cleanedUp":{"type":"string","example":null}}},"allocations":{"type":"object","description":"An object containing the details of the allocations in a re-balance.","properties":{"submitted":{"type":"string","example":"https://example-bucket.s3....","description":"Amazon S3 download containing the details of each submitted allocation."},"outcome":{"type":"string","example":"https://example-bucket.s3....","description":"Amazon S3 download containing the status and final outcome of each allocation that was submitted."}}},"subAccounts":{"type":"object","description":"An object containing details on user accounts and their holdings.","properties":{"total":{"type":"number","example":4,"description":"The total number of user accounts under the advisor."},"rebalanced":{"type":"number","example":3,"description":"The total number of user accounts that were rebalanced."},"error":{"type":"number","example":0,"description":"The total number of allocation errors at the users account level during the rebalance."},"outcome":{"type":"string","example":"https://example-bucket.s3....","description":"Amazon S3 download containing the final outcome of the rebalance, includes users account details and their holdings."}}}}},"SettlementEventPayload":{"type":"object","properties":{"settlementID":{"type":"string","example":"sett_123e4567-e89b-12d3-a456-000000000060_profile1_20240324","description":"A unique identifier that identifies the settlement report."},"settlementDate":{"$ref":"#/components/schemas/date","description":"The date for which the settlement was generated."},"partnerID":{"$ref":"#/components/schemas/partnerID"},"status":{"$ref":"#/components/schemas/singleSettlementStatus"},"statusComment":{"type":"string","example":"Report generated via aggregator cron job.","description":"A custom comment about the current status of the settlement."},"totalAmount":{"type":"number","example":-14250,"description":"The total aggregated sum of all underlying accounts and transactions."},"createdAt":{"$ref":"#/components/schemas/created","description":"The date and time the settlement was created."},"updatedAt":{"$ref":"#/components/schemas/updated","description":"The date and time the settlement was last updated."},"updatedBy":{"type":"string","example":"SYSTEM","description":"The user or system process that last updated the settlement."},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"}}},"SettlementCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000067"},"type":{"type":"string","enum":["settlements.created"],"x-enumDescriptions":{"settlements.created":"Identifies this as a settlement-created event."}},"object":{"type":"string","enum":["SETTLEMENTS_REPORT"],"x-enumDescriptions":{"SETTLEMENTS_REPORT":"The payload object type: a settlements report."}},"timestamp":{"type":"string","format":"date-time","example":"2026-03-24T22:28:21.810Z"},"payload":{"$ref":"#/components/schemas/SettlementEventPayload"}}},"SettlementUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000067"},"type":{"type":"string","enum":["settlements.updated"],"x-enumDescriptions":{"settlements.updated":"Identifies this as a settlement-updated event."}},"object":{"type":"string","enum":["SETTLEMENTS_REPORT"],"x-enumDescriptions":{"SETTLEMENTS_REPORT":"The payload object type: a settlements report."}},"timestamp":{"type":"string","format":"date-time","example":"2026-03-24T22:28:21.810Z"},"payload":{"$ref":"#/components/schemas/SettlementEventPayload"}}},"SettlementCompletedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000067"},"type":{"type":"string","enum":["settlements.completed"],"x-enumDescriptions":{"settlements.completed":"Identifies this as a settlement-completed event."}},"object":{"type":"string","enum":["SETTLEMENTS_REPORT"],"x-enumDescriptions":{"SETTLEMENTS_REPORT":"The payload object type: a settlements report."}},"timestamp":{"type":"string","format":"date-time","example":"2026-03-24T22:28:21.810Z"},"payload":{"$ref":"#/components/schemas/SettlementEventPayload"}}},"AccountStatusSnapshot":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/accountStatus"},"description":{"type":"string","example":"Open"}}},"AccountStateSnapshot":{"type":"object","description":"The state of the account at a point in time — see the Accounts Updated event, which reports one of these as `previous` and one as `current`. Any subset of fields can appear — only what changed is included.","properties":{"status":{"$ref":"#/components/schemas/AccountStatusSnapshot"},"pdt":{"type":"object","deprecated":true,"description":"Pattern Day Trading (PDT) fields are deprecated and will be removed in a future release.","properties":{"patternDayTrader":{"$ref":"#/components/schemas/patternDayTrader"},"pdtRestricted":{"$ref":"#/components/schemas/pdtRestricted"},"pdtRestrictedWhen":{"type":"string","example":"2026-02-28T07:18:02.879Z","description":"The date and time the account became PDT restricted."}}},"bod":{"$ref":"#/components/schemas/bod"},"nickname":{"type":"string","example":"Alexander Richard's Self Directed Account"},"extendedHoursEnrolled":{"type":"boolean","example":true},"fpslEnrolled":{"type":"boolean","example":false},"fpslOptInWhen":{"type":"string","example":"2026-08-24T19:34:39.549Z"},"fpslOptOutWhen":{"type":"string","example":"2026-08-24T19:40:46.201Z"},"lastActivityDate":{"type":"string","example":"2026-08-24"},"closedBy":{"$ref":"#/components/schemas/userID"},"closedWhen":{"type":"string","example":"2026-08-24T19:36:55.603Z"},"closingReason":{"type":"string","example":"OTHER"},"statusChangeHistory":{"type":"object","properties":{"status":{"type":"string","example":"FROZEN"},"statusChangeReason":{"type":"string","example":"ACCOUNT_TRANSFERRED"},"statusUpdatedBy":{"$ref":"#/components/schemas/userID"}}},"statusChangeReason":{"type":"object","properties":{"name":{"type":"string","example":"DECEASED"},"description":{"type":"string","example":"Legal Restriction (Fraud/AML)"}}},"statusComment":{"type":"string","example":"Account closed"},"statusUpdatedBy":{"$ref":"#/components/schemas/userID"},"ria":{"type":"object","properties":{"advisorID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000104.1234567890182"},"portfolioID":{"type":"string","example":"portfolio_123e4567-e89b-12d3-a456-000000000105"},"productID":{"type":"string","example":"MONEYLION_1"}}},"trustedContact":{"type":"object","properties":{"address":{"type":"string","example":"1 Main St Apt 2, Anytown, ST 00000"},"email":{"type":"string","example":"jane.doe@example.com"},"firstName":{"type":"string","example":"Jane"},"lastName":{"type":"string","example":"Doe"},"phoneNumber":{"type":"string","example":"5555550100"}}},"accountFeatures":{"type":"object","description":"Dividend/capital-gains reinvestment preferences by asset class.","properties":{"equities":{"type":"object","properties":{"capitalGainsReinvestment":{"type":"boolean","example":false},"capitalGainsReinvestmentOptInWhen":{"type":"string","example":"2026-07-17T10:07:11.376Z"},"capitalGainsReinvestmentOptOutWhen":{"type":"string","example":"2026-02-10T21:01:42.932Z"},"dividendReinvestment":{"type":"boolean","example":false},"dividendReinvestmentOptInWhen":{"type":"string","example":"2026-07-17T10:07:11.376Z"},"dividendReinvestmentOptOutWhen":{"type":"string","example":"2026-02-10T21:01:42.932Z"}}},"mutualFunds":{"type":"object","properties":{"capitalGainsReinvestment":{"type":"boolean","example":false},"dividendReinvestment":{"type":"boolean","example":false}}}}},"metadata":{"type":"object","description":"Free-form partner metadata — shape varies by partner integration.","properties":{"btgAccountData":{"type":"object","properties":{"accountCosegment":{"type":"string","example":"AA"},"accountNumber":{"type":"string","example":"5361"},"accountSegment":{"type":"string","example":"BRK"},"businessSegment":{"type":"string","example":"B2B"},"cgeAdvisor":{"type":"string","example":"0"},"cgeAdvisorOffice":{"type":"string","example":"15549979"},"institutionCGE":{"type":"string","example":"1"},"lastOperationId":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000106"},"secondOfficerCge":{"type":"string","example":"320316"},"userCGE":{"type":"string","example":"1007656"}}}}},"updatedBy":{"$ref":"#/components/schemas/userID"}}},"AccountCreatedEventPayload":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000107.1234567890183","description":"Composite account identifier — note this differs in shape from accountID below (a pre-existing inconsistency in the payload)."},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"},"nickname":{"type":"string","example":"ALEX SANTOS's Self Directed Account"},"currencyID":{"type":"string","example":"USD"},"commissionID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000108"},"openedWhen":{"type":"string","example":"2026-08-24T19:23:49Z"},"accountHolderType":{"type":"object","properties":{"name":{"type":"string","example":"I"},"description":{"type":"string","example":"An account that does not meet FINRA Rule 4215(c) or a proprietary trading account"}}},"accountMgmtType":{"type":"object","properties":{"name":{"type":"string","example":"HSA_ADVISORY"},"description":{"type":"string","example":"Health Savings Managed Account"}}},"accountType":{"type":"object","properties":{"name":{"type":"string","example":"LIVE"},"description":{"type":"string","example":"Live Account"}}},"status":{"type":"object","properties":{"name":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Open"}}},"tradingType":{"type":"object","properties":{"name":{"type":"string","example":"CASH"},"description":{"type":"string","example":"Cash account"}}},"taxProfile":{"type":"object","properties":{"taxRecipientCode":{"type":"string","example":"INDIVIDUAL"},"taxStatusCode":{"type":"string","example":"W-8BEN"}}},"regType":{"type":"string","example":"CUST"},"restricted":{"type":"boolean","example":false},"beneficiaries":{"type":"boolean","example":false},"buyingPowerOverride":{"type":"boolean","example":false},"flaggedForACATS":{"type":"boolean","example":false},"freeTradeBalance":{"type":"number","example":0},"gfvPdtExempt":{"type":"boolean","example":false},"gfvRestricted":{"type":"boolean","example":false},"goodFaithViolations":{"$ref":"#/components/schemas/goodFaithViolations"},"interestFree":{"type":"boolean","example":false},"sweepInd":{"type":"boolean","example":true},"patternDayTrader":{"$ref":"#/components/schemas/patternDayTrader"},"patternDayTrades":{"type":"integer","example":0},"pdtRestricted":{"$ref":"#/components/schemas/pdtRestricted"},"extendedHoursEnrolled":{"type":"boolean","example":true},"leverage":{"type":"number","example":1},"ignoreMarketHoursForTest":{"type":"boolean","example":false,"description":"Non-production/test-environment accounts only."},"factaStatus":{"type":"string","example":"PASSIVE_NFFE"},"bod":{"$ref":"#/components/schemas/bod"},"parentIB":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000109"},"name":{"type":"string","example":"Businessolver Inc"}}},"ria":{"type":"object","properties":{"advisorID":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000010a.1234567890184"},"portfolioID":{"type":"string","example":"portfolio_123e4567-e89b-12d3-a456-00000000010b"},"productID":{"type":"string","example":"product_123e4567-e89b-12d3-a456-00000000010c"}}},"metadata":{"type":"object","description":"Free-form partner metadata — shape varies by partner integration.","properties":{"stakeAccountType":{"type":"string","example":"INDIVIDUAL"}}}}},"AccountUpdatedEventPayload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/AccountStateSnapshot"},"current":{"$ref":"#/components/schemas/AccountStateSnapshot"},"accountEquityBreakdown":{"$ref":"#/components/schemas/accountEquityBreakdownObj"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"}}},"AccountCommissionUpdatedEventPayload":{"type":"object","properties":{"commissionID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000017","description":"The unique identifier of the commission schedule."},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountID":{"$ref":"#/components/schemas/accountID"},"userID":{"$ref":"#/components/schemas/userID"}}},"AccountCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000010d"},"type":{"type":"string","enum":["accounts.created"],"x-enumDescriptions":{"accounts.created":"Identifies this as an account-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/AccountCreatedEventPayload"}}},"AccountUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000010e"},"type":{"type":"string","enum":["accounts.updated"],"x-enumDescriptions":{"accounts.updated":"Identifies this as an account-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/AccountUpdatedEventPayload"}}},"AccountCommissionUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000010f"},"type":{"type":"string","enum":["accounts.commission.updated"],"x-enumDescriptions":{"accounts.commission.updated":"Identifies this as an account-commission-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/AccountCommissionUpdatedEventPayload"}}},"ViolationEventPayload":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"currentViolations":{"type":"object","properties":{"goodFaithViolations":{"type":"object","properties":{"count":{"$ref":"#/components/schemas/goodFaithViolations"}}},"patternDayTrades":{"type":"object","deprecated":true,"description":"Pattern Day Trading (PDT) violation events are deprecated. Please discontinue use in production systems.","properties":{"count":{"$ref":"#/components/schemas/patternDayTrades"}}}}}}},"ViolationCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000110"},"type":{"type":"string","enum":["violations.created"],"x-enumDescriptions":{"violations.created":"Identifies this as a violation-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-26T11:05:33.221118146Z"},"payload":{"$ref":"#/components/schemas/ViolationEventPayload"}}},"ViolationRemovedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000111"},"type":{"type":"string","enum":["violations.removed"],"x-enumDescriptions":{"violations.removed":"Identifies this as a violation-removed event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-26T15:41:09.887118146Z"},"payload":{"$ref":"#/components/schemas/ViolationEventPayload"}}},"DepositEventPayload":{"type":"object","properties":{"paymentID":{"type":"string","example":"BBBB009003-1234567890147-DXUCH","description":"The unique identifier of the deposit payment."},"category":{"type":"string","enum":["DEPOSIT"],"x-enumDescriptions":{"DEPOSIT":"The transaction category: a deposit."}},"type":{"type":"string","example":"ACH","description":"The method/form of the deposit (e.g. ACH, ACH_MANUAL, CASH_PROMOTION)."},"amount":{"type":"number","example":1000},"currency":{"$ref":"#/components/schemas/currency"},"status":{"type":"integer","example":1,"description":"Numeric deposit status code. See statusMessage for the human-readable status text on this event.","enum":[0,1,2,3,5,14,15,16,-1],"x-enumDescriptions":{"0":"STARTED — Deposit has been initiated.","1":"PENDING — Every new deposit for a self-directed account is set to \"Pending\". From here, the deposit can be marked as \"Rejected\", \"On Hold\" or \"Approved\".","2":"SUCCESSFUL — A Deposit has been successfully processed and completed.","3":"FAILED — The Deposit was unable to be completed.","5":"RETURNED — A deposit is marked as returned if DriveWealth receives notification from our bank that the deposit had failed.","14":"APPROVED — Once marked as \"Approved\", the deposit will be processed.","15":"REJECTED — Updating a deposit to \"Rejected\" will immediately set its status to \"Failed\".","16":"ON_HOLD — Status is reserved for deposits that are not ready for processing.","-1":"Unknown — Reserved for errors."}},"statusMessage":{"type":"string","example":"Pending"},"statusComment":{"type":"string","example":""},"statusPhase":{"type":"string","example":"BUYING_POWER_WITHHELD"},"created":{"$ref":"#/components/schemas/created"},"userID":{"$ref":"#/components/schemas/userID"},"accountID":{"$ref":"#/components/schemas/accountID"},"transactionCode":{"type":"string","example":"RECEIPT_IRA_ROLLOVER"},"description":{"type":"string","example":"Cash Receipt - Rollover IRA Contribution"},"note":{"type":"string","example":"Here's some money"},"finTranRef":{"type":"string","example":"GA.123e4567-e89b-12d3-a456-00000000006d"},"depositBuyingPowerHoldExpires":{"type":"string","example":"2026-07-26T00:00:00Z"},"seasoningPeriodExpires":{"type":"string","example":"2026-07-27T00:00:00Z"},"recurringDepositID":{"type":"string","example":"BBBB009003-1234567890148-DXUHG"},"failureReason":{"type":"string","example":"Unable to create either deposit or redemption finTran"},"metadata":{"type":"object","properties":{"clientDepositRef":{"type":"string","example":"DEP-20260807-0042"}}}}},"DepositCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000006c"},"type":{"type":"string","enum":["deposits.created"],"x-enumDescriptions":{"deposits.created":"Identifies this as a deposit-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/DepositEventPayload"}}},"DepositUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000006e"},"type":{"type":"string","enum":["deposits.updated"],"x-enumDescriptions":{"deposits.updated":"Identifies this as a deposit-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T09:12:41.905118146Z"},"payload":{"$ref":"#/components/schemas/DepositEventPayload"}}},"WithdrawalEventPayload":{"type":"object","properties":{"paymentID":{"type":"string","example":"BBBB009003-1234567890147-RXUCH"},"category":{"type":"string","enum":["REDEMPTION"],"x-enumDescriptions":{"REDEMPTION":"The transaction category: a redemption/withdrawal."}},"type":{"type":"string","example":"WIRE","description":"The method/form of the withdrawal (e.g. WIRE, ACH)."},"amount":{"type":"number","example":-100},"currency":{"$ref":"#/components/schemas/currency"},"status":{"type":"integer","example":1,"description":"Numeric status code — see statusMessage for the human-readable status."},"statusMessage":{"type":"string","example":"Pending"},"userID":{"$ref":"#/components/schemas/userID"},"accountID":{"$ref":"#/components/schemas/accountID"},"transactionCode":{"type":"string","example":"RECEIPT_WIRE"},"description":{"type":"string","example":"Cash Disbursement - Wire"},"note":{"type":"string","example":"Here's some money"},"finTranRef":{"type":"string","example":"GA.123e4567-e89b-12d3-a456-00000000006d"},"metadata":{"type":"object","properties":{"clientWithdrawalRef":{"type":"string","example":"WD-20260807-0043"}}},"statusComment":{"type":"string","example":"Valid Instant Funding redemption. Auto-move to Approved. Waiting on settlement."}}},"WithdrawalCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000006f"},"type":{"type":"string","enum":["redemptions.created"],"x-enumDescriptions":{"redemptions.created":"Identifies this as a withdrawal-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-24T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/WithdrawalEventPayload"}}},"WithdrawalUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000070"},"type":{"type":"string","enum":["redemptions.updated"],"x-enumDescriptions":{"redemptions.updated":"Identifies this as a withdrawal-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-24T09:12:41.905118146Z"},"payload":{"$ref":"#/components/schemas/WithdrawalEventPayload"}}},"PositionSnapshot":{"type":"object","description":"A position's state at a point in time.","properties":{"costBasis":{"type":"number","example":23.94},"openQty":{"type":"number","example":1.944},"symbol":{"type":"string","example":"AAON"},"avgPrice":{"type":"number","example":12.32},"fmvTransferPx":{"type":"number","example":0,"description":"Fair-market-value transfer price — present on positions received via an incoming share transfer."}}},"PositionUpdatedEventPayload":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"},"updateReason":{"type":"string","example":"MANUAL","enum":["MANUAL","SPINOFF","STOCK_SPLIT","ACATS_STOCK","OPTION_CA","EXERCISE","EXPIRED","ASSIGNMENT","SYMBOL_CHANGE","STOCK_DIV","FI_FULL_CALL","MERGER_AND_ACQUISITION"],"x-enumDescriptions":{"MANUAL":"A manual adjustment.","SPINOFF":"A spinoff corporate action.","STOCK_SPLIT":"A stock split corporate action.","ACATS_STOCK":"An ACATS stock transfer.","OPTION_CA":"An options corporate action.","EXERCISE":"An option exercise.","EXPIRED":"An option expiration.","ASSIGNMENT":"An option assignment.","SYMBOL_CHANGE":"A ticker symbol change.","STOCK_DIV":"A stock dividend.","FI_FULL_CALL":"A full call of a fixed income instrument.","MERGER_AND_ACQUISITION":"A merger or acquisition corporate action."}},"previous":{"$ref":"#/components/schemas/PositionSnapshot"},"current":{"$ref":"#/components/schemas/PositionSnapshot"},"spinoff":{"type":"object","description":"Present when updateReason is SPINOFF.","properties":{"parentCompanySymbol":{"type":"string","example":"CLEG"}}},"acats":{"type":"object","description":"Present when updateReason is ACATS_STOCK.","properties":{"type":{"type":"string","example":"INCOMING","enum":["INCOMING","OUTGOING"],"x-enumDescriptions":{"INCOMING":"An incoming ACATS transfer.","OUTGOING":"An outgoing ACATS transfer."}},"brokerDTCNo":{"type":"string","example":"524"},"referenceNo":{"type":"string","example":"ACAT00001"},"controlNo":{"type":"string","example":"99999999999999"}}},"from":{"type":"object","description":"Present when updateReason is OPTION_CA — the position being closed out.","properties":{"symbol":{"type":"string","example":"AAPL231110C00250000"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"previous":{"$ref":"#/components/schemas/PositionSnapshot"},"current":{"$ref":"#/components/schemas/PositionSnapshot"}}},"to":{"type":"object","description":"Present when updateReason is OPTION_CA — the position being opened.","properties":{"symbol":{"type":"string","example":"AAPL231110C00265000"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"previous":{"$ref":"#/components/schemas/PositionSnapshot"},"current":{"$ref":"#/components/schemas/PositionSnapshot"}}},"comment":{"type":"string","example":"ADJUST POS MOVED TO DW ERROR"}}},"PositionUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000071"},"type":{"type":"string","enum":["positions.updated"],"x-enumDescriptions":{"positions.updated":"Identifies this as a position-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-25T14:22:03.500118146Z"},"payload":{"$ref":"#/components/schemas/PositionUpdatedEventPayload"}}},"DocumentCreatedEventPayload":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"documentID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000169"},"taxForm":{"type":"object","properties":{"type":{"type":"string","example":"W-8BEN"},"w8expires":{"type":"string","example":"2028-12-31"},"w8Received":{"type":"string","example":"2026-07-29"},"s3UrlLink":{"type":"string","format":"url","example":"https://S3URLLink...."}}}}},"DocumentCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000112"},"type":{"type":"string","enum":["documents.created"],"x-enumDescriptions":{"documents.created":"Identifies this as a document-created event."}},"object":{"type":"string","example":"TAX"},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/DocumentCreatedEventPayload"}}},"EntityCreatedEventPayload":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000113"},"ibID":{"$ref":"#/components/schemas/parentIBID"},"wlpID":{"type":"string","example":"INTR"},"type":{"type":"string","enum":["CORPORATION","LLC","TRUST","PARTNERSHIP"],"x-enumDescriptions":{"CORPORATION":"A corporation.","LLC":"A Limited Liability Company.","TRUST":"A trust.","PARTNERSHIP":"A partnership."}},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"TENDIES TRADING SAU"},"dba":{"type":"string","example":"TENDIES TRADING ( TTC )"},"incorporationCountry":{"type":"string","example":"USA"},"incorporationProvince":{"type":"string","example":"NY"},"incorporationDate":{"type":"string","format":"date","example":"2001-03-09"}}},"identifications":{"type":"object","description":"Entity identification numbers, keyed uppercase.","properties":{"EIN":{"type":"string"},"FTIN":{"type":"string","example":"00-00000000-0"},"GIIN":{"type":"string"},"FTNLO":{"type":"boolean"},"SSN":{"type":"string"}}},"contact":{"type":"object","properties":{"addresses":{"type":"object","additionalProperties":{"type":"object","properties":{"street1":{"type":"string","example":"123 Main Street, Suite 201"},"street2":{"type":"string"},"city":{"type":"string","example":"New York"},"province":{"type":"string","example":"NY"},"zipcode":{"type":"string","example":"00000"},"country":{"type":"string","example":"USA"}}},"example":{"PRIMARY":{"street1":"123 Main Street, Suite 201","city":"New York","province":"NY","zipcode":"00000","country":"USA"}}},"phone":{"type":"string","example":"+15555550100"},"email":{"type":"string","example":"compliance@example.com"},"website":{"type":"string","example":"https://www.example.com"}}},"metadata":{"type":"object","description":"Free-form partner metadata — shape varies by partner integration."},"disclosures":{"type":"object","additionalProperties":{"type":"object","properties":{"agreed":{"type":"boolean"},"signedBy":{"type":"string"},"signedWhen":{"type":"string"},"disclosureName":{"type":"string"}}}},"kyb":{"type":"object","properties":{"status":{"type":"string","example":"KYB_NOT_READY"},"statusWhen":{"type":"string"},"statusBy":{"type":"string","example":"SYSTEM"}}},"tax":{"type":"string","example":"TAX_READY"},"taxData":{"type":"object","properties":{"fatcaData":{"type":"object","properties":{"applicable":{"type":"boolean"},"applicableFrom":{"type":"string"},"setBy":{"type":"string"}}},"data":{"type":"object","description":"Map of tax status code to tax information."}}},"status":{"$ref":"#/components/schemas/businessStatus"},"createdAt":{"type":"string","example":"2026-07-01T17:42:00.755082493Z"}}},"EntityKybSnapshot":{"type":"object","properties":{"status":{"type":"string","example":"KYB_APPROVED"},"statusWhen":{"type":"string","example":"2026-07-16T13:44:39.059Z"},"statusBy":{"type":"string","example":"SYSTEM"},"verificationKey":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"K201"},"description":{"type":"string","example":"The KYB is approved."}}}}}},"EntityDirectorSnapshot":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000114"},"roles":{"type":"array","items":{"type":"string","example":"CONTROL_PERSON"}},"title":{"type":"string","example":"Director"},"firstName":{"type":"string","example":"MATIAS IVAN"},"lastName":{"type":"string","example":"RICIGNOLO"},"kycStatus":{"type":"string","example":"KYC_APPROVED"}}},"EntityTaxDataSnapshot":{"type":"object","properties":{"fatcaData":{"type":"object","properties":{"applicable":{"type":"boolean"},"applicableFrom":{"type":"string"},"setBy":{"type":"string"}}},"vendor":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string","example":"Comply Exchange"},"taxFormUrl":{"type":"string"},"formUrlDate":{"type":"string"}}},"example":{"COMPLY_EXCHANGE":{"name":"Comply Exchange","taxFormUrl":"https://drivewealth.complytaxforms.com/ServiceRedirect.aspx?UUID=...","formUrlDate":"2026-07-21T17:41:47.874Z"}}},"data":{"type":"object","description":"Map of tax form/status code to tax information — only changed fields appear on a diff.","additionalProperties":{"type":"object","properties":{"formType":{"type":"string","example":"W8BENE"},"status":{"type":"string","example":"TAX_APPROVED"},"statusWhen":{"type":"string"},"statusBy":{"type":"string","example":"COMPLY_EXCHANGE"},"receivedFrom":{"type":"string"},"receivedWhen":{"type":"string"},"expiresWhen":{"type":"string"},"taxTreatyBenefitClaimed":{"type":"boolean"},"chapter3StatusW8":{"type":"string"},"chapter4StatusW8":{"type":"string"},"chapter3Status1042S":{"type":"string"},"chapter4Status1042S":{"type":"string"}}}}}},"EntityUpdatedEventPayload":{"type":"object","description":"Shows only the fields that changed — previous/current can carry any subset of entity fields (kyb, directors, tax, taxData, etc.).","properties":{"previous":{"type":"object","properties":{"kyb":{"$ref":"#/components/schemas/EntityKybSnapshot"},"directors":{"type":"array","items":{"$ref":"#/components/schemas/EntityDirectorSnapshot"}},"tax":{"type":"string","example":"TAX_READY"},"taxData":{"$ref":"#/components/schemas/EntityTaxDataSnapshot"}}},"current":{"type":"object","properties":{"kyb":{"$ref":"#/components/schemas/EntityKybSnapshot"},"directors":{"type":"array","items":{"$ref":"#/components/schemas/EntityDirectorSnapshot"}},"tax":{"type":"string","example":"TAX_PROCESSING"},"taxData":{"$ref":"#/components/schemas/EntityTaxDataSnapshot"}}},"entityID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000115"}}},"EntityCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000116"},"type":{"type":"string","enum":["entity.created"],"x-enumDescriptions":{"entity.created":"Identifies this as an entity-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/EntityCreatedEventPayload"}}},"EntityUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000117"},"type":{"type":"string","enum":["entity.updated"],"x-enumDescriptions":{"entity.updated":"Identifies this as an entity-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/EntityUpdatedEventPayload"}}},"KYCStatusSnapshot":{"type":"object","properties":{"status":{"type":"string","example":"KYC_APPROVED"},"statusMessage":{"type":"string","example":"KYC Approved"},"details":{"type":"array","items":{"type":"string"},"example":["POOR_PHOTO_QUALITY"],"description":"Present for some statuses (e.g. KYC_DOC_REQUIRED, KYC_PROCESSING, KYC_MANUAL_REVIEW) with status-specific reason codes."}}},"KYCCreatedEventPayload":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"status":{"type":"string","example":"KYC_APPROVED"},"statusMessage":{"type":"string","example":"KYC Approved"},"verificationType":{"type":"string","example":"NON_DOC"}}},"KYCUpdatedEventPayload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/KYCStatusSnapshot"},"previous":{"$ref":"#/components/schemas/KYCStatusSnapshot"},"userID":{"$ref":"#/components/schemas/userID"}}},"KYCCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000118"},"type":{"type":"string","enum":["kyc.created"],"x-enumDescriptions":{"kyc.created":"Identifies this as a KYC-created event."}},"ibID":{"$ref":"#/components/schemas/parentIBID"},"object":{"type":"string","example":"KYC_CREATED"},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/KYCCreatedEventPayload"}}},"KYCUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000119"},"type":{"type":"string","enum":["kyc.updated"],"x-enumDescriptions":{"kyc.updated":"Identifies this as a KYC-updated event."}},"ibID":{"$ref":"#/components/schemas/parentIBID"},"object":{"type":"string","example":"KYC_UPDATED"},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/KYCUpdatedEventPayload"}}},"UserStatusSnapshot":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/userStatus"},"description":{"type":"string","example":"User is pending approval."}}},"UserCreatedEventPayload":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"status":{"$ref":"#/components/schemas/UserStatusSnapshot"}}},"UserFieldsSnapshot":{"type":"object","description":"Any subset of user fields can appear here — only what changed is included.","properties":{"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"email":{"type":"string","example":"jane.doe@example.com"},"avatarURL":{"type":"string","example":"https://secure.gravatar.com/avatar/00000000000000000000000000000000.jpg"},"phone":{"type":"string","example":"+15555550100"},"addressLine1":{"type":"string","example":"1 Main St"},"addressLine2":{"type":"string","example":"910"},"city":{"type":"string","example":"Astoria"},"stateProvince":{"type":"string","example":"BA"},"zipPostalCode":{"type":"string","example":"*****XXXX"},"employerCompany":{"type":"string","example":"City Vending"},"employmentStatus":{"type":"object","properties":{"name":{"type":"string","example":"EMPLOYED"},"description":{"type":"string","example":"Employed"}}},"idType":{"type":"object","properties":{"name":{"type":"string","example":"OTHER"},"description":{"type":"string","example":"TIN"}}},"annualIncomeRange":{"type":"string","example":"$0 - $24,999"},"networthLiquidRange":{"type":"string","example":"Unknown"},"networthTotalRange":{"type":"string","example":"$100,000 - $199,999"},"irsBackupWithholdings":{"type":"boolean","example":true},"taxCountry":{"type":"string","example":"CHL"},"taxTreatyWithUS":{"type":"boolean","example":true},"taxAttestation":{"type":"object","description":"Present when the user (re-)signs their tax attestation.","properties":{"signedBy":{"$ref":"#/components/schemas/userID"},"signedWhen":{"type":"string","example":"2026-08-24T19:37:56Z"}}},"w8received":{"type":"string","example":"2026-08-24"},"w8expires":{"type":"string","example":"2029-12-31"},"ackCustomerAgreement":{"type":"boolean","example":true},"ackForeignFindersFee":{"type":"boolean","example":false},"ackExtendedHoursAgreement":{"type":"boolean","example":true},"ackIRAAgreement":{"type":"boolean","example":true},"ackMarginAgreement":{"type":"boolean","example":true},"ackMarginAgreementWhen":{"type":"string","example":"2026-08-24T19:37:22.237Z"},"ackFPSLAgreementWhen":{"type":"string","example":"2026-08-24T19:38:45.147Z"},"metadata":{"type":"object","description":"Free-form partner metadata — shape varies by partner integration.","properties":{"btgUserData":{"type":"object","properties":{"cge":{"type":"string","example":"1007656"},"lastOperationId":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000011a"}}}}},"updatedBy":{"$ref":"#/components/schemas/userID"},"updatedWhen":{"$ref":"#/components/schemas/updated"}}},"UserUpdatedEventPayload":{"type":"object","properties":{"previous":{"$ref":"#/components/schemas/UserFieldsSnapshot"},"current":{"$ref":"#/components/schemas/UserFieldsSnapshot"},"userID":{"$ref":"#/components/schemas/userID"}}},"UserInfoRequiredCreatedEventPayload":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"driveClientLink":{"type":"string","format":"url","example":"https://client.drivewealth.com/"}}},"UserCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000118"},"type":{"type":"string","enum":["users.created"],"x-enumDescriptions":{"users.created":"Identifies this as a user-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/UserCreatedEventPayload"}}},"UserUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007c"},"type":{"type":"string","enum":["users.updated"],"x-enumDescriptions":{"users.updated":"Identifies this as a user-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/UserUpdatedEventPayload"}}},"UserInfoRequiredCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000011b"},"type":{"type":"string","enum":["user.inforequired.created"],"x-enumDescriptions":{"user.inforequired.created":"Identifies this as a user-info-required event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/UserInfoRequiredCreatedEventPayload"}}},"StatementCreatedEventPayload":{"type":"object","properties":{"statement":{"$ref":"#/components/schemas/statementObj"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"}}},"TradeConfirmCreatedEventPayload":{"type":"object","properties":{"tradeConfirm":{"$ref":"#/components/schemas/tradeConfirmObj"},"orders":{"type":"object","description":"Map of trade date (YYYY-MM-DD) to the order IDs included in this trade confirmation.","additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"2026-04-28":["OOOO000066","NNNN000065"]}},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"}}},"TaxFormCreatedEventPayload":{"type":"object","properties":{"taxForm":{"$ref":"#/components/schemas/taxStatementObj"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"}}},"StatementCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007c"},"type":{"type":"string","enum":["statements.created"],"x-enumDescriptions":{"statements.created":"Identifies this as a statement-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/StatementCreatedEventPayload"}}},"TradeConfirmCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007c"},"type":{"type":"string","enum":["tradeconfirms.created"],"x-enumDescriptions":{"tradeconfirms.created":"Identifies this as a trade-confirm-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/TradeConfirmCreatedEventPayload"}}},"TaxFormCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007c"},"type":{"type":"string","enum":["taxforms.created"],"x-enumDescriptions":{"taxforms.created":"Identifies this as a tax-form-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/TaxFormCreatedEventPayload"}}},"LinkedBankAccountEventPayload":{"type":"object","description":"Standard link includes bankAccountNumber/bankRoutingNumber/bankAccountType; a Plaid-linked account instead has plaidProcessorToken. The real event `type` also inconsistently varies between singular `bankAccount.created` and plural `bankAccounts.created` for the same created scenario.","properties":{"userID":{"$ref":"#/components/schemas/userID"},"bankAccountNickname":{"$ref":"#/components/schemas/bankAccountNickName"},"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumberLastFour"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumber"},"bankAccountType":{"type":"string","example":"Saving"},"plaidProcessorToken":{"type":"string","example":"processor-sandbox-123e4567-e89b-12d3-a456-00000000007d","description":"Present when the bank account was linked via Plaid instead of manual entry."},"status":{"$ref":"#/components/schemas/bankAccountStatus"},"created":{"$ref":"#/components/schemas/created"},"updated":{"$ref":"#/components/schemas/updated"},"bankAccountDetails":{"type":"object","description":"Present for international/travel-rule-eligible transfers — carries bank/beneficiary address details beyond the standard number/routing fields.","properties":{"bankAddress":{"type":"string","example":"1 Bank Plaza, Sample City, ST, 00000"},"bankCountry":{"type":"string","example":"ARE"},"bankName":{"type":"string","example":"Akbank"},"beneficiaryDetails":{"type":"object","properties":{"accountHolderAddress":{"type":"string","example":"1 Main St Apt 2,Anytown,ST,00000"},"accountHolderCountry":{"type":"string","example":"ARE"},"accountHolderName":{"type":"string","example":"ABDULKADIR KARADEMIR"}}},"default":{"type":"boolean","example":false}}},"bankAccountPurpose":{"type":"string","example":"TRAVEL_RULE"}}},"LinkedBankAccountCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007c"},"type":{"type":"string","enum":["bankAccounts.created"],"x-enumDescriptions":{"bankAccounts.created":"Identifies this as a linked-bank-account-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/LinkedBankAccountEventPayload"}}},"LinkedBankAccountUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007e"},"type":{"type":"string","enum":["bankAccounts.updated"],"x-enumDescriptions":{"bankAccounts.updated":"Identifies this as a linked-bank-account-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/LinkedBankAccountEventPayload"}}},"LinkedBankAccountDeletedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007f"},"type":{"type":"string","enum":["bankAccounts.deleted"],"x-enumDescriptions":{"bankAccounts.deleted":"Identifies this as a linked-bank-account-deleted event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/LinkedBankAccountEventPayload"}}},"InstrumentSnapshot":{"type":"object","properties":{"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"type":"string","example":"MS"},"name":{"type":"string","example":"Morgan Stanley"},"description":{"type":"string","example":"AAPL 0003 DESC"},"status":{"type":"string","example":"ACTIVE","enum":["ACTIVE","INACTIVE"],"x-enumDescriptions":{"ACTIVE":"The instrument is tradable.","INACTIVE":"The instrument is not tradable."}},"type":{"type":"string","example":"OPTION"},"rootSymbol":{"type":"string","example":"AAPL"},"rootId":{"$ref":"#/components/schemas/instrumentID"},"expirationDate":{"type":"string","example":"2026-10-10"},"optionType":{"type":"string","example":"PUT","enum":["PUT","CALL"],"x-enumDescriptions":{"PUT":"A put option, giving the right to sell the underlying instrument.","CALL":"A call option, giving the right to buy the underlying instrument."}},"strikePrice":{"type":"number","example":30},"sharesPerContract":{"type":"number","example":100},"exchange":{"type":"string","example":"24"},"enableExtendedHoursNotionalStatus":{"type":"string","example":"INACTIVE"},"overnightTradingStatus":{"type":"string","example":"INACTIVE"}}},"InstrumentUpdatedEventPayload":{"type":"object","properties":{"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"previous":{"type":"object","properties":{"status":{"type":"string","example":"ACTIVE"},"symbol":{"type":"string","example":"SBLX"}}},"current":{"type":"object","properties":{"status":{"type":"string","example":"ACTIVE"},"symbol":{"type":"string","example":"FABC"}}}}},"InstrumentCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000080"},"type":{"type":"string","enum":["instruments.created"],"x-enumDescriptions":{"instruments.created":"Identifies this as an instrument-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/InstrumentSnapshot"}}},"InstrumentUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000011c"},"type":{"type":"string","enum":["instruments.updated"],"x-enumDescriptions":{"instruments.updated":"Identifies this as an instrument-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-08-24T19:21:45.500063369Z"},"payload":{"$ref":"#/components/schemas/InstrumentUpdatedEventPayload"}}},"EventClearingNo":{"type":"string","example":"0001","description":"The DTCC clearing number of the broker.","minLength":1,"maxLength":4},"AssetTransferStatusSnapshot":{"type":"object","description":"A code/enum value paired with a human-readable description.","properties":{"name":{"type":"string","example":"ACAT"},"description":{"type":"string","example":"ACAT transfer"}}},"AssetTransferRejectionInfo":{"type":"object","description":"Webhook events send rejectionCode as the numeric DTCC code (e.g. \"05\"), not the name form used by AssetTransferAPI.json's AcatRejectionCode enum (e.g. \"BROKER_NOT_MATCH\") — defined as a free string here rather than forcing a too-narrow $ref. See AcatRejectionCode's enum descriptions in AssetTransferAPI.json for the code↔name mapping.","properties":{"rejectionCode":{"type":"string","example":"05","description":"The numeric DTCC rejection code. Equivalent to the name-form AcatRejectionCode enum used in REST responses — see its enum descriptions in AssetTransferAPI.json for the code↔name mapping."},"rejectionReason":{"type":"string","example":"Invalid Broker Account Number"},"positions":{"type":"object","description":"Map of symbol/CUSIP to a per-security rejection message — present when specific positions (not the whole transfer) were rejected.","additionalProperties":{"type":"string"}},"cash":{"type":"number","example":-12.25,"description":"Present when the rejection is due to a cash/debit-balance issue."}}},"AcatSettlementStatus":{"type":"string","description":"Reference only — not used as a field type. Documents the known DTCC ACATS settlement status values; the actual settlementStatus field is an open string since DTCC may introduce values not listed here. Each value's description lists the raw settlementCode value(s) it corresponds to.","example":"ACAT_REVIEW_ACCEPTED","enum":["ACAT_RECEIVED","ACAT_READY","ACAT_READY_AFTER_CUTOFF","ACAT_SENT","ACAT_ACK","ACAT_ADJUST","ACAT_IN_PROGRESS","ACAT_UNDER_REVIEW","ACAT_REVIEW_ACK","ACAT_REVIEW_SENT","ACAT_REVIEW_ADJUST","ACAT_REVIEW_ERROR","ACAT_REVIEW_ACCEPTED","ACAT_PTR_IN_PROGRESS","ACAT_SETTLEMENT_IN_PROGRESS","ACAT_SETTLED","ACAT_REJECTED","ACAT_PURGE","ACAT_PTR_REJECTED"],"x-enumDescriptions":{"ACAT_RECEIVED":"Code 000. The ACAT request has been received by the clearing system.","ACAT_READY":"Code 1ED. The ACAT request is ready to be sent to the contra firm.","ACAT_READY_AFTER_CUTOFF":"Code 1EL. The ACAT request is ready but was received after the daily processing cutoff.","ACAT_SENT":"Codes TXX, TIF, TIL. The ACAT request has been sent to the contra firm.","ACAT_ACK":"Code 100. The contra firm has acknowledged receipt of the ACAT request.","ACAT_ADJUST":"Codes 110, 120. The ACAT request was adjusted.","ACAT_IN_PROGRESS":"Code 130. The ACAT request is in progress.","ACAT_UNDER_REVIEW":"Code 200. The ACAT request is under review by the receiving firm.","ACAT_REVIEW_ACK":"Codes 2ED, 2EL, 22D, 22L, 22X. The receiving firm has acknowledged the ACAT review.","ACAT_REVIEW_SENT":"Code 2XX. The ACAT review response has been sent.","ACAT_REVIEW_ADJUST":"Code 210. The ACAT review was adjusted.","ACAT_REVIEW_ERROR":"Code 220. An error occurred during the ACAT review.","ACAT_REVIEW_ACCEPTED":"Code 230. The ACAT review was accepted by the receiving firm.","ACAT_PTR_IN_PROGRESS":"Code 500. The position transfer (PTR) is in progress.","ACAT_SETTLEMENT_IN_PROGRESS":"Code 300. The ACAT is in the settlement process.","ACAT_SETTLED":"Code 310. The ACAT has settled.","ACAT_REJECTED":"Codes 140, 600. The ACAT request was rejected.","ACAT_PURGE":"Code 400. The ACAT request was purged from the system.","ACAT_PTR_REJECTED":"Code 510. The position transfer (PTR) was rejected."}},"AssetTransferEventPayload":{"type":"object","description":"ACAT transfers include clearingNo/acatsType/sourceAccountType/settlementStatus/settlementCode/rejectionInfo; Teen account migrations use a smaller subset of these same fields.","properties":{"transferID":{"type":"string","example":"acats_123e4567-e89b-12d3-a456-00000000011d"},"source":{"type":"string","example":"FOLIO123"},"destination":{"type":"string","example":"GGGG000032"},"clearingNo":{"$ref":"#/components/schemas/EventClearingNo"},"status":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"type":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"sourceAccountType":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"cash":{"type":"number","example":11500.81,"description":"Cash amount included in the transfer, when applicable."},"positions":{"type":"object","description":"Map of instrumentID to share quantity involved in the transfer.","additionalProperties":{"type":"number"}},"comment":{"type":"string","example":"comment example"},"settlementStatus":{"type":"string","example":"ACAT_REVIEW_ACCEPTED","description":"The DTCC ACATS settlement status. Kept as an open string, not a closed enum, because DTCC (not DriveWealth) controls this vocabulary and may introduce new values. See the AcatSettlementStatus schema for the known values and their settlementCode mapping — non-exhaustive."},"settlementCode":{"type":"string","example":"230","description":"The raw DTCC settlement code. Several codes can map to the same settlementStatus name — see the AcatSettlementStatus schema for the known code list — non-exhaustive."},"rejectionInfo":{"$ref":"#/components/schemas/AssetTransferRejectionInfo"},"metadata":{"type":"object"},"created":{"$ref":"#/components/schemas/created"},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000011e"},"updated":{"$ref":"#/components/schemas/updated"},"updatedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000011e"},"acatType":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"transitType":{"type":"integer","example":1}}},"AssetTransferUpdateSnapshot":{"type":"object","description":"Includes the transfer's near-complete current state, not just the changed fields.","properties":{"acatType":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"cash":{"type":"number","example":0.03},"clearingNo":{"$ref":"#/components/schemas/EventClearingNo"},"comment":{"type":"string","example":"comment example"},"controlNo":{"type":"string","example":"99999999999999","description":"DTCC control number — assigned once the transfer enters review."},"created":{"$ref":"#/components/schemas/created"},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000011e"},"destination":{"type":"string","example":"GGGG000032"},"metadata":{"type":"object"},"positions":{"type":"object","description":"Map of instrumentID to share quantity involved in the transfer.","additionalProperties":{"type":"number"}},"settlementCode":{"type":"string","example":"230","description":"The raw DTCC settlement code. Several codes can map to the same settlementStatus name — see the AcatSettlementStatus schema for the known code list — non-exhaustive."},"settlementStatus":{"type":"string","example":"ACAT_REVIEW_ACCEPTED","description":"The DTCC ACATS settlement status. Kept as an open string, not a closed enum, because DTCC (not DriveWealth) controls this vocabulary and may introduce new values. See the AcatSettlementStatus schema for the known values and their settlementCode mapping — non-exhaustive."},"source":{"type":"string","example":"FOLIO123"},"sourceAccountType":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"status":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"transferID":{"type":"string","example":"acats_123e4567-e89b-12d3-a456-00000000011d"},"transitType":{"type":"integer","example":1},"type":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"updated":{"$ref":"#/components/schemas/updated"},"updatedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000011e"},"rejectionInfo":{"$ref":"#/components/schemas/AssetTransferRejectionInfo"}}},"AssetTransferUpdatedEventPayload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/AssetTransferUpdateSnapshot"},"previous":{"$ref":"#/components/schemas/AssetTransferUpdateSnapshot"},"transferID":{"type":"string","example":"acats_123e4567-e89b-12d3-a456-00000000011d"}}},"AssetTransferCompletedSnapshot":{"type":"object","description":"Same near-complete-snapshot shape as AssetTransferUpdateSnapshot.","properties":{"acatType":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"cash":{"type":"number","example":0.03},"clearingNo":{"$ref":"#/components/schemas/EventClearingNo"},"comment":{"type":"string","example":"comment example"},"controlNo":{"type":"string","example":"99999999999999","description":"DTCC control number — assigned once the transfer enters review."},"created":{"$ref":"#/components/schemas/created"},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000011e"},"destination":{"type":"string","example":"GGGG000032"},"metadata":{"type":"object"},"positions":{"type":"object","description":"Map of instrumentID to share quantity involved in the transfer.","additionalProperties":{"type":"number"}},"settlementCode":{"type":"string","example":"230","description":"The raw DTCC settlement code. Several codes can map to the same settlementStatus name — see the AcatSettlementStatus schema for the known code list — non-exhaustive."},"settlementStatus":{"type":"string","example":"ACAT_REVIEW_ACCEPTED","description":"The DTCC ACATS settlement status. Kept as an open string, not a closed enum, because DTCC (not DriveWealth) controls this vocabulary and may introduce new values. See the AcatSettlementStatus schema for the known values and their settlementCode mapping — non-exhaustive."},"source":{"type":"string","example":"FOLIO123"},"sourceAccountType":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"status":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"transferID":{"type":"string","example":"acats_123e4567-e89b-12d3-a456-00000000011d"},"transitType":{"type":"integer","example":1},"type":{"$ref":"#/components/schemas/AssetTransferStatusSnapshot"},"updated":{"$ref":"#/components/schemas/updated"},"updatedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000011e"},"rejectionInfo":{"$ref":"#/components/schemas/AssetTransferRejectionInfo"}}},"AssetTransferCompletedEventPayload":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/AssetTransferCompletedSnapshot"},"previous":{"$ref":"#/components/schemas/AssetTransferCompletedSnapshot"},"transferID":{"type":"string","example":"acats_123e4567-e89b-12d3-a456-00000000011d"}}},"AssetTransferCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000011f"},"type":{"type":"string","enum":["assets.transfer.created"],"x-enumDescriptions":{"assets.transfer.created":"Identifies this as an asset-transfer-created event."}},"object":{"type":"string","example":"ACAT","enum":["ACAT","TEEN"],"x-enumDescriptions":{"ACAT":"An ACATS transfer.","TEEN":"A minor-to-adult (teen graduation) internal transfer."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/AssetTransferEventPayload"}}},"AssetTransferUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000120"},"type":{"type":"string","enum":["assets.transfer.updated"],"x-enumDescriptions":{"assets.transfer.updated":"Identifies this as an asset-transfer-updated event."}},"object":{"type":"string","example":"ACAT","enum":["ACAT","TEEN"],"x-enumDescriptions":{"ACAT":"An ACATS transfer.","TEEN":"A minor-to-adult (teen graduation) internal transfer."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/AssetTransferUpdatedEventPayload"}}},"AssetTransferCompletedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000120"},"type":{"type":"string","enum":["assets.transfer.completed"],"x-enumDescriptions":{"assets.transfer.completed":"Identifies this as an asset-transfer-completed event."}},"object":{"type":"string","example":"ACAT","enum":["ACAT","TEEN"],"x-enumDescriptions":{"ACAT":"An ACATS transfer.","TEEN":"A minor-to-adult (teen graduation) internal transfer."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/AssetTransferCompletedEventPayload"}}},"CancelRebillPosition":{"type":"object","properties":{"accountNo":{"$ref":"#/components/schemas/accountNo"},"symbol":{"type":"string","example":"VOO"},"openQuantity":{"type":"number","example":1.29311295},"avgPrice":{"type":"number","example":400.54},"costbasis":{"type":"number","example":517.94346099,"description":"Lowercase in the wire format, unlike costBasis elsewhere in this spec (e.g. PositionSnapshot) — confirmed against real Cancel Rebill payloads. Flagged to the producing team to align casing; do not rename here until they confirm a change."},"updated":{"$ref":"#/components/schemas/updated"}}},"CancelRebillEventPayload":{"type":"object","properties":{"status":{"type":"string","example":"PENDING","enum":["STARTED","APPROVED","ON_HOLD","REJECTED","PENDING","SUCCESSFUL","COMPLETED"],"x-enumDescriptions":{"STARTED":"The cancel/rebill request was started.","APPROVED":"The cancel/rebill request was approved.","ON_HOLD":"The cancel/rebill request is on hold.","REJECTED":"The cancel/rebill request was rejected.","PENDING":"The cancel/rebill request is pending.","SUCCESSFUL":"The cancel/rebill request completed successfully.","COMPLETED":"The cancel/rebill request is complete."}},"cancelRebillID":{"type":"string","example":"cxl_rbl_123e4567-e89b-12d3-a456-000000000089"},"reason":{"type":"string","example":"FRAUD","enum":["FRAUD","PRICE_ADJUSTMENT_PARTNER","PRICE_ADJUSTMENT_VENUE","DRIVEWEALTH_TECHNICAL_ERROR","PARTNER_TECHNICAL_ERROR","VENDOR_ERROR"],"x-enumDescriptions":{"FRAUD":"The original transaction was fraudulent.","PRICE_ADJUSTMENT_PARTNER":"A price adjustment requested by the partner.","PRICE_ADJUSTMENT_VENUE":"A price adjustment initiated by the execution venue.","DRIVEWEALTH_TECHNICAL_ERROR":"A DriveWealth technical error.","PARTNER_TECHNICAL_ERROR":"A partner technical error.","VENDOR_ERROR":"A vendor error."}},"type":{"type":"string","example":"CANCEL","enum":["CANCEL","PRICE_ADJUSTMENT","COMMISSION_ADJUSTMENT"],"x-enumDescriptions":{"CANCEL":"The original transaction is being canceled.","PRICE_ADJUSTMENT":"The price of the original transaction is being adjusted.","COMMISSION_ADJUSTMENT":"The commission of the original transaction is being adjusted."}},"comment":{"type":"string","example":"CCCC009004-001"},"orderID":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"rebillOrderID":{"$ref":"#/components/schemas/orderID"},"rebillOrderNo":{"$ref":"#/components/schemas/orderNo"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"errorAccountNo":{"$ref":"#/components/schemas/accountNo"},"errorAccountID":{"$ref":"#/components/schemas/accountID"},"userID":{"$ref":"#/components/schemas/userID"},"quantity":{"type":"number","example":1.5},"price":{"type":"number","example":192.93},"adjustedPrice":{"type":"number","example":195.38,"description":"Present when type is PRICE_ADJUSTMENT."},"adjustedCommission":{"type":"number","example":2.49,"description":"Present when type is COMMISSION_ADJUSTMENT."},"currency":{"$ref":"#/components/schemas/currency"},"metadata":{"type":"object","properties":{"orderTrans":{"type":"string","example":"CCCC009004-001"}}},"previous":{"type":"object","description":"Present on updated and completed (not created) — the account's position before the reversal, if one existed.","properties":{"position":{"$ref":"#/components/schemas/CancelRebillPosition"}}},"current":{"type":"object","description":"Present on updated and completed (not created) — the account's position after the reversal.","properties":{"position":{"$ref":"#/components/schemas/CancelRebillPosition"}}},"clientAccountOrders":{"type":"object","description":"Present on completion — the new cancel/rebill order(s) placed on the client's account.","properties":{"cancelOrderID":{"$ref":"#/components/schemas/orderID"},"cancelOrderNo":{"$ref":"#/components/schemas/orderNo"},"rebillOrderID":{"$ref":"#/components/schemas/orderID"},"rebillOrderNo":{"$ref":"#/components/schemas/orderNo"}}},"errorAccountOrders":{"type":"object","description":"Present on completion — the offsetting order(s) placed on the error account.","properties":{"cancelOrderID":{"$ref":"#/components/schemas/orderID"},"cancelOrderNo":{"$ref":"#/components/schemas/orderNo"},"rebillOrderID":{"$ref":"#/components/schemas/orderID"},"rebillOrderNo":{"$ref":"#/components/schemas/orderNo"}}}}},"CancelRebillCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000121"},"type":{"type":"string","enum":["transfers.cancelRebill.created"],"x-enumDescriptions":{"transfers.cancelRebill.created":"Identifies this as a cancel/rebill-created event."}},"ibID":{"$ref":"#/components/schemas/parentIBID"},"object":{"type":"string","enum":["CANCEL_REBILL"],"x-enumDescriptions":{"CANCEL_REBILL":"The payload object type: a cancel/rebill request."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/CancelRebillEventPayload"}}},"CancelRebillUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000122"},"type":{"type":"string","enum":["transfers.cancelRebill.updated"],"x-enumDescriptions":{"transfers.cancelRebill.updated":"Identifies this as a cancel/rebill-updated event."}},"ibID":{"$ref":"#/components/schemas/parentIBID"},"object":{"type":"string","enum":["CANCEL_REBILL"],"x-enumDescriptions":{"CANCEL_REBILL":"The payload object type: a cancel/rebill request."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/CancelRebillEventPayload"}}},"CancelRebillCompletedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000088"},"type":{"type":"string","enum":["transfers.cancelRebill.completed"],"x-enumDescriptions":{"transfers.cancelRebill.completed":"Identifies this as a cancel/rebill-completed event."}},"ibID":{"$ref":"#/components/schemas/parentIBID"},"object":{"type":"string","enum":["CANCEL_REBILL"],"x-enumDescriptions":{"CANCEL_REBILL":"The payload object type: a cancel/rebill request."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/CancelRebillEventPayload"}}},"OrderStatusMessage":{"type":"object","description":"Present when status is REJECTED.","properties":{"errorCode":{"type":"string","example":"O105"},"message":{"type":"string","example":"Order quantity exceeds quantity available for sale.  Cannot SELL SHORT.  [orderNo=DDDD009005] [orderqty=10000.0] [openQty=20.9873] [sellingInMarket=0] [restingOrderSummary=]"}}},"OrderEventPayload":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/orderID"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"type":{"type":"string","example":"MARKET","enum":["MARKET","LIMIT"],"x-enumDescriptions":{"MARKET":"Execute immediately at the best available price.","LIMIT":"Execute only at a specified price or better."}},"side":{"type":"string","example":"BUY","enum":["BUY","SELL","BUY_OPEN","SELL_OPEN","BUY_CLOSE","SELL_CLOSE"],"x-enumDescriptions":{"BUY":"Purchase the instrument.","SELL":"Sell the instrument.","BUY_OPEN":"Open a new long options position.","SELL_OPEN":"Open a new short options position.","BUY_CLOSE":"Close an existing short options position by buying.","SELL_CLOSE":"Close an existing long options position by selling."}},"status":{"type":"string","example":"NEW","enum":["NEW","FILLED","PARTIAL_FILL","REJECTED","CANCELED","PENDING_CANCEL"],"x-enumDescriptions":{"NEW":"The order has been received but not yet processed.","FILLED":"The order has been completely filled.","PARTIAL_FILL":"The order has been partially filled.","REJECTED":"The order was rejected.","CANCELED":"The order has been canceled.","PENDING_CANCEL":"A cancel request has been submitted and is awaiting confirmation."}},"symbol":{"type":"string","example":"AAPL"},"averagePrice":{"type":"number","example":188.72},"averagePriceRaw":{"type":"number","example":2},"totalOrderAmount":{"type":"number","example":200},"price":{"type":"number","example":2,"description":"The limit price — present for LIMIT orders."},"cumulativeQuantity":{"type":"number","example":1},"openQuantity":{"type":"number"},"availableForTradingQuantity":{"type":"number"},"quantity":{"type":"number","example":1},"fees":{"type":"number","example":0},"orderExpires":{"type":"string","example":"2026-03-29T20:00:00.000Z"},"createdBy":{"$ref":"#/components/schemas/userID"},"userID":{"$ref":"#/components/schemas/userID"},"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"created":{"$ref":"#/components/schemas/created"},"timeInForce":{"type":"string","example":"DAY"},"specialHandlingInstructions":{"type":"object","properties":{"tradeInstruction":{"type":"string"}}},"statusMessage":{"$ref":"#/components/schemas/OrderStatusMessage"},"lastShares":{"type":"number","example":6},"lastPrice":{"type":"number","example":134.11},"lastExecuted":{"$ref":"#/components/schemas/created"},"lastMarket":{"type":"string","example":"DRVW"},"amountCash":{"type":"number","example":1},"metadata":{"type":"object","description":"Free-form partner/order-source metadata — shape varies by partner integration."},"preventQueuing":{"type":"boolean","example":false},"triggerPrice":{"type":"number","example":1.5,"description":"Present for stop/MIT orders."},"orderNotes":{"type":"string","example":"4905179"},"executionInstructions":{"type":"array","items":{"type":"string"},"example":[]},"extendedHours":{"type":"boolean","example":false}}},"OrderEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000008a"},"type":{"type":"string","enum":["orders.created"],"x-enumDescriptions":{"orders.created":"Identifies this as an order-created event."}},"extendedHours":{"type":"boolean","example":false},"timeInForce":{"type":"string","example":""},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/OrderEventPayload"}}},"OrderUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000007c"},"type":{"type":"string","enum":["orders.updated"],"x-enumDescriptions":{"orders.updated":"Identifies this as an order-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/OrderEventPayload"}}},"OrderCompletedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-00000000008b"},"type":{"type":"string","enum":["orders.completed"],"x-enumDescriptions":{"orders.completed":"Identifies this as an order-completed event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/OrderEventPayload"}}},"TransactionInstrumentRef":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"type":"string","example":"BPY"},"name":{"type":"string","nullable":true,"description":"Typically null for OPTIONS_EXPIRED transactions.","example":"Brookfield Property Partners L.P."}}},"TransactionDetail":{"type":"object","properties":{"accountAmount":{"type":"number","example":12},"accountBalance":{"type":"number","example":57529.64},"comment":{"type":"string","example":"22"},"finTranID":{"type":"string","example":"GC.123e4567-e89b-12d3-a456-000000000123"},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"finTranTypeID":{"type":"string","example":"CSR","description":"The transaction type code (e.g. CSR = cash receipt, DIV = dividend, DIVM = manufactured dividend, DIVTAX = dividend tax, FIMAT = fixed-income maturity, FI_COUP = fixed-income coupon payment, FULCL/PRCAL = bond called by issuer (full/partial), MERGER_ACQUISITION, RDIV = dividend reinvestment, SLIP = securities lending interest payment, STCK = ACATS in-kind security transfer, XTRF = internal asset transfer between accounts, ACATS_CASH = ACATS cash transfer or internal cash transfer between accounts, CSD = cash settlement/disbursement, e.g. a deposit, withdrawal, or bulk-funding cash movement, FEE = a miscellaneous fee, e.g. wire, DTC transfer, or tax-withholding fee, INT = interest paid on swept cash, JNLC = cash journal entry between accounts, e.g. a fee reallocation or brokerage adjustment, OPTIONS_EXPIRED = a short option position expiring worthless — accountBalance is typically absent and instrument.name is typically null for these, SLIP = fully-paid securities lending interest payment, SLIPNRA = non-resident alien withholding tax on a SLIP payment, SPUR/SSAL = the two legs of a back-office fractional-share transfer/adjustment, TEFRA = TEFRA/backup IRS withholding tax on a sale, or its reversal)."},"feeSec":{"type":"number","example":0},"feeTaf":{"type":"number","example":0},"feeBase":{"type":"number","example":0},"feeXtraShares":{"type":"number","example":0},"feeExchange":{"type":"number","example":0},"positionDelta":{"type":"number","example":-11.64958061,"description":"Present for transactions that change a position's share count."},"instrument":{"$ref":"#/components/schemas/TransactionInstrumentRef"},"dividend":{"type":"object","description":"Present when finTranTypeID is DIV or DIVM (manufactured dividend — a payment-in-lieu made on a short position).","properties":{"type":{"type":"string","example":"CASH","enum":["CASH","STOCK"],"x-enumDescriptions":{"CASH":"A cash dividend.","STOCK":"A stock dividend."}},"amountPerShare":{"type":"number","example":0.3043},"taxCode":{"type":"string","example":"NON_TAXABLE"},"totalQty":{"type":"number","example":0.6,"description":"Present for stock dividends — the number of shares added."}}},"dividendTax":{"type":"object","description":"Present when finTranTypeID is DIVTAX.","properties":{"type":{"type":"string","example":"FOREIGN_TAX"},"rate":{"type":"number","example":0.19}}},"mergerAcquisition":{"type":"object","description":"Present when finTranTypeID is MERGER_ACQUISITION.","properties":{"type":{"type":"string","example":"REMOVE_SHARES_ADD_CASH","enum":["REMOVE_SHARES_ADD_CASH","REMOVE_SHARES","ADD_SHARES","EXCHANGE_STOCK_CASH"],"x-enumDescriptions":{"REMOVE_SHARES_ADD_CASH":"Shares were removed and cash was added.","REMOVE_SHARES":"Shares were removed, with no cash impact.","ADD_SHARES":"Additional shares were added, with no cash impact.","EXCHANGE_STOCK_CASH":"Shares were exchanged for a combination of stock and cash."}},"acquirer":{"$ref":"#/components/schemas/TransactionInstrumentRef"},"acquiree":{"$ref":"#/components/schemas/TransactionInstrumentRef"}}},"coupon":{"type":"object","description":"Present when finTranTypeID is FI_COUP (a coupon payment on a fixed-income holding).","properties":{"tag":{"type":"string","example":"coupon"},"type":{"type":"string","example":"Cash"},"amountPerBond":{"type":"string","example":"12.75"},"taxCode":{"type":"string","example":"NON_TAXABLE"}}},"fiCall":{"type":"object","description":"A bond redeemed by its issuer before maturity. Observed in production coded both as finTranTypeID FULCL/PRCAL (matching the type code name) and, in at least one case, as DIV.","properties":{"tag":{"type":"string","example":"fiCall"},"type":{"type":"string","example":"FI_FULL_CALL","enum":["FI_PARTIAL_CALL","FI_FULL_CALL"],"x-enumDescriptions":{"FI_PARTIAL_CALL":"A partial call of a fixed income instrument.","FI_FULL_CALL":"A full call of a fixed income instrument."}},"callRate":{"type":"string","example":"0"},"accruedInterest":{"type":"string","example":"0"},"callFactor":{"type":"string","example":"0","description":"Present for partial calls (FI_PARTIAL_CALL)."},"principalFactor":{"type":"string","example":"100","description":"Present for partial calls (FI_PARTIAL_CALL)."}}},"fiMaturity":{"type":"object","description":"Present when finTranTypeID is FIMAT — a fixed-income holding that matured and was redeemed by the issuer at par.","properties":{"type":{"type":"string","example":"FI_MATURITY","enum":["FI_MATURITY"],"x-enumDescriptions":{"FI_MATURITY":"The fixed income instrument reached maturity."}},"accruedInterest":{"type":"string","example":"0","description":"Accrued interest paid at maturity."}}},"dividendReinvest":{"type":"object","description":"Present when finTranTypeID is RDIV — dividend proceeds automatically reinvested into additional shares of the same instrument.","properties":{"type":{"type":"string","example":"EQUITY_DIVIDEND_REINVESTMENT","enum":["EQUITY_DIVIDEND_REINVESTMENT"],"x-enumDescriptions":{"EQUITY_DIVIDEND_REINVESTMENT":"An equity dividend reinvestment."}},"pricePerShare":{"type":"number","example":75.0398},"shares":{"type":"number","example":0.09208446},"orderID":{"type":"string","example":"NI.123e4567-e89b-12d3-a456-0000000000a0","description":"The internal order ID that filled the reinvestment."}}},"acats":{"type":"object","description":"Present when finTranTypeID is STCK (an ACATS in-kind security transfer to/from an external broker — the number of shares transferred is on the transaction's positionDelta, positive for INCOMING/negative for OUTGOING) or ACATS_CASH (an ACATS cash transfer to/from an external broker). ACATS_CASH may instead be a plain internal transfer between two DriveWealth accounts (tranSource BACK-OFFICE), in which case this object is absent.","properties":{"type":{"type":"string","example":"INCOMING","enum":["INCOMING","OUTGOING"],"x-enumDescriptions":{"INCOMING":"An incoming ACATS transfer.","OUTGOING":"An outgoing ACATS transfer."}},"brokerDTCNo":{"type":"string","example":"0158","description":"DTC number of the counterparty broker. Not always present."},"ReferenceNo":{"type":"string","example":"ACAT00002","description":"Capitalized as observed on the wire for this event — note this differs from the lowercase referenceNo on positions.updated's acats object."},"controlNo":{"type":"string","example":"99999999999999","description":"May be an empty string when not yet assigned."}}}}},"TransactionCreatedEventPayload":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"},"transaction":{"$ref":"#/components/schemas/TransactionDetail"}}},"TransactionCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000124"},"type":{"type":"string","enum":["transactions.created"],"x-enumDescriptions":{"transactions.created":"Identifies this as a transaction-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-07-23T07:08:14.121518146Z"},"payload":{"$ref":"#/components/schemas/TransactionCreatedEventPayload"}}},"AuthTokenCreatedEventPayload":{"type":"object","description":"Fired when a session/auth token is issued (login). Field breadth on this event is unusually sparse-but-wide: userID/email/firstName/lastName/username are always present, the rest of the profile snapshot is present only some of the time depending on login path.","properties":{"userID":{"$ref":"#/components/schemas/userID"},"id":{"type":"string","description":"Alternate user identifier used in place of userID by some white-label partners.","example":"123e4567-e89b-12d3-a456-000000000125"},"username":{"type":"string","example":"bo.appr.api"},"email":{"type":"string","example":"admin@example.com"},"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"displayName":{"type":"string","example":"BUser One"},"avatarURL":{"type":"string","example":"https://secure.gravatar.com/avatar/00000000000000000000000000000000.jpg"},"phone":{"type":"string","example":"5555550100"},"countryID":{"type":"string","example":"USA"},"languageID":{"type":"string","example":"en_US"},"wlpID":{"type":"string","example":"REBO"},"status":{"type":"object","properties":{"name":{"type":"string","example":"PENDING"},"description":{"type":"string","example":"User is pending approval."}}},"userType":{"type":"object","properties":{"name":{"type":"string","example":"BACK_OFFICE"},"description":{"type":"string","example":"Back Office"}}},"tempSecurityCode":{"type":"string","example":"2FA_VERIFIED"},"termsOfUse":{"type":"boolean","example":false},"referralCode":{"type":"string","example":"28JF1B"},"permissionID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000126"},"parentIB":{"type":"object","properties":{"name":{"type":"string","example":"DriveWealth"}}},"lastLoginWhen":{"type":"string","example":"2026-08-18T22:30:18.461Z"},"createdWhen":{"$ref":"#/components/schemas/created"},"updatedWhen":{"$ref":"#/components/schemas/updated"},"updatedBy":{"$ref":"#/components/schemas/userID"},"badPasswordCount":{"type":"integer","example":0},"marginDefault":{"type":"number","example":0},"employmentYears":{"type":"integer","example":0},"employerIsBroker":{"type":"boolean","example":false},"dependents":{"type":"integer","example":0},"director":{"type":"boolean","example":false},"brandAmbassador":{"type":"boolean","example":false},"politicallyExposed":{"type":"boolean","example":false},"renouncedUSCitizenship":{"type":"boolean","example":false},"usCitizen":{"type":"boolean","example":false},"taxTreatyWithUS":{"type":"boolean","example":false},"ackCustomerAgreement":{"type":"boolean","example":false},"fundingSources":{"type":"array","items":{"type":"string"},"example":[]},"addressLine1":{"type":"string","example":"123 Main St"},"addressLine2":{"type":"string","example":"Apt 4B"},"ackFindersFee":{"type":"boolean","example":false},"ackForeignFindersFee":{"type":"boolean","example":false},"ackJointCustomerAgreement":{"type":"boolean","example":false},"ackJointFindersFee":{"type":"boolean","example":false},"ackJointForeignFindersFee":{"type":"boolean","example":false},"ackJointMarketData":{"type":"boolean","example":false},"ackMarketData":{"type":"boolean","example":false},"ackExtendedHoursAgreement":{"type":"boolean","example":false},"ackOptionsAgreement":{"type":"boolean","example":false},"ackDisclosureRule14b":{"type":"boolean","example":false},"ackJointDisclosureRule14b":{"type":"boolean","example":false},"jointEmployerIsBroker":{"type":"boolean","example":false}}},"AuthTokenCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000127"},"type":{"type":"string","enum":["auth.tokens.created"],"x-enumDescriptions":{"auth.tokens.created":"Identifies this as an auth-token-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-08-18T18:40:00.614800005Z"},"payload":{"$ref":"#/components/schemas/AuthTokenCreatedEventPayload"}}},"InstrumentRemovedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-0000000000f9"},"type":{"type":"string","enum":["instruments.removed"],"x-enumDescriptions":{"instruments.removed":"Identifies this as an instrument-removed event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-08-18T16:04:22.202750875Z"},"payload":{"$ref":"#/components/schemas/InstrumentSnapshot"}}},"MamAllocationListEventPayload":{"type":"object","description":"Managed-account (MAM) allocation list lifecycle event. Note the payload is double-nested (payload.payload) in the real wire format.","properties":{"id":{"type":"string","example":"mam_event_123e4567-e89b-12d3-a456-0000000000fa"},"status":{"type":"string","example":"mam.allocationlist.accepted","enum":["mam.allocationlist.accepted","mam.allocationlist.complete"],"x-enumDescriptions":{"mam.allocationlist.accepted":"The MAM allocation list was accepted.","mam.allocationlist.complete":"The MAM allocation list is complete."}},"timeStamp":{"type":"string","example":"2026-05-15T13:30:35.900Z"},"version":{"type":"integer","example":0},"doNotReconcile":{"type":"boolean","example":false},"payload":{"type":"object","properties":{"allocationListID":{"type":"string","example":"NE.allocation.Alegeus.123e4567-e89b-12d3-a456-0000000000fb"},"riaID":{"type":"string","example":"123e4567-e89b-12d3-a456-0000000000fc"},"allocationCount":{"type":"integer","example":1},"completedCount":{"type":"integer","example":0},"rejectedCount":{"type":"integer","example":0},"created":{"type":"string","example":"2026-05-15T13:30:35.900Z"},"updated":{"type":"string","example":"2026-05-15T13:30:35.900Z"}}}}},"MamAllocationListAcceptedEvent":{"type":"object","properties":{"id":{"type":"string","example":"mam_event_123e4567-e89b-12d3-a456-0000000000fa"},"type":{"type":"string","enum":["mam.allocationlist.accepted"],"x-enumDescriptions":{"mam.allocationlist.accepted":"Identifies this as a MAM allocation-list-accepted event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-05-15T13:30:35.915238727Z"},"payload":{"$ref":"#/components/schemas/MamAllocationListEventPayload"}}},"MamAllocationListCompleteEvent":{"type":"object","properties":{"id":{"type":"string","example":"mam_event_123e4567-e89b-12d3-a456-0000000000fa"},"type":{"type":"string","enum":["mam.allocationlist.complete"],"x-enumDescriptions":{"mam.allocationlist.complete":"Identifies this as a MAM allocation-list-complete event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-05-15T13:30:35.915238727Z"},"payload":{"$ref":"#/components/schemas/MamAllocationListEventPayload"}}},"ReconciliationEventPayload":{"type":"object","properties":{"id":{"type":"string","example":"123e4567-e89b-12d3-a456-0000000000fe_20260515"},"date":{"type":"string","example":"2026-05-15"},"status":{"type":"string","example":"Successful","enum":["Pending","Approved","Successful"],"x-enumDescriptions":{"Pending":"The reconciliation report is pending.","Approved":"The reconciliation report has been approved.","Successful":"The reconciliation report completed successfully."}},"statusComment":{"type":"string","example":"Finished processing breakdown"},"totalAmount":{"type":"number","example":-19100000},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"batchID":{"type":"string","example":"123e4567-e89b-12d3-a456-0000000000ff"},"created":{"$ref":"#/components/schemas/created"},"updated":{"$ref":"#/components/schemas/updated"},"updatedBy":{"type":"string","example":"SYSTEM AGGREGATOR JOB"}}},"ReconciliationCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-0000000000fd"},"type":{"type":"string","enum":["reconciliations.created"],"x-enumDescriptions":{"reconciliations.created":"Identifies this as a reconciliation-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-05-15T00:52:02.967499062Z"},"payload":{"$ref":"#/components/schemas/ReconciliationEventPayload"}}},"ReconciliationUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-0000000000fd"},"type":{"type":"string","enum":["reconciliations.updated"],"x-enumDescriptions":{"reconciliations.updated":"Identifies this as a reconciliation-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-05-15T00:52:02.967499062Z"},"payload":{"$ref":"#/components/schemas/ReconciliationEventPayload"}}},"ReconciliationCompletedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-0000000000fd"},"type":{"type":"string","enum":["reconciliations.completed"],"x-enumDescriptions":{"reconciliations.completed":"Identifies this as a reconciliation-completed event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-05-15T00:52:02.967499062Z"},"payload":{"$ref":"#/components/schemas/ReconciliationEventPayload"}}},"MarginCallDetectedEventPayload":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"userID":{"$ref":"#/components/schemas/userID"},"partnerID":{"$ref":"#/components/schemas/partnerID"},"marginAmount":{"type":"number","example":0.01,"description":"The margin call amount owed."},"tradeDate":{"type":"string","example":"2026-08-24"},"created":{"$ref":"#/components/schemas/created"}}},"MarginCallDetectedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000128"},"type":{"type":"string","enum":["lpmas.marginCall.detected"],"x-enumDescriptions":{"lpmas.marginCall.detected":"Identifies this as a margin-call-detected event."}},"ibID":{"$ref":"#/components/schemas/parentIBID"},"object":{"type":"string","enum":["LPMA_MARGIN_CALL"],"x-enumDescriptions":{"LPMA_MARGIN_CALL":"The payload object type: a margin call detected by the Liquidity Provider Margin Account Service (LPMAS)."}},"timestamp":{"type":"string","format":"date-time","example":"2026-08-25T01:44:52.769Z"},"payload":{"$ref":"#/components/schemas/MarginCallDetectedEventPayload"}}},"SubscriptionEventPayload":{"type":"object","properties":{"subscriptionID":{"type":"string","example":"subscription_123e4567-e89b-12d3-a456-000000000101"},"accountID":{"$ref":"#/components/schemas/accountID"},"userID":{"$ref":"#/components/schemas/userID"},"planID":{"type":"string","example":"plan_123e4567-e89b-12d3-a456-000000000102"},"planName":{"type":"string","example":"Beanstox $10 Monthly"},"amount":{"type":"number","example":10},"currency":{"$ref":"#/components/schemas/currency"},"interval":{"type":"string","example":"MONTH"},"intervalCount":{"type":"integer","example":1},"paymentSourceID":{"type":"string","example":"bank_123e4567-e89b-12d3-a456-000000000103"},"status":{"type":"string","example":"ACTIVE"},"renews":{"type":"string","example":"2026-05-24T23:59:59Z"},"transactionID":{"type":"string","example":"subTx_EEEE009006-1234567890"},"created":{"$ref":"#/components/schemas/created"}}},"SubscriptionCreatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000100"},"type":{"type":"string","enum":["subscriptions.created"],"x-enumDescriptions":{"subscriptions.created":"Identifies this as a subscription-created event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-04-25T00:50:21.201608602Z"},"payload":{"$ref":"#/components/schemas/SubscriptionEventPayload"}}},"SubscriptionUpdatedEvent":{"type":"object","properties":{"id":{"type":"string","example":"event_123e4567-e89b-12d3-a456-000000000100"},"type":{"type":"string","enum":["subscriptions.updated"],"x-enumDescriptions":{"subscriptions.updated":"Identifies this as a subscription-updated event."}},"timestamp":{"type":"string","format":"date-time","example":"2026-04-25T00:50:21.201608602Z"},"payload":{"$ref":"#/components/schemas/SubscriptionEventPayload"}}},"WithholdingDefaultsResponse":{"type":"object","description":"Federal and state-specific default withholding percentages for retirement distributions in a given tax year.","properties":{"taxYear":{"type":"integer","example":2026,"description":"The tax year the returned defaults apply to."},"federalDefaultPercentage":{"type":"number","example":0.1,"description":"The default federal withholding rate, expressed as a decimal fraction."},"stateSpecificItems":{"type":"array","description":"One entry per state. Returns a single entry when the state parameter is supplied.","items":{"$ref":"#/components/schemas/StateWithholdingItem"}}}},"StateWithholdingItem":{"type":"object","description":"Default withholding configuration for a single U.S. state.","properties":{"state":{"type":"string","example":"VT","description":"Two-letter U.S. state code."},"stateDefaultPercentage":{"type":"number","example":0.3,"description":"The default state withholding rate, expressed as a decimal fraction."},"isWithholdingMandatory":{"type":"boolean","example":true,"description":"Whether the state requires withholding on retirement distributions. When true, the election cannot be waived."}}},"SubscriptionRequest":{"type":"object","required":["accountID","bankAccountID","planID"],"properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"bankAccountID":{"$ref":"#/components/schemas/bankAccountID"},"planID":{"type":"string","example":"plan_123e4567-e89b-12d3-a456-00000000005f","description":"The unique identifier that identifies the plan schedule."}}},"Subscription":{"type":"object","properties":{"subscriptionID":{"$ref":"#/components/schemas/subscriptionID"}}},"WithdrawalFromUserAccount":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/withdrawalID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"category":{"type":"string","example":"REDEMPTION","description":"The category of the withdrawal."},"currency":{"$ref":"#/components/schemas/currency"},"amount":{"type":"number","example":-560.36,"description":"The amount of the withdrawal."},"status":{"$ref":"#/components/schemas/redemptionStatusObject"},"source":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/withdrawalTypes"},"meta_info":{"$ref":"#/components/schemas/note"}}},"paymentRef":{"$ref":"#/components/schemas/withdrawalID"},"created":{"type":"string","example":"2022-12-08T18:36:40.609Z","description":"The date and time the when the withdrawal was created."},"accountID":{"$ref":"#/components/schemas/accountID"},"userID":{"$ref":"#/components/schemas/userID"},"transactionCode":{"$ref":"#/components/schemas/transactionCode"},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"batch":{"type":"boolean","example":true,"description":"True, if the withdrawal will be batched."},"account_number":{"$ref":"#/components/schemas/accountNo"},"iraDistribution":{"$ref":"#/components/schemas/iraDistribution"},"iraDistributionSubType":{"$ref":"#/components/schemas/iraDistributionSubType"},"remittanceInformation":{"$ref":"#/components/schemas/remittanceInformation"}}},"WithdrawalFromUserAccountReq":{"type":"object","required":["accountNo","amount","currency","type"],"properties":{"accountNo":{"$ref":"#/components/schemas/accountNo"},"amount":{"type":"number","example":125.92,"description":"The amount of the withdrawal. Accepts positive or negative values; regardless of the sign provided, the withdrawal is stored and processed as a negative amount in the system."},"currency":{"$ref":"#/components/schemas/currency"},"type":{"$ref":"#/components/schemas/withdrawalTypes"},"bankAccountID":{"$ref":"#/components/schemas/bankAccountID"},"details":{"$ref":"#/components/schemas/withdrawalDetailsObject","description":"The necessary recipient details for completing a wire payment"},"iraDistribution":{"$ref":"#/components/schemas/iraDistribution"},"iraDistributionSubType":{"$ref":"#/components/schemas/iraDistributionSubType"},"iraTaxWithholdings":{"$ref":"#/components/schemas/iraTaxWithHoldings"},"liquidate":{"type":"boolean","example":false,"description":"True, if the account is a managed account and a full liquidation is requested from the user."},"fees":{"type":"array","description":"A list of fees associated to the withdrawal.","items":{"oneOf":[{"$ref":"#/components/schemas/feeObject"}]}},"note":{"$ref":"#/components/schemas/note"},"remittanceInformation":{"$ref":"#/components/schemas/remittanceInformation"},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"metadata":{"$ref":"#/components/schemas/metadataMoneyMovement"}}},"WithdrawalByRedemptionID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/withdrawalID"},"category":{"$ref":"#/components/schemas/withdrawalCategories"},"currency":{"$ref":"#/components/schemas/currencyObject"},"status":{"$ref":"#/components/schemas/redemptionStatusObject"},"created":{"$ref":"#/components/schemas/created","description":"The date and time the redemption/withdrawal was created."},"userDetails":{"$ref":"#/components/schemas/FundingUserDetails"},"accountDetails":{"$ref":"#/components/schemas/withdrawalAccountDetails"},"batch":{"$ref":"#/components/schemas/batch"},"transactionCode":{"$ref":"#/components/schemas/transactionCodeObject"},"statusHistory":{"type":"array","description":"A list of the status history of the withdrawal.","items":{"oneOf":[{"$ref":"#/components/schemas/withdrawalStatusHistoryObject"}]}},"details":{"$ref":"#/components/schemas/withdrawalDetailsObject"},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"fees":{"type":"array","description":"A list of fees associated to the withdrawal.","items":{"oneOf":[{"$ref":"#/components/schemas/feeObject"}]}},"note":{"$ref":"#/components/schemas/note"},"remittanceInformation":{"$ref":"#/components/schemas/remittanceInformation"},"type":{"$ref":"#/components/schemas/withdrawalTypes"},"iraDistribution":{"$ref":"#/components/schemas/iraDistribution"},"iraDistributionSubType":{"$ref":"#/components/schemas/iraDistributionSubType"},"metadata":{"$ref":"#/components/schemas/metadataMoneyMovement"}}},"WithdrawalForTheFirm":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/withdrawalID"},"paymentID":{"$ref":"#/components/schemas/withdrawalID"},"type":{"$ref":"#/components/schemas/withdrawalTypes"},"amount":{"type":"number","example":125.92,"description":"The amount of the withdrawal"},"currency":{"$ref":"#/components/schemas/currencyObject"},"status":{"$ref":"#/components/schemas/redemptionStatusObject"},"userDetails":{"$ref":"#/components/schemas/FundingUserDetails"},"accountDetails":{"$ref":"#/components/schemas/withdrawalAccountDetails"},"fees":{"type":"array","description":"A list of fees associated to the withdrawal.","items":{"oneOf":[{"$ref":"#/components/schemas/feeObject"}]}},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"transactionCode":{"$ref":"#/components/schemas/transactionCodeObject"},"iraDistribution":{"$ref":"#/components/schemas/iraDistribution"},"iraDistributionSubType":{"$ref":"#/components/schemas/iraDistributionSubType"}}},"ListAllWithdrawalsForTheFirm":{"type":"array","description":"A list of all redemptions for the firm.","items":{"oneOf":[{"$ref":"#/components/schemas/WithdrawalForTheFirm"}]}},"WithdrawalUpdateFee":{"type":"object","required":["amount"],"description":"A fee line item to attach to the withdrawal. Provide either wlpFinTranTypeID or transactionCode to identify the fee's transaction type.","properties":{"amount":{"type":"number","example":-10,"description":"The fee amount. Accepts positive or negative values; regardless of the sign provided, it is stored and processed as a negative amount."},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"transactionCode":{"$ref":"#/components/schemas/transactionCode"}},"anyOf":[{"required":["wlpFinTranTypeID"]},{"required":["transactionCode"]}]},"WithdrawalUpdateReq":{"type":"object","description":"All fields are optional. Only fields present in the request body are updated; omitted fields are left unchanged.","properties":{"status":{"type":"string","example":"APPROVED","description":"The status transition being requested for the withdrawal.","enum":["PENDING","ON_HOLD","APPROVED","REJECTED","RIA_APPROVED","RIA_REJECTED","SUCCESSFUL","FAILED"],"x-enumDescriptions":{"PENDING":"The withdrawal details were accepted.","ON_HOLD":"The withdrawal details were accepted, but it is not yet ready to be processed.","APPROVED":"The withdrawal was approved.","REJECTED":"The withdrawal was rejected.","RIA_APPROVED":"Approved once cash has settled against the managed account via AutoPilot.","RIA_REJECTED":"Rejected because there is not enough cash in the account after selling securities to cover the withdrawal.","SUCCESSFUL":"The withdrawal was successful. Not settable via this endpoint for withdrawals processed via Modern Treasury.","FAILED":"The withdrawal was not successful."}},"statusComment":{"type":"string","example":"Approved","description":"A comment describing the status change. Stored on the withdrawal's status history."},"amount":{"type":"number","example":125.92,"description":"The updated withdrawal amount. Cannot be changed once a financial transaction has been submitted for processing."},"transactionCode":{"$ref":"#/components/schemas/transactionCode"},"wlpFinTranTypeID":{"allOf":[{"$ref":"#/components/schemas/wlpFinTranTypeID"}],"deprecated":true,"description":"Deprecated. Use transactionCode instead."},"batch":{"$ref":"#/components/schemas/batch"},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"metadata":{"$ref":"#/components/schemas/metadataMoneyMovement"},"fees":{"type":"array","description":"Fee line items to add to the withdrawal.","items":{"$ref":"#/components/schemas/WithdrawalUpdateFee"}}}},"RecurringDeposit":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/recurringID"},"currency":{"$ref":"#/components/schemas/currency"},"amount":{"type":"number","example":1075.25,"description":"The amount of the recurring deposit."},"frequency":{"$ref":"#/components/schemas/recurringFrequency"},"bankAccountID":{"$ref":"#/components/schemas/bankAccountID"},"active":{"type":"boolean","example":true,"description":"True, if the recurring deposit is active."},"nextDeposit":{"type":"string","example":"2019-01-15","description":"The date of when the next recurring deposit will be triggered."},"depositHistory":{"type":"array","description":"A list of all the past deposit processed.","items":{"oneOf":[{"$ref":"#/components/schemas/DepositHistory"}]}}}},"RecurringDepositUpdate":{"type":"object","properties":{"amount":{"type":"number","example":330.25,"description":"The amount of the recurring deposit will be updated to."},"frequency":{"$ref":"#/components/schemas/recurringFrequency"}}},"RecurringDepositDeleteResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/recurringID"},"currency":{"$ref":"#/components/schemas/currency"},"amount":{"type":"number","example":1075.25,"description":"The amount of the recurring deposit."},"frequency":{"$ref":"#/components/schemas/recurringFrequency"},"bankAccountID":{"$ref":"#/components/schemas/bankAccountID"},"active":{"type":"boolean","example":false,"description":"True, if the recurring deposit is active."},"nextDeposit":{"type":"string","example":null,"description":"The date of when the next recurring deposit will be triggered."},"depositHistory":{"type":"array","description":"A list of all the past deposit processed.","items":{"$ref":"#/components/schemas/DepositHistory"}},"accountID":{"$ref":"#/components/schemas/accountID"},"userID":{"$ref":"#/components/schemas/userID"},"created":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time the recurring deposit was created for the user's external bank account."},"updated":{"type":"string","example":"2022-12-11T22:28:21.810Z","description":"The date and time the recurring deposit was updated for the user's external bank account."},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000005e","description":"The user identifier whom created the recurring deposit."}}},"DepositHistory":{"type":"object","properties":{"depositID":{"$ref":"#/components/schemas/depositID"},"currency":{"$ref":"#/components/schemas/currency"},"status":{"$ref":"#/components/schemas/depositStatus"},"created":{"$ref":"#/components/schemas/created","description":"The date and time the recurring deposit was created for the user's external bank account."},"updated":{"$ref":"#/components/schemas/updated","description":"The date and time the recurring deposit was updated for the user's external bank account."},"createdBy":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000005e","description":"The user identifier whom created the recurring deposit."},"metaAccountInfo":{"type":"string","example":"Automated DAILY recurring deposit for b25f0d3... |MyBank Premier Checking|****5204","description":"A custom message about the processing of the recurring deposit."}}},"DailyReconciliation":{"type":"object","allOf":[{"$ref":"#/components/schemas/CashSettlementFields"}],"properties":{"id":{"$ref":"#/components/schemas/reconciliationID"},"date":{"type":"string","example":"2024-04-17","description":"The date of when the reconciliation report was generated for."},"status":{"$ref":"#/components/schemas/reconciliationStatus"},"statusComment":{"type":"string","example":"Finished processing breakdown","description":"A custom comment about the status."},"totalAmount":{"type":"number","example":12001.01,"description":"The total amount due or owed to the firm."},"partnerID":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000005","description":"The partner's unique identifier."},"settlementProfileID":{"type":"string","example":"settlement-profile-bank-account-1","description":"A settlement profile identifier that links to a specific bank account for fund settlement."},"created":{"type":"string","example":"2024-04-15T22:28:21.810Z","description":"The date and time the reconciliation report was created."},"updated":{"type":"string","example":"2024-04-17T22:28:21.810Z","description":"The date and time the reconciliation report was last updated."},"updatedBy":{"$ref":"#/components/schemas/updatedBy"},"attestedAt":{"type":"string","example":"2024-04-17T22:28:21.810Z","description":"The date and time when the reconciliation report was attested."}}},"ListOfDailyReconciliations":{"type":"array","description":"A list of daily reconciliations for a firm.","items":{"oneOf":[{"$ref":"#/components/schemas/DailyReconciliation"}]}},"ReconciliationUpdate":{"type":"object","required":["status","statusComment"],"properties":{"status":{"type":"string","example":"Successful","description":"The status to update the reconciliation report to.","enum":["Successful"],"x-enumDescriptions":{"Successful":"The reconciliation report completed successfully."}},"statusComment":{"type":"string","example":"Manually approving reconciliation for testing purposes.","description":"A comment describing the reason for the status update."}}},"ReconciliationDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/CashSettlementFields"}],"properties":{"id":{"$ref":"#/components/schemas/reconciliationID"},"date":{"type":"string","example":"2024-04-17","description":"The date of when the reconciliation report was generated for."},"status":{"$ref":"#/components/schemas/reconciliationStatus"},"statusComment":{"type":"string","example":"Finished processing breakdown","description":"A custom comment about the status."},"amounts":{"type":"object","properties":{"total":{"type":"number","example":-1263.56,"description":"The total amount due or owed to the firm."},"purchases":{"type":"number","example":-1680.07,"description":"The total amount in purchases of equity instruments, that are due to DriveWealth."},"sales":{"type":"number","example":416.51,"description":"The total amount in sales of equity instruments, that are owed to the firm."},"dividends":{"type":"number","example":0,"description":"The total amount of dividends, that are owed to the firm."},"fees":{"type":"number","example":0,"description":"The total amount of fees, that are due to DriveWealth."},"other":{"type":"number","example":0,"description":"The total amount of other payments, that are owed to the firm."}}},"transferAmounts":{"type":"object","properties":{"currency":{"type":"string","example":"USD","description":"The currency in abbreviation form."},"payablesToDW":{"type":"number","example":1263.56,"description":"The total amount due to DriveWealth."},"receivablesFromDW":{"type":"number","example":0,"description":"The total amount owed to the partner firm."}}},"reconciliationBreakdown":{"type":"string","properties":{"JSON":{"type":"string","example":"https://d111111abcdef8.cloudfront.net/reconciliation_123e4567-e89b-12d3-a456-426614174000_20000101.json?Policy=eyJTdGF0ZW1lbnQiOiBbeyJSZXNvdXJjZSI6Imh0dHBzOi8vZDExMTExMWFiY2RlZjguY2xvdWRmcm9udC5uZXQvcmVjb25jaWxpYXRpb25fMTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDAwXzIwMDAwMTAxLmpzb24iLCJDb25kaXRpb24iOnsiRGF0ZUxlc3NUaGFuIjp7IkFXUzpFcG9jaFRpbWUiOjEyMzQ1Njc4OTB9LCJJcEFkZHJlc3MiOnsiQVdTOlNvdXJjZUlwIjoiMC4wLjAuMC8wIn19fV19&Signature=EXAMPLEXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&Key-Pair-Id=APKAEXAMPLE00000000","description":"A URL that contains the breakdown of all the transactions that are settling in the reconciliation report."}}},"partnerID":{"$ref":"#/components/schemas/parentIBID"},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"created":{"type":"string","example":"2024-04-15T22:28:21.810Z","description":"The date and time when the reconciliation report was created."},"updated":{"type":"string","example":"2024-04-17T22:28:21.810Z","description":"The date and time when the reconciliation report was last updated."},"updatedBy":{"$ref":"#/components/schemas/updatedBy"},"attestedBy":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000167","description":"User ID of the person who attested the reconciliation report."},"attestedAt":{"type":"string","example":"2024-04-17T22:28:21.810Z","description":"The date and time when the reconciliation report was attested."}}},"AttestReconciliationResponse":{"allOf":[{"$ref":"#/components/schemas/ReconciliationDetails"},{"type":"object","properties":{"status":{"type":"string","example":"SUCCESSFUL","description":"The status of the attested reconciliation.","enum":["SUCCESSFUL"],"x-enumDescriptions":{"SUCCESSFUL":"The reconciliation report completed successfully."}}}}]},"UpdateReconciliationResponse":{"allOf":[{"$ref":"#/components/schemas/ReconciliationDetails"},{"type":"object","properties":{"status":{"type":"string","example":"SUCCESSFUL","description":"The status of the updated reconciliation.","enum":["SUCCESSFUL"],"x-enumDescriptions":{"SUCCESSFUL":"The reconciliation report completed successfully."}}}}]},"Payment":{"type":"object","description":"A single deposit or redemption, as returned by the unified funding-payments search.","required":["id","paymentID","accountID","category","status","timestamp"],"properties":{"id":{"$ref":"#/components/schemas/paymentID"},"paymentID":{"$ref":"#/components/schemas/paymentID"},"accountID":{"$ref":"#/components/schemas/accountID"},"category":{"type":"string","example":"DEPOSIT","enum":["DEPOSIT","REDEMPTION"],"description":"The category of the payment."},"type":{"type":"string","example":"ACH","description":"The payment's vendor/method type, e.g. `ACH`, `WIRE`, `WIRE_DIRECT2BANK`, `BULK_FUNDING`, `CASH_TRANSFER`."},"amount":{"type":"number","example":-50.5,"description":"The payment amount (negative for redemptions, positive for deposits)."},"currency":{"$ref":"#/components/schemas/currencyObject"},"details":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form payment details, with sensitive values (personal ID, full bank account/routing numbers) stripped or masked. Omitted when the payment has no details.","example":{"bankAccountNickname":"John's checking account","bankRoutingNumber":"****0000","bankAccountNumber":"****2227"}},"status":{"$ref":"#/components/schemas/paymentStatusObject"},"seasoningDetails":{"allOf":[{"$ref":"#/components/schemas/FundingSeasoningDetails"}],"description":"Present only for eligible Modern Treasury deposits pending seasoning; omitted otherwise."},"userDetails":{"$ref":"#/components/schemas/UnifiedFundingUserDetails"},"accountDetails":{"$ref":"#/components/schemas/withdrawalAccountDetails"},"fees":{"type":"array","description":"A list of fees associated with the payment.","items":{"oneOf":[{"$ref":"#/components/schemas/feeObject"}]}},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"transactionCode":{"$ref":"#/components/schemas/UnifiedTransactionCode"},"finTranReference":{"$ref":"#/components/schemas/finTranReference"},"note":{"$ref":"#/components/schemas/note"},"timestamp":{"type":"string","example":"2026-09-15T18:28:11.267Z","description":"The date and time the payment was created."},"liquidateAccount":{"$ref":"#/components/schemas/liquidateAccount"},"returned":{"$ref":"#/components/schemas/returned"},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"reportableTaxYear":{"$ref":"#/components/schemas/reportableTaxYear"},"iraContribution":{"$ref":"#/components/schemas/iraContribution"},"iraContributionSubType":{"$ref":"#/components/schemas/iraContributionSubType"},"iraDistribution":{"$ref":"#/components/schemas/iraDistribution"},"iraDistributionSubType":{"$ref":"#/components/schemas/iraDistributionSubType"}}},"UnifiedTransactionCode":{"type":"object","description":"Unlike the legacy deposit/redemption endpoints, the unified search isn't limited to a small fixed set of codes, so `code` is not a closed enum here.","properties":{"code":{"type":"string","example":"RECEIPT_OTHER","description":"The transaction (batch) code identifying how/why the payment was posted."},"type":{"$ref":"#/components/schemas/transactionCodeType"},"description":{"type":"string","example":"Cash Receipt - Other e.g. TransferWise, Currencycloud, etc.","description":"A custom description about the transaction code."}}},"UnifiedFundingUserDetails":{"type":"object","description":"Same shape as FundingUserDetails, but the parent-IB field is named `parentIB` here, not `parentIBID`.","properties":{"userID":{"$ref":"#/components/schemas/userID"},"username":{"$ref":"#/components/schemas/username"},"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"email":{"$ref":"#/components/schemas/email"},"parentIB":{"$ref":"#/components/schemas/parentIBIDObject"},"wlpID":{"$ref":"#/components/schemas/wlpID"},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"}}},"PaymentsSearchResponse":{"type":"object","properties":{"pageSize":{"type":"integer","example":25,"description":"The number of payments returned in this page."},"limit":{"type":"integer","example":25,"description":"The page size that was applied to this request."},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"page":{"type":"object","properties":{"hasMore":{"type":"boolean","example":true,"description":"Whether more payments remain beyond this page."},"nextCursor":{"allOf":[{"$ref":"#/components/schemas/paymentID"}],"description":"The `paymentID` to pass as `offset` to fetch the next page. Omitted when `hasMore` is false."}}}}},"paymentID":{"type":"string","example":"11AA000001-1234567890128-RJJLU","description":"A unique identifier for the payment (a deposit or redemption)."},"paymentStatusObject":{"type":"object","properties":{"id":{"type":"integer","example":2,"description":"The current status of the payment, in integer form."},"message":{"type":"string","example":"Successful","description":"The current status of the payment.","enum":["Started","Pending","Successful","Failed","Other","Returned","RIA_Pending","RIA_Approved","RIA_Rejected","Approved","Rejected","On_Hold","Processing","Remitted","Return_Pending","Unknown"],"x-enumDescriptions":{"Started":"The payment request has been initiated but processing has not yet begun.","Pending":"The payment is queued for processing.","Successful":"The payment completed successfully.","Failed":"The payment failed to process.","Other":"The payment is in a state not covered by the other status values.","Returned":"The payment was returned by the receiving bank after being sent.","RIA_Pending":"The payment is awaiting approval from the account's Registered Investment Advisor (RIA).","RIA_Approved":"The account's RIA has approved the payment, which is now awaiting completion.","RIA_Rejected":"The account's RIA rejected the payment.","Approved":"The payment has been approved and is awaiting completion.","Rejected":"The payment was rejected.","On_Hold":"The payment is held for manual review before it can proceed.","Processing":"The payment is actively being processed.","Remitted":"Funds for the payment have been remitted to their destination.","Return_Pending":"The payment is in the process of being returned by the receiving bank.","Unknown":"The payment's status could not be determined."}},"comment":{"type":"string","example":"Valid request. Auto-move to Successful","description":"A custom comment about the current status of the payment."},"updated":{"allOf":[{"$ref":"#/components/schemas/updated"}],"description":"The last updated timestamp of the status of the payment."}}},"liquidateAccount":{"type":"boolean","example":false,"description":"For a managed-account redemption, whether the request instructed DriveWealth to fully liquidate the account. Omitted for deposits."},"returned":{"type":"string","example":"2026-09-15","description":"The date the payment was returned by the bank. Omitted if it has not been returned."},"linkBankAccountReq":{"type":"object","required":["userID","bankAccountNumber","bankRoutingNumber","bankAccountNickname","bankAccountType"],"properties":{"userID":{"$ref":"#/components/schemas/userID"},"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumber"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumber"},"bankAccountType":{"$ref":"#/components/schemas/bankAccountType"},"bankAccountNickname":{"$ref":"#/components/schemas/bankAccountNickName"},"bankAccountPurpose":{"$ref":"#/components/schemas/bankAccountPurpose"},"beneficiaryDetails":{"$ref":"#/components/schemas/beneficiaryDetails"},"bankName":{"$ref":"#/components/schemas/externalBankName"},"bankAddress":{"$ref":"#/components/schemas/externalBankAddress"},"bankCountry":{"$ref":"#/components/schemas/externalBankCountry"}}},"linkBankAccountRes":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/bankAccountID"},"userDetails":{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"},"username":{"$ref":"#/components/schemas/username"},"firstName":{"$ref":"#/components/schemas/firstName"},"lastName":{"$ref":"#/components/schemas/lastName"},"email":{"$ref":"#/components/schemas/email"},"parentIB":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/parentIBID"},"name":{"$ref":"#/components/schemas/firmName"}}},"wlpID":{"$ref":"#/components/schemas/wlpID"},"walletSettlementProfileID":{"$ref":"#/components/schemas/walletSettlementProfileID"}}},"bankAccountDetails":{"type":"object","properties":{"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumberLastFour"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumber"},"bankAccountType":{"$ref":"#/components/schemas/bankAccountType"},"backAccountNickname":{"$ref":"#/components/schemas/bankAccountNickName"},"bankName":{"$ref":"#/components/schemas/externalBankName"},"bankAddress":{"type":"object","properties":{"addressLine1":{"$ref":"#/components/schemas/externalBankAddress"},"country":{"$ref":"#/components/schemas/externalBankCountry"}}}}},"bankAccountPurpose":{"$ref":"#/components/schemas/bankAccountPurpose"},"beneficiaryDetails":{"$ref":"#/components/schemas/beneficiaryDetails"},"default":{"$ref":"#/components/schemas/bankAccountDefault"},"status":{"$ref":"#/components/schemas/bankAccountStatus"},"created":{"$ref":"#/components/schemas/created"},"updated":{"$ref":"#/components/schemas/updated"}}},"updatedLinkedBankAccountReq":{"type":"object","properties":{"bankAccountNickname":{"$ref":"#/components/schemas/bankAccountNickName"},"default":{"$ref":"#/components/schemas/bankAccountDefault"},"status":{"$ref":"#/components/schemas/bankAccountStatus"},"bankAccountDetails":{"type":"object","properties":{"bankName":{"$ref":"#/components/schemas/externalBankName"},"bankAddress":{"$ref":"#/components/schemas/externalBankAddress"},"bankCountry":{"$ref":"#/components/schemas/externalBankCountry"},"accountHolderName":{"$ref":"#/components/schemas/beneficiaryDetails/properties/accountHolderName"},"accountHolderAddress":{"$ref":"#/components/schemas/beneficiaryDetails/properties/accountHolderAddress"},"accountHolderCountry":{"$ref":"#/components/schemas/beneficiaryDetails/properties/accountHolderCountry"}}}}},"bankAccountPurpose":{"type":"string","example":"TRAVEL_RULE","description":"The linked account purpose.","enum":["TRAVEL_RULE","SETTLEMENT_PROFILE"],"x-enumDescriptions":{"TRAVEL_RULE":"Funding account for Travel Rule.","SETTLEMENT_PROFILE":"Settlement profile account."}},"beneficiaryDetails":{"type":"object","properties":{"accountHolderName":{"type":"string","example":"John Doe","description":"The full name of the linked account holder."},"accountHolderAddress":{"type":"string","example":"123 Main Street, New York, NY, 10001","description":"The home address of the linked account holder."},"accountHolderCountry":{"type":"string","example":"USA","description":"The country of the linked account holder."}}},"DepositRequestReq":{"type":"object","required":["accountNo","amount","currency","type"],"properties":{"accountNo":{"$ref":"#/components/schemas/accountNo"},"amount":{"type":"number","example":250.25,"description":"The amount that will be deposited into the user's account."},"currency":{"$ref":"#/components/schemas/currency"},"type":{"$ref":"#/components/schemas/depositTypes"},"bankAccountID":{"$ref":"#/components/schemas/bankAccountID"},"note":{"$ref":"#/components/schemas/note"},"iraContribution":{"$ref":"#/components/schemas/iraContribution"},"iraContributionSubType":{"$ref":"#/components/schemas/iraContributionSubType"},"recurringFrequency":{"$ref":"#/components/schemas/recurringFrequency"},"startDate":{"type":"string","example":"2017-09-18","description":"The start date of the recurring deposit. The date should be in the future and within 90 days."},"settlementProfileID":{"$ref":"#/components/schemas/settlementProfileID"},"originatorBankDetails":{"type":"object","properties":{"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumber"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumber"},"bankName":{"$ref":"#/components/schemas/externalBankName"},"bankAddress":{"$ref":"#/components/schemas/externalBankAddress"},"accountHolderName":{"$ref":"#/components/schemas/accountHolderName"},"accountHolderAddress":{"$ref":"#/components/schemas/externalAccountHolderAddress"},"accountHolderCountry":{"$ref":"#/components/schemas/externalAccountHolderCountry"},"bankCountry":{"$ref":"#/components/schemas/externalBankCountry"}}},"metadata":{"$ref":"#/components/schemas/metadataMoneyMovement"}}},"Deposit":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/depositID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"category":{"type":"string","example":"DEPOSIT"},"currency":{"$ref":"#/components/schemas/currency"},"amount":{"type":"number","example":250.25,"description":"The amount of cash that is being deposited into the user's account."},"status":{"$ref":"#/components/schemas/depositStatusObject"},"source":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/depositTypes"},"brand":{"type":"string","example":"ACH","description":"A custom description about the type of deposit."},"meta_info":{"type":"string","example":"Hey! Welcome to DriveWealth Developer Docs!","description":"A way to store a message/note on the deposit object."}}},"created":{"allOf":[{"$ref":"#/components/schemas/created"}],"description":"The date and time the deposit was created for the user's account."},"accountID":{"$ref":"#/components/schemas/accountID"},"userID":{"$ref":"#/components/schemas/userID"},"transactionCode":{"$ref":"#/components/schemas/transactionCode"},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"iraContribution":{"$ref":"#/components/schemas/iraContribution"},"iraContributionSubType":{"$ref":"#/components/schemas/iraContributionSubType"},"reportableTaxYear":{"$ref":"#/components/schemas/reportableTaxYear"},"batch":{"type":"boolean","example":true},"recurring":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/recurringID"},"nextDeposit":{"type":"string","example":"2019-01-15","description":"The date of when the next recurring deposit will be triggered."},"active":{"type":"boolean","example":false,"description":"True, if the recurring deposit is active."},"frequency":{"$ref":"#/components/schemas/recurringFrequency"}}}}},"DepositStatusHistory":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/depositStatusNumber"},"statusMessage":{"$ref":"#/components/schemas/depositStatus"},"updatedBy":{"$ref":"#/components/schemas/updatedBy"},"comment":{"type":"string","example":"Valid request. Auto-move to Pending","description":"A custom comment generated by the system."}}},"DepositByDepositID":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/depositID"},"category":{"type":"string","example":"DEPOSIT"},"amount":{"type":"number","example":250.25,"description":"The amount of cash that is being deposited into the user's account."},"currency":{"$ref":"#/components/schemas/currencyObject"},"status":{"$ref":"#/components/schemas/depositStatusObject"},"seasoningDetails":{"$ref":"#/components/schemas/FundingSeasoningDetails"},"created":{"allOf":[{"$ref":"#/components/schemas/created"}],"description":"The date and time the deposit was created for the user's account."},"userDetails":{"$ref":"#/components/schemas/FundingUserDetails"},"accountDetails":{"$ref":"#/components/schemas/AccountDetails"},"batch":{"$ref":"#/components/schemas/batch"},"transactionCode":{"$ref":"#/components/schemas/transactionCodeObject"},"note":{"$ref":"#/components/schemas/note"},"details":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/bankAccountCountry"},"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumberLastFour"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumberLastFour"},"accountHolderName":{"$ref":"#/components/schemas/accountHolderName"}}},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"iraContribution":{"$ref":"#/components/schemas/iraContribution"},"iraContributionSubType":{"$ref":"#/components/schemas/iraContributionSubType"},"statusHistory":{"type":"array","description":"A list of the different historical status of the deposit","items":{"oneOf":[{"$ref":"#/components/schemas/DepositStatusHistory"}]}},"metadata":{"$ref":"#/components/schemas/metadataMoneyMovement"}}},"RetrieveDepositResponse":{"description":"A Deposit's details, including reportableTaxYear for IRA contribution deposits.","allOf":[{"$ref":"#/components/schemas/DepositByDepositID"},{"type":"object","properties":{"reportableTaxYear":{"$ref":"#/components/schemas/reportableTaxYear"}}}]},"DepositListItem":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/depositID"},"type":{"$ref":"#/components/schemas/depositTypes"},"amount":{"type":"number","example":125.92,"description":"The amount of the deposit"},"currency":{"$ref":"#/components/schemas/currencyObject"},"details":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/bankAccountCountry"},"bankAccountNumber":{"$ref":"#/components/schemas/bankAccountNumberLastFour"},"bankRoutingNumber":{"$ref":"#/components/schemas/bankRoutingNumberLastFour"},"accountHolderName":{"$ref":"#/components/schemas/accountHolderName"}}},"status":{"$ref":"#/components/schemas/depositStatusObject"},"userDetails":{"$ref":"#/components/schemas/FundingUserDetails"},"accountDetails":{"$ref":"#/components/schemas/AccountDetails"},"fees":{"type":"array","description":"A list of fees associated to the deposit.","items":{"oneOf":[{"$ref":"#/components/schemas/feeObject"}]}},"wlpFinTranTypeID":{"$ref":"#/components/schemas/wlpFinTranTypeID"},"transactionCode":{"$ref":"#/components/schemas/transactionCodeObject"}}},"ListAllDepositsForTheFirm":{"type":"array","description":"A list of all deposits for the firm.","items":{"$ref":"#/components/schemas/DepositListItem"}},"AchSettlementUpdate":{"type":"object","properties":{"depositBuyingPowerHoldExpires":{"type":"string","format":"date","example":"2026-05-12","description":"The date when the buying power hold on the deposit expires. Will allocate buying power if set to today or a prior date."},"seasoningPeriodExpires":{"type":"string","format":"date","example":"2026-05-13","description":"The date when the withdrawal power hold on the deposit expires. Will allocate withdrawal power if set to today or a prior date."}}},"ContributionLimitsResponse":{"type":"object","description":"Standard contribution limits and catch-up parameters for a given tax year.","properties":{"taxYear":{"type":"integer","example":2026,"description":"The tax year the returned limits apply to."},"contributionLimits":{"$ref":"#/components/schemas/ContributionLimits"}}},"ContributionLimits":{"type":"object","description":"Container for per-account-family contribution limits.","properties":{"ira":{"$ref":"#/components/schemas/IraContributionLimit"},"trumpAccount":{"$ref":"#/components/schemas/TrumpAccountContributionLimit"}}},"IraContributionLimit":{"type":"object","description":"Combined limit governing Traditional and Roth IRAs. The limit is shared across both account types, not applied separately to each.","properties":{"accountTypes":{"type":"array","description":"Account types governed by this combined limit.","items":{"type":"string","example":"TRADITIONAL_IRA"}},"standardLimit":{"type":"number","example":7500,"description":"Base annual limit, shared across all listed account types."},"catchUpAge":{"type":"integer","example":50,"description":"Age at which the catch-up allowance becomes available."},"catchUpAllowance":{"type":"number","example":1000,"description":"Additional amount permitted once catchUpAge is met."},"maximumAllowedLimit":{"type":"number","example":8500,"description":"The maximum allowed limit: standardLimit plus catchUpAllowance."},"note":{"type":"string","description":"Clarification of the combined-limit behavior.","example":"Traditional and Roth IRA contributions share this combined limit; it is not a separate limit per account type."}}},"TrumpAccountContributionLimit":{"type":"object","description":"Limit governing Trump Accounts. No catch-up allowance applies.","properties":{"accountTypes":{"type":"array","description":"Account types governed by this limit.","items":{"type":"string","example":"TRUMP_ACCOUNT"}},"standardLimit":{"type":"number","example":5000,"description":"Base annual limit."},"maximumAge":{"type":"integer","example":17,"description":"Oldest age at which contributions are permitted."},"maximumAllowedLimit":{"type":"number","example":5000,"description":"Ceiling for the account. No catch-up applies."},"contributionTypes":{"type":"array","description":"Per-contribution-type rules. Two of the five types consume the annual limit; the remaining three are permitted regardless of remaining headroom.","items":{"$ref":"#/components/schemas/TrumpAccountContributionType"}}}},"TrumpAccountContributionType":{"type":"object","description":"Rules for a single Trump Account contribution funding source.","properties":{"contributionType":{"type":"string","description":"The funding source this rule applies to.","enum":["SEC_128_EMPLOYER","OTHER_SOURCE","QUALIFIED_ROLLOVER","PILOT_PROGRAM","QUALIFIED_GENERAL"],"example":"SEC_128_EMPLOYER","x-enumDescriptions":{"SEC_128_EMPLOYER":"An employer contribution (Trump account).","OTHER_SOURCE":"An individual contribution (Trump account).","QUALIFIED_ROLLOVER":"A trustee-to-trustee transfer of the entire balance from another Trump account.","PILOT_PROGRAM":"A contribution under the U.S. Treasury pilot program (Trump account).","QUALIFIED_GENERAL":"A grant from a government, tribe, or 501(c)(3) organization (Trump account)."}},"description":{"type":"string","description":"Plain-language description of the funding source.","example":"Employer contribution; tax-free to the employee."},"subLimit":{"type":"object","nullable":true,"description":"Cap specific to this contribution type, expressed in account currency, along with usage against that cap. Null when no type-specific cap applies.","example":{"cumulativeAmount":2000,"limitApplied":2500,"remainingAllowance":500,"isLimitReached":false},"properties":{"cumulativeAmount":{"type":"number","format":"double","example":2000,"description":"Total amount contributed toward this sub-limit so far for the tax year."},"limitApplied":{"type":"number","format":"double","example":2500,"description":"The sub-limit cap applied to this contribution type."},"remainingAllowance":{"type":"number","format":"double","example":500,"description":"Remaining allowance before the sub-limit is reached."},"isLimitReached":{"type":"boolean","example":false,"description":"Whether the sub-limit has been reached."}}},"countsTowardLimit":{"type":"boolean","example":true,"description":"Whether contributions of this type consume the standardLimit."},"note":{"type":"string","description":"Optional additional context. Present only where extra clarification is needed.","example":"Not expected to occur under current product scope; included here for completeness."}}},"UserGeneratedAccountDocument":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"url":{"$ref":"#/components/schemas/fileURL"}}},"ExerciseDetailsRequest":{"type":"object","required":["instrumentID","quantity"],"properties":{"tradingType":{"type":"string","enum":["CASH","MARGIN"],"default":"CASH","example":"CASH","description":"Trading type for the exercise request. Optional — defaults to CASH if not provided. Should match the trading type on the account. Only CASH is currently supported; MARGIN will be rejected with a 400 error.","x-enumDescriptions":{"CASH":"A cash account; trades settle using available cash only.","MARGIN":"A margin account; trades may be placed using borrowed funds."}},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"quantity":{"type":"integer","minimum":1,"description":"Number of contracts to exercise or do not exercise. Must be a positive whole number."},"miscFees":{"type":"array","description":"Optional miscellaneous fees to include.","items":{"type":"object","required":["feeType","feeAmount"],"properties":{"feeType":{"type":"string","description":"Type/category of fee."},"feeAmount":{"type":"number","description":"Fee amount."}}}}}},"OptionsExerciseRequest":{"type":"object","description":"Represents an options exercise or do-not-exercise request with status.","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"clientID":{"type":"string","description":"Client identifier associated with the request."},"instructionID":{"type":"string","description":"Unique identifier for the request."},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"miscFees":{"type":"array","items":{"type":"object","properties":{"feeType":{"type":"string"},"feeAmount":{"type":"number"}}}},"osiSymbol":{"type":"string","description":"OCC option symbology (e.g., SPY271217C00765000).","example":"SPY271217C00765000"},"partnerID":{"$ref":"#/components/schemas/partnerID"},"quantity":{"type":"number","description":"Number of contracts."},"requestType":{"type":"string","description":"Type of the request.","example":"OPXRC"},"requestedAt":{"type":"string","format":"date-time","description":"Timestamp when the request was submitted."},"settlementDate":{"type":"string","format":"date","description":"Settlement date for the request."},"status":{"type":"string","enum":["INITIATED","PROCESSED","REJECTED"],"description":"Current status of the request.","x-enumDescriptions":{"INITIATED":"The exercise request has been initiated.","PROCESSED":"The exercise request has been processed.","REJECTED":"The exercise request was rejected."}},"tradeDate":{"type":"string","format":"date","description":"Trade date of the request."},"tradingType":{"$ref":"#/components/schemas/tradingType"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the request was last updated."}}},"OptionsExerciseRequestList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OptionsExerciseRequest"}},"page":{"type":"object","properties":{"hasMore":{"type":"boolean","example":false,"description":"Indicates whether more pages are available."}}}}},"OptionsExerciseRequestSummary":{"type":"object","description":"Aggregated totals per account and instrument, grouped by request type.","properties":{"data":{"type":"array","items":{"type":"object","required":["accountID","instrumentID","totals"],"properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"totals":{"type":"object","properties":{"EXERCISE":{"type":"number","description":"Total quantity for exercise requests."},"DO_NOT_EXERCISE":{"type":"number","description":"Total quantity for do-not-exercise requests."}}}}}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":false,"description":"Indicates whether more pages are available."}}}}},"Instruments":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/InstrumentInList"},{"$ref":"#/components/schemas/DebtInstrumentDetails"}]}},"InstrumentInList":{"type":"object","required":["id","status"],"properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"type":"string","example":"MS","description":"The ticker symbol of the associated Instrument."},"name":{"type":"string","example":"Morgan Stanley","description":"The official name of the company associated to the Instrument."},"enableExtendedHoursNotionalStatus":{"type":"string","example":"INACTIVE","description":"The Instrument's eligibility for extended hours notional trading. This will default to INACTIVE"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"type":{"deprecated":true,"type":"string","example":"EQUITY","description":"The classification of the Instrument.","enum":["EQUITY","ETF","ETN","ADR","ALTERNATIVE_ASSET","MUTUAL_FUND","INTEREST_RATE"],"x-enumDescriptions":{"EQUITY":"A stock or share of a company.","ETF":"An Exchange-Traded Fund.","ETN":"An Exchange-Traded Note.","ADR":"An American Depositary Receipt — a foreign company's shares traded in the U.S.","ALTERNATIVE_ASSET":"A non-traditional asset, such as private equity or a hedge fund interest.","MUTUAL_FUND":"A pooled investment fund managed by professionals.","INTEREST_RATE":"An interest-rate-linked instrument."}},"status":{"type":"string","example":"ACTIVE","description":"The current status of the instrument.","enum":["ACTIVE","INACTIVE","CLOSE_ONLY","HALTED"],"x-enumDescriptions":{"ACTIVE":"The instrument is tradable.","INACTIVE":"The instrument is not tradable.","CLOSE_ONLY":"Existing positions may be closed, but no new positions may be opened.","HALTED":"Trading in the instrument is halted."}},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"isOptionsEnabled":{"type":"boolean","example":true,"default":false,"description":"The ability to trade options for this equity instrument."},"payFrequency":{"$ref":"#/components/schemas/PayFrequency"},"couponRate":{"$ref":"#/components/schemas/CouponRate"},"maturityDate":{"$ref":"#/components/schemas/MaturityDate"},"spRating":{"$ref":"#/components/schemas/SpRating"},"bondType":{"$ref":"#/components/schemas/BondType"},"domicileCountry":{"$ref":"#/components/schemas/country"}}},"InstrumentBase":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"name":{"type":"string","example":"Morgan Stanley","description":"A friendly name of the Instrument, like the Company name for an equity"},"orderSizeMax":{"type":"number","example":20000,"description":"The maximum share amount for any order of this Instrument."},"orderSizeMin":{"type":"number","example":0.1,"description":"The minimum share amount for any order of this Instrument."},"orderSizeStep":{"type":"number","example":0.01,"description":"Increment amount on order of this Instrument."},"id":{"$ref":"#/components/schemas/instrumentID"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"exchange":{"type":"string","example":"NYQ","description":"The stock exchange the instrument is listed on."},"status":{"$ref":"#/components/schemas/instrumentStatus"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"CUSIP":{"$ref":"#/components/schemas/instrumentCUSIP"},"settlementDays":{"type":"integer","description":"Number of days for the instrument to settle","example":1}}},"EquityInstrumentBase":{"type":"object","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"name":{"type":"string","example":"Morgan Stanley","description":"A friendly name of the Instrument, like the Company name for an equity"},"orderSizeMax":{"type":"number","example":20000,"description":"The maximum share amount for any order of this Instrument."},"orderSizeMin":{"type":"number","example":0.1,"description":"The minimum share amount for any order of this Instrument."},"orderSizeStep":{"type":"number","example":0.01,"description":"Increment amount on order of this Instrument."},"id":{"$ref":"#/components/schemas/instrumentID"},"instrumentType":{"$ref":"#/components/schemas/instrumentType"},"exchange":{"type":"string","example":"NYQ","description":"The stock exchange the instrument is listed on."},"status":{"$ref":"#/components/schemas/instrumentStatus"},"ISIN":{"$ref":"#/components/schemas/instrumentISIN"},"international":{"type":"boolean","example":true,"description":"Instrument trades on a non-US exchange."},"region":{"type":"string","example":"EMEA","description":"The high-level jurisdiction where the instrument trades."},"priceBufferPctMOC":{"description":"The buffer, expressed in percentage points, applied to the buying power check from the close price for a Market-on-Close order for the instrument. For example, a value of 4 means 4%.","type":"number","format":"double","minimum":0,"maximum":100,"example":4,"nullable":true},"intlEquityData":{"type":"object","properties":{"fundFamily":{"type":"string","nullable":true,"description":"The name of the fund family. For example, \"ABC Funds\".","example":"Vanguard"},"fundStatus":{"type":"string","nullable":true,"description":"Indicates the fund status. Eligible values are OPEN, LIQUIDATED, MERGED, UNKNOWN.","enum":["OPEN","LIQUIDATED","MERGED","UNKNOWN"],"example":"OPEN","x-enumDescriptions":{"OPEN":"The fund is open.","LIQUIDATED":"The fund has been liquidated.","MERGED":"The fund has been merged into another fund.","UNKNOWN":"The fund status is unknown."}},"summaryRiskIndicator":{"type":"integer","description":"The fund risk reward indicator.","nullable":true,"minimum":1,"maximum":7,"enum":[1,2,3,4,5,6,7],"example":3,"x-enumDescriptions":{"1":"Lowest risk.","2":"Low risk.","3":"Low to moderate risk.","4":"Moderate risk.","5":"Moderate to high risk.","6":"High risk.","7":"Highest risk."}},"UCITS":{"type":"boolean","example":true,"description":"Identifies whether the instrument is a UCITS instrument."},"dividendPayoutIndicator":{"type":"boolean","example":true,"description":"Identifies whether the instrument pays out a dividend."},"dividendFrequency":{"type":"string","example":"MONTHLY","nullable":true,"enum":["DAILY","WEEKLY","FORTNIGHTLY","MONTHLY","BI_MONTHLY","QUARTERLY","EVERY_FOUR_MONTHS","SEMI_ANNUALLY","ANNUALLY","OTHER"],"description":"The frequency dividends are paid out by the fund.","x-enumDescriptions":{"DAILY":"Dividends are paid out daily.","WEEKLY":"Dividends are paid out weekly.","FORTNIGHTLY":"Dividends are paid out every two weeks.","MONTHLY":"Dividends are paid out monthly.","BI_MONTHLY":"Dividends are paid out every two months.","QUARTERLY":"Dividends are paid out quarterly.","EVERY_FOUR_MONTHS":"Dividends are paid out every four months.","SEMI_ANNUALLY":"Dividends are paid out twice a year.","ANNUALLY":"Dividends are paid out once a year.","OTHER":"Dividends are paid out at some other frequency."}}}}}},"OptionInstrumentBase":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"type":"string","example":"AAPL220517P00016000","description":"The Option OSI symbol"},"type":{"$ref":"#/components/schemas/instrumentType"},"name":{"type":"string","example":"Morgan Stanley","description":"A friendly name of the Instrument, like the Company name for an equity"},"exchange":{"type":"string","example":"NYQ","description":"The stock exchange the instrument is listed on."},"orderSizeMax":{"type":"number","example":20000,"description":"The maximum share amount for any order of this Instrument."},"orderSizeMin":{"type":"number","example":0.1,"description":"The minimum share amount for any order of this Instrument."},"orderSizeStep":{"type":"number","example":0.01,"description":"Increment amount on order of this Instrument."}}},"InstrumentsProperties":{"type":"object","properties":{"reutersPrimaryRic":{"type":"string","example":"MS","description":"Reuters instrument code, or RIC, is a ticker-like code similar to the ticker symbol of a security."},"description":{"type":"string","example":"Morgan Stanley is a global financial services company. The Company, through its subsidiaries, provides a range of investment banking, securities, wealth management and investment management services. Its segments include Institutional Securities, Wealth Management and Investment Management. Its Institutional Securities segment provides investment banking, sales and trading, and other services to corporations, governments, financial institutions and high net worth clients. Its Wealth Management segment provides financial services and solutions to individual investors and small-to-medium sized businesses and institutions covering: brokerage and investment advisory services; financial and wealth planning services; workplace services; annuity and insurance products; residential real estate loans and other lending products; banking; and retirement plan services. Its Investment Management segment provides a range of investment strategies and products to a diverse group of clients.","description":"A comprehensive description of the Instrument in English."},"marketTier":{"type":"string","example":"Q","enum":["Q","G"]},"sector":{"type":"string","example":"Financial Services","description":"The categorization of the sector pertaining to the Instrument.","enum":["Services","Industrials","Energy","Technology","Healthcare","Financial","Consumer Cyclical","Real Estate","Capital Goods","Utilities","Consumer Defensive","Basic Materials","Financial Services","Transportation","Communication Services"]},"industry":{"type":"string","example":"Retail (Apparel)","description":"The categorization of the industry pertaining to the Instrument.","enum":["Retail (Apparel)","Coal","Scientific & Technical Instr.","Biotechnology & Drugs","Business Services","Medical Equipment & Supplies","Oil & Gas Operations","Electronic Instr. & Controls","Misc. Financial Services","Software & Programming","Real Estate Operations","Aerospace & Defense","Water Utilities","Food Processing","Computer Services","Semiconductors","Auto & Truck Parts","Investment Services","Misc. Transportation","Construction - Raw Materials","Airline","Construction Services","Recreational Activities","Schools","Consumer Financial Services","Money Center Banks","Retail (Specialty)","Misc. Capital Goods","Apparel/Accessories","Oil Well Services & Equipment","Retail (Department & Discount)","Rental & Leasing","Constr. - Supplies & Fixtures","Fabricated Plastic & Rubber","Printing & Publishing","Fish/Livestock","Furniture & Fixtures","Retail (Grocery)","Healthcare Facilities","Major Drugs","Auto & Truck Manufacturers","Gold & Silver","Broadcasting & Cable TV","Misc. Fabricated Products","Chemical Manufacturing","Insurance (Prop. & Casualty)","Textiles - Non Apparel","Restaurants","Communications Equipment","Hotels & Motels","Computer Hardware","Footwear","Retail (Home Improvement)","Paper & Paper Products","Insurance (Life)","Personal & Household Prods.","Crops","Iron & Steel","Personal Services","Casinos & Gaming","Communications Services","Insurance (Miscellaneous)","Mobile Homes & RVs","Advertising","Trucking","Appliance & Tool","Constr. & Agric. Machinery","Metal Mining","Natural Gas Utilities","Audio & Video Equipment","Retail (Drugs)","Electric Utilities","Regional Banks","Railroads","Waste Management Services","Water Transportation","Recreational Products","Printing Services","Beverages (Nonalcoholic)","Office Supplies","Containers & Packaging","Chemicals - Plastics & Rubber","Forestry & Wood Products","Motion Pictures","Air Courier","Tobacco","Insurance (Accident & Health)","Computer Storage Devices","Beverages (Alcoholic)","Non-Metallic Mining","Tires","Security Systems & Services","Jewelry & Silverware"]},"trbc2012":{"type":"string","example":"Apparel & Accessories Retailers (NEC)","enum":["Apparel & Accessories Retailers (NEC)","Coal (NEC)","Heavy Electrical Equipment (NEC)","Biotechnology & Medical Research (NEC)","Management Consulting Services","Executive Search Services","Medical Equipment, Supplies & Distribution (NEC)","Oil & Gas Exploration and Production (NEC)","Oil & Gas Refining and Marketing (NEC)","Electronic Components","Bio Therapeutic Drugs","Investment Management & Fund Operators (NEC)","Enterprise Software","Entertainment Production (NEC)","Aerospace & Defense (NEC)","Biopharmaceuticals","Water Supply & Irrigation Systems","Fruit & Vegetable Processing","IT Services & Consulting (NEC)","Food Processing (NEC)","Photovoltaic Solar Systems & Equipment","Internet Gaming","Engine & Powertrain Systems","Commercial REITs (NEC)","Securities & Commodity Exchanges","Investment Banking & Brokerage Services (NEC)","Ground Freight & Logistics (NEC)","Online Services (NEC)","Social Media & Networking","Construction Materials (NEC)","Advanced Medical Equipment & Technology (NEC)","Airlines (NEC)","Construction & Engineering (NEC)","Gyms, Fitness and Spa Centers","Advertising & Marketing (NEC)","Miscellaneous Educational Service Providers","Transaction & Payment Services","Banks (NEC)","Real Estate Services (NEC)","Appliances, Tools & Housewares (NEC)","Apparel & Accessories (NEC)","Shell Companies","Oil Related Services and Equipment (NEC)","General Department Stores","Real Estate Rental, Development & Operations (NEC)","Iron & Steel (NEC)","Plastic Containers & Packaging","Professional Information Services (NEC)","Poultry Farming","Furniture","Business Support Services (NEC)","Gasoline stations","Display Screens","Internet & Mail Order Department Stores","Bio Diagnostics & Testing","Renewable Energy Equipment & Services (NEC)","Closed End Funds","Server & Database Software","Pharmaceuticals Wholesale","Consumer Leasing","Corporate Banks","Electric (Alternative) Vehicles","Non-Gold Precious Metals & Minerals (NEC)","Broadcasting (NEC)","Pest Control Services","Heavy Machinery & Vehicles (NEC)","Office REITs","Home Furnishings (NEC)","Financial Technology (Fintech) (NEC)","Semiconductors (NEC)","Agricultural Chemicals (NEC)","Commodity Chemicals (NEC)","Property & Casualty Insurance (NEC)","Commercial Printing Services (NEC)","Testing & Measuring Equipment","Integrated Circuits","Software (NEC)","Venture Capital","Integrated Hardware & Software","Blockchain & Cryptocurrency (NEC)","Auto Vehicles, Parts & Service Retailers (NEC)","Medical Diagnostic & Testing Equipment","Programming Software & Testing Tools","Industrial Machinery","Batteries & Uninterruptable Power supplies","Quick Service Restaurants","Auto, Truck & Motorcycle Parts (NEC)","Laboratory Diagnostic & Testing Substances","Phones & Smart Phones","Footwear (NEC)","Aircraft Parts Manufacturing","Home Improvement Products & Services Retailers (NEC)","Paper Mills & Products","Industrial REITs","Pharmaceuticals (NEC)","Investment Holding Companies (NEC)","Industrial Machinery & Equipment (NEC)","Industrial Equipment Rental","Personal Products (NEC)","Vegetable, Fruit & Nut Farming","Semiconductor Equipment & Testing (NEC)","Specialty Mining & Metals (NEC)","Biodiesel","Application Software","System Software","Travel Agents","Gold Mining","Casinos & Gaming (NEC)","Heating, Ventilation & Air Conditioning Systems","Handbags & Luggage","Restaurants & Bars (NEC)","Financial Information Providers","Child Care & Family Services","Life Insurance","Integrated Telecommunications Services (NEC)","Television Broadcasting","Consumer Repair Services","Education & Training Information Providers","Computer Hardware (NEC)","Machine Tools","Used Car Dealers","Insurance Brokers","Courier Services","Network Equipment","Prefabricated Homes","Consumer Credit Cards Services","Outdoor Advertising","Radio Broadcasting","Freight Trucking","Recreational Products (NEC)","Telemedicine Services","Communications & Networking (NEC)","Advanced Electronic Equipment","Oil Exploration & Production - Onshore","Residential Builders - Single Homes","Agricultural Machinery","Investment Banking","Uranium (NEC)","Building Contractors","Personal Services (NEC)","Silver Mining","Electrical Components & Equipment (NEC)","Security Software","Food Retail & Distribution (NEC)","Discount Stores (NEC)","Children's & Infants' Clothing Retailers","Oil & Gas Transportation Services (NEC)","Agricultural Biotechnology","E-commerce & Auction Services","Home Audio","Integrated Oil & Gas","Courier, Postal, Air Freight & Land-based Logistics (NEC)","Professional & Business Education","Paints & Coatings","Retail REITs","Frozen Food Manufacturing","Biomass & Waste to Energy Electric Utilities","Specialty Chemicals (NEC)","Employment Services (NEC)","Supermarkets & Convenience Stores","Commercial Aircraft Manufacturing","Healthcare Facilities & Services (NEC)","Multiline Utilities","Mortgage REITs","Memory Chips (RAM)","Scientific & Super Computers","Electric Utilities (NEC)","Environmental Services & Equipment (NEC)","Homebuilding (NEC)","Gambling & Gaming Machine Manufacturers","Women's Footwear","Petroleum Product Wholesale","Cruise Lines","Investment Management","Consumer Lending (NEC)","Sporting Goods Stores","Diversified REITs","Oil Related Equipment","Cryptocurrency Mining","Non-Alcoholic Beverages (NEC)","Toys & Children's Products (NEC)","Regional Airlines","Healthcare REITs","Satellite Design & Manufacture","Residential REITs","Hotels, Motels & Cruise Lines (NEC)","Diversified Chemicals","Business Support Supplies (NEC)","Passenger Car rental","Grain (Crop) Production","Paper Packaging (NEC)","Construction Supplies & Fixtures Wholesale","Sea-Borne Tankers","Household Products (NEC)","Highway & Bridge Construction","Hotels & Motels","Plastics","Sugar & Artificial Sweeteners","UK Investment Trusts","Pet Food Manufacturing","Self-Storage REITs","Retail - Drugs without Grocery","Medical Equipment Wholesale","Household Appliances","Optical Goods Stores","Dairy Products","Testing Laboratories","Natural Gas Distribution","Multiline Insurance & Brokers (NEC)","Stationary Fuel Cells","Special Foods & Wellbeing Products","Retail & Mortgage Banks","Specialized REITs (NEC)","Managed Healthcare (NEC)","Gaming Machine Operators","Personal Care Products Retailers","Technology Consulting & Outsourcing Services","Food Ingredients","Electronic Equipment & Parts (NEC)","Meat Processing","Office Real Estate Rental & Development","Portable Motors & Generators","Industrial Machinery & Equipment Wholesale","Sporting & Outdoor Goods","Private Equity","Corporate Financial Services (NEC)","Non-Paper Containers & Packaging (NEC)","Airport Operators","Agriculture Support Services","Trade & Business Publishing","Pump & Pumping Equipment","Cosmetics & Perfumes","Personal Care Services","Hospitals, Clinics & Primary Care Services","Power Charging Stations","Home Furnishings Retailers (NEC)","Tobacco (NEC)","Uranium Mining","Cable Service Providers","School, College & University (NEC)","Spacecraft Manufacturing","Financial & Commodity Market Operators & Service Providers (NEC)","Wireless Telecommunications Services (NEC)","Electric Scooters & Bicycles","Casinos","Sports & Outdoor Footwear","Waste Management, Disposal & Recycling Services","Broadcasting Equipment","New Car Dealers","Water & Related Utilities (NEC)","Proprietary & Advanced Pharmaceuticals","Residential Real Estate Rental & Development","Hedge Funds","Automotive Parts & Accessories Retailers","Property & Casualty Reinsurance","Miscellaneous Specialty Retailers (NEC)","Scientific & Precision Equipment","Doors & Window Frames","Coffee & Tea","Internet Security & Transactions Services","Veterinary Drugs","Generic Pharmaceuticals","Storage Devices","NFC & RFID Systems","Construction Machinery","Construction Supplies & Fixtures (NEC)","Renewable IPPs","Cloud Computing Services","Medical Equipment","Office Furniture","Brewers (NEC)","Heavy Machinery & Vehicles Wholesale","Hospitality REITs","Property Insurance","Medical Software & Technology Services","Metal Service Centers","Household Electronics (NEC)","Solar Electric Ultilities","Life & Health Insurance (NEC)","Aluminum (NEC)","Marine Freight & Logistics (NEC)","Doctor's Office","Commercial Food Services","Distillers & Wineries (NEC)","Petroleum Refining","Residential & Long-Term Care","Wealth Management","Market Research","Bio Medical Devices","Wireless Telecoms Service Providers","Lottery Operators","Semiconductor Testing Equipment & Service","Consumer Goods Conglomerates","Diversified Mining","Health Insurance","Rare Earth Minerals","Output Devices","Health Food Stores","Diversified Industrial Goods Wholesale","Alternative Medicine","Watches","Veterinary Medical Equipment & Supplies","Wires & Cables","Photographic Equipment","Movie Theaters & Movie Products","3D Printers","Computer & Electronics Retailers (NEC)","Portable Satellite Navigation","Cement & Concrete Manufacturing","Iron, Steel Mills & Foundries","Automotive Batteries","Satellite Service Operators","Sailing Yachts & Motorboats","Arms & Ammunitions Manufacturing","Newspaper Publishing","Oil Pipeline Transportation","Alternative Electric Utilities","Commercial Leasing","Blockchain Technology (Software)","Food Wholesale","Bread & Bakery Product Manufacturing","Auto & Truck Manufacturers (NEC)","Drone Manufacturing","Nursery & Garden Centers","Oil & Gas Drilling (NEC)","Air Freight","Heavy Trucks","Snack Food & Non-chocolate Confectionary","Deep Sea Freight","Fertilizers","Personal & Car Loans","Medical & Diagnostic Laboratories","Forest & Wood Products (NEC)","Consumer Publishing (NEC)","Airport Operators & Services (NEC)","Diversified Investment Services","Carbonated Soft Drinks","Switchgear","Commodity Chemicals Wholesale","Welding & Soldering Equipment","Compliance & Investor Communication","Leisure & Recreation (NEC)","Online Job portals","Tires & Rubber Products (NEC)","Women's Apparel Retailers","Commercial Loans","Adventure Sports Facilities & Ski Resorts","Brokerage Services","Freight Logistics","Mobile Application Software","Book & Magazine Retailers","Copper Ore  Mining","Cafés","Fire","Semiconductor Machinery Manufacturing","Wind Systems & Equipment","Ethanol Fuels","Lighting Fixtures","Toys & Games Retailers","Recreational Pharmaceuticals","Floor Covering Retailers","Industrial Valve Manufacturing","Energy Drinks","Search Engines","Electrical Transmission & Grid Equipment","Commercial Equipment","Pet & Pet Supplies Retailers","Natural Gas Utilities (NEC)","Glass Containers & Packaging","Cleaning Services","Footwear Wholesale","Cigars & Cigarette Manufacturing","Medical Monitoring Systems","Security & Surveillance","Consumer Goods Rental","Locomotive Engines & Rolling Stock","Home Healthcare Services","Medical Prosthetics","Residential Real Estate Services","Purification & Treatment Equipment","Maintenance & Repair Services","Timber REITs","Metal Containers & Packaging","Glasses, Spectacles & Contact lenses","Container & Packaging Material Wholesale","LNG Transportation & Storage","Heavy Buses & Coaches","Insurance - Automobile","Data Processing Services","Content & Site Management Services","Auto & Truck Parts Wholesale","Coke Coal Mining","Builder Merchants","Coloring Agents","Appliance & Houseware Wholesale","Nonferrous Metal Processing","Professional Sports Venues","Footwear Retailers","Discount Stores without Grocery","Amusement Parks and Zoos","Servers & Systems","Medical Devices & Implants","Life & Health Reinsurance","Kitchen Cabinets","Adhesive & Epoxy","Automotive Body Parts","Universities","Branding & Naming","Civil Engineers & Architects","Construction Supplies","Leisure Products Wholesale","Funeral Services","Oil Related Services","Natural Gas Pipeline Transportation","Motorcycles & Scooters","Sanitary Products","Medical Farming","Pubs, Bars & Night Clubs","Advertising Agency","Microfinancing","Independent Power Producers (NEC)","Accounting & Tax Preparation","Fishing & Farming (NEC)","Internet & Mail Order Discount Stores","Knitwear","Vegan & Vegetarian Food Manufacturing","Automotive Accessories","Industrial Components","Breakfast Cereal Manufacturing","Medical Supplies","Telecommunication Construction","Rating Agencies","Ball & Roller Bearings","Electrical Components","Gold (NEC)","Marketing Consulting Services","Auto & Truck Wholesale","Wineries","Outsourcing & Staffing Services","Chocolate & Confectionery","VOIP Services","Exhibition & Conference Services","Elevator & Conveying Equipment","Department Stores (NEC)","Land Division & Subdivision","Plays & Concert Production","Reinsurance (NEC)","Movie, TV Production & Distribution","Resort Operators","Computer Hardware & Software Retailers","Jewelry & Watch Retailers","Machine Learning & Artificial Intelligence (AI) Services","Interior Design Services","Wood Products","Entertainment Production Equipment & Services","Security Services","Drug Retailers (NEC)","Men's Apparel Retailers","Iron Ore Mining","Plumbing Fixtures & Fittings","Office Equipment (NEC)","Point of Sale Systems","Human Resources Consulting Services","Railway Freight Operators","Automobiles & Multi Utility Vehicles","Parking Lot Operators","Birth Control Products","Electric Power Plant Construction","Laser Equipment","Men's Clothing","Office Supplies & Stationery Stores","Industrial Gases","Bottled Water & Ice","Casualty Insurance","Fishing & Farming Wholesale","Sports & Outdoors Retailers","Carpets & Curtains","Unconventional Oil & Gas Production","Oil & Gas Storage","Geophysical Surveying & Mapping Services","Primary Aluminum Production","Power & Communications Network Construction","Yarn Goods","Pulp Mills","Inland Water Freight","Water & Sewage Construction","Electric Equipment Wholesale","Organic Farming","Medical Imaging Systems","Residential Builders - Multifamily Homes","Renewable Energy Services","Book Publishing"]},"indexMemberships":{"type":"array","example":["NASDAQ 100 Index","S&P 500"],"items":{"oneOf":[{"$ref":"#/components/schemas/indexMembers"}]}},"incorporatedCountry":{"type":"string","example":"USA","description":"The country code of the incorporated company's Instrument.","enum":["USA","ARG","CYM","AUS","MEX","FRA","LUX","GBR","CAN","TWN","VGB","CHL","BMU","ISR","NLD","IND","IRL","ESP","DEU","BRA","ZAF","JPN","PRI","CHN","BHS","JEY","MHL","PAN","SWE","SGP","KOR","ITA","BGD","CHE","CUW","TUR","PER","IDN","CYP","DNK","BEL","COL","FIN","MUS","GGY","NOR","PHL","LBR","GRC","HKG"],"x-enumDescriptions":{"USA":"United States.","ARG":"Argentina.","CYM":"Cayman Islands.","AUS":"Australia.","MEX":"Mexico.","FRA":"France.","LUX":"Luxembourg.","GBR":"United Kingdom.","CAN":"Canada.","TWN":"Taiwan.","VGB":"British Virgin Islands.","CHL":"Chile.","BMU":"Bermuda.","ISR":"Israel.","NLD":"Netherlands.","IND":"India.","IRL":"Ireland.","ESP":"Spain.","DEU":"Germany.","BRA":"Brazil.","ZAF":"South Africa.","JPN":"Japan.","PRI":"Puerto Rico.","CHN":"China.","BHS":"Bahamas.","JEY":"Jersey.","MHL":"Marshall Islands.","PAN":"Panama.","SWE":"Sweden.","SGP":"Singapore.","KOR":"South Korea.","ITA":"Italy.","BGD":"Bangladesh.","CHE":"Switzerland.","CUW":"Curaçao.","TUR":"Turkey.","PER":"Peru.","IDN":"Indonesia.","CYP":"Cyprus.","DNK":"Denmark.","BEL":"Belgium.","COL":"Colombia.","FIN":"Finland.","MUS":"Mauritius.","GGY":"Guernsey.","NOR":"Norway.","PHL":"Philippines.","LBR":"Liberia.","GRC":"Greece.","HKG":"Hong Kong."}},"isOptionsEnabled":{"type":"boolean","example":true,"description":"The ability to trade options for this equity instrument. Default is false, meaning it is not possible to trade options for this instrument."},"longOnly":{"type":"boolean","example":true,"description":"The ability to short an Instrument. Default is true, meaning it is not possible to short the instrument."},"exchangeNickelSpread":{"type":"boolean","example":false,"description":"If true, a limit order for this Instrument must be in increments of $0.05"},"close":{"type":"number","example":87.79,"description":"The most recent closing price of the Instrument."},"enableExtendedHoursNotionalStatus":{"type":"string","example":"INACTIVE","description":"The instruments eligibility for extended hours notional trading. This will default to INACTIVE."},"fundamentalDataModel":{"$ref":"#/components/schemas/fundamentalDataModel"},"type":{"deprecated":true,"type":"string","example":"EQUITY","description":"The classification of the Instrument.","enum":["EQUITY","ETF","ETN","ADR","ALTERNATIVE_ASSET","MUTUAL_FUND"],"x-enumDescriptions":{"EQUITY":"A stock or share of a company.","ETF":"An Exchange-Traded Fund.","ETN":"An Exchange-Traded Note.","ADR":"An American Depositary Receipt — a foreign company's shares traded in the U.S.","ALTERNATIVE_ASSET":"A non-traditional asset, such as private equity or a hedge fund interest.","MUTUAL_FUND":"A pooled investment fund managed by professionals."}},"url":{"type":"string","example":"http://investor.apple.com","description":"URL for the investor site of the instrument."},"closePrior":{"type":"number","example":90.5,"description":"The instruments closing price of the prior trading day."},"image":{"type":"string","example":"http://syscdn.drivewealth.net/images/symbols/ms.png","description":"A publicly hosted image of the instruments logo."},"isPTP":{"type":"boolean","example":false,"description":"True, if the Instrument is a publicly traded partnership (PTP)."},"averageLendingRate":{"type":"number","example":1.5,"description":"30-day average of daily lending rates. Available only for Fully Paid Securities Lending Partners."}}},"EquityInstrumentDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/EquityInstrumentBase"},{"$ref":"#/components/schemas/InstrumentsProperties"}],"properties":{"fundamentalDataModel":{"$ref":"#/components/schemas/fundamentalDataModel"}}},"fundamentalDataModel":{"type":"object","nullable":true,"properties":{"id":{"$ref":"#/components/schemas/instrumentID"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"openPrice":{"$ref":"#/components/schemas/openPrice"},"bidPrice":{"$ref":"#/components/schemas/bidPrice"},"askPrice":{"$ref":"#/components/schemas/askPrice"},"lowPrice":{"$ref":"#/components/schemas/lowPrice"},"highPrice":{"$ref":"#/components/schemas/highPrice"},"fiftyTwoWeekLowPrice":{"type":"number","example":72.05,"description":"The lowest price of the instrument in the past 52 weeks."},"fiftyTwoWeekHighPrice":{"type":"number","example":109.73,"description":"The highest price of the instrument in the past 52 weeks."},"cumulativeVolume":{"type":"number","example":3970567,"description":"Cumulative Volume is a running total of daily trade volume. This measures the cumulative inflow and outflow of trading volume for the instrument. Measured in quantity of shares."},"marketCap":{"type":"number","example":148374700000,"description":"The total market cap of the instrument measured in USD."},"peRatio":{"type":"number","example":12.7434,"description":"The Price-earnings ratio for the instrument."},"dividendYield":{"type":"number","example":3.5312,"description":"The percentage of a company's share price that is payed out in dividends each year."},"earningsPerShare":{"type":"number","example":6.889,"description":"The earnings per share of the instrument measured in USD. EPS is company's profit divided by the outstanding shares of its common stock."},"dividend":{"type":"number","example":3.1,"description":"The annual dividend amount paid out per share measured in USD."},"sharesOutstanding":{"type":"number","example":1307993346,"description":"The total shares outstanding for the instrument. Shares outstanding are all the shares of an instrument that have been authorized, issued and purchased by investors."},"timeLastUpdate":{"type":"string","example":"18:28:00","description":"The last time the instruments data was updated."},"bookValuePerShare":{"type":"string","example":"59.49634","description":"The book value per share of the instrument measured in USD. The BVPS is the ratio of equity available to common shareholders divided by the number of outstanding shares."},"cashFlowPerShare":{"type":"string","example":"10.40132","description":"The cash flow per share measured in USD. Cash flow per share is the after-tax earnings plus depreciation on a per-share basis that functions as a measure of a firm's financial strength."},"operatingIncome":{"type":"string","example":"19668000000","description":"The operating income of an instrument measured in USD. Operating income is an accounting figure that measures the amount of profit realized from a business's operations after deducting operating expenses such as wages, depreciation, and cost of goods sold."},"pbRatio":{"type":"string","example":"1.61196","description":"The Price-to-Book ratio of the instrument measured USD per share. The Price-to-Bok ratio measures the market valuation of an Instrument relative to its book value."},"volumeMovingAverage10Day":{"type":"number","example":7791905,"description":"The volume moving average of the last 10 days for the instrument measured in quantity of shares."},"volumeMovingAverage25Day":{"type":"number","example":6768708,"description":"The volume moving average of the last 25 days for the instrument measured in quantity of shares."},"volumeMovingAverage50Day":{"type":"number","example":7307176,"description":"The volume moving average of the last 50 days for the instrument measured in quantity of shares."},"priceMovingAverage50Day":{"type":"number","example":85.3034,"description":"The price moving average of the last 50 days for the instrument measured in (USD) per share."},"priceMovingAverage150Day":{"type":"number","example":83.6295,"description":"The price moving average of the last 150 days for the instrument measured in (USD) per share."},"priceMovingAverage200Day":{"type":"number","example":84.3036,"description":"The price moving average of the last 200 days for the instrument measured in (USD) per share."},"roe":{"type":"string","example":"0.15315","description":"Return on equity of the instrument measured as a fraction, multiply by 100 to get percentage value. ROE is a measure of financial performance calculated by dividing net income by shareholders' equity."},"percentchangeWTD":{"type":"number","example":2.31,"description":"The percentage change between the most recent market closing price and the closing price at the week start."},"percentchangeMTD":{"type":"number","example":2.3,"description":"The price percentage change for the instrument Month to Date."},"percentchangeYTD":{"type":"number","example":10.11,"description":"The price percentage change for the instrument Year to Date."},"percentchange4week":{"type":"number","example":21.22,"description":"The price percentage change for the instrument in last 4 Weeks."},"percentchange13week":{"type":"number","example":6.67,"description":"The price percentage change for the instrument in last 13 Weeks."},"percentchange26week":{"type":"number","example":8.26,"description":"The price percentage change for the instrument in last 26 Weeks."},"percentchange52week":{"type":"number","example":12.1,"description":"The price percentage change for the instrument in last 52 Weeks."},"percentchange5day":{"type":"number","example":10.11,"description":"The 5 Day Price Percent Change is the percentage change in the company's stock price over the last 5 tradable (business) days."},"percentchangeYTDrelsnp":{"type":"number","example":9.11,"description":"The percentage change in price since the close of the last trading day of the previous year as compared to the change in price of the S&P 500 during that same period."},"percentchange5weekrelsnp":{"type":"number","example":16.62,"description":"The percentage change in price over the last four weeks as compared to the change in price of the S&P 500 during that same period"},"percentchange13weekrelsnp":{"type":"number","example":5.67,"description":"The percentage change in price over the last thirteen weeks as compared to the change in price of the S&P 500 during that same period"},"percentchange26weekrelsnp":{"type":"number","example":2.66,"description":"The percentage change in price over the last twenty six weeks as compared to the change in price of the S&P 500 during that same period."},"percentchange52weekrelsnp":{"type":"number","example":11.12,"description":"The percentage change in price over the last fifty two weeks as compared to the change in price of the S&P 500 during that same period."}}},"OptionInstrumentDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/OptionInstrumentBase"}],"properties":{"optionsData":{"type":"object","properties":{"rootSymbol":{"type":"string","example":"AAPL","description":"Ticker symbol of the underlying instrument from which this Option is derived."},"rootId":{"type":"string","example":"123e4567-e89b-12d3-a456-000000000006","description":"A unique ID created by DriveWealth to identify a specific Instrument that this Option is derived from."},"expirationDate":{"type":"string","example":"2018-09-18","description":"The date the Option Contract will expire","format":"date"},"optionType":{"type":"string","example":"PUT","description":"Call or Put","enum":["CALL","PUT"],"x-enumDescriptions":{"CALL":"A call option, giving the right to buy the underlying instrument.","PUT":"A put option, giving the right to sell the underlying instrument."}},"strikePrice":{"type":"number","example":16.5,"description":"The strike price of the option."},"deliverable":{"type":"number","example":100,"default":100,"description":"The deliverable unit, available for stock and index options, is the number of shares of the underlying stock with respect to one option contract."},"multiplier":{"type":"number","example":100,"default":100,"description":"The premium/strike Multiplier, available for stock and index options, provides the premium/strike multiplier for an option contract."}}}}},"MutualFundInstrumentDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstrumentBase"}],"properties":{"url":{"type":"string","nullable":true,"example":"http://investor.apple.com","description":"The URL to the investor information page or the prospectus."},"image":{"type":"string","nullable":true,"example":"http://syscdn.drivewealth.net/images/symbols/ms.png","description":"A publicly hosted image of the instruments logo."},"mutualFundData":{"type":"object","properties":{"fundFamily":{"type":"string","nullable":true,"description":"The name of the fund family. For example, \"ABC Funds\".","example":"Vanguard"},"shareClass":{"type":"string","nullable":true,"description":"Identifies the share class of the fund. For example Class A, Class B, or Institutional.","enum":["A","B","INST","OTHER"],"example":"INST","x-enumDescriptions":{"A":"Class A shares.","B":"Class B shares.","INST":"Institutional share class.","OTHER":"Another share class."}},"loadType":{"type":"string","description":"Identifies how commissions are paid for the fund, if any.","enum":["NO_LOAD","FRONT_END","BACK_END","LEVEL","HYBRID","OTHER"],"example":"NO_LOAD","x-enumDescriptions":{"NO_LOAD":"No sales charge.","FRONT_END":"A sales charge paid at purchase.","BACK_END":"A sales charge paid at redemption.","LEVEL":"An ongoing level sales charge, such as a 12b-1 fee.","HYBRID":"A combination of front-end and back-end sales charges.","OTHER":"Another commission structure."}},"dccsEligible":{"type":"boolean","description":"Indicates if the fund allows orders to be submitted through the NSCC DCC&S Defined Contribution Clearance and Settlement.","example":true},"blueSkyStates":{"type":"array","nullable":true,"description":"State postal abbreviation for each state the fund has been registered in.","example":["CA","NY","AZ"],"items":{"type":"string"}},"purchaseCutOff":{"type":"string","nullable":true,"description":"The cutoff time to accept a buy order and execute the same day.","example":"16:00"},"redemptionCutOff":{"type":"string","nullable":true,"description":"The cutoff time to accept a sell order and execute the same day.","example":"16:00"},"maximumPurchaseAmount":{"type":"number","nullable":true,"description":"The maximum purchase amount in dollars the fund will allow.","example":10000000},"purchaseMinimums":{"type":"object","nullable":true,"properties":{"minimumInitialTaxable":{"type":"integer","nullable":true,"description":"The minimum initial purchase amount, in dollars, the fund will allow for taxable accounts.","example":500},"minimumInitialIRA":{"type":"integer","nullable":true,"description":"The minimum initial purchase amount, in dollars, the fund will allow for IRA accounts.","example":500},"minimumInitialQualifiedPlans":{"type":"integer","nullable":true,"description":"The minimum initial purchase amount, in dollars, the fund will allow for qualified plans. This would include 401K, HSAs, etc.","example":500},"minimumSubsequentTaxable":{"type":"integer","nullable":true,"description":"The minimum subsequent purchase amount, in dollars, the fund will allow for taxable accounts.","example":100},"minimumSubsequentIRA":{"type":"integer","nullable":true,"description":"The minimum subsequent purchase amount, in dollars, the fund will allow for IRA accounts.","example":100},"minimumSubsequentQualifiedPlans":{"type":"integer","nullable":true,"description":"The minimum subsequent purchase amount, in dollars, the fund will allow for qualified plans. This would include 401K, HSAs, etc.","example":100},"minimumSystematicPurchase":{"type":"integer","nullable":true,"description":"The minimum amount, in dollars, which will be allowed for systematic purchases.","example":10},"minimumInitialExchange":{"type":"integer","nullable":true,"description":"The minimum initial purchase amount, in dollars, which will be allowed for exchange purchases.","example":10},"minimumSubsequentExchange":{"type":"integer","nullable":true,"description":"The minimum subsequent purchase amount, in dollars, which will be allowed for exchange purchases.","example":10}}},"fundType":{"type":"string","nullable":true,"description":"The type of mutual fund.","enum":["MUTUAL_FUND","MONEY_MARKET","UIT","CLOSE_END","GIC","STABLE_VALUE","SEPARATE_ACCOUNT","BANK_COLLECTIVE_TRUST","OFFSHORE_NRA","BIC","529_PLAN","OFFSHORE_US_DOLLAR","OFFSHORE_NON_US_DOLLAR","ANNUITY","UNKNOWN"],"example":"MUTUAL_FUND","x-enumDescriptions":{"MUTUAL_FUND":"A standard open-end mutual fund.","MONEY_MARKET":"A money market fund.","UIT":"A Unit Investment Trust.","CLOSE_END":"A closed-end fund.","GIC":"A Guaranteed Investment Contract.","STABLE_VALUE":"A stable value fund.","SEPARATE_ACCOUNT":"An insurance company separate account.","BANK_COLLECTIVE_TRUST":"A bank collective investment trust.","OFFSHORE_NRA":"An offshore fund for non-resident alien investors.","BIC":"A Bank Investment Contract.","529_PLAN":"A Section 529 education savings plan.","OFFSHORE_US_DOLLAR":"An offshore fund denominated in U.S. dollars.","OFFSHORE_NON_US_DOLLAR":"An offshore fund denominated in a currency other than U.S. dollars.","ANNUITY":"An annuity product.","UNKNOWN":"The fund type is unknown."}},"fundStatus":{"type":"string","description":"Indicates if the fund is open or closed. Eligible values are Open, Closed - Liquidated, Closed - Merged.","enum":["OPEN","LIQUIDATED","MERGED","UNKNOWN"],"example":"OPEN","x-enumDescriptions":{"OPEN":"The fund is open.","LIQUIDATED":"The fund has been liquidated.","MERGED":"The fund has been merged into another fund.","UNKNOWN":"The fund status is unknown."}},"largeTradeNotificationRequired":{"type":"boolean","description":"Does the fund required prior notification when large trades are being placed."},"largeTradeDollarThreshold":{"type":"number","nullable":true,"description":"At what dollar amount is prior trade notification.","example":1000000000},"redemptionFeePercentage":{"type":"integer","nullable":true,"description":"The percent charged for the non-short-term redemption.","example":0},"redemptionFeeAmount":{"type":"integer","nullable":true,"description":"The amount, in dollars, charged for the non-short-term redemption fee.","example":0},"restrictedRedemption":{"type":"boolean","nullable":true,"description":"Is the redemption of shares for this fund limited to specific dates and/or intervals."},"purchaseEligibility":{"type":"string","nullable":true,"description":"Can the fund be purchased by new and/or existing shareholders. Eligible values: All, Existing Only, Closed, Restrictions Apply (see Prospectus).","enum":["ALL","EXISTING_ONLY","CLOSED","RESTRICTIONS_APPLY","UNKNOWN"],"example":"ALL","x-enumDescriptions":{"ALL":"Open to all investors, new and existing.","EXISTING_ONLY":"Open only to existing shareholders.","CLOSED":"Closed to new purchases.","RESTRICTIONS_APPLY":"Restrictions apply; see the fund's prospectus.","UNKNOWN":"Eligibility is unknown."}},"exchangeBuyEligibility":{"type":"string","nullable":true,"description":"Can shares of another fund be exchanged into new and/or existing accounts or is the fund closed for exchange purchases.","enum":["ALL","EXISTING_ONLY","CLOSED","RESTRICTIONS_APPLY","UNKNOWN"],"example":"ALL","x-enumDescriptions":{"ALL":"Open to all investors, new and existing.","EXISTING_ONLY":"Open only to existing shareholders.","CLOSED":"Closed to new exchange purchases.","RESTRICTIONS_APPLY":"Restrictions apply; see the fund's prospectus.","UNKNOWN":"Eligibility is unknown."}},"exchangeFee":{"type":"string","nullable":true,"description":"Are exchange fees charged on this fund and, if so, are they done on a percentage or fixed dollar basis.","enum":["NO_EXCHANGE_FEE","PERCENTAGE","FIXED_DOLLAR","UNKNOWN"],"example":"PERCENTAGE","x-enumDescriptions":{"NO_EXCHANGE_FEE":"No fee is charged on exchanges.","PERCENTAGE":"A percentage-based exchange fee.","FIXED_DOLLAR":"A fixed-dollar exchange fee.","UNKNOWN":"Whether an exchange fee applies is unknown."}},"exchangeFeePercentage":{"type":"number","nullable":true,"description":"The exchange fee percent charged.","example":10.5},"exchangeFeeAmount":{"type":"integer","nullable":true,"description":"The amount, in dollars, of the exchange fee charged.","example":0},"dividendFrequency":{"type":"string","nullable":true,"description":"The frequency dividends are paid out by the fund.","enum":["DAILY","WEEKLY","FORTNIGHTLY","MONTHLY","BI_MONTHLY","EVERY_FOUR_MONTHS","QUARTERLY","SEMI_ANNUALLY","ANNUALLY","OTHER"],"example":"MONTHLY","x-enumDescriptions":{"DAILY":"Dividends are paid out daily.","WEEKLY":"Dividends are paid out weekly.","FORTNIGHTLY":"Dividends are paid out every two weeks.","MONTHLY":"Dividends are paid out monthly.","BI_MONTHLY":"Dividends are paid out every two months.","EVERY_FOUR_MONTHS":"Dividends are paid out every four months.","QUARTERLY":"Dividends are paid out quarterly.","SEMI_ANNUALLY":"Dividends are paid out twice a year.","ANNUALLY":"Dividends are paid out once a year.","OTHER":"Dividends are paid out at some other frequency."}},"operatingExpenses":{"type":"number","nullable":true,"description":"Expenses paid by the shareholders each year as a percentage of the fund's value.","example":0.25},"portfolioTurnover":{"type":"number","nullable":true,"description":"Investment portfolio turnover rate.","example":10.7},"shortTermRedemptionRules":{"type":"boolean","nullable":true,"description":"Do Short-Term Redemption Fee fields apply for this fund.","example":true},"shortTermRedemptionMinimumAmount":{"type":"integer","nullable":true,"description":"The minimum amount that the fund will charge as a short-term redemption fee.","example":0},"mergedSecurity":{"type":"string","nullable":true,"description":"The fund status code equal to closed - merged, the Security ID of the fund to which it was merged.","example":"000000001"},"prospectusUrl":{"type":"string","nullable":true,"description":"The link to the fund prospectus.","example":"https://app.allfunds.com/docs/legal/fund/...."},"managementFee":{"type":"number","nullable":true,"description":"The fund management fee.","example":0.15},"domicile":{"type":"string","nullable":true,"description":"The fund ISO 2 domicile code.","example":"GB"},"summaryRiskIndicator":{"type":"integer","nullable":true,"description":"The fund risk reward indicator.","minimum":1,"maximum":7,"enum":[1,2,3,4,5,6,7],"example":3,"x-enumDescriptions":{"1":"Lowest risk.","2":"Low risk.","3":"Low to moderate risk.","4":"Moderate risk.","5":"Moderate to high risk.","6":"High risk.","7":"Highest risk."}},"UCITS":{"type":"boolean","description":"True, if the investment funds regulated at European Union level.","example":true},"subAssetClassCategory":{"type":"string","readOnly":true,"nullable":true,"description":"The most specific categorization within the asset class hierarchy.","example":"EQ - Japanese Small Cap"},"minimumHoldingAmount":{"type":"number","format":"double","readOnly":true,"nullable":true,"description":"The minimum amount, in dollars, that must be held in the account to maintain a position.","example":1000},"decimalsForShares":{"type":"integer","nullable":true,"description":"The maximum number of decimals for shares for this fund.","minimum":0,"example":2},"decimalsForAmount":{"type":"integer","nullable":true,"description":"The maximum number of decimals for amounts for this fund.","minimum":0,"example":2},"decimalsForPrices":{"type":"integer","nullable":true,"description":"The maximum number of decimals in the price for this fund.","minimum":0,"example":2},"isPreFunded":{"type":"boolean","nullable":true,"description":"Indicates whether the fund needs to be pre-funded for subscription.","example":true},"subscriptionsByAmount":{"type":"boolean","nullable":true,"description":"Indicates whether subscriptions by amount are allowed for the fund.","example":true},"subscriptionsByShares":{"type":"boolean","nullable":true,"description":"Indicates whether subscriptions by shares are allowed for the fund.","example":true},"redemptionsByAmount":{"type":"boolean","nullable":true,"description":"Indicates whether redemptions by amount are allowed for the fund.","example":true},"redemptionsByShares":{"type":"boolean","nullable":true,"description":"Indicates whether redemptions by shares are allowed for the fund.","example":true},"frequencyValuation":{"type":"string","nullable":true,"description":"The frequency at which the fund is valued.","example":"DAILY","allOf":[{"$ref":"#/components/schemas/FundFrequency"}]},"frequencySubscriptions":{"type":"string","nullable":true,"description":"The frequency at which the fund can be subscribed to.","example":"WEEKLY","allOf":[{"$ref":"#/components/schemas/FundFrequency"}]},"frequencyRedemptions":{"type":"string","nullable":true,"description":"The frequency at which the fund can be redeemed.","example":"MONTHLY","allOf":[{"$ref":"#/components/schemas/FundFrequency"}]}}}}},"DebtInstrumentDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/InstrumentBase"}],"properties":{"debtData":{"$ref":"#/components/schemas/DebtReferenceData"}}},"ExpirationDateList":{"type":"object","properties":{"symbol":{"type":"string","example":"AAPL","description":"The Symbol of the underlying equity security."},"expiration":{"type":"array","example":["2022-05-10","2022-05-11"],"description":"The date the Option Contract will expire.","items":{"type":"string"}}}},"OptionsList":{"type":"object","properties":{"symbol":{"type":"string","example":"AAPL220517P00016000","description":"Option OSI symbol"},"options":{"type":"array","items":{"$ref":"#/components/schemas/OptionInstrumentDetails"}}}},"PayFrequency":{"description":"The anticipated frequency of scheduled interest payments under the Bonds.","type":"string","enum":["ANNUALLY","SEMI_ANNUALLY","QUARTERLY","MONTHLY","WEEKLY","DAILY","EVERY_X_DAYS","EVERY_X_MONTHS","EVERY_X_WEEKS","EVERY_X_YEARS","AT_MATURITY","SINGLE_DATE","SINGLE_INTEREST_PAYMENT","FLEXIBLE","NOT_APPLICABLE"],"example":"SEMI_ANNUALLY","readOnly":true,"x-enumDescriptions":{"ANNUALLY":"Paid once a year.","SEMI_ANNUALLY":"Paid twice a year.","QUARTERLY":"Paid quarterly.","MONTHLY":"Paid monthly.","WEEKLY":"Paid weekly.","DAILY":"Paid daily.","EVERY_X_DAYS":"Paid every specified number of days.","EVERY_X_MONTHS":"Paid every specified number of months.","EVERY_X_WEEKS":"Paid every specified number of weeks.","EVERY_X_YEARS":"Paid every specified number of years.","AT_MATURITY":"Paid in full at maturity.","SINGLE_DATE":"Paid on a single specified date.","SINGLE_INTEREST_PAYMENT":"A single interest payment.","FLEXIBLE":"The payment schedule is flexible.","NOT_APPLICABLE":"Not applicable."}},"CouponRate":{"description":"The annual rate of interest currently applicable to the instrument.","type":"number","format":"double","example":0.05,"readOnly":true},"MaturityDate":{"description":"The date on which the principal amount of the debt instrument becomes due.","type":"string","format":"date","example":"2022-05-10","readOnly":true},"SpRating":{"description":"The long term S&P Rating of the issuer.","type":"string","example":"AAA","readOnly":true},"SpRatingDate":{"description":"The date on which the S&P Rating was last updated.","type":"string","format":"date","example":"2018-05-10","readOnly":true},"BondType":{"description":"The type of bond.","type":"string","enum":["OTHER","CORPORATE_BOND","GOVERNMENT/AGENCY_BOND","US_MUNICIPAL_BOND","COLLATERALIZED_MORTGAGE_OBLIGATION/ASSET-BACKED_SECURITY","MORTGAGE-BACKED_SECURITY","MONEY_MARKET","COMMON_EQUITY","PREFERRED_EQUITY","RIGHT","WARRANT","OPTION","FUTURE","SWAP","CURRENCY","COMMODITY","INDEX","MUTUAL_FUND/UNIT_INVESTMENT_TRUST","MONEY_MARKET_FUND","EXCHANGE_TRADED_FUND","HYBRID","NON-US_MORTGAGE-BACKED_SECURITY","COMPOSITE_UNIT","DEBT/EQUITY_HYBRID","STRATEGY","OVER-THE-COUNTER_(OTC)","BANK_LOAN","MBS_GENERIC"],"example":"CORPORATE_BOND","readOnly":true,"x-enumDescriptions":{"OTHER":"Another bond type.","CORPORATE_BOND":"A corporate bond.","GOVERNMENT/AGENCY_BOND":"A government or government-agency bond.","US_MUNICIPAL_BOND":"A U.S. municipal bond.","COLLATERALIZED_MORTGAGE_OBLIGATION/ASSET-BACKED_SECURITY":"A collateralized mortgage obligation (CMO) or asset-backed security (ABS).","MORTGAGE-BACKED_SECURITY":"A mortgage-backed security (MBS).","MONEY_MARKET":"A money market instrument.","COMMON_EQUITY":"Common equity.","PREFERRED_EQUITY":"Preferred equity.","RIGHT":"A subscription right.","WARRANT":"A warrant.","OPTION":"An option.","FUTURE":"A futures contract.","SWAP":"A swap.","CURRENCY":"A currency instrument.","COMMODITY":"A commodity instrument.","INDEX":"An index.","MUTUAL_FUND/UNIT_INVESTMENT_TRUST":"A mutual fund or unit investment trust (UIT).","MONEY_MARKET_FUND":"A money market fund.","EXCHANGE_TRADED_FUND":"An exchange-traded fund (ETF).","HYBRID":"A hybrid debt/equity instrument.","NON-US_MORTGAGE-BACKED_SECURITY":"A non-U.S. mortgage-backed security.","COMPOSITE_UNIT":"A composite unit.","DEBT/EQUITY_HYBRID":"A debt/equity hybrid instrument.","STRATEGY":"A strategy-based instrument.","OVER-THE-COUNTER_(OTC)":"An over-the-counter (OTC) instrument.","BANK_LOAN":"A bank loan.","MBS_GENERIC":"A generic mortgage-backed security."}},"DebtReferenceData":{"type":"object","properties":{"payFrequency":{"$ref":"#/components/schemas/PayFrequency"},"couponRate":{"$ref":"#/components/schemas/CouponRate"},"maturityDate":{"$ref":"#/components/schemas/MaturityDate"},"spRating":{"$ref":"#/components/schemas/SpRating"},"spRatingDate":{"$ref":"#/components/schemas/SpRatingDate"},"minimumInvestmentAmount":{"description":"The minimum initial investment in the security.","type":"integer","format":"int64","example":1000,"readOnly":true},"incrementalInvestmentAmount":{"description":"The minimum additional investment in the security.","type":"integer","format":"int64","example":1000,"readOnly":true},"issueDate":{"description":"The date on which the instrument was first made available to the market.","type":"string","format":"date","example":"2018-05-10","readOnly":true},"datedDate":{"description":"The date of a Bond Issue from which Interest begins to accrue.","type":"string","format":"date","example":"2018-05-10","readOnly":true},"issueAmount":{"description":"The total value of the security at issue.","type":"number","format":"double","example":1000000,"readOnly":true},"issuePricePercent":{"description":"The nominal value associated with a financial instrument at the time of issuance.","type":"number","format":"double","example":100,"readOnly":true},"accruedInterest":{"description":"The amount of interest that has accumulated since the last coupon payment.","type":"number","format":"double","example":0.05,"readOnly":true},"debtType":{"description":"The code for the type fixed income instrument.","type":"integer","readOnly":true},"bondType":{"$ref":"#/components/schemas/BondType"},"debtTypeDescription":{"type":"string","description":"The description for the type fixed income instrument.","enum":["NONE","BANK_LOAN","ASSET-BACKED_SECURITY_(ABS)","BOND","CERTIFICATE_OF_DEPOSIT_(CD)","DEMAND_NOTE","EMPLOYEE_STOCK_OWNERSHIP_PLAN_(ESOP)","FHLMC_REFERENCE_NOTES","GUARANTEED_INVESTMENT_CERTIFICATE_(GIC)","SCHULDSCHEIN","INCOME","MORTGAGE-BACKED_SECURITY_(MBS)","BANKER'S_ACCEPTANCE","COLLATERALISED_LOAN_OBLIGATION_(CLO)","COLLATERALIZED_MORTGAGE_OBLIGATION_(CMO)","NOTE","COLLATERALISED_BOND_OBLIGATION_(CBO)","COMMERCIAL_PAPER","PFANDBRIEF","PROMISSORY_NOTES","STRUCTURED_ASSETS","TRUST_CERTIFICATE","PARTICIPATION_UNIT","SAVINGS_BOND","PASS_THRU_CERTIFICATES","UNKNOWN","STRIP","ANNUITY","BILL","CERTIFICATE","DEPOSIT_NOTE","EQUIPMENT_TRUST_CERTIFICATE","FNMA_BENCHMARK_ISSUES","MORTGAGE/UK_DEBENTURE","SCHATZANWEISUNGEN","DISCOUNT_NOTE","PERMANENT_INTEREST_BEARING_SECURITY","OTHER_MONEY_MARKETS","LOAN_NOTE","MERCHANT_MARINE","MORTGAGE_NOTE","COLLATERALIZED_DEBT_OBLIGATION_(CDO)","PRIVATE_PLACEMENT","EXCHANGE_TRADED_NOTE","PREMIUM_BOND","SECURITY","UNIT","SAVINGS_NOTES","PARTICIPATION_CERTIFICATES","DISCOUNT_DEBENTURE","DEBENTURE_-_UNSECURED","EXCHANGE_TRADED_COMMODITY","ASSET-BACKED_COMMERCIAL_PAPER","SUKUK","DEBENTURE_-_SECURED","LETTER_OF_CREDIT","GLOBAL_DEPOSITORY_NOTE"],"example":"BOND","readOnly":true,"x-enumDescriptions":{"NONE":"No debt type specified.","BANK_LOAN":"A bank loan.","ASSET-BACKED_SECURITY_(ABS)":"An asset-backed security (ABS).","BOND":"A bond.","CERTIFICATE_OF_DEPOSIT_(CD)":"A certificate of deposit (CD).","DEMAND_NOTE":"A demand note, payable on request.","EMPLOYEE_STOCK_OWNERSHIP_PLAN_(ESOP)":"An employee stock ownership plan (ESOP) note.","FHLMC_REFERENCE_NOTES":"A Freddie Mac (FHLMC) reference note.","GUARANTEED_INVESTMENT_CERTIFICATE_(GIC)":"A guaranteed investment certificate (GIC).","SCHULDSCHEIN":"A German-law private debt instrument (Schuldschein loan).","INCOME":"An income-type debt instrument.","MORTGAGE-BACKED_SECURITY_(MBS)":"A mortgage-backed security (MBS).","BANKER'S_ACCEPTANCE":"A banker's acceptance.","COLLATERALISED_LOAN_OBLIGATION_(CLO)":"A collateralized loan obligation (CLO).","COLLATERALIZED_MORTGAGE_OBLIGATION_(CMO)":"A collateralized mortgage obligation (CMO).","NOTE":"A note.","COLLATERALISED_BOND_OBLIGATION_(CBO)":"A collateralized bond obligation (CBO).","COMMERCIAL_PAPER":"Commercial paper.","PFANDBRIEF":"A German covered bond (Pfandbrief).","PROMISSORY_NOTES":"Promissory notes.","STRUCTURED_ASSETS":"Structured asset securities.","TRUST_CERTIFICATE":"A trust certificate.","PARTICIPATION_UNIT":"A participation unit.","SAVINGS_BOND":"A savings bond.","PASS_THRU_CERTIFICATES":"Pass-through certificates.","UNKNOWN":"The debt type is unknown.","STRIP":"A stripped security (interest and principal separated).","ANNUITY":"An annuity.","BILL":"A bill (short-term debt instrument).","CERTIFICATE":"A certificate.","DEPOSIT_NOTE":"A deposit note.","EQUIPMENT_TRUST_CERTIFICATE":"An equipment trust certificate.","FNMA_BENCHMARK_ISSUES":"A Fannie Mae (FNMA) benchmark issue.","MORTGAGE/UK_DEBENTURE":"A mortgage or UK debenture.","SCHATZANWEISUNGEN":"A German government short-term treasury note (Schatzanweisungen).","DISCOUNT_NOTE":"A discount note.","PERMANENT_INTEREST_BEARING_SECURITY":"A UK permanent interest-bearing security (PIBS).","OTHER_MONEY_MARKETS":"Another money market instrument.","LOAN_NOTE":"A loan note.","MERCHANT_MARINE":"A merchant marine bond.","MORTGAGE_NOTE":"A mortgage note.","COLLATERALIZED_DEBT_OBLIGATION_(CDO)":"A collateralized debt obligation (CDO).","PRIVATE_PLACEMENT":"A privately placed debt instrument.","EXCHANGE_TRADED_NOTE":"An exchange-traded note (ETN).","PREMIUM_BOND":"A premium bond.","SECURITY":"A security.","UNIT":"A unit.","SAVINGS_NOTES":"Savings notes.","PARTICIPATION_CERTIFICATES":"Participation certificates.","DISCOUNT_DEBENTURE":"A discount debenture.","DEBENTURE_-_UNSECURED":"An unsecured debenture.","EXCHANGE_TRADED_COMMODITY":"An exchange-traded commodity (ETC).","ASSET-BACKED_COMMERCIAL_PAPER":"Asset-backed commercial paper.","SUKUK":"An Islamic bond (Sukuk).","DEBENTURE_-_SECURED":"A secured debenture.","LETTER_OF_CREDIT":"A letter of credit.","GLOBAL_DEPOSITORY_NOTE":"A global depository note."}},"sector":{"type":"string","example":"FINANCE_AND_INSURANCE","description":"The categorization of the sector pertaining to the Instrument.","enum":["AGRICULTURE_FORESTRY_FISHING_AND_HUNTING","MINING_QUARRYING_AND_OIL_AND_GAS_EXTRACTION","UTILITIES","CONSTRUCTION","MANUFACTURING","WHOLESALE_TRADE","RETAIL_TRADE","TRANSPORTATION_AND_WAREHOUSING","INFORMATION","FINANCE_AND_INSURANCE","REAL_ESTATE_AND_RENTAL_AND_LEASING","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES","ADMINISTRATIVE_AND_SUPPORT_AND_WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES","EDUCATIONAL_SERVICES","HEALTH_CARE_AND_SOCIAL_ASSISTANCE","ARTS_ENTERTAINMENT_AND_RECREATION","ACCOMMODATION_AND_FOOD_SERVICES","OTHER_SERVICES_EXCEPT_PUBLIC_ADMINISTRATION","PUBLIC_ADMINISTRATION"],"x-enumDescriptions":{"AGRICULTURE_FORESTRY_FISHING_AND_HUNTING":"Agriculture, forestry, fishing, and hunting.","MINING_QUARRYING_AND_OIL_AND_GAS_EXTRACTION":"Mining, quarrying, and oil and gas extraction.","UTILITIES":"Utilities.","CONSTRUCTION":"Construction.","MANUFACTURING":"Manufacturing.","WHOLESALE_TRADE":"Wholesale trade.","RETAIL_TRADE":"Retail trade.","TRANSPORTATION_AND_WAREHOUSING":"Transportation and warehousing.","INFORMATION":"Information.","FINANCE_AND_INSURANCE":"Finance and insurance.","REAL_ESTATE_AND_RENTAL_AND_LEASING":"Real estate and rental and leasing.","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES":"Professional, scientific, and technical services.","MANAGEMENT_OF_COMPANIES_AND_ENTERPRISES":"Management of companies and enterprises.","ADMINISTRATIVE_AND_SUPPORT_AND_WASTE_MANAGEMENT_AND_REMEDIATION_SERVICES":"Administrative and support and waste management and remediation services.","EDUCATIONAL_SERVICES":"Educational services.","HEALTH_CARE_AND_SOCIAL_ASSISTANCE":"Health care and social assistance.","ARTS_ENTERTAINMENT_AND_RECREATION":"Arts, entertainment, and recreation.","ACCOMMODATION_AND_FOOD_SERVICES":"Accommodation and food services.","OTHER_SERVICES_EXCEPT_PUBLIC_ADMINISTRATION":"Other services (except public administration).","PUBLIC_ADMINISTRATION":"Public administration."}},"duration":{"description":"The duration of the bond.","type":"number","format":"double","example":"10.5","readOnly":true,"nullable":true},"nextCallDate":{"description":"The next call date of the bond.","type":"string","format":"date","example":"2018-05-10","readOnly":true,"nullable":true},"debtRankType":{"description":"The debt rank type of the bond.","type":"string","example":"SENIOR","readOnly":true,"enum":["UNKNOWN","SECOND_MORTGAGE","FIRST_MORTGAGE ","JUNIOR","MEZZANINE","SENIOR_SUBORDINATED","SUBORDINATED","THIRD_MORTGAGE","UNSUBORDINATED","JUNIOR_SUBORDINATED","SENIOR","NOT_APPLICABLE","TIER_I","LOWER_TIER_II","UPPER_TIER_II","TIER_III","SENIOR_SECURED","ALTERNATIVE_ADDITIONAL_TIER_I","SENIOR_NON_PREFERRED"],"x-enumDescriptions":{"UNKNOWN":"The debt rank is unknown.","SECOND_MORTGAGE":"Second mortgage lien.","FIRST_MORTGAGE ":"First mortgage lien.","JUNIOR":"Junior (subordinated) rank.","MEZZANINE":"Mezzanine rank, between senior debt and equity.","SENIOR_SUBORDINATED":"Senior subordinated rank.","SUBORDINATED":"Subordinated rank.","THIRD_MORTGAGE":"Third mortgage lien.","UNSUBORDINATED":"Unsubordinated (senior) rank.","JUNIOR_SUBORDINATED":"Junior subordinated rank.","SENIOR":"Senior rank.","NOT_APPLICABLE":"Not applicable.","TIER_I":"Tier I capital rank.","LOWER_TIER_II":"Lower Tier II capital rank.","UPPER_TIER_II":"Upper Tier II capital rank.","TIER_III":"Tier III capital rank.","SENIOR_SECURED":"Senior secured rank.","ALTERNATIVE_ADDITIONAL_TIER_I":"Alternative Additional Tier I capital rank.","SENIOR_NON_PREFERRED":"Senior non-preferred rank."}},"spRatingType":{"type":"string","example":"INVESTMENT_GRADE","description":"The spRating type of the bond.","enum":["INVESTMENT_GRADE","HIGH_YIELD"],"x-enumDescriptions":{"INVESTMENT_GRADE":"Investment-grade credit rating.","HIGH_YIELD":"High-yield (below investment-grade) credit rating."}},"coupon":{"$ref":"#/components/schemas/Coupon"},"issuer":{"$ref":"#/components/schemas/Issuer"},"indicators":{"$ref":"#/components/schemas/Indicators"},"denominationAmounts":{"$ref":"#/components/schemas/DenominationAmounts"}}},"Coupon":{"description":"A coupon or coupon payment is the annual interest rate paid on a bond, expressed as a percentage of the face value and paid from issue date until maturity.","type":"object","properties":{"couponType":{"description":"The method by which the coupon rate of the instrument is determined.","type":"string","enum":["UNKNOWN","SHORT_TERM_DISCOUNT","FIXED_RATE_-_UNCONFIRMED","ADJUSTABLE_RATE","ZERO_COUPON","FLOATING_RATE","INDEX_LINKED","STEPPED_COUPON","FIXED_RATE","STRIPPED_CONVERTIBLE","DEFERRED_INTEREST","FLOATING_RATE_@_FLOOR","STRIPPED_TAX_CREDIT","INVERSE_FLOATING","STRIPPED_COUPON_PRINCIPAL","LINKED_INVERSE_FLOATER","FLEXIBLE_RATE","ORIGINAL_ISSUE_DISCOUNT","STRIPPED_PRINCIPAL","RESERVE_CUSIP","VARIABLE_RATE","STRIPPED_COUPON","FLOATING_AUCTION_RATE","TAX_CREDIT","TAX_CREDIT_OID","STRIPPED_COUPON_PAYMENT","STEPPED_UP_STEPPED_DOWN","CREDIT_SENSITIVE","PAY_IN_KIND","RANGE","DIGITAL","RESET"],"example":"FIXED_RATE","readOnly":true,"x-enumDescriptions":{"UNKNOWN":"The coupon type is unknown.","SHORT_TERM_DISCOUNT":"A short-term discount instrument with no stated coupon.","FIXED_RATE_-_UNCONFIRMED":"A fixed-rate coupon, unconfirmed.","ADJUSTABLE_RATE":"An adjustable-rate coupon.","ZERO_COUPON":"No periodic coupon; the instrument is issued at a discount.","FLOATING_RATE":"A floating-rate coupon, tied to a reference rate.","INDEX_LINKED":"A coupon linked to an index.","STEPPED_COUPON":"A coupon rate that steps up or down over time.","FIXED_RATE":"A fixed-rate coupon.","STRIPPED_CONVERTIBLE":"A stripped convertible instrument.","DEFERRED_INTEREST":"Interest that is deferred rather than paid currently.","FLOATING_RATE_@_FLOOR":"A floating-rate coupon with a minimum (floor) rate.","STRIPPED_TAX_CREDIT":"A stripped tax-credit component.","INVERSE_FLOATING":"An inverse floating-rate coupon, moving opposite the reference rate.","STRIPPED_COUPON_PRINCIPAL":"The principal component of a stripped instrument.","LINKED_INVERSE_FLOATER":"An inverse floating-rate coupon linked to a reference rate.","FLEXIBLE_RATE":"A flexible-rate coupon.","ORIGINAL_ISSUE_DISCOUNT":"An original issue discount (OID) instrument.","STRIPPED_PRINCIPAL":"The principal-only component of a stripped instrument.","RESERVE_CUSIP":"A reserve CUSIP, not a standard coupon type.","VARIABLE_RATE":"A variable-rate coupon.","STRIPPED_COUPON":"The coupon (interest-only) component of a stripped instrument.","FLOATING_AUCTION_RATE":"A floating rate set by periodic auction.","TAX_CREDIT":"A tax-credit bond coupon.","TAX_CREDIT_OID":"A tax-credit bond issued at an original issue discount.","STRIPPED_COUPON_PAYMENT":"A single stripped coupon payment.","STEPPED_UP_STEPPED_DOWN":"A coupon that steps up and down over the life of the instrument.","CREDIT_SENSITIVE":"A coupon rate sensitive to the issuer's credit rating.","PAY_IN_KIND":"Interest paid in additional securities rather than cash (PIK).","RANGE":"A coupon that accrues only while a reference rate stays within a set range.","DIGITAL":"A digital (binary) coupon structure.","RESET":"A coupon rate that resets periodically."}},"currentRateDate":{"description":"The annual rate of interest currently applicable to the instrument.","type":"string","format":"date","minLength":0,"maxLength":10,"example":"2018-05-10","readOnly":true},"dayCount":{"description":"The method of calculating interest accrual associated with the instrument.","type":"string","enum":["UNKNOWN_INTEREST_CALCULATION_METHOD","ACTUAL/ACTUAL","ACTUAL/360","30/360","30_DAYS_PER_MONTH_/_ACTUAL","ACTUAL/365_(FIXED)","CHANGEABLE","ACTUAL/365_(366_LEAP_YEAR_-_ISDA)","30/360_(COMPOUNDED_INTEREST)","30/365","FUTURE_DATA_-_NOT_AVAILABLE","HISTORICAL_DATA_-_NOT_AVAILABLE","30/360_(ICMA)","ACTUAL/365_(366_LEAP_YEAR)","ACTUAL/364","BUS/252","365/365","ACTUAL/ACTUAL_(ICMA)","28/360","30/360_US","30/360_US_(NASD)","30/360_BMA","30/360_(ISDA)","30/360_IT","30/360_SIA","30E/360","30E/360_(ISDA)","30E+/360","NL/365_(NO_LEAP_YEAR)","7/360","30/360_WITH_GROSS_UP","NOT_APPLICABLE"],"example":"30/360","readOnly":true,"x-enumDescriptions":{"UNKNOWN_INTEREST_CALCULATION_METHOD":"The interest calculation method is unknown.","ACTUAL/ACTUAL":"Actual/Actual day-count convention.","ACTUAL/360":"Actual/360 day-count convention.","30/360":"30/360 day-count convention.","30_DAYS_PER_MONTH_/_ACTUAL":"30 days per month over actual days elapsed.","ACTUAL/365_(FIXED)":"Actual/365 (Fixed) day-count convention.","CHANGEABLE":"The day-count convention can change over the life of the instrument.","ACTUAL/365_(366_LEAP_YEAR_-_ISDA)":"Actual/365, with 366 in a leap year, per ISDA convention.","30/360_(COMPOUNDED_INTEREST)":"30/360 day-count convention with compounded interest.","30/365":"30/365 day-count convention.","FUTURE_DATA_-_NOT_AVAILABLE":"Not yet available; a future data point.","HISTORICAL_DATA_-_NOT_AVAILABLE":"Not available for this historical period.","30/360_(ICMA)":"30/360 day-count convention per ICMA rules.","ACTUAL/365_(366_LEAP_YEAR)":"Actual/365, with 366 in a leap year.","ACTUAL/364":"Actual/364 day-count convention.","BUS/252":"Business days/252 day-count convention.","365/365":"365/365 day-count convention.","ACTUAL/ACTUAL_(ICMA)":"Actual/Actual day-count convention per ICMA rules.","28/360":"28/360 day-count convention.","30/360_US":"30/360 day-count convention, U.S. variant.","30/360_US_(NASD)":"30/360 day-count convention per NASD rules.","30/360_BMA":"30/360 day-count convention per Bond Market Association (BMA) rules.","30/360_(ISDA)":"30/360 day-count convention per ISDA rules.","30/360_IT":"30/360 day-count convention, Italian variant.","30/360_SIA":"30/360 day-count convention per Securities Industry Association (SIA) rules.","30E/360":"30E/360 (European) day-count convention.","30E/360_(ISDA)":"30E/360 (European) day-count convention per ISDA rules.","30E+/360":"30E+/360 day-count convention.","NL/365_(NO_LEAP_YEAR)":"Actual/365 excluding leap-year days (No Leap).","7/360":"7/360 day-count convention.","30/360_WITH_GROSS_UP":"30/360 day-count convention with gross-up adjustment.","NOT_APPLICABLE":"Not applicable."}},"benchmark":{"description":"The identifier the index against which the interest rate for an Index Linked Bond is reset.","type":"string","example":"US CPI","readOnly":true},"benchmarkFormula":{"description":"The multiple in the floating rate formula that is applied to the benchmark in order to calculate the reset rate on a floating rate instrument.","type":"string","example":"1.5","readOnly":true},"nextResetDate":{"description":"The date of the next interest rate reset of the instrument","type":"string","format":"date","example":"2018-05-10","readOnly":true},"minimumRate":{"description":"The minimum interest rate that an instrument will pay.","type":"number","format":"double","example":0.05,"readOnly":true},"maximumRate":{"description":"The maximum interest rate that an instrument will pay.","type":"number","format":"double","example":0.05,"readOnly":true},"firstCouponDate":{"description":"The date on which the first payment of interest is made.","type":"string","format":"date","example":"2018-05-10","readOnly":true},"nextCouponDate":{"description":"The next date on which a payment of interest will be made.","type":"string","format":"date","example":"2018-05-10","readOnly":true},"finalCouponDate":{"description":"The date on which the final interest payment is scheduled to be made to owners of the security.","type":"string","format":"date","example":"2018-05-10","readOnly":true}}},"Issuer":{"description":"The entity name (in the XML/Web Service) or organization_id (in the Database) of the insurer who has been contracted to provide payments to bondholders in the event of a default by the issuer. In the Database, the entity name can be looked up by using the organization_id in conjunction with the Organization_Master.primary_name field'","type":"object","properties":{"primaryName":{"description":"A field containing the root symbol assigned by an exchange to the derivative product.","type":"string","example":"Coca Cola Corp","readOnly":true},"country":{"$ref":"#/components/schemas/country"},"domicileCountry":{"$ref":"#/components/schemas/country"}}},"Indicators":{"description":"Indicators that provide additional information about the security","example":{"callIndicator":false,"convertibleIndicator":false,"defaultIndicator":false,"dtcIndicator":true,"oidIndicator":false,"putIndicator":false,"sinkIndicator":false,"tipsIndicator":false,"floaterIndicator":false,"traceEligible":true,"capitalizedIndicator":false,"childIndicator":false,"defeasanceIndicator":false,"equityLinkedNoteIndicator":false,"pikIndicator":false,"tenderExchangeOfferIndicator":false,"warrantsIndicator":false,"tradingRestrictionsType":"None"},"properties":{"callIndicator":{"description":"Indicates if the security is eligible to be redeemed by the issuer on a call basis","readOnly":true,"type":"boolean"},"convertibleIndicator":{"description":"Specifies whether an issue is convertible or exchangeable","readOnly":true,"type":"boolean"},"defaultIndicator":{"description":"Specifies whether the security is in default or not","readOnly":true,"type":"boolean"},"dtcIndicator":{"description":"Indicates whether the security is acceptable for clearing by the DTCC.","readOnly":true,"type":"boolean"},"oidIndicator":{"description":"Specifies whether or not this issue qualifies for Original Issue Discount status","readOnly":true,"type":"boolean"},"putIndicator":{"description":"Indicates whether the security carries provisions that allow for redemption at the request of owners of the security","readOnly":true,"type":"boolean"},"sinkIndicator":{"description":"Indicates whether the security carries a sinking fund as part of its terms and conditions","readOnly":true,"type":"boolean"},"tipsIndicator":{"description":"Indicates whether the security is a Treasury Inflation Protected Security","readOnly":true,"type":"boolean"},"traceEligible":{"description":"Indicates whether the security is considered TRACE eligible for price reporting","readOnly":true,"type":"boolean"},"capitalizedIndicator":{"description":"Specifies whether a bond issuer has set aside some of the proceeds from a bond sale to cover a certain number of interest payments","readOnly":true,"type":"boolean"},"childIndicator":{"description":"Indicates whether the security is created as the result of a corporate action or other event (the child instrument) from a previously issued instrument (the parent)","readOnly":true,"type":"boolean"},"defeasanceIndicator":{"description":"Indicates whether the security contains a provision that voids a bond or loan when the borrower sets aside cash or bonds sufficient enough to service the borrower's debt (a process called defeasance)","readOnly":true,"type":"boolean"},"equityLinkedNoteIndicator":{"description":"Indicates whether the security is an Equity Linked Note","readOnly":true,"type":"boolean"},"pikIndicator":{"description":"Indicates whether the security carries provisions to make Payment In Kind (PIK) to owners of the security","readOnly":true,"type":"boolean"},"tenderExchangeOfferIndicator":{"description":"Indicates whether the security has an associated exchange or tender offer","readOnly":true,"type":"boolean"},"warrantsIndicator":{"description":"Indicates whether there is a warrant associated with the particular security","readOnly":true,"type":"boolean"},"floaterIndicator":{"description":"Indicates whether the security has a floating or adjustable rate issue","readOnly":true,"type":"boolean"},"tradingRestrictionsType":{"description":"Indicates whether any trading restrictions are in effect for the security","enum":["None","144A","REG_S","PRIVATE_PLACEMENT","ACCREDITED_INVESTORS","REG_D","SEC_ACT_OF_1933"],"readOnly":true,"type":"string","x-enumDescriptions":{"None":"No trading restrictions.","144A":"Restricted to qualified institutional buyers under SEC Rule 144A.","REG_S":"Offered only outside the U.S. under SEC Regulation S.","PRIVATE_PLACEMENT":"Sold via private placement, not a public offering.","ACCREDITED_INVESTORS":"Restricted to accredited investors.","REG_D":"Offered under SEC Regulation D.","SEC_ACT_OF_1933":"Subject to registration requirements of the Securities Act of 1933."}}}},"DenominationAmounts":{"description":"A set of amounts that represent denomination amounts for the security","properties":{"incrementAmount":{"description":"The increment amount for the security.","readOnly":true,"type":"number","format":"double"},"incrementAmountSecondary":{"description":"The secondary increment amount for the security.","readOnly":true,"type":"number","format":"double"},"minimumAmount":{"description":" The minimum denomination amount for the security.","readOnly":true,"type":"number","format":"double"}}},"domicileCountry":{"$ref":"#/components/schemas/country"},"FilterCriterion":{"type":"object","required":["field","operator","value1"],"properties":{"field":{"description":"The name of the field to be filtered on.","type":"string","example":"spRating","enum":["id","ISIN","CUSIP","CINS","payFrequency","payFrequencyDescription","couponRate","maturityDate","spRating","assetClassCode","assetClassDescription","accrualDate","bidPrice","askPrice","meanPrice","askYieldToMaturity","bidYieldToMaturity","status","statusDescription","issuer.primaryName","issuer.country","issuer.domicileCountry","features.minimumInvestmentAmount","features.incrementalInvestmentAmount","coupon.dayCountDescription","coupon.couponTypeDescription","details.nextCouponDate","statusCode","longOnly","coupon.dayCount","coupon.couponType","coupon.nextCouponDate","sector","price","minimumAmount","orderBook.liquidityRetail","orderBook.liquidityInstitutional","orderBook.liquidityMicro","orderBook.onlyLiveQuotes","orderBook.price","orderBook.yieldToWorst","details.debtTypeDescription","denominationAmounts.incrementAmount","indicators.tradingRestrictionsType"],"x-enumDescriptions":{"id":"The instrument's unique identifier.","ISIN":"The instrument's ISIN.","CUSIP":"The instrument's CUSIP.","CINS":"The instrument's CINS (CUSIP International Numbering System) identifier.","payFrequency":"The coupon payment frequency code.","payFrequencyDescription":"The coupon payment frequency, described.","couponRate":"The coupon rate.","maturityDate":"The maturity date.","spRating":"The S&P credit rating.","assetClassCode":"The asset class code.","assetClassDescription":"The asset class, described.","accrualDate":"The interest accrual start date.","bidPrice":"The bid price.","askPrice":"The ask price.","meanPrice":"The mean of the bid and ask price.","askYieldToMaturity":"The yield to maturity at the ask price.","bidYieldToMaturity":"The yield to maturity at the bid price.","status":"The instrument's status code.","statusDescription":"The instrument's status, described.","issuer.primaryName":"The issuer's primary name.","issuer.country":"The issuer's country.","issuer.domicileCountry":"The issuer's country of domicile.","features.minimumInvestmentAmount":"The minimum investment amount.","features.incrementalInvestmentAmount":"The minimum incremental investment amount.","coupon.dayCountDescription":"The coupon day-count convention, described.","coupon.couponTypeDescription":"The coupon type, described.","details.nextCouponDate":"The next scheduled coupon payment date.","statusCode":"The instrument's status code.","longOnly":"Whether the instrument is restricted to long-only positions.","coupon.dayCount":"The coupon day-count convention code.","coupon.couponType":"The coupon type code.","coupon.nextCouponDate":"The next scheduled coupon payment date.","sector":"The instrument's sector.","price":"The instrument's price.","minimumAmount":"The minimum order amount.","orderBook.liquidityRetail":"Retail order book liquidity.","orderBook.liquidityInstitutional":"Institutional order book liquidity.","orderBook.liquidityMicro":"Micro-lot order book liquidity.","orderBook.onlyLiveQuotes":"Whether only live quotes are included in the order book.","orderBook.price":"The order book price.","orderBook.yieldToWorst":"The yield to worst from the order book.","details.debtTypeDescription":"The debt instrument type, described.","denominationAmounts.incrementAmount":"The minimum denomination increment amount.","indicators.tradingRestrictionsType":"The trading restrictions in effect for the instrument."}},"operator":{"description":"Filters, operator`= equal to``!= not equal to``< less than``<= less than or equal to``> greater than``>= greater than or equal to``>< in between``() contains`","type":"string","enum":["=","!=","<","<=",">=",">","><","()"],"x-enumDescriptions":{"=":"Equal to.","!=":"Not equal to.","<":"Less than.","<=":"Less than or equal to.",">=":"Greater than or equal to.",">":"Greater than.","><":"In between.","()":"Contains."}},"value1":{"description":"The value of the field that should be filtered","type":"string","example":"AA"},"value2":{"description":"The value of the field that should be filtered. Should be provided when filtering ranges (between \"><\")","type":"string","example":"A"}}},"FilterCriteria":{"description":"The filter criteria, Criterion with different field names are ANDed. Criterion with same field names are ORed.","type":"array","items":{"$ref":"#/components/schemas/FilterCriterion"}},"indexMembers":{"type":"string","description":"The index members of the instrument.","example":"S&P 500","enum":["TR Equity United States Index","S&P 600 Small Cap","S&P 500","S&P 400 Mid Cap","NASDAQ 100 Index","Dow Transportation","Toronto SE 300 Composite Index","Dow Industry","TR Equity Israel Index","Safrica-JSE-FTSE-AllShare-Index","Shanghai SE Composite Index","Dow Utility","SX All Share PI Market Index","OSL All-share Index","CAC 40 Index","DAX Index","Swiss Market Index","FTSE 100 Index","FTSE All Share Index","Denmark-OMX-Copenhagen-All-Share-Index","ASE Main General Index"]},"FundFrequency":{"type":"string","description":"The frequency at which a fund operation occurs.","enum":["DAILY","WEEKLY","FORTNIGHTLY","MONTHLY","QUARTERLY","SEMI_ANNUALLY","ANNUALLY"],"example":"DAILY","x-enumDescriptions":{"DAILY":"The fund operation occurs daily.","WEEKLY":"The fund operation occurs weekly.","FORTNIGHTLY":"The fund operation occurs every two weeks.","MONTHLY":"The fund operation occurs monthly.","QUARTERLY":"The fund operation occurs quarterly.","SEMI_ANNUALLY":"The fund operation occurs twice a year.","ANNUALLY":"The fund operation occurs once a year."}},"ErrorResponse":{"type":"object","description":"Standard error response returned on 4xx and 5xx errors.","properties":{"errorCode":{"type":"string","description":"Machine-readable error code.","example":"E032"},"message":{"type":"string","description":"Human-readable description of the error.","example":"Invalid or missing parameters in the request body. Refer to the API documentation for details."},"errorDetails":{"type":"object","nullable":true,"description":"Additional details about the error, including the specific field and detail.","properties":{"detail":{"type":"string","description":"Additional detail about the error.","example":"DECIMAL"},"field":{"type":"string","description":"The specific request field that caused the error.","example":"adjustedPrice"}}}}},"UpdateCancelCorrectionRequest":{"type":"object","description":"Details of the adjustments made to the transaction, including price, quantity, commission, and fees.\n","required":["cancelRebillList"],"properties":{"cancelRebillList":{"type":"array","description":"Array of cancel correction update records. Supports multiple records for bulk status updates. Must contain exactly one record when any adjustment field is provided.\n","items":{"$ref":"#/components/schemas/UpdateCancelCorrectionItem"},"minItems":1,"example":[{"id":"abc-001","status":"APPROVED","comment":"Reviewed and approved.","outrightCancel":false}]}}},"UpdateCancelCorrectionListResponse":{"type":"object","description":"Response object containing the list of updated cancel correction records.","properties":{"data":{"type":"array","description":"Array of updated cancel correction records. Returns one record for each ID in the request.","items":{"$ref":"#/components/schemas/UpdateCancelCorrectionResponse"}}}},"CancelCorrectDetail":{"type":"object","description":"Full details of a cancel-correct record as returned by `GET /cancel-rebills` and `GET /cancel-rebills/{cancelRebillID}`. Each record maps to at most one order, one execution, or one transaction, reflecting the segregated single-record-per-request create endpoints.\n","properties":{"id":{"type":"string","description":"The unique identifier of the cancel-correct record.","example":"cxl_rbl_123e4567-e89b-12d3-a456-000000000039"},"orderNo":{"type":"string","nullable":true,"description":"The DriveWealth order number associated with this cancel-correct record. Present when the record was submitted via `POST /cancel-correct/order`, or belongs to the order the executions were submitted against via `POST /cancel-correct/executions`.\n","example":"CCC000028"},"executionId":{"type":"string","nullable":true,"description":"The execution ID associated with this cancel-correct record. Present when the record was submitted via `POST /cancel-correct/executions`.\n","example":"exec.111"},"transactionId":{"type":"string","nullable":true,"description":"The transaction ID associated with this cancel-correct record. Present when the record was submitted via `POST /cancel-correct/transaction`.\n","example":"txn.aaa"},"type":{"$ref":"#/components/schemas/NameDescription"},"reason":{"$ref":"#/components/schemas/NameDescription"},"status":{"$ref":"#/components/schemas/NameDescription"},"approvedBy":{"type":"string","nullable":true,"description":"The userID or name of the user who approved this cancel-correct record.","example":"John Doe"},"comment":{"type":"string","nullable":true,"description":"The comment provided at the time of submission.","example":"reported NSF"},"adjustmentDetails":{"$ref":"#/components/schemas/AdjustmentDetails"}}},"CancelRebillListResponse":{"type":"object","title":"CancelRebillListResponse","description":"Paginated list of cancel-correct records returned by `GET /cancel-rebills`.\n","properties":{"data":{"type":"array","description":"The page of cancel-correct records matching the query.","items":{"$ref":"#/components/schemas/CancelCorrectDetail"}},"responseMetadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"ResponseMetadata":{"type":"object","title":"ResponseMetadata","properties":{"lastKey":{"type":"string","example":"123e4567-e89b-12d3-a456-00000000003a#cxl_rbl_123e4567-e89b-12d3-a456-00000000003c"},"count":{"type":"integer","example":1}}},"GetErrorResponse":{"type":"object","description":"Standard error response returned on 4xx and 5xx errors.","properties":{"errorCode":{"type":"string","description":"Machine-readable error code.","example":"E001"},"message":{"type":"string","description":"Human-readable description of the error.","example":"No cancel correction found for the provided ID."},"errorDetails":{"type":"object","nullable":true,"description":"Additional details about the error.","properties":{"detail":{"type":"string","description":"Additional detail about the error.","example":"NOT_FOUND"},"field":{"type":"string","description":"The specific field that caused the error.","example":"cancelRebillID"}}}}},"AdjustmentDetails":{"type":"object","description":"Details of the adjustments made to the transaction, including price, quantity, commission, and fees.\n","properties":{"adjustedPrice":{"type":"number","description":"The updated price applied to the corrected transaction.","example":152.5},"adjustedQuantity":{"type":"number","description":"The updated quantity applied to the corrected transaction.","example":50},"adjustedCommission":{"type":"number","description":"The updated commission applied to the corrected transaction.","example":1.25},"adjustedFees":{"type":"array","description":"One or more updated fees to apply to the corrected transaction.\n","items":{"$ref":"#/components/schemas/Fee"},"minItems":1,"example":[{"feeType":"COMMISSION","feeAmount":"1.25","feeCurrency":"USD","transactionTypeId":"fee.001"}]}}},"UpdateCancelCorrectionItem":{"type":"object","description":"A single cancel correction update record. When any adjustment field (`adjustedPrice`, `adjustedCommission`, `adjustedAmount`, `adjustedFee`) is provided, this must be the only item in the request array.\n","required":["id","status"],"properties":{"partnerID":{"type":"string","format":"uuid","description":"The unique identifier of the partner associated with this record. Optional — to be confirmed as required by development.\n","example":"123e4567-e89b-12d3-a456-000000000005","x-required-tbd":true},"id":{"type":"string","description":"The unique identifier of the cancel correction record to update.","example":"abc-001"},"status":{"type":"string","enum":["STARTED","APPROVED","ON_HOLD","REJECTED","PENDING","SUCCESSFUL"],"description":"The updated status to apply to the cancel correction record.","example":"APPROVED","x-enumDescriptions":{"STARTED":"The cancel/rebill request was started.","PENDING":"The cancel/rebill request is pending.","ON_HOLD":"The cancel/rebill request is on hold.","APPROVED":"The cancel/rebill request was approved.","REJECTED":"The cancel/rebill request was rejected.","SUCCESSFUL":"The cancel/rebill request completed successfully."}},"comment":{"type":"string","minLength":1,"maxLength":100,"description":"A comment describing the reason for the status update.","example":"Reviewed and approved."},"outrightCancel":{"type":"boolean","description":"Flag indicating whether this is an outright cancel. When `true`, the full transaction is cancelled without adjustment. Defaults to `false`.\n","default":false,"example":false},"errorAccount":{"type":"string","description":"Overrides the default error account for this transaction. **Restricted field** — only accepted when submitted by a `drivewealth_ops` user persona. Requests from any other persona that include this field will be rejected with a 403 error.\n","example":"acct.error.xyz123","x-persona-restriction":"drivewealth_ops"},"adjustmentDetails":{"type":"object","description":"Details of the adjustments to apply to the transaction, including price, quantity, commission, amount, and fees. **Single-record only** — cannot be combined with multiple IDs in the request array.\n","properties":{"adjustedPrice":{"type":"number","description":"The updated price to set from the original transaction.","example":150.25},"adjustedCommission":{"type":"number","description":"The updated commission to set from the original transaction.","example":1.5},"adjustedAmount":{"type":"number","description":"The updated total amount to set from the original transaction.","example":200},"adjustedFees":{"type":"array","description":"One or more updated fees to set against the original transaction, using the same Fee structure as the create cancel rebill API.\n","items":{"$ref":"#/components/schemas/Fee"},"minItems":1,"example":[{"feeType":"COMMISSION","feeAmount":"1.25","feeCurrency":"USD","transactionTypeId":"fee.001"},{"feeType":"REGULATORY","feeAmount":"0.05","feeCurrency":"USD","transactionTypeId":null}]}}}}},"UpdateCancelCorrectionResponse":{"type":"object","description":"Confirmation object returned after a cancel correction is updated.","properties":{"partnerID":{"$ref":"#/components/schemas/PartnerSummary"},"id":{"type":"string","description":"The unique identifier of the updated cancel correction record.","example":"abc-001"},"status":{"$ref":"#/components/schemas/NameDescription"},"comment":{"type":"string","description":"The comment associated with the updated record.","example":"Price corrected after venue adjustment."}}},"NameDescription":{"type":"object","description":"A code/enum value paired with a human-readable description.","properties":{"name":{"type":"string","description":"The machine-readable enum value.","example":"PRICE_ADJUSTMENT"},"description":{"type":"string","description":"A human-readable label for the value.","example":"Price Adjustment"}}},"Fee":{"type":"object","description":"Fee record containing fee type, amount, currency, and identifier information.","required":["type","amount"],"properties":{"type":{"type":"string","description":"Type of fee (e.g., COMMISSION, REGULATORY, etc.).","example":"COMMISSION"},"amount":{"type":"number","description":"Amount of the fee, represented as a decimal string to preserve precision.\n","example":"1.25"},"currency":{"$ref":"#/components/schemas/CurrencyCode"},"transactionTypeId":{"type":"string","nullable":true,"default":null,"description":"Optional identifier for the fee.","example":"fee.001"}}},"PartnerSummary":{"type":"object","description":"Summary of the partner associated with the updated record.","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the partner.","example":"123e4567-e89b-12d3-a456-000000000005"},"name":{"type":"string","description":"The display name of the partner.","example":"Tendies Trading Company"}}},"CurrencyCode":{"type":"string","description":"ISO 4217 currency code.","default":"USD","example":"USD"},"CancelCorrectDetails":{"type":"object","description":"Shared cancellation/correction details common to the order, executions, and transaction cancel-correct requests.\n","required":["type","reason","initiatedBy","comment"],"properties":{"type":{"type":"string","enum":["CANCEL","CORRECT","PRICE_ADJUSTMENT","COMMISSION_ADJUSTMENT"],"description":"The type of cancel-correct action to apply. `CANCEL` voids the entity outright; `CORRECT` amends it in place; `PRICE_ADJUSTMENT` and `COMMISSION_ADJUSTMENT` amend price/quantity or commission via `adjustmentDetails`.\n","example":"CANCEL","x-enumDescriptions":{"CANCEL":"The entity is voided outright.","CORRECT":"The entity is amended in place.","PRICE_ADJUSTMENT":"The price of the entity is being adjusted.","COMMISSION_ADJUSTMENT":"The commission of the entity is being adjusted."}},"reason":{"type":"string","enum":["FRAUD","PRICE_ADJUSTMENT_PARTNER","PRICE_ADJUSTMENT_VENUE","DRIVEWEALTH_TECHNICAL_ERROR","PARTNER_TECHNICAL_ERROR","VENDOR_ERROR"],"description":"The reason for the cancel-correct request.","example":"PARTNER_TECHNICAL_ERROR","x-enumDescriptions":{"FRAUD":"The original transaction was fraudulent.","PRICE_ADJUSTMENT_PARTNER":"A price adjustment requested by the partner.","PRICE_ADJUSTMENT_VENUE":"A price adjustment initiated by the execution venue.","DRIVEWEALTH_TECHNICAL_ERROR":"A DriveWealth technical error.","PARTNER_TECHNICAL_ERROR":"A partner technical error.","VENDOR_ERROR":"A vendor error."}},"initiatedBy":{"type":"string","description":"The userId or system that initiated the cancel-correct request.","example":"John Doe"},"comment":{"type":"string","minLength":1,"maxLength":100,"description":"A comment describing the reason for the cancel-correct request.","example":"Order submitted in error."},"errorAccount":{"type":"string","description":"Overrides the default error account for this transaction. **Restricted field** — only accepted when submitted by a `drivewealth_ops` user persona. Requests from any other persona that include this field will be rejected with a 403 error.\n","example":"acct.error.xyz123","x-persona-restriction":"drivewealth_ops"},"adjustmentDetails":{"$ref":"#/components/schemas/AdjustmentDetails"}}},"CancelCorrectOrderRequest":{"description":"Request body for cancelling or correcting a single order.\n","allOf":[{"type":"object","required":["orderId"],"properties":{"orderId":{"type":"string","description":"The DriveWealth order identifier to cancel or correct.","example":"ORD-001"}}},{"$ref":"#/components/schemas/CancelCorrectDetails"}]},"CancelCorrectExecutionItem":{"description":"A single execution cancel-correct entry.\n","allOf":[{"type":"object","required":["executionId"],"properties":{"executionId":{"type":"string","description":"The execution identifier to cancel or correct.","example":"EXEC-001"}}},{"$ref":"#/components/schemas/CancelCorrectDetails"}]},"CancelCorrectExecutionsRequest":{"type":"object","description":"Request body for cancelling or correcting one or more executions belonging to a single order.\n","required":["OrderNo","executions"],"properties":{"OrderNo":{"type":"string","description":"The DriveWealth order identifier that the executions belong to.","example":"ORD-001"},"executions":{"type":"array","description":"One or more executions to cancel or correct. Each entry is processed independently and may carry its own type, reason, initiatedBy, and comment.\n","items":{"$ref":"#/components/schemas/CancelCorrectExecutionItem"},"minItems":1,"example":[{"executionId":"EXEC-001","type":"CANCEL","reason":"PARTNER_TECHNICAL_ERROR","initiatedBy":"John Doe","comment":"Order submitted in error."}]}}},"CancelCorrectTransactionRequest":{"description":"Request body for cancelling or correcting a single transaction.\n","allOf":[{"$ref":"#/components/schemas/CancelCorrectDetails"},{"type":"object","required":["transactionID"],"properties":{"transactionID":{"type":"string","description":"The transaction identifier to cancel or correct.","example":"TXN-1001"}}}]},"CancelCorrectResponseBase":{"type":"object","description":"Fields common to every cancel-correct response.","required":["id","type","reason","status"],"properties":{"id":{"type":"string","description":"Unique identifier for the created cancel-correct record.","example":"cxl_rbl_123e4567-e89b-12d3-a456-000000000040"},"type":{"$ref":"#/components/schemas/NameDescription"},"reason":{"$ref":"#/components/schemas/NameDescription"},"status":{"$ref":"#/components/schemas/NameDescription"},"initiatedBy":{"type":"string","description":"The userId or system that initiated the cancel-correct request.","example":"John Doe"},"comment":{"type":"string","description":"The comment provided at the time of submission.","example":"Order submitted in error."},"adjustmentDetails":{"$ref":"#/components/schemas/AdjustmentDetails"}}},"CancelCorrectOrderResponse":{"description":"Response returned after an order cancel-correct request is created.\n","allOf":[{"$ref":"#/components/schemas/CancelCorrectResponseBase"},{"type":"object","required":["orderId"],"properties":{"orderId":{"type":"string","description":"The DriveWealth order identifier this record was submitted against.","example":"ORD-001"}}}]},"CancelCorrectExecutionResult":{"description":"Result of a single execution cancel-correct entry.\n","allOf":[{"$ref":"#/components/schemas/CancelCorrectResponseBase"},{"type":"object","required":["executionId"],"properties":{"executionId":{"type":"string","description":"The execution identifier this record was submitted against.","example":"EXEC-001"}}}]},"CancelCorrectExecutionsResponse":{"type":"object","description":"Response returned after one or more execution cancel-correct requests are created. Contains one result per submitted execution.\n","properties":{"OrderNo":{"type":"string","description":"The DriveWealth order identifier that the executions belong to.","example":"ORD-001"},"executions":{"type":"array","description":"One result per submitted execution, in the same order as the request.","items":{"$ref":"#/components/schemas/CancelCorrectExecutionResult"}}}},"CancelCorrectTransactionResponse":{"description":"Response returned after a transaction cancel-correct request is created.\n","allOf":[{"$ref":"#/components/schemas/CancelCorrectResponseBase"},{"type":"object","required":["transactionID"],"properties":{"transactionID":{"type":"string","description":"The transaction identifier this record was submitted against.","example":"TXN-1001"}}}]},"AssetTransferType":{"type":"string","enum":["ACAT","TEEN","CASH","PROMOTIONAL","REWARD","STOCK","INTERNAL"],"x-enumDescriptions":{"ACAT":"An ACATS transfer.","TEEN":"A minor-to-adult (teen graduation) internal transfer.","CASH":"A cash transfer.","PROMOTIONAL":"A promotional asset transfer.","REWARD":"A reward asset transfer.","STOCK":"A stock transfer.","INTERNAL":"An internal transfer between DriveWealth accounts."}},"AssetTransferStatus":{"type":"string","enum":["STARTED","PENDING","FAILED","SUCCESSFUL","ON_HOLD"],"x-enumDescriptions":{"STARTED":"Asset transfer request has been initiated.","PENDING":"Asset transfer request is pending.","FAILED":"The asset transfer failed.","SUCCESSFUL":"Asset transfer request has been successfully completed.","ON_HOLD":"Asset transfer request is on hold."}},"AcatRejectionCode":{"type":"string","description":"The ACAT rejection reason. REST responses (Retrieve/List/Update Transfer) send this name form; each value's description below gives its numeric code. The `assets.transfer.updated`/`.completed` webhook events send that numeric code alone instead (e.g. \"05\" for BROKER_NOT_MATCH).","enum":["UNKNOWN","SSN_NOT_MATCH","ACCOUNT_NOT_MATCH","DOC_REQUIRED","ACCOUNT_FLAT","BROKER_NOT_MATCH","DUPLICATE_REQUEST","ACCOUNT_IN_TRANSIT","BROKER_REJECTED","MISSING_AUTH_SIGN","MISSING_FUND","SYMBOL_NOT_SUPPORTED","QUANTITY_MISMATCH"],"x-enumDescriptions":{"UNKNOWN":"No specific code. Unknown.","SSN_NOT_MATCH":"Code 01. SSN/Tax ID mismatch.","ACCOUNT_NOT_MATCH":"Code 02. Account title mismatch.","DOC_REQUIRED":"Code 03. Documentation needed.","ACCOUNT_FLAT":"Code 04. Account flat.","BROKER_NOT_MATCH":"Code 05. Invalid broker account number.","DUPLICATE_REQUEST":"Code 06. Duplicate request.","ACCOUNT_IN_TRANSIT":"Code 07. Account in distribution or transfer.","BROKER_REJECTED":"Code 08. Client rescinded.","MISSING_AUTH_SIGN":"Code 09. Missing authorized signature.","MISSING_FUND":"Code 21. Insufficient portfolio value to support debit.","SYMBOL_NOT_SUPPORTED":"Code 22. Instrument not supported.","QUANTITY_MISMATCH":"Code 23. Instrument quantity mismatch."}},"GenericTransferStatus":{"type":"object","description":"The status of the Transfer","properties":{"name":{"$ref":"#/components/schemas/AssetTransferStatus"},"description":{"type":"string"}}},"GenericTransferRequest":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/accountNo"},"destination":{"type":"string","description":"The DriveWealth destination account number where all assets will be transferred to.","example":"FFFF000031"},"comment":{"$ref":"#/components/schemas/note"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"GenericTransferResponseModel":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/assetTransferID"},"status":{"$ref":"#/components/schemas/GenericTransferStatus"},"type":{"type":"object","description":"The type of the Transfer","properties":{"name":{"$ref":"#/components/schemas/AssetTransferType"},"description":{"type":"string"}}},"partner":{"$ref":"#/components/schemas/parentIBIDObject"},"created":{"type":"string","format":"date-time","example":"2022-12-22T06:07:41Z"},"updated":{"type":"string","format":"date-time","example":"2022-12-22T06:07:41Z"},"auditDetails":{"type":"array","description":"Audit of Transfer status changes","items":{"type":"object","minProperties":1,"properties":{"timestamp":{"type":"string","format":"date-time","description":"Status update timestamp","example":"2022-12-22T06:07:41Z"},"status":{"$ref":"#/components/schemas/GenericTransferStatus"},"comment":{"type":"string","description":"Status comment added by the system"}}}}}},"AcatsCreateRequestModelWithoutEnums":{"type":"object","properties":{"clearingNo":{"$ref":"#/components/schemas/ClearingNo"},"cash":{"type":"number","description":"The amount of cash to be moved from the source account.","default":0},"positions":{"type":"array","minItems":0,"description":"The positions to be moved from the source account to the destination account.","items":{"$ref":"#/components/schemas/AcatPositionModel"}}}},"AcatsTransferEnumValues_SourceAccountType":{"type":"string","description":"The type of account the sources account is. If TRUMP_ACCOUNT is selected, The acatType can only be FULL.","enum":["INDIVIDUAL","CORPORATE","JOINT","CUSTODIAL","IRA","RIA_MANAGED","TRUMP_ACCOUNT"],"x-enumDescriptions":{"INDIVIDUAL":"Individual account.","CORPORATE":"Corporate or trust account.","JOINT":"Joint account.","CUSTODIAL":"Custodial/minor/teen account.","IRA":"Individual Retirement Account.","RIA_MANAGED":"Robo advisor managed account.","TRUMP_ACCOUNT":"Trump account."}},"ClearingNo":{"type":"string","example":"0001","description":"The DTCC clearing number of the broker. Refer DTCC broker API to fetch full supported list.","minLength":1,"maxLength":4,"externalDocs":{"description":"DTCC Broker API","url":"https://developer.drivewealth.com/apis/reference/get_asset-transfers-acats-brokers"}},"AcatsType":{"type":"string","description":"The type of ACAT transfer to be performed.","enum":["FULL","PARTIAL"],"x-enumDescriptions":{"FULL":"Full ACATS transfer.","PARTIAL":"Partial ACATS transfer."}},"AcatsTransitType":{"type":"string","description":"The transit type of ACAT transfer to be performed.","enum":["ACAT_IN","ACAT_OUT"],"x-enumDescriptions":{"ACAT_IN":"Incoming ACAT transfer.","ACAT_OUT":"Outgoing ACAT transfer."}},"OutgoingCash":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of cash which is going from the broker.","example":1000}}},"IncomingCash":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of cash which is coming from the contra broker.","example":1000}}},"LoadingPositionIdentifier":{"type":"object","properties":{"symbol":{"type":"string","example":"AMD","description":"It can be empty if asset is not supported by DW."},"cusip":{"type":"string","description":"The CUSIP of the asset to be transferred.","example":"000000000"}}},"AcatLoadingPosition":{"type":"object","allOf":[{"$ref":"#/components/schemas/LoadingPositionIdentifier"},{"type":"object","properties":{"quantity":{"type":"integer","description":"The quantity of the asset to be transferred.","example":3},"instrumentType":{"$ref":"#/components/schemas/instrumentType"}}}]},"InternalTransferLoadingPosition":{"type":"object","allOf":[{"$ref":"#/components/schemas/LoadingPositionIdentifier"},{"type":"object","properties":{"quantity":{"type":"number","description":"The quantity of the asset to be transferred.","example":3},"instrumentType":{"type":"string","example":"EQUITY","description":"The classification of the instrument.","enum":["EQUITY","MUTUAL_FUND","DEBT"],"x-enumDescriptions":{"EQUITY":"A stock or share of a company.","MUTUAL_FUND":"A pooled investment fund managed by professionals.","DEBT":"A fixed-income security, such as a bond."}}}}]},"AcatReviewPositionItem":{"type":"object","properties":{"cusip":{"type":"string","description":"The CUSIP of the asset to be rejected.","example":"000000000"},"comment":{"$ref":"#/components/schemas/note","example":"AMD is rejected by broker."}}},"AcatReviewRejectPosition":{"type":"object","properties":{"reject":{"type":"array","description":"Indicates the position should be rejected from the transfer.","default":[],"items":{"$ref":"#/components/schemas/AcatReviewPositionItem"}}}},"Status724":{"type":"string","description":"The status of the transfer in the clearing custody.","example":"230"},"SettlementInfo":{"title":"AcatSettlementInfo","type":"object","description":"Settlement Info will appear when transfer gets sent to clearing custody. It consists of the controlno assigned from clearing custody and the status.","properties":{"controlNo":{"type":"string","description":"The control number assigned by the clearing custody.","example":"20250320013533"},"status":{"type":"string","enum":["ACAT_RECEIVED","ACAT_READY","ACAT_READY_AFTER_CUTOFF","ACAT_SENT","ACAT_ACK","ACAT_ADJUST","ACAT_IN_PROGRESS","ACAT_UNDER_REVIEW","ACAT_REVIEW_ACK","ACAT_REVIEW_SENT","ACAT_REVIEW_ADJUST","ACAT_PTR_IN_PROGRESS","ACAT_REVIEW_ACCEPTED","ACAT_SETTLEMENT_IN_PROGRESS","ACAT_REVIEW_ERROR","ACAT_SETTLED","ACAT_REJECTED","ACAT_PURGE","ACAT_PTR_REJECTED","UNRECOGNISED"],"description":"Enum for the status assigned by clearing custody","example":"ACAT_REVIEW_ACCEPTED","x-enumDescriptions":{"ACAT_RECEIVED":"The ACAT transfer request was received.","ACAT_READY":"The ACAT transfer is ready to be sent.","ACAT_READY_AFTER_CUTOFF":"The ACAT transfer is ready to be sent, after the daily cutoff.","ACAT_SENT":"The ACAT transfer was sent.","ACAT_ACK":"The ACAT transfer was acknowledged.","ACAT_ADJUST":"The ACAT transfer is being adjusted.","ACAT_IN_PROGRESS":"The ACAT transfer is in progress.","ACAT_UNDER_REVIEW":"The ACAT transfer is under review.","ACAT_REVIEW_ACK":"The ACAT transfer review was acknowledged.","ACAT_REVIEW_SENT":"The ACAT transfer review was sent.","ACAT_REVIEW_ADJUST":"The ACAT transfer review is being adjusted.","ACAT_PTR_IN_PROGRESS":"The ACAT partial transfer request (PTR) is in progress.","ACAT_REVIEW_ACCEPTED":"The ACAT transfer review was accepted.","ACAT_SETTLEMENT_IN_PROGRESS":"The ACAT transfer settlement is in progress.","ACAT_REVIEW_ERROR":"An error occurred during the ACAT transfer review.","ACAT_SETTLED":"The ACAT transfer has settled.","ACAT_REJECTED":"The ACAT transfer was rejected.","ACAT_PURGE":"The ACAT transfer record was purged.","ACAT_PTR_REJECTED":"The ACAT partial transfer request (PTR) was rejected.","UNRECOGNISED":"The status code was not recognized."}},"status724":{"$ref":"#/components/schemas/Status724"},"positions":{"type":"object","description":"The positions and cash which accepted by broker after review.","properties":{"cash":{"type":"number","description":"The amount of cash to be moved to account.","default":0},"accepted":{"type":"array","description":"The positions which are accepted and to be moved from the account. Array is consist of cusip values."},"excluded":{"type":"array","description":"The positions which are excluded in transfer. Array is consist of cusip values. We will exclude the assets which are not supported by ACAT transfer."}}}}},"RejectionInfo":{"type":"object","properties":{"rejectionCode":{"$ref":"#/components/schemas/AcatRejectionCode"},"rejectionReason":{"type":"string"},"positions":{"type":"object","description":"The positions which are rejected by broker after review.","additionalProperties":{"type":"string","example":"Instrument not found."}},"cash":{"type":"number","description":"The debit amount of cash which is rejected by broker after review.","example":-700}}},"AcatsCreateRequestModel":{"type":"object","title":"AcatsRequestModel","description":"ACAT Request model","allOf":[{"$ref":"#/components/schemas/GenericTransferRequest"},{"$ref":"#/components/schemas/AcatsCreateRequestModelWithoutEnums","allOf":[{"properties":{"acatType":{"$ref":"#/components/schemas/AcatsType"}}}]}],"properties":{"sourceAccountType":{"$ref":"#/components/schemas/AcatsTransferEnumValues_SourceAccountType"},"acatType":{"$ref":"#/components/schemas/AcatsType"}},"required":["source","destination","clearingNo","acatType"]},"AcatsUpdateRequestModel":{"type":"object","title":"AcatsUpdateRequestModel","description":"ACAT Request model","properties":{"comment":{"$ref":"#/components/schemas/note","description":"The comment for the ACAT transfer."},"reviewPositions":{"type":"object","description":"The positions to be reviewed by the broker.","allOf":[{"$ref":"#/components/schemas/AcatReviewRejectPosition"}]}},"required":["reviewPositions"]},"AcatsTransferListResponseModel":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/accountNo"},"sourceAccountID":{"$ref":"#/components/schemas/sourceAccountID"},"destinationAccountID":{"$ref":"#/components/schemas/destinationAccountID"},"sourceAccountType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsTransferEnumValues_SourceAccountType"},"description":{"type":"string"}}},"clearingNo":{"$ref":"#/components/schemas/ClearingNo"},"acatType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsType"},"description":{"type":"string"}}},"acatTransit":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsTransitType"},"description":{"type":"string"}}},"positions":{"$ref":"#/components/schemas/AcatPositionResponseModel"},"settlementInfo":{"$ref":"#/components/schemas/SettlementInfo"},"rejectionInfo":{"$ref":"#/components/schemas/RejectionInfo"},"metadata":{"$ref":"#/components/schemas/metadata"},"auditDetails":{"type":"array","description":"Audit of Transfer status changes","anyOf":[{"$ref":"#/components/schemas/AcatsAuditDetails"}]}},"required":["source","destination","clearingNo","acatType","acatTransit","auditDetails"]},"AcatsTransferGetResponseModel":{"type":"object","properties":{"sourceAccountID":{"$ref":"#/components/schemas/sourceAccountID"},"destinationAccountID":{"$ref":"#/components/schemas/destinationAccountID"},"sourceAccountType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsTransferEnumValues_SourceAccountType"},"description":{"type":"string"}}},"clearingNo":{"$ref":"#/components/schemas/ClearingNo"},"acatType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsType"},"description":{"type":"string"}}},"acatTransit":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsTransitType"},"description":{"type":"string"}}},"positions":{"$ref":"#/components/schemas/AcatPositionResponseModel"},"incomingCash":{"type":"object","description":"The amount of cash which is coming from the contra broker.","allOf":[{"$ref":"#/components/schemas/IncomingCash"}]},"outgoingCash":{"type":"object","description":"The amount of cash which is going to the contra broker.","allOf":[{"$ref":"#/components/schemas/OutgoingCash"}]},"incomingPositions":{"type":"array","description":"The positions which are accepted by the broker after review.","allOf":[{"$ref":"#/components/schemas/AcatLoadingPosition"}]},"outgoingPositions":{"type":"array","description":"The positions which are going out to the broker after review.","allOf":[{"$ref":"#/components/schemas/AcatLoadingPosition"}]},"settlementInfo":{"$ref":"#/components/schemas/SettlementInfo"},"rejectionInfo":{"$ref":"#/components/schemas/RejectionInfo"},"metadata":{"$ref":"#/components/schemas/metadata"},"auditDetails":{"type":"array","description":"Audit of Transfer status changes","anyOf":[{"$ref":"#/components/schemas/AcatsAuditDetails"}]}},"required":["source","destination","clearingNo","acatType","acatTransit","auditDetails"]},"ACATSTransferCreatedResponseModel":{"type":"object","properties":{"source":{"allOf":[{"$ref":"#/components/schemas/accountNo"}],"description":"The account number of the account on contra broker.","example":"DTCCBROKER1"},"sourceAccountID":{"$ref":"#/components/schemas/sourceAccountID"},"destination":{"allOf":[{"$ref":"#/components/schemas/accountNo"}],"description":"The DriveWealth destination account number where all assets will be transferred.","example":"FFFF000031"},"destinationAccountID":{"$ref":"#/components/schemas/destinationAccountID"},"clearingNo":{"$ref":"#/components/schemas/ClearingNo"},"sourceAccountType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsTransferEnumValues_SourceAccountType"},"description":{"type":"string"}}},"acatType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsType"},"description":{"type":"string"}}},"acatTransit":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/AcatsTransitType"},"description":{"type":"string"}}},"positions":{"$ref":"#/components/schemas/AcatPositionResponseModel"},"metadata":{"$ref":"#/components/schemas/metadata"},"auditDetails":{"type":"array","description":"Audit of Transfer status changes","anyOf":[{"$ref":"#/components/schemas/AuditDetails"}]}},"required":["source","destination","clearingNo","acatType","acatTransit","auditDetails"]},"InternalTransferCreatedResponseModel":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the internal transfer.","example":"int_123e4567-e89b-12d3-a456-00000000003b"},"status":{"type":"string","description":"The status of the internal transfer.","example":"STARTED"},"source":{"$ref":"#/components/schemas/accountNo"},"sourceAccountID":{"$ref":"#/components/schemas/sourceAccountID"},"destination":{"$ref":"#/components/schemas/accountNo"},"destinationAccountID":{"$ref":"#/components/schemas/destinationAccountID"},"clearingNo":{"$ref":"#/components/schemas/ClearingNo","deprecated":true,"description":"clearingNo is not needed for internal transfer"},"transferType":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/InternalTransferType"},"description":{"type":"string"}},"example":{"name":"FULL","description":"Full Transfer"}},"partner":{"$ref":"#/components/schemas/parentIBIDObject"},"cash":{"type":"number","description":"The cash amount to be transferred.","example":1000},"incomingCash":{"type":"number","description":"The incoming cash amount to be transferred.","example":1000},"outgoingCash":{"type":"number","description":"The outgoing cash amount to be transferred.","example":1000},"positions":{"type":"array","items":{"$ref":"#/components/schemas/InternalTransferLoadingPosition"}},"incomingPositions":{"type":"array","items":{"$ref":"#/components/schemas/InternalTransferLoadingPosition"}},"outgoingPositions":{"type":"array","items":{"$ref":"#/components/schemas/InternalTransferLoadingPosition"}},"comment":{"$ref":"#/components/schemas/note"},"metadata":{"$ref":"#/components/schemas/metadata"},"created":{"type":"string","format":"date-time","example":"2022-12-22T06:07:41Z"},"updated":{"type":"string","format":"date-time","example":"2022-12-22T06:07:41Z"},"auditDetails":{"type":"array","description":"Audit of Transfer status changes","items":{"$ref":"#/components/schemas/AuditDetails"}}}},"MinorCreateRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/GenericTransferRequest"}]},"AcatPositionModel":{"title":"AcatPosition","type":"object","description":"Position Model. Symbol or InstrumentID is required.","properties":{"symbol":{"$ref":"#/components/schemas/instrumentSymbol"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"quantity":{"type":"number","description":"The quantity of shares to be transferred. Assets that are moving to or from an account outside of DriveWealth, can only be whole shares.","minimum":1}},"required":["quantity"]},"AcatPositionResponseModel":{"type":"array","description":"The positions to be moved from the source account to the destination account.","allOf":[{"$ref":"#/components/schemas/AcatPositionModel"},{"$ref":"#/components/schemas/instrumentType"}]},"AcatsDTCCBrokerListResponseModel":{"type":"array","description":"List of supported DTCC brokers.","items":{"type":"object","properties":{"brokerCode":{"type":"string","description":"The DTCC clearing number of the broker.","example":"0001","minLength":1,"maxLength":4},"brokerName":{"type":"string","description":"The name of the broker.","example":"DriveWealth"}}},"required":["brokerCode","brokerName"]},"CancelRebillUpdateRes":{"type":"object","properties":{"partnerID":{"$ref":"#/components/schemas/parentIBIDObject"},"id":{"type":"string"},"status":{"$ref":"#/components/schemas/CancelRebillStatus/properties/name"},"comment":{"$ref":"#/components/schemas/note"}}},"CancelRebillRequest":{"type":"object","required":["orderNo","type","reason"],"properties":{"orderNo":{"$ref":"#/components/schemas/orderNo"},"type":{"type":"string","example":"CANCEL","enum":["CANCEL","PRICE_ADJUSTMENT","COMMISSION_ADJUSTMENT"],"description":"The adjustment classification.","x-enumDescriptions":{"CANCEL":"The original transaction is being canceled.","PRICE_ADJUSTMENT":"The price of the original transaction is being adjusted.","COMMISSION_ADJUSTMENT":"The commission of the original transaction is being adjusted."}},"reason":{"type":"string","example":"FRAUD","enum":["FRAUD","PRICE_ADJUSTMENT_PARTNER","PRICE_ADJUSTMENT_VENUE","DRIVEWEALTH_TECHNICAL_ERROR","PARTNER_TECHNICAL_ERROR","VENDOR_ERROR"],"description":"The cause of the request.","x-enumDescriptions":{"FRAUD":"The original transaction was fraudulent.","PRICE_ADJUSTMENT_PARTNER":"A price adjustment requested by the partner.","PRICE_ADJUSTMENT_VENUE":"A price adjustment initiated by the execution venue.","DRIVEWEALTH_TECHNICAL_ERROR":"A DriveWealth technical error.","PARTNER_TECHNICAL_ERROR":"A partner technical error.","VENDOR_ERROR":"A vendor error."}},"approvedBy":{"$ref":"#/components/schemas/userID"},"adjustedPrice":{"type":"number","example":125.3,"description":"The *updated* price that should be set; from the original transaction."},"adjustedCommission":{"type":"number","example":2.49,"description":"The *updated* commission that should be set; from the original transaction."},"comment":{"type":"string","description":"The comment on the reason for Cancellation or an Adjustment.","minLength":1,"maxLength":100},"metadata":{"type":"array","description":"Any metadata field which needs to be part of cancel rebill transaction.","items":{"type":"object"}}}},"CancelRebillIdentifer":{"type":"string","description":"A unique identifier generated for the Cancel Rebill.","format":"string"},"CancelRebillResponse":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/CancelRebillIdentifer"},"reason":{"$ref":"#/components/schemas/CancelRebillReason"},"type":{"$ref":"#/components/schemas/CancelRebillType"},"orderNo":{"$ref":"#/components/schemas/orderNo"},"status":{"$ref":"#/components/schemas/CancelRebillStatus"},"approvedBy":{"type":"string","description":"The user who approved the Cancel Rebill Request.","minLength":1,"maxLength":50},"comment":{"$ref":"#/components/schemas/note"}}},"CancelRebillReason":{"type":"object","properties":{"name":{"example":"PRICE_ADJUSTMENT_PARTNER","enum":["FRAUD","PRICE_ADJUSTMENT_PARTNER","PRICE_ADJUSTMENT_VENUE","DRIVEWEALTH_TECHNICAL_ERROR","PARTNER_TECHNICAL_ERROR","VENDOR_ERROR"],"description":"The Cancel Rebill reason.","x-enumDescriptions":{"FRAUD":"The original transaction was fraudulent.","PRICE_ADJUSTMENT_PARTNER":"A price adjustment requested by the partner.","PRICE_ADJUSTMENT_VENUE":"A price adjustment initiated by the execution venue.","DRIVEWEALTH_TECHNICAL_ERROR":"A DriveWealth technical error.","PARTNER_TECHNICAL_ERROR":"A partner technical error.","VENDOR_ERROR":"A vendor error."}},"description":{"type":"string","description":"The description of the reason for the Cancel Rebill."}}},"CancelRebillType":{"type":"object","properties":{"name":{"example":"CANCEL","enum":["CANCEL","PRICE_ADJUSTMENT","COMMISSION_ADJUSTMENT"],"description":"The type of Cancel Rebill.","x-enumDescriptions":{"CANCEL":"The original transaction is being canceled.","PRICE_ADJUSTMENT":"The price of the original transaction is being adjusted.","COMMISSION_ADJUSTMENT":"The commission of the original transaction is being adjusted."}},"description":{"type":"string","description":"The description of the cancel rebill type."}}},"CancelRebillStatus":{"type":"object","properties":{"name":{"enum":["STARTED","APPROVED","ON_HOLD","REJECTED","PENDING","SUCCESSFUL"],"description":"The status of the Cancel Rebill.","x-enumDescriptions":{"STARTED":"The cancel/rebill request was started.","APPROVED":"The cancel/rebill request was approved.","ON_HOLD":"The cancel/rebill request is on hold.","REJECTED":"The cancel/rebill request was rejected.","PENDING":"The cancel/rebill request is pending.","SUCCESSFUL":"The cancel/rebill request completed successfully."}},"description":{"type":"string","description":"The description of the Cancel Rebill status."},"code":{"type":"integer"}}},"CancelRebillDetailResponse":{"type":"object","title":"CancelRebillDetailResponse","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CancelRebillDetail"}},"responseMetadata":{"$ref":"#/components/schemas/ResponseMetadata"}}},"CancelRebillDetail":{"type":"object","title":"CancelRebillDetail","description":"Model object to list all the cancel rebill transaction attributes.","properties":{"id":{"$ref":"#/components/schemas/CancelRebillIdentifer"},"partner":{"$ref":"#/components/schemas/parentIBIDObject"},"reviewRequired":{"example":true,"type":"boolean","description":"Flag which suggests whether the cancel rebill request require manual processing."},"orderNo":{"$ref":"#/components/schemas/orderNo"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"accountID":{"$ref":"#/components/schemas/accountID"},"errorAccountNo":{"$ref":"#/components/schemas/accountNo","description":"Error Account against which the Cancel rebill transaction was booked."},"errorAccountID":{"$ref":"#/components/schemas/accountID"},"type":{"$ref":"#/components/schemas/CancelRebillType"},"reason":{"$ref":"#/components/schemas/CancelRebillReason"},"symbol":{"$ref":"#/components/schemas/instrumentSymbol","description":"The instrument symbol for which the original trade was booked."},"quantity":{"type":"number","example":4,"description":"The order quantity of original transaction."},"price":{"type":"number","example":100.01,"description":"The price of original transaction."},"adjustedPrice":{"type":"number","example":100.03,"description":"New price when adjusting the price of original transaction."},"adjustedCommission":{"type":"number","example":2.49,"description":"The new commission when adjusting the commission of original transaction."},"status":{"$ref":"#/components/schemas/CancelRebillStatus"},"statusComment":{"type":"string","description":"Comment while approving rejecting the Cancel Rebill transaction."},"approvedBy":{"type":"string","description":"The approver of the Cancel Rebill Request.","example":"John Doe","minLength":1,"maxLength":50},"updated":{"type":"string","description":"The last updated date of the Cancel Rebill transaction."},"comment":{"$ref":"#/components/schemas/note"},"auditDetails":{"type":"array","items":{"$ref":"#/components/schemas/AuditDetails"}}}},"AuditDetails":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/AssetTransferStatus"},"comment":{"$ref":"#/components/schemas/note"},"updatedBy":{"type":"string","description":"The user who updated the status."},"timestamp":{"type":"string","format":"date-time","description":"Status update timestamp","example":"2022-12-22T06:07:41Z"}}},"AcatsAuditDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/AuditDetails"},{"$ref":"#/components/schemas/Status724"}]},"CancelRebillUpdateRequest":{"type":"array","items":{"$ref":"#/components/schemas/UpdateRequest"}},"UpdateRequest":{"type":"object","properties":{"partnerID":{"$ref":"#/components/schemas/partnerID"},"id":{"$ref":"#/components/schemas/CancelRebillIdentifer"},"status":{"example":"APPROVED","enum":["STARTED","APPROVED","ON_HOLD","REJECTED","PENDING","SUCCESSFUL"],"description":"The status of the Cancel Rebill.","x-enumDescriptions":{"STARTED":"The cancel/rebill request was started.","APPROVED":"The cancel/rebill request was approved.","ON_HOLD":"The cancel/rebill request is on hold.","REJECTED":"The cancel/rebill request was rejected.","PENDING":"The cancel/rebill request is pending.","SUCCESSFUL":"The cancel/rebill request completed successfully."}},"comment":{"$ref":"#/components/schemas/note"}},"required":["partnerID","id","status"]},"InternalTransfersCreateRequestModel":{"title":"InternalTransfersCreateRequestModel","description":"Internal Transfers Request model. For FULL, ALL_CASH, and ALL_POSITIONS transfer types, cash and positions must not be provided in the request. For ALL_POSITIONS transfers, all positions are automatically transferred from the source account. For PARTIAL transfers, at least one of cash or positions must be provided.","oneOf":[{"$ref":"#/components/schemas/InternalTransferFullRequest"},{"$ref":"#/components/schemas/InternalTransferPartialRequest"},{"$ref":"#/components/schemas/InternalTransferAllCashRequest"},{"$ref":"#/components/schemas/InternalTransferAllPositionsRequest"}]},"InternalTransferFullRequest":{"type":"object","title":"Full Transfer","description":"Transfers all cash and positions from the source account to the destination account. Cash and positions must not be specified.","allOf":[{"$ref":"#/components/schemas/GenericTransferRequest"}],"properties":{"transferType":{"type":"string","enum":["FULL"],"description":"Must be FULL for a full transfer.","x-enumDescriptions":{"FULL":"Transfer all cash and all positions from the source account."}}},"required":["source","destination","transferType"]},"InternalTransferPartialRequest":{"type":"object","title":"Partial Transfer","description":"Transfers a specified amount of cash and/or positions from the source account to the destination account. At least one of cash or positions must be provided.","allOf":[{"$ref":"#/components/schemas/GenericTransferRequest"}],"properties":{"transferType":{"type":"string","enum":["PARTIAL"],"description":"Must be PARTIAL for a partial transfer.","x-enumDescriptions":{"PARTIAL":"Transfer only the specified cash amount and/or positions."}},"cash":{"type":"number","description":"The amount of cash to transfer."},"positions":{"$ref":"#/components/schemas/InternalTransferPositions"}},"required":["source","destination","transferType"],"anyOf":[{"required":["cash"]},{"required":["positions"]}]},"InternalTransferAllCashRequest":{"type":"object","title":"All Cash Transfer","description":"Transfers all cash from the source account to the destination account. Cash and positions must not be specified.","allOf":[{"$ref":"#/components/schemas/GenericTransferRequest"}],"properties":{"transferType":{"type":"string","enum":["ALL_CASH"],"description":"Must be ALL_CASH for a full cash transfer.","x-enumDescriptions":{"ALL_CASH":"Transfer all cash from the source account while leaving positions untouched."}}},"required":["source","destination","transferType"]},"InternalTransferAllPositionsRequest":{"type":"object","title":"All Positions Transfer","description":"Transfers all positions from the source account to the destination account. Cash and positions must not be specified.","allOf":[{"$ref":"#/components/schemas/GenericTransferRequest"}],"properties":{"transferType":{"type":"string","enum":["ALL_POSITIONS"],"description":"Must be ALL_POSITIONS for a full position transfer.","x-enumDescriptions":{"ALL_POSITIONS":"Transfer all positions from the source account while leaving cash untouched."}}},"required":["source","destination","transferType"]},"InternalTransferType":{"type":"string","description":"The type of internal transfer. FULL transfers all cash and all positions from the source account. PARTIAL transfers only the specified cash amount and/or positions. ALL_CASH transfers all cash from the source account while leaving positions untouched. ALL_POSITIONS transfers all positions from the source account while leaving cash untouched.","enum":["FULL","PARTIAL","ALL_CASH","ALL_POSITIONS"],"x-enumDescriptions":{"FULL":"Full internal transfer.","PARTIAL":"Partial internal transfer.","ALL_CASH":"Transfer all cash only.","ALL_POSITIONS":"Transfer all positions only."}},"InternalTransferPositions":{"type":"array","items":{"$ref":"#/components/schemas/InternalTransferPosition"}},"InternalTransferPosition":{"type":"object","properties":{"symbol":{"type":"string","example":"AMD"},"quantity":{"type":"number","example":1}}},"PerformanceResponse":{"type":"object","x-implements":["java.io.Serializable"],"properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"startDate":{"type":"string","format":"date","description":"Requested start date of the accounts performance period."},"endDate":{"type":"string","format":"date","description":"Requested end date of the accounts performance period."},"lastUpdated":{"type":"string","format":"date","description":"The date and time the this request."},"method":{"x-audience":"beta","type":"string","enum":["MODIFIED_DIETZ","TIME_WEIGHTED"],"description":"![beta](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDY0IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtQkVUQSIgeDE9IjAiIHkxPSIwIiB4Mj0iMCIgeTI9IjEiPjxzdG9wIG9mZnNldD0iMCUiIHN0b3AtY29sb3I9InJnYmEoMTQsMTY1LDIzMywwLjIyKSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0icmdiYSgxNCwxNjUsMjMzLDAuMDYpIi8+PC9saW5lYXJHcmFkaWVudD48ZmlsdGVyIGlkPSJnbG93LUJFVEEiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iNjIiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjMGVhNWU5IiBmaWx0ZXI9InVybCgjZ2xvdy1CRVRBKSIgb3BhY2l0eT0iMC41NSIvPjxyZWN0IHg9IjAuNSIgeT0iMC41IiB3aWR0aD0iNjMiIGhlaWdodD0iMTkiIHJ4PSIxMCIgZmlsbD0idXJsKCNncmFkLUJFVEEpIiBzdHJva2U9IiMwZWE1ZTkiIHN0cm9rZS13aWR0aD0iMSIvPjxjaXJjbGUgY3g9IjEwIiBjeT0iMTAiIHI9IjQuNSIgZmlsbD0iIzBlYTVlOSIgZmlsdGVyPSJ1cmwoI2dsb3ctQkVUQSkiIG9wYWNpdHk9IjAuNSIvPjxjaXJjbGUgY3g9IjEwIiBjeT0iMTAiIHI9IjMiIGZpbGw9IiMwZWE1ZTkiLz48dGV4dCB4PSIxOCIgeT0iMTMuNSIgZm9udC1mYW1pbHk9IkhlbHZldGljYSwgQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTAiIGZvbnQtd2VpZ2h0PSI3MDAiIGxldHRlci1zcGFjaW5nPSIwLjYiIGZpbGw9IiMwYzhlZTAiPkJFVEE8L3RleHQ+PC9zdmc+)\nThe methodology used to compute summary.periodReturn. Trailing returns (mtdReturn, ytdReturn, 1yearReturn, 3yearReturn, 5yearReturn, inceptionReturn) are methodology-independent.","x-enumDescriptions":{"MODIFIED_DIETZ":"Modified Dietz return methodology.","TIME_WEIGHTED":"Time-weighted return methodology."}},"timeSeries":{"type":"array","items":{"$ref":"#/components/schemas/TimeSeriesElement"}},"summary":{"$ref":"#/components/schemas/Summary","type":"object"}}},"TimeSeriesElement":{"type":"object","x-implements":["java.io.Serializable"],"properties":{"date":{"type":"string","example":"2018-09-18","description":"the date of the performance arrays values."},"gainLoss":{"type":"number","description":"The change in market value of the account during this time series (adjusted to remove impact of cashflows)."},"positionBalance":{"type":"number","description":"The sum of the value of the positions held in the account (excluding money market funds which are captured in cashBalance) at the beginning date of the time series."},"cashBalance":{"$ref":"#/components/schemas/performanceObj/properties/cash"},"marketValue":{"type":"number","description":"The market value of the account at the beginning date of the time series. Market value defined as the sum of the position balance and the cash balance."},"cashFlows":{"type":"number","description":"The sum of the inflows and outflows during this time series."},"deposits":{"$ref":"#/components/schemas/performanceObj/properties/deposits"},"withdrawals":{"$ref":"#/components/schemas/performanceObj/properties/withdrawals"},"fees":{"type":"number","example":0,"description":"The total amount of fees calculated from 4pm of previous day until current time."},"income":{"type":"number","description":"Income in the account for the time series. (Income defined as dividends, interest and capital gains distributions."},"rateOfReturn":{"type":"number","description":"The rate of return for the time series calculated utilizing the Modified Dietz methodology."}}},"Summary":{"type":"object","x-implements":["java.io.Serializable"],"properties":{"beginningMarketValue":{"type":"number","description":"The market value of the account at the beginning date of the query. Market value defined as the sum of the position balance and the cash balance."},"beginningPositionBalance":{"type":"number","description":"The sum of the value of the positions held in the account (excluding money market funds which are captured in cashBalance) at the beginning date or the query."},"beginningCashBalance":{"type":"number","description":"The cash balance of the account at the beginning date of the query."},"endingMarketValue":{"type":"number","description":"The market value of the account at the ending date of the query. Market value defined as the sum of the position balance and the cash balance."},"endingPositionBalance":{"type":"number","description":"The sum of the value of the positions held in the account (excluding money market funds which are captured in cashBalance) at the ending date of the query"},"endingCashBalance":{"type":"number","description":"The cash balance of the account at the ending date of the query."},"periodGainLoss":{"type":"number","description":"The gain / loss for the period defined as the delta of the beginningMarketValue vs endingMarketValue adjusted for cashflows."},"periodCashFlows":{"type":"number","description":"The sum of the inflows and outflows during this period."},"periodDeposits":{"type":"number","description":"The sum of deposits for this period."},"periodWithdrawals":{"type":"number","description":"The sum of withdrawals for this period."},"periodFees":{"type":"number","description":"The sum of trading related fees accumulated during this period."},"periodIncome":{"type":"number","description":"Income in the account for the period. (Income defined as dividends, interest and capital gains distributions."},"periodReturn":{"type":"number","description":"The return for the period calculated using the selected method (MODIFIED_DIETZ or TIME_WEIGHTED)."},"mtdReturn":{"type":"number","description":"The month-to-date return for the account calculated utilizing Modified Dietz methodology."},"ytdReturn":{"type":"number","description":"The historic year-to-date year return of the account calculated by joining monthly return statistics. Query will return NULL values if the account has not been open for the duration."},"1yearReturn":{"type":"number","description":"The historic 1 year return of the account calculated by joining monthly return statistics. Query will return NULL values if the account has not been open for the duration."},"3yearReturn":{"type":"number","description":"The historic 3 year return of the account calculated by joining monthly return statistics. Query will return NULL values if the account has not been open for the duration."},"5yearReturn":{"type":"number","description":"The historic 5 year return of the account calculated by joining monthly return statistics. Query will return NULL values if the account has not been open for the duration."},"inceptionReturn":{"type":"number","description":"The historic return of the account calculated by joining monthly return statistics from inception of account to current date."}}},"assetClass":{"type":"string","description":"Asset class of the position (e.g., EQUITY, OPTIONS, FIXED_INCOME, MUTUAL_FUND, EVENT_CONTRACT).","example":"EQUITY"},"sleeve":{"type":"string","description":"The sleeve is a virtual sub-account identifier.","example":"ACCOUNT123"},"PositionLegsV2":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"id":{"$ref":"#/components/schemas/taxLotID"},"sleeve":{"$ref":"#/components/schemas/sleeve"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"assetClass":{"$ref":"#/components/schemas/assetClass"},"created":{"type":"string","example":"2017-06-16T15:35:30.617Z","description":"The timestamp when the position was created."},"initialQuantity":{"type":"number","example":0.17583963,"description":"The initial quantity of shares for position leg."},"openQuantity":{"type":"number","example":10.1,"description":"The total amount of shares currently held in this position leg."},"effectiveCostPerShare":{"type":"number","example":113.74,"description":"The effective cost per share of the position leg."},"side":{"$ref":"#/components/schemas/sideAbbreviated"},"comment":{"$ref":"#/components/schemas/note"},"openClose":{"type":"string","description":"Open/close indicator for the lot. Null for non-options lots.","enum":["O","C"],"example":"O","x-enumDescriptions":{"O":"Open.","C":"Close."}},"settlementDate":{"type":"string","format":"date","description":"Settlement date of the lot.","example":"2022-08-29"},"transactionStatus":{"type":"string","description":"Transaction status of the lot.","example":"NEW"},"originalQuantity":{"type":"number","description":"Original (as-traded) quantity of the lot.","example":0.17583963},"entryDateTime":{"type":"string","description":"Entry timestamp for the lot.","example":"2022-08-25T10:07:47.235Z"},"longShortIndicator":{"type":"string","description":"Long/short indicator for the lot.","example":"LONG"},"transactionID":{"type":"string","description":"Transaction identifier for the lot."},"positionType":{"type":"string","description":"Type of the position."}}},"PositionLegsV2WithUserID":{"allOf":[{"$ref":"#/components/schemas/PositionLegsV2"},{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"}}}]},"PositionLegsV2WithPartnerIDAndUserID":{"allOf":[{"$ref":"#/components/schemas/PositionLegsV2WithUserID"},{"type":"object","properties":{"partnerID":{"$ref":"#/components/schemas/partnerID"}}}]},"V2AccountPositionLotsRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PositionLegsV2"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":true,"description":"Indicates whether more pages are available."}}}}},"V2UserPositionLotsRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PositionLegsV2WithUserID"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":true,"description":"Indicates whether more pages are available."}}}}},"V2PartnerPositionLotsRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PositionLegsV2WithPartnerIDAndUserID"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":true,"description":"Indicates whether more pages are available."}}}}},"positionBreakdownItem":{"type":"object","description":"Represents a position segment with its sell availability.","properties":{"type":{"type":"string","enum":["HC","HELD_CLEAR","STOCK_LOAN","ACATS_OUT_LOCK","LOCK"],"example":"STOCK_LOAN","description":"Segment type within the position."},"quantity":{"type":"number","example":10,"description":"Quantity associated with this segment."},"availableForTrade":{"type":"boolean","example":true,"description":"Whether this segment is available for trade."},"availableForWithdrawal":{"type":"boolean","example":true,"description":"Whether this segment is available for withdrawal."}}},"V2AccountPositionItem":{"type":"object","properties":{"accountID":{"$ref":"#/components/schemas/accountID"},"accountNo":{"$ref":"#/components/schemas/accountNo"},"assetClass":{"$ref":"#/components/schemas/assetClass"},"tradingType":{"$ref":"#/components/schemas/tradingType"},"sleeve":{"$ref":"#/components/schemas/sleeve"},"preferredIdentifier":{"type":"string","description":"The preferred security identifier value (e.g., ticker, ISIN, CUSIP, or instrument UUID).","example":"MS"},"instrumentID":{"$ref":"#/components/schemas/instrumentID"},"openClose":{"type":"string","description":"Indicates if the position is open ('O') or close ('C'). Optional. Present only for options positions.","enum":["O","C"],"example":"O","x-enumDescriptions":{"O":"Open.","C":"Close."}},"totalQty":{"type":"number","example":31.65120151,"description":"The quantity of shares currently open."},"settledQty":{"type":"number","example":25.65120151,"description":"Quantity that has been settled or available for transfer."},"availableForTradingQty":{"type":"number","example":26.65120151,"description":"Quantity available for trading."},"availableForWithdrawalQty":{"type":"number","example":26.65120151,"description":"Quantity available for withdrawal or transfer."},"positionBreakdown":{"type":"array","description":"Breakdown of position quantities by segment and sell availability.","items":{"$ref":"#/components/schemas/positionBreakdownItem"}},"marketValue":{"type":"number","example":4540.36,"description":"The current market value of the position."},"priorClose":{"type":"number","example":144.29,"description":"The prior close price."},"avgPrice":{"type":"number","example":30.84,"description":"Average price per share."},"mktPrice":{"type":"number","example":143.45,"description":"Current market price."},"unrealizedPL":{"type":"number","example":3564.38,"description":"Unrealized profit/loss."},"unrealizedPLPercent":{"type":"number","example":14.29,"description":"Unrealized P/L as a percentage of the total cost basis."},"unrealizedDayPLPercent":{"type":"number","example":-0.58,"description":"Unrealized day P/L percentage."},"unrealizedDayPL":{"type":"number","example":-26.59,"description":"Unrealized day P/L."},"partnerID":{"type":"string","description":"Identifier of the partner associated with the position."},"partnerName":{"type":"string","description":"Name of the partner associated with the position."},"positionType":{"type":"string","description":"Type of the position"}}},"V2AccountPositionItemWithUserID":{"allOf":[{"$ref":"#/components/schemas/V2AccountPositionItem"},{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"}}}]},"OptionsAccountPositionItem":{"allOf":[{"$ref":"#/components/schemas/V2AccountPositionItem"},{"type":"object","properties":{"underlying":{"type":"object","description":"Underlying instrument details. Present only for options positions.","properties":{"rootSymbol":{"type":"string","description":"Root symbol of the underlying instrument.","example":"SPY"},"marketPrice":{"type":"number","description":"Current market price of the underlying instrument."}}},"moneyness":{"type":"string","description":"Moneyness of the option position (e.g. ITM, OTM, ATM). Present only for options positions."}}}]},"V2PositionsRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/V2AccountPositionItem"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":true,"description":"Indicates whether more pages are available."}}}}},"V2UserPositionsRes":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/V2AccountPositionItemWithUserID"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":true,"description":"Indicates whether more pages are available."}}}}},"TransactionsCharges":{"type":"object","properties":{"Type":{"type":"string","description":"Type of the commission or fee."},"Amount":{"type":"number","nullable":true,"description":"Amount of the commission or fee."},"Currency":{"type":"string","nullable":true,"description":"Currency of the commission or fee."},"TransactionTypeId":{"type":"string","nullable":true,"description":"TranID for the commission or fee reference."}}},"DispositionLotsDetails":{"type":"object","properties":{"TradeDate":{"type":"string","format":"date","nullable":true,"description":"Trade date of the financial transaction."},"Amount":{"type":"number","nullable":true,"description":"Amount depleted from the trade."},"Price":{"type":"number","nullable":true,"description":"Cost basis of this lot."},"Method":{"type":"string","enum":["VSP","FIFO","LIFO"],"nullable":true,"description":"Disposition method applied.","x-enumDescriptions":{"VSP":"Versus purchase — a specific tax lot is selected for disposition.","FIFO":"First in, first out.","LIFO":"Last in, first out."}}}},"TransactionV2Response":{"type":"object","description":"Flexible representation for any type of transaction (trade, transfer, payment, corporate action, etc.)","properties":{"transactionId":{"type":"string","description":"Uniquely generated ID. Linkage to the back-office trade."},"partnerId":{"type":"string","nullable":true,"description":"Identifier of the partner associated with the transaction."},"accountNo":{"type":"string","nullable":true,"description":"Number of the account (10 digit, client facing ID)."},"accountId":{"type":"string","nullable":true,"description":"Unique identifier for the account."},"accountType":{"type":"string","nullable":true,"description":"The type of the account (e.g., C=cash, M=margin, S=Short)."},"sleeve":{"type":"string","nullable":true,"description":"Virtual sub-account identifier."},"createdAt":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the transaction record was created."},"activityDate":{"type":"string","format":"date","nullable":true,"description":"Activity date (processing business date)."},"tradeDate":{"type":"string","format":"date","nullable":true,"description":"Trade date of the financial transaction."},"settlementDate":{"type":"string","format":"date","nullable":true,"description":"Settlement date of the financial transaction."},"transactTime":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the transaction happened."},"orderNo":{"type":"string","description":"Order number as assigned by OMS."},"extTranId":{"type":"string","nullable":true,"description":"External transaction reference ID."},"extTranRefId":{"type":"string","nullable":true,"description":"Original ID on cancel or revision."},"transactionRefId":{"type":"string","description":"Reference to original transaction on a Cancel/Revision record."},"orderDetails":{"type":"object","nullable":true,"description":"Order-level details parsed from the order details JSON.","properties":{"clientOrderId":{"type":"string","nullable":true,"description":"Client-supplied order identifier."},"orderId":{"type":"string","nullable":true,"description":"Order identifier assigned by the OMS."},"orderStatus":{"type":"string","nullable":true,"description":"Status of the order."},"executionType":{"type":"string","nullable":true,"description":"Execution type of the order."}}},"transactionType":{"type":"string","nullable":true,"description":"Broader transaction category (Trade, Cash, Position)."},"transactionCategory":{"type":"string","nullable":true,"description":"Transaction category (e.g., CASH, FEE, JNLC, JNLM, JNLS, TRADE)."},"normalizedTransactionType":{"type":"string","nullable":true,"description":"Normalized transaction type."},"transactionStatus":{"type":"string","enum":["NEW","CANCEL","REVISION"],"nullable":true,"description":"State of the transaction record.","x-enumDescriptions":{"NEW":"A new transaction record.","CANCEL":"The transaction was canceled.","REVISION":"A revision to a prior transaction record."}},"transactionTypeId":{"type":"string","nullable":true,"description":"ID linked to TransactionType table."},"side":{"type":"string","nullable":true,"description":"Transaction side (B, S, BC, SS, CR, DR, etc.)."},"openClose":{"type":"string","nullable":true,"enum":["O","C"],"description":"Open/close indicator for options transactions.","x-enumDescriptions":{"O":"Open.","C":"Close."}},"solicited":{"type":"boolean","nullable":true,"description":"Whether the transaction was solicited."},"discretionary":{"type":"boolean","nullable":true,"description":"Whether the transaction was discretionary."},"instrumentId":{"type":"string","format":"uuid","nullable":true,"description":"Unique instrument identifier of the traded security."},"assetClass":{"type":"string","nullable":true,"description":"Asset class of the traded security."},"quantity":{"type":"number","nullable":true,"description":"Quantity of this trade execution; up to 8 decimal places."},"price":{"type":"number","nullable":true,"description":"Price of this trade execution."},"priceType":{"type":"string","nullable":true,"description":"Price type (e.g., U=unit, P=percent)."},"factor":{"type":"integer","nullable":true,"description":"Trade factor."},"accruedInterest":{"type":"integer","nullable":true,"description":"Accrued interest for the transaction."},"grossAmount":{"type":"number","nullable":true,"description":"Gross amount of the trade."},"netAmount":{"type":"number","nullable":true,"description":"Net amount of all trades in this order."},"salesCredit":{"type":"number","nullable":true,"description":"Sales credit amount."},"miscFees":{"type":"array","description":"Array of miscellaneous fees.","items":{"$ref":"#/components/schemas/TransactionsCharges"}},"commission":{"type":"array","nullable":true,"description":"Array of commissions charged.","items":{"$ref":"#/components/schemas/TransactionsCharges"}},"currency":{"type":"string","nullable":true,"description":"Three-character currency code."},"fXRate":{"type":"number","nullable":true,"description":"Foreign exchange rate applied to the transaction."},"fXRateType":{"type":"string","nullable":true,"description":"Foreign exchange rate type (e.g., M=market, D=direct)."},"settlementCurrency":{"type":"string","nullable":true,"description":"Settlement currency, populated for fixed income trades."},"dispositionLots":{"type":"array","nullable":true,"description":"Array of disposition lot details.","items":{"$ref":"#/components/schemas/DispositionLotsDetails"}},"description1":{"type":"string","nullable":true,"description":"First description line for the transaction."},"description2":{"type":"string","nullable":true,"description":"Second description line for the transaction."},"yield":{"type":"object","nullable":true,"description":"Yield details, populated for fixed income trades.","properties":{"yield":{"type":"number","nullable":true,"description":"Yield of the transaction."},"yieldToMaturity":{"type":"number","nullable":true,"description":"Yield to maturity."},"yieldToWorst":{"type":"number","nullable":true,"description":"Yield to worst."}}},"tradeLegRefId":{"type":"integer","nullable":true,"description":"Reference ID linking legs of a multi-leg options trade."},"linkTransactionId":{"type":"string","nullable":true,"description":"Identifier linking related transactions."},"disclosureCode":{"type":"string","nullable":true,"description":"Disclosure code associated with the transaction."},"pMPPrice":{"type":"number","nullable":true,"description":"Prior market price."},"positionType":{"type":"string","nullable":true,"description":"Type of the position"}}},"TransactionV2ResponseWithUserID":{"allOf":[{"$ref":"#/components/schemas/TransactionV2Response"},{"type":"object","properties":{"userID":{"$ref":"#/components/schemas/userID"}}}]},"PaginatedTransactionResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransactionV2Response"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":false,"description":"Indicates whether more pages are available."}}}}},"PaginatedUserTransactionResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransactionV2ResponseWithUserID"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"example":"123e4567-e89b-12d3-a456-426614174000.1234567890123#123e4567-e89b-12d3-a456-000000000001.2023-12-07T21:17:45.743Z","description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":false,"description":"Indicates whether more pages are available."}}}}},"OptionsPositionSearchRequest":{"type":"object","properties":{"accountIDs":{"type":"array","description":"List of account identifiers to search. Only one of accountIDs or partnerIDs should be provided.","items":{"type":"string"}},"partnerIDs":{"type":"array","description":"List of partner identifiers to search. Only one of partnerIDs or accountIDs should be provided.","items":{"type":"string"}},"filters":{"$ref":"#/components/schemas/OptionsPositionFilters"}}},"OptionsPositionFilters":{"type":"object","properties":{"expirationDate":{"type":"string","format":"date","description":"Filter positions by option expiration date (YYYY-MM-DD).","example":"2026-08-15"},"rootSymbol":{"type":"string","description":"Filter positions by root symbol (underlying symbol for options).","example":"SPY"},"osiSymbol":{"type":"string","description":"Filter positions by OCC option symbology.","example":"SPY260815C00550000"}}},"OptionsAccountPositionResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OptionsAccountPositionItem"}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":false,"description":"Indicates whether more pages are available."}}}}},"OptionsLiquidationRiskResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accountID":{"type":"string","description":"Account identifier."},"accountNo":{"type":"string","description":"Account number."},"buyingPower":{"type":"object","properties":{"currency":{"type":"string","description":"ISO currency code.","example":"USD"},"amount":{"type":"number","description":"Buying power amount (may be negative).","example":-450.25}}},"symbol":{"type":"string","description":"OCC option symbology.","example":"SPY260815C00550000"},"positionToClose":{"type":"integer","description":"Quantity of option contracts to close.","example":10}}}},"page":{"type":"object","properties":{"nextCursor":{"type":"string","nullable":true,"description":"Opaque cursor for the next page; null if no more results."},"hasMore":{"type":"boolean","example":false,"description":"Indicates whether more pages are available."}}}}}},"parameters":{"fromParams":{"in":"query","name":"from","schema":{"type":"string"},"required":false,"example":"2022-06-16","description":"The date to start the filter."},"toParams":{"in":"query","name":"to","schema":{"type":"string"},"required":false,"example":"2022-07-16","description":"The date to end the filter."}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"dwAppKey":{"type":"apiKey","in":"header","name":"dw-client-app-key"},"sessionToken":{"type":"apiKey","in":"header","name":"dw-auth-token"}}}}