Values - NodeAsset

A field that takes one of a set of values names the set here. Every value is a string in lowercase kebab-case; an operation kind and an event type join two such words with a dot, such as settlement.start. A closed set gains no value within /v1; an extensible one may, and a client treats a value it does not know as unknown. A request takes only the listed values: another is 400, its field named in errors. A filter on a value takes several by repeating the parameter, such as ?state=claimed&state=priced. Sets: AdmissionConsentProposalKind · AdmissionState · AllocationLeg · AllocationSide · AmendmentState · ApprovalState · AttributeState · ClaimTopic · CredentialIssuerKind · DealingCycleState · DistributionFrequency · DistributionLineState · DistributionPeriodState · DistributionRollState · DistributionState · EventKind · EventType · ForcedMoveGrounds · HoldState · HolderState · InvestorType · IssuerPowersConsentState · LockAgreementState · LockKind · MovementKind · NavFeedState · OperationKind · OperationState · ParticipantPermission · PolicyChange · PolicyTermsSource · PolicyVersionState · PrecheckAct · PricePinKind · PrimaryMarketState · ProposalKind · RateChangeRule · ReconciliationTrigger · ReconciliationVerdict · RedemptionOrderState · RedemptionState · RegisterLineKind · ReserveOrderState · ReserveState · ResourceKind · ResponseFormat · RestrictionMode · RestrictionReason · RestrictionState · Role · ScreeningState · SeriesInterval · SeriesMetric · SeriesUnit · SortOrder · StandingApprovalState · StandingSettlementKind · StandingSettlementState · StatementKind · SubscriptionOrderState · SubscriptionState · SupplyProposalKind · ValuationMode · WebhookSource · Weekday.

AdmissionConsentProposalKind

What the venue’s proposal to an admission consent proposes. Extensible: a value may be added within /v1.

Value	Meaning
`opening`	The admission consent itself, on the policy’s eligibility terms.
`terms`	New terms for the live admission consent.

Used by AdmissionConsentProposalView.kind.

AdmissionState

Where a holder stands with one instrument. Extensible: a value may be added within /v1.

Value	Meaning
`not-offered`	Neither a credential nor an open offer from the venue.
`offered`	The venue’s offer is open, awaiting the holder’s accept.
`admitted`	A credential of the issuer the configuration requires is live: the venue’s, or the register keeper’s.
`expired`	That credential lapsed; an open re-offer, if any, is in `offerCid`.

Used by AdmissionView.state, RegisterLine.admission.

AllocationLeg

One of an order’s two allocations in a dealing cycle. Extensible: a value may be added within /v1.

Value	Meaning
`fund`	The fund’s units: their receipt for a subscription, the units sent for a redemption.
`payment`	The payment asset: the payment for a subscription, the payout’s receipt for a redemption.

Used by SubscriptionSettleResult.awaiting[], RedemptionSettleResult.awaiting[], DealingCycleAwaitedOrder.missing[], StandingSettlementSettleResult.awaiting[], DealingCycleOrder.allocated[].

AllocationSide

Which side of a leg an allocation request asks the holder’s custodian to allocate. Extensible: a value may be added within /v1.

Value	Meaning
`sender`	The holder sends the instrument.
`receiver`	The holder receives the instrument.

Used by AllocationRequestSide.side.

AmendmentState

Where an amendment of a reserve’s terms stands. Extensible: a value may be added within /v1.

Value	Meaning
`proposed`	The venue proposed the terms; the issuer has not decided.
`accepted`	The issuer accepted them: they are a version of the terms, in effect or pending.
`rejected`	The issuer rejected them.
`withdrawn`	The venue withdrew them before the issuer decided.

Used by AmendmentView.state, GET /v1/reserves/{reserveId}/amendments ?state[].

ApprovalState

Where a four-eyes action stands. Extensible: a value may be added within /v1.

Value	Meaning
`awaiting`	Recorded on its maker’s call, and waiting for its approvers.
`approved`	Its last approver signed it, and it ran as an operation.
`rejected`	An approver rejected it, or its maker withdrew it; the same request is refused from now on.

Used by WriteAnswer.state, AwaitingApprovalView.state, ApprovalView.state, ApprovalRequestedWebhook.payload.state, ApprovalSignedWebhook.payload.state, ApprovalApprovedWebhook.payload.state, ApprovalRejectedWebhook.payload.state, GET /v1/approvals ?state[].

AttributeState

Where an eligibility attribute stands, as the caller that recorded it asserts. Extensible: a value may be added within /v1.

Value	Meaning
`pending`	Not verified yet; it makes no claim.
`verified`	Verified against its evidence; while unexpired, it becomes a claim.
`rejected`	Its evidence did not verify; it makes no claim.

Used by HolderAttribute.state.

ClaimTopic

An eligibility topic an admission may require. Extensible: a value may be added within /v1.

Value	Meaning
`residency`	Where the holder resides, an ISO 3166-1 alpha-2 country code.
`investor-type`	The holder’s investor type.
`accreditation`	The holder’s accreditation, a code with its expiry.

Used by InstrumentBody.requires[], AdmissionTerms.requires[], EligibilityTerms.requires[].

CredentialIssuerKind

Whose isHolderOf credential an instrument’s configuration requires. Extensible: a value may be added within /v1.

Value	Meaning
`venue`	The venue’s own, created by its offer and the holder’s accept.
`register-keeper`	The register keeper’s own, issued and held by it under its admission consent; the holder accepts nothing.

Used by AdmissionConsentView.credentialIssuerKind.

