Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The API’s roles, grouped by who holds them, and what each may read, write and approve in each business area.
POST /v1/approvals/{actionKey}:approve); own: an investor reaches only its own holder’s records.
| Role | What it is for |
|---|---|
operator | Day-to-day operations and setup: settlements, admissions and distributions; instruments, reserves and policies; provision settlements (the maker). |
approver | The checker half of every four-eyes action; never the maker of the same one. |
risk | Reconciliation on demand and the stops: pause an instrument alone, release a hold with two approvers. |
compliance | Interventions on a holder: freeze or liquidate-only at once; lift a restriction, force a transfer citing an order, or recover units to the registered successor citing evidence, each with two approvers. |
auditor | Read-only over everything, operations and control events included. |
| Business area | operator | approver | risk | compliance | auditor |
|---|---|---|---|---|---|
| Instruments | R M | R A | R | R | |
| Policies | R M | R A | R M | R | |
| Prices | R | R | R | R | |
| Holders | R W M | R A | R | R | R |
| Subscriptions | R W | R | R | R | |
| Redemptions | R W | R | R | R | |
| Dealing cycles | R W | R | R | R | |
| Reserves | R W M | R A | R W | R | |
| Standing settlements | R W M | R A | R W | R | |
| Distributions | R W M | R W A | R W | R | |
| Restrictions and issuer powers | R W M | R A | R W M | R W M | R |
| Holds and pauses | R | R A | R W M | R | |
| Reconciliation | R W M | R A | R W | R | |
| Approvals and operations | R W | R W | R W | R W | R |
| Reports | R | R | R | R | |
| Events | R W M | R A | R | R | |
| System | R | R | R | R | R |
| Role | What it is for |
|---|---|
app | An integrating application’s backend: settlements and reads for any holder, no control actions. |
monitor | Health and status for dashboards and on-call: health, the system status, the redacted reconciliation verdict, the feed’s control events redacted, and the audit log’s integrity; no report, statement, account, hold or journal event. |
| Business area | app | monitor |
|---|---|---|
| Instruments | R | |
| Policies | R | |
| Prices | R | |
| Holders | R W | |
| Subscriptions | R W | |
| Redemptions | R W | |
| Dealing cycles | R | |
| Reserves | R W | |
| Standing settlements | R W | |
| Distributions | R | |
| Restrictions and issuer powers | R | |
| Holds and pauses | R | |
| Reconciliation | R | R |
| Approvals and operations | R | R |
| Reports | R | |
| Events | R | R |
| System | R | R |
| Role | Kind | What it is for |
|---|---|---|
investor | Person | A holder, scoped to its own holder id by the holder claim. |
feed | Service | An off-ledger party’s records feed: posts its statements, reads nothing. |
registrar | Service | The Registrar’s own systems on its node: the parties the venue asks it to block on DA’s block list, and the distributions it pays, their frozen lines and their roll; nothing else. |
| Business area | investor | feed | registrar |
|---|---|---|---|
| Instruments | R | ||
| Policies | R own | ||
| Prices | R | ||
| Holders | R W own | ||
| Subscriptions | R own | ||
| Redemptions | R W own | ||
| Dealing cycles | |||
| Reserves | R W own | ||
| Standing settlements | |||
| Distributions | R | R | |
| Restrictions and issuer powers | R | ||
| Holds and pauses | |||
| Reconciliation | W | ||
| Approvals and operations | R own | ||
| Reports | R own | ||
| Events | |||
| System | R | R | R |
GET /v1/tenants/{tenantId}, GET /v1/health, GET /v1/openapi.json.
Related: Conventions · Duties and governance · Deployment patterns