Report Branding

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,...",
    "bannerUrl": null
  },
  "colors": {
    "primary": "#0f0e0c",
    "accent": "#0f0e0c",
    "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": ["#0f0e0c", "#1D9E75", "#EF9F27"]
  }
}

Source Settings

The branding settings saved from the app are normalized before they can be used by report exports. Allowed settings:

Key	Type	Notes
`company_name`	string	Max 80 characters
`tagline`	string	Max 120 characters
`logo`	string	Hosted image URL or image data URL (PNG, JPEG, WEBP, SVG), max 2 MB
`banner`	string	Optional full-width report header image. Hosted image URL or image data URL (PNG, JPEG, WEBP, SVG), max 5 MB
`primary_color`	hex color	Optional; falls back to accent
`accent_color`	hex color	Optional; falls back to NearIQ primary
`font_family`	enum	`Inter`, `DM Sans`, `Arial`, `Helvetica`, `Georgia`
`heading_font_family`	enum	Same enum
`website`	HTTPS URL	Optional
`email`	email	Optional
`phone`	string	Max 30 characters
`address`	string	Max 200 characters
`footer_text`	string	Max 160 characters
`legal_text`	string	Max 240 characters
`chart_palette`	hex color array	3 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.

Field	Purpose
Source report	Optional source intelligence report
Owner	User who requested the export
Business	Optional business context
Format	Export format
Status	Export lifecycle status
Branding snapshot	Exact render token snapshot
File location	Stored file path or URL when available
Error detail	Failure detail for support

Export records are scoped to the owning user.

API Reference

Endpoints

Webhooks

Report Branding

Overview

Token Shape

Source Settings

Export Rules

Export Record

​Overview

​Token Shape

​Source Settings

​Export Rules

​Export Record

Overview

Token Shape

Source Settings

Export Rules

Export Record