Account Lifecycle and Controls

zerohash exposes six actions to manage an account's operational state over its lifetime, from restricting activity to full closure. Each targets an account by its zrn and offers platforms more controls on a customer at the account levels.

ActionEndpointEffect
LockPOST /accounts/{zrn}/lockStops all activity on the account.
UnlockPOST /accounts/{zrn}/unlockRestores a locked account.
Withdraw lockPOST /accounts/{zrn}/withdraw-lockBlocks new withdrawals only. Trading and deposits continue.
Withdraw unlockPOST /accounts/{zrn}/withdraw-unlockRestores withdrawals.
DivestPOST /accounts/{zrn}/divestLiquidates positions ahead of closure.
ClosePOST /accounts/{zrn}/closeCloses the account.

Restricting and restoring activity

  • Account Lock halts all activity — trading, deposits, and withdrawals. Unlock reverses it.
  • Account Withdraw lock (POST /accounts/{zrn}/withdraw-lock) is narrower: it blocks new withdrawals while leaving trading and deposits open. Withdraw unlock restores withdrawals.

Winding down

  • Divest (POST /accounts/{zrn}/divest) liquidates open positions to cash in preparation for closure.
  • Close (POST /accounts/{zrn}/close) closes the account.

Statuses and confirmation

An account moves through five statuses — open, locked, withdraw_locked, divesting, and closed. All six actions are asynchronous: the request is accepted immediately, and the state change is confirmed by the customer_account_status_changed (webhook events) webhook. Drive your product logic off the webhook, not the API response.


Account statuses are open, locked, withdraw_locked, divesting and closed. All six actions are asynchronous and confirmed by the customer_account_status_changed webhook.

🚧

UTMA Accounts

When the minor reaches the age of majority, zerohash locks the account with the reason minor_attained_age_of_majority. Plan for this transition in your product flow.

Tax Reporting by Account Type

Only JTIC and JTWROS are treated as joint accounts for tax reporting. Each tenant on those accounts is registered as a secondary owner and receives their own reporting.

Individual, Business, Trust and UTMA accounts report to the primary account holder only, regardless of how many tenants are on the account.


Did this page help you?