DealingCycleState

Where a dealing cycle stands: open, or ended. Extensible: a value may be added within /v1.

Value	Meaning
`awaiting-allocations`	Some order’s two allocations are not on the ledger as the cycle asked them yet.
`allocated`	Every order’s two allocations are on the ledger as the cycle asked them, so it settles.
`settled`	Its orders settled in one transaction; `endedAt` and `endedUpdateId` say when and where.
`released`	The venue released it: its orders are free to settle alone or in another cycle.

Used by DealingCycleSettleResult.state, DealingCycleView.state, GET /v1/dealing-cycles ?state[].

DistributionFrequency

How often an instrument distributes; periods are calendar periods, UTC. Extensible: a value may be added within /v1.

Value	Meaning
`monthly`	Every calendar month.
`quarterly`	Every three months: a record date in the last month of each calendar quarter.
`semiannual`	Every six months: a record date in the sixth and the twelfth month of the year.
`annual`	Every year: a record date in its twelfth month.

Used by DistributionCalendar.frequency, DistributionDate.frequency.

DistributionLineState

Where one line of a distribution’s payment stands. Extensible: a value may be added within /v1.

Value	Meaning
`unpaid`	Reconciliation has not seen the Registrar mint the line’s payout yet.
`paid`	Reconciliation saw the Registrar mint the line’s payout; the roll has not charged it to the holder’s row yet.
`rolled`	The roll charged the line to the holder’s row; nothing is left to do for it.

Used by DistributionLine.state, DistributionExportLine.state.

DistributionPeriodState

Where one calendar month with an oracle point stands. Extensible: a value may be added within /v1.

Value	Meaning
`open`	The latest month with a point: it still accrues and is not distributed.
`distributed`	A distribution was executed for it; `distributionState` says where that stands.
`undistributed`	An earlier month that was not distributed.

Used by DistributionPeriodView.state.

DistributionRollState

What a roll found for one line of a distribution’s plan. Extensible: a value may be added within /v1.

Value	Meaning
`pending`	The Registrar has not delivered the line; the next roll looks again.
`mismatch`	The holder’s holdings differ from its row by something other than the payout; nothing was touched.
`no-row`	No active holder row for the account.
`already-rolled`	An earlier roll, or the Registrar’s own script, charged the line already.
`rolled`	The roll charged the line to the holder’s row.
`duplicate`	The command was submitted already; the ledger kept the first.
`rejected`	The ledger refused the roll’s command.
`exceeds-accrued`	The row’s accrual is less than the line charges; nothing was touched.
`no-point`	No oracle point to roll the row at.

Used by DistributionRollLine.state.

DistributionState

Where an executed distribution stands. Extensible: a value may be added within /v1.

Value	Meaning
`awaiting-administrator`	Rebased, and waiting for the fund administrator’s distribution list to agree with its plan.
`payable`	The Registrar may pay its lines, and the roll may charge them.
`held`	Its instrument is under a hold; nothing is paid or rolled until the hold is released.
`partial`	Some lines are rolled and some are not, or a rebase failed; rolling it again finishes it.
`paid`	Every line is paid and rolled.

Used by DistributionExecuteResult.state, DistributionRollResult.state, DistributionView.state, DistributionExport.state, DistributionPeriodView.distributionState, DistributionDate.distributionState, TaxLine.state, GET /v1/distributions ?state[].

EventKind

Which feed an event belongs to. Extensible: a value may be added within /v1.

Value	Meaning
`journal`	A fact of the ledger, read from the projection.
`control`	An event the engine announces, which a webhook may receive: its own act, or a step of a settlement or an order it follows.

Used by Event.kind, GET /v1/events ?kind[].

EventType

What an event announces: the record and what happened to it, <record>.<event>. Extensible: a value may be added within /v1.

Value	Meaning
`reconciliation.run`	A reconciliation run finished, with its verdict.
`reconciliation.finding`	A reconciliation run made findings.
`reconciliation.hold`	Reconciliation held an instrument on a blocking finding.
`hold.released`	An instrument hold was released.
`statement.received`	An external statement arrived and was stored.
`statement.overdue`	A source’s statement became overdue.
`distribution.payable`	A distribution became payable.
`distribution.held`	A distribution was held, its instrument under a hold.
`distribution.paid`	A distribution was paid: every line delivered is rolled.
`holder.restricted`	A holder was restricted, or a recovery carried a restriction to its successor.
`holder.unrestricted`	A holder’s restriction was lifted.
`holder.forced-transfer`	A consenting holder’s units moved under a cited order.
`holder.recovered`	A consenting holder’s units moved to its registered successor.
`instrument.paused`	An instrument was paused.
`distribution.rate-changed`	A period whose withholding rate changed executed at the latest rate.
`distribution.carried`	A period executed with holders left out, whose earlier line is not rolled.
`distribution.due`	A scheduled record date passed with no distribution of its period.
`standing-approval.granted`	A standing approval was granted.
`standing-approval.revoked`	A standing approval was revoked.
`reserve.minted`	A mint against a reserve settled.
`reserve.redeemed`	A redemption from a reserve settled.
`reserve.cover-low`	Reconciliation found a reserve’s cover below its minimum, and held its backed instrument.
`reserve.reported`	The ledger computed a reserve’s report.
`reserve.amended`	The issuer accepted new terms for a reserve.
`retention.pruned`	Retention deleted records past their retention period.
`operation.succeeded`	An operation finished `succeeded`.
`operation.failed`	An operation finished `failed`.
`approval.requested`	A four-eyes action was recorded, and awaits an approver.
`approval.signed`	An approver signed an action that needs two.
`approval.approved`	A four-eyes action was approved, and ran.
`approval.rejected`	A four-eyes action was rejected, or withdrawn by its maker.
`subscription.priced`	A subscription’s attestors priced it: its lot was created on the ledger.
`subscription.delivered`	A subscription was delivered, its units minted to the holder.
`subscription.ended`	A subscription ended: its lot closed, or its claim was withdrawn.
`redemption.priced`	The fund’s oracle priced a redemption claim.
`redemption.funded`	The holder’s custodian requested the burn of a redemption’s units.
`redemption.burned`	The Registrar accepted a redemption’s burn request.
`redemption.settled`	The venue settled a redemption.
`redemption.withdrawn`	The venue withdrew a redemption claim before it settled.
`dealing-cycle.settled`	A dealing cycle settled its orders in one transaction.
`dealing-cycle.released`	The venue released a dealing cycle.
`webhook.test`	A test delivery, `POST /v1/webhooks/{webhookId}:test`; never in the feed.
`settlement.proposed`	A settlement intent was created on the ledger.
`price.point`	The oracle published a NAV point.
`subscription.created`	A subscription was priced into a record on the ledger.
`admission.offered`	The venue offered a holder an admission credential.
`admission.granted`	A holder was admitted: the venue’s credential was issued on its accept, or the register keeper’s under its admission consent.

