Compartir a través de

Legalign (versión preliminar)

Diseñado para equipos de operaciones y legales centrados en el cumplimiento, el conector de Legalign vincula la plataforma de energía de Microsoft con legalign eSignature para desencadenar flujos de trabajo de documentos y destinatarios, enviar recordatorios, capturar archivos PDF y datos de formulario expuestas. Requiere una suscripción legalign activa aprobada para el uso de la API.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Compatibilidad con API
URL https://legalesign.com/contact/
Correo Electrónico sales@legalesign.com
Metadatos del conector
Publicador Legalign
Más información sobre Legalign https://docs.microsoft.com/connectors/legalesign
Sitio web https://legalesign.com
Política de privacidad https://legalesign.com/opn/privacy/
Categorías Contenido y archivos; Productividad

Conector REST legalign eSignature

La API REST legalign potencia los flujos de trabajo de eSignature. Este conector proporciona acceso completo a la API y desencadenadores en tiempo real, lo que permite una integración perfecta con Microsoft Power Automate, Logic Apps y plataformas relacionadas.

Prerrequisitos

Para empezar, necesita una cuenta legalign y una clave de API: 1. Regístrese para obtener una evaluación gratuita. 2. Cree un grupo (un entorno individual, por ejemplo, uno para desarrollo y otro para producción). 3. Solicite una clave de API mediante la creación de una incidencia de soporte técnico. Incluya el caso de uso, la empresa y el rol para que el soporte técnico pueda comprobar su identidad. 4. Una vez comprobado, inicie sesión en el panel de API para recuperar la clave.

Despliegue

Las nuevas cuentas comienzan en modo de espacio aislado con las siguientes limitaciones: • Los documentos solo se pueden enviar para probar las direcciones de correo electrónico que configure en el Panel de API. • Las solicitudes se limitan a 100 minutos.

Cuando esté listo para empezar a trabajar, cree una incidencia de soporte técnico para cambiar la cuenta de espacio aislado a producción. En ese momento, se levantarán las restricciones. Consulte la guía de implementación para obtener más información.

Desencadenadores

El conector admite dos desencadenadores en tiempo real:

  • Eventos de documento (por ejemplo, creados, rechazados, firmados, pdf finales creados)
  • Eventos de destinatario (por ejemplo, completados, rechazados, abiertos por correo electrónico, devueltos, recordatorios enviados)

Puede recibir todos los documentos o destinatarios, de filtro por grupo o tipo de evento. Todos los webhooks legalesign asociados se pueden administrar y supervisar en el panel de API.

Operations

Se admiten las operaciones de LA API REST legalign. Entre los más comunes se incluyen descargar un PDF firmado, administrar plantillas, documentos, destinatarios y colocación de campos. Consulte la documentación completa de la API para obtener la especificación completa.

En Legalign, un documento cargado se denomina "plantilla". Cuando se envía una plantilla a uno o varios destinatarios, se convierte en un "documento". Normalmente, cargará una plantilla, recuperará su identificador y la enviará a uno o varios destinatarios.

Entre las operaciones comunes se incluyen:

Plantillas

  • Create PDF template - cargar una plantilla (cualquier tipo de archivo, como PDF, Word o imagen).
  • Get PDF embeddable link : un vínculo de un solo uso para mostrar el editor de plantillas a un usuario.

Documentos

  • Location to download PDF : devuelve el archivo binario PDF de un documento firmado.
  • Create signing document : enviar un documento (seleccionar una plantilla y destinatarios)
  • Void/archive signing document - detener la firma de un documento
  • Permanently delete signing document : quitar un documento para siempre

Destinatarios (firmantes)

  • Send signer reminder email : recuerde al destinatario que complete el documento.
  • Get signer rejection reason : si se rechaza el documento, vea por qué

Selección de ubicación de campo

Legalign tiene un sistema de formulario avanzado con campos. Si tiene firmantes, cada firmante debe tener al menos un campo de firma.

Hay cuatro maneras de definir campos en la plantilla:

  1. Cargue un PDF con campos incrustados (convertido automáticamente por Legalign).
  2. Use etiquetas de texto legalign.
  3. Defina coordenadas x/y.
  4. Use el editor de formularios Legalign (mediante el vínculo para insertar o la aplicación web).

Haga clic aquí para la guía.

Consultas y soporte técnico

Para obtener soporte técnico o consultas adicionales, inicie sesión en su cuenta legalign y cree una incidencia de soporte técnico.

Crear una conexión

El conector admite los siguientes tipos de autenticación:
Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
clave_api securestring La api_key de esta API Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Carga de una plantilla pdf

