Skip to main content
One table per resource. Each row is a state, what it means, and what moves it out. The status alone never answers that last question.
Each table below shows the values as they arrive. Compare them without case.

Sub-client

Branch on this field. verification_status reports the result of the identity check. See Sub-client verification. A document rejected on its own is not in this table. It moves verification_status to needs_action and leaves status where it was. User values has the set.

Virtual account

Which set comes back depends on the version you are pinned to. The values are on Virtual account values, where both sets are listed side by side. Nothing but the active state can receive money. Wait for virtual_account.activated rather than for the account to exist. A freeze, an unfreeze and a deactivation each send virtual_account.status_changed. Account opening follows the whole sequence.

Deposit

A bank deposit to a fiat account arrives PENDING while compliance reviews it and becomes COMPLETED once approved. A crypto inbound to the same account arrives PENDING and completes once it is converted to dollars. KYT_REJECTED is not FAILED. Holds explains why they are kept apart. Only REFUNDED is terminal, and FAILED ends a deposit unless Kira returns it. A COMPLETED deposit can still be held or clawed back, so code that treats it as final is treating a state as an ending it does not have.

Payout

Only FAILED, CANCELLED and EXPIRED are terminal. A bank return moves a COMPLETED payout to FAILED. Payout has when and why.

NEEDS_ACTION, on a deposit or a payout

NEEDS_ACTION is in neither table above, because a movement never transitions into it. It is what a payout or a deposit reports while an open request for information holds it. The hold that waits on you says what happens to the state underneath. Treat it as an overlay, not a stage. Keep it out of your state machine, and read rfi on the payout to find the request to answer.

RFI

A request can also be withdrawn, which no event announces. The item is the unit covers that and how items are answered.

What you cannot read back

One piece of information exists only on the event that carried it, and no read ever returns it: Event catalog says how to keep it.