Skip to navigation

Declare an account address

Declares a deposit or withdrawal address on one of the organisation’s accounts (account-addresses:propose), unverified until a second user verifies it. An account outside the organisation refuses 422 UNKNOWN_ENTITY or ORG_MISMATCH; a duplicate, 409 DUPLICATE_ADDRESS.

Authentication

AuthorizationBearer

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

Headers

Idempotency-KeystringRequired

Required on every write: a URL-safe string of 1 to 64 characters from [A-Za-z0-9._~-] (a UUID fits), scoped to you. It names one operation on one record, ever: a retry replays the stored outcome (Idempotent-Replay: true) or attaches to the live one, and reuse on another record refuses 409 IDEMPOTENCY_KEY_REUSED. Missing or malformed, 400.

Request

This endpoint expects an object.
accountIdintegerRequired
assetIdintegerRequired
chainenumRequired

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:
addressstringRequired
memostringRequired

Response

The account address as the platform now holds it after the write — the same row the read serves, with the answering change's position, the row's ETag and, on a replayed key, Idempotent-Replay.

accountAddressIdinteger
The address's id, minted by the platform and never reused.
accountIdinteger
The account the address belongs to.
addressstring
assetIdinteger

Refdata reference — carried, not resolved here.

chainenum

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:
globalSequencestringformat: "^[0-9]+$"

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

memostring

Memo/tag where the chain needs one; empty-not-null.

orgIdinteger

Owner-stamped from the account's org.

sourceenum

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:
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

declaredByUserIdinteger or nullOptional

The user who declared a DECLARED address — its verifier must be a different user (SELF_APPROVAL); 0 for OBSERVED rows.

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
Create Account Addresses Request Bad Request Error
401
Create Account Addresses Request Unauthorized Error
403
Create Account Addresses Request Forbidden Error
409
Create Account Addresses Request Conflict Error
413
Create Account Addresses Request Content Too Large Error
422
Create Account Addresses Request Unprocessable Entity Error
429
Create Account Addresses Request Too Many Requests Error
500
Create Account Addresses Request Internal Server Error
503
Create Account Addresses Request Service Unavailable Error