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

# List business signal sources

> Lists every business signal source registration, active and revoked: the name a policy's `signalSources` uses, the HTTPS endpoint Parmana asks, and the Ed25519 key its answers must be signed with, if one is registered.



## OpenAPI

````yaml openapi.bundled.yaml GET /business-signal-sources
openapi: 3.1.0
info:
  title: Parmana API
  version: 1.0.0
  description: >
    Parmana sits between an AI agent and the systems it acts on. An agent sends
    a Business Transaction: who

    authorized it, what action it wants, and the facts that justify it. Parmana
    evaluates the policy bound to

    the action, checks any signed human approval the policy requires, releases
    the action to the connector

    only if the policy approves, and returns a signed Execution Trust Record
    anyone can verify.


    **Authentication.** Send `Authorization: Bearer <key>` on every request. The
    only routes that need no key

    are the probes, the documents and the independent verification routes: `GET
    /health`, `GET /ready`,

    `GET /openapi.yaml`, `GET /openapi.json`, `GET /api-manifest.json`, `GET
    /documentation`,

    `GET /reference`, `GET /parmana-handbook.pdf`, `GET
    /handbook/download-leads`,

    `POST /handbook/download-leads`, `POST /refusal/verify`, `POST
    /execution-intents/verify`,

    `POST /audit/verify`, `GET /keys/{keyId}` and `GET /.well-known/jwks.json`.
    A missing or unknown key

    returns `401` before anything else runs. The server holds only a hash of
    each key. See

    [Authentication](/api-reference/authentication).


    **Two kinds of key.** An agent or service key may invoke only the
    capabilities listed on it. A human key

    (`credentialHolderType: USER`) is required for governance: proposing and
    approving policies, approvers

    and external connectors, and repairing Execution Intents. Approving or
    rejecting a change also needs a

    step up authorization signed with the checker's own step up key, and the
    checker must not be the

    person who proposed it.


    **Ownership.** Every lookup by `businessTransactionId` is scoped to the key
    that submitted the

    transaction. A transaction submitted by another key returns the same `404`
    as one that does not exist.


    **Try it live.** The first server below is the public sandbox,
    `https://parmana-sandbox.vercel.app`: the same

    code as production with its own database, keys and demo approver, whose one
    action, `sandbox:receipt`,

    acts on nothing. Every "Try it" panel calls it with the published demo key
    prefilled. The demo key may

    invoke only `sandbox:receipt`, so other capabilities return `403` and
    governance routes return

    `403 NON_HUMAN_CALLER_DENIED`. Everything sent to the sandbox is visible to
    every visitor. See

    [Playground](/playground). Production needs a key issued by its operator.


    **Start here:** the [Playground](/playground) (no install), the
    [Quickstart](/quickstart), then [Integrate Parmana](/agents/integrate) for
    agents

    and [Connect any external system](/guides/connect-any-external-system) for
    your own endpoint.
  contact:
    name: Parmana Systems
    email: founder@parmanasystems.com
  license:
    name: Proprietary, source-available for evaluation only, see LICENSE
    url: https://github.com/pavancharak/parmana/blob/main/LICENSE
servers:
  - url: https://parmana-sandbox.vercel.app
    description: >-
      Public sandbox (the docs playground). Same code as production, demo data
      only, acts on nothing. Demo key prefilled.
  - url: https://parmana-api-real.vercel.app
    description: Production. Needs a key issued by the operator.
  - url: http://localhost:3000
    description: Local (packages/api, PORT env var, default 3000)
security:
  - bearerAuth: []
tags:
  - name: Execution
    description: >-
      Executes a Business Transaction through the complete Execution Trust
      pipeline
  - name: Transactions
    description: Business Transaction creation and retrieval
  - name: Verification
    description: Deterministic verification of an Execution Trust Record
  - name: Receipts
    description: Cryptographically signed Execution Trust Receipts
  - name: Trust Records
    description: Execution Trust Record retrieval
  - name: Replay
    description: Deterministic replay of a recorded Execution Trust Record
  - name: Policies
    description: Policy existence/readability check
  - name: Policy Governance
    description: Maker-checker proposal, listing, approval, and rejection of policy changes
  - name: Approvers
    description: Maker-checker for the keys trusted to sign approvals, without a deploy
  - name: External Connectors
    description: >-
      Maker-checker for binding a capability to an operator's HTTPS endpoint and
      its policy, without a deploy (ADR-0013)
  - name: Business Signal Sources
    description: >-
      Maker-checker for the business systems Parmana asks for the facts a policy
      needs, without a deploy (RFC-0023)
  - name: Authority Grants
    description: >-
      Maker-checker for which agent may have which action decided, within which
      limits, until when (RFC-0023)
  - name: Sandbox
    description: >-
      Routes that exist only on the public sandbox (ADR-0014), for trying
      Parmana from a browser
  - name: Refusal Records
    description: >-
      Durable, signed evidence that a policy decision rejected a transaction
      (RFC-0021)
  - name: Execution Intents
    description: >-
      A signed statement, stored before an action is released, of exactly what
      is about to be released, plus the operator tools to find and repair a
      released action that has no signed Trust Record (ADR-0012)
  - name: Audit
    description: >-
      Signed caller-authentication audit events, independently
      third-party-verifiable
  - name: System
    description: Operational endpoints
