Whitelist Management

verview

The Spree Protocol uses whitelists to control access to operations:

Whitelist	Purpose	Endpoint Pattern
Mint	Controls who can mint points	/factory/{addr}/whitelist/mint/...
Transfer	Controls who can have points transfered to (destination whitelist)	/points/{addr}/whitelist/transfer/...
Redeem	Controls who can redeem points	/factory/{addr}/whitelist/redeem/...

Add to Mint Whitelist

Required for SP → Branded SP minting flow.

PUT /api/v1/build/evm/chain/{chainId}/factory/{factoryAddr}/whitelist/mint/user/{userAddr}

Request Body:

{
  "input": {},
  "key": "0xWhitelistAuthorityAddress"
}

Add to Transfer Whitelist

The receiver must be whitelisted for transfers.

PUT /api/v1/build/evm/chain/{chainId}/points/{pointsAddr}/whitelist/transfer/user/{userAddr}

Add to Redeem Whitelist

PUT /api/v1/build/evm/chain/{chainId}/factory/{factoryAddr}/whitelist/redeem/user/{userAddr}

Remove from Whitelists

Use DELETE method on the same endpoints:

DELETE /api/v1/build/evm/chain/{chainId}/factory/{factoryAddr}/whitelist/mint/user/{userAddr}
DELETE /api/v1/build/evm/chain/{chainId}/points/{pointsAddr}/whitelist/transfer/user/{userAddr}
DELETE /api/v1/build/evm/chain/{chainId}/factory/{factoryAddr}/whitelist/redeem/user/{userAddr}

Check Whitelist Status (Read-Only)

GET /api/v1/evm/chain/{chainId}/factory/{factoryAddr}/whitelist/mint/user/{userAddr}
GET /api/v1/evm/chain/{chainId}/points/{pointsAddr}/whitelist/transfer/user/{userAddr}
GET /api/v1/evm/chain/{chainId}/factory/{factoryAddr}/whitelist/redeem/user/{userAddr}