Espacio aislado de Adobe Acrobat Sign
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 |
|---|---|---|
| Copilot Studio | Estándar | 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 | Estándar | 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 | Estándar | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con 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 |
Espacio aislado de Adobe Acrobat Sign
Adobe Acrobat Sign Sandbox es una cuenta de nivel empresarial modificada en un entorno discreto del entorno de producción. El propósito del espacio aislado es permitir que los administradores prueben las configuraciones de configuración, las llamadas API, las plantillas de biblioteca, los flujos de trabajo personalizados y las nuevas características que se están aproximando a la versión.
Publicador: Adobe, Inc.
Prerrequisitos
Se requiere la cuenta de Adobe Acrobat Sign.
Obtención de credenciales
N/A
Introducción al conector
N/A
Problemas y limitaciones conocidos
N/A
Errores y soluciones comunes
N/A
Preguntas más frecuentes
Guía del usuario del conector https://helpx.adobe.com/sign/using/adobesign-sandbox.html
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 250 | 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. |
| Cargar un documento y obtener un identificador de documento (antiguo) [EN DESUSO] |
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 contenido de archivo y envío para la firma |
Esta operación crea un contrato a partir de un archivo en Adobe Acrobat Sign y lo envía para su firma. |
| 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 un flujo de trabajo y envío para la firma |
Esta operación crea un contrato a partir de un flujo de trabajo 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 |
| Crear un contrato a partir de un documento cargado y enviar para la firma (anterior) [EN DESUSO] |
Esta operación crea un contrato a partir de un documento cargado en Adobe Acrobat Sign y lo envía para su firma. |
| Crear un contrato a partir de una dirección URL de documento y enviar para la firma (anterior) [EN DESUSO] |
Esta operación crea un contrato a partir de un documento cargado en Adobe Acrobat Sign y lo envía para su firma. |
| Crear un contrato a partir de una plantilla de biblioteca y enviar para la firma (anterior) [EN DESUSO] |
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. |
| Crear una plantilla de biblioteca a partir de un documento cargado (antiguo) [EN DESUSO] |
Esta operación crea una plantilla en la biblioteca adobe Acrobat Sign a partir de un documento cargado. Use esta plantilla para enviar contratos. |
| Crear una plantilla de biblioteca a partir de una dirección URL de documento (antigua) [EN DESUSO] |
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. |
| Obtención de la información detallada del flujo de trabajo |
Esta operación captura fragmentos detallados de información sobre el flujo de trabajo. |
| 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 el estado de un contrato [EN DESUSO] |
Esta acción ha quedado en desuso. Use Obtener el estado de un contrato en su lugar.
|
| Obtener un documento de un contrato |
Esta operación captura la secuencia de archivos de un documento específico del contrato. |
| Obtener un documento de un contrato [EN DESUSO] |
Esta acción ha quedado en desuso. Use Obtener un documento de un contrato en su lugar.
|
| Obtener un PDF de la pista de auditoría del contrato |
Esta operación captura el flujo de archivos PDF de la pista de auditoría del contrato. Tenga en cuenta que la secuencia de archivos debe almacenarse con un nombre de archivo que termine en .pdf extensión de archivo. |
| 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 un PDF de un contrato firmado [EN DESUSO] |
Esta acción ha quedado en desuso. Use obtener un PDF de un contrato firmado en su lugar.
|
| 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 todas las plantillas de biblioteca (antiguas) [EN DESUSO] |
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 acuerdos basados en criterios de búsqueda |
Esta operación busca acuerdos por criterios como el identificador de flujo de trabajo, etc. |
| 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 contratos (Antiguo) [EN DESUSO] |
Esta operación captura la lista de todos los contratos del usuario. |
| Obtener una lista de todos los flujos de trabajo |
Esta operación captura la lista de todos los flujos de trabajo del usuario. |
| Obtener una lista de todos los formularios web |
Esta operación captura la lista de todos los formularios web del usuario. |
| Obtener una lista de todos los grupos a los que pertenece el usuario |
Esta operación captura la lista de todos los grupos a los que pertenece el 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. |
| Obtener una lista de todos los identificadores de documento de un contrato [EN DESUSO] |
Esta acción ha quedado en desuso. Use Obtener una lista de todos los identificadores de documento de un contrato en su lugar.
|
| 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
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. |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
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
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 |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
Devoluciones
Json que contiene el identificador del documento cargado
Cargar un documento y obtener un identificador de documento (antiguo) [EN DESUSO]
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
Creación de un contrato a partir de un contenido de archivo y envío para la firma
Esta operación crea un contrato a partir de un archivo en Adobe Acrobat Sign y lo envía para su firma.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Nombre del contrato
|
name | True | string |
Nombre del contrato |
|
Nombre
|
fileName | True | string |
Nombre del documento que se va a cargar, con extensión |
|
Content
|
formData | True | byte |
Secuencia de archivos del documento que se va a cargar |
|
Tipo de firma
|
signatureType | True | string |
Tipo de firma que desea solicitar: firma electrónica o escrita |
|
Correo electrónico de participante
|
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.). |
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
|
|
Message
|
message | string |
Un mensaje opcional para los destinatarios que solicitan su acción |
|
|
Correo Electrónico
|
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.
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.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
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
|
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.). |
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
|
|
Message
|
message | string |
Un mensaje opcional para los destinatarios que solicitan su acción |
|
|
Correo Electrónico
|
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.
Creación de un contrato a partir de un flujo de trabajo y envío para la firma
Esta operación crea un contrato a partir de un flujo de trabajo en Adobe Acrobat Sign y lo envía para su firma.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | True | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
Nombre o identificador del grupo
|
groupId | True | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
|
Nombre o identificador del flujo de trabajo
|
workflowIdParam | True | string |
Seleccione flujo de trabajo personalizado en la lista o escriba el identificador de flujo de trabajo personalizado. |
|
agreementWorkflowSchema
|
agreementWorkflowSchema | True | dynamic |
Detalles del evento seleccionado. |
Devoluciones
Json que contiene el identificador del contrato recién creado.
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.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
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
|
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.). |
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
|
|
Message
|
message | string |
Un mensaje opcional para los destinatarios que solicitan su acción |
|
|
Correo Electrónico
|
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.
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.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
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
|
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.). |
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
|
|
Message
|
message | string |
Un mensaje opcional para los destinatarios que solicitan su acción |
|
|
Correo Electrónico
|
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.
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.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
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. |
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
Devoluciones
Objeto JSON que describe la plantilla de biblioteca
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
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
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. |
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
Devoluciones
Objeto JSON que describe la plantilla de biblioteca
Crear un contrato a partir de un documento cargado y enviar para la firma (anterior) [EN DESUSO]
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 |
|
Id. de documento
|
transientDocumentId | True | string |
El identificador de documento recibido mediante la carga de un documento |
|
Tipo de firma
|
signatureType | True | string |
Tipo de firma que desea solicitar: firma electrónica o escrita |
|
Correo electrónico del destinatario
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Message
|
message | string |
Un mensaje opcional para los destinatarios que solicitan su acción |
|
|
Días a fecha límite
|
daysUntilSigningDeadline | integer |
Número de días que permanecen antes de que expire el documento. |
|
|
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 |
|
|
Id. de documento (2)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (3)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (4)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (5)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (6)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (7)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (8)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (9)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (10)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Correo electrónico del destinatario (2)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (2)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (2)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (3)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (3)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (3)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (4)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (4)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (4)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (5)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (5)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (5)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (6)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (6)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (6)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (7)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (7)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (7)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (8)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (8)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (8)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (9)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (9)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (9)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico de destinatario (10)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (10)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (10)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (11)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (11)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (11)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (12)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (12)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (12)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (13)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (13)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (13)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (14)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (14)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (14)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (15)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (15)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (15)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (16)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (16)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (16)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (17)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (17)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (17)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (18)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (18)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (18)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (19)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (19)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (19)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (20)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (20)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (20)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (21)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (21)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (21)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (22)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (22)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (22)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (23)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (23)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (23)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (24)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (24)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (24)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (25)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (25)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (25)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Nombre del campo de formulario (1)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (1)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (2)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (2)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (3)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (3)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (4)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (4)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (5)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (5)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (6)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (6)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (7)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (7)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (8)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (8)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (9)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (9)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (10)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (10)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (11)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (11)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (12)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (12)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (13)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (13)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (14)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (14)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (15)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (15)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (16)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (16)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (17)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (17)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (18)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (18)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (19)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (19)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (20)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (20)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (21)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (21)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (22)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (22)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (23)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (23)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (24)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (24)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (25)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (25)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (26)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (26)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (27)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (27)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (28)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (28)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (29)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (29)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (30)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (30)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (31)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (31)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (32)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (32)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (33)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (33)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (34)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (34)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (35)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (35)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (36)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (36)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (37)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (37)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (38)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (38)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (39)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (39)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (40)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (40)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (41)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (41)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (42)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (42)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (43)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (43)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (44)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (44)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (45)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (45)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (46)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (46)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (47)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (47)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (48)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (48)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (49)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (49)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (50)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (50)
|
defaultValue | string |
Valor predeterminado del campo |
Devoluciones
Json que contiene el identificador del contrato recién creado.
Crear un contrato a partir de una dirección URL de documento y enviar para la firma (anterior) [EN DESUSO]
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 documento |
|
Nombre
|
name | True | string |
Nombre del documento al que se hace referencia, con extensión |
|
Tipo de firma
|
signatureType | True | string |
Tipo de firma que desea solicitar: firma electrónica o escrita |
|
Correo electrónico del destinatario
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Message
|
message | string |
Un mensaje opcional para los destinatarios que solicitan su acción |
|
|
Días a fecha límite
|
daysUntilSigningDeadline | integer |
Número de días que permanecen antes de que expire el documento. |
|
|
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 |
|
|
Dirección URL (2)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (2)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (3)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (3)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (4)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (4)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (5)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (5)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (6)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (6)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (7)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (7)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (8)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (8)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (9)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (9)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (10)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (10)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Correo electrónico del destinatario (2)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (2)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (2)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (3)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (3)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (3)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (4)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (4)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (4)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (5)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (5)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (5)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (6)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (6)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (6)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (7)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (7)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (7)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (8)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (8)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (8)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (9)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (9)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (9)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico de destinatario (10)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (10)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (10)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (11)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (11)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (11)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (12)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (12)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (12)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (13)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (13)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (13)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (14)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (14)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (14)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (15)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (15)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (15)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (16)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (16)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (16)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (17)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (17)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (17)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (18)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (18)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (18)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (19)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (19)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (19)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (20)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (20)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (20)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (21)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (21)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (21)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (22)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (22)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (22)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (23)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (23)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (23)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (24)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (24)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (24)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (25)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (25)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (25)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Nombre del campo de formulario (1)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (1)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (2)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (2)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (3)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (3)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (4)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (4)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (5)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (5)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (6)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (6)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (7)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (7)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (8)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (8)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (9)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (9)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (10)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (10)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (11)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (11)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (12)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (12)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (13)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (13)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (14)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (14)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (15)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (15)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (16)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (16)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (17)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (17)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (18)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (18)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (19)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (19)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (20)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (20)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (21)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (21)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (22)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (22)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (23)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (23)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (24)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (24)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (25)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (25)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (26)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (26)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (27)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (27)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (28)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (28)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (29)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (29)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (30)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (30)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (31)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (31)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (32)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (32)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (33)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (33)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (34)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (34)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (35)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (35)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (36)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (36)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (37)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (37)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (38)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (38)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (39)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (39)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (40)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (40)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (41)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (41)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (42)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (42)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (43)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (43)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (44)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (44)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (45)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (45)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (46)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (46)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (47)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (47)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (48)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (48)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (49)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (49)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (50)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (50)
|
defaultValue | string |
Valor predeterminado del campo |
Devoluciones
Json que contiene el identificador del contrato recién creado.
Crear un contrato a partir de una plantilla de biblioteca y enviar para la firma (anterior) [EN DESUSO]
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 |
|
Plantilla de biblioteca de documentos
|
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 del destinatario
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Message
|
message | string |
Un mensaje opcional para los destinatarios que solicitan su acción |
|
|
Días a fecha límite
|
daysUntilSigningDeadline | integer |
Número de días que permanecen antes de que expire el documento. |
|
|
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 |
|
|
Plantilla de biblioteca de documentos (2)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (3)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (4)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (5)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (6)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (7)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (8)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (9)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Plantilla de biblioteca de documentos (10)
|
libraryDocumentId | string |
Elegir un documento de las plantillas almacenadas en la biblioteca |
|
|
Correo electrónico del destinatario (2)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (2)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (2)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (3)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (3)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (3)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (4)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (4)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (4)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (5)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (5)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (5)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (6)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (6)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (6)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (7)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (7)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (7)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (8)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (8)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (8)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (9)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (9)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (9)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico de destinatario (10)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (10)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (10)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (11)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (11)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (11)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (12)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (12)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (12)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (13)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (13)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (13)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (14)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (14)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (14)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (15)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (15)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (15)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (16)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (16)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (16)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (17)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (17)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (17)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (18)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (18)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (18)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (19)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (19)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (19)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (20)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (20)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (20)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (21)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (21)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (21)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (22)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (22)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (22)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (23)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (23)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (23)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (24)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (24)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol destinatario (24)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Correo electrónico del destinatario (25)
|
True | string |
Correo electrónico del destinatario |
|
|
Orden de firma de destinatarios (25)
|
signingOrder | True | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Rol de destinatario (25)
|
recipientSetRole | True | string |
Especificar el rol del destinatario |
|
Nombre del campo de formulario (1)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (1)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (2)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (2)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (3)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (3)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (4)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (4)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (5)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (5)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (6)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (6)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (7)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (7)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (8)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (8)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (9)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (9)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (10)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (10)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (11)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (11)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (12)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (12)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (13)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (13)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (14)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (14)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (15)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (15)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (16)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (16)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (17)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (17)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (18)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (18)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (19)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (19)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (20)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (20)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (21)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (21)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (22)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (22)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (23)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (23)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (24)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (24)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (25)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (25)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (26)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (26)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (27)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (27)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (28)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (28)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (29)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (29)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (30)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (30)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (31)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (31)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (32)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (32)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (33)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (33)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (34)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (34)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (35)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (35)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (36)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (36)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (37)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (37)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (38)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (38)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (39)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (39)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (40)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (40)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (41)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (41)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (42)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (42)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (43)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (43)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (44)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (44)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (45)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (45)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (46)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (46)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (47)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (47)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (48)
|
fieldName | string |
Nombre del campo |
|
|
Valor del campo de formulario (48)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (49)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (49)
|
defaultValue | string |
Valor predeterminado del campo |
|
|
Nombre del campo de formulario (50)
|
fieldName | string |
Nombre del campo |
|
|
Valor de campo de formulario (50)
|
defaultValue | string |
Valor predeterminado del campo |
Devoluciones
Json que contiene el identificador del contrato recién creado.
Crear una plantilla de biblioteca a partir de un documento cargado (antiguo) [EN DESUSO]
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
|
libraryTemplateTypes | True | string |
Lista de uno o varios tipos de plantilla de biblioteca |
|
Uso compartido con
|
librarySharingMode | True | string |
Especifica quién debe tener acceso a este documento de biblioteca. |
|
Id. de documento
|
transientDocumentId | True | string |
El identificador de documento recibido mediante la carga de un documento |
|
Id. de documento (2)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (3)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (4)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (5)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (6)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (7)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (8)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (9)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
|
|
Id. de documento (10)
|
transientDocumentId | string |
El identificador de documento recibido mediante la carga de un documento |
Devoluciones
Objeto JSON que describe la plantilla de biblioteca
Crear una plantilla de biblioteca a partir de una dirección URL de documento (antigua) [EN DESUSO]
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
|
libraryTemplateTypes | True | string |
Lista de uno o varios tipos de plantilla de biblioteca |
|
Uso compartido con
|
librarySharingMode | 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 documento |
|
Nombre
|
name | True | string |
Nombre del documento al que se hace referencia, con extensión |
|
Dirección URL (2)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (2)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (3)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (3)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (4)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (4)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (5)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (5)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (6)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (6)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (7)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (7)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (8)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (8)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
Dirección URL (9)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (9)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
|
|
DIRECCIÓN URL (10)
|
url | string |
Dirección URL accesible públicamente para recuperar el documento |
|
|
Nombre (10)
|
name | string |
Nombre del documento al que se hace referencia, con extensión |
Devoluciones
Objeto JSON que describe la plantilla de biblioteca
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.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de contrato
|
agreementId | True | string |
Identificador de contrato del contrato cuya información es necesaria |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
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
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 |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
Devoluciones
Contenido de los datos del formulario
- Contenido de datos del formulario
- object
Obtención de la información detallada del flujo de trabajo
Esta operación captura fragmentos detallados de información sobre el flujo de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de flujo de trabajo
|
workflowId | True | string |
Identificador de flujo de trabajo del flujo de trabajo cuya información es necesaria |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
Devoluciones
Json que contiene información detallada sobre el flujo de trabajo
Obtener datos de campo de formulario del contrato (antiguo) [EN DESUSO]
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
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 |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
Devoluciones
Detalles del contrato completo
- Body
- AgreementInfoV6
Obtener el estado de un contrato [EN DESUSO]
Esta acción ha quedado en desuso. Use Obtener el estado de un contrato en su lugar.
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 completos sobre el contrato
- Body
- AgreementInfo
Obtener un documento de un contrato
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 |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
Devoluciones
Secuencia de archivos del documento
- response
- DocumentResponse
Obtener un documento de un contrato [EN DESUSO]
Esta acción ha quedado en desuso. Use Obtener un documento de un contrato en su lugar.
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 la pista de auditoría del contrato
Esta operación captura el flujo de archivos PDF de la pista de auditoría del contrato. 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 |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Id. de contrato
|
agreementId | True | string |
Identificador de contrato del contrato cuya información es necesaria |
Devoluciones
Flujo de archivos de la pista de auditoría del contrato
- response
- AgreementAuditTrailResponse
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.
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. |
|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
Devoluciones
Secuencia de archivos del documento
- response
- CombinedDocumentResponse
Obtener un PDF de un contrato firmado [EN DESUSO]
Esta acción ha quedado en desuso. Use obtener un PDF de un contrato firmado en su lugar.
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?
|
auditReport | 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
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 |
|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
Devoluciones
Json que contiene el objeto de matriz de plantillas de biblioteca
- Body
- LibraryDocuments
Obtener una lista de todas las plantillas de biblioteca (antiguas) [EN DESUSO]
Esta operación captura la lista de todos los documentos almacenados como plantillas en la biblioteca adobe Acrobat Sign del usuario.
Devoluciones
Json que contiene el objeto de matriz de plantillas de biblioteca
- Body
- DocumentLibraryItems
Obtener una lista de todos los acuerdos basados en criterios de búsqueda
Esta operación busca acuerdos por criterios como el identificador de flujo de trabajo, etc.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
|
|
Nombre o identificador del flujo de trabajo
|
workflowId | string |
Seleccione flujo de trabajo personalizado en la lista o escriba el identificador de flujo de trabajo personalizado. |
|
|
Creado después
|
gt | string |
Fecha y hora mínima permitidas. Ejemplo: 2020-12-31T23:59:00Z |
|
|
Creado antes
|
lt | string |
Fecha y hora máxima permitidas. Ejemplo: 2023-12-31T23:59:00Z |
|
|
Tamaño de página
|
pageSize | integer |
Número de elementos de la página de respuesta. De forma predeterminada: 50; Máximo: 500 |
|
|
Índice inicial
|
startIndex | integer |
Primera fila basada en 0 (desplazamiento) de los resultados de búsqueda que se van a devolver. |
Devoluciones
Json que contiene el objeto de matriz de contrato de usuario
- Body
- userAgreementListV6
Obtener una lista de todos los contratos
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 |
|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
Devoluciones
Json que contiene el objeto de matriz de contrato de usuario
- Body
- userAgreementListV6
Obtener una lista de todos los contratos (Antiguo) [EN DESUSO]
Esta operación captura la lista de todos los contratos del usuario.
Devoluciones
Json que contiene el objeto de matriz de contrato de usuario
- Body
- UserAgreements
Obtener una lista de todos los flujos de trabajo
Esta operación captura la lista de todos los flujos de trabajo del usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Incluir flujos de trabajo de borrador
|
includeDraftWorkflows | boolean |
Incluir flujos de trabajo de borrador |
|
|
Incluir flujos de trabajo inactivos
|
includeInactiveWorkflows | boolean |
Incluir flujos de trabajo inactivos |
|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
Devoluciones
Json que contiene el objeto de matriz de flujo de trabajo de usuario
- Body
- userWorkflowListV6
Obtener una lista de todos los formularios web
Esta operación captura la lista de todos los formularios web 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 |
|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Nombre o identificador del grupo
|
groupId | string |
Id. del grupo. Para usar esto: el campo "En el nombre de" debe seleccionarse. |
Devoluciones
Json que contiene el objeto de matriz de formularios web de usuario
- Body
- userWidgetListV6
Obtener una lista de todos los grupos a los que pertenece el usuario
Esta operación captura la lista de todos los grupos a los que pertenece el usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
|
|
Id. de usuario
|
userId | True | string |
Para obtener el resultado del usuario autorizado, el identificador de usuario se puede reemplazar por "me" sin comillas. |
Devoluciones
Json que contiene la lista de grupos para un usuario determinado
- Body
- UserGroupsInfoV6
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.
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 |
|
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
Devoluciones
Json que contiene los documentos y los objetos de matriz de documentos auxiliares
- Body
- AgreementDocumentsV6
Obtener una lista de todos los identificadores de documento de un contrato [EN DESUSO]
Esta acción ha quedado en desuso. Use Obtener una lista de todos los identificadores de documento de un contrato en su lugar.
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
- AgreementDocuments
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.
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. |
|
En el nombre de
|
x-api-user | string |
El correo electrónico del llamador de API con el formato: correo electrónico:adobesignuser@domain.com |
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 Web Form. |
| Cuando se produce un evento de contrato de formulario web |
Desencadena un nuevo flujo cuando se produce un evento de contrato de formulario web. Trata los eventos de contrato más comunes, como la creación, la finalización, etc. |
| Cuando se produce un evento de grupo |
Desencadena un nuevo flujo cuando se produce un evento de grupo. Cubre todos los eventos Agreement, Mega Sign y Web Form. |
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.
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
Cuando se completa correctamente un flujo de trabajo de contrato
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
Cuando se crea un nuevo contrato
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
Cuando se envía un contrato a un participante
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
Desencadena un nuevo flujo cuando se produce un evento. Cubre todos los eventos Agreement, Mega Sign y Web Form.
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 mega sign o formulario web o id. de grupo 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? |
|
|
¿Incluir información de formulario web?
|
includeDetailedInfo | boolean |
¿Se debe enviar información detallada del formulario web en la notificación? |
|
|
¿Incluir información de participante del formulario web?
|
includeParticipantsInfo | boolean |
¿Debe enviarse la información del participante del formulario web en la notificación? |
|
|
¿Incluir información de documentos de formulario web?
|
includeDocumentsInfo | boolean |
¿Se debe enviar información del documento del formulario web en la notificación? |
Devoluciones
Cuando se produce un evento de contrato de formulario web
Desencadena un nuevo flujo cuando se produce un evento de contrato de formulario web. 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 |
|
Tamaño de página de formularios web Forms
|
pageSize | integer |
Seleccione el número de formularios web que se van a mostrar en la lista desplegable. |
|
|
Nombre o identificador del formulario web
|
resourceId | True | string |
Seleccione el formulario web de la lista o escriba el identificador del formulario web. |
|
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
Cuando se produce un evento de grupo
Desencadena un nuevo flujo cuando se produce un evento de grupo. Cubre todos los eventos Agreement, Mega Sign y Web Form.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
name | True | string |
Nombre del desencadenador |
|
Nombre o identificador del grupo
|
resourceId | string |
Identificador del grupo |
|
|
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? |
|
|
¿Incluir información de formulario web?
|
includeDetailedInfo | boolean |
¿Se debe enviar información detallada del formulario web en la notificación? |
|
|
¿Incluir información de participante del formulario web?
|
includeParticipantsInfo | boolean |
¿Debe enviarse la información del participante del formulario web en la notificación? |
|
|
¿Incluir información de documentos de formulario web?
|
includeDocumentsInfo | boolean |
¿Se debe enviar información del documento del formulario web en la notificación? |
Devoluciones
Definiciones
AgreementCreationResponse
Json que contiene el identificador del contrato recién creado.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de contrato
|
agreementId | string |
Identificador único del contrato que se puede usar para consultar el estado y descargar documentos firmados. |
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. |
AgreementDocuments
Json que contiene los documentos y los objetos de matriz de documentos auxiliares
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of Document |
Lista de objetos que representan los documentos |
|
Documentos auxiliares
|
supportingDocuments | array of SupportingDocument |
Lista de documentos auxiliares. Esto solo se devuelve si hay algún documento auxiliar en el contrato. |
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. |
AgreementInfo
Detalles completos sobre el contrato
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de contrato
|
agreementId | string |
Un identificador único que se puede usar para identificar de forma única el contrato. |
|
Eventos
|
events | array of DocumentHistoryEvent |
Lista ordenada de los eventos de la pista de auditoría de este documento |
|
Fecha de expiración
|
expiration | date |
Fecha después de la cual el contrato ya no se puede firmar |
|
Identificador de versión más reciente
|
latestVersionId | string |
Un identificador único que identifica de forma única la versión actual del contrato. |
|
Message
|
message | string |
Mensaje asociado al contrato que el remitente ha proporcionado. |
|
Nombre del contrato
|
name | string |
Nombre del contrato, especificado por el remitente. |
|
Conjuntos de participantes siguientes
|
nextParticipantSetInfos | array of NextParticipantSetInfo |
Información sobre quién debe actuar a continuación para este acuerdo |
|
Conjuntos de participantes
|
participantSetInfos | array of ParticipantSetInfo |
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. |
|
Protección de documentos
|
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 |
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. |
|
Identificador de grupo
|
groupId | string |
Identificador único del grupo al que pertenece el contrato. |
CombinedDocumentResponse
Secuencia de archivos del documento
Secuencia de archivos del documento
- Contenido del archivo
- binary
AgreementAuditTrailResponse
Flujo de archivos de la pista de auditoría del contrato
Flujo de archivos de la pista de auditoría del contrato
- Contenido de la pista de auditoría del contrato
- 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
|
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 |
Documento
Información sobre el documento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de documento
|
documentId | 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 |
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 |
DocumentHistoryEvent
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Iniciador de eventos
|
actingUserEmail | string |
Dirección de correo electrónico del usuario que inició el evento |
|
Fecha de evento
|
date | date |
La fecha del evento de auditoría |
|
Descripción del evento
|
description | string |
Descripción del evento de auditoría |
|
Correo electrónico de participante
|
participantEmail | string |
Dirección de correo electrónico del usuario que inició el evento |
|
Tipo de evento
|
type | string |
Tipo de evento de contrato |
DocumentLibraryItem
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de plantilla de biblioteca
|
libraryDocumentId | string |
Identificador único del documento de biblioteca que se usa al enviar el documento que se va a firmar. |
|
Tipos de plantilla de biblioteca
|
libraryTemplateTypes | 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
|
scope | string |
Ámbito de visibilidad de la plantilla de biblioteca |
DocumentLibraryItems
Json que contiene el objeto de matriz de plantillas de biblioteca
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Lista de plantillas de biblioteca
|
libraryDocumentList | array of DocumentLibraryItem |
Lista de elementos de plantilla de biblioteca |
DocumentResponse
Secuencia de archivos del documento
Secuencia de archivos del documento
- Contenido del archivo
- binary
LibraryDocumentCreationResponse
Objeto JSON que describe la plantilla de biblioteca
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de plantilla de biblioteca
|
libraryDocumentId | string |
Identificador único que se puede usar para hacer referencia a la plantilla de biblioteca |
NextParticipantInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Correo Electrónico
|
string |
Dirección de correo electrónico del siguiente participante |
|
|
Nombre
|
name | string |
Nombre del siguiente participante, si está disponible. |
|
Esperando desde
|
waitingSince | date |
Fecha desde la que el documento ha estado esperando a que el participante tome medidas |
NextParticipantSetInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Siguiente conjunto de participantes: información de miembro
|
nextParticipantSetMemberInfos | array of NextParticipantInfo |
Información sobre los miembros del siguiente conjunto de participantes |
ParticipantInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Empresa
|
company | string |
La empresa del participante, si está disponible |
|
Correo Electrónico
|
string |
Dirección de correo electrónico del participante |
|
|
Nombre
|
name | string |
Nombre del participante, si está disponible. |
|
ID del participante
|
participantId | string |
Identificador único del participante |
|
Opciones de seguridad
|
securityOptions | array of string |
Opciones de seguridad que se aplican al participante |
|
Title
|
title | string |
Título del participante, si está disponible. |
ParticipantSetInfo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. del conjunto de participantes
|
participantSetId | string |
Identificador único del conjunto de participantes |
|
Información de miembro del conjunto de participantes
|
participantSetMemberInfos | array of ParticipantInfo |
Información sobre los miembros del conjunto de destinatarios |
|
Mensaje privado
|
privateMessage | string |
Mensaje privado para los participantes del conjunto |
|
Rol
|
roles | array of string |
Roles actuales del conjunto de participantes. Un conjunto de participantes puede tener uno o varios roles |
|
securityOptions
|
securityOptions | array of string |
Opciones de seguridad que se aplican al participante |
|
Orden de firma
|
signingOrder | integer |
Índice a partir de 1, que indica el orden en el que este destinatario firma |
|
Estado del conjunto de participantes
|
status | string |
El participante establece el estado con respecto al documento. |
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
|
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
|
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 conDocument
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
|
supportingDocumentId | string |
Identificador único que representa el documento auxiliar |
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 |
UserAgreement
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de contrato
|
agreementId | string |
Un identificador único que se puede usar para identificar de forma única el contrato. |
|
Mostrar información del conjunto de usuarios
|
displayUserSetInfos | 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 | date |
La fecha de presentación del contrato |
|
Esign
|
esign | boolean |
True si se trata de un documento de firma electrónica |
|
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 |
|
Estado
|
status | string |
Estado actual del contrato |
UserAgreements
Json que contiene el objeto de matriz de contrato de usuario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Lista de contratos
|
userAgreementList | array of UserAgreement |
Matriz de elementos de contrato |
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 formulario web |
|
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: Formulario web 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
|
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: Formulario web 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: Formulario web 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: Formulario web 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: Formulario web 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 |
|
Formulario web
|
widget | WebhookWidgetInfo |
La información completa del formulario web |
WebFormWebhookAgreementEventPayload
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Event
|
event | string |
Evento de contrato que se ha producido en el formulario web. |
|
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 |
Evento secundario que se ha producido en un formulario web. |
|
Tipo primario del contrato: formulario web
|
eventResourceParentType | string |
Valor que indica que se crea un contrato a partir del formulario web. |
|
Id. de formulario web
|
eventResourceParentId | string |
Identificador único del formulario web desde el que se crea este contrato |
|
Tipo de recurso de evento: contrato
|
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 |
GroupWebhookEventPayload
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Event
|
event | string |
Evento que se ha producido para un grupo. |
|
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 |
Evento secundario que se ha producido para un grupo. |
|
Tipo primario del contrato: formulario web
|
eventResourceParentType | string |
Información sobre el grupo desde el que se crea el contrato. |
|
Id. de formulario web
|
eventResourceParentId | string |
Identificador único del grupo desde el que se crea este contrato |
|
Tipo de recurso de evento: contrato
|
eventResourceType | string |
Grupo para 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 |
|
Formulario web
|
widget | WebhookWidgetInfo |
La información completa del formulario web |
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 formulario web
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador único del formulario web |
|
Nombre
|
name | string |
Nombre del formulario web |
|
Estado
|
status | string |
Estado del formulario web |
|
Información de error de autenticación
|
authFailureInfo | AuthFailureWidgetRedirectionInfo |
Url y propiedades asociadas para la página de error que el firmante del formulario web 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 formulario web. |
|
Fecha de creación
|
createdDate | date |
Fecha en la que se creó el formulario web |
|
Información de finalización
|
completionInfo | WidgetCompletionRedirectionInfo |
Dirección URL y propiedades asociadas para la página correcta a la que se llevará a cabo el firmante del formulario web después de realizar la acción deseada en el formulario web |
|
Correo electrónico del creador
|
creatorEmail | string |
Correo electrónico del creador del formulario web |
|
¿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 formulario web, excepto el firmante del formulario web |
|
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 formulario web 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 de formulario web. |
|
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 formulario web |
WidgetCompletionRedirectionInfo
Dirección URL y propiedades asociadas para la página correcta a la que se llevará a cabo el firmante del formulario web después de realizar la acción deseada en el formulario web
| 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 de formulario web. |
|
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 formulario web |
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 formulario web
| 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 formulario web
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Correo Electrónico
|
string |
Correo electrónico del participante cc del formulario web |
MegaSignCcInfo
La información sobre el CC del mega sign
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Correo Electrónico
|
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
|
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
|
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 |
UserWidgetV6
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de formulario web
|
id | string |
Identificador único de un formulario web |
|
Fecha de modificación
|
modifiedDate | string |
Fecha en la que se modificó por última vez el formulario web |
|
Oculto
|
hidden | boolean |
True si el contrato está oculto para el usuario |
|
Identificador de grupo
|
groupId | string |
Identificador único del grupo |
|
Nombre
|
name | string |
Nombre del formulario web |
|
Estado
|
status | string |
Estado del formulario web |
|
URL
|
url | string |
Dirección URL hospedada del formulario web |
|
Javascript
|
javascript | string |
Código javascript incrustado del formulario web |
userWidgetListV6
Json que contiene el objeto de matriz de formularios web de usuario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
página
|
page | page |
Información de paginación para navegar por la respuesta |
|
Lista de formularios web
|
userWidgetList | array of UserWidgetV6 |
Matriz de elementos de formulario web |
UserWorkflowV6
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de flujo de trabajo
|
id | string |
Identificador único de un flujo de trabajo |
|
Description
|
description | string |
Descripción proporcionada para este flujo de trabajo en el momento de su creación |
|
Fecha de creación
|
created | string |
Fecha en la que se creó el flujo de trabajo. El formato sería aaaa-MM-dd'T'HH:mm:ssZ |
|
Fecha de modificación
|
modified | string |
Fecha en la que se modificó el flujo de trabajo. El formato sería aaaa-MM-dd'T'HH:mm:ssZ |
|
Nombre
|
name | string |
Nombre del flujo de trabajo |
|
Nombre de pantalla
|
displayName | string |
Nombre para mostrar del flujo de trabajo |
|
Estado
|
status | string |
Estado del flujo de trabajo |
|
Ámbito
|
scope | string |
Ámbito del flujo de trabajo |
|
Id. del originador
|
originatorId | string |
Originador inicial del flujo de trabajo |
|
Identificador de ámbito
|
scopeId | string |
Identificador del ámbito. Actualmente solo es aplicable para el ámbito GROUP y el valor será groupId. |
userWorkflowListV6
Json que contiene el objeto de matriz de flujo de trabajo de usuario
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Lista de flujos de trabajo
|
userWorkflowList | array of UserWorkflowV6 |
Matriz de elementos de flujo de trabajo |
WorkflowDefaultParamsV6
Json que contiene el objeto params predeterminado del flujo de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Valor predeterminado
|
defaultValue | string |
Valor predeterminado del campo si no se proporciona la entrada para este campo y este campo es obligatorio |
|
Editable
|
editable | boolean |
Si se puede editar el campo actual. Si el atributo editable para este campo es false, este campo no se debe proporcionar en la solicitud de creación del contrato y el valor predeterminado de este campo se usará en la creación de acuerdos. |
|
Obligatorio
|
required | boolean |
Si este campo es obligatorio o opcional |
|
Visible
|
visible | boolean |
Indica si el campo actual está visible o no. Si el atributo visible para este campo es false, este campo no debe estar visible en la interfaz de usuario de creación de contratos mediante este flujo de trabajo para el usuario. |
CCsListInfoDescriptionV6
Json que contiene información detallada sobre el flujo de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Valores predeterminados
|
defaultValues | array of string |
Matriz de correos electrónicos predeterminados que se usarán si no se proporciona ninguna entrada para este elemento de lista |
|
Editable
|
editable | boolean |
Si se puede editar el campo actual. Si el atributo editable para este campo es false, este campo no se debe proporcionar en la solicitud de creación del contrato y el valor predeterminado de este campo se usará en la creación de acuerdos. |
|
Etiqueta
|
label | string |
Texto para mostrar del usuario de flujo de trabajo que se puede usar para la lista cc actual |
|
Número máximo de entradas cc
|
maxListCount | integer |
Número máximo de entradas permitidas en la lista cc actual |
|
Entradas de CC mínimas
|
minListCount | integer |
Número mínimo de entradas permitidas en la lista cc actual |
|
Nombre de lista cc
|
name | string |
Nombre de la lista cc actual |
|
Obligatorio
|
required | boolean |
Si este campo es obligatorio o opcional |
|
Visible
|
visible | boolean |
Indica si el campo actual está visible o no. Si el atributo visible para este campo es false, este campo no se debe mostrar en la página de creación de contratos mediante este flujo de trabajo. |
ExpirationFieldInfoDescriptionV6
Json que contiene información sobre la expiración
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Valor predeterminado
|
defaultValue | string |
Valor predeterminado del campo si no se proporciona la entrada para este campo y este campo es obligatorio |
|
Editable
|
editable | boolean |
Si se puede editar el campo actual. Si el atributo editable para este campo es false, este campo no se debe proporcionar en la solicitud de creación del contrato y el valor predeterminado de este campo se usará en la creación de acuerdos. |
|
Días máximos de expiración del contrato
|
maxDays | integer |
Número máximo de días para la expiración del contrato |
|
Obligatorio
|
required | boolean |
Si este campo es obligatorio o opcional |
|
Visible
|
visible | boolean |
Indica si el campo actual está visible o no. Si el atributo visible para este campo es false, este campo no se debe mostrar en la página de creación de contratos mediante este flujo de trabajo. |
FileInfosDescriptionV6
Json que contiene información sobre los archivos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Etiqueta
|
label | string |
Mostrar etiqueta de este campo para usuarios externos |
|
Nombre
|
name | string |
Nombre del elemento fileInfo |
|
Obligatorio
|
required | boolean |
Si este campo es obligatorio o opcional |
|
Documentos de la biblioteca de flujo de trabajo
|
workflowLibraryDocumentSelectorList | array of WorkflowLibraryDocumentV6 |
Lista de documentos de biblioteca de flujo de trabajo de los que se puede seleccionar un documento de biblioteca de flujo de trabajo con este objeto fileInfo |
WorkflowLibraryDocumentV6
Json que contiene información sobre el documento de biblioteca de flujo de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Etiqueta
|
label | string |
Texto para mostrar de este formulario para los usuarios de flujo de trabajo |
|
Fecha de modificación
|
modifiedDate | string |
Fecha en la que se modificó por última vez el documento de biblioteca. El formato sería aaaa-MM-dd'T'HH:mm:ssZ. Por ejemplo, por ejemplo, 2016-02-25T18:46:19Z representa la hora UTC. |
|
Modo de uso compartido
|
sharingMode | string |
Especifica quién debe tener acceso a este documento de biblioteca. El uso compartido GLOBAL es una operación restringida |
|
Tipos de plantilla
|
templateTypes | array of |
Lista de uno o varios tipos de plantilla de biblioteca |
|
Id. de documento de la biblioteca de flujo de trabajo
|
workflowLibDoc | string |
Identificador del documento de biblioteca de flujo de trabajo que se puede proporcionar como un archivo de entrada en la solicitud de creación del contrato de flujo de trabajo personalizado |
LocaleFieldInfoDescriptionV6
Json que contiene información detallada sobre la configuración regional del flujo de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Configuraciones regionales disponibles
|
availableLocales | array of string |
Qué configuraciones regionales se pueden elegir para este flujo de trabajo |
|
Valor predeterminado
|
defaultValue | string |
Valor predeterminado del campo si no se proporciona la entrada para este campo y este campo es obligatorio |
|
Editable
|
editable | boolean |
Si se puede editar el campo actual. Si el atributo editable para este campo es false, este campo no se debe proporcionar en la solicitud de creación del contrato y el valor predeterminado de este campo se usará en la creación de acuerdos. |
|
Obligatorio
|
required | boolean |
Si este campo es obligatorio o opcional |
|
Visible
|
visible | boolean |
Indica si el campo actual está visible o no. Si el atributo visible para este campo es false, este campo no debe estar visible en la interfaz de usuario de creación de contratos mediante este flujo de trabajo para el usuario. |
MergeFieldInfoDescriptionV6
Json que contiene información detallada sobre el campo de combinación
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Valor predeterminado
|
defaultValue | string |
Valor predeterminado del campo si no se proporciona la entrada para este campo y este campo es obligatorio |
|
Nombre de pantalla
|
displayName | string |
Texto para mostrar que se puede mostrar para este campo personalizado |
|
Editable
|
editable | boolean |
Si se puede editar el campo actual. Si el atributo editable para este campo es false, este campo no se debe proporcionar en la solicitud de creación del contrato y el valor predeterminado de este campo se usará en la creación de acuerdos. |
|
Nombre de campo personalizado
|
fieldName | string |
Nombre del campo personalizado en este flujo de trabajo |
|
Obligatorio
|
required | boolean |
Si este campo es obligatorio o opcional |
|
Visible
|
visible | boolean |
Si el campo actual debe estar visible en la página de creación de contratos. Si el atributo visible para este campo es false, este campo no se debe mostrar en la página de creación del contrato mediante este flujo de trabajo. |
PasswordFieldInfoDescriptionV6
Json que contiene información detallada sobre la contraseña
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contraseña
|
defaultValue | string |
Valor predeterminado del campo de información de contraseña |
|
Editable
|
editable | boolean |
Si se puede editar el campo actual. Si el atributo editable para este campo es false, este campo no se debe proporcionar en la solicitud de creación del contrato y el valor predeterminado de este campo se usará en la creación de acuerdos. |
|
Etiqueta
|
label | string |
Etiqueta del campo contraseña |
|
Nombre
|
name | string |
Nombre del campo contraseña |
|
Obligatorio
|
required | boolean |
Si este campo es obligatorio o opcional |
|
Visible
|
visible | boolean |
Si el campo de información de contraseña está visible en la página de creación de contratos |
RecipientsListInfoDescriptionV6
Json que contiene información detallada sobre la lista de destinatarios
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Permitir remitente
|
allowSender | boolean |
Indica si el remitente se permite como destinatario |
|
Permitir remitente
|
allowfax | boolean |
Indica si se permite o no fax |
|
Método de autenticación
|
authenticationMethod | string |
Método de autenticación para que la lista de destinatarios actual tenga acceso para ver y firmar el documento, |
|
Valor predeterminado de correo electrónico/fax
|
defaultValue | string |
Un correo electrónico predeterminado o un número de fax |
|
Editable
|
editable | boolean |
Si se puede editar el campo actual. Si el atributo editable para este campo es false, este campo no se debe proporcionar en la solicitud de creación del contrato y el valor predeterminado de este campo se usará en la creación de acuerdos. |
|
Etiqueta
|
label | string |
Texto para mostrar del usuario de flujo de trabajo que se puede usar para la lista de destinatarios actual |
|
Número máximo de destinatarios
|
maxListCount | integer |
Número máximo de entradas permitidas en la lista de destinatarios actual |
|
Destinatarios mínimos
|
minListCount | integer |
Número mínimo de entradas permitidas en la lista de destinatarios actual |
|
Nombre de la lista de información del destinatario
|
name | string |
Nombre de la lista de información del destinatario actual |
|
Rol de participante
|
role | string |
Rol actual del participante |
|
Visible
|
visible | boolean |
Indica si el campo actual está visible. Si el atributo visible para este campo es false, este campo no se debe mostrar en la interfaz de usuario de creación de contratos mediante este flujo de trabajo para el usuario. |
WorkflowDescriptionV6
Json que contiene información detallada sobre el flujo de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
agreementNameInfo
|
agreementNameInfo | WorkflowDefaultParamsV6 |
Json que contiene el objeto params predeterminado del flujo de trabajo |
|
authoringInfo
|
authoringInfo | WorkflowDefaultParamsV6 |
Json que contiene el objeto params predeterminado del flujo de trabajo |
|
Información de lista cc
|
ccsListInfo | array of CCsListInfoDescriptionV6 |
Información sobre el campo de entrada de lista CC en la solicitud de creación del contrato |
|
Fecha de creación del flujo de trabajo
|
created | string |
El día en el que se creó el flujo de trabajo |
|
Descripción del flujo de trabajo
|
description | string |
Descripción proporcionada para este flujo de trabajo en el momento de su creación |
|
Nombre para mostrar del flujo de trabajo
|
displayName | string |
Nombre para mostrar del flujo de trabajo |
|
expirationInfo
|
expirationInfo | ExpirationFieldInfoDescriptionV6 |
Json que contiene información sobre la expiración |
|
Información de archivos
|
fileInfos | array of FileInfosDescriptionV6 |
Información sobre el campo de entrada de información de archivo en la solicitud de creación del contrato |
|
localeInfo
|
localeInfo | LocaleFieldInfoDescriptionV6 |
Json que contiene información detallada sobre la configuración regional del flujo de trabajo |
|
Información de campos de combinación
|
mergeFieldsInfo | array of MergeFieldInfoDescriptionV6 |
Información sobre el campo de entrada de información personalizada en la solicitud de creación del contrato |
|
messageInfo
|
messageInfo | WorkflowDefaultParamsV6 |
Json que contiene el objeto params predeterminado del flujo de trabajo |
|
Fecha de modificación
|
modified | string |
El día en el que se modificó por última vez el flujo de trabajo |
|
Nombre del flujo de trabajo
|
name | string |
Nombre del flujo de trabajo |
|
passwordInfo
|
passwordInfo | PasswordFieldInfoDescriptionV6 |
Json que contiene información detallada sobre la contraseña |
|
Información de lista de destinatarios
|
recipientsListInfo | array of RecipientsListInfoDescriptionV6 |
Información sobre el campo de entrada de información de recepients en la solicitud de creación del contrato |
|
Ámbito de flujo de trabajo
|
scope | string |
Ámbito del flujo de trabajo |
|
Estado del flujo de trabajo
|
status | string |
Estado del flujo de trabajo |
|
Identificador del originador de flujo de trabajo
|
originatorId | string |
Originador inicial del flujo de trabajo |
|
Id. de ámbito de flujo de trabajo
|
scopeId | string |
Identificador del ámbito. Actualmente solo es aplicable para el ámbito GROUP y el valor será groupId. |
BooleanSettingInfoV6
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Importancia
|
value | boolean |
Valor de la configuración |
|
Heredado
|
inherited | boolean |
True si la configuración se hereda de su valor de grupo o cuenta |
SettingsInfoV6
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
libaryDocumentCreationVisible
|
libaryDocumentCreationVisible | BooleanSettingInfoV6 | |
|
sendRestrictedToWorkflows
|
sendRestrictedToWorkflows | BooleanSettingInfoV6 | |
|
userCanSend
|
userCanSend | BooleanSettingInfoV6 | |
|
widgetCreationVisible
|
widgetCreationVisible | BooleanSettingInfoV6 |
UserGroupInfoV6
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de grupo
|
id | string |
Identificador único del grupo |
|
¿Es administrador de grupo?
|
isGroupAdmin | boolean |
True si el usuario es administrador del grupo |
|
Es el grupo principal
|
isPrimaryGroup | boolean |
True si el grupo es el grupo principal del usuario |
|
Estado
|
status | string |
Estado de la pertenencia al grupo |
|
Fecha de creación
|
createdDate | date |
Se creó el grupo de fechas |
|
Nombre de grupo
|
name | string |
Nombre del grupo |
|
settings
|
settings | SettingsInfoV6 |
UserGroupsInfoV6
Json que contiene la lista de grupos para un usuario determinado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Lista de grupos de usuarios
|
groupInfoList | array of UserGroupInfoV6 |
Matriz de elementos de información de grupo de usuarios |
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".