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

# Self-describing environment (sandbox vs production)

> Public, unauthenticated. Every value is server-derived — any
client-supplied `?env=` / body value is ignored (never read). SDKs and
the dashboard call this at startup to verify they reached the intended
deployment (sandbox = `sandbox-api.peridot.id`, DOKU test mode, no real
money moves). Cacheable for 60s.




## OpenAPI

````yaml /openapi.yaml get /env
openapi: 3.0.3
info:
  title: PeridotID API
  version: 0.1.0
  description: >
    Gaming Identity Platform — Authentication, Identity, and Profile for the
    Peridot ecosystem.


    ## Base URL

    All endpoints are prefixed with `/v1`.


    | Environment | Base URL |

    |---|---|

    | Production | `https://api.pid.peridotvault.com/v1` |

    | Local dev | `http://localhost:3300/v1` |


    ## Authentication

    Authentication is **cookie-based**. After a successful Google sign-in the
    API sets two

    `HttpOnly` cookies:


    - `pid_access` — short-lived JWT access token (15 min), sent on every
    request.

    - `pid_refresh` — long-lived rotating refresh token (30 days), only sent to
    `/v1/auth`.


    Browsers handle these automatically; non-browser clients must send

    `Cookie: pid_access=<token>` on each request and call `/v1/auth/refresh`
    before the

    access token expires.
  contact:
    name: PeridotID
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.pid.peridotvault.com/v1
    description: Production
  - url: http://localhost:3300/v1
    description: Local development
security: []
tags:
  - name: auth
    description: Login, logout, token refresh, and machine (client-credentials) tokens
  - name: identity
    description: The user's identity across products
  - name: profile
    description: The user's public profile
  - name: wallet
    description: >
      The user's wallet, associated with their PID. **Deprecated (V3 surface)**
      — preserved

      for existing clients, backed by `linked_address` chain accounts. Use
      `/account` and

      the smart account instead.
  - name: account
    description: >-
      PeridotID account — owns chain accounts (smart account PDA, legacy linked
      address)
  - name: meta
    description: |
      Deployment metadata: self-describing environment endpoints (sandbox vs
      production). Public, server-derived, never echoing client input.
  - name: fiat
    description: |
      The internal IDR fiat ledger: balances, statements, sends, and money-in.
      Top-ups enter through a hosted DOKU Checkout page (no Sub-Account) and
      credit the internal ledger once the payment is corroborated. Any identity
      can send to any identity (escrow/payouts). Fees: global 0.1% (min Rp100,
      no cap) plus optional per-app fees that stack and credit the app. Bank
      withdrawals (redemption) are disabled for now.
  - name: apps
    description: |
      Third-party apps ("Sign in with PeridotID"): client_id, allowed origins,
      optional backend secret, ledger callbacks (deferred), and a per-app fee
      schedule. Owner-scoped — a non-owner gets 404. App backends authenticate
      server-side with `POST /v1/auth/token` (client credentials).
  - name: credentials
    description: >
      Signing authorities (secp256r1 passkeys). Google OAuth proves identity; a

      passkey authorizes the wallet. The first credential registers freely; each
      additional

      credential requires approval by an existing credential
      (existing-credential approval rule).
  - name: permissions
    description: >
      EVM permission grants (scoped P-256 session keys, WHITEPAPER.md §10).
      Validation is pure

      hygiene + canonical id/challenge computation; submission-time account
      binding

      is enforced by the relay path.
  - name: session-keys
    description: >
      SVM gameplay sessions (Ed25519 session keys in isolated PDAs,
      WHITEPAPER.md §11).

      Validation is pure hygiene + canonical address/challenge computation;

      submission-time vault binding is enforced by the relay path.
  - name: openapi
    description: Machine-readable API specification
paths:
  /env:
    get:
      tags:
        - meta
      summary: Self-describing environment (sandbox vs production)
      description: |
        Public, unauthenticated. Every value is server-derived — any
        client-supplied `?env=` / body value is ignored (never read). SDKs and
        the dashboard call this at startup to verify they reached the intended
        deployment (sandbox = `sandbox-api.peridot.id`, DOKU test mode, no real
        money moves). Cacheable for 60s.
      responses:
        '200':
          description: Server environment
          headers:
            Cache-Control:
              schema:
                type: string
              example: public, max-age=60
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvInfo'
              example:
                env: sandbox
                dokuMode: sandbox
                docs: https://docs.peridot.id
components:
  schemas:
    EnvInfo:
      type: object
      required:
        - env
        - dokuMode
        - docs
      properties:
        env:
          type: string
          enum:
            - sandbox
            - production
          description: Server-derived deployment environment (never echoes client input)
        dokuMode:
          type: string
          enum:
            - sandbox
            - production
          description: DOKU rail mode for this deployment
        docs:
          type: string
          format: uri
          description: Canonical docs base URL
      example:
        env: sandbox
        dokuMode: sandbox
        docs: https://docs.peridot.id

````

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