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

instrumentId
string

Only this instrument's records.

at
integer<int64>

The ledger offset to read at, instead of the latest; not with asOf. What depends on time is judged at the offset's ledger time.

asOf
string<date-time>

An instant to read the ledger as it stood then; not with at. What depends on time is judged at that instant.

limit
integer<int32>

The most records a page holds, 1 to 1000; absent, every record.

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

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

Response

The consents, live then proposed.

offset
integer<int64>
required

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

ledgerTime
string | null
required

The ledger time of offset: the effective time of the latest transaction at or before it; null where the projection records none.

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.