Skip to main content
GET
@firma-dev/sdk

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Respuesta

Configuración de la empresa recuperada correctamente

default_expiration_hours
integer
requerido
Rango requerido: 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

Muestra un código QR en la página de firma que permite a los firmantes continuar desde su teléfono. Este es el valor predeterminado a nivel de empresa; los espacios de trabajo, plantillas y solicitudes de firma pueden sobrescribirlo.

completion_title
string | null

Encabezado predeterminado a nivel de empresa para la página de finalización mostrada tras la firma. Los espacios de trabajo, las plantillas y las solicitudes de firma pueden sobrescribirlo. Null significa que no hay valor predeterminado de empresa, por lo que se usa el encabezado traducido integrado.

Maximum string length: 200
completion_message
string | null

Texto principal predeterminado a nivel de empresa para la página de finalización mostrada tras la firma. Los espacios de trabajo, las plantillas y las solicitudes de firma pueden sobrescribirlo. Null significa que no hay valor predeterminado de empresa, por lo que se usa el mensaje traducido integrado.

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

URL predeterminada a nivel de empresa a la que se redirige al firmante desde la página de finalización. Debe usar https://. Los espacios de trabajo, las plantillas y las solicitudes de firma pueden sobrescribirla. Null significa que no hay redirección salvo que un nivel inferior la defina.

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

Número de segundos predeterminado a nivel de empresa que espera la página de finalización antes de redirigir (0 redirige de inmediato). Solo se aplica cuando se resuelve una URL de redirección; la página usa 5 segundos cuando ningún nivel define un retraso.

Rango requerido: 0 <= x <= 30