> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vibechain.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check allowlist eligibility

> Returns whether an address is listed and, when eligible, the Merkle proof required by the launch flow.



## OpenAPI

````yaml /api-reference/vibemarket_openapi.yml get /whitelist/check/{slug}
openapi: 3.0.3
info:
  title: vibe.market API
  version: 1.0.0
  description: |
    Production API for vibe.market packs, games, collections, creator drafts,
    allowlists, market activity, social features, recovery tools, and analytics.

    Most operations require a caller-specific VibeChain API key in the
    `API-KEY` header. Account-bound writes additionally require a vibe.market
    session token in `Authorization: Bearer <token>`. Public or Bearer-only
    exceptions are marked on the individual operation.
  contact:
    name: VibeChain developer support
    email: gm@vibechain.com
    url: https://docs.vibechain.com/api-reference/vibemarket-intro
servers:
  - url: https://build.vibechain.com/vibe/boosterbox
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Packs
    description: Read pack ownership, state, rarity, and metadata.
  - name: Collections
    description: Read collection holdings, statistics, and activity.
  - name: Games
    description: Discover games and read launch configuration.
  - name: Metadata
    description: Read published metadata and update launched collections.
  - name: Creator drafts
    description: Create, autosave, inspect, confirm, and delete launch drafts.
  - name: Allowlists
    description: Configure draft allowlists and generate Merkle proofs.
  - name: Activity
    description: Read recent packs and recover indexed transaction events.
  - name: Social
    description: Read chat, react to messages, and report collections.
  - name: Analytics
    description: Read price history, leaderboards, and platform totals.
  - name: Utility
    description: Resolve slugs, regions, prices, and processing readiness.
paths:
  /whitelist/check/{slug}:
    get:
      tags:
        - Allowlists
      summary: Check allowlist eligibility
      description: >-
        Returns whether an address is listed and, when eligible, the Merkle
        proof required by the launch flow.
      operationId: checkVibeMarketAllowlist
      parameters:
        - $ref: '#/components/parameters/SlugPath'
        - in: query
          name: address
          schema:
            $ref: '#/components/schemas/EvmAddress'
      responses:
        '200':
          description: Allowlist status and proof
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllowlistCheckResponse'
        '400':
          $ref: '#/components/responses/InvalidInput'
        '429':
          $ref: '#/components/responses/ApiKeyOrRateLimit'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    SlugPath:
      in: path
      name: slug
      required: true
      schema:
        type: string
        minLength: 1
  schemas:
    EvmAddress:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x1111111111111111111111111111111111111111'
    AllowlistCheckResponse:
      type: object
      required:
        - success
        - whitelistEnabled
        - isWhitelisted
        - proof
        - totalWhitelisted
        - isDraft
      properties:
        success:
          type: boolean
          enum:
            - true
        whitelistEnabled:
          type: boolean
        merkleRoot:
          type: string
          nullable: true
        isWhitelisted:
          type: boolean
        proof:
          type: array
          items:
            type: string
            pattern: ^0x[a-fA-F0-9]{64}$
        totalWhitelisted:
          type: integer
          minimum: 0
        isDraft:
          type: boolean
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        error:
          description: >-
            Optional diagnostic detail. Do not depend on this field being
            present in production.
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
  responses:
    InvalidInput:
      description: Invalid or incomplete request input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid contract address
    ApiKeyOrRateLimit:
      description: API key missing/invalid or the caller's rate allowance is exhausted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: >-
              Too many requests or invalid API key! See docs.vibechain.com for
              more info.
    InternalError:
      description: The server could not complete the operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Failed to complete request
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: API-KEY
      description: Caller-specific VibeChain API key used for quota and abuse control.

````