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

# Replace a rule

> Full replacement. Omitted optional fields reset to their defaults; use PATCH to edit in place.



## OpenAPI

````yaml /api_schema.yaml put /api/v1/rules/{id}/
openapi: 3.0.3
info:
  title: Sphinx Document Fraud API
  version: 1.0.0
  description: >
    Detect forged, tampered, and AI-generated documents. Upload a PDF or image
    and get back a

    structured verdict with a defined set of fraud flags.


    **Quick Start:**

    1. **Create an API key**: sign up, then generate a key from Settings.

    2. **Submit a document**: `POST /api/v1/document-checks/` with a file or a
    URL.
       You get back an id with status `"processing"`.
    3. **Poll for the result**: `GET /api/v1/document-checks/{id}/` until status
    is
       `"completed"` or `"failed"`.

    Optionally pass `webhook_url` on submit to be notified when analysis
    finishes, or

    `?wait=true` to block the submit request for up to 55s.


    **Authentication:** `Authorization: Bearer <api_key>`


    **Decisions:** Every completed check returns a decision (`clear`, `pending`,
    `suspicious`, or

    `fraudulent`), a `risk_level`, a plain-language summary, structured flags,
    and any

    workspace rules that triggered. The four-value decision set is the v1
    contract.
servers:
  - url: /
    description: This environment
security: []
tags:
  - name: Document Checks
    description: |-
      Submit a document for fraud analysis and retrieve structured results.

      **Allowed file types:** PDF, PNG, JPG.
  - name: Rules
    description: >-
      Workspace rules that guide the fraud engine, plus the score cut lines that
      set the `action` field on each check.
paths:
  /api/v1/rules/{id}/:
    put:
      tags:
        - Rules
      summary: Replace a rule
      description: >-
        Full replacement. Omitted optional fields reset to their defaults; use
        PATCH to edit in place.
      operationId: v1_rules_update
      parameters:
        - in: path
          name: id
          schema:
            type: string
          description: The rule id, e.g. `rule_9f2c4b1e8a7d4c3fb2e1d0a9c8b7a6f5`.
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleCreateUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RuleCreateUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RuleCreateUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: The updated rule.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid input. See `error.message`.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The key's workspace role lacks the required permission.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: No such check in this workspace.
      security:
        - ApiKeyAuth: []
components:
  schemas:
    RuleCreateUpdate:
      type: object
      properties:
        title:
          type: string
          maxLength: 255
        condition:
          type: string
        guidance:
          type: string
          default: ''
        outcome_guidance:
          allOf:
            - $ref: '#/components/schemas/OutcomeGuidanceEnum'
          default: ADVISORY
        score_delta:
          type: integer
          maximum: 100
          minimum: -100
          default: 0
        document_types:
          type: array
          items:
            type: string
            maxLength: 128
        document_descriptions:
          type: array
          items:
            type: string
            maxLength: 128
        document_subtypes:
          type: array
          items:
            type: string
            maxLength: 128
        status:
          allOf:
            - $ref: '#/components/schemas/RuleStatusEnum'
          default: active
      required:
        - condition
        - title
    Rule:
      type: object
      properties:
        id:
          type: string
          description: Prefixed id, e.g. `rule_9f2c…`.
        object:
          type: string
          default: rule
        created_at:
          type: string
        status:
          $ref: '#/components/schemas/RuleStatusEnum'
        title:
          type: string
        condition:
          type: string
        guidance:
          type: string
        outcome_guidance:
          $ref: '#/components/schemas/OutcomeGuidanceEnum'
        score_delta:
          type: integer
          description: Added to `risk_score` when the rule triggers.
        document_types:
          type: array
          items:
            type: string
        document_descriptions:
          type: array
          items:
            type: string
        document_subtypes:
          type: array
          items:
            type: string
      required:
        - condition
        - created_at
        - document_types
        - guidance
        - id
        - outcome_guidance
        - score_delta
        - status
        - title
    Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
    OutcomeGuidanceEnum:
      enum:
        - ACCEPTED
        - REJECTED
        - PENDING
        - ADVISORY
      type: string
      description: |-
        * `ACCEPTED` - ACCEPTED
        * `REJECTED` - REJECTED
        * `PENDING` - PENDING
        * `ADVISORY` - ADVISORY
    RuleStatusEnum:
      enum:
        - active
        - disabled
      type: string
      description: |-
        * `active` - active
        * `disabled` - disabled
    ErrorDetail:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ErrorTypeEnum'
        code:
          type: string
          description: Machine-readable cause, e.g. `unsupported_document`.
        message:
          type: string
          description: Human-readable explanation. Safe to log; do not parse.
      required:
        - code
        - message
        - type
    ErrorTypeEnum:
      enum:
        - invalid_request_error
        - authentication_error
        - insufficient_credits_error
        - permission_error
        - not_found_error
        - rate_limit_error
        - api_error
      type: string
      description: |-
        * `invalid_request_error` - invalid_request_error
        * `authentication_error` - authentication_error
        * `insufficient_credits_error` - insufficient_credits_error
        * `permission_error` - permission_error
        * `not_found_error` - not_found_error
        * `rate_limit_error` - rate_limit_error
        * `api_error` - api_error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Paste your workspace API key from Settings. Sent as Authorization:
        Bearer <key>.

````