Crear Documento

Obtener documento

Permite obtener el detalle de un documento existente mediante su token. Puede opcionalmente expandir la información de firmantes, seguimiento y otros atributos vinculados.

Endpoint

GET

https://app.firmeasy.legal/api/v1/documents/{token}

Headers

Nombre	Tipo	Descripción	Límites
Authorization *	string	Token de acceso obtenido en el login, con el prefijo 'Bearer'.	Obligatorio
Content-Type	string	Especifica el tipo de contenido del cuerpo de la solicitud HTTP. Para las peticiones que incluyen datos JSON	'application/json'

Parametros disponibles

Permite incluir bloques adicionales de información junto al documento base:

Nombre	Tipo	Descripción	Límites
include[]=signers	array	Incluye el detalle completo de los firmantes.	Opcional
include[]=tracking	array	Incluye el historial de seguimiento del documento.	Opcional
include[]=user	object	Incluye el detalle del usuario creador (uso avanzado).	Opcional

Respuesta exitosa

{
  "external_id": null,
  "token": "f3d2c489-6c81-4b6e-96e5-0b92145f8e2b",
  "name": "Informe Técnico 2025_04_000912.pdf",
  "folder": null,
  "status": "pending",
  "lang": "es",
  "size": "104752",
  "original_file": "https://docs.corporativoglobal.com/files/f3d2c489-6c81-4b6e-96e5-0b92145f8e2b",
  "signed_file": null,
  "signatures_made": 0,
  "signature_deadline": null,
  "created_through": "api",
  "reminder_every_n_days": 0,
  "send_automatic_invitations": false,
  "send_signed_document_by_whatsapp": false,
  "is_rejection_allowed": false,
  "is_signature_order_active": false,
  "redirect_link": null,
  "observers": null,
  "metadata": null,
  "created_at": "2024-11-20T09:35:14.000000Z",
  "updated_at": "2024-11-20T09:35:14.000000Z"
}

Campos devueltos (respuesta)

Nombre	Tipo	Descripción
external_id	string	ID externo asignado por el cliente.
token	string	Token único interno del documento.
name	string	Nombre del documento.
folder	object	Carpeta asociada (si corresponde).
status	string	Estado actual del documento.
lang	string	Idioma configurado para el documento.
size	integer	Tamaño del archivo en bytes.
original_file	string	Enlace al archivo original.
signed_file	string	Enlace al archivo firmado (si disponible).
signatures_made	integer	Cantidad de firmas realizadas.
signature_deadline	datetime	Fecha límite de firma (UTC ISO 8601).
created_through	string	Origen de creación (ej: 'api').
reminder_every_n_days	integer	Frecuencia de recordatorios automáticos.
send_automatic_invitations	boolean	Indica si se envían invitaciones automáticas.
send_signed_document_by_whatsapp	boolean	Indica si se envía el documento firmado por WhatsApp.
is_rejection_allowed	boolean	Indica si los firmantes pueden rechazar la firma.
is_signature_order_active	boolean	Indica si el orden de firma está habilitado.
redirect_link	string	URL de redirección post-firma (si configurado).
observers	array	Lista de observadores configurados.
metadata	object	Datos adicionales enviados por el cliente.
created_at	datetime	Fecha de creación del documento.
updated_at	datetime	Fecha de última actualización.

Errores posibles

Código	Descripción
401	No autorizado (token inválido o ausente).
404	Documento no encontrado.
500	Error interno inesperado.