POST/api/v1/remove-from-contract-whitelist

Remove an address from a token whitelist

Removes an address from a token's approved-destination list, returning a transaction proposal that the owning vault's signers approve before the change takes effect on-chain.

AccessRequires a permission in the workspaceMANAGE_WORKSPACE

The token enforces its own whitelist on-chain, so removing an address is a contract action rather than a saved setting. The response has the same shape as POST /api/v1/call-contract: a psbt_id and a psbt_base64 for the owning vault's signers to approve through POST /api/v1/sign-psbt. The address stays an approved destination until the vault's threshold is met and the transaction is broadcast.

Removal is per token. An address taken off one token's list remains approved for any other token it was added to, and it stays in the workspace Address Book until you remove it there as well with POST /api/v1/remove-whitelist-address; the Address Book is a list of named addresses and carries no approval of its own. Whitelist Management and Managing whitelisted addresses describe both layers as operators see them. Note the field names on this endpoint: it takes workspace_uid and wallet_uid, where the token endpoints take workspace_id and wallet_id.

A whitelist change is an on-chain action

When the last required approval arrives, the removal is finalised and submitted to the Bitcoin network automatically, and it cannot be reversed once broadcast. Check for a pending transfer to this address before you remove it, since the token will no longer accept that destination.

Body parameters

workspace_uidnumberrequired

The workspace the token belongs to. You must hold MANAGE_WORKSPACE in it. Note the uid suffix, not workspace_id.

wallet_uidstringrequired

The vault that owns the token contract and whose signers approve this change. Note the uid suffix, not wallet_id.

contract_uidnumberrequired

The token whose approved-destination list you are removing from.

address_to_removestringrequired

The Bitcoin address to withdraw approval from for this token.

bash

curl -X POST "$SQRL_API/api/v1/remove-from-contract-whitelist" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "workspace_uid": 342,
        "wallet_uid": "vault_01HZXB2K7P",
        "contract_uid": 512,
        "address_to_remove": "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h"
      }'

const res = await fetch(
  `${process.env.SQRL_API}/api/v1/remove-from-contract-whitelist`,
  {
    method: "POST",
    headers: {
      authorization: `Bearer ${process.env.SQRL_TOKEN}`,
      "content-type": "application/json",
    },
    body: JSON.stringify({
      workspace_uid: 342,
      wallet_uid: "vault_01HZXB2K7P",
      contract_uid: 512,
      address_to_remove: "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h",
    }),
  },
);
const { call_uid, psbt_id, psbt_base64 } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/remove-from-contract-whitelist", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "workspace_uid": 342,
        "wallet_uid": "vault_01HZXB2K7P",
        "contract_uid": 512,
        "address_to_remove": "bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h",
    }))
    .send()
    .await?;

Response200 OK

{
"call_uid": 8872,
"call_id": "call_01HZXF4B9M",
"payload_hash": "e9b3d0a5…71c",
"psbt_id": "psbt_01HZXC9F4R",
"psbt_base64": "cHNidP8BAHECAAAAAf…AAAA"
}

#What happens next

The owning vault's signers approve the returned proposal with POST /api/v1/sign-psbt, and the removal takes effect once the threshold is met and the transaction confirms. Follow it on GET /api/v1/contract-calls, where the call_uid above appears as UID, and confirm the resulting list with GET /api/v1/get-workspace-whitelist.

Was this page helpful?