Skip to main content
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.

What you get back

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.