Destinatarios
Un destinatario (recipient) representa a una persona involucrada en un envelope — quien firma, aprueba, o solo recibe una copia. La Guía de Integración muestra cómo crear destinatarios al crear el envelope; este recurso profundiza en el objeto y las operaciones sobre destinatarios ya creados.
| Rol | Comportamiento |
|---|---|
SIGNER |
Debe firmar. Sus campos requeridos deben completarse. |
APPROVER |
Debe aprobar antes de que los SIGNER con signingOrder mayor puedan firmar. |
VIEWER |
Puede ver el documento, no realiza ninguna acción. |
CC |
Recibe una copia del documento completado, no participa del proceso. |
ASSISTANT |
Puede completar campos en nombre de otro destinatario. |
Crear destinatarios
Sección titulada «Crear destinatarios»POST /envelope/recipient/create-manyCada destinatario acepta email, name, role, y opcionalmente signingOrder, accessAuth y actionAuth.
Ver la especificación completa en la Referencia de la API.
Orden de firma
Sección titulada «Orden de firma»Con firma secuencial, los destinatarios con signingOrder más bajo firman primero; los que comparten el mismo valor pueden firmar en simultáneo. Para habilitar firma secuencial, define signingOrder: "SEQUENTIAL" en el meta del envelope — ver Crear el envelope.
Autenticación de destinatarios
Sección titulada «Autenticación de destinatarios»Para reforzar la seguridad de un destinatario en particular, más allá de la autenticación general de la API:
accessAuth (para ver el documento) |
Descripción |
|---|---|
ACCOUNT |
El destinatario debe tener sesión iniciada. |
TWO_FACTOR_AUTH |
El destinatario debe verificar con 2FA. |
actionAuth (para firmar) |
Descripción |
|---|---|
ACCOUNT |
El destinatario debe tener sesión iniciada. |
PASSKEY |
Requiere autenticación con passkey. |
TWO_FACTOR_AUTH |
Requiere código 2FA. |
PASSWORD |
Requiere verificación con contraseña. |
EXPLICIT_NONE |
Desactiva explícitamente la autenticación de acción. |
Actualizar destinatarios
Sección titulada «Actualizar destinatarios»POST /envelope/recipient/update-manySolo disponible mientras el envelope no está COMPLETED. Acepta los mismos campos que la creación, todos opcionales salvo el id del destinatario a modificar.
Ver la especificación completa en la Referencia de la API.
Eliminar un destinatario
Sección titulada «Eliminar un destinatario»POST /envelope/recipient/deleteVer la especificación completa en la Referencia de la API.
Rechazar en nombre de un destinatario
Sección titulada «Rechazar en nombre de un destinatario»POST /envelope/recipient/{recipientId}/rejectMarca a un destinatario como REJECTED sin pasar por el flujo normal de firma — por ejemplo, si te informan el rechazo por un canal fuera de Legaldoc y necesitas reflejarlo en el envelope.
Ver la especificación completa en la Referencia de la API.
Consultar un destinatario
Sección titulada «Consultar un destinatario»GET /envelope/recipient/{recipientId}Devuelve el objeto completo, incluyendo signingStatus (NOT_SIGNED, SIGNED, REJECTED), readStatus (NOT_OPENED, OPENED) y sendStatus (NOT_SENT, SENT).
Ver la especificación completa en la Referencia de la API.
Ver también
Sección titulada «Ver también»- Campos — asignar campos a cada destinatario
- Guía de Integración — flujo completo de creación y firma
- Firma Electrónica Avanzada — RUT, orden secuencial y validación de identidad