tektolo-com Verify API

openapi: 3.2.0
info:
  title: Tektolo Capabilities Verify API
  summary: 'Source-cited capabilities for humans, developers and agents: the same findings under the same ruleset always give the same answer.'
  description: 'Rules-based tools for the US rental move-out. Property turnover prices the make-ready work from inspection findings, scaled to the ZIP code''s labor market. Deposit settlement applies each state''s security deposit statute (and covered cities'' ordinances): the return deadline, each deduction assessed, interest, the refund and a draft itemized statement. Every result carries its citations, assumptions and the ruleset version that produced it. No account is needed. The same operations are MCP tools at /mcp/rental-property, and /catalog.json lists each one with its schemas and examples.'
  termsOfService: https://tektolo.com/terms
  contact:
    name: Tektolo
    url: https://tektolo.com/contact
    email: hello@tektolo.com
  version: 0.1.0
servers:
- url: https://tektolo.com
tags:
- name: Verify
paths:
  /v1/verify:
    post:
      tags:
      - Verify
      summary: Check a verify code or a signed result
      description: 'Check a verify code (from a document or a ``/verify/`` link) or an API result''s

        ``signature.jws``. Says whether Tektolo issued it, which tool, ruleset and engine it

        used, when, and whether that ruleset is still current. With ``text``, also whether a

        summary is word for word the one its code was issued for. Nothing is stored.'
      operationId: verify_api_v1_verify_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    RulesetCheck:
      properties:
        version:
          anyOf:
          - type: string
          - type: 'null'
          title: Version
        hash_prefix:
          anyOf:
          - type: string
          - type: 'null'
          title: Hash Prefix
          description: The first 16 hex digits of the ruleset hash.
        status:
          type: string
          enum:
          - current
          - superseded
          - unknown
          - none
          title: Status
        current_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Version
          description: The ruleset this site uses now.
      type: object
      required:
      - version
      - hash_prefix
      - status
      - current_version
      title: RulesetCheck
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    VerifyResponse:
      properties:
        signing:
          type: string
          enum:
          - 'on'
          - 'off'
          title: Signing
        verified:
          type: boolean
          title: Verified
          description: True only when Tektolo's signature checks out.
        reason:
          type: string
          title: Reason
          description: Empty when verified; else malformed, unsupported, unknown_key, bad_signature or signing_off.
        message:
          type: string
          title: Message
        kid:
          anyOf:
          - type: string
          - type: 'null'
          title: Kid
        issued_on:
          anyOf:
          - type: string
          - type: 'null'
          title: Issued On
          description: The day it was issued (UTC).
        issued_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Issued At
          description: 'JWS only: the exact time.'
        capability:
          anyOf:
          - type: string
          - type: 'null'
          title: Capability
        capability_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Capability Name
        tool_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Tool Name
          description: The web tool's name when a web tool issued it.
        operation:
          anyOf:
          - type: string
          - type: 'null'
          title: Operation
        document:
          anyOf:
          - type: string
          - type: 'null'
          title: Document
          description: What the code was printed on.
        ruleset:
          anyOf:
          - $ref: '#/components/schemas/RulesetCheck'
          - type: 'null'
        engine:
          anyOf:
          - $ref: '#/components/schemas/EngineCheck'
          - type: 'null'
        result_hash:
          anyOf:
          - type: string
          - type: 'null'
          title: Result Hash
          description: JWS only.
        covers:
          anyOf:
          - type: string
            enum:
            - result
            - text
          - type: 'null'
          title: Covers
          description: 'What the code''s keyed digest covers: one result, or a summary''s text.'
        text_check:
          anyOf:
          - type: string
            enum:
            - not_asked
            - matches
            - differs
            - not_available
          - type: 'null'
          title: Text Check
        text_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Text Message
      type: object
      required:
      - signing
      - verified
      - reason
      - message
      title: VerifyResponse
    EngineCheck:
      properties:
        version:
          type: string
          title: Version
        current_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Version
      type: object
      required:
      - version
      - current_version
      title: EngineCheck
    VerifyRequest:
      properties:
        code:
          anyOf:
          - type: string
            maxLength: 712
          - type: 'null'
          title: Code
          description: A verify code, or a whole verify link (…/verify/<code>).
        text:
          anyOf:
          - type: string
            maxLength: 20000
          - type: 'null'
          title: Text
          description: 'Optional, for a summary''s code: the summary''s text, to check it was not changed. Compared in memory and not stored.'
        jws:
          anyOf:
          - type: string
            maxLength: 4096
          - type: 'null'
          title: Jws
          description: 'Instead of a code: an API result''s signature.jws, to check its signature.'
      type: object
      title: VerifyRequest