Adobe Acrobat Sign Government

Adobe es el servicio de firma de documentos digitales más confiable del mundo. Con Adobe Acrobat Sign, puede transformar procesos manuales en experiencias all-digitales. Incorpore la funcionalidad adobe Acrobat Sign a sus aplicaciones favoritas para crear, enviar y supervisar el estado de los contratos.

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

Service	Class	Regions
Power Apps	Estándar	Administración Pública de Estados Unidos

Contacto
Nombre	Compatibilidad con Adobe Acrobat Sign
URL	https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Correo Electrónico	support@echosign.zendesk.com

Metadatos del conector
Publicador	Adobe Inc.
Sitio web	https://acrobat.adobe.com/us/en/sign.html
Directiva de privacidad	https://www.adobe.com/privacy/policy.html
Categorías	Sitio web

Adobe Acrobat Sign

Publicador: Adobe, Inc.

Prerrequisitos

Se requiere la cuenta de Adobe Acrobat Sign.

Introducción al conector

Guía del usuario del conector https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Preguntas más frecuentes

Guía del usuario del conector https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html

Limitaciones

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

Acciones

Cancelación de un contrato	Cancela el contrato identificado por agreementId en la ruta de acceso.
Carga de un documento y obtención de un identificador de documento	Esta operación carga un documento en la cuenta de Adobe Acrobat Sign y devuelve un identificador de documento para él. Este documento se almacena temporalmente en Adobe Acrobat Sign y el identificador de documento se puede usar para otras operaciones, como la creación de un contrato.
Creación de un contrato a partir de un documento cargado y envío para la firma	Esta operación crea un contrato a partir de un documento cargado en Adobe Acrobat Sign y lo envía para su firma.
Creación de un contrato a partir de una dirección URL de documento y envío para la firma	Esta operación crea un contrato a partir de un documento cargado en Adobe Acrobat Sign y lo envía para su firma.
Creación de un contrato a partir de una plantilla de biblioteca y envío para firma	Esta operación crea un contrato a partir de una plantilla almacenada en la biblioteca adobe Acrobat Sign del usuario y la envía para su firma.
Creación de una plantilla de biblioteca a partir de un documento cargado	Esta operación crea una plantilla en la biblioteca adobe Acrobat Sign a partir de un documento cargado. Use esta plantilla para enviar contratos.
Creación de una plantilla de biblioteca a partir de una dirección URL de documento	Esta operación crea una plantilla en la biblioteca adobe Acrobat Sign a partir de una dirección URL del documento. Usar esta plantilla para enviar contratos
Obtención de datos de campo de formulario de acuerdo en formato CSV	Recupera los datos introducidos en los campos de formulario interactivo del contrato.
Obtención de datos de campo de formulario de acuerdo en formato JSON	Recupera los datos introducidos en los campos de formulario interactivo del contrato.
Obtener datos de campo de formulario del contrato (antiguo) [EN DESUSO]	Recupera los datos introducidos en los campos de formulario interactivo del contrato.
Obtener el estado de un contrato	Esta operación captura toda la información actual de un contrato, como el estado.
Obtener un documento de un contrato	Esta operación captura la secuencia de archivos de un documento específico del contrato.
Obtener un PDF de un contrato firmado	Esta operación captura la secuencia de archivos PDF del contrato combinado o firmado. Tenga en cuenta que la secuencia de archivos debe almacenarse con un nombre de archivo que termine en .pdf extensión de archivo.
Obtener una lista de todas las plantillas de biblioteca	Esta operación captura la lista de todos los documentos almacenados como plantillas en la biblioteca adobe Acrobat Sign del usuario.
Obtener una lista de todos los contratos	Esta operación captura la lista de todos los contratos del usuario.
Obtener una lista de todos los identificadores de documento de un contrato	Esta operación captura los identificadores de todos los documentos y los documentos auxiliares de un contrato.
Recuperación de la dirección URL de firma	Esta operación recupera la dirección URL de la página de inicio de sesión electrónico de los firmantes actuales de un contrato.

Cancelación de un contrato

Id. de la operación:: CancelAgreement

Cancela el contrato identificado por agreementId en la ruta de acceso.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	Identificador del contrato que se va a cancelar.
Estado de agrementación	state		string	El estado en el que debe llegar el acuerdo.
Comentario	comment		string	Comentario opcional que describe el motivo de la cancelación a los destinatarios.
Otros	notifyOthers		boolean	Si desea que se notifiquen o no a los destinatarios.

Carga de un documento y obtención de un identificador de documento

Id. de la operación:: CreateTransientDocument_V2

Esta operación carga un documento en la cuenta de Adobe Acrobat Sign y devuelve un identificador de documento para él. Este documento se almacena temporalmente en Adobe Acrobat Sign y el identificador de documento se puede usar para otras operaciones, como la creación de un contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de archivo	File-Name	True	string	Nombre del documento que se va a cargar, con extensión
Contenido del archivo	File	True	contentOnly	Secuencia de archivos del documento que se va a cargar

Devoluciones

Json que contiene el identificador del documento cargado

Body: TransientDocumentResponse

Creación de un contrato a partir de un documento cargado y envío para la firma

Id. de la operación:: CreateAgreementById_V2

Esta operación crea un contrato a partir de un documento cargado en Adobe Acrobat Sign y lo envía para su firma.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre del contrato	name	True	string	Nombre del contrato
identificación	transientDocumentId	True	string	Identificador de documento recibido cargando un documento transitorio
Tipo de firma	signatureType	True	string	Tipo de firma que desea solicitar: firma electrónica o escrita
Correo electrónico de participante	email	True	string	Correo electrónico del participante
Autenticación	authenticationMethod		string	Autenticación predeterminada: correo electrónico (Ninguno)
Contraseña	password		string	La contraseña necesaria para el participante
Código de país	countryCode		string	Código de país de teléfono del destinatario necesario para ver y firmar el documento
Teléfono No.	phone		string	Número de teléfono del destinatario necesario para ver y firmar el contrato
Pedido	order	True	integer	Índice a partir de 1, que indica la posición en la que el grupo de firma debe firmar.
Rol	role	True	string	Los roles actuales del conjunto de participantes (firmante, aprobador, etc.).
Message	message		string	Un mensaje opcional para los destinatarios que solicitan su acción
Correo Electrónico	email		string	El correo electrónico del CC del contrato
Hora de expiración	expirationTime		string	Hora después de la cual expira el Contrato. Ejemplo: 2020-12-31T23:59:00Z
Frecuencia de recordatorio	reminderFrequency		string	¿Con qué frecuencia desea enviar recordatorios?
Contraseña del documento	openPassword		string	Contraseña que se debe usar para cifrar el pdf del contrato firmado
Nombre	fieldName		string	Nombre del campo
Importancia	defaultValue		string	Valor predeterminado del campo
Retraso de redirección	redirectDelay		string	Retraso (en segundos) antes de que el usuario se tome en la página correcta.
Dirección URL de redireccionamiento	redirectUrl		string	Dirección URL para redirigir después de completar el proceso de firma, por ejemplo, https://adobe.com
Correos electrónicos iniciales	initEmails		string	Controlar los correos electrónicos de notificación para los eventos de inicio del contrato.

Devoluciones

Json que contiene el identificador del contrato recién creado.

Body: AgreementCreationResponseV6

Creación de un contrato a partir de una dirección URL de documento y envío para la firma

Id. de la operación:: CreateAgreementByUrl_V2