Cargue un documento PDF que desea enviar para que se firme.
Cargar datos adjuntos de PDF

Guarde un pdf para adjuntarlo a un correo electrónico de destinatario.
Descargar el registro de auditoría del documento

PDF de solo el registro de auditoría de documentos.
Descargar PDF

Obtenga el borrador o el PDF final de un documento de firma, en función de su estado. Tenga en cuenta que es posible una respuesta 200 o 302.
Documento void y archivado

Establece un documento con el estado 40 -quitado- y lo archiva.
Eliminar datos adjuntos

Eliminar datos adjuntos.
Eliminar permanentemente el documento

Elimina permanentemente los datos y los archivos.
Enviar correo electrónico de recordatorio de destinatario

Envíe un correo electrónico de recordatorio a un destinatario.
Enviar documento

Envíe un documento para su firma o aprobación.
Miembro de un grupo

Detalles de un usuario específico dentro de un grupo.
Miembros de grupos

Listados de todos los miembros de los grupos.
Obtener campos de documento

Campos del documento.
Obtener campos de formulario de destinatario

Devuelve los campos de formulario de un destinatario específico.
Obtener datos adjuntos

Obtener datos adjuntos.
Obtener datos adjuntos

Enumerar datos adjuntos.
Obtener destinatario

Obtiene el estado y los detalles de un destinatario individual.
Obtener documento

Devuelve un documento específico.
Obtener documentos

Enumerar documentos de firma sin archivar.
Obtener el motivo del rechazo del destinatario

Devuelve el firmante de motivo dado para rechazar un documento.
Obtener grupos

Enumera los grupos a los que pertenece el usuario de api.
Obtener plantilla pdf

Detalles de una plantilla PDF específica
Obtener plantillas PDF

Enumerar plantillas pdf
Obtener usuario

Obtenga los detalles del usuario.
Obtener vínculo de destinatario

Vínculo de un solo uso para que el destinatario vaya a páginas de firma.
Obtener vínculo insertable en PDF

Devuelve un vínculo de uso único para insertar el editor de PDF.

Carga de una plantilla pdf

Id. de la operación:
PostPdfTemplate

Cargue un documento PDF que desea enviar para que se firme.

Parámetros

Nombre Clave Requerido Tipo Description
Archivar tras enviar
 archive_upon_send boolean

Establezca true si esta carga solo será para un solo uso.
Grupo
 group True string

Especifique el grupo donde se usará.
Archivo PDF
 pdf_file True byte

Datos de archivo PDF codificados en Base64.
Etiquetas de proceso
 process_tags boolean

Si el archivo contiene etiquetas de texto, conviértalas en campos.
Title
 title string

Asigne un nombre a este registro y usará el nombre de archivo si no se usa.
Usuario
 user string

Asigne al miembro del grupo si no al usuario de api.

Cargar datos adjuntos de PDF

Id. de la operación:
PostAttachment

Guarde un pdf para adjuntarlo a un correo electrónico de destinatario.

Parámetros

Nombre Clave Requerido Tipo Description
group
 group True string

URI de recursos de grupo
pdf_file
 pdf_file True byte

Datos de archivo PDF codificados en Base64, el tamaño máximo es una configuración de grupo, 5 MB de forma predeterminada.
filename
 filename True string

Nombre alfanumérico simple que termina .pdf
user
 user string

Asigne a otro usuario.
descripción
 description string

Descargar el registro de auditoría del documento

Id. de la operación:
GetDocumentAuditLog

PDF de solo el registro de auditoría de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 docId True uuid

Id. de documento

Devoluciones

response
file

Descargar PDF

Id. de la operación:
GetDocumentPdf

Obtenga el borrador o el PDF final de un documento de firma, en función de su estado. Tenga en cuenta que es posible una respuesta 200 o 302.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 docId True uuid

Id. de documento

Devoluciones

response
file

Documento void y archivado

Id. de la operación:
UpdateArchiveDocument

Establece un documento con el estado 40 -quitado- y lo archiva.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 docId True uuid

Id. de documento
Enviar un correo electrónico de notificación al destinatario
 email string

Si se establece en true o 1 se notifica a los destinatarios, se anula el documento.

Eliminar datos adjuntos

Id. de la operación:
DeleteAttachment

Eliminar datos adjuntos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de datos adjuntos
 attachId True uuid

Asociar id.

Eliminar permanentemente el documento

Id. de la operación:
DeleteDocument

Elimina permanentemente los datos y los archivos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 docId True uuid

Id. de documento