paths:
  /business-signal-sources:
    get:
      tags:
        - Business Signal Sources
      summary: List business signal sources
      description: >
        Lists every business signal source registration, active and revoked: the
        name a policy's

        `signalSources` uses, the HTTPS endpoint Parmana asks, and the Ed25519
        key its answers must be

        signed with, if one is registered. Revoked registrations stay listed, so
        every Trusted Signal ever

        recorded can be traced to the registration that produced it. Needs a
        human key. See

        [Connect a business system as a signal
        source](/guides/connect-a-business-signal-source).
      operationId: listBusinessSignalSources
      responses:
        '200':
          description: The registrations.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/business-signal-sources-list-response.schema
              examples:
                active:
                  summary: Real captured response
                  value:
                    sources:
                      - registrationId: 5ba7d3a6-d56d-4e90-b588-402d44aeee0c
                        name: erp
                        endpointUrl: https://orders.example.com/parmana/signals
                        timeoutMs: 5000
                        publicKeyPem: >
                          -----BEGIN PUBLIC KEY-----

                          MCowBQYDK2VwAyEAsgWd/PtRf9OsENif9bgJegghUpmEOOZN5NROxc3zpPc=

                          -----END PUBLIC KEY-----
                        keyId: erp-2026-10
                        status: active
                        registeredAt: '2026-10-11T02:58:24.745Z'
                withRevoked:
                  summary: >-
                    Real captured response, after a revoke: the registration
                    stays listed
                  value:
                    sources:
                      - registrationId: 5ba7d3a6-d56d-4e90-b588-402d44aeee0c
                        name: erp
                        endpointUrl: https://orders.example.com/parmana/signals
                        timeoutMs: 5000
                        publicKeyPem: >
                          -----BEGIN PUBLIC KEY-----

                          MCowBQYDK2VwAyEAsgWd/PtRf9OsENif9bgJegghUpmEOOZN5NROxc3zpPc=

                          -----END PUBLIC KEY-----
                        keyId: erp-2026-10
                        status: revoked
                        registeredAt: '2026-10-11T02:58:24.745Z'
                        revokedByChangeId: 92ba551c-02bb-4089-9762-6d2d3a89392e
                        revokedAt: '2026-10-11T02:58:24.800Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: '`NON_HUMAN_CALLER_DENIED`: this needs a human key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.schema'
              examples:
                service:
                  summary: Real captured response, a service credential
                  value:
                    error: >-
                      This action requires a caller credential provisioned as a
                      verified human (credentialHolderType: USER).
                    code: NON_HUMAN_CALLER_DENIED
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://parmana-api-real.vercel.app/business-signal-sources \
              -H "Authorization: Bearer $PARMANA_API_KEY"
        - lang: typescript
          label: TypeScript
          source: |-
            import { ParmanaClient } from "@parmana/sdk";

            const client = new ParmanaClient({
              endpoint: "https://parmana-api-real.vercel.app",
              apiKey: process.env.PARMANA_API_KEY!,
            });

            for (const source of await client.businessSignalSources()) {
              console.log(source.name, source.status, source.endpointUrl);
            }
        - lang: python
          label: Python
          source: |-
            import os

            from parmana import ParmanaClient

            client = ParmanaClient(
                endpoint="https://parmana-api-real.vercel.app",
                api_key=os.environ["PARMANA_API_KEY"],
            )

            for source in client.list_business_signal_sources():
                print(source.name, source.status, source.endpoint_url)