Esta operación crea un contrato a partir de un documento cargado en Adobe Acrobat Sign y lo envía para su firma.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre del contrato	name	True	string	Nombre del contrato
URL	url	True	string	Dirección URL accesible públicamente para recuperar el contenido del archivo sin procesar
Nombre	name	True	string	Nombre de archivo del sistema original del documento que se envía
Tipo	mimeType	True	string	Tipo mime del archivo al que se hace referencia, por ejemplo, application/pdf
Tipo de firma	signatureType	True	string	Especifica el tipo de firma solicitado: firma electrónica o escrito.
Correo electrónico de participante	email	True	string	Correo electrónico del participante
Autenticación	authenticationMethod		string	Autenticación predeterminada: correo electrónico (Ninguno)
Contraseña	password		string	La contraseña necesaria para el participante
Código de país	countryCode		string	Código de país de teléfono del destinatario necesario para ver y firmar el documento
Teléfono No.	phone		string	Número de teléfono del destinatario necesario para ver y firmar el contrato
Pedido	order	True	integer	Índice a partir de 1, que indica la posición en la que el grupo de firma debe firmar.
Rol	role	True	string	Los roles actuales del conjunto de participantes (firmante, aprobador, etc.).
Message	message		string	Un mensaje opcional para los destinatarios que solicitan su acción
Correo Electrónico	email		string	El correo electrónico del CC del contrato
Hora de expiración	expirationTime		string	Hora después de la cual expira el Contrato. Ejemplo: 2020-12-31T23:59:00Z
Frecuencia de recordatorio	reminderFrequency		string	¿Con qué frecuencia desea enviar recordatorios?
Contraseña del documento	openPassword		string	Contraseña que se debe usar para cifrar el pdf del contrato firmado
Nombre	fieldName		string	Nombre del campo
Importancia	defaultValue		string	Valor predeterminado del campo
Retraso de redirección	redirectDelay		string	Retraso (en segundos) antes de que el usuario se tome en la página correcta.
Dirección URL de redireccionamiento	redirectUrl		string	Dirección URL para redirigir después de completar el proceso de firma, por ejemplo, https://adobe.com
Correos electrónicos iniciales	initEmails		string	Controlar los correos electrónicos de notificación para los eventos de inicio del contrato.

Devoluciones

Json que contiene el identificador del contrato recién creado.

Body: AgreementCreationResponseV6

Creación de un contrato a partir de una plantilla de biblioteca y envío para firma

Id. de la operación:: CreateAgreementByTemplate_V2

Esta operación crea un contrato a partir de una plantilla almacenada en la biblioteca adobe Acrobat Sign del usuario y la envía para su firma.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre del contrato	name	True	string	Nombre del contrato
Template	libraryDocumentId	True	string	Elegir un documento de las plantillas almacenadas en la biblioteca
Tipo de firma	signatureType	True	string	Tipo de firma que desea solicitar: firma electrónica o escrita
Correo electrónico de participante	email	True	string	Correo electrónico del participante
Autenticación	authenticationMethod		string	Autenticación predeterminada: correo electrónico (Ninguno)
Contraseña	password		string	La contraseña necesaria para el participante
Código de país	countryCode		string	Código de país de teléfono del destinatario necesario para ver y firmar el documento
Teléfono No.	phone		string	Número de teléfono del destinatario necesario para ver y firmar el contrato
Pedido	order	True	integer	Índice a partir de 1, que indica la posición en la que el grupo de firma debe firmar.
Rol	role	True	string	Los roles actuales del conjunto de participantes (firmante, aprobador, etc.).
Message	message		string	Un mensaje opcional para los destinatarios que solicitan su acción
Correo Electrónico	email		string	El correo electrónico del CC del contrato
Hora de expiración	expirationTime		string	Hora después de la cual expira el Contrato. Ejemplo: 2020-12-31T23:59:00Z
Frecuencia de recordatorio	reminderFrequency		string	¿Con qué frecuencia desea enviar recordatorios?
Contraseña del documento	openPassword		string	Contraseña que se debe usar para cifrar el pdf del contrato firmado
Nombre	fieldName		string	Nombre del campo
Importancia	defaultValue		string	Valor predeterminado del campo
Retraso de redirección	redirectDelay		string	Retraso (en segundos) antes de que el usuario se tome en la página correcta.
Dirección URL de redireccionamiento	redirectUrl		string	Dirección URL para redirigir después de completar el proceso de firma, por ejemplo, https://adobe.com
Correos electrónicos iniciales	initEmails		string	Controlar los correos electrónicos de notificación para los eventos de inicio del contrato.

Devoluciones

Json que contiene el identificador del contrato recién creado.

Body: AgreementCreationResponseV6

Creación de una plantilla de biblioteca a partir de un documento cargado

Id. de la operación:: CreateLibraryDocumentById_V2

Esta operación crea una plantilla en la biblioteca adobe Acrobat Sign a partir de un documento cargado. Use esta plantilla para enviar contratos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de libro	name	True	string	Nombre del contrato usado para identificar la plantilla
Tipo de plantilla	templateTypes	True	array of string	Lista de uno o varios tipos de plantilla de biblioteca
Modo de uso compartido	sharingMode	True	string	Especifica quién debe tener acceso a este documento de biblioteca.
identificación	transientDocumentId	True	string	Identificador de documento recibido cargando un documento transitorio
Estado de plantilla	state	True	string	Estado del documento de biblioteca.

Devoluciones

Objeto JSON que describe la plantilla de biblioteca

Body: LibraryDocumentCreationResponseV6

Creación de una plantilla de biblioteca a partir de una dirección URL de documento

Id. de la operación:: CreateLibraryDocumentByUrl_V2

Esta operación crea una plantilla en la biblioteca adobe Acrobat Sign a partir de una dirección URL del documento. Usar esta plantilla para enviar contratos

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre de libro	name	True	string	Nombre del contrato usado para identificar la plantilla
Tipo de plantilla	templateTypes	True	array of string	Lista de uno o varios tipos de plantilla de biblioteca
Modo de uso compartido	sharingMode	True	string	Especifica quién debe tener acceso a este documento de biblioteca.
URL	url	True	string	Dirección URL accesible públicamente para recuperar el contenido del archivo sin procesar
Nombre	name	True	string	Nombre de archivo del sistema original del documento que se envía
Tipo	mimeType	True	string	Tipo mime del archivo al que se hace referencia, por ejemplo, application/pdf
Estado de plantilla	state	True	string	Estado del documento de biblioteca.

Devoluciones

Objeto JSON que describe la plantilla de biblioteca

Body: LibraryDocumentCreationResponseV6

Obtención de datos de campo de formulario de acuerdo en formato CSV

Id. de la operación:: GetAgreementFormFieldData_V2

Recupera los datos introducidos en los campos de formulario interactivo del contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	Identificador de contrato del contrato cuya información es necesaria

Devoluciones

Contenido de los datos del formulario

Contenido de datos del formulario: binary

Obtención de datos de campo de formulario de acuerdo en formato JSON

Id. de la operación:: GetAgreementFormFieldData_V3

Recupera los datos introducidos en los campos de formulario interactivo del contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	Identificador de contrato del contrato cuya información es necesaria

Devoluciones

Contenido de los datos del formulario

Contenido de datos del formulario: object

Obtener datos de campo de formulario del contrato (antiguo) [EN DESUSO]

Id. de la operación:: GetAgreementFormFieldData

Recupera los datos introducidos en los campos de formulario interactivo del contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	Identificador de contrato del contrato cuya información es necesaria

Devoluciones

response: file

Obtener el estado de un contrato

Id. de la operación:: GetAgreementInfo_V2

Esta operación captura toda la información actual de un contrato, como el estado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	Identificador de contrato del contrato cuya información es necesaria

Devoluciones

Detalles del contrato completo

Body: AgreementInfoV6

Obtener un documento de un contrato

Id. de la operación:: GetDocument_V2

Esta operación captura la secuencia de archivos de un documento específico del contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	Identificador de contrato del contrato cuyo documento es necesario
Id. de documento	documentId	True	string	Identificador de documento del documento específico del contrato