Enviar correo electrónico de recordatorio de destinatario

Id. de la operación:
PostSignerReminder

Envíe un correo electrónico de recordatorio a un destinatario.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipientId True uuid

Id. de destinatario
texto
 text string

Texto del mensaje personalizado

Enviar documento

Id. de la operación:
PostDocument

Envíe un documento para su firma o aprobación.

Parámetros

Nombre Clave Requerido Tipo Description
Grupo
 group True string

URI de recursos de grupo
Nombre
 name True string

Especificar el nombre del documento
Plantilla de PDF
 templatepdf True string

Pdf cargado que se va a enviar.
Correo electrónico
 email True email

Correo Electrónico
nombre de pila
 firstname True string

Nombre
apellido
 lastname True string

Apellido
datos adjuntos
 attachments array of string

Lista de uris de recursos adjuntos.
expires
 expires date-time

ISO8601 datetime formado, establezca en TZ de remitente o zona horaria si se usa.
Mensaje
 message string

Su mensaje personal para la fiesta, introducido en el centro de la plantilla de correo electrónico del grupo. Use el nombre de una plantilla de correo electrónico guardada precedida por un símbolo hash para usar esa plantilla. Si hay más de una plantilla con el mismo nombre, seleccionará la última modificación.
nombre de pila
 firstname string

Nombre
apellido
 lastname string

Apellido
Correo electrónico
 email True email

Correo Electrónico
include_link
 include_link boolean

Incluir un vínculo a las páginas de firma que permiten a un revisor firmar
mensaje de texto
 sms string

Use el número de formato internacional para agregar la comprobación de SMS. Requerido si un testigo o un firmante testigo.
Asunto
 subject string

Línea de asunto del correo electrónico saliente
timezone
 timezone string

TZ del firmante debe ser TZ válido según la zona horaria (consulte User for timezoneenum details). Si blank usa tz del remitente.
Tipo de firma
 signature_type integer

Use 4 para obtener la certificación PDF ejecutada. Recomendado. El valor predeterminado es 1 (usa un hash sha256 para la integridad del documento).
Anexar PDF
 append_pdf boolean

Anexar información de validación legalign a PDF final.
auto_archive
 auto_archive boolean

Envíe al archivo poco después de la firma. Mantiene libre la desorden de la aplicación web
Uso de correos electrónicos legalesign
 do_email boolean

Use legalign email para enviar correos electrónicos de notificación. Si false suprime todos los correos electrónicos.
CC tras la finalización
 cc_emails string

Cadena delimitada por comas de direcciones de correo electrónico notificadas de firma o rechazo.
Convertir campos de remitente vacíos en los primeros campos de destinatario
 convert_sender_to_signer boolean

Si se deja en blanco algún campo remitente, conviértelos en campos para el primer destinatario.
Contraseña de PDF
 pdf_password string

Establezca una contraseña. Debe ser capaz de codificar ascii, también debe establecer signature_type en 4 y elegir un pdf_password_type.
Configuración de contraseña de PDF
 pdf_password_type integer

1 para almacenar la contraseña, 2 para eliminar de nuestros registros tras la firma final.
pdftext
 pdftext object

Asigne valores a los campos remitentes de PDF, use la etiqueta de campo de la plantilla o su uuid como claves de objeto. Consulte templatepdf/:id/fields/ y filtre por element_type="admin", para obtener los campos pertinentes con su etiqueta o uuid. Consulte también strict_fields.
URL de redireccionamiento
 redirect string

Dirección URL para enviar el firmante a después de la firma (en lugar de la página de descarga). La dirección URL incluirá parámetros de consulta con información de identificador y estado como sigue: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Programación de recordatorios
 reminders string

Coloque "default" si desea usar la programación de recordatorio predeterminada en el grupo (vaya a la aplicación web para establecer la programación predeterminada).
Devolver vínculos del firmante
 return_signer_links boolean

Devuelve vínculos de documento para los firmantes en la respuesta BODY.
secuenciación de envío
 signers_in_order boolean

Notificar a los firmantes en su secuencia de orden. Si se notifican todos los false simulatanemente.
signertext
 signertext object

Agregue marcadores de posición personalizados a los campos de firmante. Use etiquetas de campo o uuid como claves en el objeto (como para pdftext). Consulte templatepdf/:id/fields/ y filtre por element_type = "text" para obtener los campos pertinentes con sus etiquetas o uuid.
Aplicación de la validación de campos
 strict_fields boolean

Pdftext produce un error en las comprobaciones de validación de forma silenciosa y establece true para validar.
Su referencia
 tag string

