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

# Monitoring Rules

> Manage detection rules

<Info>
  Configure dynamic rules for transaction monitoring.
</Info>

## Request

<ParamField header="Authorization" type="string" required>
  `Bearer olive_live_xxx` (Admin)
</ParamField>

***

## Response

<ResponseField name="rules" type="array">
  List of active monitoring rules
</ResponseField>

***

## Examples

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://demo.api.vultlocal.com/api/v1/compliance/rules" \
    -H "Authorization: Bearer olive_live_xxx"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "rules": [
      {
        "id": 1,
        "name": "High Value Alert",
        "type": "AMOUNT_THRESHOLD",
        "threshold": 10000000,
        "action": "FLAG"
      },
      {
        "id": 2,
        "name": "Rapid Velocity",
        "type": "TRANSACTION_COUNT",
        "time_window": "5m",
        "threshold": 10,
        "action": "BLOCK"
      }
    ]
  }
  ```
</ResponseExample>


## OpenAPI

````yaml olive-openapi.json GET /compliance/rules
openapi: 3.0.0
info:
  description: >-
    API Gateway for OLIVE NFC Card Payment System - Comprehensive payment, card
    management, agent operations, and admin authentication. All /api/v1 routes
    require authentication using either API Key or JWT token.
  title: OLIVE NFC Card Payment API
  termsOfService: http://swagger.io/terms/
  contact:
    name: API Support
    email: support@olive.sl
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
  - url: https://olive-gateway-a6ba.onrender.com/api/v1
security: []
paths:
  /compliance/rules:
    get:
      tags:
        - Monitoring Rules
      summary: List all monitoring rules
      description: Get a list of all monitoring rules with optional status filter
      parameters:
        - description: Filter by status (active/inactive)
          name: status
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      description: >-
        API Key for third-party integrations (WhatsApp, Smart PAY, VULT).
        Format: 'Bearer olive_live_xxxxxxxxxxxxx'
      type: apiKey
      name: Authorization
      in: header

````