Devoluciones

Secuencia de archivos del documento

response: DocumentResponse

Obtener un PDF de un contrato firmado

Id. de la operación:: GetCombinedDocument_V2

Esta operación captura la secuencia de archivos PDF del contrato combinado o firmado. Tenga en cuenta que la secuencia de archivos debe almacenarse con un nombre de archivo que termine en .pdf extensión de archivo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	El identificador de contrato proporcionado por la acción que crea el contrato.
¿Adjuntar documentos auxiliares?	attachSupportingDocuments		boolean	Si es true, adjunte documentos auxiliares al PDF del contrato firmado.
¿Adjuntar informe de auditoría?	attachAuditReport		boolean	Si es true, adjunte un informe de auditoría al PDF del contrato firmado.

Devoluciones

Secuencia de archivos del documento

response: CombinedDocumentResponse

Obtener una lista de todas las plantillas de biblioteca

Id. de la operación:: GetLibraryDocuments_V2

Esta operación captura la lista de todos los documentos almacenados como plantillas en la biblioteca adobe Acrobat Sign del usuario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Cursor	cursor		string	Se usa para navegar por las páginas. Si no se proporciona, devuelve la primera página.
Tamaño de página	pageSize		integer	Número de elementos de la página de respuesta. De forma predeterminada: 100; Máximo: 10000

Devoluciones

Json que contiene el objeto de matriz de plantillas de biblioteca

Body: LibraryDocuments

Obtener una lista de todos los contratos

Id. de la operación:: GetAllAgreements_V2

Esta operación captura la lista de todos los contratos del usuario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Cursor	cursor		string	Se usa para navegar por las páginas. Si no se proporciona, devuelve la primera página.
Tamaño de página	pageSize		integer	Número de elementos de la página de respuesta. De forma predeterminada: 100; Máximo: 10000

Devoluciones

Json que contiene el objeto de matriz de contrato de usuario

Body: userAgreementListV6

Obtener una lista de todos los identificadores de documento de un contrato

Id. de la operación:: GetAllDocumentsofAnAgreement_V2

Esta operación captura los identificadores de todos los documentos y los documentos auxiliares de un contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	El identificador de contrato del contrato cuyos documentos son necesarios.
Documentos auxiliares: tipo de contenido	supportingDocumentContentFormat		string	Tipo de contenido de los documentos auxiliares del contrato

Devoluciones

Json que contiene los documentos y los objetos de matriz de documentos auxiliares

Body: AgreementDocumentsV6

Recuperación de la dirección URL de firma

Id. de la operación:: GetSigningUrls

Esta operación recupera la dirección URL de la página de inicio de sesión electrónico de los firmantes actuales de un contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de contrato	agreementId	True	string	El identificador de contrato proporcionado por la acción que crea el contrato.

Devoluciones

Body: SigningUrlResponse

Desencadenadores

Cuando cambia el estado de un contrato	Desencadena un nuevo flujo cuando cambia el estado de un contrato. Trata los eventos de contrato más comunes, como la creación, la finalización, etc.
Cuando se completa correctamente un flujo de trabajo de contrato	Desencadena un nuevo flujo cuando se completa correctamente un flujo de trabajo de contrato.
Cuando se crea un nuevo contrato	Desencadena un nuevo flujo cuando se crea un nuevo contrato.
Cuando se envía un contrato a un participante	Desencadena un nuevo flujo cuando se envía un contrato a un participante.
Cuando se produce un evento	Desencadena un nuevo flujo cuando se produce un evento. Cubre todos los eventos Agreement, Mega Sign y Widget.

Cuando cambia el estado de un contrato

Id. de la operación:: CreateWebhookForAgreementStatusUpdated

Desencadena un nuevo flujo cuando cambia el estado de un contrato. Trata los eventos de contrato más comunes, como la creación, la finalización, etc.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre del desencadenador
Ámbito	scope	True	string	Ámbito del desencadenador
Nombre o identificador del contrato	resourceId		string	Especifique solo cuando "Ámbito" sea "Un contrato específico". Seleccione un contrato de la lista o escriba el identificador del contrato.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Eventos para los que se debe desencadenar el flujo
¿Incluir información del contrato?	includeDetailedInfo		boolean	¿Se debe enviar información detallada del contrato en la notificación?
¿Incluir información de participante del contrato?	includeParticipantsInfo		boolean	¿Debe enviarse la información del participante del contrato en la notificación?
¿Incluir información del documento del contrato?	includeDocumentsInfo		boolean	¿Debe enviarse la información del documento del contrato en la notificación?
¿Incluir información del documento firmado por el contrato?	includeSignedDocuments		boolean	¿Debe enviarse una copia final del documento firmado en notificación de finalización del contrato?

Devoluciones

Body: WebhookPayloadWithSignedDocumentForStatusChange

Cuando se completa correctamente un flujo de trabajo de contrato

Id. de la operación:: CreateWebhookForAgreementSignedEvent

Desencadena un nuevo flujo cuando se completa correctamente un flujo de trabajo de contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre del desencadenador
Ámbito	scope	True	string	Ámbito del desencadenador
Nombre o identificador del contrato	resourceId		string	Especifique solo cuando "Ámbito" sea "Un contrato específico". Seleccione un contrato de la lista o escriba el identificador del contrato.
Subscription	webhookSubscriptionEvents	True	array of string	Eventos para los que se debe desencadenar el flujo
¿Incluir información del contrato?	includeDetailedInfo		boolean	¿Se debe enviar información detallada del contrato en la notificación?
¿Incluir información de participante del contrato?	includeParticipantsInfo		boolean	¿Debe enviarse la información del participante del contrato en la notificación?
¿Incluir información del documento del contrato?	includeDocumentsInfo		boolean	¿Debe enviarse la información del documento del contrato en la notificación?
¿Incluir información del documento firmado por el contrato?	includeSignedDocuments		boolean	¿Debe enviarse una copia final del documento firmado al finalizar el contrato en la notificación?

Devoluciones

Body: WebhookPayloadWithSignedDocument

Cuando se crea un nuevo contrato

Id. de la operación:: CreateWebhookForAgreementCreatedEvent

Desencadena un nuevo flujo cuando se crea un nuevo contrato.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre del desencadenador
Ámbito	scope	True	string	Ámbito del desencadenador
Subscription	webhookSubscriptionEvents	True	array of string	Eventos para los que se debe desencadenar el flujo
¿Incluir información del contrato?	includeDetailedInfo		boolean	¿Se debe enviar información detallada del contrato en la notificación?
¿Incluir información de participante del contrato?	includeParticipantsInfo		boolean	¿Debe enviarse la información del participante del contrato en la notificación?

Devoluciones

Body: WebhookPayloadWithoutNextParticipantSet

Cuando se envía un contrato a un participante

Id. de la operación:: CreateWebhookForAgreementSignatureRequestedEvent

Desencadena un nuevo flujo cuando se envía un contrato a un participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre del desencadenador
Ámbito	scope	True	string	Ámbito del desencadenador
Nombre o identificador del contrato	resourceId		string	Especifique solo cuando "Ámbito" sea "Un contrato específico". Seleccione un contrato de la lista o escriba el identificador del contrato.
Subscription	webhookSubscriptionEvents	True	array of string	Eventos para los que se debe desencadenar el flujo
¿Incluir información del contrato?	includeDetailedInfo		boolean	¿Se debe enviar información detallada del contrato en la notificación?
¿Incluir información de participante del contrato?	includeParticipantsInfo		boolean	¿Debe enviarse la información del participante del contrato en la notificación?
¿Incluir información del documento del contrato?	includeDocumentsInfo		boolean	¿Debe enviarse la información del documento del contrato en la notificación?

