POST/api/v1/add-whitelist-address

Add an address to the Address Book

Saves an address in the workspace Address Book under a display name, so members can pick it by name instead of pasting it, without approving it for any token.

AccessRequires a permission in the workspaceMANAGE_WORKSPACE

The Address Book is a workspace-level list of named addresses. Saving an address here records it once for everyone in the workspace to reuse, whether as a transfer destination or as the address you later approve for a token. It is a convenience layer, and it holds no approval of its own.

Approval is a separate, on-chain step: a token enforces its own whitelist, and an address is only an approved destination for that token once POST /api/v1/add-to-contract-whitelist has been signed and broadcast for it. Whitelist Management and Managing whitelisted addresses describe how operators work through the two layers in order.

Saving an address does not approve it

An entry in the Address Book is a name for an address, nothing more. It grants no permission to send anything anywhere, and while a token's whitelist is on, that token still rejects the address until it is added to the token's own list.

Body parameters

workspace_idnumberrequired

The workspace whose Address Book to add to. You must hold MANAGE_WORKSPACE in it.

addressstringrequired

The Bitcoin address to save.

display_namestringrequired

The name members see for this address in the application.

bash

curl -X POST "$SQRL_API/api/v1/add-whitelist-address" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "workspace_id": 342,
        "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
        "display_name": "Settlement desk"
      }'

const res = await fetch(`${process.env.SQRL_API}/api/v1/add-whitelist-address`, {
  method: "POST",
  headers: {
    authorization: `Bearer ${process.env.SQRL_TOKEN}`,
    "content-type": "application/json",
  },
  body: JSON.stringify({
    workspace_id: 342,
    address: "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
    display_name: "Settlement desk",
  }),
});
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/add-whitelist-address", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "workspace_id": 342,
        "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
        "display_name": "Settlement desk",
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true
}

Was this page helpful?