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

# Get the OpenAPI document

> Returns this OpenAPI 3.1 document. It needs no API key.



## OpenAPI

````yaml /generated/inbound-api-v1.openapi.json get /v1/openapi.json
openapi: 3.1.0
info:
  description: >-
    Send Customers, Receivables, and Payment observations from your source
    system to PayPathIQ one record at a time. Start in sandbox with a sandbox
    key and synthetic data. Every error type links to a page at
    https://docs.paypathiq.com/problems/{code}.
  title: PayPathIQ Inbound Receivables API
  version: 1.0.0
servers:
  - description: Sandbox
    url: https://api.sandbox.paypathiq.com
  - description: Production
    url: https://api.paypathiq.com
security:
  - BearerAuth: []
tags:
  - description: People and businesses that owe one Client.
    name: Customers
  - description: Independently recoverable Receivables.
    name: Receivables
  - description: Immutable evidence of external payments, refunds, and reversals.
    name: Payment observations
  - description: Explicit Receivable pause and closure commands.
    name: Receivable lifecycle
  - description: This machine-readable API contract.
    name: Specification
paths:
  /v1/openapi.json:
    get:
      tags:
        - Specification
      summary: Get the OpenAPI document
      description: Returns this OpenAPI 3.1 document. It needs no API key.
      operationId: getOpenApiDocument
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: The current OpenAPI document.
          headers:
            Cache-Control:
              description: Integration-facing responses are never cached.
              schema:
                const: no-store
                type: string
            X-Request-Id:
              description: PayPathIQ-generated support correlation identifier.
              schema:
                format: uuid
                type: string
      security: []
components:
  securitySchemes:
    BearerAuth:
      bearerFormat: ppiq_test_<keyId>_<secret> or ppiq_live_<keyId>_<secret>
      description: >-
        Integration-owned environment-specific API key. Never paste a production
        key into documentation tools.
      scheme: bearer
      type: http

````