SignatureAPI

Envíe documentos para firmar, realice un seguimiento de su progreso y realice un trabajo más rápido con SignatureAPI, la plataforma de firma electrónica creada para la automatización. https://signatureapi.com/docs/integrations/power-automate/getting-started

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	Signature API, Inc.
URL	https://signatureapi.com
Correo Electrónico	support@signatureapi.com

Metadatos del conector
Publicador	SignatureAPI
Sitio web	https://signatureapi.com/power-automate
Directiva de privacidad	https://signatureapi.com/privacy
Categorías	Colaboración; Productividad

SignatureAPI

SignatureAPI es una plataforma de firma electrónica creada para la automatización.

Envíe documentos para firmar y realizar un seguimiento de su progreso mediante nuestra plataforma de firma electrónica para Power Automate, que proporciona diversas acciones y desencadenadores para ayudarle a crear flujos de trabajo sencillos y complejos.

Las firmas electrónicas realizadas con SignatureAPI son legalmente vinculantes y aceptadas globalmente, al igual que las firmas de lápiz tradicionales en la mayoría de las jurisdicciones.

SignatureAPI ofrece precios rentables para la automatización de gran volumen. Consulte nuestros detalles de precios.

Características clave

Varios destinatarios: envíe documentos a hasta 10 firmantes en una sola transacción.
Firma paralela o secuencial: elija enviar documentos a todos los destinatarios a la vez o en un orden específico.
Plantillas de documento: genere documentos mediante programación mediante plantillas y datos dinámicos.
Idiomas y localización: personalice la interfaz de firma con diferentes idiomas, formatos de fecha y hora y zonas horarias.
Firma sin cuenta: permite que los destinatarios firmen documentos sin crear ni iniciar sesión en una cuenta.
Registro de auditoría: mantenga un registro detallado de eventos de acceso, revisión y firma de documentos.
Corrección de alteraciones: asegúrese de que la integridad del documento sea comprobada e irrefutable después de la firma.
Seguimiento de sobres: supervise el progreso de la firma a través de un panel fácil de usar.
Real-Time Notificaciones: recibir actualizaciones instantáneas sobre las actividades de firma a través de correo electrónico y webhooks.

Prerrequisitos

Para usar este conector, regístrese para obtener una cuenta de SignatureAPI y genere una clave de API. Obtenga una clave de API de prueba gratuita y configure la conexión.

Introducción

El flujo de trabajo más común implica enviar uno o varios documentos a los destinatarios para la firma. Los destinatarios reciben un correo electrónico con un vínculo para acceder a la interfaz de firma.

SignatureAPI admite flujos de trabajo avanzados. Explore nuestras guías de conector para obtener instrucciones paso a paso, casos de uso y estrategias de automatización.

Paso 1: Crear un sobre

Comience creando un sobre vacío. Un sobre es un contenedor que contiene documentos y administra el proceso de firma.

Acción: Crear un sobre

Entre las opciones se incluyen:

Definir si los destinatarios inician sesión en paralelo o secuencialmente (enrutamiento de destinatarios)
Personalización del idioma, la zona horaria y el formato de fecha y hora (localización de sobres)
Establecer el nombre y el correo electrónico del remitente

Paso 2: Agregar destinatarios

Especifique quién debe firmar los documentos agregando destinatarios al sobre. Actualmente, solo se admiten los firmantes, pero los tipos de destinatarios adicionales estarán disponibles en el futuro.

Acción: Agregar un destinatario: firmante

Paso 3: Agregar documentos

Agregue los documentos que necesitan firmas al sobre. Puede cargar archivos PDF o DOCX o generar documentos a partir de plantillas mediante datos.

Paso 4: Definir lugares en los documentos

Los lugares se designan en un documento en el que un destinatario interactúa, como la firma, la provisión de iniciales o la adición de texto. También pueden contener valores estáticos o calculados, como fechas de finalización.

Paso 5: Iniciar el proceso de firma

Una vez preparado el sobre, inicie el proceso de firma.

Acción: Iniciar un sobre

Paso 6: Esperar a que se complete el sobre

Para mantener todo el flujo de trabajo dentro del mismo flujo, puede esperar hasta que se complete el sobre. Esto garantiza que todos los destinatarios hayan firmado y se genere la entrega (documento firmado).

Acción: Esperar sobre

Como alternativa, puede desencadenar un flujo de trabajo independiente cuando se complete el sobre y se genere la entrega.

Desencadenador: cuando se genera una entrega

Paso 7: Recuperar el documento firmado

Una vez completado el proceso, recupere el documento firmado (entrega).

Acción: Obtener una entrega

Trabajar con desencadenadores

SignatureAPI ofrece desencadenadores para automatizar los flujos de trabajo y simplificar los procesos. Obtenga información sobre la lista completa de desencadenadores y cómo usarlos.

Desencadenadores usados habitualmente

Cuando se genera un resultado

Se desencadena cuando se completa el sobre y el documento firmado (entrega) está listo.

Cuando un destinatario completa un sobre

Se desencadena cada vez que un destinatario finaliza su parte del proceso de firma.

