Get compliance results

Get compliance report

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/content/{id}/compliance \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/content/{id}/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/content/{id}/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/content/{id}/compliance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "article_id": "4d42cdcf-e24f-4123-960e-6c15761fcfcf",
    "status": "not_checked",
    "report": null
  }
}

GET

content

{id}

compliance

Get compliance report

curl --request GET \
  --url https://api.app.hrizn.io/v1/public/content/{id}/compliance \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/content/{id}/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.app.hrizn.io/v1/public/content/{id}/compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.hrizn.io/v1/public/content/{id}/compliance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "article_id": "4d42cdcf-e24f-4123-960e-6c15761fcfcf",
    "status": "not_checked",
    "report": null
  }
}

Returns the latest compliance check results for content. Scope required: content:read

Path parameters

string

required

UUID of the content.

Response

string

UUID of the article.

string

Compliance status: not_checked, checking, completed, or failed.

object | null

Latest report — overall verdict and score, per-category scores, and a flat issues array. null if compliance has not been run.

string

Stable finding id. Pass it to Apply compliance decisions as issue_ids (fix) or ignore_issue_ids (dismiss). Ids survive re-checks of the same finding.

object[]

Decisions already recorded against findings (state: accepted or ignored, with who/when/why where known). Carried across re-checks, so a resolved finding does not come back as open.

{
  "data": {
    "article_id": "4d42cdcf-e24f-4123-960e-6c15761fcfcf",
    "status": "not_checked",
    "report": null
  }
}

When a compliance check has been completed:

{
  "data": {
    "article_id": "4d42cdcf-e24f-4123-960e-6c15761fcfcf",
    "status": "completed",
    "report": {
      "overall": "FAIL",
      "overall_score": 91,
      "summary": {
        "total_issues": 1,
        "high_severity_issues": 1,
        "medium_severity_issues": 0,
        "low_severity_issues": 0
      },
      "issues": [
        {
          "id": "9f3d2a417c05b1e8",
          "severity": "high",
          "category": "msrp_pricing",
          "description": "Implies a guaranteed price without disclosure",
          "problematic_text": "guaranteed lowest price",
          "suggested_replacement": "competitive pricing"
        }
      ],
      "timestamp": "2026-08-25T15:10:40.588Z"
    },
    "dispositions": [
      {
        "issue_id": "4b8e1f60aa3c92d7",
        "state": "ignored",
        "at": "2026-08-24T18:02:11.000Z",
        "reason": "OEM-approved seasonal wording"
      }
    ]
  }
}

Act on findings with Apply compliance decisions: issue_ids fixes the copy, ignore_issue_ids records a dismissal.

To trigger a compliance check, use Trigger compliance. Content must be in complete status before a compliance check can be run.

Authorizations

X-API-Key

string

header

required

Your Hrizn API key (prefix hzk_)

Path Parameters

string<uuid>

required

Content ID

Response

Compliance report

data

object

Hide child attributes

data.article_id

string<uuid>

data.status

enum<string>

Available options:

not_checked,

checking,

completed

data.report

object | null

Hide child attributes

data.report.score

integer

data.report.issues

object[]

Hide child attributes

data.report.issues.severity

string

data.report.issues.rule

string

data.report.issues.message

string

data.report.issues.location

string

data.report.checked_at

string<date-time>

Last modified on August 26, 2026

Overview

IdeaClouds

Content Intelligence

Content

Content Types

Compliance

Content Tools

Inventory

Market

Site

Dealership Config

Social

Webhooks

Reference

Health

Analytics

IdeaClouds

Content

Compliance

Content Tools

Inventory

Market

Site

Webhooks

Content Intelligence

Reference

Social

Path parameters

Response

Authorizations

Path Parameters

Response

​Path parameters

​Response

Authorizations

Path Parameters

Response

Path parameters

Response