Ciclo de vida
Esta página describe los estados por los que pasan los documentos y las firmas en Signatura, las transiciones posibles entre ellos y los eventos webhook que se generan en cada caso.
Estados de un documento
| Código | Estado | Descripción |
|---|---|---|
PE | Pendiente | El documento está esperando que todos los firmantes completen sus firmas. |
CO | Completado | Todos los firmantes han firmado el documento. |
CA | Cancelado | El documento fue cancelado antes de completarse. |
EX | Vencido | El documento alcanzó su fecha límite de firma sin que todos los firmantes completaran sus firmas. |
Transiciones
- PE → CO: Ocurre automáticamente cuando todas las firmas del documento alcanzan el estado Completado (
CO). - PE → CA: Ocurre cuando se cancela el documento a través de la API o del panel de administración. La cancelación es irreversible y cancela todas las firmas pendientes.
- PE → EX: Ocurre cuando el documento alcanza su fecha límite de firma, definida por los días de vigencia configurados en el espacio de trabajo. El vencimiento se procesa periódicamente, por lo que el cambio de estado puede registrarse hasta una hora después de la fecha límite. Las firmas pendientes conservan su estado, pero el enlace de firma deja de estar disponible.
Estados de una firma
| Código | Estado | Descripción |
|---|---|---|
IN | Inicial | La firma fue creada pero el firmante aún no ha abierto la invitación. |
PE | Leído | El firmante abrió la invitación pero aún no ha firmado. |
CO | Completado | El firmante completó la firma exitosamente. |
CA | Cancelado | La firma fue cancelada (por cancelación del documento o invalidación). |
DE | Rechazado | El firmante rechazó firmar el documento. |
Transiciones
- IN → PE: Ocurre cuando el firmante abre el enlace de firma por primera vez.
- PE → CO: Ocurre cuando el firmante completa todas las validaciones requeridas y firma el documento.
- PE → DE: Ocurre cuando el firmante rechaza explícitamente la firma del documento.
- IN/PE → CA: Ocurre cuando se cancela el documento o se invalida la firma.
Eventos webhook
Signatura envía notificaciones webhook cuando ocurren cambios en los documentos y las firmas. A continuación se describen los eventos y las transiciones que los generan.
| Evento | Descripción | Transición asociada |
|---|---|---|
DS | Firma completada | Firma: PE → CO |
SD | Firma rechazada | Firma: PE → DE |
DC | Cambio de estado del documento | Documento: PE → CO, PE → CA o PE → EX |
Ejemplo de payload
Cuando un firmante completa su firma, se envía un evento DS:
{
"notification_action": "DS",
"document_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"signature_id": "f5407940-6d19-4508-baed-195c03fcf739"
}
Cuando el documento cambia de estado (por ejemplo, se completa, se cancela o vence), se envía un evento DC con el nuevo estado en new_status:
{
"notification_action": "DC",
"document_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"new_status": "CO"
}
Para más información sobre cómo configurar y validar webhooks, consulte la documentación de webhooks.