Desencadenador: cuando se completa un destinatario

Cuando un correo electrónico de destinatario rebota

Se desencadena cuando la dirección de correo electrónico de un destinatario no puede recibir la solicitud.

Problemas conocidos y limitaciones

Use una clave de API de prueba para crear sobres de prueba. Estos sobres no envían correos electrónicos reales y no se facturan, por lo que son perfectos para realizar pruebas. Más información sobres de prueba.
La acción "Esperar sobre" agota el tiempo de espera después de 30 días. Si espera que los destinatarios tarden más tiempo, use un nuevo flujo de trabajo a partir del desencadenador "Cuando se genera una entrega".

Errores y soluciones comunes

Asegúrese de que se ejecuta la acción Obtener una entrega después de la acción Esperar sobre . Las entregas solo están disponibles una vez que todos los destinatarios hayan completado su parte.
Si cambia de una clave de API de prueba a una clave de API activa, actualice el desencadenador para asegurarse de que el webhook se crea en el entorno correcto (activo o de prueba). Consulte nuestra guía de solución de problemas para obtener más información.

Creación de 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 de API	securestring	Clave de API para la cuenta de SignatureAPI.	Cierto

Limitaciones

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

Acciones

Adición de una plantilla: DOCX	Agrega una plantilla DOCX a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Agregar datos a la plantilla	Agrega datos a una plantilla. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Agregar un destinatario: firmante	Agrega un destinatario a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Agregar un documento: DOCX	Agrega un documento DOCX a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Agregar un documento: PDF	Agrega un documento PDF a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Agregar un lugar: entrada de texto	Agrega un lugar de entrada de texto a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Agregar un lugar: fecha de finalización del destinatario	Agrega un lugar de fecha de finalización del destinatario a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Agregar un lugar: fecha de finalización del sobre	Agrega un lugar de fecha de finalización de sobre a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Agregar un lugar: firma	Agrega un lugar de firma a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Agregar un lugar: iniciales	Agrega un lugar inicial a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Agregar un lugar: texto	Agrega un lugar de texto a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Crear un sobre	Crea un nuevo sobre al que puede agregar destinatarios y documentos. Cuando esté listo, use la acción "Iniciar un sobre" para iniciar el proceso de firma. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Crear una ceremonia: autenticación de vínculo de correo electrónico	Crea una ceremonia en la que el destinatario se autentica a través de un vínculo enviado a su correo electrónico. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Crear una ceremonia: autenticación personalizada	Crea una ceremonia en la que el destinatario se autentica externamente en SignatureAPI. Úselo para obtener una dirección URL de ceremonia para compartir con destinatarios. Antes de usar la lectura de autenticación personalizada https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Eliminar un sobre	Elimina un sobre y toda la información asociada. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Esperar sobre	Espera a que un sobre llegue a un estado completado u otro estado final. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope
Iniciar un sobre	Inicia el proceso de firma de un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Obtención de una entrega	Recupera un resultado mediante su identificador. Úselo para descargar una copia firmada del sobre. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Obtener un destinatario	Recupera los detalles del destinatario por su identificador. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Obtener un sobre	Recupera los detalles del sobre por su identificador. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Obtener un valor capturado	Recupera un valor especificado por un destinatario en un lugar de entrada durante la firma. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Adición de una plantilla: DOCX

Id. de la operación:: AddTemplate

Agrega una plantilla DOCX a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.
Título del documento	title		string	Título de este documento. Esto puede mostrarse a los destinatarios.
Contenido del archivo	file_content	True	byte	Contenido del archivo de documento.
Datos de plantilla	data		array of string	Campo: par de valores que contiene los datos que se van a rellenar en la plantilla.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Devoluciones

Body: AddDocumentOutput

Agregar datos a la plantilla

Id. de la operación:: AddTemplateData

Agrega datos a una plantilla. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de documento	documentId	True	string	Identificador del documento.
Nombre del campo	field_name	True	string	Nombre del campo de la plantilla.
Importancia	value	True	string	Valor del campo de la plantilla.

Agregar un destinatario: firmante

Id. de la operación:: AddRecipient

Agrega un destinatario a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.
Nombre del destinatario	name	True	string	Nombre del destinatario.
Correo electrónico del destinatario	email	True	string	Dirección de correo electrónico del destinatario.
Clave de destinatario	key	True	string	Clave que identifica un destinatario dentro de un sobre.
Creación de la ceremonia de destinatarios	ceremony_creation		string	Cómo se crean las ceremonias de un destinatario.
Tipo de entrega de destinatarios	delivery_type		string	Cómo se envía el resultado al destinatario.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Devoluciones

Body: AddRecipientSignerOutput

Agregar un documento: DOCX

Id. de la operación:: AddDocumentDocx

Agrega un documento DOCX a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.
Título del documento	title		string	Título de este documento. Esto puede mostrarse a los destinatarios.
Contenido del archivo	file_content	True	byte	Contenido del archivo de documento.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Devoluciones

Body: AddDocumentOutput

Agregar un documento: PDF

Id. de la operación:: AddDocument