Used by WebhooksStatusView.types[], WebhookStatusView.events[], WebhookOutboxView.lastDeliveredType, WebhookOutboxView.lastErrorType, Event.type, WebhookView.events[], WebhookBody.events[], ReconciliationRunWebhook.type, ReconciliationFindingWebhook.type, ReconciliationHoldWebhook.type, HoldReleasedWebhook.type, StatementReceivedWebhook.type, StatementOverdueWebhook.type, DistributionPayableWebhook.type, DistributionHeldWebhook.type, DistributionPaidWebhook.type, HolderRestrictedWebhook.type, HolderUnrestrictedWebhook.type, HolderForcedTransferWebhook.type, HolderRecoveredWebhook.type, InstrumentPausedWebhook.type, DistributionRateChangedWebhook.type, DistributionCarriedWebhook.type, DistributionDueWebhook.type, StandingApprovalGrantedWebhook.type, StandingApprovalRevokedWebhook.type, ReserveMintedWebhook.type, ReserveRedeemedWebhook.type, ReserveCoverLowWebhook.type, ReserveReportedWebhook.type, ReserveAmendedWebhook.type, RetentionPrunedWebhook.type, OperationSucceededWebhook.type, OperationFailedWebhook.type, ApprovalRequestedWebhook.type, ApprovalSignedWebhook.type, ApprovalApprovedWebhook.type, ApprovalRejectedWebhook.type, SubscriptionPricedWebhook.type, SubscriptionDeliveredWebhook.type, SubscriptionEndedWebhook.type, RedemptionPricedWebhook.type, RedemptionFundedWebhook.type, RedemptionBurnedWebhook.type, RedemptionSettledWebhook.type, RedemptionWithdrawnWebhook.type, DealingCycleSettledWebhook.type, DealingCycleReleasedWebhook.type, GET /v1/events ?type[].

ForcedMoveGrounds

Why a forced move moved a holder’s units. Extensible: a value may be added within /v1.

Value	Meaning
`forced-transfer`	A forced transfer carrying out an order.
`recovery`	A recovery to the same investor’s successor holder, on evidence that it is the same investor.

Used by IssuerPowerResult.kind, ForcedMoveView.grounds.

HoldState

Where an instrument hold stands. Extensible: a value may be added within /v1.

Value	Meaning
`open`	In effect: the instrument is not distributed.
`released`	Released under two approvers; the instrument may be distributed again.

Used by HoldView.state, GET /v1/holds ?state[].

HolderState

Where a holder stands. Extensible: a value may be added within /v1.

Value	Meaning
`active`	Registered and open: it may be admitted and take part in acts.
`closed`	Closed: it takes part in nothing more, and its id is not used again.

Used by HolderView.state.

InvestorType

An investor’s type, as its verified attribute states it. Extensible: a value may be added within /v1.

Value	Meaning
`retail`	An individual investor without professional standing.
`professional`	A professional or qualified investor.
`institutional`	An institution, such as a bank, an insurer or a fund.

Used by Policy.investorTypes[], EligibilityTerms.investorTypes[].

IssuerPowersConsentState

Where a holder’s consent to the issuer powers on one instrument stands. Extensible: a value may be added within /v1.

Value	Meaning
`offered`	The consent is offered, awaiting the holder’s signature.
`consented`	The holder consented: its units may be moved under the issuer powers.

Used by IssuerPowersConsentView.state.

LockAgreementState

Where a reserve’s lock agreement stands. Extensible: a value may be added within /v1.

Value	Meaning
`proposed`	The venue proposed the agreement; a party has not signed yet.
`live`	Every party signed: the reserve locks the asset through it.

Used by LockAgreementView.state.

LockKind

What holds a holder’s locked units. Extensible: a value may be added within /v1.

Value	Meaning
`allocation`	An allocation for a settlement, until it settles or is withdrawn.
`burn-request`	A burn request funding a redemption, until the Registrar burns or rejects it.
`other`	Any other lock, which its context names.

Used by HoldingLock.kind, LockedHolding.kind.

MovementKind