Devoluciones

Body: WebhookPayload

Cuando se produce un evento

Id. de la operación:: CreateWebhookGeneric

Desencadena un nuevo flujo cuando se produce un evento. Cubre todos los eventos Agreement, Mega Sign y Widget.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre	name	True	string	Nombre del desencadenador
Ámbito	scope	True	string	Ámbito del desencadenador
Tipo de recurso	resourceType		string	Especifique solo cuando "Ámbito" sea "Un recurso específico". Seleccione el tipo de recurso para el que se debe desencadenar el flujo.
Identificador del recurso	resourceId		string	Especifique solo cuando "Ámbito" sea "Un recurso específico". Escriba el contrato o el identificador de mega sign o widget para el que se debe desencadenar el flujo.
webhookSubscriptionEvents	webhookSubscriptionEvents	True	array of string	Eventos para los que se debe desencadenar el flujo
¿Incluir información del contrato?	includeDetailedInfo		boolean	¿Se debe enviar información detallada del contrato en la notificación?
¿Incluir información de participante del contrato?	includeParticipantsInfo		boolean	¿Debe enviarse la información del participante del contrato en la notificación?
¿Incluir información del documento del contrato?	includeDocumentsInfo		boolean	¿Debe enviarse la información del documento del contrato en la notificación?
¿Incluir información del documento firmado por el contrato?	includeSignedDocuments		boolean	¿Debe enviarse una copia final del documento firmado al finalizar el contrato en la notificación?
¿Incluye información de MegaSign?	includeDetailedInfo		boolean	¿Se debe enviar información detallada de mega sign en la notificación?
¿Incluye información de widget?	includeDetailedInfo		boolean	¿Se debe enviar información detallada del widget en la notificación?
¿Incluir información de participante del widget?	includeParticipantsInfo		boolean	¿Se debe enviar la información del participante del widget en la notificación?
¿Incluir información de documentos de widget?	includeDocumentsInfo		boolean	¿Se debe enviar la información del documento del widget en la notificación?

Devoluciones

Body: WebhookPayloadGeneric

Definiciones

AgreementCreationResponseV6

Json que contiene el identificador del contrato recién creado.

Nombre	Ruta de acceso	Tipo	Description
Id. de contrato	id	string	Identificador único del contrato que se puede usar para consultar el estado y descargar documentos firmados.

AgreementDocumentsV6

Json que contiene los documentos y los objetos de matriz de documentos auxiliares

Nombre	Ruta de acceso	Tipo	Description
Documentos	documents	array of DocumentV6	Lista de objetos que representan los documentos
Documentos auxiliares	supportingDocuments	array of SupportingDocumentV6	Lista de documentos auxiliares. Esto solo se devuelve si hay algún documento auxiliar en el contrato.

AgreementInfoV6

Detalles del contrato completo

Nombre	Ruta de acceso	Tipo	Description
Id. de contrato	id	string	Un identificador único que se puede usar para identificar de forma única el contrato.
Fecha de creación	createdDate	date	Fecha en la que se creó el contrato
Primer retraso de recordatorio	firstReminderDelay	integer	Entero que especifica el retraso en horas antes de enviar el primer aviso.
Frecuencia de recordatorio	reminderFrequency	string	¿Con qué frecuencia desea enviar recordatorios?
Fecha de expiración	expiration	date	Fecha después de la cual el contrato ya no se puede firmar
Configuración regional	locale	string	Configuración regional asociada a este contrato, por ejemplo, en_US o fr_FR
Message	message	string	Mensaje asociado al contrato que el remitente ha proporcionado.
Nombre del contrato	name	string	Nombre del contrato, especificado por el remitente.
¿Visibilidad del documento?	documentVisibilityEnabled	boolean	¿Está habilitada la visibilidad del documento?
Conjuntos de participantes	participantSetsInfo	array of ParticipantSetInfoV6	Información sobre todos los conjuntos de participantes de este documento
Tipo de firma	signatureType	string	Especifica el tipo de firma solicitado: firma electrónica o escrito.
Opciones de seguridad	securityOptions	string	Información de seguridad sobre el documento que especifica si se requiere o no una contraseña para ver y firmarla
Estado	status	string	Estado actual del contrato
Correo electrónico del remitente	senderEmail	string	El correo electrónico del remitente
Id. de flujo de trabajo	workflowId	string	Identificador del flujo de trabajo personalizado que define la ruta de enrutamiento de un contrato.
Ccs	ccs	array of CcInfo	Lista de uno o varios CCs que se copiarán en la transacción del contrato.

CombinedDocumentResponse

Secuencia de archivos del documento

Contenido del archivo: binary

DisplayUserInfo

Nombre	Ruta de acceso	Tipo	Description
Empresa	company	string	Muestra el nombre de la empresa del usuario, si está disponible.
Correo Electrónico	email	string	Muestra el correo electrónico del usuario
Nombre completo	fullName	string	Muestra el nombre completo del usuario, si está disponible.

DisplayUserSetInfo

Nombre	Ruta de acceso	Tipo	Description
Mostrar información del conjunto de usuarios	displayUserSetMemberInfos	array of DisplayUserInfo	Muestra la información sobre el conjunto de usuarios.
Mostrar nombre del conjunto de usuarios	displayUserSetName	string

DocumentV6

Información sobre el documento

Nombre	Ruta de acceso	Tipo	Description
Id. de documento	id	string	Identificador único del documento
Tipo mime	mimeType	string	Tipo Mime del documento
Nombre	name	string	Nombre del documento
Páginas de número	numPages	integer	Número de páginas del documento

DocumentResponse

Secuencia de archivos del documento

Contenido del archivo: binary

ParticipantSetInfoV6

Nombre	Ruta de acceso	Tipo	Description
Información de miembro del conjunto de participantes	memberInfos	array of MemberInfosV6	Información sobre los miembros del conjunto de destinatarios
Pedido	order	integer	Índice que indica la posición en la que el grupo de firma debe firmar.
Rol	role	string	Los roles actuales del conjunto de participantes (firmante, aprobador, etc.).
Nombre del conjunto de participantes	name	string	Nombre del conjunto de participantes
Message privado del conjunto de participantes	privateMessage	string	Mensaje privado para los participantes del conjunto
Páginas visibles del conjunto de participantes	visiblePages	array of string	Páginas visibles para el conjunto de participantes

MemberInfosV6

Nombre	Ruta de acceso	Tipo	Description
Correo electrónico de participante	email	string	Correo electrónico del participante
Autenticación	securityOption.authenticationMethod	string	Autenticación predeterminada: correo electrónico (Ninguno)
Contraseña	securityOption.password	string	La contraseña necesaria para el participante
Código de país	securityOption.phoneInfo.countryCode	string	Código de país de teléfono del destinatario necesario para ver y firmar el documento
Teléfono No.	securityOption.phoneInfo.phone	string	Número de teléfono del destinatario necesario para ver y firmar el contrato

SigningUrl

Nombre	Ruta de acceso	Tipo	Description
Correo electrónico para la dirección URL de inicio de sesión	email	string	Dirección de correo electrónico del firmante asociado a esta dirección URL de firma
Dirección URL de inicio de sesión	esignUrl	string	Dirección URL del firmante asociado a esta dirección URL de firma

SigningUrlResponse

Nombre	Ruta de acceso	Tipo	Description
Matriz de direcciones URL para conjuntos de firmantes	signingUrlSetInfos	array of SigningUrlSetInfo	Matriz de direcciones URL para conjuntos de firmantes implicados en este contrato

SigningUrlSetInfo

