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

Cuerpo

application/json

Crear una Solicitud de Firma a partir de un documento PDF

document
string<byte>
requerido

Documento PDF o DOCX codificado en base64. Los archivos DOCX se convierten automáticamente a PDF. El número de páginas se extrae automáticamente. Para documentos de más de 5 MB, usa POST /documents y pasa el document_id en su lugar.

name
string

Nombre para la Solicitud de Firma

Maximum string length: 255
description
string

Descripción para la Solicitud de Firma

expiration_hours
integer
predeterminado:168

Horas hasta que expire la Solicitud de Firma (predeterminado: 168 = 7 días)

Rango requerido: x >= 1
recipients
object[]

Destinatarios para la Solicitud de Firma. Usa IDs temporales (por ejemplo, 'temp_1') en el campo id para hacer referencia a los destinatarios en fields/reminders.

fields
object[]

Campos a colocar en el documento

anchor_tags
object[]

Etiquetas de anclaje para la colocación automática de campos. Se localizan marcadores de texto en el PDF y se convierten en campos posicionados. El texto de anclaje se elimina del PDF después del procesamiento. Los campos creados a partir de etiquetas de anclaje se añaden junto con cualquier campo especificado manualmente. Solo está disponible para la creación basada en documento (no basada en Plantilla).

Maximum array length: 100
reminders
object[]

Recordatorios para enviar a los destinatarios

settings
object

Configuración de la Solicitud de Firma

language
enum<string> | null

Idioma opcional de los correos para esta solicitud de firma. Cuando se establece, todos los correos dirigidos al firmante (y el formato de fecha) lo utilizan. Omítelo o usa null para volver al idioma predeterminado del espacio de trabajo y luego de la empresa (sin cambios de comportamiento).

Opciones disponibles:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl,
cs,
sv,
nl,
ro,
nb
completion_title
string | null

Encabezado mostrado en la página de finalización tras la firma. Hereda del espacio de trabajo y después de la empresa cuando se omite o es null.

Maximum string length: 200
completion_message
string | null

Texto principal mostrado en la página de finalización tras la firma. Hereda del espacio de trabajo y después de la empresa cuando se omite o es null.

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

URL a la que se redirige al firmante desde la página de finalización. Debe usar https:// (http://localhost y http://127.0.0.1 también se aceptan en solicitudes de firma en modo de prueba). Hereda del espacio de trabajo y después de la empresa cuando se omite o es null.

Maximum string length: 2000
completion_redirect_delay
integer | null

Segundos 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. Hereda del espacio de trabajo y después de la empresa cuando se omite o es null.

Rango requerido: 0 <= x <= 30
seal_participants
object[]

Participantes de sello de organización a incluir en la secuencia de firma

Respuesta

Solicitud de firma creada exitosamente. La respuesta puede incluir advertencias no bloqueantes de correo electrónico o de etiquetas de anclaje.

Solicitud de firma tal como la devuelven los endpoints CREATE (POST /signing-requests)

id
string<uuid>
requerido

Identificador único de la solicitud de firma

name
string
requerido

Nombre de la solicitud de firma

Maximum string length: 255
status
enum<string>
requerido

El status siempre es 'draft' para solicitudes de firma recién creadas

Opciones disponibles:
draft
description
string | null

Descripción de la solicitud de firma

document_url
string<uri>

URL prefirmada al documento PDF

page_count
integer

Número de páginas en el documento

Rango requerido: x >= 1
expiration_hours
integer
predeterminado:168

Horas hasta que la solicitud de firma expire (por defecto: 168 = 7 días)

Rango requerido: x >= 1
template_id
string<uuid> | null

ID de la plantilla si se creó a partir de una plantilla

settings
object

Configuración devuelta por los endpoints de listado y detalle de Solicitudes de Firma. Las Plantillas usan el esquema TemplateSettings (sin campos de identidad).

created_date
string<date-time>

Marca de tiempo de creación

updated_date
string<date-time>

Marca de tiempo de la última actualización

sent_date
string<date-time> | null

Cuándo se envió la solicitud de firma

finished_date
string<date-time> | null

Cuándo se completaron todas las firmas

cancelled_date
string<date-time> | null

Cuándo se canceló la solicitud de firma

recipients
object[]

Destinatarios de la solicitud de firma

fields
object[]

Campos de la solicitud de firma con valores de posición planos

warnings
string[]

Advertencias opcionales no bloqueantes, incluidos formatos de correo electrónico de destinatario inusuales, propiedades de etiquetas de anclaje desconocidas durante la ventana de compatibilidad y advertencias de procesamiento de anclajes.

seal_participants
object[]

Participantes de sello de organización en el orden de firma. Vacío cuando la solicitud no tiene sellos.