Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neariq.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

White-label reports use a versioned branding object instead of reading live app styles or raw profile settings directly. The export renderer receives a PdfBrandTokens snapshot, renders from that snapshot, and stores the same snapshot with the export record. This keeps exported reports reproducible after an agency changes its logo, colors, contact details, or after the NearIQ app design changes.

​
Token Shape

{
  "schemaVersion": 1,
  "source": "white_label",
  "identity": {
    "companyName": "Acme Local SEO",
    "tagline": "Local intelligence for multi-location brands",
    "logoUrl": "data:image/png;base64,..."
  },
  "colors": {
    "primary": "#0D89F9",
    "accent": "#0D89F9",
    "ink": "#111827",
    "muted": "#6b7280",
    "background": "#ffffff"
  },
  "typography": {
    "bodyFont": "Inter",
    "headingFont": "Inter"
  },
  "contact": {
    "website": "https://example.com",
    "email": "reports@example.com",
    "phone": "+1 555 0100",
    "address": "123 Main St"
  },
  "footer": {
    "text": "Prepared by Acme Local SEO",
    "legalText": "AI insights are for informational purposes only. Verify important business decisions independently."
  },
  "charts": {
    "palette": ["#0D89F9", "#1D9E75", "#EF9F27"]
  }
}

​
Source Settings

The branding settings saved from the app are normalized before they can be used by report exports. Allowed settings:
KeyTypeNotes
company_namestringMax 80 characters
taglinestringMax 120 characters
logostringHTTPS URL or image data URL, max 200 KB encoded
primary_colorhex colorOptional; falls back to accent
accent_colorhex colorOptional; falls back to NearIQ blue
font_familyenumInter, DM Sans, Arial, Helvetica, Georgia
heading_font_familyenumSame enum
websiteHTTPS URLOptional
emailemailOptional
phonestringMax 30 characters
addressstringMax 200 characters
footer_textstringMax 160 characters
legal_textstringMax 240 characters
chart_palettehex color array3 to 8 colors

​
Export Rules

  • Build branding tokens before rendering.
  • Enable white-label branding only after server-side plan and permission checks pass.
  • Store the exact token object used for each export so the file can be reproduced later.
  • Do not render directly from raw settings.
  • Do not render directly from app CSS variables.
  • If validation fails, use NearIQ’s default branding tokens.

​
Export Record

Each report export stores the branding snapshot used at render time.
FieldPurpose
Source reportOptional source intelligence report
OwnerUser who requested the export
BusinessOptional business context
FormatExport format
StatusExport lifecycle status
Branding snapshotExact render token snapshot
File locationStored file path or URL when available
Error detailFailure detail for support
Export records are scoped to the owning user.