---
title: "Update Requirement Instance"
method: PATCH
path: "/requirements/instances/{instance_id}"
tags: ["requirements"]
---

# Update Requirement Instance

`PATCH /requirements/instances/{instance_id}`

## Request

- Base URL: `https://api.kobaltlabs.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.kobaltlabs.com/requirements/instances/{instance_id}`
- Auth: none declared

## Path parameters

- `instance_id` string, uuid, required

## Request body

- UpdateRequirementInstanceRequest: User edits to a requirement instance. `ai_compliance` is never touched.
  - `compliance` 'compliant' | 'non_compliant' | 'partially_compliant' | 'no_evidence' | 'not_applicable': Compliance status for an evidence requirement.
  - `reviewer_note` string, nullable
  - `note` string, nullable

## Response `200`

Successful Response

- RequirementInstanceResponse
  - `id` string, uuid, required
  - `requirement_id` string, uuid, required
  - `upload_id` string, uuid, required
  - `requirement_text` string, nullable
  - `section_label` string, nullable
  - `title` string, nullable
  - `compliance` 'compliant' | 'non_compliant' | 'partially_compliant' | 'no_evidence' | 'not_applicable': Compliance status for an evidence requirement.
  - `ai_compliance` 'compliant' | 'non_compliant' | 'partially_compliant' | 'no_evidence' | 'not_applicable': Compliance status for an evidence requirement.
  - `severity` string, nullable
  - `explanation` string, nullable
  - `evidence` string, nullable
  - `remediation` string, nullable
  - `note` string, nullable
  - `reviewer_note` string, nullable
  - `citations` RequirementCitationResponse[]
    - `upload_id` string, uuid, required
    - `cited_text` string, required
    - `start_page_number` integer, required
    - `end_page_number` integer, required
    - `bounding_boxes` BoundingBox[]
      - `x0` number, required
      - `y0` number, required
      - `x1` number, required
      - `y1` number, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/kobaltlabs/apis/kobaltlabs-api.md) - [All operations](https://skmtc.dev/kobaltlabs/apis/kobaltlabs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kobaltlabs/apis/kobaltlabs-api/revisions/8587332d5e43?raw)
