> ## 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.

# Check Financials Read-State Consistency

> "Can I trust the numbers": verifies a window of the company's derived
financial read state against a **read-only** replay of the journal —
nothing is rewritten. `scope` picks which derived read models are
checked: `invoices` (invoices and their payments), `balances` (entity
account balances), or `earning` (policy earning layers).
`updatedAfter` / `updatedBefore` bound the checked
window by row update time; omit both to check everything in scope.

Returns the list of mismatches — stored rows that differ from the
replay. An empty `mismatches` means the scoped window is consistent.

**Required permission:** `company.payment:read`




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/financials/validation/check
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}/financials/validation/check:
    get:
      tags:
        - Financials
      summary: Check Financials Read-State Consistency
      description: |
        "Can I trust the numbers": verifies a window of the company's derived
        financial read state against a **read-only** replay of the journal —
        nothing is rewritten. `scope` picks which derived read models are
        checked: `invoices` (invoices and their payments), `balances` (entity
        account balances), or `earning` (policy earning layers).
        `updatedAfter` / `updatedBefore` bound the checked
        window by row update time; omit both to check everything in scope.

        Returns the list of mismatches — stored rows that differ from the
        replay. An empty `mismatches` means the scoped window is consistent.

        **Required permission:** `company.payment:read`
      operationId: checkFinancialsValidation
      parameters:
        - $ref: '#/components/parameters/companyId'
        - name: scope
          in: query
          required: true
          schema:
            type: string
            enum:
              - invoices
              - balances
              - earning
          description: Which derived read models to check
        - name: updatedAfter
          in: query
          schema:
            type: string
            format: date-time
          description: Only rows updated at or after this ISO 8601 timestamp
        - name: updatedBefore
          in: query
          schema:
            type: string
            format: date-time
          description: Only rows updated at or before this ISO 8601 timestamp
      responses:
        '200':
          description: The mismatch list for the scoped window
          content:
            application/json:
              schema:
                type: object
                required:
                  - mismatches
                properties:
                  mismatches:
                    type: array
                    items:
                      $ref: '#/components/schemas/FinancialsV2ValidationMismatch'
              examples:
                consistent:
                  summary: The scoped window is consistent
                  value:
                    mismatches: []
                drift:
                  summary: One stored invoice row differs from the replay
                  value:
                    mismatches:
                      - kind: invoice
                        id: 550e8400-e29b-41d4-a716-446655440700
                        detail: 'amountPaidCents: stored 4000, recomputed 0'
        '400':
          description: >-
            Bad Request — a missing or unknown `scope`, an unknown query field,
            or a malformed timestamp
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unknownScope:
                  summary: Unknown scope
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: >-
                        scope: Invalid option: expected one of
                        "invoices"|"balances"|"earning"
                      userMessages:
                        - >-
                          scope: Invalid option: expected one of
                          "invoices"|"balances"|"earning"
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            Not Found — the company does not have this financials surface
            enabled (the endpoint behaves as if it does not exist)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: Not found
                  value:
                    error:
                      code: NotFoundError
                      message: Not found
                      userMessages:
                        - Not found
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    FinancialsV2ValidationMismatch:
      type: object
      description: >-
        One stored-vs-recomputed difference found by the validation check,
        pointing at the mismatching derived row.
      required:
        - kind
        - id
        - detail
      properties:
        kind:
          type: string
          enum:
            - invoice
            - invoicePayment
            - entityAccountBalance
            - earningLayer
          description: Which derived row kind the mismatch points at
        id:
          type: string
          format: uuid
          description: The mismatching row's id
        detail:
          type: string
          description: Human-readable description of the stored-vs-recomputed difference
    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
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  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.

````