components:
  schemas:
    business-signal-sources-list-response.schema:
      title: Business Signal Sources List Response
      description: >-
        Response of GET /business-signal-sources: every registration, active and
        revoked.
      type: object
      additionalProperties: false
      required:
        - sources
      properties:
        sources:
          type: array
          items:
            $ref: '#/components/schemas/business-signal-source.schema'
    error.schema:
      title: Error Response
      description: >-
        Shared error envelope produced by
        packages/api/src/middleware/error-handler.ts and by every route's inline
        validation checks. error is always a plain human-readable string (never
        a nested object). code is present only when the failure was a
        RuntimeError subclass reaching the centralized error handler
        (VerificationFailedError, ReceiptGenerationError, or an uncategorized
        RuntimeError); it is absent from every inline route-level check
        (businessTransactionId format/required checks) and from
        BusinessTransactionValidationError, PolicyValidationError,
        SignalValidationError, PolicyNotFoundError,
        DuplicateBusinessTransactionError, and the generic 500 fallback. POST
        /policies/validate does NOT use this envelope at all. See its own
        response schema. For the triggering condition and recommended caller
        action behind any specific error/code/status combination, see the Error
        catalog at /api-reference/error-catalog.
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: >-
            Stable machine-readable error code. Only present for errors that
            reach the handler as a RuntimeError.
          examples:
            - RUNTIME_ERROR
            - VERIFICATION_FAILED
            - RECEIPT_GENERATION_FAILED
            - POLICY_DENIED
            - CAPABILITY_NOT_ALLOWED
            - RATE_LIMITED
            - AUDIT_UNAVAILABLE
            - SIGNING_UNAVAILABLE
            - CONNECTOR_NOT_REGISTERED
            - EXECUTION_RECORD_INCOMPLETE
            - EXECUTION_INTENT_UNAVAILABLE
            - EXECUTION_INTENT_RESULT_NOT_RECORDED
            - EXECUTION_INTENT_NOT_FOUND
            - EXECUTION_INTENTS_NOT_ENABLED
            - EXECUTION_INTENT_NOT_RESOLVABLE
            - EXECUTION_INTENT_RESOLUTION_INVALID
            - NON_HUMAN_CALLER_DENIED
            - EXECUTION_OUTCOME_UNKNOWN
            - AUTHORIZATION_NO_LONGER_VALID
        executionStatus:
          type: string
          enum:
            - EXECUTION_UNKNOWN
            - NOT_EXECUTED
          description: >-
            RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN:
            the action was released and the call failed, so whether it ran is
            unknown; never reported as failed, and the Execution Intent stays
            ERRORED until a person resolves it. NOT_EXECUTED with
            AUTHORIZATION_NO_LONGER_VALID: the release was refused because a
            business condition or the authority grant it rested on no longer
            held, and nothing was sent.
      examples:
        - error: businessTransactionId must be a valid UUID.
        - error: >-
            Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already
            exists.
        - error: >-
            Execution rejected: Vendor payment rejected because the assessed
            payment risk exceeds the maximum permitted threshold.
          code: RUNTIME_ERROR
    business-signal-source.schema:
      title: Business Signal Source
      description: >-
        A business system Parmana asks for the facts a policy declares in
        signalSources (RFC-0023), registered through business signal source
        changes. Nothing is deleted: a revoked registration stays listed.
      type: object
      additionalProperties: false
      required:
        - registrationId
        - name
        - endpointUrl
        - timeoutMs
        - status
        - registeredAt
      properties:
        registrationId:
          type: string
          description: The changeId of the approved register change that created it.
        name:
          type: string
          pattern: ^[a-z0-9][a-z0-9-]{0,62}$
          description: The name a policy's signalSources uses in `source`.
        endpointUrl:
          type: string
          description: >-
            The HTTPS endpoint Parmana posts each signed query to. It is the
            query's audience.
        timeoutMs:
          type: integer
        publicKeyPem:
          type: string
          description: >-
            The Ed25519 public key, SPKI PEM, the source signs its answers with.
            When present, an answer without a valid signature is refused as
            SOURCE_UNAVAILABLE.
        keyId:
          type: string
          pattern: ^[A-Za-z0-9._-]{1,128}$
          description: >-
            A label for publicKeyPem. When present, an answer signed under
            another keyId is refused.
        status:
          type: string
          enum:
            - active
            - revoked
          description: At most one active registration per name.
        registeredAt:
          type: string
          format: date-time
        revokedByChangeId:
          type: string
          description: 'revoked only: the approved change that revoked it.'
        revokedAt:
          type: string
          format: date-time
          description: revoked only.
  responses:
    Unauthorized:
      description: >-
        The `Authorization` header is missing, is not a bearer key, or names a
        key the server does not know. Nothing ran. Send a valid key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error.schema'
          examples:
            authRequired:
              summary: Real captured response, missing or invalid Authorization header
              value:
                error: authentication required
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      x-default: 2VfYWCzt_cBAPK-8uufX6ordfY2JuQhFPsohuEumKME
      description: >
        Caller API key issued by scripts/generate-api-key.ts. Sent as
        Authorization: Bearer <key>. Verified against a stored SHA-256 hash in
        constant time by packages/api/src/auth/StaticKeyAuthenticator.ts.
        Required on every route not listed as exempt in this document's
        top-level description. See /api-reference/authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.