Create audit finding | Comp AI API

Create an audit finding so teams can track issue ownership, remediation activity, severity, and supporting evidence.

POST /v1/findings

Create audit finding

cURL

curl --request POST \
  --url https://api.trycomp.ai/v1/findings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "soc2",
  "content": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'soc2', content: '<string>'})
};

fetch('https://api.trycomp.ai/v1/findings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/findings"

payload = {
    "type": "soc2",
    "content": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Authorizations

X-API-Key · string · header · required

API key for authentication

Body

application/json

type · enum<string> · default: soc2 · required

Type of finding (SOC 2 or ISO 27001)

Available options: soc2, iso27001

content · string · required

Finding content/message

Maximum string length: 5000

taskId · string

Task ID

evidenceSubmissionId · string

Evidence submission ID

evidenceFormType · enum<string>

Evidence form type

Available options: board-meeting, it-leadership-meeting, risk-committee-meeting, meeting, access-request, whistleblower-report, penetration-test, rbac-matrix, infrastructure-inventory, employee-performance-evaluation, network-diagram, tabletop-exercise

policyId · string

Policy ID

vendorId · string

Vendor ID

riskId · string

Risk ID

memberId · string

Member ID (person this finding targets)

deviceId · string

Device ID

area · enum<string>

Broad area when the finding is not tied to a specific item

Available options: people, documents, compliance, risks, vendors, policies, other

severity · enum<string> · default: medium

Severity

Available options: low, medium, high, critical

Response

201 - undefined