compliance:write
The compliance:write scope allows you to trigger compliance checks on content. Compliance checks verify that content meets OEM guidelines and advertising regulations. The check runs asynchronously — use the Get compliance report endpoint (requires content:read) or the compliance.completed webhook event to retrieve results.
Endpoints
| Method | Path | Description |
|---|
POST | /public/content/{id}/compliance | Trigger a compliance check |
Trigger compliance check
POST /public/content/{id}/compliance
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"
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"
{
"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"]
}
}
}
