Read your white-label settings over the API and mirror them in your own UI.
The candidate-facing experience carries your branding, not ours. GET /v1/account returns
those settings so your own tooling can match.
Branding is configured in the dashboard (Settings → Branding) and read-only over the
API. It’s an account-level setting, so only a Company Admin can change it.
The single accent applied across candidate-facing pages.
primary_color
Optional override for primary surfaces. null falls back to the default.
logo_url
Absolute URL, safe to use directly in your own UI.
sender_name
The From name on candidate emails.
support_email
Where candidates are told to get help.
custom_domain
Your assessment domain, if configured.
custom_domain_verified
Whether DNS has been verified. Until true, links use our domain.
Check custom_domain_verified before building a candidate URL from custom_domain. An
unverified domain doesn’t serve yet, and a link to it will fail. The invitation_url
returned when you create an invitation is always correct — prefer it over constructing
one.
Any field may be null when it hasn’t been configured. Treat null as “use your own
default” rather than as an error.
Mirroring it in your UI
If you show a candidate their assessment status inside your own product, reading these
values keeps the two consistent — one accent colour, one logo, one support address — so a
candidate never sees a handoff between two differently-branded systems.
Cache this. Branding changes rarely and GET /v1/account draws on your read quota; there’s
no reason to fetch it per page view.