Etiqueta
Su referencia
 tag1 string

Etiqueta
Su referencia
 tag2 string

Etiqueta
user
 user string

Asigne otro documento al usuario del grupo.

Miembro de un grupo

Id. de la operación:
GetMember

Detalles de un usuario específico dentro de un grupo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de miembro
 memberId True uuid

Id. de miembro

Devoluciones

Body
MemberResponse

Miembros de grupos

Id. de la operación:
GetMembers

Listados de todos los miembros de los grupos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo
 group string

Filtrar por un grupo específico
Límite de consultas
 limit integer

Use con desplazamiento para recorrer en iteración los resultados.
Desplazamiento de consulta
 offset integer

Use con límite para recorrer en iteración los resultados.

Devoluciones

Body
MemberListResponse

Obtener campos de documento

Id. de la operación:
GetDocumentFields

Campos del documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 docId True uuid

Id. de documento

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object

Lista de campos de documento
element_type
 element_type string

Tipo de elemento
fieldorder
 fieldorder integer

Orden de campo
label
 label string

Etiqueta
label_extra
 label_extra string

Etiqueta adicional
firmante
 signer integer

Destinatario
estado
 state boolean
validación
 validation integer

Identificador de validación
value
 value string

Importancia

Obtener campos de formulario de destinatario

Id. de la operación:
GetSignerFields

Devuelve los campos de formulario de un destinatario específico.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipientId True uuid

Id. de destinatario

Devoluciones

Nombre Ruta de acceso Tipo Description
array of object
label
 label string

Etiqueta
label_extra
 label_extra string

Etiqueta adicional
estado
 state boolean

Estado
fieldorder
 fieldorder integer

Orden de campo
value
 value string

Si el campo es un archivo de firmante, este valor será una dirección URL de descarga de corta duración.

Obtener datos adjuntos

Id. de la operación:
GetAttachment

Obtener datos adjuntos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de datos adjuntos
 attachId True uuid

Id. de datos adjuntos

Devoluciones

Adjuntar elemento.

Body
AttachmentResponse

Obtener datos adjuntos

Id. de la operación:
GetAttachments

Enumerar datos adjuntos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo
 group string

Filtre por un grupo específico.
Límite de consultas
 limit integer

Use con desplazamiento para recorrer en iteración los resultados.
Desplazamiento de consulta
 offset integer

Use con límite para recorrer en iteración los resultados.

Devoluciones

Lista de datos adjuntos

Body
AttachmentListResponse

Obtener destinatario

Id. de la operación:
GetRecipient

Obtiene el estado y los detalles de un destinatario individual.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipientId True uuid

Id. de destinatario

Devoluciones

Detalles del destinatario

Body
SignerResponse

Obtener documento

Id. de la operación:
GetDocument

Devuelve un documento específico.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 docId True uuid

Id. de documento

Devoluciones

Detalles del documento

Body
DocumentResponseDetail

Obtener documentos

Id. de la operación:
GetDocuments

Enumerar documentos de firma sin archivar.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo
 group True string

Filtre por un grupo específico, necesario.
Incluir documentos archivados
 archived string

Filtrar por el estado archivado, el valor predeterminado no está archivado, use el valor todo en este parámetro para consultar todos los documentos.
Filtrar por correo electrónico de destinatario
 email string

Filtre por correo electrónico del destinatario.
Límite de consultas
 limit integer

Longitud del conjunto de datos que se va a devolver. Use con la consulta de desplazamiento para recorrer en iteración los resultados.
Desplazamiento de consulta
 offset integer

Desplazamiento desde el inicio del conjunto de datos. Use con la consulta de límite para recorrer en iteración el conjunto de datos.
Filtrar por estado del documento
 status integer

Filtre por el estado del documento.
Quitar destinatarios de la respuesta
 nosigners string

Agregue el valor 1 para quitar la información de los destinatarios para una consulta más rápida.
Filtrar por creado después de esta fecha
 created_gt date-time

Filtre por esos documentos creados después de un tiempo determinado.
Filtrar por modificado después de esta fecha
 modified_gt date-time

Filtre los documentos modificados después de un tiempo determinado.

Devoluciones

Listados de documentos

Body
DocumentListResponse

Obtener el motivo del rechazo del destinatario

Id. de la operación:
GetSignerRejection

Devuelve el firmante de motivo dado para rechazar un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipientId True uuid

Id. de destinatario

Devoluciones

Nombre Ruta de acceso Tipo Description
estado
 status integer

Estatuas de destinatarios.
reason
 reason string

Motivo de rechazo.

