Check Requirements

Checks if a user is eligible to claim a reward for a campaign.

Path Parameters
id string — REQUIRED The ID of the NFT campaign.

Responses
200 The check result containing the eligibility status, user data requirements, and rule fulfillment. Schema — OPTIONAL readyToClaim boolean userDataPoints object[] An array of User data points. Lists requirements and sources if user data is not available. name string Possible values: [email, phone, firstName, lastName, picture] The name of the @Web2DataPoints representing the data point, e.g., "email", "firstName", "lastName" sources string[] — OPTIONAL Possible values: [SOCIAL, DIRECT_INPUT, AUTH] An array of @Web2Sources indicating the possible sources of the @Web2DataPoints available boolean A boolean indicating the availability of the @Web2DataPoints value string — OPTIONAL The value of the @Web2DataPoints if it's available ruleFulfillment object[] isFulfilled boolean The fulfillment status of the @NftRuleFulfillment blockchain string Possible values: [ethereum, polygon, binance, avalanche, arbitrum, flow] @SupportedBlockchains Enumeration of supported blockchains. smartContractId string The smart contract ID of the @NftRuleFulfillment missingTraits object[] — OPTIONAL missing traits of the @NftRuleFulfillment, if any traitName string The name of the @Trait traitOption string — OPTIONAL The value of the @Trait memberRuleFulfillment object[] isFulfilled boolean The fulfillment status of the @NftRuleFulfillment claimedRewards object[] projectName string — OPTIONAL The name of the project associated with the @UserReward campaignRewardName string — OPTIONAL The name of the campaign reward associated with the @UserReward reward object — OPTIONAL Given a table interface, extracts the select type from all {@link ColumnType} types. Examples interface PersonTable { id: Generated<number> first_name: string modified_at: ColumnType<Date, string, never> } type Person = Selectable<PersonTable> // { // id: number, // first_name: string // modified_at: Date // } id string — OPTIONAL projectId string — OPTIONAL status string — OPTIONAL createdAt date-time — OPTIONAL updatedAt date-time — OPTIONAL nftCampaignId string — OPTIONAL notaUserId string — OPTIONAL nftId string — OPTIONAL contractAddress string — OPTIONAL claimedAt date-time — OPTIONAL blockchain string — OPTIONAL rewardData — OPTIONAL nftCampaign object — OPTIONAL @NftCampaign Represents an NFT campaign in Pangea with selectable properties. id string — OPTIONAL projectId string — OPTIONAL nftRules — OPTIONAL maxClaims double — OPTIONAL startDate date-time — OPTIONAL endDate date-time — OPTIONAL status string — OPTIONAL trackNftUsed boolean — OPTIONAL soulBound boolean — OPTIONAL rewardCount double — OPTIONAL createdAt date-time — OPTIONAL updatedAt date-time — OPTIONAL integrationType string — OPTIONAL name string — OPTIONAL publishStatus string — OPTIONAL Possible values: [draft, scheduled, live, blocked, completed, deleted] Represents the publishing status of an NFT campaign. claimedCount double — OPTIONAL The count of claims made for the @NftCampaign, if any rewardTemplateCode string Possible values: [MINDBODY_ITEM_GIVEAWAY, MINDBODY_COUPON_CODE, SQUARE_LOYALTY_POINTS, SHOPIFY_DISCOUNT_CODE, STRIPE_DISCOUNT_CODE, LIGHTSPEED_GIFT_CARD, WIX_DISCOUNT_CODE, BIGCOMMERCE_DISCOUNT_CODE, INTERNAL_SECRET] @CampaignTemplateCode Enum representing the possible codes for a @CampaignTemplate. projectName string — OPTIONAL Brand/Project name. Available only on GET method (single record) *
400 Invalid input data. Schema — OPTIONAL code double The HTTP status code representing the result of the API call errorCode A more specific, domain-specific error code (use the ErrorCodes enum) message string A human-readable message describing the error validationIssues object — OPTIONAL
401 Unauthorized, missing or invalid access token