Crear Solicitud de Firma
Crea una nueva solicitud de firma ya sea a partir de un documento PDF (basado en documento) o a partir de una plantilla existente (basado en plantilla). Para la creación basada en documento, allow_editing_before_sending se establece automáticamente en true. Para la creación basada en plantilla, las propiedades se heredan de la plantilla y se pueden sobrescribir.
Patrón de ID Temporal: Para la creación basada en documento, puedes referenciar destinatarios antes de que se creen usando IDs temporales (formato: ‘temp_X’ donde X es cualquier identificador, por ejemplo, ‘temp_1’, ‘temp_alice’). Usa estos IDs temporales en recipient.id, field.recipient_id y reminder.recipient_id. La API valida todas las referencias y mapea automáticamente los IDs temporales a UUID reales después de que se crean los destinatarios. La respuesta contiene solo UUID reales.
Validación de ID Temporal: Los IDs temporales deben comenzar con ‘temp_’, ser únicos entre todos los destinatarios de la solicitud, y todas las referencias de field/reminder deben apuntar a destinatarios definidos en la misma solicitud. Un formato inválido, IDs duplicados o referencias de destinatario faltantes devuelven un error 400 con mensajes de validación detallados.
Autorizaciones
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
- Option 1
- Option 2
Crear una Solicitud de Firma a partir de un documento PDF
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.
Nombre para la Solicitud de Firma
255Descripción para la Solicitud de Firma
Horas hasta que expire la Solicitud de Firma (predeterminado: 168 = 7 días)
x >= 1Destinatarios 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.
Campos a colocar en el documento
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).
100Recordatorios para enviar a los destinatarios
Configuración de la Solicitud de Firma
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).
en, es, it, pt, fr, de, el, ru, pl, cs, sv, nl, ro, nb 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.
200Texto 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.
1000URL 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.
2000Segundos 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.
0 <= x <= 30Participantes 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)
Identificador único de la solicitud de firma
Nombre de la solicitud de firma
255El status siempre es 'draft' para solicitudes de firma recién creadas
draft Descripción de la solicitud de firma
URL prefirmada al documento PDF
Número de páginas en el documento
x >= 1Horas hasta que la solicitud de firma expire (por defecto: 168 = 7 días)
x >= 1ID de la plantilla si se creó a partir de una plantilla
Configuración devuelta por los endpoints de listado y detalle de Solicitudes de Firma. Las Plantillas usan el esquema TemplateSettings (sin campos de identidad).
Marca de tiempo de creación
Marca de tiempo de la última actualización
Cuándo se envió la solicitud de firma
Cuándo se completaron todas las firmas
Cuándo se canceló la solicitud de firma
Destinatarios de la solicitud de firma
Campos de la solicitud de firma con valores de posición planos
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.
Participantes de sello de organización en el orden de firma. Vacío cuando la solicitud no tiene sellos.