> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.hrizn.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Check freeform compliance

> Run a sync OEM compliance check on pasted marketing copy

Analyzes arbitrary marketing copy against the dealership’s OEM advertising rules. Returns overall score, categories, and flat issues with `suggested_replacement` text.

**Scope required:** `compliance:write`

Also requires the dealership’s **Compliance Checking** plan feature (Pro+ / add-on). Automotive heuristics only — not legal advice.

## Body

<ParamField body="text" type="string" required>Marketing copy to analyze (plain text or HTML).</ParamField>
<ParamField body="format" type="string">Optional `plain` or `html` hint.</ParamField>
<ParamField body="source_label" type="string">Optional label stamped onto the report (for example `social_ad`).</ParamField>

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "data": {
      "status": "completed",
      "report": {
        "overall": "FAIL",
        "overall_score": 70,
        "issues": [
          {
            "id": "a1b2c3d4e5f67890",
            "severity": "HIGH",
            "category": "msrpPricing",
            "description": "Sale language below MSRP",
            "problematic_text": "Huge sale",
            "suggested_replacement": "Featured vehicles"
          }
        ],
        "disclaimer": "OEM advertising heuristics for dealership marketing copy — not legal advice."
      },
      "guidance": "Lead with HIGH severity issues..."
    }
  }
  ```
</ResponseExample>

<Tip>
  For interactive agent loops, call this tool, discuss HIGH issues, then [Apply compliance fixes](/api-reference/compliance/apply-fixes) with `recheck: true`.
</Tip>


## OpenAPI

````yaml POST /compliance/check
openapi: 3.1.0
info:
  title: Hrizn Public API
  version: 1.2.0
  description: >
    The Hrizn Public API allows partners to programmatically create content,
    manage inventory descriptions, and integrate with the Hrizn platform.


    All endpoints are prefixed with `/public` and require an API key passed via
    the `X-API-Key` header (except the health check).
  contact:
    email: support@hrizn.io
servers:
  - url: https://api.app.hrizn.io/v1/public
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: IdeaClouds
    description: Create and manage AI-powered keyword research
  - name: Content Intelligence
    description: AI-powered content gap analysis and recommendations
  - name: Content
    description: Generate content from IdeaClouds
  - name: Compliance
    description: Run OEM compliance checks on content
  - name: Content Tools
    description: Generate SEO metadata, schemas, and social snippets
  - name: Inventory
    description: Access vehicle data and AI descriptions
  - name: Market
    description: >-
      Live local market listings, days supply, competitive set, and pricing
      insights (Unlimited plan + market_data:read)
  - name: Site
    description: View dealership details and configuration
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events
  - name: Reference
    description: Look up available types, scopes, and events
  - name: Social
    description: >-
      Social Hub posting and reviews across all connected platforms (X,
      Facebook, Instagram, LinkedIn, Google Business Profile)
  - name: Health
    description: Health check (no authentication)
paths:
  /compliance/check:
    post:
      tags:
        - Compliance
      summary: Check freeform copy
      description: >
        Sync OEM advertising compliance check on arbitrary marketing copy.
        Requires compliance:write and the Compliance Checking plan feature.
        Heuristics only — not legal advice.
      operationId: checkComplianceFreeform
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - text
              properties:
                text:
                  type: string
                  minLength: 1
                  maxLength: 100000
                format:
                  type: string
                  enum:
                    - plain
                    - html
                source_label:
                  type: string
                  maxLength: 200
      responses:
        '200':
          description: Compliance report
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    BadRequest:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: API key lacks required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: 'keyword: Required'
            details:
              type: object
            request_id:
              type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Hrizn API key (prefix hzk_)

````