Nombre	Ruta de acceso	Tipo	Description
- Matriz de direcciones URL de firma	signingUrls	array of SigningUrl	Matriz de direcciones URL para el conjunto de firmantes actual
- Nombre del conjunto de direcciones URL de inicio de sesión	signingUrlSetName	string	Nombre del conjunto de firmantes actual

Compatibilidad conDocumentV6

Información sobre el documento auxiliar

Nombre	Ruta de acceso	Tipo	Description
Nombre de documento auxiliar	displayLabel	string	Nombre para mostrar del documento auxiliar
Nombre de campo de documento auxiliar	fieldName	string	Nombre del campo de documento auxiliar
Tipo mime de documento auxiliar	mimeType	string	Tipo Mime del documento auxiliar
Páginas de documentos auxiliares	numPages	integer	Número de páginas del documento auxiliar
Id. de documento auxiliar	id	string	Identificador único que representa el documento auxiliar

TransientDocumentResponse

Json que contiene el identificador del documento cargado

Nombre	Ruta de acceso	Tipo	Description
Id. de documento	transientDocumentId	string	Identificador de documento del documento cargado

UserAgreementV6

Nombre	Ruta de acceso	Tipo	Description
Mostrar información del conjunto de usuarios	displayParticipantSetInfos	array of DisplayUserSetInfo	El usuario actual más relevante establecido para el contrato. Normalmente es el siguiente firmante si el contrato es del usuario actual o el remitente si se recibe de otro usuario.
Fecha de presentación	displayDate	string	La fecha de presentación del contrato
Esign	esign	boolean	True si se trata de un documento de firma electrónica
Oculto	hidden	boolean	True si el contrato está oculto para el usuario
Identificador de grupo	groupId	string	Identificador único del grupo
Identificador de versión más reciente	latestVersionId	string	Identificador de versión que identifica de forma única la versión actual del contrato
Nombre	name	string	Nombre del Contrato
Id. primario	parentId	string	Identificador primario de un elemento secundario de megaSign O el identificador de origen de una instancia de contrato de widget
Id. de contrato	id	string	Identificador único del contrato
Estado	status	string	Estado actual del contrato
Tipo	type	string	El tipo de acuerdo

userAgreementListV6

Json que contiene el objeto de matriz de contrato de usuario

Nombre	Ruta de acceso	Tipo	Description
página	page	page	Información de paginación para navegar por la respuesta
Lista de contratos	userAgreementList	array of UserAgreementV6	Matriz de elementos de contrato

página

Información de paginación para navegar por la respuesta

Nombre	Ruta de acceso	Tipo	Description
nextCursor	nextCursor	string	Se usa para navegar a la página siguiente. Si no se devuelve, no hay más páginas.

WebhookPayload

Nombre	Ruta de acceso	Tipo	Description
Event	event	string	Evento que se ha producido en el recurso.
Fecha de evento	eventDate	date	Fecha del evento. El formato sería aaaa-MM-dd'T'HH:mm:ssZ. Por ejemplo, por ejemplo, 2016-02-25T18:46:19Z representa la hora UTC.
Tipo de recurso de evento	eventResourceType	string	Recurso en el que se ha producido el evento.
Tipo primario del contrato	eventResourceParentType	string	Información sobre el recurso desde el que se crea el contrato. Valores posibles: Widget o Mega Sign
Identificador primario del contrato	eventResourceParentId	string	Un identificador único del recurso desde el que se crea este contrato.
Rol de participante del evento	participantRole	string	Rol del participante para el evento.
Id. de participante del evento	participantUserId	string	Identificador del participante del evento.
Correo electrónico del participante del evento	participantUserEmail	string	El correo electrónico del participante para el evento.
Identificador de usuario de acción de eventos	actingUserId	string	Identificador del usuario que creó el evento.
Correo electrónico de usuario de acción de eventos	actingUserEmail	string	Correo electrónico del usuario que creó el evento.
Dirección IP del usuario de acción de eventos	actingUserIpAddress	string	Dirección IP del usuario que creó el evento
Id. de usuario de inicio de eventos	initiatingUserId	string	Identificador del usuario que inició el evento en nombre del usuario que actúa.
Correo electrónico del usuario que inicia eventos	initiatingUserEmail	string	El correo electrónico del usuario que inició el evento en nombre del usuario que actúa.
Notificación de usuarios aplicables	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista de usuarios para los que se aplica esta notificación
Agreement	agreement	WebhookAgreementInfo	Información completa del contrato

ApplicableUsers

La información sobre los usuarios para los que se aplica esta notificación

Nombre	Ruta de acceso	Tipo	Description
Identificador de usuario aplicable a la notificación	id	string	Identificador único del usuario para el que se aplica esta notificación.
Correo electrónico de usuario aplicable a la notificación	email	string	El correo electrónico del usuario para el que se aplica esta notificación
Rol de usuario aplicable a la notificación	role	string	Rol del usuario en el flujo de trabajo para el que se genera esta notificación
¿Es el usuario aplicable a la carga?	payloadApplicable	boolean	Si los datos proporcionados en esta notificación son aplicables a este usuario o no

WebhookPayloadWithoutNextParticipantSet

Nombre	Ruta de acceso	Tipo	Description
Event	event	string	Evento que se ha producido en el recurso.
Fecha de evento	eventDate	date	Fecha del evento. El formato sería aaaa-MM-dd'T'HH:mm:ssZ. Por ejemplo, por ejemplo, 2016-02-25T18:46:19Z representa la hora UTC.
Tipo de recurso de evento	eventResourceType	string	Recurso en el que se ha producido el evento.
Tipo primario del contrato	eventResourceParentType	string	Información sobre el recurso desde el que se crea el contrato. Valores posibles: Widget o Mega Sign
Identificador primario del contrato	eventResourceParentId	string	Un identificador único del recurso desde el que se crea este contrato.
Id. de participante del evento	participantUserId	string	Identificador del participante del evento.
Correo electrónico del participante del evento	participantUserEmail	string	El correo electrónico del participante para el evento.
Identificador de usuario de acción de eventos	actingUserId	string	Identificador del usuario que creó el evento.
Correo electrónico de usuario de acción de eventos	actingUserEmail	string	Correo electrónico del usuario que creó el evento.
Dirección IP del usuario de acción de eventos	actingUserIpAddress	string	Dirección IP del usuario que creó el evento
Id. de usuario de inicio de eventos	initiatingUserId	string	Identificador del usuario que inició el evento en nombre del usuario que actúa.
Correo electrónico del usuario que inicia eventos	initiatingUserEmail	string	El correo electrónico del usuario que inició el evento en nombre del usuario que actúa.
Notificación de usuarios aplicables	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista de usuarios para los que se aplica esta notificación
Agreement	agreement	WebhookAgreementInfoWithoutNextParticipantSet	Información completa del contrato

WebhookPayloadWithSignedDocumentForStatusChange

Nombre	Ruta de acceso	Tipo	Description
Event	event	string	Evento que se ha producido en el recurso.
Fecha de evento	eventDate	date	Fecha del evento. El formato sería aaaa-MM-dd'T'HH:mm:ssZ. Por ejemplo, por ejemplo, 2016-02-25T18:46:19Z representa la hora UTC.
Sub (evento)	subEvent	string	Sub evento que se ha producido en un recurso.
Tipo primario del contrato	eventResourceParentType	string	Información sobre el recurso desde el que se crea el contrato. Valores posibles: Widget o Mega Sign
Identificador primario del contrato	eventResourceParentId	string	Un identificador único del recurso desde el que se crea este contrato.
Id. de participante del evento	participantUserId	string	Identificador del participante del evento.
Correo electrónico del participante del evento	participantUserEmail	string	El correo electrónico del participante para el evento.
Identificador de usuario de acción de eventos	actingUserId	string	Identificador del usuario que creó el evento.
Correo electrónico de usuario de acción de eventos	actingUserEmail	string	Correo electrónico del usuario que creó el evento.
Dirección IP del usuario de acción de eventos	actingUserIpAddress	string	Dirección IP del usuario que creó el evento
Tipo de acción	actionType	string	Acción para la que se ha producido el evento.
Id. de usuario de inicio de eventos	initiatingUserId	string	Identificador del usuario que inició el evento en nombre del usuario que actúa.
Correo electrónico del usuario que inicia eventos	initiatingUserEmail	string	El correo electrónico del usuario que inició el evento en nombre del usuario que actúa.
Tipo de recurso de evento	eventResourceType	string	Recurso en el que se ha producido el evento.
Rol de participante del evento	participantRole	string	Rol del participante para el evento.
Notificación de usuarios aplicables	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista de usuarios para los que se aplica esta notificación
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Información completa del contrato

