…
" } }, "confidence": 0.9, "evidence_refs": [], "details": { "failingRegions": [ "US-CA" ] }, "scan": "scan_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", "first_seen": 1793318400, "last_seen": 1793318400, "resolved_at": 1793318400 } ], "has_more": false, "url": "/v1/sites" } ``` ## Retrieve a finding {#retrieveFinding} `GET /v1/findings/{finding}` One finding with its legal requirements (citations), evidence references and remediation. **Scope** `findings:read` · **Operation** `retrieveFinding` SDK: `checkbox.findings.retrieve()` (Node) · `checkbox.findings.retrieve()` (Python). MCP / agents: operation `retrieveFinding`. #### Parameters | Parameter | In | Type | Description | |---|---|---|---| | `finding` **required** | path | string | Unique identifier of the finding (fnd_…). | #### Returns Returns a [Finding](https://checkbox.site/docs/api/findings#the-finding-object) object. Errors use the [standard envelope](https://checkbox.site/docs/api/errors) with a stable `code` and, where useful, `next_action`. ```curl curl https://app.checkbox.site/v1/findings/fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b \ -u "$CHECKBOX_SECRET_KEY:" ``` ```node import Checkbox from '@checkbox-site/cli'; const checkbox = new Checkbox(process.env.CHECKBOX_SECRET_KEY); const finding = await checkbox.findings.retrieve('fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b'); console.log(finding); ``` ```python import os from checkbox import Checkbox checkbox = Checkbox(os.environ["CHECKBOX_SECRET_KEY"]) finding = checkbox.findings.retrieve("fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b") print(finding) ``` ```json title="Response" { "id": "fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", "object": "finding", "livemode": false, "site": "site_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", "check_id": "signup.disclosure_clear_conspicuous", "title": "Auto-renewal terms are not shown before purchase", "detail": "The checkout page in US-CA (mobile) shows no renewal terms near the subscribe button.", "stage": "signup", "severity": "high", "status": "fail", "state": "open", "note": null, "jurisdictions": [ "US-CA", "US-NY" ], "requirements": [ { "id": "US-CA.17602.a.1", "jurisdiction": "US-CA", "citation": "Cal. Bus. & Prof. Code § 17602(a)(1)", "title": "Clear and conspicuous auto-renewal terms before purchase", "source_url": "https://leginfo.legislature.ca.gov/…" } ], "remediation": { "summary": "Show the auto-renewal terms next to the subscribe button.", "steps": [ "Add the disclosure above the button" ], "platform": "stripe", "suggested_copy": "Your subscription renews automatically every month at $9.99 until you cancel.", "snippet": { "language": "html", "code": "…
" } }, "confidence": 0.9, "evidence_refs": [], "details": { "failingRegions": [ "US-CA" ] }, "scan": "scan_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", "first_seen": 1793318400, "last_seen": 1793318400, "resolved_at": 1793318400 } ``` ## Triage a finding {#updateFinding} `POST /v1/findings/{finding}` Sets the triage state (open, acknowledged, accepted_risk, resolved) and an optional note. Triage does not change the check result; fixing the issue and re-scanning does. **Scope** `findings:write` · **Idempotent** (send `Idempotency-Key`) · **Operation** `updateFinding` SDK: `checkbox.findings.update()` (Node) · `checkbox.findings.update()` (Python). MCP / agents: operation `updateFinding`. #### Parameters | Parameter | In | Type | Description | |---|---|---|---| | `finding` **required** | path | string | Unique identifier of the finding (fnd_…). | #### Body | Field | Type | Description | |---|---|---| | `state` **required** | enum | New triage state. One of `open`, `acknowledged`, `resolved`, `accepted_risk`. | | `note` | string | Why (kept with the finding). | #### Returns Returns a [Finding](https://checkbox.site/docs/api/findings#the-finding-object) object. Errors use the [standard envelope](https://checkbox.site/docs/api/errors) with a stable `code` and, where useful, `next_action`. ```curl curl https://app.checkbox.site/v1/findings/fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b \ -u "$CHECKBOX_SECRET_KEY:" \ -H "Content-Type: application/json" \ -d '{ "state": "acknowledged" }' ``` ```node import Checkbox from '@checkbox-site/cli'; const checkbox = new Checkbox(process.env.CHECKBOX_SECRET_KEY); const finding = await checkbox.findings.update('fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b', { state: 'acknowledged' }); console.log(finding); ``` ```python import os from checkbox import Checkbox checkbox = Checkbox(os.environ["CHECKBOX_SECRET_KEY"]) finding = checkbox.findings.update("fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", state="acknowledged") print(finding) ``` ```json title="Response" { "id": "fnd_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", "object": "finding", "livemode": false, "site": "site_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", "check_id": "signup.disclosure_clear_conspicuous", "title": "Auto-renewal terms are not shown before purchase", "detail": "The checkout page in US-CA (mobile) shows no renewal terms near the subscribe button.", "stage": "signup", "severity": "high", "status": "fail", "state": "open", "note": null, "jurisdictions": [ "US-CA", "US-NY" ], "requirements": [ { "id": "US-CA.17602.a.1", "jurisdiction": "US-CA", "citation": "Cal. Bus. & Prof. Code § 17602(a)(1)", "title": "Clear and conspicuous auto-renewal terms before purchase", "source_url": "https://leginfo.legislature.ca.gov/…" } ], "remediation": { "summary": "Show the auto-renewal terms next to the subscribe button.", "steps": [ "Add the disclosure above the button" ], "platform": "stripe", "suggested_copy": "Your subscription renews automatically every month at $9.99 until you cancel.", "snippet": { "language": "html", "code": "…
" } }, "confidence": 0.9, "evidence_refs": [], "details": { "failingRegions": [ "US-CA" ] }, "scan": "scan_3f9a1c2e7b4d4e0f9a8b7c6d5e4f3a2b", "first_seen": 1793318400, "last_seen": 1793318400, "resolved_at": 1793318400 } ```