Update a finding

Update a finding. Status transition rules apply based on user role.

PATCH /v1/findings/{id}

Update a finding

cURL

curl --request PATCH \
  --url http://localhost:3333/v1/findings/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "content": "The uploaded evidence does not clearly show the Organization Name or URL.",
  "revisionNote": "Please provide clearer screenshots showing the timestamp."
}
'

Authorizations

X-API-Key · string · header · required

API key for authentication

Headers

X-Organization-Id · string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

id · string · required

Finding ID

Example:

"fnd_abc123"

Body

application/json

Finding update data

status · enum<string>

Finding status

Available options: open, ready_for_review, needs_revision, closed

type · enum<string>

Type of finding (SOC 2 or ISO 27001)

Available options: soc2, iso27001

content · string

Finding content/message

Maximum string length: 5000

Example:

"The uploaded evidence does not clearly show the Organization Name or URL."

revisionNote · object

Auditor note when requesting revision (only for needs_revision status)

Example:

"Please provide clearer screenshots showing the timestamp."

Response

200

The updated finding