Generates signed claim messages that allow users to claim their rewards on-chain through the FuulManager smart contract.

How Claiming Works

This endpoint is part of a multi-step claim flow:

1. Call this endpoint with the user's address and amounts to claim
2. Receive signatures containing claim parameters (amount, currency, deadline, proofs)
3. User calls FuulManager.claim() on the blockchain with the signature data
4. Funds transfer from FuulProject contract to user's wallet

When to Use This Endpoint

• User wants to claim accumulated rewards on-chain
• Building a claim UI/flow in your application
• Verifying claimable amounts before initiating on-chain transaction
• Generating proofs for multi-currency claims

When NOT to Use This Endpoint

• Just checking claimable totals (use GET /v1/claim-checks/totals instead)
• User has no claimable rewards (check totals first)
• Claiming points/credits (this is for on-chain token claims only)

Important Constraints

• Signatures Expire: Each signature has a deadline timestamp (typically 24 hours)
• Gas Required: User needs native token (ETH, MATIC, etc.) for gas to execute claim on-chain
• Network Specific: Signatures are valid only for the specified chain_id
• One-Time Use: Once claimed on-chain, signature cannot be reused
• Multi-Currency: May return multiple signatures if user has claims in different tokens

Claim Flow Best Practices

1. GET /v1/claim-checks/totals → Show user claimable amounts
2. POST /v1/claim-checks/claim → Generate signatures
3. User approves transaction in wallet
4. Call FuulManager.claim(signatures) on-chain
5. Transaction confirmed → Rewards transferred

Smart Contract Integration

• Contract: FuulManager (see https://docs.fuul.xyz/protocol/smart-contracts)
• Function: claim(ClaimData[] calldata claims)
• Source Code: https://github.com/fuul-protocol/protocol-contracts

Common Errors

• 400 Bad Request: Invalid user identifier format
• 404 Not Found: Project not found or user has no claimable rewards
• 403 Forbidden: API key lacks required permissions

Related Endpoints

• GET /v1/claim-checks/totals - Check claimable amounts before claiming
• GET /v1/payouts/totals/{userIdentifier} - View all payout data