Skip to main content
GET
Get public tenant config

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Response

brokerageFirmCustomFields
object[]
required
theme
object
required

Visual theming configuration (colors, logos, branding)

authentication
object
required

Authentication configuration (Cognito user pool, OAuth domain)

tenantName
string
required
availableProductIds
string[]
required

Product ids active (feature-flag-enabled) for this tenant in this environment.

speechToText
object

Speech-to-text (dictation) config. When set, dictation is enabled for this tenant; when absent, dictation is off. Exposed in the public tenant config so the frontend can gate the mic.

External links (attestations, notices, legal pages, …) rendered in the tenant frontend on the login page, the home page and the sidebar. Exposed in the public tenant config.

previousClaimsPlatformUrl
string<uri>

URL of the legacy claims platform. When set, the tenant frontend surfaces an alert pointing users to it for claims filed before migration. Exposed in the public tenant config.

displayName
string

Human-readable tenant name shown to end users in the tenant frontend. Falls back to the technical tenant ID when unset.

distributionRequest
object
brokerageFirmDocuments
object
documentPrefill
object

Controls the default choice (upload now vs. later) on the document prefill funnel step

reports
object[]
metabaseDashboardIds
object[]

Metabase dashboard tabs configuration (takes priority over metabaseDashboardId)

ai
object

Tenant-level AI configuration (classification, extraction)

externalScripts
object[]

Third-party scripts to inject into the tenant frontend at runtime (e.g. chat widgets). Each entry is rendered as a