Obtener grupos

Id. de la operación:
GetGroups

Enumera los grupos a los que pertenece el usuario de api.

Parámetros

Nombre Clave Requerido Tipo Description
Desplazamiento de consulta
 offset integer

Desplazamiento desde el inicio del conjunto de datos. Use con la consulta de límite para recorrer en iteración el conjunto de datos.
Límite de consultas
 limit integer

Longitud del conjunto de datos que se va a devolver. Use con la consulta de desplazamiento para recorrer en iteración los resultados.

Devoluciones

Lista de grupos

Body
GroupListResponse

Obtener plantilla pdf

Id. de la operación:
GetPdfTemplate

Detalles de una plantilla PDF específica

Parámetros

Nombre Clave Requerido Tipo Description
Id. de PDF cargado
 pdfId True uuid

Id. de PDF cargado

Devoluciones

Detalles de la plantilla

Body
TemplatePdfResponse

Obtener plantillas PDF

Id. de la operación:
GetPdfTemplates

Enumerar plantillas pdf

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo
 group string

Puede ser completo resource_uri o solo id.
Límite de consultas
 limit integer

Longitud del conjunto de datos que se va a devolver. Use con la consulta de desplazamiento para recorrer en iteración los resultados.
Desplazamiento de consulta
 offset integer

Desplazamiento desde el inicio del conjunto de datos. Use con la consulta de límite para recorrer en iteración el conjunto de datos.

Devoluciones

Listados de plantillas

Body
TemplatePdfListResponse

Obtener usuario

Id. de la operación:
GetUser

Obtenga los detalles del usuario.

Parámetros

Nombre Clave Requerido Tipo Description
ID de usuario
 userId True uuid

ID de usuario

Devoluciones

Detalles del usuario.

Body
UserDetailResponse

Obtener vínculo de destinatario

Id. de la operación:
GetSignerLink

Vínculo de un solo uso para que el destinatario vaya a páginas de firma.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipientId True uuid

Id. de destinatario

Obtener vínculo insertable en PDF

Id. de la operación:
GetPdfTemplateEditLink

Devuelve un vínculo de uso único para insertar el editor de PDF.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de PDF
 pdfId True string

Establezca el id. de PDF cargado.
Ocultar la lista de campos de la página representada
 hide_sender_fields boolean

Ocultar la lista de campos de la página representada.
Código hexadecimal que excluye el símbolo hash para el color de fondo
 css_body_backgroundcolor string

Use código hexadecimal excepto el símbolo hash para cambiar el color de fondo.

Desencadenadores

Evento document

Se produce un desencadenador para un evento de documento
Evento Recipient

Desencadenador para cuando se produce un evento de destinatario

Evento document

Id. de la operación:
DocumentTrigger

Se produce un desencadenador para un evento de documento

Parámetros

Nombre Clave Requerido Tipo Description
eventFilter
 eventFilter True string

Filtro de eventos
group
 group string

Filtro de grupo

Devoluciones

Nombre Ruta de acceso Tipo Description
version
 version string

Versión
objeto
 object string

Objeto
tag1
 data.tag1 string

Etiqueta
recipients
 data.recipients array of object

Recipientes
Identificador Único Universal (UUID)
 data.recipients.uuid string

Id. de destinatario
Correo electrónico
 data.recipients.email string

Correo electrónico del destinatario
order
 data.recipients.order integer

Número de pedido del destinatario
estado
 data.recipients.status integer

Estado del destinatario
apellido
 data.recipients.lastname string

Apellido del destinatario
roleText
 data.recipients.roleText string

Texto del rol destinatario
nombre de pila
 data.recipients.firstname string

Nombre del destinatario
statusText
 data.recipients.statusText string

Recipient statusText
resourceUri
 data.recipients.resourceUri string

URI de recurso de destinatario
rejectReason
 data.recipients.rejectReason string

rejectReason
groupResourceUri
 data.groupResourceUri string

URI de recursos de grupo
statusText
 data.statusText string

Texto de estado del documento
nombre
 data.name string

Nombre del documento
tag
 data.tag string

Etiqueta
resourceUri
 data.resourceUri string

URI de recursos
Identificador Único Universal (UUID)
 data.uuid string

Id. de documento
tag2
 data.tag2 string

Tag2
group
 data.group string

Grupo
estado
 data.status integer

Estado documento
creado
 created integer

Creado
id
 id string

Sí
evento
 event string

Event

Evento Recipient

Id. de la operación:
RecipientTrigger

Desencadenador para cuando se produce un evento de destinatario

Parámetros

