White-label

Update the white-label configuration

Updates the branding applied to analysis outputs and emails. If the key is master of an organization, the changes propagate automatically to ALL child sub-keys. Sub-keys can NOT edit their own branding (403 FORBIDDEN_CHILD_KEY) — only the master can.

Available modes:

  • nexus (default): outputs keep 'Nexus Legal'.
  • partner: replaces 'Nexus Legal' with partner_brand_name in the body of the analysis. The technical NEXUS-AUDIT-TRAIL block is preserved.
  • none: removes the mentions of 'Nexus Legal' from the body.

Anti-SSRF validation: partner_logo_url and partner_website must be public https URLs (no localhost, no private IPs, no metadata services). Same pattern as /api/v1/webhooks.

put/api/v1/branding

Request

  • Base URL: https://legal.nexusquantum.legal
  • URL: https://legal.nexusquantum.legal/api/v1/branding
  • Auth: HTTP bearer

Request body

branding'nexus' | 'partner' | 'none'

Branding mode. nexus keeps 'Nexus Legal'. partner replaces it with partner_brand_name. none removes the mentions.

partner_brand_namestring nullable

Partner trade name. Replaces 'Nexus Legal' in the analysis body when branding='partner'. Required when mode is partner.

partner_legal_namestring nullable

Registered legal name. Used in the audit-trail PDF and in DPA generation.

partner_logo_urlstring uri nullable

Public https URL of the logo. Anti-SSRF (no localhost, no private IPs).

partner_primary_colorstring nullable

Hex color #RRGGBB for emails and dashboards.

partner_support_emailstring email nullable

Reply-to in webhook notifications + system messages.

partner_websitestring uri nullable

Partner website URL. Used in the email footer.

Example request

{
  "partner_brand_name": "Acme Legal AI",
  "partner_legal_name": "Acme Legal S.A.",
  "partner_logo_url": "https://cdn.example.com/logo.png",
  "partner_primary_color": "#1A5F8B",
  "partner_support_email": "soporte@example.com",
  "partner_website": "https://example.com"
}

Response

Configuration saved. Returns applied_to_keys with the number of affected keys (1 if solo, N if master of an org).

okboolean required
applied_to_keysinteger required

Number of keys it was applied to (1 if solo, N if a master propagated to children).

requestIdstring

Example response

{
  "config": {
    "partner_brand_name": "Acme Legal AI",
    "partner_legal_name": "Acme Legal S.A.",
    "partner_logo_url": "https://cdn.example.com/logo.png",
    "partner_primary_color": "#1A5F8B",
    "partner_support_email": "soporte@example.com",
    "partner_website": "https://example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.