Skip to main content
GET
@firma-dev/sdk

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Response

Company settings retrieved successfully

default_expiration_hours
integer
required
Required range: x >= 1
require_terms_acceptance
boolean
show_custom_branding_only
boolean
require_otp_verification
boolean
allow_presigning_download
boolean
disable_guided_navigation
boolean
show_signature_frame
boolean
show_partial_watermark
boolean
email_local_part
string
color_primary
string | null
color_primary_fg
string | null
color_background
string | null
color_foreground
string | null
color_card
string | null
color_border
string | null
color_accent
string | null
color_accent_fg
string | null
color_canvas
string | null
color_muted
string | null
color_muted_fg
string | null
show_qr_code
boolean | null

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_title
string | null

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.

Maximum string length: 200
completion_message
string | null

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.

Maximum string length: 1000
completion_redirect_url
string<uri> | null

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.

Maximum string length: 2000
Pattern: ^https://
completion_redirect_delay
integer | null

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.

Required range: 0 <= x <= 30