Agrega un documento PDF a un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.
Título del documento	title		string	Título de este documento. Esto puede mostrarse a los destinatarios.
Contenido del archivo	file_content	True	byte	Contenido del archivo de documento.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Devoluciones

Body: AddDocumentOutput

Agregar un lugar: entrada de texto

Id. de la operación:: AddPlaceTextInput

Agrega un lugar de entrada de texto a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de documento	documentId	True	string	Identificador del documento.
Colocar clave	key	True	string	Clave que identifica este lugar dentro del documento.
Clave de destinatario	recipient_key	True	string	La clave del destinatario a la que hace referencia este lugar.
Capturar como	capture_as		string	Clave que almacena la entrada del destinatario y se incluye en las capturas del sobre.
Hint	hint		string	Mensaje de información sobre herramientas que se muestra sobre el campo de entrada para el destinatario.
Pronto	prompt		string	Mensaje de marcador de posición que se muestra dentro del campo de texto de entrada durante la ceremonia de firma.
Requirement	requirement		string	Especifica si el destinatario debe rellenar este campo para completar la ceremonia de firma.
Formato	format		string	Especifica el formato válido para la entrada del usuario. Consulte la documentación de los valores permitidos.
Dar formato al mensaje	format_message		string	Mensaje que se muestra cuando la entrada del usuario no coincide con el formato necesario.
Número de página	page		number	Número de página para colocar este lugar.
Distancia desde arriba	top		number	Distancia (en puntos) desde la parte superior de la página hasta la parte inferior del lugar.
Distancia desde la izquierda	left		number	Distancia (en puntos) de la izquierda de la página al lugar.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Agregar un lugar: fecha de finalización del destinatario

Id. de la operación:: AddPlaceRecipientCompletedDate

Agrega un lugar de fecha de finalización del destinatario a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de documento	documentId	True	string	Identificador del documento.
Colocar clave	key	True	string	Clave que identifica este lugar dentro del documento.
Clave de destinatario	recipient_key	True	string	La clave del destinatario a la que hace referencia este lugar.
Formato de fecha	date_format		string	Define el formato de la fecha y hora. Consulte la documentación de los valores permitidos.
Número de página	page		number	Número de página para colocar este lugar.
Distancia desde arriba	top		number	Distancia (en puntos) desde la parte superior de la página hasta la parte inferior del lugar.
Distancia desde la izquierda	left		number	Distancia (en puntos) de la izquierda de la página al lugar.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Agregar un lugar: fecha de finalización del sobre

Id. de la operación:: AddPlaceEnvelopeCompletedDate

Agrega un lugar de fecha de finalización de sobre a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de documento	documentId	True	string	Identificador del documento.
Colocar clave	key	True	string	Clave que identifica este lugar dentro del documento.
Formato de fecha	date_format		string	Define el formato de la fecha y hora. Consulte la documentación de los valores permitidos.
Número de página	page		number	Número de página para colocar este lugar.
Distancia desde arriba	top		number	Distancia (en puntos) desde la parte superior de la página hasta la parte inferior del lugar.
Distancia desde la izquierda	left		number	Distancia (en puntos) de la izquierda de la página al lugar.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Agregar un lugar: firma

Id. de la operación:: AddPlaceSignature

Agrega un lugar de firma a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de documento	documentId	True	string	Identificador del documento.
Colocar clave	key	True	string	Clave que identifica este lugar dentro del documento.
Clave de destinatario	recipient_key	True	string	La clave del destinatario a la que hace referencia este lugar.
Alto del lugar	height		number	Establezca un alto personalizado, el ancho se ajusta proporcionalmente.
Número de página	page		number	Número de página para colocar este lugar.
Distancia desde arriba	top		number	Distancia (en puntos) desde la parte superior de la página hasta la parte inferior del lugar.
Distancia desde la izquierda	left		number	Distancia (en puntos) de la izquierda de la página al lugar.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Agregar un lugar: iniciales

Id. de la operación:: AddPlaceInitials

Agrega un lugar inicial a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de documento	documentId	True	string	Identificador del documento.
Colocar clave	key	True	string	Clave que identifica este lugar dentro del documento.
Clave de destinatario	recipient_key	True	string	La clave del destinatario a la que hace referencia este lugar.
Alto del lugar	height		number	Establezca un alto personalizado, el ancho se ajusta proporcionalmente.
Número de página	page		number	Número de página para colocar este lugar.
Distancia desde arriba	top		number	Distancia (en puntos) desde la parte superior de la página hasta la parte inferior del lugar.
Distancia desde la izquierda	left		number	Distancia (en puntos) de la izquierda de la página al lugar.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Agregar un lugar: texto

Id. de la operación:: AddPlaceText

Agrega un lugar de texto a un documento. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de documento	documentId	True	string	Identificador del documento.
Colocar clave	key	True	string	Clave que identifica este lugar dentro del documento.
Importancia	value	True	string	Valor de este lugar de texto.
Tamaño de fuente	font_size		number	Tamaño de fuente en puntos.
Color de fuente	font_color		string	Color de fuente en notación hexadecimal.
Número de página	page		number	Número de página para colocar este lugar.
Distancia desde arriba	top		number	Distancia (en puntos) desde la parte superior de la página hasta la parte inferior del lugar.
Distancia desde la izquierda	left		number	Distancia (en puntos) de la izquierda de la página al lugar.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Crear un sobre

