Utilities

Whitelist addresses

Propose new wallet addresses to whitelist.

POST
/api/v2/whitelisted-addresses

Creates a whitelisted address proposal in PROPOSED status. Wallet approvers must approve it in the dashboard before it becomes active.

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key obtained on Settings > API Keys page in Compose UI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST 'https://compose.finance/api/v2/whitelisted-addresses' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Content-Type: application/json' \  -d '{    "addresses": [      {        "network": "base",        "address": "0x1234567890abcdef1234567890abcdef12345678",        "name": "Treasury Wallet"      }    ]  }'
{
  "transactionId": "txn_123456789",
  "status": "PROPOSED",
  "requiresUiAction": true
}
{
  "error": "addresses: At least one address is required"
}
{
  "error": "Unauthorized - Invalid or missing API key or session"
}
{
  "error": "Customers feature is not enabled for your organization"
}
{
  "error": "Invalid request data"
}
{
  "error": "0x1234567890abcdef1234567890abcdef12345678 is already whitelisted on Base as Treasury Wallet"
}
{
  "error": "Rate limit exceeded. Please try again later."
}

{
  "error": "Internal server error"
}