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

# Check wallet invite status

> Checks whether a wallet address is whitelisted and returns associated information.



## OpenAPI

````yaml /openapi/phoenix-public-api.json get /v1/invite/check/{wallet}
openapi: 3.1.0
info:
  title: Phoenix Eternal API
  description: >-
    RESTful API for accessing Phoenix Eternal perpetual trading data. Provides
    real-time orderbook levels, asset information, and market metadata.
  termsOfService: https://www.phoenix.trade/terms-of-service
  contact:
    name: Phoenix Development Team
    url: https://github.com/Ellipsis-Labs/phoenix
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://perp-api.phoenix.trade
    description: Phoenix Eternal Perp API
security: []
tags:
  - name: Auth
    description: Wallet and session authentication.
  - name: Exchange
    description: Exchange, market, candle, and no-referral register-instruction workflows.
  - name: Invite
    description: Invite validation, referral activation, and wallet allowlist checks.
  - name: Notifications
    description: Trader notification reads and acknowledgement helpers.
  - name: Trader
    description: Trader state, account history, and transaction builders.
externalDocs:
  url: https://docs.phoenix.trade
  description: Phoenix developer documentation
paths:
  /v1/invite/check/{wallet}:
    get:
      tags:
        - Invite
      summary: Check wallet invite status
      description: >-
        Checks whether a wallet address is whitelisted and returns associated
        information.
      operationId: get.v1.invite.check.by_wallet
      parameters:
        - name: wallet
          in: path
          description: Solana wallet address to check
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Whitelist status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckWalletResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '500':
          $ref: '#/components/responses/ErrorResponse'
        '503':
          $ref: '#/components/responses/ErrorResponse'
      security:
        - PhoenixBearerAuth: []
components:
  schemas:
    CheckWalletResponse:
      type: object
      required:
        - whitelisted
      properties:
        invite_code_used:
          type:
            - string
            - 'null'
        whitelisted:
          type: boolean
        whitelisted_at:
          type:
            - string
            - 'null'
          format: date-time
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    ErrorResponse:
      description: Standard JSON error payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    PhoenixBearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token issued by `/v1/auth/*` login endpoints.

````