Skip to navigation

Delete an account address

Deletes the address at once, for good (either account-addresses capability). A declaration still awaiting verification comes back to its declarer: the row records who deleted it, when and the body’s reason, and the approvals inbox serves it returned under its DELETED row; a verified row’s delete returns nothing.

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.

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.

If-MatchstringRequired

Required on every entity write: the ETag the read minted, quoted or bare — the version this write was computed against — or * to write unconditionally on purpose, except on a notification endpoint’s approval, which refuses * 400 INVALID_IF_MATCH. Absent is 428 PRECONDITION_REQUIRED; a weak validator 400 INVALID_IF_MATCH; a stale value 412 VERSION_CONFLICT (CONFIG_SEQ_CONFLICT on an algo’s config write) with currentVersion and a fresh ETag: re-read, reapply, retry. A * write overwrites every field from your copy, a colleague’s amend since your read included.

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Request

This endpoint expects an object.
accountAddressIdintegerOptional
expectedVersionstring or nullOptionalformat: "^-?[0-9]+$"
int64 as a decimal JSON string
reasonstringOptional

Why, for the declarer: recorded on the row as lastWithdrawalReason when the delete ends a declaration still awaiting verification, beside who deleted it and when; empty-not-null, and nothing on a verified row. At most 256 bytes; longer refuses INVALID_FIELD. Optional in this body: absent reads as "".

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

At most 256 bytes; longer refuses INVALID_FIELD.

approvalslist of objects

Who approved the row’s last proposal and when, in approval order — grown by each approval and kept on the concluded row as its record until the next proposal or a withdrawal clears it; empty until the first approval. The proposal concludes at the approval that meets the organisation’s count for the family as it stands then; pendingTransition says whether one is pending. a repeating group served as an array of objects, in the group’s own order; empty = no entries, never null

assetIdinteger

Refdata reference — carried, not resolved here.

chainenum

UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. 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:
concludedTransitionenum

What the row’s last proposal proposed, kept once it concluded: the pending transition the conclusion cleared, as the register wrote it; NONE while it pends, or where none was. So the concluded row says what concluded, however its status has moved on since. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. 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

globalSequencestringformat: "^[0-9]+$"

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

lastWithdrawalReasonstring

Why the last proposal was withdrawn, as the withdrawer stated it; empty-not-null.

memostring

Memo/tag where the chain needs one; empty-not-null. At most 256 bytes; longer refuses INVALID_FIELD.

orgIdinteger

Owner-stamped from the account’s org.

pendingTransitionenum

ACTIVATE while a declared or observed address awaits verification — the family’s one proposal; NONE once verified, and on a deleted row. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. 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

remarkstring

The maker’s note on the pending proposal, for its approvers; empty-not-null — a declaration states none today. At most 256 bytes; longer refuses INVALID_FIELD.

sourceenum

UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. 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 the field is required, and explicit UNKNOWN refuses 400. 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

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

Platform time the row’s last proposal concluded; 0 while it is pending, or when the row never carried one. A write the organisation’s count let through at once concludes in the maker’s own fact: equal to proposedAtNs. int64 as a decimal JSON string

concludedByobject or nullOptional

Who concluded the row’s last proposal: the approver whose approval met the organisation’s count, or the maker when the count was 0 and the write concluded at once; null while it is pending, or when the row never carried one. an actor: an object {kind, id}; null where none is stated

keyHolderobject or nullOptional

When an API key made the row’s last proposal, the member the key’s secret had last been answered to as it proposed — its last rotator then, else its issuer — kept on the concluded row with proposedBy; null when a member made the proposal, or the row never carried one. The proposal counts as this member’s and the key’s issuer’s, whoever rotates the key afterwards: neither may approve it (SELF_APPROVAL). an actor: an object {kind, id}; null where none is stated

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

Platform time of that withdrawal; 0 when none was. The three fields and lastWithdrawalReason stand until the next proposal replaces them. int64 as a decimal JSON string

lastWithdrawalProposedByobject or nullOptional

Who made the last proposal that was withdrawn; null when none was. an actor: an object {kind, id}; null where none is stated

lastWithdrawalWithdrawnByobject or nullOptional

Who withdrew it — the proposer, or a checker returning it; null when none was. an actor: an object {kind, id}; null where none is stated

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

Platform time the row’s last proposal was made — the declaration or the observation — kept on the concluded row; 0 when the row never carried one. int64 as a decimal JSON string

proposedByobject or nullOptional

Who made the row’s last proposal — kept on the concluded row as its record; null when the row never carried one (an address a connector observed). pendingTransition says whether that proposal is still pending. an actor: an object {kind, id}; null where none is stated

verifiedUnderCountinteger or nullOptional

The organisation’s account-addresses approval count read when the address’s verification concluded, or unstated (null) where that count was 0 — an address verified on its declarer’s own write, or by one person while the organisation’s count was 0 — and for every address verified before this field existed. An address verified under no stated count serves only a transfer a second person approves; to spare it that, delete it and declare it again under a count of at least 1, which gives it a new id: a verified address is never re-verified.

Errors

400
Delete Account Addresses Request Bad Request Error
401
Delete Account Addresses Request Unauthorized Error
403
Delete Account Addresses Request Forbidden Error
404
Delete Account Addresses Request Not Found Error
409
Delete Account Addresses Request Conflict Error
412
Delete Account Addresses Request Precondition Failed Error
413
Delete Account Addresses Request Content Too Large Error
422
Delete Account Addresses Request Unprocessable Entity Error
428
Delete Account Addresses Request Precondition Error
429
Delete Account Addresses Request Too Many Requests Error
500
Delete Account Addresses Request Internal Server Error
503
Delete Account Addresses Request Service Unavailable Error