What moved an account’s units. Extensible: a value may be added within /v1.

Value	Meaning
`issue`	A mint against a reserve: the deposit locked into the reserve, or the backed units minted.
`retire`	A redemption from a reserve: the backed units burned, or the asset paid out of the reserve.
`subscription`	A subscription’s units were minted, or its payment moved: the Registrar’s mint, or its settlement against the payment asset.
`redemption`	A redemption’s units were burned, or its payout moved: the Registrar’s accept of a burn request, or its settlement against the payment asset.
`distribution`	A distribution’s payout reached the account.
`forced-transfer`	The venue moved a consenting holder’s units under a cited order.
`recovery`	The venue moved a consenting holder’s units to its registered successor.
`succession`	A holder’s units moved to its registered successor, or back, by a transfer of their own.
`transfer`	Units moved between two accounts by a transfer that no venue act explains.
`correction`	The Registrar burned units to remedy a reconciliation run’s finding.
`other`	Nothing the venue records explains the change.

Used by Movement.kind, GET /v1/instruments/{instrumentId}/movements ?kind[], GET /v1/holders/{holderId}/movements ?kind[].

NavFeedState

Whether an instrument may be priced from the fund administrator’s NAV feed. Extensible: a value may be added within /v1.

Value	Meaning
`live`	A source’s latest NAV is official and in date: the instrument may be priced.
`halted`	Pricing stops: a source pulled its ripcord, or its official NAV expired; `reasons` says which.
`no-statement`	No source has sent a NAV for the instrument yet.

Used by NavFeedView.state.

OperationKind

What an operation does: the record it acts on and the act, <record>.<verb>. Extensible: a value may be added within /v1.

Value	Meaning
`instrument.record`	Records an instrument in the manifest.
`policy.set`	Sets an instrument’s compliance policy whole.
`admission-consent.propose`	Proposes the register keeper’s admission consent, on the policy’s eligibility terms.
`instrument.pause`	Pauses an instrument: holds it.
`holder.register`	Registers a holder.
`holder.onboard`	Onboards a holder whose KYC ran outside the venue.
`holder.close`	Closes a holder.
`holder.register-successor`	Registers a holder’s successor, under its new custodian.
`holder.set-attributes`	Sets a holder’s eligibility attributes whole.
`admission.offer`	Offers a holder an admission to an instrument, or re-issues one; under the register keeper’s admission consent, admits it.
`admission.withdraw`	Withdraws a holder’s admission to an instrument.
`accepted-terms.accept`	Records a holder’s acceptance of a tenant’s terms.
`subscription.claim`	Claims a subscription to a fund.
`subscription.withdraw`	Withdraws a subscription’s claim.
`subscription.deliver`	Delivers a priced subscription against the Registrar’s mint.
`subscription.settle`	Settles a priced subscription against the payment asset.
`subscription.release`	Releases a subscription’s stuck order.
`primary-market.propose`	Proposes a fund’s consent to a primary market paid on the ledger.
`redemption.claim`	Claims a holder’s redemption.
`redemption.withdraw`	Withdraws a redemption’s claim.
`redemption.release`	Releases a redemption’s stuck order.
`redemption.settle`	Settles a redemption.
`dealing-cycle.open`	Opens a dealing cycle.
`dealing-cycle.settle`	Settles a dealing cycle.
`dealing-cycle.release`	Releases a dealing cycle’s orders.
`standing-settlement.open`	Opens a sweep or a liquidity pool.
`standing-settlement.settle`	Settles one iteration of a standing settlement.
`standing-settlement.pause`	Pauses a standing settlement.
`standing-settlement.resume`	Resumes a standing settlement.
`standing-settlement.close`	Closes a standing settlement.
`reserve.propose`	Proposes a backed instrument’s reserve, to its issuer and its holder.
`reserve.close`	Closes a reserve with nothing outstanding.
`lock-agreement.propose`	Proposes a reserve’s lock agreement, to another registrar.
`lock-agreement.release`	Releases a reserve’s lock agreement, or withdraws one still proposed.
`mint.start`	Starts a mint against a reserve.
`mint.cancel`	Cancels a mint that has not settled.
`reserve-redemption.start`	Starts a redemption from a reserve.
`reserve-redemption.cancel`	Cancels a redemption from a reserve that has not settled.
`reserve-report.create`	Has the ledger compute a reserve’s report.
`amendment.propose`	Proposes new terms for a reserve, to its issuer.
`amendment.withdraw`	Withdraws an amendment its issuer has not decided.
`provision-settlement.propose`	Proposes a settlement of a period’s provisions, to its attestors.
`distribution.execute`	Executes a distribution: freezes its plan.
`distribution.roll`	Rolls the lines of a distribution the Registrar paid.
`standing-approval.grant`	Grants a standing approval.
`standing-approval.revoke`	Revokes a standing approval.
`holder.restrict`	Restricts a holder.
`holder.restrict-batch`	Restricts several holders of one instrument at once.
`restriction.lift`	Lifts a holder’s restriction.
`issuer-powers-agreement.propose`	Proposes the issuer-powers agreement, to the Registrar.
`issuer-powers-consent.offer`	Offers a holder the issuer-powers consent on an instrument.
`holder.force-transfer`	Forces a transfer of a consenting holder’s units, citing an order.
`holder.recover`	Recovers a consenting holder’s units to its registered successor.
`instrument.force-transfer`	Forces several transfers on one instrument at once.
`instrument.recover`	Recovers several holders on one instrument at once.
`hold.release`	Releases an instrument hold.
`external-account.map`	Maps an external source’s account to a holder, a lock or the Registrar.
`webhook.register`	Registers a webhook.
`webhook.remove`	Removes a webhook.
`webhook.test`	Sends a webhook one signed test delivery.

