GET
cURL
Roles: app, approver, auditor, operator, risk.

Authorizations

Authorization
string
header
required

A JWT from the deployment's identity provider, whose roles claim names the caller's roles and whose holder claim names an investor's holder.

Headers

X-Signature-Key
string

A signed request's key id, as venue.api.signing.clients configures it for the bearer's subject.

X-Signature-Timestamp
string

Seconds since the epoch, within venue.api.signing.window of the engine's clock, 5 minutes by default.

Pattern: ^[0-9]+$
X-Signature-Nonce
string

At least 16 random bytes in base64url, never reused within twice the window.

Required string length: 22 - 128
Pattern: ^[A-Za-z0-9_-]+={0,2}$
X-Signature
string

The base64 HMAC-SHA256, under the key's secret, of the method, the path and query, the timestamp, the nonce and the body's SHA-256.

X-Request-Id
string

Your id for this request, 1 to 128 printable characters, repeated in the answer; absent, the engine makes one.

Maximum string length: 128
Pattern: ^[\x21-\x7E]+$
traceparent
string

A W3C trace context, which the engine joins and passes on.

Pattern: ^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

Query Parameters

state
enum<string>[]

Only operations in these states; repeat it for several. Absent, every state.

Where an operation stands.

Available options:
queued,
running,
succeeded,
failed
kind
enum<string>[]

Only operations of these kinds; repeat it for several. Absent, every kind.

What an operation does: the record it acts on and the act, <record>.<verb>.

Available options:
instrument.record,
policy.set,
admission-consent.propose,
instrument.pause,
holder.register,
holder.onboard,
holder.close,
holder.register-successor,
holder.set-attributes,
admission.offer,
admission.withdraw,
accepted-terms.accept,
subscription.claim,
subscription.withdraw,
subscription.deliver,
subscription.settle,
subscription.release,
primary-market.propose,
redemption.claim,
redemption.withdraw,
redemption.release,
redemption.settle,
dealing-cycle.open,
dealing-cycle.settle,
dealing-cycle.release,
standing-settlement.open,
standing-settlement.settle,
standing-settlement.pause,
standing-settlement.resume,
standing-settlement.close,
reserve.propose,
reserve.close,
lock-agreement.propose,
lock-agreement.release,
mint.start,
mint.cancel,
reserve-redemption.start,
reserve-redemption.cancel,
reserve-report.create,
amendment.propose,
amendment.withdraw,
provision-settlement.propose,
distribution.execute,
distribution.roll,
standing-approval.grant,
standing-approval.revoke,
holder.restrict,
holder.restrict-batch,
restriction.lift,
issuer-powers-agreement.propose,
issuer-powers-consent.offer,
holder.force-transfer,
holder.recover,
instrument.force-transfer,
instrument.recover,
hold.release,
external-account.map,
webhook.register,
webhook.remove,
webhook.test
resourceKind
enum<string>[]

Only operations on these kinds of record; repeat it for several. Absent, every kind.

A kind of record an operation, an action or an event concerns.

Available options:
instrument,
holder,
subscription,
redemption,
dealing-cycle,
standing-settlement,
reserve,
lock-agreement,
mint,
reserve-redemption,
amendment,
distribution,
standing-approval,
reconciliation-run,
external-statement,
primary-market,
restriction,
hold,
webhook,
external-account,
external-source,
issuer-powers-agreement,
scheduled-distribution,
contract,
exercise
resourceId
string

Only operations on this record.

actor
string

Only operations this caller asked for, by its sub.

from
string<date-time>

Only operations opened at this instant or later, by createdAt.

to
string<date-time>

Only operations opened before this instant, by createdAt.

limit
integer<int32>

The most records a page holds, 1 to 1000; 50 by default.

Required range: 1 <= x <= 1000
after
string

The previous page's next; absent, the first page.

Response

The operations.

offset
integer<int64>
required

The ledger offset the answer was read at; 0 for an answer from the engine's own records.

now
string
required

The engine's clock when it answered, an ISO-8601 instant.

value
object[] | null
required

What the read answers; for a list, the page's records in the list's order.

next
string | null
required

The cursor for the next page, sent back as after; null on a list's last page, never on a feed.