Sign in
Company

Get company settings

Retrieve settings for the authenticated company

get/company/settings

Response

Company settings retrieved successfully

default_expiration_hoursinteger required
require_terms_acceptanceboolean
show_custom_branding_onlyboolean
require_otp_verificationboolean
allow_presigning_downloadboolean
disable_guided_navigationboolean
show_signature_frameboolean
show_partial_watermarkboolean
email_local_partstring
color_primarystring nullable
color_primary_fgstring nullable
color_backgroundstring nullable
color_foregroundstring nullable
color_cardstring nullable
color_borderstring nullable
color_accentstring nullable
color_accent_fgstring nullable
color_canvasstring nullable
color_mutedstring nullable
color_muted_fgstring nullable
show_qr_codeboolean nullable

Show a QR code on the signing page that lets signers continue on their phone. This is the company-level default; workspaces, templates, and signing requests can override it.

completion_titlestring nullable

Company-level default heading for the completion page shown after signing. Workspaces, templates, and signing requests can override it. Null means no company default, so the built-in translated heading is used.

completion_messagestring nullable

Company-level default body text for the completion page shown after signing. Workspaces, templates, and signing requests can override it. Null means no company default, so the built-in translated message is used.

completion_redirect_urlstring uri nullable

Company-level default URL the signer is redirected to from the completion page. Must use https://. Workspaces, templates, and signing requests can override it. Null means no redirect unless a lower level sets one.

completion_redirect_delayinteger nullable

Company-level default number of seconds the completion page waits before redirecting (0 redirects immediately). Only applies when a redirect URL resolves; the page falls back to 5 seconds when no level sets a delay.

default_timezonestring

IANA timezone identifier used as the company-wide default for certificates and email timestamps.

language'en' | 'es' | 'it' | 'pt' | 'fr' | 'de' | 'el' | 'ru' | 'pl' | 'cs' | 'sv' | 'nl' | 'ro' | 'nb'

Default language for company emails and certificates.

Example response

{
  "default_timezone": "Europe/Paris",
  "language": "en"
}

Changes

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