Used by WriteAnswer.kind, OperationView.kind, ApprovalView.kind, StandingApprovalView.action, StandingApprovalBody.action, StandingApprovalGrantedWebhook.payload.action, OperationSucceededWebhook.payload.kind, OperationFailedWebhook.payload.kind, ApprovalRequestedWebhook.payload.kind, ApprovalSignedWebhook.payload.kind, ApprovalApprovedWebhook.payload.kind, ApprovalRejectedWebhook.payload.kind, GET /v1/approvals ?kind[], GET /v1/operations ?kind[].

OperationState

Where an operation stands. Extensible: a value may be added within /v1.

Value	Meaning
`queued`	Opened, and waiting for a worker; nothing has gone to the ledger yet.
`running`	A worker is running it; its commands may be on their way to the ledger.
`succeeded`	It finished and did what it was asked; `result` says what it came to.
`failed`	It finished without doing what it was asked; `problem` says why.

Used by WriteAnswer.state, OperationView.state, AuditLogEntry.state, GET /v1/operations ?state[].

ParticipantPermission

A Canton node’s permission for the venue’s party on a synchronizer. Extensible: a value may be added within /v1.

Value	Meaning
`submission`	The Canton node submits and confirms for the party.
`confirmation`	The Canton node confirms for the party, and does not submit.
`observation`	The Canton node observes the party only.

Used by SynchronizerView.permission.

PolicyChange

Which way a policy version changes the policy before it. Extensible: a value may be added within /v1.

Value	Meaning
`tightening`	It lets less through: one approver, in effect at once.
`loosening`	It lets more through: two approvers and the timelock.

Used by PolicyVersionView.change.

PolicyTermsSource

Where the terms in effect come from. Extensible: a value may be added within /v1.

Value	Meaning
`policy`	A stored policy version.
`manifest`	The terms the manifest recorded with the instrument, before any policy version.

Used by PolicyTermsView.source.

PolicyVersionState

Where a stored policy version stands now. Extensible: a value may be added within /v1.

Value	Meaning
`pending`	Approved, and not in effect yet: its `effectiveAt`, a loosening’s timelock included, is ahead.
`in-effect`	The version in effect now.
`superseded`	A later version took effect first; this one never will.
`past`	It was in effect, and a later version took over.

Used by PolicyVersionView.state.

PrecheckAct

An act a precheck judges. Extensible: a value may be added within /v1.

Value	Meaning
`subscription`	New units credited to the holder.
`transfer`	Units moved from the holder to another, `toHolderId`.

Used by GET /v1/instruments/{instrumentId}/precheck ?act.

PricePinKind

What an instrument’s price is read from. Extensible: a value may be added within /v1.

Value	Meaning
`par`	Par, 1, read from no contract.
`oracle`	The oracle’s latest NAV point.

Used by PricePin.kind.

PrimaryMarketState

Where a fund’s consent to a primary market paid on the ledger stands. Extensible: a value may be added within /v1.

Value	Meaning
`proposed`	The venue proposed the consent; a party has not signed yet.
`live`	Every party signed; the venue settles the fund’s subscriptions and redemptions under it.

Used by PrimaryMarketView.state.

ProposalKind

What an open proposal of the venue’s proposes. Extensible: a value may be added within /v1.

Value	Meaning
`provision-settlement`	A settlement of a period’s provisions, to its attestors.
`subscription`	A subscription’s claim, to its oracle.

Used by ProposalView.kind, GET /v1/proposals ?kind[].

RateChangeRule

Whether a period whose withholding rate changed may execute under a standing approval. Extensible: a value may be added within /v1.

Value	Meaning
`refuse`	It does not execute under the grant.
`alert`	It executes at the latest rate, and the engine announces `distribution.rate-changed`.

Used by StandingApprovalView.rateChange, StandingApprovalBody.rateChange, StandingApprovalGrantedWebhook.payload.rateChange.

ReconciliationTrigger

What started a reconciliation run. Extensible: a value may be added within /v1.

Value	Meaning
`scheduled`	The engine’s schedule.
`on-demand`	A caller, by `POST /v1/reconciliation-runs`.
`statement`	An external statement’s arrival.
`standing-approval`	The calendar scheduler, before it executes a due period under a standing approval.

Used by ReconciliationReport.trigger, ReconciliationRunSummary.trigger, ReconciliationRunVerdict.trigger, ReconciliationRunWebhook.payload.trigger.

ReconciliationVerdict

What a reconciliation run, or one of its checks, found. Extensible: a value may be added within /v1.

Value	Meaning
`ok`	Every check ran and found nothing.
`finding`	A check found at least one discrepancy.
`not-checkable`	A check could not measure part of what it reads, and none found a discrepancy.

Used by ReconciliationReport.verdict, ReconciliationRunSummary.verdict, ReconciliationCheck.verdict, ReconciliationRunVerdict.verdict, ReconciliationRunWebhook.payload.verdict.

RedemptionOrderState

A redemption as an order, on a fund whose primary market is paid on the ledger. Extensible: a value may be added within /v1.

Value	Meaning
`claimed`	The claim is made; the investor has not allocated its units and the payment’s receipt.
`allocated`	The investor allocated its units and the payment’s receipt; the venue settles next.
`redeemed`	The units were burned and the payment paid, in one transaction.
`withdrawn`	The venue withdrew the claim before it settled.

