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

# Rewrite stored Policy field values for a migration

> Maintenance-only compare-and-swap rewrite of a Policy's complete stored
history. The server maps each logical `policy.*` path across every stored
policy segment version and the direct or container values in its transaction
deltas, then fingerprints the canonically sorted occurrence descriptors.

A `dryRun: true` request returns the current and projected fingerprints plus
exact current occurrences without writing. Those reviewed fingerprints feed
an applying request. A `dryRun: false` request changes data only when the current fingerprint equals
`expectedPreFingerprint`. It atomically rewrites all matching values,
recomputes hashes for touched segments, verifies the exact reviewed
postimage, and writes one audit record. Replaying the same request after a
successful migration returns `unchanged` without a mutation audit row. Any other current state returns a
typed `409` with the current fingerprint and occurrences and writes nothing.

This is deliberately not a general Policy update endpoint.

**Required permission:** none — staff level `staff` (a staff user's own
Bearer token or the platform service identity); no API key is accepted.




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/policies/{policyId}/field-value-rewrites
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/policies/{policyId}/field-value-rewrites:
    post:
      tags:
        - Field Model Policy Transactions
      summary: Rewrite stored Policy field values for a migration
      description: >
        Maintenance-only compare-and-swap rewrite of a Policy's complete stored

        history. The server maps each logical `policy.*` path across every
        stored

        policy segment version and the direct or container values in its
        transaction

        deltas, then fingerprints the canonically sorted occurrence descriptors.


        A `dryRun: true` request returns the current and projected fingerprints
        plus

        exact current occurrences without writing. Those reviewed fingerprints
        feed

        an applying request. A `dryRun: false` request changes data only when
        the current fingerprint equals

        `expectedPreFingerprint`. It atomically rewrites all matching values,

        recomputes hashes for touched segments, verifies the exact reviewed

        postimage, and writes one audit record. Replaying the same request after
        a

        successful migration returns `unchanged` without a mutation audit row.
        Any other current state returns a

        typed `409` with the current fingerprint and occurrences and writes
        nothing.


        This is deliberately not a general Policy update endpoint.


        **Required permission:** none — staff level `staff` (a staff user's own

        Bearer token or the platform service identity); no API key is accepted.
      operationId: rewritePolicyFieldValues
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/policyIdPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  additionalProperties: false
                  required:
                    - dryRun
                    - rewrites
                  properties:
                    dryRun:
                      type: boolean
                      enum:
                        - true
                    rewrites:
                      type: array
                      minItems: 1
                      items:
                        $ref: '#/components/schemas/PolicyFieldValueRewrite'
                - type: object
                  additionalProperties: false
                  required:
                    - dryRun
                    - expectedPreFingerprint
                    - expectedPostFingerprint
                    - rewrites
                  properties:
                    dryRun:
                      type: boolean
                      enum:
                        - false
                    expectedPreFingerprint:
                      type: string
                      pattern: ^[0-9a-f]{64}$
                      description: >-
                        Reviewed SHA-256 fingerprint of the exact preimage
                        occurrences.
                    expectedPostFingerprint:
                      type: string
                      pattern: ^[0-9a-f]{64}$
                      description: >-
                        Reviewed SHA-256 fingerprint of the exact postimage
                        occurrences.
                    rewrites:
                      type: array
                      minItems: 1
                      items:
                        $ref: '#/components/schemas/PolicyFieldValueRewrite'
            examples:
              previewPercentageMigration:
                value:
                  dryRun: true
                  rewrites:
                    - path: policy.commissionPercentage
                      expectedValue: 25
                      replacementValue: 0.25
              percentageMigration:
                value:
                  dryRun: false
                  expectedPreFingerprint: >-
                    711b836b01292b2fe6bd4e2897de598c6fa4954d023749a2866c023112a18b8d
                  expectedPostFingerprint: >-
                    1da1aa47f7ab3ffca098aa966332457aceb79281532fbc8a3301b4d5a2c11f7b
                  rewrites:
                    - path: policy.commissionPercentage
                      expectedValue: 25
                      replacementValue: 0.25
      responses:
        '200':
          description: >-
            A read-only fingerprint preview, a changed Policy history, or an
            already-applied no-op.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    required:
                      - status
                      - currentFingerprint
                      - projectedFingerprint
                      - occurrences
                    properties:
                      status:
                        type: string
                        enum:
                          - dryRun
                      currentFingerprint:
                        type: string
                        pattern: ^[0-9a-f]{64}$
                      projectedFingerprint:
                        type: string
                        pattern: ^[0-9a-f]{64}$
                      occurrences:
                        type: array
                        items:
                          oneOf:
                            - $ref: >-
                                #/components/schemas/PolicySegmentFieldValueOccurrence
                            - $ref: >-
                                #/components/schemas/PolicyTransactionDeltaFieldValueOccurrence
                  - type: object
                    required:
                      - status
                      - fingerprint
                      - occurrences
                    properties:
                      status:
                        type: string
                        enum:
                          - changed
                          - unchanged
                      fingerprint:
                        type: string
                        pattern: ^[0-9a-f]{64}$
                      occurrences:
                        type: array
                        items:
                          oneOf:
                            - $ref: >-
                                #/components/schemas/PolicySegmentFieldValueOccurrence
                            - $ref: >-
                                #/components/schemas/PolicyTransactionDeltaFieldValueOccurrence
              examples:
                changed:
                  value:
                    status: changed
                    fingerprint: >-
                      1da1aa47f7ab3ffca098aa966332457aceb79281532fbc8a3301b4d5a2c11f7b
                    occurrences:
                      - surface: policySegment
                        policyVersion: 1
                        startDate: '2025-01-01'
                        path: policy.commissionPercentage
                        valuePath: /commissionPercentage
                        value: 0.25
        '400':
          description: The strict rewrite manifest is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The live Policy does not exist in the company named by the URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            The current preimage or projected postimage differs from the
            reviewed manifest; nothing was written.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyFieldValueRewriteConflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    policyIdPath:
      name: policyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Policy identifier
  schemas:
    PolicyFieldValueRewrite:
      type: object
      description: >-
        One exact value mapping. The same path may appear more than once when
        Policy history contains different raw values, but each
        path/expectedValue pair must be unique so one physical occurrence can
        match at most one mapping.
      additionalProperties: false
      required:
        - path
        - expectedValue
        - replacementValue
      properties:
        path:
          type: string
          pattern: ^policy(?:\.[A-Za-z0-9_-]+)+$
          example: policy.commissionPercentage
        expectedValue:
          description: The exact value to replace wherever this logical path occurs.
        replacementValue:
          description: The canonical replacement value.
    PolicySegmentFieldValueOccurrence:
      type: object
      additionalProperties: false
      required:
        - surface
        - policyVersion
        - startDate
        - path
        - valuePath
        - value
      properties:
        surface:
          type: string
          enum:
            - policySegment
        policyVersion:
          type: integer
        startDate:
          type: string
          format: date
        path:
          type: string
        valuePath:
          type: string
          description: JSON Pointer within the bare policy segment blob.
        value: {}
    PolicyTransactionDeltaFieldValueOccurrence:
      type: object
      additionalProperties: false
      required:
        - surface
        - transactionId
        - deltaId
        - deltaPath
        - path
        - valuePath
        - value
      properties:
        surface:
          type: string
          enum:
            - policyTransactionDelta
        transactionId:
          type: string
          format: uuid
        deltaId:
          type: string
          format: uuid
        deltaPath:
          type: string
        path:
          type: string
        valuePath:
          type: string
          description: JSON Pointer within the delta value; empty for a direct delta.
        value: {}
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  code:
                    type: string
                    description: Stable problem code for this individual validation failure
                    example: BLANK_LIST_ELEMENT
                  reason:
                    type: string
                    description: Stable reason the value violates its canonical contract
                    example: blank-list-element
                  expected:
                    type: string
                    description: The expected canonical value contract
                    example: nonblank trimmed string
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
    PolicyFieldValueRewriteConflict:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - expectedPostFingerprint
            - occurrences
          properties:
            code:
              type: string
              enum:
                - policy-field-value-rewrite-preimage-mismatch
                - policy-field-value-rewrite-postimage-mismatch
            message:
              type: string
            userMessages:
              type: array
              items:
                type: string
            expectedPreFingerprint:
              type: string
              pattern: ^[0-9a-f]{64}$
            expectedPostFingerprint:
              type: string
              pattern: ^[0-9a-f]{64}$
            currentFingerprint:
              type: string
              pattern: ^[0-9a-f]{64}$
            actualPostFingerprint:
              type: string
              pattern: ^[0-9a-f]{64}$
            occurrences:
              type: array
              items:
                oneOf:
                  - $ref: '#/components/schemas/PolicySegmentFieldValueOccurrence'
                  - $ref: >-
                      #/components/schemas/PolicyTransactionDeltaFieldValueOccurrence
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0
        access token (audience = the app API audience) as `Authorization: Bearer
        <jwt>`. The request resolves to the user's identity and is authorized by
        their Role on the `{companyId}` in the path — the same role-based
        permissions the web app enforces. This is the path the MCP connector
        uses to act on a user's behalf; endpoints that accept it list both
        `BearerAuth` and `ApiKeyAuth`.

````