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

# Update Finding Locations Setting

> Switch page locations on or off for your organisation's analyses.

Switches page locations on or off for your organisation's analyses; the setting is off by default. Send `{ "enabled": true }` or `{ "enabled": false }`, and the response returns the saved value.

## Permission

Requires `organisation_settings:write`, which the Owner role holds by default. A caller without it receives `403`.

## What Changes

* **Past analyses too.** The setting applies whenever an analysis is read, including analyses made before you changed it. If you switch it off, locations disappear from every analysis. If you switch it back on, they return. Nothing is analysed again or deleted.
* **Nothing else changes.** Risk scores, findings and every other field in the analysis are the same with the setting on or off.
* **Changes are audited.** Each change is recorded in the [audit log](https://docs.veridox.ai/api-reference/endpoints/org-audit-log-get.md) as `finding_location_settings.updated`.

## Best Practices

* Send only `enabled`, as a boolean. A body with a missing or non-boolean `enabled`, or any other field, is rejected with `400`.

## Related

* [Get Finding Locations Setting](https://docs.veridox.ai/api-reference/endpoints/org-finding-locations-get.md) reads the current value.
* [Get File Analysis](https://docs.veridox.ai/api-reference/endpoints/files-analysis-get.md#page-locations) describes the page locations the setting controls.


## OpenAPI

````yaml PUT /organisations/features/finding-locations
openapi: 3.1.0
info:
  title: Veridox Core API
  description: Veridox Core Platform API
  version: 0.0.1
  contact: {}
servers:
  - url: https://api.uk.veridox.ai
    description: Live (UK)
  - url: https://api.ca.veridox.ai
    description: Live (CA)
  - url: https://api.eu.veridox.ai
    description: Live (EU)
security: []
tags:
  - name: Status
    description: System status and health check endpoints
  - name: Authentication
    description: Authentication status of the calling credential
  - name: Cases
    description: Case management
  - name: Case Files
    description: Case file uploads, downloads and analysis results
  - name: Organisations
    description: Organisation management
  - name: Users
    description: The calling user's profile
  - name: Document Requests
    description: Document request management
  - name: Search
    description: Search functionality
paths:
  /organisations/features/finding-locations:
    put:
      tags:
        - Organisations
      summary: Update finding location settings
      description: >-
        Switches page locations on evidence, and the key_terms block, on or off
        for the organisation's analyses. The change applies to every analysis
        when it is next read, including analyses made before it. Writes an
        audit-log entry. Requires organisation_settings:write.
      operationId: FindingLocationSettingsController_updateSettings
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFindingLocationSettingsRequestDto'
      responses:
        '200':
          description: Finding location settings updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindingLocationSettingsResponseDto'
        '400':
          description: Missing or non-boolean enabled, or an unknown field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
        '401':
          description: Unauthorized (invalid or missing authentication token)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
        '403':
          description: Caller lacks organisation_settings:write
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
        '429':
          description: Too many requests (rate limit exceeded)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
        - api-key: []
components:
  schemas:
    UpdateFindingLocationSettingsRequestDto:
      type: object
      properties:
        enabled:
          type: boolean
          x-nestjs_zod-parent-additional-properties: false
          x-nestjs_zod-parent-metadata:
            description: Request payload for updating finding location settings
      required:
        - enabled
      description: Request payload for updating finding location settings
      additionalProperties: false
    FindingLocationSettingsResponseDto:
      type: object
      properties:
        enabled:
          type: boolean
      required:
        - enabled
    ErrorDto:
      type: object
      properties:
        error_code:
          type: string
          description: Machine-readable error code for programmatic handling
          examples:
            - request.cases.file.missing-risk-score
            - request.authentication.invalid-token
            - request.forbidden
            - request.cases.case.not-found
            - request.cases.case.already-locked
        error_message:
          type: string
          description: Human-readable error message explaining what went wrong
          example: >-
            User tried to perform an invalid operation on a file without a risk
            score.
        error_details:
          type: object
          example:
            field: email_address
      required:
        - error_code
        - error_message
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.