Id. de la operación:: CreateEnvelope

Crea un nuevo sobre al que puede agregar destinatarios y documentos. Cuando esté listo, use la acción "Iniciar un sobre" para iniciar el proceso de firma. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Título del sobre	title	True	string	Título de este sobre. Esto puede mostrarse a los destinatarios.
Etiqueta de sobre	label		string	Etiqueta personalizada dada al sobre para facilitar la identificación. Las etiquetas son para uso interno y no se muestran a los destinatarios.
Mensaje de sobre	message		string	Mensaje que se enviará a los destinatarios.
Modo de sobre	mode		string	Los sobres del modo de prueba no son vinculantes y no se facturan.
Enrutamiento de sobres	routing		string	Orden en el que los destinatarios firman el sobre. Puede ser paralelo, donde todos los destinatarios pueden firmar simultáneamente, o secuencialmente, donde los destinatarios se firman uno después de otro.
Language	language		string	Idioma predeterminado que se usará en la ceremonia de firma y entregas. Si no se especifica, se usa el idioma predeterminado de la cuenta. https://signatureapi.com/docs/localization/language
Zona horaria	timezone		string	Zona horaria que se va a usar para las marcas de tiempo en entregas. Si no se especifica, se usa el desplazamiento de zona horaria predeterminado de la cuenta. https://signatureapi.com/docs/localization/timezone
Formato de marca de tiempo	timestamp_format		string	El formato de fecha y hora que se va a usar en marcas de tiempo para entregas. Si no se especifica, se usa el formato de marca de tiempo predeterminado de la cuenta. https://signatureapi.com/docs/localization/timestamp_format
Atestación de sobre	attestation		string	Atestación de cumplimiento o normativa
Nombre	name		string	Nombre del remitente.
Correo Electrónico	email		string	Dirección de correo electrónico del remitente.
Temas sobre	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Devoluciones

Body: CreateEnvelopeOutput

Crear una ceremonia: autenticación de vínculo de correo electrónico

Id. de la operación:: CreateCeremonyEmailLink

Crea una ceremonia en la que el destinatario se autentica a través de un vínculo enviado a su correo electrónico. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de destinatario	recipientId	True	string	Identificador del destinatario.
Dirección URL de redireccionamiento	redirect_url		string	Dirección URL para redirigir el destinatario a una vez finalizada una ceremonia. Más información en: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Devoluciones

response: object

Crear una ceremonia: autenticación personalizada

Id. de la operación:: CreateCeremonyCustom

Crea una ceremonia en la que el destinatario se autentica externamente en SignatureAPI. Úselo para obtener una dirección URL de ceremonia para compartir con destinatarios. Antes de usar la lectura de autenticación personalizada https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de destinatario	recipientId	True	string	Identificador del destinatario.
Proveedor de autenticación	provider	True	string	Nombre del proveedor de autenticación. Este valor es arbitrario y aparecerá en los registros de auditoría del sobre.
Datos de autenticación	data	True	array of string	Clave: par de valores que contiene metadatos de autenticación. Estos detalles se incluirán en los registros de auditoría del sobre.
Dirección URL de redireccionamiento	redirect_url		string	Dirección URL para redirigir el destinatario a una vez finalizada una ceremonia. Más información en: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Propiedades adicionales	extra		string	Propiedades adicionales para la extensibilidad

Devoluciones

Body: CreateCeremonyCustomOutput

Eliminar un sobre

Id. de la operación:: DeleteEnvelope

Elimina un sobre y toda la información asociada. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.

Esperar sobre

Id. de la operación:: WaitEnvelope

Espera a que un sobre llegue a un estado completado u otro estado final. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.

Devoluciones

Body: Envelope

Iniciar un sobre

Id. de la operación:: StartEnvelope

Inicia el proceso de firma de un sobre. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.

Devoluciones

Body: StartEnvelopeOutput

Obtención de una entrega

Id. de la operación:: GetDeliverable

Recupera un resultado mediante su identificador. Úselo para descargar una copia firmada del sobre. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de entrega	deliverableId	True	string	Identificador de la entrega.

Devoluciones

Body: Deliverable

Obtener un destinatario

Id. de la operación:: GetRecipient

Recupera los detalles del destinatario por su identificador. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de destinatario	recipientId	True	string	Identificador del destinatario.

Devoluciones

Body: Recipient

Obtener un sobre

Id. de la operación:: GetEnvelope

Recupera los detalles del sobre por su identificador. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.

Devoluciones

Body: Envelope

Obtener un valor capturado

Id. de la operación:: GetCapture

Recupera un valor especificado por un destinatario en un lugar de entrada durante la firma. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeId	True	string	Identificador del sobre.
Clave de captura	captureKey	True	string	Clave del valor capturado.

Devoluciones

Body: Capture

Desencadenadores

