Skip to main content
POST
/
v1
/
screen
curl -X POST https://api.sunbreak.com/v1/screen \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $SUNBREAK_API_KEY" \
  -d '{"wallet": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fEa3"}'

{
  "allowed": true,
  "wallet": "0x742d35cc6634c0532925a3b844bc9e7595f8fea3"
}
curl -X POST https://api.sunbreak.com/v1/screen \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $SUNBREAK_API_KEY" \
  -d '{"wallet": "0x742d35Cc6634C0532925a3b844Bc9e7595f8fEa3"}'

​
Block Reasons

When a wallet is blocked (allowed: false), the reason field indicates why:
ReasonDescription
sanctions_listWallet appears on OFAC sanctions list
trm_screen_failedWallet flagged by TRM risk screening
internal_blockWallet blocked by Sunbreak

Authorizations

​
X-API-Key
string
header
required

Your Sunbreak API key

Body

application/json
​
wallet
string
required

Wallet address to screen (EVM or Solana format)

Response

Screening result

​
allowed
boolean
required

Whether the wallet is allowed to transact

​
wallet
string
required

The normalized wallet address

​
reason
enum<string>

Why the wallet was blocked (only present if allowed is false)

Available options:
sanctions_list,
trm_screen_failed,
internal_block