POST
cURL
Roles: feed, 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

externalSourceId
string
required

The configured source the statement comes from.

instrumentId
string

The instrument, where the format does not name it or names several.

businessDate
string<date>

The business date, where the format does not carry it.

period
string

A distribution list's period, uuuu-MM, where the format does not carry it.

Body

A statement in the engine's own form, the JSON body of POST /v1/external-statements.

instrumentId
string
required

The instrument's id on the Registry, or an ISIN, CUSIP or FIGI the manifest records.

kind
enum<string>
required

What the statement states.

Available options:
distribution-list,
register,
nav,
withholding,
custody
businessDate
string
required

The business date, yyyy-MM-dd, in the source's zone.

asOf
string | null

The instant the ledger is compared at; absent, the business date's cut-off.

period
string | null

A distribution list's period, uuuu-MM.

reference
string | null

The source's own reference for the statement.

currency
string | null

The ISO 4217 currency.

totalQuantity
number | null

The statement's total quantity.

totalAmount
number | null

The statement's total amount.

lines
object[]

The statement's lines.

nav
object | null

A nav statement's figures; no other kind carries them.

Response

The same bytes were stored already: the statement, and no run.

What posting a statement came to.

statement
object
required

The statement as stored.

replayed
boolean
required

Whether the same bytes were stored already.

run
object | null
required

The reconciliation run the statement started; null on a replay.