Skip to navigation

Get a chain policy

Serves one chain policy of the organisation; any other id is 404.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idintegerRequired

The record's id — a positive 32-bit integer the platform minted.

Query parameters

viewenumOptionalDefaults to latest

latest (the default) shows a row's pending proposal where one exists; approved shows what the platform enforces. Resources without proposals serve the same rows for both.

Allowed values:

Response

The chain policy's row, rendered as the guide's Reads section describes: the position header and body field, the ETag, money as decimal strings.

assetIdinteger
Refdata reference.
chainenum

≠ UNKNOWN on a policy row. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
chainPolicyIdinteger
Sticky entity key.
globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders and balance readings included.

orgIdinteger

Owner-stamped.

pendingTransitionenum

NONE is the unset sentinel: outputs only — as input, omit the field instead; explicit NONE refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict

statusenum

UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
versionstringformat: "^-?[0-9]+$"

The row's version — monotonic per record, bumped on every change; served as the ETag and taken by If-Match. int64 as a decimal JSON string

isEnabledbooleanOptional

FALSE = chain disabled for this asset: an unstated chain moves nothing. a boolean; absent reads false

maxTransferAmountstring or nullOptionalformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

0 = no bound. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset

minConfirmationsinteger or nullOptional

The settle gate: the confirmation depth at which an on-chain transfer counts as settled rather than in transit; 0 = not stated, and a transfer never settles (the strict reading).

minTransferAmountstring or nullOptionalformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

0 = no bound. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset

pendingByUserIdinteger or nullOptional

The user whose proposal is pending, so an approver is checked to be someone else; 0 when nothing is pending.

settlementSlaNsstring or nullOptionalformat: "^-?[0-9]+$"

The obligation's value-date offset (value date = the envelope time plus this); 0 = due immediately, so breaches surface at once (the noisy-safe reading). int64 as a decimal JSON string

unscaledbooleanOptionalDeprecated

Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so a row is never served raw, whether or not this member holds the asset or instrument it references. Kept, deprecated, so a client generated from 0.3.2 still compiles; it goes at the next major.

Errors

400
Get Chain Policies Request Bad Request Error
401
Get Chain Policies Request Unauthorized Error
403
Get Chain Policies Request Forbidden Error
404
Get Chain Policies Request Not Found Error
503
Get Chain Policies Request Service Unavailable Error