compliance:write

compliance:write The compliance:write scope allows you to run OEM advertising compliance checks and apply suggested replacements. Use the sync freeform endpoints for pasted copy (agents / MCP), or trigger an async check on existing Hrizn content. Freeform checks also require the dealership’s Compliance Checking plan feature (Pro+ / add-on). Results are heuristics — not legal advice.

Endpoints

Method	Path	Description
`POST`	`/public/compliance/check`	Sync freeform compliance check
`POST`	`/public/compliance/apply-fixes`	Apply selected replacements (optional recheck)
`POST`	`/public/content/{id}/compliance`	Trigger an async article compliance check

Article reports are retrieved with content:read via GET /public/content/{id}/compliance, or via the compliance.completed webhook.

Check freeform copy

POST /public/compliance/check

Analyzes arbitrary marketing copy (plain text or HTML) against OEM checking rules for this dealership. Returns overall score, categories, and a flat issues array with stable ids plus suggested_replacement text.

Body

Name	Type	Required	Description
`text`	string	Yes	Copy to analyze
`format`	`plain` \| `html`	No	Optional format hint
`source_label`	string	No	Optional label stamped on the report

Apply compliance fixes

POST /public/compliance/apply-fixes

Applies selected issue ids (from a prior check) and/or explicit problematic_text → suggested_replacement pairs. Set recheck: true to run another check on the revised text in one round-trip.

Trigger article compliance check

POST /public/content/{id}/compliance

Starts an asynchronous compliance check on the specified content. The check evaluates the content against OEM compliance rules and dealership advertising guidelines.

Path parameters

Name	Type	Required	Description
`id`	string (UUID)	Yes	Article ID

Request body

No request body is required.

Example

curl -X POST https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance \
  -H "X-API-Key: hzk_your_key_here"

const res = await fetch(
  "https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance",
  {
    method: "POST",
    headers: { "X-API-Key": "hzk_your_key_here" },
  }
);
const data = await res.json();

import requests

response = requests.post(
    "https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance",
    headers={"X-API-Key": "hzk_your_key_here"},
)
data = response.json()

$ch = curl_init("https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ["X-API-Key: hzk_your_key_here"],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));

Response — `202 Accepted`

{
  "data": {
    "article_id": "d4e5f6a7-b8c9-0123-def0-456789abcdef",
    "status": "checking"
  }
}

You can skip this manual step by setting auto_compliance: true when creating content. The compliance check will run automatically once generation completes.

Retrieving the compliance report

Once the check completes, retrieve the report using the content:read scope:

curl https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance \
  -H "X-API-Key: hzk_your_key_here"

const res = await fetch(
  "https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance",
  { headers: { "X-API-Key": "hzk_your_key_here" } }
);
const data = await res.json();

import requests

response = requests.get(
    "https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance",
    headers={"X-API-Key": "hzk_your_key_here"},
)
data = response.json()

$ch = curl_init("https://api.app.hrizn.io/v1/public/content/d4e5f6a7-b8c9-0123-def0-456789abcdef/compliance");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["X-API-Key: hzk_your_key_here"],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch));

{
  "data": {
    "article_id": "d4e5f6a7-b8c9-0123-def0-456789abcdef",
    "status": "completed",
    "report": {
      "score": 92,
      "issues": [
        {
          "severity": "warning",
          "rule": "pricing_accuracy",
          "message": "Price mentioned may be outdated",
          "location": "paragraph 3"
        }
      ],
      "checked_at": "2026-02-01T15:30:00Z"
    }
  }
}

Status codes

Code	Description
`202`	Compliance check started
`400`	Article ID is required
`401`	Missing or invalid API key
`403`	API key does not have `compliance:write` scope
`404`	Content not found or belongs to a different site
`500`	Internal server error

Error response — Missing scope

If your API key does not include compliance:write, any request to this endpoint returns:

{
  "error": {
    "code": "forbidden",
    "message": "This API key requires one of the following scopes: compliance:write",
    "details": {
      "required_scopes": ["compliance:write"]
    }
  }
}

Getting Started

Concepts

Guides

Scopes

Endpoints

Check freeform copy

Body

Apply compliance fixes

Trigger article compliance check

Path parameters

Request body

Example

Response — `202 Accepted`

Retrieving the compliance report

Status codes

Error response — Missing scope

​Endpoints

​Check freeform copy

​Body

​Apply compliance fixes

​Trigger article compliance check

​Path parameters

​Request body

​Example

​Response — 202 Accepted

​Retrieving the compliance report

​Status codes

​Error response — Missing scope

Endpoints

Check freeform copy

Body

Apply compliance fixes

Trigger article compliance check

Path parameters

Request body

Example

Response — `202 Accepted`

Retrieving the compliance report

Status codes

Error response — Missing scope