Cuando se cancela un sobre	Este evento se produce cuando el proceso de firma se ha detenido intencionadamente antes de la finalización, lo que da lugar a un estado de sobre cancelado.
Cuando se completa un destinatario	Este evento se produce cuando un destinatario ha completado su parte del proceso de firma.
Cuando se completa un sobre	Este evento se produce cuando un estado de sobre pasa de in_progress a completado, lo que indica que todos los destinatarios lo han completado.
Cuando se crea un sobre	Este evento se produce cada vez que se crea un sobre.
Cuando se envía un destinatario	Este evento se produce cuando se envía una solicitud a un destinatario.
Cuando se genera una entrega	Este evento se produce cuando se genera correctamente una entrega, como un registro de auditoría.
Cuando se ha iniciado un sobre	Este evento se produce cuando un estado de sobre pasa de procesamiento a in_progress, lo que indica que está listo para enviarse a los destinatarios.
Cuando se libera un destinatario	Este evento se produce cuando un destinatario está listo para enviar una solicitud para completar un sobre.
Cuando se produce un error en un destinatario	Este evento se produce cuando se produce un error relacionado con un destinatario, lo que da lugar a un estado de error del destinatario.
Cuando se produce un error en un sobre	Este evento se produce cuando se produce un error en un sobre, lo que da lugar a un estado de sobre de error.
Cuando se produce un error en una entrega	Este evento se produce cuando se produce un error en la generación de una entrega, lo que da lugar a un estado de entrega de error.
Cuando se rechaza un destinatario	Este evento se produce cuando un destinatario rechaza el sobre.
Cuando se reemplaza un destinatario	Este evento se produce cuando un destinatario se reemplaza por uno nuevo.
Cuando se vuelve a enviar un destinatario	Este evento se produce cuando una solicitud se vuelve a enviar a un destinatario.
Cuando un destinatario rebota	Este evento se produce cuando un correo electrónico no se puede entregar, ya sea temporalmente (rebote suave) o permanentemente (rebote duro).

Cuando se cancela un sobre

Id. de la operación:: CreateEndpointForEnvelopeCanceled

Este evento se produce cuando el proceso de firma se ha detenido intencionadamente antes de la finalización, lo que da lugar a un estado de sobre cancelado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForEnvelopeCanceled

Cuando se completa un destinatario

Id. de la operación:: CreateEndpointForRecipientCompleted

Este evento se produce cuando un destinatario ha completado su parte del proceso de firma.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientCompleted

Cuando se completa un sobre

Id. de la operación:: CreateEndpointForEnvelopeCompleted

Este evento se produce cuando un estado de sobre pasa de in_progress a completado, lo que indica que todos los destinatarios lo han completado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForEnvelopeCompleted

Cuando se crea un sobre

Id. de la operación:: CreateEndpointForEnvelopeCreated

Este evento se produce cada vez que se crea un sobre.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForEnvelopeCreated

Cuando se envía un destinatario

Id. de la operación:: CreateEndpointForRecipientSent

Este evento se produce cuando se envía una solicitud a un destinatario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientSent

Cuando se genera una entrega

Id. de la operación:: CreateEndpointForDeliverableGenerated

Este evento se produce cuando se genera correctamente una entrega, como un registro de auditoría.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForDeliverableGenerated

Cuando se ha iniciado un sobre

Id. de la operación:: CreateEndpointForEnvelopeStarted

Este evento se produce cuando un estado de sobre pasa de procesamiento a in_progress, lo que indica que está listo para enviarse a los destinatarios.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForEnvelopeStarted

Cuando se libera un destinatario

Id. de la operación:: CreateEndpointForRecipientReleased

Este evento se produce cuando un destinatario está listo para enviar una solicitud para completar un sobre.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientReleased

Cuando se produce un error en un destinatario

Id. de la operación:: CreateEndpointForRecipientFailed

Este evento se produce cuando se produce un error relacionado con un destinatario, lo que da lugar a un estado de error del destinatario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientFailed

Cuando se produce un error en un sobre

Id. de la operación:: CreateEndpointForEnvelopeFailed

Este evento se produce cuando se produce un error en un sobre, lo que da lugar a un estado de sobre de error.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForEnvelopeFailed

Cuando se produce un error en una entrega

Id. de la operación:: CreateEndpointForDeliverableFailed

Este evento se produce cuando se produce un error en la generación de una entrega, lo que da lugar a un estado de entrega de error.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForDeliverableFailed

Cuando se rechaza un destinatario

Id. de la operación:: CreateEndpointForRecipientRejected

Este evento se produce cuando un destinatario rechaza el sobre.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientRejected

Cuando se reemplaza un destinatario

Id. de la operación:: CreateEndpointForRecipientReplaced

Este evento se produce cuando un destinatario se reemplaza por uno nuevo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientReplaced

Cuando se vuelve a enviar un destinatario

Id. de la operación:: CreateEndpointForRecipientResent

Este evento se produce cuando una solicitud se vuelve a enviar a un destinatario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientResent

Cuando un destinatario rebota

Id. de la operación:: CreateEndpointForRecipientBounced

