Skip to main content
DICT manages the Pix key directory and related dispute workflows. Use the public API for client actions; the plugin coordinates provider calls and local state.

​
Register and resolve a key

  1. Create an entry with Create entry. Send the account scope, required reason, and idempotency headers.
  2. Save the entry identifier and read it with Get entry.
  3. Resolve a key with Lookup key before a key-based payment, or use Check keys existence for a batch check.
  4. Update or delete only through the entry’s public lifecycle routes. Do not treat a lookup as ownership proof for another account.
Entry creation and update can fail closed when their replay store is unavailable. A 503 in that condition is not a safe prompt to repeat the business action under a new key.

​
Move a key through a claim

Claims cover ownership and portability. A client flow is:
  1. Open the claim with Create claim.
  2. Read it with Get claim.
  3. Use the transition that matches the claim role and state: confirm, complete, acknowledge, or cancel.
Most claim mutations are unavailable while VSync reconciles the affected scope. Claim cancellation is intentionally separate: it remains an exit for an active claim rather than a new source of directory drift.

​
Work a MED 2.0 case

A funds recovery opens a tracked case; it does not itself prove that funds were returned.
  1. Open it with Create funds recovery and keep the returned internal identifier.
  2. Read the case, its related infraction reports, and its tracking graph through the corresponding reference operations.
  3. Update only mutable contact or report fields with the documented merge-patch contract.
  4. When the case reaches the state that permits it, initiate its refund through the documented funds-recovery refund operation. Read the case again to observe the new state.
  5. Cancel only when its current state allows cancellation.
The plugin scopes funds recoveries to the authenticated participant. A not-found response must not be used to distinguish another participant’s resource from an unknown identifier.

​
Record and cancel a fraud marker

Use Create fraud marker with a caller-created request identity. A replay with the same identity and payload returns the same marker; a different payload is rejected. Use List fraud markers or Get fraud marker to inspect it, and Cancel fraud marker when the marker should no longer apply.

​
Let VSync protect key consistency

VSync reconciles local key state against the directory by scope. It progresses from verification to event synchronization and, when needed, file reconciliation. VSync is an internal operational surface in v1.0.0; client applications observe its effect through the 503 gate on protected mutations and do not call its state, job, log, or reconciliation-action routes. While a scope reconciles, DICT refuses protected mutations with 503 rather than accepting a change that could add new drift. Wait for the scope to become available; ask the operator to inspect VSync state if the gate persists. Do not bypass the gate with adapter callbacks or direct storage changes. For disputed-payment holds and refunds, continue with SPI and the Block Balancer.