Used by RedemptionSettleResult.orderState, RedemptionView.orderState.

RedemptionState

Where a redemption stands, from its claim to its settlement. Extensible: a value may be added within /v1.

Value	Meaning
`claimed`	The claim is on the ledger; the holder has not asked the Registrar to burn its units.
`funded`	The holder’s custodian asked the Registrar to burn the units, which are locked to the Registrar.
`burned`	The Registrar burned the units; the venue has not settled the claim.
`settled`	The venue settled it: after the burn, or against the payment asset in one transaction.
`withdrawn`	The venue withdrew the claim before it was funded.

Used by RedemptionSettleResult.state, RedemptionView.state, GET /v1/redemptions ?state[].

RegisterLineKind

Whose account a register’s line is. Extensible: a value may be added within /v1.

Value	Meaning
`holder`	A registered holder’s account.
`unregistered`	An account no registered holder names.
`registrar`	The Registrar’s own account, its treasury.

Used by RegisterLine.kind.

ReserveOrderState

Where a mint or a redemption against a reserve stands. Extensible: a value may be added within /v1.

Value	Meaning
`awaiting-allocations`	The intent and the ask are on the ledger; the holder has not allocated both legs yet.
`settling`	Both legs are allocated; the venue submitted the settlement.
`settled`	The ledger settled it: the deposit and the units moved, or the burn and the payout, in one transaction.
`failed`	It ended without settling: refused, declined, or past its deadline; its failure says why.
`cancelled`	The venue cancelled it before it settled.

Used by MintView.state, ReserveRedemptionView.state, GET /v1/reserves/{reserveId}/mints ?state[], GET /v1/reserves/{reserveId}/redemptions ?state[].

ReserveState

Where a reserve stands. Extensible: a value may be added within /v1.

Value	Meaning
`proposed`	The venue proposed the reserve; its issuer or its holder has not accepted yet.
`open`	Both accepted: the reserve mints and redeems.

Used by ReserveView.state.

ResourceKind

A kind of record an operation, an action or an event concerns. Extensible: a value may be added within /v1.

Value	Meaning
`instrument`	An instrument, `/v1/instruments/{id}`.
`holder`	A holder, `/v1/holders/{id}`.
`subscription`	A subscription, `/v1/subscriptions/{id}`.
`redemption`	A redemption, `/v1/redemptions/{id}`.
`dealing-cycle`	A dealing cycle, `/v1/dealing-cycles/{id}`.
`standing-settlement`	A standing settlement, `/v1/standing-settlements/{id}`.
`reserve`	A reserve, `/v1/reserves/{id}`.
`lock-agreement`	A reserve’s lock agreement, `<reserveId>/<assetId>`; no read of its own.
`mint`	A mint, `<reserveId>/<mintId>`, read at `/v1/reserves/{reserveId}/mints/{mintId}`.
`reserve-redemption`	A redemption from a reserve, `<reserveId>/<redemptionId>`, read under its reserve.
`amendment`	An amendment of a reserve’s terms, `<reserveId>/<amendmentId>`, read under its reserve.
`distribution`	A distribution, `/v1/distributions/{id}`.
`standing-approval`	A standing approval, `/v1/standing-approvals/{id}`.
`reconciliation-run`	A reconciliation run, `/v1/reconciliation-runs/{id}`.
`external-statement`	An external statement, `/v1/external-statements/{id}`.
`primary-market`	A fund’s consent to a primary market, by its instrument; no read of its own.
`restriction`	A holder’s restriction; no read of its own.
`hold`	An instrument hold; no read of its own.
`webhook`	A webhook; no read of its own.
`external-account`	An external source’s account mapping, `<externalSourceId>/<accountId>`; no read of its own.
`external-source`	An external source; no read of its own.
`issuer-powers-agreement`	The Registrar’s issuer-powers agreement; no read of its own.
`scheduled-distribution`	A period’s scheduled distribution, `<instrumentId>/<period>`; no read of its own.
`contract`	A ledger contract a journal event saw created, by its contract id.
`exercise`	A choice a journal event saw exercised, `<contractId>@<offset>`.

Used by ResourceRef.kind, DealingCycleOrderFigures.kind, DealingCycleAwaitedOrder.kind, DealingCycleOrder.kind, StandingSettlementIteration.kind, Event.resourceKind, ReconciliationRunWebhook.resourceKind, ReconciliationFindingWebhook.resourceKind, ReconciliationHoldWebhook.resourceKind, HoldReleasedWebhook.resourceKind, StatementReceivedWebhook.resourceKind, StatementOverdueWebhook.resourceKind, DistributionPayableWebhook.resourceKind, DistributionHeldWebhook.resourceKind, DistributionPaidWebhook.resourceKind, HolderRestrictedWebhook.resourceKind, HolderUnrestrictedWebhook.resourceKind, HolderForcedTransferWebhook.resourceKind, HolderRecoveredWebhook.resourceKind, InstrumentPausedWebhook.resourceKind, DistributionRateChangedWebhook.resourceKind, DistributionCarriedWebhook.resourceKind, DistributionDueWebhook.resourceKind, StandingApprovalGrantedWebhook.resourceKind, StandingApprovalRevokedWebhook.resourceKind, ReserveMintedWebhook.resourceKind, ReserveRedeemedWebhook.resourceKind, ReserveCoverLowWebhook.resourceKind, ReserveReportedWebhook.resourceKind, ReserveAmendedWebhook.resourceKind, OperationSucceededWebhook.resourceKind, OperationFailedWebhook.resourceKind, ApprovalRequestedWebhook.resourceKind, ApprovalSignedWebhook.resourceKind, ApprovalApprovedWebhook.resourceKind, ApprovalRejectedWebhook.resourceKind, SubscriptionPricedWebhook.resourceKind, SubscriptionDeliveredWebhook.resourceKind, SubscriptionEndedWebhook.resourceKind, RedemptionPricedWebhook.resourceKind, RedemptionFundedWebhook.resourceKind, RedemptionBurnedWebhook.resourceKind, RedemptionSettledWebhook.resourceKind, RedemptionWithdrawnWebhook.resourceKind, DealingCycleSettledWebhook.resourceKind, DealingCycleReleasedWebhook.resourceKind, GET /v1/approvals ?resourceKind[], GET /v1/operations ?resourceKind[], GET /v1/events ?resourceKind[].

