Page cover

Overview

Getting started with Quotient Allowlists

Allowlists enable programmatic access control based on on-chain and social graph data.

Create an allowlist by defining a minimum Farcaster credibility score (0-1 scale, set to 0 to disable) and optional conditions like Farcaster follows, channel membership, token holdings, or miniapp usage levels. Each allowlist generates a unique Query ID used to check user eligibility via the API endpoint.

Eligibility is evaluated dynamically at query time using AND logic across all conditions.

When you check if a user is eligible, the system verifies they meet the reputation threshold (if set) plus ALL additional conditions. For example, an allowlist requiring FC Cred ≥ 0.74, following @dwr, and holding $DEGEN would only return true for users meeting all three criteria.

The eligibility check happens in real-time against the current graph state, so users automatically gain or lose access as their on-chain activity changes.

Integration is straightforward using the Query ID returned after allowlist creation. Make a GET request to /api/allowlist/{queryId}/check/{userIdentifier} where userIdentifier can be an FID, username, or wallet address.

The API returns a boolean eligibility status along with detailed condition results, making it easy to gate features, distribute rewards, or personalize experiences based on your defined criteria.

Last updated