WebhookPayloadWithSignedDocument

Nombre	Ruta de acceso	Tipo	Description
Event	event	string	Evento que se ha producido en el recurso.
Fecha de evento	eventDate	date	Fecha del evento. El formato sería aaaa-MM-dd'T'HH:mm:ssZ. Por ejemplo, por ejemplo, 2016-02-25T18:46:19Z representa la hora UTC.
Tipo primario del contrato	eventResourceParentType	string	Información sobre el recurso desde el que se crea el contrato. Valores posibles: Widget o Mega Sign
Identificador primario del contrato	eventResourceParentId	string	Un identificador único del recurso desde el que se crea este contrato.
Tipo de recurso de evento	eventResourceType	string	Recurso en el que se ha producido el evento.
Rol de participante del evento	participantRole	string	Rol del participante para el evento.
Id. de participante del evento	participantUserId	string	Identificador del participante del evento.
Correo electrónico del participante del evento	participantUserEmail	string	El correo electrónico del participante para el evento.
Identificador de usuario de acción de eventos	actingUserId	string	Identificador del usuario que creó el evento.
Correo electrónico de usuario de acción de eventos	actingUserEmail	string	Correo electrónico del usuario que creó el evento.
Dirección IP del usuario de acción de eventos	actingUserIpAddress	string	Dirección IP del usuario que creó el evento
Id. de usuario de inicio de eventos	initiatingUserId	string	Identificador del usuario que inició el evento en nombre del usuario que actúa.
Correo electrónico del usuario que inicia eventos	initiatingUserEmail	string	El correo electrónico del usuario que inició el evento en nombre del usuario que actúa.
Notificación de usuarios aplicables	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista de usuarios para los que se aplica esta notificación
Agreement	agreement	WebhookAgreementInfoWithSignedDocument	Información completa del contrato

WebhookPayloadGeneric

Nombre	Ruta de acceso	Tipo	Description
Event	event	string	Evento que se ha producido en el recurso.
Fecha de evento	eventDate	date	Fecha del evento. El formato sería aaaa-MM-dd'T'HH:mm:ssZ. Por ejemplo, por ejemplo, 2016-02-25T18:46:19Z representa la hora UTC.
Sub (evento)	subEvent	string	Sub evento que se ha producido en un recurso.
Tipo primario del contrato	eventResourceParentType	string	Información sobre el recurso desde el que se crea el contrato. Valores posibles: Widget o Mega Sign
Identificador primario del contrato	eventResourceParentId	string	Un identificador único del recurso desde el que se crea este contrato.
Tipo de recurso de evento	eventResourceType	string	Recurso en el que se ha producido el evento.
Rol de participante del evento	participantRole	string	Rol del participante para el evento.
Id. de participante del evento	participantUserId	string	Identificador del participante del evento.
Correo electrónico del participante del evento	participantUserEmail	string	El correo electrónico del participante para el evento.
Identificador de usuario de acción de eventos	actingUserId	string	Identificador del usuario que creó el evento.
Correo electrónico de usuario de acción de eventos	actingUserEmail	string	Correo electrónico del usuario que creó el evento.
Id. de usuario de inicio de eventos	initiatingUserId	string	Identificador del usuario que inició el evento en nombre del usuario que actúa.
Correo electrónico del usuario que inicia eventos	initiatingUserEmail	string	El correo electrónico del usuario que inició el evento en nombre del usuario que actúa.
Tipo de acción	actionType	string	Acción para la que se ha producido el evento.
Dirección IP del usuario de acción de eventos	actingUserIpAddress	string	Dirección IP del usuario que creó el evento
Notificación de usuarios aplicables	webhookNotificationApplicableUsers	array of ApplicableUsers	Lista de usuarios para los que se aplica esta notificación
Agreement	agreement	WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo	Información completa del contrato
Mega Sign	megaSign	WebhookMegaSignInfo	La información completa del mega sign
Widget	widget	WebhookWidgetInfo	La información completa del widget

WebhookAgreementInfo

Información completa del contrato

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del contrato
Nombre	name	string	Nombre del contrato
Tipo de firma	signatureType	string	Especifica el tipo de firma solicitado: firma electrónica o escrito.
Estado	status	string	Estado actual del contrato
Ccs	ccs	array of CcInfo	Lista de uno o varios CCs que se copiarán en la transacción del contrato.
Fecha de creación	createdDate	date	Fecha en la que se creó el contrato
Hora de expiración	expirationTime	string	Tiempo después del cual expira el Contrato y debe firmarse antes de que expire.
External ID	externalId.id	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Grupo externo	externalId.group	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Primer retraso de recordatorio	firstReminderDelay	integer	Entero que especifica el retraso en horas antes de enviar el primer aviso.
Configuración regional	locale	string	Configuración regional asociada a este contrato
Message	message	string	Un mensaje opcional para los participantes, que describe lo que se envía o por qué se requiere su firma.
Frecuencia de recordatorio	reminderFrequency	string	Parámetro opcional que establece la frecuencia con la que desea enviar recordatorios a los participantes. Si no se especifica, se usará la frecuencia predeterminada establecida para la cuenta.
Correo electrónico del remitente	senderEmail	string	Correo electrónico del remitente del contrato
¿Se ha habilitado el almacenamiento en almacenes?	vaultingInfo.enabled	boolean	En el caso de las cuentas configuradas para el almacén de documentos y la opción de habilitar por contrato, esto determina si el documento se va a guardar en el almacén.
¿Visibilidad del documento?	documentVisibilityEnabled	boolean	¿Está habilitada la visibilidad del documento?
Id. de flujo de trabajo	workflowId	string	Identificador del flujo de trabajo personalizado que define la ruta de enrutamiento de un contrato.
Dirección URL de redireccionamiento de inicio de sesión posterior	postSignOption.redirectUrl	string	Dirección URL accesible públicamente a la que se enviará el usuario después de completar correctamente el proceso de firma.
Conjuntos de participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	El participante establece información
Conjuntos de participantes siguientes	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	El siguiente participante establece información
Documentos	documentsInfo.documents	array of WebhookDocument	Lista de objetos que representan los documentos
Documentos auxiliares	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Lista de documentos auxiliares

WebhookAgreementInfoWithoutNextParticipantSet