Nombre Clave Requerido Tipo Description
eventFilter
 eventFilter True string

Filtro de eventos
group
 group string

Filtro de grupo

Devoluciones

Nombre Ruta de acceso Tipo Description
version
 version string

Versión
objeto
 object string

Objeto
tag
 data.tag string

Etiqueta
tag1
 data.tag1 string

Tag1
tag2
 data.tag2 string

Tag2
Identificador Único Universal (UUID)
 data.uuid string

Id. de destinatario
Correo electrónico
 data.email string

Correo Electrónico
group
 data.group string

Grupo
order
 data.order integer

Pedido
estado
 data.status integer

Estado
documento
 data.document string

Documento
apellido
 data.lastname string

Apellido
roleText
 data.roleText string

Texto del rol
nombre de pila
 data.firstname string

Nombre
statusText
 data.statusText string

Texto de estado
emailBounce
 data.emailBounce integer

El correo electrónico rebotó
resourceUri
 data.resourceUri string

URI de recurso de destinatario
Nombre del documento
 data.documentName string

Nombre del documento
rejectReason
 data.rejectReason string

Motivo de rechazo
groupResourceUri
 data.groupResourceUri string

URI de recursos de grupo
emailBounceMessage
 data.emailBounceMessage string

Mensaje de devolución de correo electrónico
documentResourceUri
 data.documentResourceUri string

URI del recurso de documento
creado
 created integer

Creado
id
 id string

identificación
evento
 event string

Event

Definiciones

PermissionsEnum

Opciones de permiso

Opciones de permiso

integer

ListMeta

Meta información sobre la lista.

Nombre Ruta de acceso Tipo Description
limit
 limit integer

Número máximo de objetos.
próximo
 next string

Dirección URL del siguiente conjunto de objetos.
offset
 offset integer

Número de elementos desde el principio del conjunto de resultados.
anterior
 previous string

Dirección URL del conjunto anterior de objetos.
total_count
 total_count integer

Número total de objetos.

GroupListResponse

Lista de grupos

Nombre Ruta de acceso Tipo Description
meta
 meta ListMeta

Meta información sobre la lista.
objetos
 objects array of object
creado
 objects.created date-time

Creado
is_active
 objects.is_active boolean

Active
modificado
 objects.modified date-time

Modificada
nombre
 objects.name string

Nombre
public_name
 objects.public_name string

Nombre público
resource_uri
 objects.resource_uri string

URI de recursos
trago
 objects.slug string

Nombre único
user
 objects.user string

URI del recurso creator
xframe_allow
 objects.xframe_allow boolean

Permitir la firma de inserción
xframe_allow_pdf_edit
 objects.xframe_allow_pdf_edit boolean

Permitir edición de inserción

TemplatePdfListResponse

Listados de plantillas

Nombre Ruta de acceso Tipo Description
meta
 meta ListMeta

Meta información sobre la lista.
objetos
 objects array of TemplatePdfResponse

TemplatePdfResponse

Detalles de la plantilla

Nombre Ruta de acceso Tipo Description
creado
 created date-time

Creado
group
 group string

URI de grupo
modificado
 modified date-time

Modificada
Partes
 parties string

Matriz con cadenas JSON de partes del documento.
page_count
 page_count integer

Recuento de páginas
resource_uri
 resource_uri string

URI de recursos
signer_count
 signer_count integer

Recuento de firmantes
title
 title string

Title
user
 user string

URI de recurso del creador
Identificador Único Universal (UUID)
 uuid uuid

Id. de PDF
válido
 valid boolean

Se puede enviar (si los campos no se validan).

DocumentListResponse

Listados de documentos

Nombre Ruta de acceso Tipo Description
meta
 meta ListMeta

Meta información sobre la lista.
objetos
 objects array of object

Documentos
Archivados
 objects.archived boolean

Archivado
auto_archive
 objects.auto_archive boolean

Archivar después de enviar.
cc_emails
 objects.cc_emails string

Mensajes de correo electrónico de lista delimitados por comas a cc tras la finalización.
creado
 objects.created date-time

Creado
do_email
 objects.do_email boolean

Use correos electrónicos legalesign.
download_final
 objects.download_final boolean

Está listo para descargarse después de la finalización.
group
 objects.group string

URI de recurso de grupo.
modificado
 objects.modified date-time

Modificada
nombre
 objects.name string

Nombre del documento
pdftext
 objects.pdftext string

Valores de campo remitente
redirigir
 objects.redirect string

Dirección URL para redirigir al destinatario después de la firma
resource_uri
 objects.resource_uri string