Este evento se produce cuando un correo electrónico no se puede entregar, ya sea temporalmente (rebote suave) o permanentemente (rebote duro).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Temas	topics		array of string	Use para clasificar sobres y filtrar notificaciones de webhook.

Devoluciones

Body: NotificationForRecipientBounced

Definiciones

Sobre

Nombre	Ruta de acceso	Tipo	Description
Id. de sobre	id	EnvelopeId	Identificador del sobre.
Título del sobre	title	EnvelopeTitle	Título de este sobre. Esto puede mostrarse a los destinatarios.
Etiqueta de sobre	label	EnvelopeLabel	Etiqueta personalizada dada al sobre para facilitar la identificación. Las etiquetas son para uso interno y no se muestran a los destinatarios.
Mensaje de sobre	message	EnvelopeMessage	Mensaje que se enviará a los destinatarios.
remitente	sender	EnvelopeSender
Estado del sobre	status	EnvelopeStatus	Estado del sobre.
entregable	deliverable	EnvelopeDeliverable
Sobre completado en	completed_at	EnvelopeCompletedAt	Hora en que todos los destinatarios completaron el sobre.
Modo de sobre	mode	EnvelopeMode	Los sobres del modo de prueba no son vinculantes y no se facturan.
Enrutamiento de sobres	routing	EnvelopeRouting	Orden en el que los destinatarios firman el sobre. Puede ser paralelo, donde todos los destinatarios pueden firmar simultáneamente, o secuencialmente, donde los destinatarios se firman uno después de otro.
Zona horaria	timezone	EnvelopeTimezone	Zona horaria que se va a usar para las marcas de tiempo en entregas. Si no se especifica, se usa el desplazamiento de zona horaria predeterminado de la cuenta. https://signatureapi.com/docs/localization/timezone
Formato de marca de tiempo	timestamp_format	EnvelopeTimestampFormat	El formato de fecha y hora que se va a usar en marcas de tiempo para entregas. Si no se especifica, se usa el formato de marca de tiempo predeterminado de la cuenta. https://signatureapi.com/docs/localization/timestamp_format
Atestación de sobre	attestation	EnvelopeAttestation	Atestación de cumplimiento o normativa
Temas sobre	topics	EnvelopeTopics	Use para clasificar sobres y filtrar notificaciones de webhook.

Destinatario

Nombre	Ruta de acceso	Tipo	Description
Id. de destinatario	id	RecipientId	Identificador del destinatario.
Id. de sobre	envelope_id	EnvelopeId	Identificador del sobre.
Tipo de destinatario	type	RecipientType	Tipo del destinatario.
Clave de destinatario	key	RecipientKey	Clave que identifica un destinatario dentro de un sobre.
Nombre del destinatario	name	RecipientName	Nombre del destinatario.
Correo electrónico del destinatario	email	RecipientEmail	Dirección de correo electrónico del destinatario.
Estado del destinatario	status	RecipientStatus	Estado del destinatario.
Creación de la ceremonia de destinatarios	ceremony_creation	RecipientCeremonyCreation	Cómo se crean las ceremonias de un destinatario.
Tipo de entrega de destinatarios	delivery_type	RecipientDeliveryType	Cómo se envía el resultado al destinatario.
Destinatario completado en	completed_at	RecipientCompletedAt	Hora en que el destinatario completó el sobre.

Entregable

Nombre	Ruta de acceso	Tipo	Description
Id. de entrega	id	DeliverableId	Identificador de la entrega.
Tipo de entrega	type	DeliverableType	Tipo de la entrega.
Estado de entrega	status	DeliverableStatus	Estado de la entrega.
Contenido del archivo	file_content	DeliverableFileContent	Contenido del archivo del resultado. Úselo para guardar una copia firmada del sobre.

Capture

Nombre	Ruta de acceso	Tipo	Description
Valor de captura	value	CaptureValue	Valor de la captura de entrada del destinatario

CreateEnvelopeOutput

Nombre	Ruta de acceso	Tipo	Description
Id. de sobre	id	EnvelopeId	Identificador del sobre.
Título del sobre	title	EnvelopeTitle	Título de este sobre. Esto puede mostrarse a los destinatarios.
Etiqueta de sobre	label	EnvelopeLabel	Etiqueta personalizada dada al sobre para facilitar la identificación. Las etiquetas son para uso interno y no se muestran a los destinatarios.
Mensaje de sobre	message	EnvelopeMessage	Mensaje que se enviará a los destinatarios.
remitente	sender	EnvelopeSender
Modo de sobre	mode	EnvelopeMode	Los sobres del modo de prueba no son vinculantes y no se facturan.
Enrutamiento de sobres	routing	EnvelopeRouting	Orden en el que los destinatarios firman el sobre. Puede ser paralelo, donde todos los destinatarios pueden firmar simultáneamente, o secuencialmente, donde los destinatarios se firman uno después de otro.
Zona horaria	timezone	EnvelopeTimezone	Zona horaria que se va a usar para las marcas de tiempo en entregas. Si no se especifica, se usa el desplazamiento de zona horaria predeterminado de la cuenta. https://signatureapi.com/docs/localization/timezone
Formato de marca de tiempo	timestamp_format	EnvelopeTimestampFormat	El formato de fecha y hora que se va a usar en marcas de tiempo para entregas. Si no se especifica, se usa el formato de marca de tiempo predeterminado de la cuenta. https://signatureapi.com/docs/localization/timestamp_format
Atestación de sobre	attestation	EnvelopeAttestation	Atestación de cumplimiento o normativa
Temas sobre	topics	EnvelopeTopics	Use para clasificar sobres y filtrar notificaciones de webhook.

