Saltar al contenido principal

Cambios en la API REST

Cambios en la API REST v1 (/api/v1/).


2026

2026-08-26

Recurso TemplatePDF — Nuevo endpoint: GET /api/v1/templatepdf/{pdfId}/preview/ — devuelve una vista previa PDF para la plantilla especificada.

2026-08-14

Recurso Element/FieldGET /api/v1/document/{id}/fields/ — se añadió el parámetro filtro de consulta element_type. Véase Obtener Campos del Documento.

2026-07-02

Recurso TemplatePDF — Nuevo endpoint: GET /api/v1/templatepdf/{id}/component-token/ — devuelve un token de componente para incrustar el componente visualizador de PDF.

2026-07-01

Recurso Signer — Nuevo endpoint: GET /api/v1/signer/{id}/component-token/ — devuelve un token de 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 para firmantes devueltos en la respuesta API ahora se conservan en formato legado para compatibilidad con versiones anteriores al usar firmas en lote/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 actualizar — ver developer.legalesign.com para detalles.

2026-01-21

Recurso TemplatePDFDELETE /api/v1/templatepdf/{id}/delete/ — eliminación actualizada para eliminación segura. Devuelve un error si falla (por ejemplo, la política de retención requiere aprobación secundaria).

2026-01-06–07

Recurso Document — Se añadió campo booleano append_history a la respuesta de envío y detalle del documento. Cuando es true, se añade la página de historial de firmas al PDF finalizado (refleja el comportamiento existente append_pdf).

Obsoleto: Los campos sign_mouse, sign_type, sign_upload en el recurso document están obsoletos y serán eliminados en una futura versión.


2025

2025-12-18–19

Recurso Document — Se añadió el parámetro skip para firmantes al enviar un documento. Establecer skip: true en una posición de firmante omite a ese destinatario en el 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 por API al flujo de firma.

2025-10-08

  • Recurso Document — La respuesta GET /api/v1/document/{id}/ ahora incluye un arreglo signer_objects junto al arreglo existente signers. Cada objeto contiene: firstname, lastname, email, tel, status, order, resource_uri, role, uuid.
  • Recurso Signer — Se añadió campo role a la respuesta de firmante ("signer", "approver" o "witness").

2025-09-26

  • Recurso DocumentDELETE /api/v1/document/{id}/ — se añadió parámetro opcional de consulta email=1 para enviar correos de notificación en la eliminación.
  • Recurso TemplatePDF — Se añadió parámetro hide_sender_fields en el endpoint de edición PDF.
  • Recurso Element/Field — Las búsquedas pdftext y signertext ahora aceptan UUID además del nombre de la etiqueta.
  • Recurso Signer — Se añadió campo uuid al objeto de respuesta del firmante.

2025-09-04

Recurso Document — Cuando no se proporciona mensaje en el envío, ahora se usa automáticamente la plantilla de mensaje predeterminada del grupo.

2025-08-22

Recurso Document — Al enviar un documento, el PDF fuente se copia desde la plantilla al registro del documento.

2025-06-10

Recurso TemplatePDF — Nuevo endpoint: POST /api/v1/templatepdf/{id}/archive/ — archiva una plantilla PDF.


2024

2024-10-17

Recurso Document — Se eliminó el parámetro obsoleto append_to en firmantes. Este parámetro no tenía efecto y ha sido eliminado.

2024-08-21

  • Recurso User — Usuarios creados por la API ahora reciben una contraseña permanente (no temporal para resetear).
  • Recurso Document — Valores de firmantes de elementos admin manejados correctamente para índice de firmante 0.

2024-08-20

  • Recurso Document — Los parámetros convert_sender_to_signer y strict_fields ahora aceptan true/"true"/1 (antes sólo booleano True).
  • Recurso Signer/Element — El campo signer ahora es nullable; elementos con element_type: "admin" asignados por defecto a firmante 0.
  • Roles — Los roles de API ahora se sincronizan con la consola después de crear un documento.
  • Mensajes de error — Mejoras al error cuando el usuario no tiene enlace a organización.

2024-08-19

Recurso Group (Tab)POST /api/v1/group/name es ahora el único campo obligatorio. xframe_allow es parámetro opcional.

2024-07-16

Recurso Document — El parámetro cc ahora acepta el valor "default" para usar la lista predeterminada de CC del grupo.

2024-06-14

Recurso Document — Se añadieron campos pdf_password y pdf_password_type a la respuesta de detalle del documento.

2024-02-20

Recurso TemplatePDFGET /api/v1/templatepdf/{id}/ (descarga PDF) — se añadió parámetro de consulta returnAsJson para devolver el PDF como respuesta JSON codificada en base64 en vez de descarga de archivo.

2024-02-09

Recurso TemplatePDF — Corrección de errata en respuesta de returnAsJson: documet_uridocument_uri.

2024-01-26

Recurso TemplatePDFPOST /api/v1/templatepdf/ — se añadió parámetro opcional de consulta returnAsJson. Si está establecido, el cuerpo de 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/ optimizado (consulta de conteo más rápida).


2023

2023-09-27

Recurso DocumentGET /api/v1/document/ — añadidos 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)

URLs de paginación next/previous ahora incluyen correctamente todos los parámetros de filtro activos.

2023-08-08

Recurso DocumentGET /api/v1/document/ — añadido parámetro de filtro sentUserId.

2023-07-07

Recurso User — Los usuarios admin 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 — Añadido campo rejection_reason a la respuesta del firmante.
  • Nomenclatura — Correcciones de consistencia en nombres de campos a lo largo de la API.

2023-03-02

Webhooks — Se extendió la longitud máxima del campo callback_url de 200 a 500 caracteres.

2023-01-17

Recurso Document — Se añadieron los campos tag2 y tag3 (además de los existentes tag/tag1) al envío y 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 añadieron nuevos tipos de evento webhook. Elementos usercallback actualizados.

2022-09-09

Recurso Document — Se añadió parámetro de solicitud message_template para especificar una plantilla de mensaje al enviar.

2022-05-12

Recurso Element/Field — Se añadió campo no_pdf: opción para marcar un campo para que no se renderice en el PDF final.

2022-04-20

  • Recurso Document — El campo role ya no es obligatorio en el dictado de firmante al enviar un documento usando un TemplatePDF.
  • Reporte de errores — Mejoras en mensajes de respuesta de error en la API.

2022-04-06

Recurso Element/Field — Se añadió tipo de validación regex (tipo 93) para valores de campo.

2022-02-24

Recurso Element/Field — Se añadió campo label_extra.

2022-02-22

Recurso TemplatePDF — Se añadió opción force_download en la recuperación de borradores PDF.

2022-02-17

Recurso Document — Se añadió soporte para reviewers al enviar un documento.

2022-02-15

Recurso Document — Se añadió soporte para el campo honorifics en POST de documentos.


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 un campo tag.

2021-10-30

Recurso Document — La respuesta de GET /api/v1/document/ ahora incluye un 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 campos para 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ó campo archive_upon_send a la lista de campos del recurso TemplatePDF.