URI de recursos
return_signer_links
 objects.return_signer_links boolean

Agregar vínculos de destinatario a la respuesta
Firmantes
 objects.signers array of array

Matrices anidadas con detalles del firmante
items
 objects.signers array of

Siempre contiene [uri del firmante, nombre, apellidos, correo electrónico, número de sms, has_fields, estado, orden del firmante (0-indexado)]
signers_in_order
 objects.signers_in_order integer

Destinatarios de correo electrónico simulados o secuenciales
estado
 objects.status DocumentStatusEnum

Opciones de estado del documento:

  • 10 - Estado inicial, comprobación del estado del firmante para enviar o anular la sangría
  • 20 - Campos completados
  • 30 - Firmado
  • 40 - Quitado (antes de firmar)
  • 50 - Rechazado
tag
 objects.tag string

Documento de etiqueta
tag1
 objects.tag1 string

Documento de etiqueta
tag2
 objects.tag2 string

Documento de etiqueta
template
 objects.template string

URI de recurso de plantilla si se usa
templatepdf
 objects.templatepdf string

URI del recurso de plantilla de PDF
texto
 objects.text string

Texto para firmar
user
 objects.user string

URI del creador
Identificador Único Universal (UUID)
 objects.uuid uuid

Id. de documento

DocumentStatusEnum

Opciones de estado del documento:

  • 10 - Estado inicial, comprobación del estado del firmante para enviar o anular la sangría
  • 20 - Campos completados
  • 30 - Firmado
  • 40 - Quitado (antes de firmar)
  • 50 - Rechazado

Opciones de estado del documento:

  • 10 - Estado inicial, comprobación del estado del firmante para enviar o anular la sangría
  • 20 - Campos completados
  • 30 - Firmado
  • 40 - Quitado (antes de firmar)
  • 50 - Rechazado
integer

SignerResponse

Detalles del destinatario

Nombre Ruta de acceso Tipo Description
documento
 document string

Documento
Correo electrónico
 email string

Correo electrónico del destinatario
primer nombre
 first_name string

Nombre del destinatario
apellido
 last_name string

Apellidos del destinatario
has_fields
 has_fields boolean

El destinatario tiene campos
order
 order integer

Orden del destinatario
resource_uri
 resource_uri string

URI de recurso de destinatario
estado
 status SignerStatusEnum

Opciones de estado del firmante:

  • 4 - sin enviar
  • 5 - programado para enviar
  • 10 - enviado
  • 15 - correo electrónico abierto
  • 20 - visitado
  • 30 - campos completados
  • 35 - campos completados ex firma
  • 39 - esperando a que se complete el testigo
  • 40 - firmado
  • 50 - descargado
  • 60 - rechazado

SignerStatusEnum

Opciones de estado del firmante:

  • 4 - sin enviar
  • 5 - programado para enviar
  • 10 - enviado
  • 15 - correo electrónico abierto
  • 20 - visitado
  • 30 - campos completados
  • 35 - campos completados ex firma
  • 39 - esperando a que se complete el testigo
  • 40 - firmado
  • 50 - descargado
  • 60 - rechazado

Opciones de estado del firmante:

  • 4 - sin enviar
  • 5 - programado para enviar
  • 10 - enviado
  • 15 - correo electrónico abierto
  • 20 - visitado
  • 30 - campos completados
  • 35 - campos completados ex firma
  • 39 - esperando a que se complete el testigo
  • 40 - firmado
  • 50 - descargado
  • 60 - rechazado
integer

DocumentResponseDetail

Detalles del documento

Nombre Ruta de acceso Tipo Description
Archivados
 archived boolean

Se archiva
auto_archive
 auto_archive boolean

Enviar archivo de documentos después de la firma.
cc_emails
 cc_emails string

Quién será cc'd con remitente en la notificación por correo electrónico cuando se firme
creado
 created date-time

Creado
do_email
 do_email boolean

Uso de correos electrónicos legalesign
download_final
 download_final boolean

Pdf final está disponible para descargar
pie de página
 footer string

Documentos HTML: texto para pie de página si se usa
footer_height
 footer_height integer

Documentos de HTMl: alto px del pie de página si se usa
group
 group string

URI de recurso del grupo
has_fields
 has_fields boolean

El documento tiene campos
hash_value
 hash_value string

Suma de comprobación SHA256 del documento final, úselo para validar la descarga final de PDF.
encabezado
 header string

Documentos HTML: texto para el encabezado si se usa
header_height
 header_height integer

Documentos de HTMl: alto px del encabezado si se usa
modificado
 modified date-time

