> For the complete documentation index, see [llms.txt](https://docs.fuul.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fuul.xyz/developer-guide/claiming-onchain-rewards/get-claim-checks.md).

# Get Claim Checks

Claim checks are signed vouchers that allow users to claim their rewards onchain. This step is the same regardless of whether you're claiming on EVM or SVM.

Use `Fuul.getClaimableChecks` from `@fuul/sdk`:

```typescript
import { Fuul } from '@fuul/sdk';

const claimChecks = await Fuul.getClaimableChecks({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address', // evm_address | solana_address | xrpl_address | sui_address | stellar_address | email
});
```

{% hint style="warning" %}
Not every identifier type can receive an onchain payout. A payout targeting a `stellar_address` fails with `UnsupportedIdentifierType`: Stellar is supported for identification and attribution only. See [Stellar signatures](/developer-guide/tracking-referrals-in-your-app.md#stellar-signatures).
{% endhint %}

Each claim check carries its own `id` (a uuid) alongside the voucher fields (`project_address`, `to`, `currency`, `currency_type`, `amount`, `reason`, `token_id`, `deadline`, `proof`, `signatures`). Use it to correlate a signed voucher with the rows returned by `getClaimChecks`, to deduplicate, or to reference a single check when closing.

You can also call the [claim check endpoint](https://fuul.readme.io/reference/generateclaimsignature) on the Fuul API directly.

{% hint style="info" %}
`getClaimableChecks` was introduced in SDK version **7.8.0**. Upgrade if you're on an earlier version. The per-check `id` was added in **7.44.0**.
{% endhint %}

## Get claim totals

To show users their claimed and unclaimed balances without building a full transaction ([API reference](https://fuul.readme.io/reference/getclaimabletotals)):

```typescript
import { Fuul } from '@fuul/sdk';

const totals = await Fuul.getClaimCheckTotals({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address', // or 'solana_address'
});
// Returns { claimed: [...], unclaimed: [...] } grouped by currency
```

## Claim check aggregation (open checks)

Some projects enable **claim check aggregation**, which batches multiple rewards into a single on-chain transaction per currency. This is optional and configured per project.

When aggregation is enabled, claim checks start with status `open` — they accumulate rewards over time without being signed yet. New rewards for the same user, currency, and reason are merged into the existing open check by summing amounts and extending deadlines. This reduces on-chain transactions from one per reward event to one per currency/reason combination.

To finalize an open check and make it claimable, call `POST /claim-checks/close`:

```typescript
import { Fuul } from '@fuul/sdk';

await Fuul.closeClaimChecks({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address',
});
```

`closeClaimChecks` returns the same `ClaimResponse` shape as `getClaimableChecks`, so the per-check `id` is available from either method. You can also pass `claim_check_ids` to close a specific subset instead of everything open.

After closing, the check transitions from `open` to `unclaimed` and receives its signature — at which point it's returned by `getClaimableChecks` and ready to claim onchain.

{% hint style="info" %}
If aggregation is not enabled for a project, claim checks are signed immediately at creation time and are returned as `unclaimed` from the start. No `close` call is needed.
{% endhint %}

## List claim checks by status

To inspect a user's checks without generating vouchers, use `getClaimChecks`. This is the SDK method behind `GET /claim-checks`:

```typescript
import { Fuul, ClaimCheckStatus } from '@fuul/sdk';

const { claim_checks } = await Fuul.getClaimChecks({
  user_identifier: '0x1234...',
  user_identifier_type: 'evm_address',
  status: ClaimCheckStatus.Open, // optional — omit to return every status
});

claim_checks.forEach((check) => {
  console.log(`${check.id}: ${check.amount} ${check.currency_name} (${check.status})`);
});
```

| Status                                       | Meaning                                                                  |
| -------------------------------------------- | ------------------------------------------------------------------------ |
| `ClaimCheckStatus.Open` (`'open'`)           | Aggregating rewards, not signed yet. Call `closeClaimChecks` to finalize |
| `ClaimCheckStatus.Unclaimed` (`'unclaimed'`) | Signed and ready to claim onchain                                        |
| `ClaimCheckStatus.Claimed` (`'claimed'`)     | Already redeemed onchain                                                 |

Each row returns `id`, `currency_address`, `currency_chain_id`, `currency_name`, `currency_decimals`, `reason`, `amount`, `status`, `deadline_seconds`, and `created_at`. Note that these are metadata rows, not vouchers: they carry no `proof` or `signatures`. Use `getClaimableChecks` when you need to submit a transaction.

## Next steps

Once you have your claim checks, follow the guide for your chain:

* [EVM Claiming](/developer-guide/claiming-onchain-rewards/evm.md) for Ethereum, Arbitrum, Base, HyperEVM, Ink, Monad, Optimism
* [SVM Claiming (Solana)](/developer-guide/claiming-onchain-rewards/svm-solana.md) — for Solana Mainnet, Devnet, Fogo Mainnet