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

# Get storefront compliance status

> Get the most recent compliance readiness check for the storefront. Returns null when no compliance check has run yet.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /readiness/compliance
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: >-
    REST API for partners to manage Seller Accounts, inventory sources, and
    billing.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


    `https://api.interchange.io/api/v2/storefront`


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/storefront` with three tools:

    - `initialize`: Start an MCP session

    - `api_call`: Make REST API calls

    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.interchange.io/api/v2/storefront
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Storefront
    description: Manage storefront and inventory sources
  - name: Storefront Agents
    description: List and manage registered sales, signals, and outcomes agents
  - name: Storefront Activity
    description: Audit log of configuration and inventory changes on the storefront
  - name: Storefront Billing
    description: Payout bank details and billing configuration for Seller Accounts
  - name: AI Usage
    description: Seller Account AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /readiness/compliance:
    get:
      tags:
        - Storefront
      summary: Get storefront compliance status
      description: >-
        Get the most recent compliance readiness check for the storefront.
        Returns null when no compliance check has run yet.
      operationId: getStorefrontCompliance
      responses:
        '200':
          description: Get storefront compliance status
          content:
            application/json:
              schema:
                nullable: true
                allOf:
                  - $ref: '#/components/schemas/ReadinessCheck'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No storefront exists for the calling operator.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ReadinessCheck:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        category:
          type: string
        status:
          type: string
          enum:
            - complete
            - partial
            - missing
            - optional
          description: >-
            Status of a readiness check. `optional` is reserved for checks that
            are explicitly skipped (e.g. billing in non-production environments)
            — they are not required before the storefront can start transacting.
        isBlocker:
          type: boolean
        method:
          type: string
        details:
          type: string
        action:
          description: >-
            Where this step resolves. Absent → the widget falls back to its own
            routing for the check id.
          type: string
          enum:
            - inline_currency
            - inline_operator_domain
            - link
            - policy
            - open
            - chat
            - recheck
        actionLabel:
          description: >-
            Outcome-named action label for this step (e.g. "Connect ad server",
            "Set currency") — names the task, not the tool. Absent → the widget
            derives a label from the check name.
          type: string
        actionUrl:
          description: >-
            Absolute application destination for a `link` action. Server-owned
            so every MCP Apps host executes the same destination without a model
            prompt.
          type: string
          format: uri
        actionValue:
          description: >-
            Current value used to seed an inline action control, when
            applicable.
          type: string
        compliance:
          description: Per-agent compliance results (present on agent_connectivity checks)
          type: array
          items:
            $ref: '#/components/schemas/AgentComplianceResult'
        requirement:
          description: >-
            Requirement classification for this storefront's current selling
            path. 'hard': must be resolved before the storefront can go live.
            'soft': advisory — improves outcomes but never blocks.
            'platform_default': the platform applied a sensible default (named
            in appliedDefault) that the seller can change later. The server
            always sets this; optional only for payload compatibility.
          type: string
          enum:
            - hard
            - soft
            - platform_default
        appliedDefault:
          description: >-
            For 'platform_default' checks: the default the platform applied,
            stated in seller terms, and how to change it.
          type: string
        guidance:
          description: >-
            Present on every incomplete hard requirement. Omitted for complete
            or non-blocking checks.
          allOf:
            - $ref: '#/components/schemas/ReadinessBlockingGuidance'
      required:
        - id
        - name
        - description
        - category
        - status
        - isBlocker
      additionalProperties: false
      description: Individual readiness check result
    ErrorResponse:
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
      description: Standard error response
    AgentComplianceResult:
      type: object
      properties:
        agentId:
          type: string
        agentUrl:
          type: string
        passed:
          type: boolean
        tracks:
          type: array
          items:
            $ref: '#/components/schemas/ComplianceTrackResult'
        summary:
          type: string
          description: One-line compliance headline
        observations:
          type: array
          items:
            type: object
            properties:
              category:
                type: string
              severity:
                type: string
                enum:
                  - info
                  - suggestion
                  - warning
                  - error
              message:
                type: string
            required:
              - category
              - severity
              - message
            additionalProperties: false
          description: Advisory observations from compliance checks
        durationMs:
          type: number
        error:
          type: string
      required:
        - agentId
        - agentUrl
        - passed
        - tracks
        - summary
        - observations
        - durationMs
      additionalProperties: false
      description: Compliance assessment for a single agent
    ReadinessBlockingGuidance:
      type: object
      properties:
        coverage:
          type: string
          enum:
            - complete
            - missing
          description: >-
            `complete` when the canonical readiness catalog owns a resolution;
            `missing` makes an unregistered future blocker explicit.
        stage:
          type: string
          enum:
            - before_source_dispatch
          description: >-
            The blocker stops buyer-serving work at storefront transaction
            admission, before an inventory source receives `get_products`.
        why:
          type: string
          description: Current cause, using the check's live evidence.
        effect:
          type: string
          description: >-
            Buyer-path consequence. Consumers render this instead of inferring
            demand from source call counts.
        fix:
          type: string
          description: Smallest honest action that clears the blocker.
        subjects:
          type: array
          items:
            type: object
            properties:
              kind:
                type: string
                enum:
                  - inventory_source
              id:
                nullable: true
                type: string
              name:
                type: string
            required:
              - kind
              - id
              - name
            additionalProperties: false
        evidence:
          oneOf:
            - type: object
              properties:
                kind:
                  type: string
                  enum:
                    - billing_compatibility
                requiredSupportedBilling:
                  type: string
                  enum:
                    - agent
                incompatibleSources:
                  type: array
                  items:
                    type: object
                    properties:
                      sourceId:
                        nullable: true
                        type: string
                      sourceName:
                        type: string
                      advertisedSupportedBillings:
                        type: array
                        items:
                          type: string
                    required:
                      - sourceId
                      - sourceName
                      - advertisedSupportedBillings
                    additionalProperties: false
              required:
                - kind
                - requiredSupportedBilling
                - incompatibleSources
              additionalProperties: false
          type: object
      required:
        - coverage
        - stage
        - why
        - effect
        - fix
        - subjects
      additionalProperties: false
      description: >-
        Canonical cause, buyer-path effect, evidence, and resolution for an
        incomplete hard readiness requirement.
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error message
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
      description: Structured error object
    ComplianceTrackResult:
      type: object
      properties:
        track:
          type: string
          description: Compliance track name
        status:
          type: string
          enum:
            - pass
            - fail
            - skip
            - partial
            - silent
          description: >-
            Track assessment result. 'silent' means the track was wired but
            observation-based assertions saw zero resources — distinct from
            'pass' (verified) and 'skip' (didn't run).
        label:
          type: string
          description: Human-readable track label
        durationMs:
          type: number
          description: Track duration in ms
        failureReason:
          description: Why this track failed or partially passed
          type: string
      required:
        - track
        - status
        - label
        - durationMs
      additionalProperties: false
      description: Result for a single compliance track
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````