ResponseFormat

The form a read answers in. Closed.

Value	Meaning
`json`	JSON, the read’s envelope.
`csv`	A CSV file.

Used by GET /v1/distributions/{distributionId}/export ?format, GET /v1/instruments/{instrumentId}/register ?format.

RestrictionMode

What a restriction stops. Extensible: a value may be added within /v1.

Value	Meaning
`freeze`	Refuses every act of the holder’s: admissions, subscriptions, transfers, redemptions and distributions.
`liquidate-only`	Lets the holder leave, redeeming, retiring and renewing the admission that needs, and refuses subscriptions and transfers.

Used by RestrictionView.mode, RestrictionBody.mode, BatchRestrictionBody.mode, HolderRestrictedWebhook.payload.mode, HolderUnrestrictedWebhook.payload.mode.

RestrictionReason

Why a holder is restricted. Extensible: a value may be added within /v1.

Value	Meaning
`sanctions`	A sanctions list names the holder.
`court-order`	A court ordered it; the restriction cites the order.
`regulator-order`	A regulator ordered it; the restriction cites the order.
`kyc-lapsed`	The holder’s KYC lapsed.
`credential-lapsed`	The holder’s credential lapsed.
`investigation`	An investigation of the holder is open.
`deceased`	The holder died.
`key-loss`	The holder lost its key.
`other`	Another reason, which the rationale states.

Used by RestrictionView.reason, RestrictionBody.reason, BatchRestrictionBody.reason, HolderRestrictedWebhook.payload.reason.

RestrictionState

Where a holder’s restriction stands. Extensible: a value may be added within /v1.

Value	Meaning
`active`	In effect: not lifted, and before its auto-release time.
`expired`	Its auto-release time passed, and it no longer applies; no call lifted it.
`lifted`	Lifted by `:lift`, under two approvers.

Used by RestrictionView.state, GET /v1/restrictions ?state[].

Role

A role a bearer may hold, as x-role-catalog lists it. Extensible: a value may be added within /v1.

Value	Meaning
`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.
`investor`	A holder, scoped to its own holder id by the holder claim.
`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.
`feed`	An off-ledger party’s records feed: posts its statements, reads nothing.
`registrar`	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.

Used by WriteAnswer.role, WriteAnswer.makerRole, OperationView.role, AwaitingApprovalView.makerRole, ApprovalView.makerRole, CallerView.roles[], HolderAttributeVersionView.makerRole, StandingApprovalView.makerRole, OperationSucceededWebhook.payload.role, OperationFailedWebhook.payload.role, ApprovalRequestedWebhook.payload.makerRole, ApprovalSignedWebhook.payload.makerRole, ApprovalApprovedWebhook.payload.makerRole, ApprovalRejectedWebhook.payload.makerRole.

ScreeningState

What a holder’s screening found. Extensible: a value may be added within /v1.

Value	Meaning
`clear`	No list matched the holder.
`potential-match`	A list may name the holder, and a person is reviewing it.
`confirmed-match`	A list names the holder.

Used by ScreeningRecord.state.

SeriesInterval

How far apart a series’ points are. Closed.

Value	Meaning
`change`	A point each time the figure changed.
`day`	A point a UTC day, the figure at the day’s end.

Used by SeriesView.interval, GET /v1/instruments/{instrumentId}/series ?interval.

SeriesMetric

A figure an instrument’s series reads. Extensible: a value may be added within /v1.

Value	Meaning
`supply`	The units in issue, from the Registry’s holdings.
`holders`	How many accounts hold the instrument, from the Registry’s holdings.
`nav`	The NAV per unit, from the oracle’s published points.

Used by SeriesView.metric, GET /v1/instruments/{instrumentId}/series ?metric.

SeriesUnit

What a series’ points count. Extensible: a value may be added within /v1.

Value	Meaning
`units`	Units of the instrument.
`count`	Accounts.
`price`	A price per unit.

Used by SeriesView.unit.

SortOrder

Which end of the feed a page starts from. Closed.

Value	Meaning
`asc`	Oldest first.
`desc`	Newest first.

Used by GET /v1/events ?order.

StandingApprovalState

Where a standing approval stands, as of the read. Extensible: a value may be added within /v1.

Value	Meaning
`live`	In force: the calendar scheduler executes the instrument’s due distributions under it, within its bounds.
`revoked`	Revoked; nothing more runs under it.
`lapsed`	Its `validUntil` passed; nothing more runs under it.

Used by StandingApprovalView.state.

StandingSettlementKind

What a standing settlement settles. Extensible: a value may be added within /v1.

