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

# Preview customer applicability and change impacts without storing customer state



## OpenAPI

````yaml /openapi.json post /api/v1/customer-lifecycle/preview
openapi: 3.1.0
info:
  title: Esheria Regulatory API
  version: 1.0.0
  description: >-
    Citation-backed regulatory pack API for pack discovery, obligations,
    applicability checks, version history, diffs, change events, evidence
    requirements, filing rules, penalty facts, legal review audit metadata,
    graph queries, and claim verification.
servers:
  - url: https://api.esheria.ai
    description: Production API
  - url: http://127.0.0.1:8080
    description: Local development runtime
security: []
paths:
  /api/v1/customer-lifecycle/preview:
    post:
      tags:
        - Customer Applicability API
      summary: >-
        Preview customer applicability and change impacts without storing
        customer state
      operationId: preview_customer_lifecycle_api_v1_customer_lifecycle_preview_post
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerLifecyclePreviewRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                status: error
                errors:
                  - code: unauthorized
                    message: Invalid API key
                trace_id: trace-123
        '402':
          description: Credits exhausted
          content:
            application/json:
              example:
                status: error
                errors:
                  - code: credits_exhausted
                    message: API credits exhausted
                trace_id: trace-123
        '409':
          description: Conflict
          content:
            application/json:
              example:
                status: error
                errors:
                  - code: duplicate_token_name
                    message: An active data token already uses that name.
                trace_id: trace-123
        '422':
          description: Validation error
          content:
            application/json:
              example:
                status: error
                errors:
                  - code: validation_error
                    message: Invalid payload
                    field: body.name
                trace_id: trace-123
        '503':
          description: Billing or dependency unavailable
          content:
            application/json:
              example:
                status: error
                errors:
                  - code: billing_unavailable
                    message: Billing ledger is unavailable
                trace_id: trace-123
      security:
        - ApiKeyAuth: []
components:
  parameters:
    IdempotencyKey:
      name: idempotency-key
      in: header
      required: true
      schema:
        type: string
      description: Unique key for mutating request replay protection.
      example: claim-verify-2026-06-01T120000Z
  schemas:
    CustomerLifecyclePreviewRequest:
      properties:
        pack_ids:
          items:
            type: string
          type: array
          minItems: 1
          title: Pack Ids
        locked_pack_versions:
          additionalProperties:
            type: string
          type: object
          title: Locked Pack Versions
        entity_roles:
          items:
            type: string
          type: array
          title: Entity Roles
        activities:
          items:
            type: string
          type: array
          title: Activities
        sector_tags:
          items:
            type: string
          type: array
          title: Sector Tags
        processing_characteristics:
          items:
            type: string
          type: array
          title: Processing Characteristics
        entity_profile:
          additionalProperties: true
          type: object
          title: Entity Profile
        profile_facts:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Profile Facts
        include_change_impacts:
          type: boolean
          title: Include Change Impacts
          default: true
        from_version:
          anyOf:
            - type: string
              maxLength: 160
            - type: 'null'
          title: From Version
        to_version:
          anyOf:
            - type: string
              maxLength: 160
            - type: 'null'
          title: To Version
        limit:
          type: integer
          maximum: 500
          minimum: 1
          title: Limit
          default: 100
      additionalProperties: false
      type: object
      required:
        - pack_ids
      title: CustomerLifecyclePreviewRequest
      example:
        activities:
          - personal_data_processing
        entity_profile:
          entity_types:
            - data_controller
          jurisdictions:
            - UK
            - EU
          regulated_activities:
            - personal_data_processing
        entity_roles:
          - data_controller
        include_change_impacts: true
        limit: 100
        pack_ids:
          - UK-DATA-PROTECTION-PRIVACY
          - EU-GDPR-DATA-PROTECTION
        sector_tags:
          - financial_services
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Client API key issued by Esheria.
      x-default: YOUR_ESHERIA_API_KEY

````