# Account status

Source: https://docs.settlemint.com/docs/console/participants/change-account-status
Restrict, suspend, close or terminate a person in your organisation, see which wallets the change reaches before you make it, and resume a suspension later.

A person's account status says what they may still do in your organisation: "Active", "Restricted", "Suspended", "Closed" or "Terminated". Each wallet the person holds in the organisation carries its own status, and the person's status is the strictest one in force. On "Change account status" you set a new status on every wallet at once, or on one wallet, with a reason that stays in the status history. The page shows which wallets the change reaches, which it leaves alone and why, and refuses a change that would leave the organisation without an owner or a role holder before anything is written.

"Resume account" ends a suspension. Each suspended wallet gets back the status it had before it was suspended, so a wallet that was "Restricted" before is "Restricted" again. A status set here applies only in this organisation. A person's wallets in another organisation keep the status set there.

![The Change account status page with New status, the wallets the change reaches, Effective from, Reason and Note](https://docs.settlemint.com/docs/screenshots/console-participant-status-change.light.en.webp)

[Screenshot] The "Change account status" page for a person in the organisation.

## Before you start [#before-you-start]

- **A wallet in this organisation.** A status is held on the person's wallets here. A person with no wallet in the organisation shows "No wallets in this organisation" on the "Rights" tab and has nothing to change.
- **Your own standing.** While your own account in this organisation is suspended, closed or terminated, the platform refuses every status change you make, a resumption included. While a suspension, closure or termination is scheduled for your own account, the platform refuses every change to your own status, so you cannot cancel or postpone it yourself.
- **Roles handed over.** Before you suspend, close or terminate a person who is the only holder of a role, grant that role to someone else. The page names the roles.
- **A reason.** Know which reason code applies and what the note should record. Both stay in the status history.

## Steps [#steps]

### Open the person [#open-the-person]

Open "Organisation participants", then "Users". An identity manager sees an "Actions" column in the list: open the row's actions and select **Change status**. Or open the person, then the "Rights" tab, and select "Change status" on the "Account status" card. Either way the change applies to every wallet the person holds in this organisation.

To change one wallet only, select **Change status** in that wallet's row of the "Wallet statuses" table on the "Rights" tab. The page then reads "Set the account status on one of this person's wallets in this organisation."

### Choose the new status [#choose-the-new-status]

Under **New status**, choose "Active", "Restricted", "Suspended", "Closed" or "Terminated". For "Restricted", tick at least one function under "Restricted functions": "Trading restricted", "Securities transfers restricted" or "Withdrawals restricted". Every other function stays available.

### Read what the change reaches [#read-what-the-change-reaches]

Once you choose a status, the page checks the change before you make it. It names each wallet it changes, as "Changes 2 wallets" with their addresses, and each wallet it leaves as it is, with the reason:

- "because it already has this status", for a wallet that holds the new status already.
- "because terminated is final", for a wallet that is terminated. A terminated wallet never changes again.

When the change is not allowed, the page shows "This change is not allowed" with the reason, and **Change status** stays disabled. [What the platform checks](#what-the-platform-checks) lists the reasons. When a multisig wallet would lose the signer seats it needs, the page shows "Multisig wallets need this person" and still lets you make the change.

### Set when it applies [#set-when-it-applies]

Leave **Effective from** empty to apply the change now. Choose a later date and time to schedule it: the status history shows the change as "Scheduled" until then. A new change replaces a change still scheduled on the same wallets, and the history shows the replaced one as "Cancelled before it took effect".

### Record the reason [#record-the-reason]

Choose the **Reason** from the [reason codes](#reason-codes), and write the "Note", up to 500 characters. Both are required, and both stay with the change in the status history.

### Change the status [#change-the-status]

Select **Change status**. When it is disabled, the line beside it says what is missing, such as "Choose a reason." or "No wallet would change.". Wait for "Account status changed". The Console returns to the "Rights" tab, where the "Account status" card and the "Status history" table show the change.

## Resume an account [#resume-an-account]

**Resume** shows on the "Account status" card when at least one of the person's wallets holds a suspension of its own. In the "Users" list it shows as "Resume account" in the row's actions, and in the "Wallet statuses" table as "Resume" on a suspended wallet.

"Resume account" names the wallets it resumes, as "Resumes 2 wallets". Choose the **Reason** and write the "Note", then select "Resume". A resumption applies now, and each suspended wallet gets back the status it held before its suspension, with its restricted functions. A wallet that had no status of its own before it was suspended gets back the strictest status the person's other wallets held then, which is the status it inherited, or "Active" when none held one. A change still scheduled on a resumed wallet is cancelled. Venue orders the suspension cancelled stay cancelled.

A resumption reaches only wallets with a suspension of their own. A wallet that shows "Inherited from another wallet" takes its status from the person's other wallets, so it changes when they do. When no wallet holds a suspension of its own, the page shows "Nothing to resume" and "Resume" stays disabled.

## Reason codes [#reason-codes]

| Reason | Use it when |
| --- | --- |
| KYC failed | The person's know-your-customer review failed. |
| AML review | An anti-money-laundering review is open on the person. |
| Client request | The person asked for the change. |
| Staff investigation | Your staff are investigating the account. |
| Dormant account | The account has been inactive. |
| Legal order | A court order or regulator requires the change. |
| Other | None of the above applies. Say what does in the "Note". |

## What the platform checks [#what-the-platform-checks]

The page checks the change when you choose the status, and the platform checks it again when you submit, so a change that became unsafe in between is still refused. The checks run before anything is written. When the platform cannot read what a check needs, it refuses the change, and the page shows "The Console could not check what this change reaches. Try again."

| Check | Applies to | The page says |
| --- | --- | --- |
| Your own standing | Every change and every resumption | "Your own account in this organisation is suspended, closed or terminated, so you cannot change anyone's status." |
| Your own account | A change to "Suspended", "Closed" or "Terminated", and any change to your own status while one of those is scheduled | "You cannot suspend, close or terminate your own account, or change your own status while such a change is scheduled." |
| The organisation's last owner | A change to "Suspended", "Closed" or "Terminated" | "This person is the organisation's last owner. Make someone else an owner first." |
| The only holder of a role | A change to "Suspended", "Closed" or "Terminated" | "This person is the only holder of" and the roles, then "Grant those roles to someone else first." |
| Multisig signer seats | A change to "Suspended", "Closed" or "Terminated" | "Multisig wallets need this person", as a warning that allows the change |

A role counts as held by someone else only when that person is not suspended, closed or terminated in the organisation themselves.

## Where the status takes effect [#where-the-status-takes-effect]

The platform checks the status of the wallet that acts, in the organisation where it acts. "Active" stops nothing. "Suspended", "Closed" and "Terminated" stop all three functions below, and "Restricted" stops only the functions you ticked:

| Function | What the platform refuses |
| --- | --- |
| "Trading restricted" | Placing, reducing or replacing an order on a trading venue. Cancelling an order stays open. |
| "Securities transfers restricted" | Token transfers and register-line requests from the wallet, creating or approving an XvP settlement, and custody withdrawals. |
| "Withdrawals restricted" | Custody withdrawals, custody gateway withdrawals, deposit watches and bank rail cash-outs. |

A trading venue also reads the status when it admits a wallet, and a "Suspended", "Closed" or "Terminated" status cancels the wallet's open orders on this organisation's venues within about a minute of taking effect, as [Participant access](https://docs.settlemint.com/docs/console/asset-lifecycle/venues/participant-access) describes. [Custody gateway review](https://docs.settlemint.com/docs/console/asset-lifecycle/custody-gateway-review) and [Cash-outs](https://docs.settlemint.com/docs/console/asset-lifecycle/bank-rail/cash-outs) describe how a withdrawal or cash-out shows the refusal. Tokens on Canton do not check the status yet.

### What reaches a wallet that cannot receive [#what-reaches-a-wallet-that-cannot-receive]

While a wallet is "Suspended", "Closed" or "Terminated", nothing can be sent to it in this organisation: transfers, mints, token sale purchases and deliveries, settlements and conversions to it are refused, and a corporate action run skips it. Forced transfers, refunds and burns stay open. A bank payment or gateway deposit for the user is held until the status is active again or returned, and a stop order naming the wallet is cancelled when it triggers.

The platform refuses these calls itself, and the status freezes nothing on chain. To freeze a wallet on the tokens it holds, [restrict the wallet](https://docs.settlemint.com/docs/console/participants/restrict-a-wallet).

## You should see [#you-should-see]

- The "Account status" card on the "Rights" tab shows the new status, with the restricted functions and the reason you chose.
- Each wallet the change reached shows the new status in the "Wallet statuses" table, with "Set on this wallet" as its "Source".
- The "Status history" table shows the change once, with the number of wallets it moved, such as "2 wallets", and its "Reason". A scheduled change reads "Scheduled".
- In the "Users" list, the person's "Account status" shows the change, and "Status reason", once you add it with "View", the reason code.

## Troubleshooting [#troubleshooting]

**Change status is not offered**

Only an identity manager sees **Change status** and "Resume". Ask an owner to grant you the "Identity manager" role. A
person with no wallet in this organisation has no status to change.

**The page says This change is not allowed**

Read the reason under the title. For the only holder of a role, grant each role it names to another person who is not
suspended, closed or terminated and has no such change scheduled, then open the page again. For the last owner, make
someone else an owner first, or resume an owner who is suspended.

**Change status stays disabled with No wallet would change.**

Every wallet already has the status you chose, or is terminated. Choose another status, or close the page.

**Resume does not show for a suspended person**

No wallet holds a suspension of its own in force. A wallet whose "Source" reads "Inherited from another wallet"
changes with the person's other wallets, and a suspension still "Scheduled" cannot be resumed before it takes effect.
Change the status instead, or wait until the suspension is in force.

## API routes [#api-routes]

The Console calls the participant status operations of the Platform API: `GET /api/v2/participants/{participantId}/status/impact` to check a change, `POST /api/v2/participants/{participantId}/status` to make it and `POST /api/v2/participants/{participantId}/status/resumptions` to resume. The [Platform API reference](https://docs.settlemint.com/docs/api-reference/v2) lists every field and response, and [Upgrade to DALP 3.2](https://docs.settlemint.com/docs/api-reference/guides/upgrade-to-3-2#participant-account-status-per-organisation) describes how they changed.