Value	Meaning
`sweep`	An investor’s committed payment asset buys the fund, one subscription an iteration.
`liquidity-pool`	The treasury’s committed payment asset pays redemptions at once, one redemption an iteration.

Used by StandingSettlementSettleResult.kind, StandingSettlementView.kind, StandingSettlementBody.kind.

StandingSettlementState

Where a standing settlement stands. Extensible: a value may be added within /v1.

Value	Meaning
`awaiting-allocations`	A sweep’s investor has not committed its allocations yet.
`open`	Its committed allocation is live, and iterations settle against it.
`paused`	The venue paused it; no iteration settles until it resumes.
`spent`	Its committed allocation has ended; nothing more settles.
`closed`	It was closed; nothing more settles. `endedAt` and `endedUpdateId` say when and where.

Used by StandingSettlementView.state, GET /v1/standing-settlements ?state[].

StatementKind

What an external statement states. Extensible: a value may be added within /v1.

Value	Meaning
`distribution-list`	The fund administrator’s list of a period’s payouts, by account.
`register`	A register of holdings, by account.
`nav`	The fund administrator’s official NAV.
`withholding`	The tax withheld, by account.
`custody`	A custodian’s holdings, by account.

Used by CanonicalStatement.kind, ExternalStatementView.kind, ExternalSourceView.kind, StatementReceivedWebhook.payload.kind, GET /v1/external-statements ?kind[].

SubscriptionOrderState

A subscription as an order, on a fund whose primary market is paid on the ledger. Extensible: a value may be added within /v1.

Value	Meaning
`initiated`	Claimed or priced; the venue has not asked for the investor’s payment yet.
`awaiting-payment`	The venue’s allocation request is out; the investor’s allocations of the payment and of the units’ receipt are awaited.
`minted`	Paid and minted in one transaction.
`refunded`	It ended unsettled and nothing was paid; an allocation the investor made stays locked until its deadline, or until the venue cancels it.

Used by SubscriptionSettleResult.orderState, SubscriptionView.orderState.

SubscriptionState

Where a subscription stands, from its claim to its close. Extensible: a value may be added within /v1.

Value	Meaning
`claimed`	The claim is on the ledger; its oracle has not priced it.
`priced`	The oracle priced it at the applied NAV; its units are not delivered yet.
`delivered`	Its units were delivered, by the Registrar’s mint or in its settlement against the payment asset.
`closed`	It ended after it was priced: its attestors closed it, or its holder redeemed its last unit.
`withdrawn`	It ended before it was priced: the venue withdrew the claim, or its attestors rejected it.

Used by SubscriptionDeliverResult.state, SubscriptionSettleResult.state, SubscriptionView.state, SubscriptionEndedWebhook.payload.state, GET /v1/subscriptions ?state[].

SupplyProposalKind

What the venue’s proposal to a supply ledger proposes. Extensible: a value may be added within /v1.

Value	Meaning
`opening`	The supply ledger’s opening, with the units in issue as it opens.
`terms`	New terms for the open supply ledger.

Used by SupplyProposalView.kind.

ValuationMode

How an instrument carries value. Extensible: a value may be added within /v1.

Value	Meaning
`rebasing`	The unit count moves with the oracle’s NAV series; the price is 1.
`par`	The unit count and the price stay at 1: a claim on a reserve at par.
`accumulating`	The unit count stays; the price grows: the reserve’s share price, computed at each mint and redemption.

Used by InstrumentView.valuation, InstrumentBody.valuation, PriceView.mode, ReserveView.valuation.

WebhookSource

Where a webhook was made. Extensible: a value may be added within /v1.

Value	Meaning
`configuration`	The deployment’s configuration; the API does not change it.
`api`	`POST /v1/webhooks`.

Used by WebhookView.source.

Weekday

A day of the week, in a window’s time zone. Closed.

Value	Meaning
`monday`	Monday.
`tuesday`	Tuesday.
`wednesday`	Wednesday.
`thursday`	Thursday.
`friday`	Friday.
`saturday`	Saturday.
`sunday`	Sunday.

Used by Window.days[]. Related: Conventions · Problems

​AdmissionConsentProposalKind

​AdmissionState

​AllocationLeg

​AllocationSide

​AmendmentState

​ApprovalState

​AttributeState

​ClaimTopic

​CredentialIssuerKind

​DealingCycleState

​DistributionFrequency

​DistributionLineState

​DistributionPeriodState

​DistributionRollState

​DistributionState

​EventKind

​EventType

​ForcedMoveGrounds

​HoldState

​HolderState

​InvestorType

​IssuerPowersConsentState

​LockAgreementState

​LockKind

​MovementKind

​NavFeedState

​OperationKind

​OperationState

​ParticipantPermission

​PolicyChange

​PolicyTermsSource

​PolicyVersionState

​PrecheckAct

​PricePinKind

​PrimaryMarketState

​ProposalKind

​RateChangeRule

​ReconciliationTrigger

​ReconciliationVerdict

​RedemptionOrderState

​RedemptionState

​RegisterLineKind

​ReserveOrderState

​ReserveState

​ResourceKind

​ResponseFormat

​RestrictionMode

​RestrictionReason

​RestrictionState

​Role

​ScreeningState

​SeriesInterval

​SeriesMetric

​SeriesUnit

​SortOrder

​StandingApprovalState

​StandingSettlementKind

​StandingSettlementState

​StatementKind

​SubscriptionOrderState

​SubscriptionState

​SupplyProposalKind

​ValuationMode

​WebhookSource

​Weekday