Registro de cambios de la API REST
Cambios en la API REST v1 (/api/v1/).
2027
2027-10-27
Recurso TemplatePDF — POST /api/v1/templatepdf/{pdfId}/preview/ reemplaza a GET para generar vistas previas de PDF con campos del remitente completados. GET sigue siendo compatible.
2026
2026-08-26
Recurso TemplatePDF — Nuevo endpoint: GET /api/v1/templatepdf/{pdfId}/preview/ — devuelve una vista previa en PDF para la plantilla especificada.
2026-08-14
Recurso Element/Field — GET /api/v1/document/{id}/fields/ — se agregó el parámetro de filtro de consulta element_type. Ver Obtener campos del documento.
2026-07-02
Recurso TemplatePDF — Nuevo endpoint: GET /api/v1/templatepdf/{id}/component-token/ — devuelve un token del componente visualizador para incrustar el componente visor de PDF.
2026-07-01
Recurso Signer — Nuevo endpoint: GET /api/v1/signer/{id}/component-token/ — devuelve un token del componente para incrustar el componente de firma. Requiere una clave API no heredada y que el grupo esté habilitado para uso del componente.
2026-05-20
Recurso Document — Los enlaces de firma del firmante devueltos en la respuesta API ahora se conservan como enlaces en formato legado para compatibilidad hacia atrás al usar firma por lotes/lobby.
2026-04-28
Autenticación — Ahora está disponible un nuevo esquema de clave API. Las claves existentes continúan funcionando. Se recomienda encarecidamente a los desarrolladores actualizarse — ver developer.legalesign.com para detalles.
2026-01-21
Recurso TemplatePDF — DELETE /api/v1/templatepdf/{id}/delete/ — eliminación actualizada para eliminación segura. Devuelve un error si falla (por ejemplo, política de retención requiere aprobación secundaria).
2026-01-06–07
Recurso Document — Se agregó el campo booleano append_history a la respuesta de envío y detalle del documento. Cuando es true, se agrega la página de historial de firma al PDF completado (refleja el comportamiento existente append_pdf).
Obsoleto: Los campos sign_mouse, sign_type, sign_upload en el recurso documento están obsoletos y serán eliminados en una versión futura.
2025
2025-12-18–19
Recurso Document — Se agregó el parámetro skip para firmantes al enviar un documento. Establecer skip: true en una posición de firmante omite ese destinatario del envío. Los testigos que siguen a un firmante omitido también se omiten automáticamente.
2025-10-30
Recurso Document — La creación de políticas de retención se trasladó del envío API al flujo de firma.
2025-10-08
- Recurso Document — La respuesta de
GET /api/v1/document/{id}/ahora incluye una matrizsigner_objectsjunto con la matriz existentesigners. Cada objeto contiene:firstname,lastname,email,tel,status,order,resource_uri,role,uuid. - Recurso Signer — Se añadió el campo
rolea la respuesta del firmante ("signer","approver"o"witness").
2025-09-26
- Recurso Document —
DELETE /api/v1/document/{id}/— se agregó el parámetro de consulta opcionalemail=1para enviar correos electrónicos de notificación en la eliminación. - Recurso TemplatePDF — Se agregó el parámetro
hide_sender_fieldsal endpoint de edición de PDF. - Recurso Element/Field — Las búsquedas
pdftextysignertextahora aceptan UUID además del nombre de etiqueta. - Recurso Signer — Se añadió el campo
uuidal objeto de respuesta del firmante.
2025-09-04
Recurso Document — Si no se proporciona mensaje al enviar, ahora se usa automáticamente la plantilla de mensaje predeterminada del grupo.
2025-08-22
Recurso Document — Al enviar un documento, el PDF de origen ahora se copia de la plantilla al registro del documento.
2025-06-10
Recurso TemplatePDF — Nuevo endpoint: POST /api/v1/templatepdf/{id}/archive/ — archiva un PDF de plantilla.
2024
2024-10-17
Recurso Document — Se eliminó el parámetro de firmante obsoleto append_to. Este parámetro no tenía efecto y fue eliminado.
2024-08-21
- Recurso User — Los usuarios creados vía API ahora tienen una contraseña permanente (no una temporal que requiera reinicio).
- Recurso Document — Los valores de elemento de firma de administrador se gestionan correctamente para el índice de firmante 0.
2024-08-20
- Recurso Document — Los parámetros
convert_sender_to_signerystrict_fieldsahora aceptantrue/"true"/1(antes sólo booleanoTrue). - Recursos Signer/Element — El campo
signerahora puede ser nulo; los elementos conelement_type: "admin"tienen por defecto firmante0. - Roles — Los roles API ahora se sincronizan con la consola después de la creación del documento.
- Mensajes de error — Mejorada la notificación de error cuando el usuario no tiene vínculo con la organización.
2024-08-19
Recurso Group (Tab) — POST /api/v1/group/ — name es ahora el único campo requerido. xframe_allow es un parámetro opcional.
2024-07-16
Recurso Document — El parámetro cc ahora acepta el valor "default" para usar la lista predeterminada CC del grupo.
2024-06-14
Recurso Document — Se agregaron los campos pdf_password y pdf_password_type a la respuesta de detalle del documento.
2024-02-20
Recurso TemplatePDF — GET /api/v1/templatepdf/{id}/ (descarga de PDF) — se agregó el parámetro de consulta returnAsJson para devolver el PDF como respuesta JSON codificada en base64 en lugar de descargar un archivo.
2024-02-09
Recurso TemplatePDF — Corregido error tipográfico en la respuesta de returnAsJson: documet_uri → document_uri.
2024-01-26
Recurso TemplatePDF — POST /api/v1/templatepdf/ — se agregó el parámetro de consulta opcional returnAsJson. Cuando está configurado, el cuerpo de la respuesta incluye { resource: { uid, status_uri, document_uri } } en lugar de un 201 vacío.
2024-01-21
Recurso Document — Mejora de rendimiento: GET /api/v1/document/ mejorado (consulta de conteo más rápida).
2023
2023-09-27
Recurso Document — GET /api/v1/document/ — se agregaron dos nuevos parámetros de filtro de consulta:
created_gt— filtrar documentos creados después de una fecha y hora dada (ISO 8601)modified_gt— filtrar documentos modificados después de una fecha y hora dada (ISO 8601)
Las URLs de paginación next/previous ahora incluyen correctamente todos los parámetros de filtro activos.
2023-08-08
Recurso Document — GET /api/v1/document/ — se agregó el parámetro de filtro sentUserId.
2023-07-07
Recurso User — Los usuarios administradores ahora pueden crear subusuarios vía API.
2023-05-31
Recurso Document — Los testigos ya no se incluyen en la lista predeterminada de destinatarios de recordatorios.
2023-04-17
- Recurso Signer — Se agregó el campo
rejection_reasona la respuesta del firmante. - Nomenclatura — Correcciones de consistencia en el nombrado de campos a lo largo de la API.
2023-03-02
Webhooks — Se amplió la longitud máxima del campo callback_url de 200 a 500 caracteres.
2023-01-17
Recurso Document — Se agregaron los campos tag2 y tag3 (además de los existentes tag/tag1) al enviar y en la respuesta del documento.
2022
2022-11-14–15
Recurso Document — Se aumentó el número máximo de campos permitidos por documento.
2022-11-02–03
Webhooks — Se agregaron nuevos tipos de eventos webhook. Se actualizaron los ítems usercallback.
2022-09-09
Recurso Document — Se agregó el parámetro de solicitud message_template para especificar una plantilla de mensaje al enviar.
2022-05-12
Recurso Element/Field — Se agregó el campo no_pdf: opción para marcar un campo de modo que no se renderice en el PDF final.
2022-04-20
- Recurso Document — El campo
roleya no es obligatorio en el diccionario de firmante al enviar un documento usando un TemplatePDF. - Reportes de error — Mejora en los mensajes de respuesta de error en toda la API.
2022-04-06
Recurso Element/Field — Se agregó el tipo de validación regex (tipo de validación 93) para valores de campo.
2022-02-24
Recurso Element/Field — Se agregó el campo label_extra.
2022-02-22
Recurso TemplatePDF — Se agregó la opción force_download en la recuperación de borradores de PDF.
2022-02-17
Recurso Document — Se agregó soporte para reviewers al enviar un documento.
2022-02-15
Recurso Document — Se agregó soporte para el campo honorifics en POST de documento.
2021
2021-11-30
Recurso Document — Nuevo endpoint: GET /api/v1/document/{id}/auditlog/ — devuelve el registro de auditoría para un documento.
2021-10-31
Recurso Document — La respuesta de GET /api/v1/document/ ahora incluye el campo tag.
2021-10-30
Recurso Document — La respuesta de GET /api/v1/document/ ahora incluye el campo location.
2021-10-28
Recurso Document — Se añadió soporte para validación de campos al enviar documentos vía API.
2021-10-27
Recurso Document — Nuevo endpoint: GET /api/v1/document/{id}/fields/ — devuelve datos de campo de un documento.
2021-10-25
Recurso Document — Se añadió soporte para bundle. Se añadió el parámetro convert_sender_to_signer al enviar un documento.
2021-08-17
Recurso TemplatePDF — Se añadió el campo archive_upon_send a la lista de campos del recurso template PDF.