Modificada
nombre
 name string

Nombre del documento
pdf_password
 pdf_password string

Contraseña de PDF
pdf_password_type
 pdf_password_type string

Si se conserva la contraseña pdf
pdftext
 pdftext string

Omitir esto
redirigir
 redirect string

Dirección URL del redireccionamiento del destinatario después de la firma
resource_uri
 resource_uri string

URI de recursos
return_signer_links
 return_signer_links boolean

Ignore
sign_mouse
 sign_mouse boolean

ignorar
sign_time
 sign_time date-time

Hora de inicio de sesión
sign_type
 sign_type boolean

heredado
sign_upload
 sign_upload boolean

heredado
signature_placement
 signature_placement integer

heredado
signature_type
 signature_type integer

heredado: siempre 4
Firmantes
 signers array of array

Matrices anidadas con detalles del firmante
items
 signers array of

Siempre contiene [uri del firmante, nombre, apellidos, correo electrónico, número de sms, has_fields, estado, orden del firmante (0-indexado)]
signer_objects
 signer_objects array of object

Lista de destinatarios
Correo electrónico
 signer_objects.email string

Correo Electrónico
nombre de pila
 signer_objects.firstname string

Nombre
apellido
 signer_objects.lastname string

Apellido
Teléfono
 signer_objects.tel string

Número tel
order
 signer_objects.order integer

Orden de firma
resource_uri
 signer_objects.resource_uri string

URI de recursos
role
 signer_objects.role string

Rol
estado
 signer_objects.status integer

Código de estado del destinatario
Identificador Único Universal (UUID)
 signer_objects.uuid string

Id. de destinatario
signers_in_order
 signers_in_order boolean

Destinatarios de correo electrónico simulados o secuenciales
estado
 status DocumentStatusEnum

Opciones de estado del documento:

  • 10 - Estado inicial, comprobación del estado del firmante para enviar o anular la sangría
  • 20 - Campos completados
  • 30 - Firmado
  • 40 - Quitado (antes de firmar)
  • 50 - Rechazado
tag
 tag string

Su referencia
tag1
 tag1 string

Su referencia
tag2
 tag2 string

Su referencia
template
 template string

URI de recurso para la plantilla de texto si se usa
templatepdf
 templatepdf string

URI de recurso para la plantilla pdf si se usa
texto
 text string

Texto del documento si se usa
user
 user string

URI de recurso de usuario.
Identificador Único Universal (UUID)
 uuid uuid

Id. de documento

MemberListResponse

Nombre Ruta de acceso Tipo Description
meta
 meta ListMeta

Meta información sobre la lista.
objetos
 objects array of MemberResponse

MemberResponse

Nombre Ruta de acceso Tipo Description
creado
 created date-time

Creado
group
 group string

URI de recursos de grupo
modificado
 modified date-time

Modificada
permiso
 permission PermissionsEnum

Opciones de permiso
resource_uri
 resource_uri string

URI de recursos
user
 user string

URI de recurso de usuario.

AttachmentResponse

Adjuntar elemento.

Nombre Ruta de acceso Tipo Description
creado
 created date-time

Creado
descripción
 description string

Description
filename
 filename string

Nombre del archivo
group
 group string

Grupo
resource_uri
 resource_uri string

Adjuntar identificador URI de recursos
user
 user string

URI de recursos de usuario
Identificador Único Universal (UUID)
 uuid uuid

Asociar id.

AttachmentListResponse

Lista de datos adjuntos

Nombre Ruta de acceso Tipo Description
meta
 meta ListMeta

Meta información sobre la lista.
objetos
 objects array of object

Listado
creado
 objects.created date-time

Creado
descripción
 objects.description string

Description
filename
 objects.filename string

Nombre del archivo
group
 objects.group string

Grupo
resource_uri
 objects.resource_uri string

URI de recursos
user
 objects.user string

URI de recursos de usuario
Identificador Único Universal (UUID)
 objects.uuid uuid

Asociar id.

UserDetailResponse

Detalles del usuario.

Nombre Ruta de acceso Tipo Description
date_joined
 date_joined date-time

Fecha de unión
Correo electrónico
 email email

Correo Electrónico
primer nombre
 first_name string

Nombre
groups
 groups array of string

Lista de grupos a los que se ha unido este usuario.
last_login
 last_login date-time

Último inicio de sesión
apellido
 last_name string

Apellido
resource_uri
 resource_uri string

URI de recursos
timezone
 timezone string

Zona horaria
nombre de usuario
 username string

Nombre de usuario

archivo

Este es el tipo de datos básico "file".