StartEnvelopeOutput

Nombre	Ruta de acceso	Tipo	Description
Estado del sobre	status	EnvelopeStatus	Estado del sobre.

AddDocumentOutput

Nombre	Ruta de acceso	Tipo	Description
Id. de documento	id	DocumentId	Identificador del documento

AddRecipientSignerOutput

Nombre	Ruta de acceso	Tipo	Description
Id. de destinatario	id	RecipientId	Identificador del destinatario.
Nombre del destinatario	name	RecipientName	Nombre del destinatario.
Correo electrónico del destinatario	email	RecipientEmail	Dirección de correo electrónico del destinatario.
Clave de destinatario	key	RecipientKey	Clave que identifica un destinatario dentro de un sobre.
Creación de la ceremonia de destinatarios	ceremony_creation	RecipientCeremonyCreation	Cómo se crean las ceremonias de un destinatario.
Tipo de entrega de destinatarios	delivery_type	RecipientDeliveryType	Cómo se envía el resultado al destinatario.

CreateCeremonyCustomOutput

Nombre	Ruta de acceso	Tipo	Description
Dirección URL de la ceremonia	url	CeremonyUrl	La dirección URL que el destinatario debe visitar para iniciar la ceremonia

EnvelopeId

Identificador del sobre.

Id. de sobre: string

EnvelopeTitle

Título de este sobre. Esto puede mostrarse a los destinatarios.

Título del sobre: string

EnvelopeLabel

Etiqueta personalizada dada al sobre para facilitar la identificación. Las etiquetas son para uso interno y no se muestran a los destinatarios.

Etiqueta de sobre: string

EnvelopeMessage

Mensaje que se enviará a los destinatarios.

Mensaje de sobre: string

EnvelopeRouting

Orden en el que los destinatarios firman el sobre. Puede ser paralelo, donde todos los destinatarios pueden firmar simultáneamente, o secuencialmente, donde los destinatarios se firman uno después de otro.

Enrutamiento de sobres: string

EnvelopeTimezone

Zona horaria que se va a usar para las marcas de tiempo en entregas. Si no se especifica, se usa el desplazamiento de zona horaria predeterminado de la cuenta. https://signatureapi.com/docs/localization/timezone

Zona horaria: string

EnvelopeTimestampFormat

El formato de fecha y hora que se va a usar en marcas de tiempo para entregas. Si no se especifica, se usa el formato de marca de tiempo predeterminado de la cuenta. https://signatureapi.com/docs/localization/timestamp_format

Formato de marca de tiempo: string

EnvelopeSender

Nombre	Ruta de acceso	Tipo	Description
Nombre del remitente	name	string	Nombre del remitente.
Correo electrónico del remitente	email	string	Dirección de correo electrónico del remitente.

EnvelopeStatus

Estado del sobre.

Estado del sobre: string

EnvelopeMode

Los sobres del modo de prueba no son vinculantes y no se facturan.

Modo de sobre: string

EnvelopeTopics

Use para clasificar sobres y filtrar notificaciones de webhook.

Nombre	Ruta de acceso	Tipo	Description
Productos		string

EnvelopeAttestation

Atestación de cumplimiento o normativa

Atestación de sobre: string

EnvelopeDeliverable

Nombre	Ruta de acceso	Tipo	Description
Id. de entrega	id	string	Identificador de la entrega. Úselo para descargar una copia firmada del sobre.

EnvelopeCompletedAt

Hora en que todos los destinatarios completaron el sobre.

Sobre completado en: date-time

DocumentId

Identificador del documento

Id. de documento: string

RecipientId

Identificador del destinatario.

Id. de destinatario: string

RecipientType

Tipo del destinatario.

Tipo de destinatario: string

RecipientName

Nombre del destinatario.

Nombre del destinatario: string

RecipientEmail

Dirección de correo electrónico del destinatario.

Correo electrónico del destinatario: string

RecipientKey

Clave que identifica un destinatario dentro de un sobre.

Clave de destinatario: string

RecipientStatus

Estado del destinatario.

Estado del destinatario: string

RecipientCeremonyCreation

Cómo se crean las ceremonias de un destinatario.

Creación de la ceremonia de destinatarios: string

RecipientDeliveryType

Cómo se envía el resultado al destinatario.

Tipo de entrega de destinatarios: string

RecipientCompletedAt

Hora en que el destinatario completó el sobre.

Destinatario completado en: date-time

DeliverableId

Identificador de la entrega.

Id. de entrega: string

DeliverableType

Tipo de la entrega.

Tipo de entrega: string

DeliverableStatus

Estado de la entrega.

Estado de entrega: string

DeliverableFileContent

