---
title: "Freeze the wallet for the given coin and wallet id."
method: POST
path: "/api/v2/{coin}/wallet/{walletId}/freeze"
tags: ["Wallet"]
---

# Freeze the wallet for the given coin and wallet id.

`POST /api/v2/{coin}/wallet/{walletId}/freeze`

Permissions:
- spender for the given wallet and coin

## Path parameters

- `coin` string, required — A cryptocurrency symbol or token ticker symbol
- `walletId` string, required

## Request body

- object — Freeze Wallet Request Body Parameters for freezing a wallet, including duration and optional metadata.
  - `duration` union, required — How long to freeze the wallet
    - number
    - 'max'
  - `reason` 'TxIntentMismatch' | 'TxIntentMismatchRecipient' | 'TxIntentMismatchContract' | 'TxIntentMismatchApproval' | 'UserRequest' | 'AdminRequest'
  - `referenceId` string — Used for tracking purposes
  - `metadata` union
    - string
    - object
      - `suspiciousTransactionHex` string, required
      - `txParams` object[], required
        - `address` string, required
        - `amount` union, required
          - string
          - number
        - `data` union
          - string
          - TokenTransferRecipientParams — Token transfer recipient params used in freeze metadata.
            - `tokenType` string, required
            - `tokenQuantity` string, required
            - `tokenContractAddress` string
            - `tokenName` string
            - `tokenId` string
            - `decimalPlaces` number
        - `feeLimit` string
        - `tokenData` TokenTransferRecipientParams — Token transfer recipient params used in freeze metadata.
          - `tokenType` string, required
          - `tokenQuantity` string, required
          - `tokenContractAddress` string
          - `tokenName` string
          - `tokenId` string
          - `decimalPlaces` number
        - `tokenName` string

## Response `200`

OK

- WalletFreezeResponse
  - `time` string, date, required
  - `expires` string, date, required
  - `reason` 'TxIntentMismatch' | 'TxIntentMismatchRecipient' | 'TxIntentMismatchContract' | 'TxIntentMismatchApproval' | 'UserRequest' | 'AdminRequest'
  - `referenceId` string — An optional reference ID for tracking purposes
  - `adminOrUserId` string — The user who froze the wallet (could be a regular user or an admin)

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `500` — Internal Server Error

---

[API](https://skmtc.net/bitgo/apis/bitgo-api.md) · [All operations](https://skmtc.net/bitgo/apis/bitgo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitgo/bitgo-api/revisions/e445c15e5bee/schema)