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

# Get a wallet authorization challenge

> Get organization-bound EIP-712 typed data to sign for wallet admission. The authorization expires in five minutes.

Request this challenge using your Ground API key. Have the wallet sign the returned `typedData.domain`, `typedData.types`, and `typedData.value`, then send its signature together with `issuedAt` and `expiresAt` to the allowlist endpoint. The challenge expires after five minutes.


## OpenAPI

````yaml swagger/swagger-combined.yaml GET /v2/gvaults/{gVaultId}/allowlist/{address}/authorization
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for Portfolio Wallets, gtokens, MicroVaults, and webhooks.
  version: 2.0.0
servers:
  - url: https://sandbox.groundtech.co
  - url: https://production.groundtech.co
security:
  - bearerAuth: []
tags:
  - name: System
    description: System health and utility endpoints.
  - name: Sandbox Faucets
    description: Sandbox-only test token faucets.
  - name: Portfolio Wallets
    description: >-
      Portfolio wallets with strategy allocation, deposits, withdrawals, and
      yield positions.
  - name: gVaults
    description: >-
      Direct access to gtokens with deposit access controls and optional fee
      wrappers.
  - name: MicroVaults
    description: >-
      Customer-owned onchain vaults with externally held ERC-20 shares. Private
      preview in sandbox on Ethereum Sepolia.
  - name: Webhook Endpoints
    description: Webhook endpoint management for portfolio wallet notifications.
paths:
  /v2/gvaults/{gVaultId}/allowlist/{address}/authorization:
    parameters:
      - name: gVaultId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/GVaultId'
      - name: address
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/NonzeroEvmAddress'
    get:
      tags:
        - gVaults
      summary: Get a wallet authorization challenge
      description: >-
        Get organization-bound EIP-712 typed data to sign for wallet admission.
        The authorization expires in five minutes.
      operationId: getGVaultAllowlistAuthorization
      responses:
        '200':
          description: Wallet authorization challenge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GTokenAdmissionAuthorization'
        '400':
          description: Invalid address or parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Organization is not eligible for this yield source.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: gtoken not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    GVaultId:
      type: string
      description: Source ID returned by the gtoken yield-source catalogue.
      enum:
        - ground-ustb-vault
      example: ground-ustb-vault
    NonzeroEvmAddress:
      type: string
      description: >-
        Valid nonzero EVM EOA or contract address. Mixed-case values must use a
        valid EIP-55 checksum.
      minLength: 42
      maxLength: 42
      pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
      example: '0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81'
    GTokenAdmissionAuthorization:
      type: object
      additionalProperties: false
      required:
        - typedData
        - issuedAt
        - expiresAt
      properties:
        issuedAt:
          type: integer
          description: Issuance time in Unix seconds.
        expiresAt:
          type: integer
          description: Expiry time in Unix seconds.
        typedData:
          type: object
          additionalProperties: false
          required:
            - domain
            - types
            - value
          properties:
            domain:
              type: object
              description: >-
                EIP-712 domain including name, version, chainId and
                verifyingContract.
            types:
              type: object
              description: EIP-712 Admission type definitions.
            value:
              type: object
              description: >-
                Admission message including opaque organizationBinding, wallet,
                permissionKind, issuedAt and expiresAt.
    ErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: >-
            Human-readable error message. May change without notice; do not
            parse programmatically.
        code:
          type: string
          description: >-
            Machine-readable error code. Stable across API versions — safe to
            switch on in client code.
          enum:
            - validation_error
            - unknown_parameters
            - unsupported_chain
            - unsupported_token
            - invalid_destination_address
            - precision_overflow
            - invalid_cursor
            - unauthenticated
            - forbidden
            - wallet_not_found
            - wallet_limit_reached
            - withdrawal_not_found
            - deposit_not_found
            - yield_source_not_found
            - wallet_projection_unavailable
            - insufficient_funds
            - duplicate_request_id
            - request_id_conflict
            - invalid_position_weight
            - invalid_withdrawal_plan
            - payout_not_found
            - webhook_not_found
            - webhook_duplicate_url
            - withdrawal_not_cancellable
            - withdrawal_already_cancelled
            - withdrawal_payout_in_progress
            - withdrawal_policy_required
            - workflow_conflict
            - stale_rebalance_plan
            - stale_wallet_strategy
            - payout_already_terminal
            - payout_in_progress
            - payout_not_retryable
            - address_book_entry_not_found
            - address_book_duplicate_entry
            - address_book_whitelist_violation
            - rate_limited
            - rate_limit_exceeded
            - internal_error
            - wallet_creation_failed
            - service_temporarily_unavailable
    AuthErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Authentication or authorization error message.
        message:
          type: string
          nullable: true
          description: Additional auth middleware detail, when present.
        code:
          type: string
          nullable: true
          enum:
            - unauthenticated
            - forbidden
          description: >-
            Some auth and scope failures include a stable code; middleware
            errors may omit it.
    ServiceUnavailableError:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            retryable:
              type: boolean
              description: Whether the client should retry with the same requestId
  responses:
    Unauthorized:
      description: >-
        The request is missing a valid bearer token, or the token is invalid or
        expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthenticated request
            message: Missing or invalid bearer token
    ServiceUnavailable:
      description: >-
        An upstream dependency is temporarily unavailable. The request can be
        retried with the same `requestId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceUnavailableError'
          example:
            error: Service temporarily unavailable
            code: service_temporarily_unavailable
            retryable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.