Sign in
latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Issuance

Freeze account

Freezes a token account to prevent transfers.

post/v1/issuance/tokens/{tokenId}/freeze

Path parameters

tokenIdstring required

Token identifier.

Example:tok_example

Token identifier.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Idempotency-Keystring

Idempotency key for safely retrying mutating requests. 1-255 printable ASCII characters; echoed back on the response.

Example:idempotency_example_12345

Idempotency key for safely retrying mutating requests. 1-255 printable ASCII characters; echoed back on the response.

Request body

accountAddressstring required

Wallet or token account address to freeze. SDP resolves the associated token account automatically when a wallet address is provided.

reasonstring

Optional reason for freezing.

signingWalletIdstring

Optional custody wallet ID to use as the signer for this request.

Example request

{
  "accountAddress": "So11111111111111111111111111111111111111112",
  "reason": "Compliance hold",
  "signingWalletId": "privy_abcd1234"
}

Response

Account frozen

Example response

{
  "data": {
    "frozenAccount": {
      "id": "frz_example",
      "tokenId": "tok_example",
      "accountAddress": "So11111111111111111111111111111111111111112",
      "reason": "Compliance hold",
      "frozenAt": "2025-01-05T00:00:00.000Z",
      "frozenBy": "key_example",
      "unfrozenAt": "2025-01-10T00:00:00.000Z",
      "signature": "sig_example"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}