philidor-io User terms API

openapi: 3.2.0
info:
  title: Philidor Io User terms API
  version: 1.2.0
  description: 'Operations tagged User terms across 2 of this provider''s published API definitions: philidor-openapi.json, philidor-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.philidor.io
  description: Production
- url: http://localhost:3003
  description: Local
tags:
- name: User terms
paths:
  /v1/users/{address}/terms:
    get:
      tags:
      - User terms
      summary: Current Agent Vault terms acceptance
      description: 'Returns whether this wallet has a stored acceptance of the current Agent Vault terms version and text hash. Acceptance of an older version is not current. The response is wallet-specific and must not be cached. No signature is required: the status is a boolean for a public address.'
      parameters:
      - schema:
          type: string
          pattern: ^0x[a-fA-F0-9]{40}$
          description: Wallet address (Ethereum)
        required: true
        name: address
        in: path
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
      responses:
        '200':
          description: Acceptance status for the current terms version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsStatus'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - {}
      - ApiKeyAuth: []
      operationId: getV1UsersAddressTerms
    post:
      tags:
      - User terms
      summary: Store a wallet-signed terms acceptance
      description: Verifies an EIP-191 signature of the message from GET /v1/users/{address}/terms/auth-message and stores it. The message is chain-agnostic (address in the path, no chain id) and binds a single-use server nonce, the terms version and the sha256 of the accepted text. A wrong text hash or version is rejected and does not consume the nonce. A replayed nonce is 401. Repeating the current version with a fresh signature keeps the original stored proof.
      parameters:
      - schema:
          type: string
          pattern: ^0x[a-fA-F0-9]{40}$
          description: Wallet address (Ethereum)
        required: true
        name: address
        in: path
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
                  minLength: 1
                  description: 'EIP-191 message from GET /v1/users/{address}/terms/auth-message. Chain-agnostic: address, nonce, terms version and text sha256, no chain id.'
                signature:
                  type: string
                  pattern: ^0x[0-9a-fA-F]{130}$
                  description: EIP-191 signature of message by the owner wallet (0x + 130 hex).
              required:
              - message
              - signature
      responses:
        '200':
          description: Current terms are accepted for this wallet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsStatus'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '400':
          description: Malformed body
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Missing, invalid, expired or replayed signature
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: This terms version is already stored with a different text hash. The version must change before a new text can be accepted.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - {}
      - ApiKeyAuth: []
      operationId: postV1UsersAddressTerms
    servers:
    - url: https://api.philidor.io
      description: Production
    - url: http://localhost:3003
      description: Local
  /v1/users/{address}/terms/auth-message:
    get:
      tags:
      - User terms
      summary: Get the terms message to sign
      description: Returns the EIP-191 message the owner wallet must sign for POST /v1/users/{address}/terms. Query version and textSha256 must match the server current terms; a mismatch is 400 and no nonce is issued. The message includes a single-use nonce valid for five minutes, the terms version and the text sha256. It does not include a chain id.
      parameters:
      - schema:
          type: string
          pattern: ^0x[a-fA-F0-9]{40}$
          description: Wallet address (Ethereum)
        required: true
        name: address
        in: path
      - schema:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$
          description: Terms version the client is accepting. Must match the server.
        required: true
        name: version
        in: query
      - schema:
          type: string
          pattern: ^[0-9a-fA-F]{64}$
          description: sha256 hex of the terms text the client is accepting. Must match the server.
        required: true
        name: textSha256
        in: query
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
      responses:
        '200':
          description: Message to sign
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                - message
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '400':
          description: version or textSha256 does not match the current terms
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - {}
      - ApiKeyAuth: []
      operationId: getV1UsersAddressTermsAuthMessage
    servers:
    - url: https://api.philidor.io
      description: Production
    - url: http://localhost:3003
      description: Local
components:
  headers:
    Retry-After:
      description: Seconds to wait before retrying (429, 503, 504).
      schema:
        type: integer
        minimum: 0
    X-RateLimit-Limit:
      description: Requests allowed in the active window for this caller.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the window resets.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the active window.
      schema:
        type: integer
    X-Request-Id:
      description: Correlation id for the request. A valid inbound X-Request-Id (1-64 word characters or dashes) is echoed; otherwise one is generated. Quote it when reporting a failure.
      schema:
        type: string
  schemas:
    TermsStatus:
      type: object
      properties:
        termsVersion:
          type: string
          description: Terms version the server currently requires.
          example: agent-vault-draft-2026-10-17
        textSha256:
          type: string
          description: Lowercase sha256 of the terms text for termsVersion.
        accepted:
          type: boolean
          description: True when this wallet has a stored acceptance of termsVersion and textSha256.
        acceptedAt:
          type:
          - string
          - 'null'
          format: date-time
          description: Server time the current version was first stored, or null.
      required:
      - termsVersion
      - textSha256
      - accepted
      - acceptedAt
    ErrorEnvelope:
      description: Error body. `legacy_code` is present for one compatibility release when an older endpoint previously emitted a lowercase route-specific code.
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - request_id
          properties:
            code:
              type: string
              pattern: ^[A-Z][A-Z0-9_]*$
              example: NOT_FOUND
            message:
              type: string
              example: Vault not found
            request_id:
              type: string
              description: Correlation id, also in the X-Request-Id header.
            legacy_code:
              type: string
              description: Previous lowercase code during the one-release migration window.
            pricing_url:
              type: string
              description: Present on a tier gate. Same URL as refusal.upgrade_url.
            refusal:
              description: Present on 401/403 for a gated data family (PHI-312). Same object as one row of GET /v1/access/families. x402_price is null until pay-per-request is live.
              type: object
              required:
              - restricted_fields
              - family
              - required_plan
              - upgrade_url
              - x402_price
              properties:
                restricted_fields:
                  type: array
                  items:
                    type: string
                family:
                  type: string
                required_plan:
                  type:
                  - string
                  - 'null'
                  enum:
                  - Free
                  - Analyst
                  - Pro
                  - Data
                  - Decisioning
                  - Embedded
                  - null
                upgrade_url:
                  type: string
                  example: https://philidor.io/pricing
                x402_price:
                  type: 'null'
          additionalProperties: true
  securitySchemes:
    IndexTokenAuth:
      type: http
      scheme: bearer
      description: Separate index preview/client token. Commercial API keys do not unlock private index routes.
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Philidor API key (`Authorization: Bearer pk_live_...`). Optional on public endpoints, where it raises rate limits and unlocks tiered capabilities. The administrative surfaces additionally require operator-set metadata.admin_surface=true; mutations require metadata.admin_role=admin_editor or admin_operator under the same write-role enforcement as admin sessions. A plan tier alone never grants administrative access.'
    AdminCookieAuth:
      type: apiKey
      in: cookie
      name: philidor_admin_session
      description: Administrative session. Additionally IP-allowlisted.
    DashboardCookieAuth:
      type: apiKey
      in: cookie
      name: philidor_dashboard_session
      description: Dashboard session cookie (httpOnly).
x-refined-from:
- philidor-openapi.json
- philidor-io-openapi.json