Skip to main content
PATCH
/
policies
/
{policyId}
/
documents
/
compliance
/
{documentId}
/
override
Override compliance status for a document
curl --request PATCH \
  --url https://api.example.com/policies/{policyId}/documents/compliance/{documentId}/override \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "COMPLIANT"
}
'
{
  "documentId": "<string>",
  "status": "PENDING",
  "results": [
    {
      "ruleType": "READABLE",
      "passed": true,
      "message": "<string>",
      "metadata": {}
    }
  ],
  "aiMetadata": {},
  "checkedAt": "<string>",
  "override": {
    "overriddenBy": "<string>",
    "overriddenAt": "<string>",
    "previousStatus": "<string>",
    "originalStatus": "<string>"
  }
}

Path Parameters

policyId
string
required
documentId
string
required

Body

application/json
status
enum<string>
required
Available options:
COMPLIANT,
NON_COMPLIANT

Response

documentId
string
required

Document ID

status
enum<string>
required

Overall compliance status

Available options:
PENDING,
COMPLIANT,
NON_COMPLIANT,
FAILED,
SKIPPED
results
object[]
required

Results for each compliance rule

aiMetadata
object

AI compliance metadata

checkedAt
string

Last check timestamp

override
object

Override metadata if compliance was manually overridden