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

# Service health

> Reports configured capabilities. Booleans reflect configuration presence, not live connectivity.



## OpenAPI

````yaml /openapi.yaml get /health
openapi: 3.1.0
info:
  title: Confiroll payroll-api
  version: 1.0.0
  description: >
    The Confiroll BFF (backend-for-frontend) for confidential contractor payroll
    on Stellar **testnet**. It issues session JWTs (SEP-10 wallet or Privy
    email) and fee-bumps browser-signed confidential transfers (Fork B). It
    holds operational keys only, never a user's signing or viewing key.


    Every handled error returns `{ "error": string }`. Request bodies are
    limited to 256 KiB.
servers:
  - url: https://api.confiroll.com
    description: Live testnet deployment
security: []
tags:
  - name: Health
    description: Service health.
  - name: Auth
    description: Session issuance via SEP-10 (wallet) or Privy (email).
  - name: Transfers
    description: The core confidential-payout call (Fork B fee-bump).
  - name: Batch runs
    description: Run a confidential batch of payouts.
  - name: Withdrawals and disclosure
    description: >-
      Withdraw and auditor disclosure. These routes return 501; the operations
      run in the client tooling.
  - name: Session and role
    description: Resolves the signed-in user's role.
  - name: Contractors
    description: Contractor directory (public data only).
  - name: Batches
    description: SDP-aligned batch (disbursement) records.
  - name: Payouts
    description: SDP-aligned payout (payment) records.
  - name: Funding
    description: Faucet and CCTP vault state.
paths:
  /health:
    get:
      tags:
        - Health
      summary: Service health
      description: >-
        Reports configured capabilities. Booleans reflect configuration
        presence, not live connectivity.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
components:
  schemas:
    Health:
      type: object
      properties:
        ok:
          type: boolean
          examples:
            - true
        network:
          type: string
          description: >-
            "testnet" when the configured passphrase is the test network, else
            "other".
          examples:
            - testnet
        privy:
          type: boolean
          description: Whether Privy email login is configured.
        sdp:
          type: boolean
          description: Whether SDP relay database/tenant/distribution are configured.
        sponsor:
          type: boolean
          description: >-
            Whether the fee-bump sponsor secret and contract allow-list are
            configured.
      required:
        - ok
        - network
        - privy
        - sdp
        - sponsor

````