Información completa del contrato

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del contrato
Nombre	name	string	Nombre del contrato
Tipo de firma	signatureType	string	Especifica el tipo de firma solicitado: firma electrónica o escrito.
Estado	status	string	Estado actual del contrato
Ccs	ccs	array of CcInfo	Lista de uno o varios CCs que se copiarán en la transacción del contrato.
Fecha de creación	createdDate	date	Fecha en la que se creó el contrato
¿Visibilidad del documento?	documentVisibilityEnabled	boolean	¿Está habilitada la visibilidad del documento?
Hora de expiración	expirationTime	string	Tiempo después del cual expira el Contrato y debe firmarse antes de que expire.
External ID	externalId.id	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Grupo externo	externalId.group	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Primer retraso de recordatorio	firstReminderDelay	integer	Entero que especifica el retraso en horas antes de enviar el primer aviso.
Configuración regional	locale	string	Configuración regional asociada a este contrato
Message	message	string	Un mensaje opcional para los participantes, que describe lo que se envía o por qué se requiere su firma.
Frecuencia de recordatorio	reminderFrequency	string	Parámetro opcional que establece la frecuencia con la que desea enviar recordatorios a los participantes. Si no se especifica, se usará la frecuencia predeterminada establecida para la cuenta.
Correo electrónico del remitente	senderEmail	string	Correo electrónico del remitente del contrato
¿Se ha habilitado el almacenamiento en almacenes?	vaultingInfo.enabled	boolean	En el caso de las cuentas configuradas para el almacén de documentos y la opción de habilitar por contrato, esto determina si el documento se va a guardar en el almacén.
Dirección URL de redireccionamiento de inicio de sesión posterior	postSignOption.redirectUrl	string	Dirección URL accesible públicamente a la que se enviará el usuario después de completar correctamente el proceso de firma.
Id. de flujo de trabajo	workflowId	string	Identificador del flujo de trabajo personalizado que define la ruta de enrutamiento de un contrato.
Conjuntos de participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	El participante establece información

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Información completa del contrato

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del contrato
Nombre	name	string	Nombre del contrato
Tipo de firma	signatureType	string	Especifica el tipo de firma solicitado: firma electrónica o escrito.
Estado	status	string	Estado actual del contrato
Ccs	ccs	array of CcInfo	Lista de uno o varios CCs que se copiarán en la transacción del contrato.
Fecha de creación	createdDate	date	Fecha en la que se creó el contrato
Hora de expiración	expirationTime	string	Tiempo después del cual expira el Contrato y debe firmarse antes de que expire.
External ID	externalId.id	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Grupo externo	externalId.group	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Primer retraso de recordatorio	firstReminderDelay	integer	Entero que especifica el retraso en horas antes de enviar el primer aviso.
Configuración regional	locale	string	Configuración regional asociada a este contrato
Message	message	string	Un mensaje opcional para los participantes, que describe lo que se envía o por qué se requiere su firma.
Frecuencia de recordatorio	reminderFrequency	string	Parámetro opcional que establece la frecuencia con la que desea enviar recordatorios a los participantes. Si no se especifica, se usará la frecuencia predeterminada establecida para la cuenta.
Dirección URL de redireccionamiento de inicio de sesión posterior	postSignOption.redirectUrl	string	Dirección URL accesible públicamente a la que se enviará el usuario después de completar correctamente el proceso de firma.
Id. de flujo de trabajo	workflowId	string	Identificador del flujo de trabajo personalizado que define la ruta de enrutamiento de un contrato.
Correo electrónico del remitente	senderEmail	string	Correo electrónico del remitente del contrato
¿Visibilidad del documento?	documentVisibilityEnabled	boolean	¿Está habilitada la visibilidad del documento?
¿Se ha habilitado el almacenamiento en almacenes?	vaultingInfo.enabled	boolean	En el caso de las cuentas configuradas para el almacén de documentos y la opción de habilitar por contrato, esto determina si el documento se va a guardar en el almacén.
Conjuntos de participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	El participante establece información
Conjuntos de participantes siguientes	participantSetsInfo.nextParticipantSets	array of WebhookParticipantSets	El siguiente participante establece información
Documentos	documentsInfo.documents	array of WebhookDocument	Lista de objetos que representan los documentos
Documentos auxiliares	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Una lista de documentos auxiliares Se devuelve solo si hay algún documento auxiliar en el contrato.
Información del documento firmado	signedDocumentInfo.document	string	Cadena codificada en base64 del documento firmado

WebhookAgreementInfoWithSignedDocument

Información completa del contrato

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del contrato
Nombre	name	string	Nombre del contrato
Tipo de firma	signatureType	string	Especifica el tipo de firma solicitado: firma electrónica o escrito.
Estado	status	string	Estado actual del contrato
Ccs	ccs	array of CcInfo	Lista de uno o varios CCs que se copiarán en la transacción del contrato.
Fecha de creación	createdDate	date	Fecha en la que se creó el contrato
¿Visibilidad del documento?	documentVisibilityEnabled	boolean	¿Está habilitada la visibilidad del documento?
Hora de expiración	expirationTime	string	Tiempo después del cual expira el Contrato y debe firmarse antes de que expire.
External ID	externalId.id	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Grupo externo	externalId.group	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Primer retraso de recordatorio	firstReminderDelay	integer	Entero que especifica el retraso en horas antes de enviar el primer aviso.
Configuración regional	locale	string	Configuración regional asociada a este contrato
Message	message	string	Un mensaje opcional para los participantes, que describe lo que se envía o por qué se requiere su firma.
Frecuencia de recordatorio	reminderFrequency	string	Parámetro opcional que establece la frecuencia con la que desea enviar recordatorios a los participantes. Si no se especifica, se usará la frecuencia predeterminada establecida para la cuenta.
Correo electrónico del remitente	senderEmail	string	Correo electrónico del remitente del contrato
¿Se ha habilitado el almacenamiento en almacenes?	vaultingInfo.enabled	boolean	En el caso de las cuentas configuradas para el almacén de documentos y la opción de habilitar por contrato, esto determina si el documento se va a guardar en el almacén.
Dirección URL de redireccionamiento de inicio de sesión posterior	postSignOption.redirectUrl	string	Dirección URL accesible públicamente a la que se enviará el usuario después de completar correctamente el proceso de firma.
Id. de flujo de trabajo	workflowId	string	Identificador del flujo de trabajo personalizado que define la ruta de enrutamiento de un contrato.
Conjuntos de participantes	participantSetsInfo.participantSets	array of WebhookParticipantSets	El participante establece información
Documentos	documentsInfo.documents	array of WebhookDocument	Lista de objetos que representan los documentos
Documentos auxiliares	documentsInfo.supportingDocuments	array of WebhookSupportingDocument	Una lista de documentos auxiliares Se devuelve solo si hay algún documento auxiliar en el contrato.
Información del documento firmado	signedDocumentInfo.document	string	Cadena codificada en base64 del documento firmado

WebhookMegaSignInfo

La información completa del mega sign

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del megasign
Nombre	name	string	Nombre del megasign
Estado	status	string	Estado del megasign
Ccs	ccs	array of MegaSignCcInfo	Lista de una o varias direcciones de correo electrónico que desea copiar en este megasign.
External ID	externalId.id	string	Valor arbitrario del sistema, que se puede especificar en el momento del envío y, a continuación, se devuelve o consulta más adelante.
Primer retraso de recordatorio	firstReminderDelay	integer	Entero que especifica el retraso en horas antes de enviar el primer aviso.
Configuración regional	locale	string	Configuración regional asociada a este contrato
Message	message	string	Un mensaje opcional para los participantes, que describe lo que se envía o por qué se requiere su firma.
Dirección URL de redireccionamiento de inicio de sesión posterior	postSignOption.redirectUrl	string	Dirección URL accesible públicamente a la que se enviará el usuario después de completar correctamente el proceso de firma.
Correo electrónico del remitente	senderEmail	string	Correo electrónico del creador de megasignes
Tipo de firma	signatureType	string	Especifica el tipo de firma solicitado: firma electrónica o escrito.
¿Se ha habilitado el almacenamiento en almacenes?	vaultingInfo.enabled	boolean	En el caso de las cuentas configuradas para el almacén de documentos y la opción de habilitar por contrato, esto determina si el documento se va a guardar en el almacén.
Información del archivo de contratos secundarios	childAgreementsInfo.fileInfo	MegaSignChildAgreementsFileInfo	Información de archivo que contiene información de contrato por niño de megaSign.

