Skip to main content
Developers

API

This page describes a design, not a live endpoint. Saying so is the point — an API reference for something you cannot call is worse than no page at all.

One transaction boundaryThree stacked elements — a record, a rule and a ledger posting — enclosed by a single boundary, indicating that all three commit together or not at all.ONE TRANSACTION BOUNDARYRecordwhat is trueRulewhat is permittedPostingwhat it did to the bookscommit together

What it changes

  1. Tenant-scoped credentialsEvery key belongs to a tenant, and the same isolation layers apply to an API request as to a session.
  2. Idempotency on every writeA retried request that creates a second payment is the failure that matters, so the key is required rather than optional.
  3. Errors that say what to doRefusals name what is missing and what can be done instead, in the same vocabulary the interface uses.
Ask, agree, then actThree steps. One person requests, a different person approves, and only then does the state change. The approval binds to what was requested, so editing it afterwards invalidates the sign-off.Requestone personApprovea different oneActnow it movesThe approval binds to what was asked.Edit it afterwards and the sign-off is void.
Every irreversible act on this platform takes this shape, whatever the subject of the page: one person asks, a different one agrees, and only then does anything move.

What it includes

ResourcesAssets, offerings, subscriptions, allocations, payments, holdings, transfers, distributions and redemptions.
Pagination and filteringStable cursors, because offset pagination over a moving register skips and repeats rows.
VersioningExplicit, with a deprecation policy rather than silent change.

See it against something real.

Bring an instrument you are actually considering. Structuring it is the only way to judge whether the model fits.

Your instrument, against this modelAn unspecified asset on the left feeds four stages: structure, compliance policy, the offering book and the register. The asset is drawn as an outline because it is the reader's, not the platform's.Your assetwhatever it isStructurePolicyBookRegister