FLINT Network Scout Credits API

openapi: 3.2.0
info:
  title: FLINT Agent Transaction Control Scout Credits API
  version: 1.0.0
  description: FLINT verifies agent authority before autonomous economic activity, issues signed verification records, accepts outcome feedback, and returns partner-safe Trust Graph reputation.
  x-guidance: 'Use POST /api/x402/scan for a $0.01 x402-paid bounded pre-transaction scan of a separate intended commerce transaction. Use POST /api/x402/verify for high-assurance $0.01 x402-paid agent-authority verification after obtaining the required FLINT capability and DPoP proof. Free operations are explicitly marked with security: [].'
  contact:
    name: FLINT Support
    email: support@flint.network
    url: https://flint.network
  license:
    name: Proprietary
    identifier: LicenseRef-FLINT-Proprietary
servers:
- url: https://flint.network
  description: Production
security: []
tags:
- name: Scout Credits
  description: 'Prepaid FLINT Scout scan credits: one x402 payment buys a block of scans that run without a per-call wallet signature.'
paths:
  /api/x402/scout-credits:
    post:
      x-flint-release-state: staging
      security:
      - X402Payment: []
      tags:
      - Scout Credits
      operationId: purchaseScoutCredits
      summary: Pay for a block of prepaid Scout scan credits
      description: x402 resource that sells 100 FLINT Scout scan credits for $1.00. Requires a session (WorkOSOwnerSession cookie or bearerAgentSession bearer token) so the credits land on an account. On settlement, credits the account, issues an fsr_ settlement receipt with purpose flint_scout_credit_topup, and returns the new balance.
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '1.000000'
        protocols:
        - x402: {}
      responses:
        '200':
          description: Payment settled and 100 credits were added to the caller's account.
          headers:
            PAYMENT-RESPONSE:
              $ref: '#/components/headers/PaymentResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutCreditsTopupResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          description: No WorkOSOwnerSession cookie or bearerAgentSession token was presented; credits need an account to land on.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          $ref: '#/components/responses/X402PaymentRequired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /api/account/scout-credits:
    get:
      x-flint-release-state: staging
      security:
      - WorkOSOwnerSession: []
      - bearerAgentSession: []
      tags:
      - Scout Credits
      operationId: getScoutCreditsBalance
      summary: Read the caller's Scout credit balance and recent ledger
      description: Returns the current Scout credit balance, lifetime purchased and used totals, and the last 20 ledger entries (topup, debit, refund) for the authenticated account.
      responses:
        '200':
          description: Balance and ledger.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutCreditsBalanceResponse'
        '401':
          description: No WorkOSOwnerSession cookie or bearerAgentSession token was presented.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/account/scout-credits/intent:
    post:
      x-flint-release-state: staging
      security:
      - WorkOSOwnerSession: []
      - bearerAgentSession: []
      tags:
      - Scout Credits
      operationId: createScoutCreditsTopupIntent
      summary: Create a Scout credits top-up intent
      description: 'Session required (WorkOSOwnerSession cookie or bearerAgentSession bearer token) so FLINT knows which account to credit before any money moves. Returns an sct_ topup_id good for 24 hours and its pay_url: POST /api/x402/scout-credits/{topup_id}, a route that needs no session to pay, so a stock x402 client''s unauthenticated discovery request (awal x402 pay, for example) can settle it. Rate limited to 10 intents per rolling hour per account.'
      responses:
        '200':
          description: Intent created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutCreditsTopupIntentResponse'
        '401':
          description: No WorkOSOwnerSession cookie or bearerAgentSession token was presented.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
  /api/x402/scout-credits/{topup_id}:
    post:
      x-flint-release-state: staging
      security:
      - X402Payment: []
      tags:
      - Scout Credits
      operationId: purchaseScoutCreditsTopupIntent
      summary: Pay a Scout credits top-up intent
      description: 'x402 resource that settles one Scout credits top-up intent created by POST /api/account/scout-credits/intent. No session is required or accepted here: the intent already bound topup_id to an account, which is what lets a stock x402 client with an unauthenticated discovery request (awal x402 pay , for example) pay it. Every request is gated on the intent first, before any payment work: an unknown topup_id is 404; an already-settled or expired one is 409. Idempotent on settlement: a second successful payment against an already-settled topup_id is never credited twice.'
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '1.000000'
        protocols:
        - x402: {}
      parameters:
      - name: topup_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^sct_[0-9A-Za-z]{20,32}$
        description: Top-up intent id from POST /api/account/scout-credits/intent.
      responses:
        '200':
          description: Payment settled and 100 credits were added to the intent's account.
          headers:
            PAYMENT-RESPONSE:
              $ref: '#/components/headers/PaymentResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScoutCreditsTopupIntentSettledResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '402':
          description: Canonical x402 v2 payment challenge, with a pay_recipe (awal, script, credits, browser) for ways to pay this exact intent. No protected or expensive work has executed.
          headers:
            PAYMENT-REQUIRED:
              $ref: '#/components/headers/PaymentRequired'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 'topup_intent_not_found: no intent exists for this topup_id, or it expired out of storage.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: 'topup_intent_already_settled or topup_intent_expired: returned before any payment work when checked up front, or after a real settlement lost a redemption race (in which case the payment settled but was not credited a second time).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/ServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