Contenido del archivo del resultado. Úselo para guardar una copia firmada del sobre.

Contenido del archivo: byte

CeremonyUrl

La dirección URL que el destinatario debe visitar para iniciar la ceremonia

Dirección URL de la ceremonia: string

CaptureValue

Valor de la captura de entrada del destinatario

Valor de captura: string

NotificationForEnvelopeCreated

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.

NotificationForEnvelopeStarted

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.

NotificationForEnvelopeCompleted

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.

NotificationForEnvelopeFailed

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Detalle	data.detail	string	Información sobre el error.

NotificationForEnvelopeCanceled

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.

NotificationForRecipientReleased

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.

NotificationForRecipientSent

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.

NotificationForRecipientCompleted

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.

NotificationForRecipientRejected

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.
Motivo	data.reason	string	Explicación del destinatario para el rechazo.

NotificationForRecipientBounced

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.
Detalle	data.detail	string	Información sobre el rebote.

NotificationForRecipientFailed

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.
Detalle	data.detail	string	Información sobre el error.

NotificationForRecipientReplaced

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.
Nuevo identificador de destinatario	data.new_recipient_id	string	Identificador del nuevo destinatario.

NotificationForRecipientResent

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de destinatario	data.object_id	EventRecipientId	El identificador del destinatario al que hace referencia este evento.
Tipo de destinatario	data.recipient_type	EventRecipientType	El tipo de destinatario al que hace referencia este evento.
Clave de destinatario	data.recipient_key	EventRecipientKey	La clave del destinatario al que hace referencia este evento.

NotificationForDeliverableGenerated

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de entrega	data.object_id	EventDeliverableId	El identificador de la entrega a la que hace referencia este evento.

NotificationForDeliverableFailed

Nombre	Ruta de acceso	Tipo	Description
Id. del evento	id	EventId	Id. del evento.
Marca de tiempo del evento	timestamp	EventTimestamp	Fecha y hora del evento, en formato ISO 8601.
Tipo de evento	type	EventType	El tipo de evento.
Id. de sobre	data.envelope_id	EventEnvelopeId	El identificador del sobre al que hace referencia este evento.
Id. de entrega	data.object_id	EventDeliverableId	El identificador de la entrega a la que hace referencia este evento.
Detalle	data.detail	string	Información sobre el error.

EventId

Id. del evento.

Id. del evento: string

Marca de tiempo del evento

Fecha y hora del evento, en formato ISO 8601.

Marca de tiempo del evento: date-time

Tipo de evento

El tipo de evento.

Tipo de evento: string

EventEnvelopeId

El identificador del sobre al que hace referencia este evento.

Id. de sobre: string

EventRecipientId

El identificador del destinatario al que hace referencia este evento.

Id. de destinatario: string

EventRecipientType

El tipo de destinatario al que hace referencia este evento.

Tipo de destinatario: string

EventRecipientKey

La clave del destinatario al que hace referencia este evento.

Clave de destinatario: string

EventDeliverableId

El identificador de la entrega a la que hace referencia este evento.

Id. de entrega: string

objeto

Este es el tipo 'objeto'.

Compartir a través de

SignatureAPI

SignatureAPI

Características clave

Prerrequisitos

Introducción

Paso 1: Crear un sobre

Paso 2: Agregar destinatarios

Paso 3: Agregar documentos

Paso 4: Definir lugares en los documentos

Paso 5: Iniciar el proceso de firma

Paso 6: Esperar a que se complete el sobre

Paso 7: Recuperar el documento firmado

Trabajar con desencadenadores

Desencadenadores usados habitualmente

Cuando se genera un resultado

Cuando un destinatario completa un sobre

Cuando un correo electrónico de destinatario rebota

Problemas conocidos y limitaciones

Errores y soluciones comunes

Creación de una conexión

Predeterminado

Limitaciones

Acciones

Adición de una plantilla: DOCX

Parámetros

Devoluciones

Agregar datos a la plantilla

Parámetros

Agregar un destinatario: firmante

Parámetros

Devoluciones

Agregar un documento: DOCX

Parámetros

Devoluciones

Agregar un documento: PDF

Parámetros

Devoluciones

Agregar un lugar: entrada de texto

Parámetros

Agregar un lugar: fecha de finalización del destinatario

Parámetros

Agregar un lugar: fecha de finalización del sobre

Parámetros

Agregar un lugar: firma

Parámetros

Agregar un lugar: iniciales

Parámetros

Agregar un lugar: texto

Parámetros

Crear un sobre

Parámetros

Devoluciones

Crear una ceremonia: autenticación de vínculo de correo electrónico

Parámetros

Devoluciones

Crear una ceremonia: autenticación personalizada

Parámetros

Devoluciones

Eliminar un sobre

Parámetros

Esperar sobre

Parámetros

Devoluciones

Iniciar un sobre

Parámetros

Devoluciones

Obtención de una entrega

Parámetros

Devoluciones

Obtener un destinatario

Parámetros

Devoluciones

Obtener un sobre

Parámetros

Devoluciones

Obtener un valor capturado

Parámetros

Devoluciones

Desencadenadores