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

# Onboard an organization

> Creates or resumes the Turnkey authority required to manage MicroVaults. This request has no body.

Create or resume the authority required to manage your organization's MicroVaults.

<Note>
  MicroVaults are in private preview for enabled sandbox organizations on Ethereum Sepolia.
</Note>


## OpenAPI

````yaml swagger/swagger-combined.yaml POST /v2/microvaults/onboarding
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/onboarding:
    post:
      tags:
        - MicroVaults
      summary: Onboard the organization for MicroVaults
      description: >-
        Creates or resumes the Turnkey authority required to manage MicroVaults.
        This request has no body.
      operationId: onboardMicrovaultOrganization
      responses:
        '200':
          description: Current onboarding state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultOnboarding'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          description: Managed onboarding is temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultError'
components:
  schemas:
    MicroVaultOnboarding:
      type: object
      additionalProperties: false
      required:
        - status
        - customerRecordId
        - customerId
        - authorityAddress
        - chainId
        - policyRegistryAddress
      properties:
        status:
          type: string
          enum:
            - provisioning
            - registering
            - activating
            - active
        customerRecordId:
          allOf:
            - $ref: '#/components/schemas/UuidV4'
          nullable: true
        customerId:
          $ref: '#/components/schemas/MicroVaultUint256'
        authorityAddress:
          $ref: '#/components/schemas/NullableNonzeroEvmAddress'
        chainId:
          type: integer
          example: 11155111
        policyRegistryAddress:
          $ref: '#/components/schemas/NonzeroEvmAddress'
      example:
        status: active
        customerRecordId: 8ef3d494-7b6f-4df4-9d45-09f31196368f
        customerId: '190025120042021478378651368413409605263'
        authorityAddress: '0x1111111111111111111111111111111111111111'
        chainId: 11155111
        policyRegistryAddress: '0x6666666666666666666666666666666666666666'
    MicroVaultError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Stable machine-readable error code.
        message:
          type: string
          nullable: true
        details:
          nullable: true
      example:
        error: microvaults_not_enabled
        message: MicroVaults are not enabled for this organization
    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
    MicroVaultUint256:
      type: string
      pattern: ^(0|[1-9][0-9]*)$
      description: >-
        Unsigned base-10 integer string. Asset and share amounts use token base
        units.
      example: '1000000'
    NullableNonzeroEvmAddress:
      type: string
      nullable: true
      description: >-
        Deployed nonzero EVM contract address, or null while deployment is
        pending.
      minLength: 42
      maxLength: 42
      pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
      example: '0x7c4a1cb5a3d5c3c4e019c3f6ab29a0f98c21b814'
    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'
    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

````