WebhookWidgetInfo

La información completa del widget

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del widget
Nombre	name	string	Nombre del widget
Estado	status	string	Estado del widget
Información de error de autenticación	authFailureInfo	AuthFailureWidgetRedirectionInfo	Url y propiedades asociadas para la página de error que el firmante del widget se tomará después de no autenticarse
Ccs	ccs	array of WidgetCcInfo	Lista de una o varias direcciones de correo electrónico que desea copiar en este widget.
Fecha de creación	createdDate	date	Fecha en la que se creó el widget
Información de finalización	completionInfo	WidgetCompletionRedirectionInfo	Dirección URL y propiedades asociadas para la página correcta en la que se realizará el firmante del widget después de realizar la acción deseada en el widget
Correo electrónico del creador	creatorEmail	string	El correo electrónico del creador del widget
¿Se ha habilitado el almacenamiento en almacenes?	vaultingInfo.enabled	boolean	En el caso de las cuentas configuradas para el almacén de documentos y la opción de habilitar por contrato, esto determina si el documento se va a guardar en el almacén.
Información adicional de conjuntos de participantes	participantSetsInfo.additionalParticipantSets	array of WidgetParticipantSetInfo	Lista de todos los participantes en el widget, excepto el firmante del widget
Primer rol de conjunto de participantes	participantSetsInfo.widgetParticipantSet.role	string	Rol asumido por todos los participantes del conjunto (firmante, aprobador, etc.)
Orden establecido del primer participante	participantSetsInfo.widgetParticipantSet.order	integer	Índice que indica el grupo de firma secuencial (especificado para el enrutamiento híbrido)
Documentos	documentsInfo.documents	array of WidgetWebhookDocument	Lista de objetos que representan los documentos

AuthFailureWidgetRedirectionInfo

Url y propiedades asociadas para la página de error que el firmante del widget se tomará después de no autenticarse

Nombre	Ruta de acceso	Tipo	Description
Retraso de redirección de errores de autenticación	delay	integer	Retraso (en segundos) antes de que el usuario se tome en la página resultante.
Deframe de redirección de error de autenticación	deframe	boolean	Si el deframe es false, la página resultante se mostrará dentro del marco del widget.
Dirección URL de redireccionamiento de errores de autenticación	url	string	Dirección URL accesible públicamente a la que se enviará el usuario después de completar correctamente el widget

WidgetCompletionRedirectionInfo

Dirección URL y propiedades asociadas para la página correcta en la que se realizará el firmante del widget después de realizar la acción deseada en el widget

Nombre	Ruta de acceso	Tipo	Description
Retraso de redirección de finalización	delay	integer	Retraso (en segundos) antes de que el usuario se tome en la página resultante.
Deframe de redirección de finalización	deframe	boolean	Si el deframe es false, la página resultante se mostrará dentro del marco del widget.
Dirección URL de redireccionamiento de finalización	url	string	Dirección URL accesible públicamente a la que se enviará el usuario después de completar correctamente el widget

WebhookParticipantSets

Nombre	Ruta de acceso	Tipo	Description
Información de miembro	memberInfos	array of MemberInfos	La información sobre los miembros del participante
Pedido	order	integer	Índice que indica la posición en la que el grupo de firma debe firmar.
Rol	role	string	Rol asumido por todos los participantes del conjunto (firmante, aprobador, etc.)
Estado	status	string	Estado actual del contrato desde la perspectiva del usuario
identificación	id	string	Identificador del conjunto de participantes
Nombre	name	string	Nombre del conjunto de participantes
Mensaje privado	privateMessage	string	Mensaje privado para los participantes del conjunto

MegaSignChildAgreementsFileInfo

Información de archivo que contiene información de contrato por niño de megaSign.

Nombre	Ruta de acceso	Tipo	Description
Id. de archivo de contratos secundarios	childAgreementsInfoFileId	string	Identificador del archivo que contiene información sobre el elemento childAgreementsInfo existente del megaSign.

WidgetWebhookDocument

Información sobre el documento del widget

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del documento
Nombre	name	string	Nombre del documento

WebhookDocument

Información sobre el documento del contrato

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del documento
Nombre	name	string	Nombre del documento

WebhookSupportingDocument

Información sobre el documento auxiliar

Nombre	Ruta de acceso	Tipo	Description
Nombre	displayLabel	string	Nombre para mostrar del documento auxiliar
Nombre del campo	fieldName	string	Nombre del campo de documento auxiliar
identificación	id	string	Identificador único que representa el documento auxiliar

WidgetCcInfo

Información sobre el CC del widget

Nombre	Ruta de acceso	Tipo	Description
Correo Electrónico	email	string	Correo electrónico del participante cc del widget

MegaSignCcInfo

La información sobre el CC del mega sign

Nombre	Ruta de acceso	Tipo	Description
Correo Electrónico	email	string	Correo electrónico del participante cc del megasign

CcInfo

Información sobre el CC del contrato

Nombre	Ruta de acceso	Tipo	Description
Correo Electrónico	email	string	El correo electrónico del CC del contrato
Etiqueta	label	string	Etiqueta de la lista CC tal y como se devuelve en la descripción del flujo de trabajo
Páginas visibles	visiblePages	array of string	Páginas visibles para el CC

WidgetParticipantSetInfo

Nombre	Ruta de acceso	Tipo	Description
Rol	role	string	Rol asumido por todos los participantes del conjunto (firmante, aprobador, etc.)
identificación	id	string	Identificador único del conjunto de participantes
Información de miembro	memberInfos	array of MemberInfos	La información sobre los miembros del participante
Pedido	order	integer	Índice que indica el grupo de firma secuencial (especificado para el enrutamiento híbrido)

MemberInfos

Nombre	Ruta de acceso	Tipo	Description
identificación	id	string	Identificador único del participante
Correo Electrónico	email	string	Correo electrónico del participante
Empresa	company	string	La empresa del participante
Nombre	name	string	Nombre del participante
Mensaje privado	privateMessage	string	Mensaje privado del participante
Estado	status	string	Estado del participante

LibraryDocumentCreationResponseV6

Objeto JSON que describe la plantilla de biblioteca

Nombre	Ruta de acceso	Tipo	Description
Id. de plantilla de biblioteca	id	string	Identificador único que se puede usar para hacer referencia a la plantilla de biblioteca

LibraryDocument

Nombre	Ruta de acceso	Tipo	Description
Id. de plantilla de biblioteca	id	string	Identificador único que se usa para hacer referencia a la plantilla de biblioteca
Oculto	hidden	boolean	True si el documento de biblioteca está oculto
Tipos de plantilla	templateTypes	array of string	Lista de uno o varios tipos de plantilla de biblioteca
Fecha de modificación	modifiedDate	date	El día en el que se modificó por última vez la plantilla de biblioteca
Nombre de plantilla de biblioteca	name	string	Nombre de la plantilla de biblioteca
Modo de uso compartido de plantillas	sharingMode	string	Ámbito de visibilidad de la plantilla de biblioteca
Correo electrónico del creador	creatorEmail	string	Dirección de correo electrónico del creador del documento de biblioteca.
Identificador de grupo	groupId	string	Identificador único del grupo al que pertenece la plantilla de biblioteca.
Estado	status	string	Estado del documento de biblioteca

LibraryDocuments

Json que contiene el objeto de matriz de plantillas de biblioteca

Nombre	Ruta de acceso	Tipo	Description
página	page	page	Información de paginación para navegar por la respuesta
Lista de plantillas de biblioteca	libraryDocumentList	array of LibraryDocument	Lista de elementos de plantilla de biblioteca

binary

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

objeto

Este es el tipo 'objeto'.

archivo

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