components:
  responses:
    ServerError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: The cheap caller-admission quota for paid attempts was exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    X402PaymentRequired:
      description: Canonical x402 v2 payment challenge. No protected or expensive work has executed.
      headers:
        PAYMENT-REQUIRED:
          $ref: '#/components/headers/PaymentRequired'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadGateway:
      description: Upstream graph or service failure
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ScoutCreditsBalanceResponse:
      type: object
      required:
      - ok
      - balance
      - purchased_total
      - used_total
      - ledger
      properties:
        ok:
          type: boolean
        balance:
          type: integer
          minimum: 0
        purchased_total:
          type: integer
          minimum: 0
        used_total:
          type: integer
          minimum: 0
        ledger:
          type: array
          items:
            $ref: '#/components/schemas/ScoutCreditLedgerEntry'
    ScoutCreditsTopupResponse:
      type: object
      required:
      - ok
      - credits_added
      - balance
      - receipt_id
      - receipt_url
      properties:
        ok:
          const: true
        credits_added:
          const: 100
        balance:
          type: integer
          minimum: 0
        receipt_id:
          type: string
          pattern: ^fsr_
        receipt_url:
          type:
          - string
          - 'null'
          format: uri
    ErrorResponse:
      type: object
      properties:
        ok:
          type: boolean
        error:
          type: string
        detail:
          type: string
    ScoutCreditLedgerEntry:
      type: object
      required:
      - at
      - kind
      - amount
      properties:
        at:
          type: string
          format: date-time
        kind:
          type: string
          enum:
          - topup
          - debit
          - refund
        amount:
          type: integer
        receipt_id:
          type:
          - string
          - 'null'
        record_id:
          type:
          - string
          - 'null'
        note:
          type:
          - string
          - 'null'
    ScoutCreditsTopupIntentSettledResponse:
      type: object
      required:
      - ok
      - topup_id
      - credits_added
      - balance
      - receipt_id
      - receipt_url
      properties:
        ok:
          const: true
        topup_id:
          type: string
          pattern: ^sct_
        credits_added:
          const: 100
        balance:
          type: integer
          minimum: 0
        receipt_id:
          type: string
          pattern: ^fsr_
        receipt_url:
          type:
          - string
          - 'null'
          format: uri
    ScoutCreditsTopupIntentResponse:
      type: object
      required:
      - ok
      - topup_id
      - pay_url
      - expires_at
      - credits
      - price_usd
      properties:
        ok:
          const: true
        topup_id:
          type: string
          pattern: ^sct_
        pay_url:
          type: string
          format: uri
          description: POST /api/x402/scout-credits/{topup_id}. No session needed to pay it.
        expires_at:
          type: string
          format: date-time
        credits:
          const: 100
        price_usd:
          const: 1
  headers:
    PaymentResponse:
      description: Base64url-encoded canonical x402 v2 settlement response.
      schema:
        type: string
    PaymentRequired:
      description: Base64url-encoded canonical x402 v2 payment challenge.
      schema:
        type: string
  securitySchemes:
    WorkOSOwnerSession:
      type: apiKey
      in: cookie
      name: flint_session
      description: Sealed WorkOS session required for claimed-Passport owner actions. Unclaimed mandate updates require the claim token as a management capability.
    PartnerServiceBearer:
      type: http
      scheme: bearer
      description: Server-only partner credential. The authenticated partner must match the partner in the stored signed verification record.
    X402Payment:
      type: apiKey
      in: header
      name: PAYMENT-SIGNATURE
      description: Canonical x402 v2 payment proof on a paid retry. Initial unpaid challenge requests require no payment proof.
    FlintCapability:
      type: apiKey
      in: header
      name: FLINT-CAPABILITY
      description: Short-lived Passport-owner-issued capability bound to the exact x402 Verify request.
    DPoP:
      type: apiKey
      in: header
      name: DPoP
      description: Fresh caller proof bound to the capability, request, and x402 payment proof.
    X401Proof:
      type: apiKey
      in: header
      name: PROOF-RESPONSE
      description: Base64url-encoded x401 principal-identity presentation. Omit to request a proof challenge.
    bearerAgentSession:
      type: http
      scheme: bearer
      bearerFormat: flint_sess_...
      description: 'Agent session bearer token minted by POST /api/auth/otp-verify (Authorization: Bearer flint_sess_...). Accepted everywhere a WorkOSOwnerSession cookie is accepted, so an MCP agent never needs a browser. Also accepted via the X-FLINT-Session header.'