> ## 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.

# Preview a MicroVault redemption

> Returns an instant route when liquidity is available, otherwise a requested route that settles at actual attributable proceeds.

Determine whether a redemption can execute immediately or requires underlying source liquidation.


## OpenAPI

````yaml swagger/swagger-combined.yaml POST /v2/microvaults/vaults/{vaultId}/redemptions/preview
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for Portfolio Wallets, gVaults, 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: App-specific Ground vaults with customer access and fee sharing.
  - 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/microvaults/vaults/{vaultId}/redemptions/preview:
    parameters:
      - name: vaultId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UuidV4'
    post:
      tags:
        - MicroVaults
      summary: Preview a shareholder redemption
      description: >-
        Returns an instant route when liquidity is available, otherwise a
        requested route that settles at actual attributable proceeds.
      operationId: previewMicrovaultRedemption
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewMicroVaultRedemptionRequest'
      responses:
        '200':
          description: Redemption route and transaction data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultRedemptionPreviewResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultError'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    UuidV4:
      type: string
      format: uuid
      pattern: >-
        ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
      example: 8f4c52d7-62ab-4db9-a964-92f481f6b851
    PreviewMicroVaultRedemptionRequest:
      type: object
      additionalProperties: false
      required:
        - owner
        - receiver
        - shares
        - minAssetsOut
      properties:
        owner:
          $ref: '#/components/schemas/NonzeroEvmAddress'
        receiver:
          $ref: '#/components/schemas/NonzeroEvmAddress'
        shares:
          $ref: '#/components/schemas/MicroVaultUint256'
        minAssetsOut:
          $ref: '#/components/schemas/MicroVaultUint256'
          description: >-
            Minimum output for an instant redemption. Requested redemptions
            settle at actual attributable proceeds.
      example:
        owner: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22'
        receiver: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22'
        shares: '1000000000000000000'
        minAssetsOut: '990000'
    MicroVaultRedemptionPreviewResponse:
      type: object
      required:
        - plan
      properties:
        plan:
          type: object
          additionalProperties: true
      example:
        plan:
          route: requested
          estimatedAssetsUnits: '5000000'
          transaction:
            to: '0x848837d997f0ce3f753d4644ee51b837ab8b386e'
            data: '0xabcdef01'
          settlement: actual_attributable_proceeds
    MicroVaultError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: invalid_request
        message:
          type: string
          nullable: true
          example: allocation targets and idleTargetBps must total 10000
        details:
          nullable: true
      example:
        error: invalid_request
        message: allocation targets and idleTargetBps must total 10000
    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'
    MicroVaultUint256:
      type: string
      pattern: ^(0|[1-9][0-9]*)$
      description: Unsigned base-10 integer in token base units.
      example: '1000000'
    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.
  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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````