Corgi BankDocumentation
OpenAPI

The Custody Position Snapshot object

Immutable dated customer securities and actual cash source, separate from bank assets and insured deposits.

Attributes

actorstringRequired
captured_atstring · date-timeRequired
content_sha256stringRequired
idstringRequired
snapshotobjectRequired
9 child attributes
blockersarray of stringsRequired
captured_atstring · date-timeRequired
distributionsarray of objectsRequired
3 child attributes
blockersarray of stringsRequired
cashobject or nullOptional

CashObservation 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_keystringRequired
committed_atstring · date-timeRequired
journalobjectRequired

Journal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_sha256stringRequired
posting_datestring · dateRequired

A business date, YYYY-MM-DD

distributionobjectRequired
12 child attributes
accounting_plan_sha256stringOptional
accounting_plansarray of objectsOptional
actorstringRequired
created_atstring · date-timeRequired
exceptionsarray of stringsRequired
idstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

receiptobjectRequired

Distribution is actual external cash evidence. Neither a forecast dividend nor a reached Treasury maturity date authorizes a customer credit.

request_sha256stringRequired
resolutionsarray of objectsOptional
statusstringRequired
master_cash_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

observation_datestring · dateRequired

A business date, YYYY-MM-DD

ordersarray of objectsRequired
4 child attributes
blockersarray of stringsRequired
cashobject or nullOptional

CashObservation 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_keystringRequired
committed_atstring · date-timeRequired
journalobjectRequired

Journal excludes ledger-assigned identity/time and separately authenticated actors. Entry order is part of the instruction, matching the ledger replay fingerprint.

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_sha256stringRequired
posting_datestring · dateRequired

A business date, YYYY-MM-DD

orderobjectRequired
26 child attributes
accounting_plan_sha256stringOptional
accounting_plansarray of objectsOptional
actorstringRequired
cash_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired
custody_accountobjectRequired
customer_hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decisionobject or nullOptional
exceptionsarray of stringsRequired
executionobject or nullOptional
idstringRequired
instructionobject or nullOptional

Instruction is the bank's immutable, independently reviewed command. Signed execution and settlement evidence attest its exact digest; an ACK is no fill.

instrumentobjectRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

lot_idstringOptional
lot_revisionintegerOptional
posting_datestring · date or nullOptional

A business date, YYYY-MM-DD

programobjectRequired
requestobjectRequired
request_sha256stringRequired
resolutionsarray of objectsOptional
screening_atstring · date-time or nullOptional
screening_idsarray of stringsOptional
settlementobject or nullOptional
sourceobjectRequired
statusstringRequired
reserved_cash_amountintegerRequired
positionsarray of objectsRequired
7 child attributes
accrued_income_amountinteger or nullOptional
actual_unitsintegerRequired
blockersarray of stringsRequired
lotobjectRequired
24 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

acquired_datestring · dateRequired

A business date, YYYY-MM-DD

actual_proceeds_amountinteger or nullOptional
disposal_distribution_idstringOptional
disposal_order_idstringOptional
exceptionsarray of stringsRequired
external_account_referencestringRequired
idstringRequired
instrumentobjectRequired
instrument_idstringRequired
journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

latest_observationobject or nullOptional
original_cost_amountintegerRequired

Actual BUY net cash, including fees

owner_idstringRequired
programobjectRequired
purchase_order_idstringRequired
reservation_revisionintegerOptional
reserved_distribution_idstringOptional
reserved_order_idstringOptional
revisionintegerRequired
settlement_sha256stringRequired
statusstringRequired

Active, selling, maturing, sold, matured, exception

tax_basis_amountinteger or nullOptional

Unknown unless actual custody source supplies it

unitsintegerRequired

Original whole-lot quantity; never mutated by a sale

market_value_amountinteger or nullOptional
tax_basis_amountinteger or nullOptional
values_as_ofstring · date or nullOptional

A business date, YYYY-MM-DD

readybooleanRequired
source_sha256stringRequired

to move to open esc to close