Capture a bounded complete custody source with actual cash evidence and explicit exceptions
/investment-snapshotVerified staff/service with payments:investments:read or payments:investments:write captures the complete current source inventory and actual ledger evidence with immutable digests and explicit custody or cash exceptions. No customer all-book access. Original customer securities stay separate from deposits and bank-owned assets. A complete source above the bounded response size fails explicitly; evidence is never silently truncated or reconstructed as historical truth.
Returns
200 OK
blockersarray of stringsRequiredcaptured_atstring · date-timeRequireddistributionsarray of objectsRequired3 child attributes
blockersarray of stringsRequiredcashobject or nullOptionalCashObservation is a read of the actual ledger's immutable command digest and permanent claim, alongside its retained exact command. It is not broker cash.
6 child attributes
claim_keystringRequiredcommitted_atstring · date-timeRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
11 child attributes
adjusts_periodstringOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequiredkindstringRequiredprotected_command_idstringRequiredreasonstringOptionalrelease_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_sha256stringRequiredposting_datestring · dateRequiredA business date, YYYY-MM-DD
distributionobjectRequired12 child attributes
accounting_plan_sha256stringOptionalaccounting_plansarray of objectsOptional7 child attributes
correction_reasonstringOptionalcreated_atstring · date-timeRequiredevidence_sha256stringRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
journal_keystringRequiredjournal_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcreated_atstring · date-timeRequiredexceptionsarray of stringsRequiredidstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
posting_datestring · date or nullOptionalA business date, YYYY-MM-DD
receiptobjectRequiredDistribution is actual external cash evidence. Neither a forecast dividend nor a reached Treasury maturity date authorizes a customer credit.
27 child attributes
cash_evidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
cash_referencestringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequiredcustody_evidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
external_account_referencestringRequiredfee_amountintegerRequiredgross_amountintegerRequiredidstringRequiredkey_idstringRequiredkindstringRequiredCash_distribution or maturity
lot_idstringRequiredlot_revisionintegerRequirednet_cash_amountintegerRequiredobserved_atstring · date-timeRequiredoriginal_settlement_sha256stringRequiredowner_idstringRequiredpayment_datestring · dateRequiredA business date, YYYY-MM-DD
payment_referencestringRequiredrecord_datestring · dateRequiredA business date, YYYY-MM-DD
signaturestringRequiredtax_characterstringRequiredExplicit actual classification, including unknown
tax_evidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
unitsintegerRequiredOriginal full lot; distribution does not remove units
versionstringRequiredwithholding_amountintegerRequiredrequest_sha256stringRequiredresolutionsarray of objectsOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredstatusstringRequiredmaster_cash_ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
observation_datestring · dateRequiredA business date, YYYY-MM-DD
ordersarray of objectsRequired4 child attributes
blockersarray of stringsRequiredcashobject or nullOptionalCashObservation is a read of the actual ledger's immutable command digest and permanent claim, alongside its retained exact command. It is not broker cash.
6 child attributes
claim_keystringRequiredcommitted_atstring · date-timeRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
11 child attributes
adjusts_periodstringOptionaleffective_datestring · dateRequiredA business date, YYYY-MM-DD
entriesarray of objectsRequiredkindstringRequiredprotected_command_idstringRequiredreasonstringOptionalrelease_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
require_availablebooleanOptionalreversal_ofstringOptionalsource_refstringRequiredsource_servicestringRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
journal_sha256stringRequiredposting_datestring · dateRequiredA business date, YYYY-MM-DD
orderobjectRequired26 child attributes
accounting_plan_sha256stringOptionalaccounting_plansarray of objectsOptional7 child attributes
correction_reasonstringOptionalcreated_atstring · date-timeRequiredevidence_sha256stringRequiredjournalobjectRequiredJournal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.
journal_keystringRequiredjournal_sha256stringRequiredsupersedes_sha256stringOptionalactorstringRequiredcash_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredcustody_accountobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptionaldecisionobject or nullOptionalidstringRequiredinstrumentobject or nullOptionalkindstringRequiredprogramobject or nullOptionalcustomer_hold_idstringOptionalExample hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
decisionobject or nullOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredexceptionsarray of stringsRequiredexecutionobject or nullOptional29 child attributes
broker_referencestringRequiredconfirmationobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
confirmation_deliveryobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
confirmation_received_atstring · date-timeRequiredcounterpartystringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequireddelivered_atstring · date-timeRequireddelivery_methodstringRequireddelivery_recipient_idstringRequiredexecuted_atstring · date-timeRequiredexecution_referencestringRequiredexternal_account_referencestringRequiredfee_amountintegerRequiredinstruction_sha256stringRequiredkey_idstringRequirednet_cash_amountintegerRequiredobserved_atstring · date-timeRequiredorder_idstringRequiredowner_idstringRequiredpriceintegerRequiredprincipal_amountintegerRequiredsidestringRequiredsignaturestringRequiredstatusstringRequiredExecuted, cancelled, rejected; full fill only
trade_datestring · dateRequiredA business date, YYYY-MM-DD
unitsintegerRequiredversionstringRequiredidstringRequiredinstructionobject or nullOptionalInstruction is the bank's immutable, independently reviewed command. Signed execution and settlement evidence attest its exact digest; an ACK is no fill.
30 child attributes
broker_referencestringRequiredcash_limit_amountintegerRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequiredcustody_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
custody_account_sha256stringRequiredexternal_account_referencestringRequiredidstringRequiredinstrument_idstringRequiredinstrument_sha256stringRequiredissued_atstring · date-timeRequiredlimit_priceintegerRequiredlot_idstringOptionallot_revisionintegerOptionalmax_fee_amountintegerRequiredorder_idstringRequiredowner_idstringRequiredprice_scaleintegerRequiredprogram_idstringRequiredprogram_sha256stringRequiredrequest_sha256stringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sha256stringRequiredsidestringRequiredtrade_datestring · dateRequiredA business date, YYYY-MM-DD
unit_basisstringRequiredunit_scaleintegerRequiredunitsintegerRequiredversionstringRequiredinstrumentobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptionaldecisionobject or nullOptionalidstringRequiredinstrumentobject or nullOptionalkindstringRequiredprogramobject or nullOptionaljournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
lot_idstringOptionallot_revisionintegerOptionalposting_datestring · date or nullOptionalA business date, YYYY-MM-DD
programobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptionaldecisionobject or nullOptionalidstringRequiredinstrumentobject or nullOptionalkindstringRequiredprogramobject or nullOptionalrequestobjectRequired16 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
cash_limit_amountintegerRequiredBUY maximum total debit; SELL minimum net credit
currency_codestringRequiredcustody_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
disclosure_sha256stringRequiredinstrument_idstringRequiredinvestment_consentbooleanRequiredlimit_priceintegerRequiredlot_idstringOptionalmax_fee_amountintegerRequiredowner_idstringRequiredprogram_idstringRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
sidestringRequiredBUY or SELL
trade_datestring · dateRequiredA business date, YYYY-MM-DD
unitsintegerRequiredrequest_sha256stringRequiredresolutionsarray of objectsOptional5 child attributes
actorstringRequiredatstring · date-timeRequiredcontent_sha256stringRequireddecisionstringRequirednotestringRequiredscreening_atstring · date-time or nullOptionalscreening_idsarray of stringsOptionalsettlementobject or nullOptional25 child attributes
broker_referencestringRequiredcash_evidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
cash_referencestringRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequireddelivery_evidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
delivery_referencestringRequiredexecution_sha256stringRequiredexternal_account_referencestringRequiredfee_amountintegerRequiredinstruction_sha256stringRequiredkey_idstringRequirednet_cash_amountintegerRequiredobserved_atstring · date-timeRequiredorder_idstringRequiredowner_idstringRequiredprincipal_amountintegerRequiredsettled_atstring · date-timeRequiredsettlement_datestring · dateRequiredA business date, YYYY-MM-DD
settlement_referencestringRequiredsidestringRequiredsignaturestringRequiredunitsintegerRequiredversionstringRequiredsourceobjectRequired8 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
captured_atstring · date-timeRequiredcustody_ownershipobjectRequiredexternal_account_referencestringRequiredledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
owner_idstringRequiredownership_revisionintegerRequiredownership_sha256stringRequiredstatusstringRequiredreserved_cash_amountintegerRequiredpositionsarray of objectsRequired7 child attributes
accrued_income_amountinteger or nullOptionalactual_unitsintegerRequiredblockersarray of stringsRequiredlotobjectRequired24 child attributes
account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
acquired_datestring · dateRequiredA business date, YYYY-MM-DD
actual_proceeds_amountinteger or nullOptionaldisposal_distribution_idstringOptionaldisposal_order_idstringOptionalexceptionsarray of stringsRequiredexternal_account_referencestringRequiredidstringRequiredinstrumentobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptionaldecisionobject or nullOptionalidstringRequiredinstrumentobject or nullOptionalkindstringRequiredprogramobject or nullOptionalinstrument_idstringRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
latest_observationobject or nullOptional19 child attributes
accrued_income_amountinteger or nullOptionalas_ofstring · dateRequiredA business date, YYYY-MM-DD
close_out_completebooleanRequiredcurrency_codestringRequiredcusipstringRequiredcustodian_referencestringRequiredevidenceobjectRequiredDocument retains the actual external bytes, not a mutable reference alone.
external_account_referencestringRequiredkey_idstringRequiredlot_idstringRequiredmarket_value_amountinteger or nullOptionalobserved_atstring · date-timeRequiredoriginal_settlement_sha256stringRequiredowner_idstringRequiredpriceinteger or nullOptionalsignaturestringRequiredtax_basis_amountinteger or nullOptionalunitsintegerRequiredversionstringRequiredoriginal_cost_amountintegerRequiredActual BUY net cash, including fees
owner_idstringRequiredprogramobjectRequired9 child attributes
actorstringRequiredcontent_sha256stringRequiredcreated_atstring · date-timeRequiredcustody_accountobject or nullOptionaldecisionobject or nullOptionalidstringRequiredinstrumentobject or nullOptionalkindstringRequiredprogramobject or nullOptionalpurchase_order_idstringRequiredreservation_revisionintegerOptionalreserved_distribution_idstringOptionalreserved_order_idstringOptionalrevisionintegerRequiredsettlement_sha256stringRequiredstatusstringRequiredActive, selling, maturing, sold, matured, exception
tax_basis_amountinteger or nullOptionalUnknown unless actual custody source supplies it
unitsintegerRequiredOriginal whole-lot quantity; never mutated by a sale
market_value_amountinteger or nullOptionaltax_basis_amountinteger or nullOptionalvalues_as_ofstring · date or nullOptionalA business date, YYYY-MM-DD
readybooleanRequiredsource_sha256stringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503