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

# Readiness check



## OpenAPI

````yaml GET /readyz
openapi: 3.1.0
info:
  title: Qustody API
  description: >
    Non-custodial custody and orchestration API for Quantum Chain (post-quantum
    blockchain).

    Provides Fireblocks-like operating model for institutional integrators:

    multi-tenant vault/wallet management, transaction lifecycle with policy
    enforcement,

    external (callback-based) signing, webhook-driven event delivery, and full
    audit trail.
  version: 1.0.0
  contact:
    name: Quantum Chain Platform Team
  license:
    name: LGPL-3.0-or-later
servers:
  - url: '{baseUrl}/v1'
    description: Qustody API
    variables:
      baseUrl:
        default: https://api.qustody.io
security:
  - BearerAPIKey: []
tags:
  - name: health
    description: Liveness and readiness probes
  - name: tenants
    description: Tenant (integrator) management
  - name: vaults
    description: Vault (logical wallet grouping) management
  - name: wallets
    description: Wallet (on-chain address) registration and lookup
  - name: transactions
    description: Transaction lifecycle – create, sign, approve, reject, query
  - name: assets
    description: Supported asset registry
  - name: webhooks
    description: Webhook endpoint management
  - name: sso
    description: Single Sign-On (OIDC and SAML) authentication
  - name: tokens
    description: Token Management — Beta / Proposed.
paths:
  /readyz:
    get:
      tags:
        - health
      summary: Readiness probe
      operationId: healthReady
      responses:
        '200':
          description: Service is ready
        '503':
          description: Service is not ready
      security: []
components:
  securitySchemes:
    BearerAPIKey:
      type: http
      scheme: bearer
      description: 'API key authentication. Format: `Bearer {key_id}:{secret}`'

````