Foxit eSign (versión preliminar)
Foxit eSign es una solución de firma electrónica que le permite enviar, firmar y administrar documentos en línea, lo que elimina la necesidad de imprimir, escanear o enviar correos. Cargue el documento, defina los campos de firma y envíelos a los destinatarios para las firmas de enlace rápido y legal.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones 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 - Azure regiones de China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones 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) |
| Contact | |
|---|---|
| Nombre | Compatibilidad con Foxit eSign |
| URL | https://www.foxit.com |
| Correo Electrónico | api@foxit.com |
| Metadatos del conector | |
|---|---|
| Publicador | Foxit Software Inc. |
| Sitio web | https://www.foxit.com/esign-pdf/ |
| Directiva de privacidad | https://www.foxit.com/company/privacy-policy.html |
| Categories | Productividad; Contenido y archivos |
Foxit eSign
Foxit eSign es una solución de firma electrónica de nivel empresarial que permite a las empresas enviar, firmar y administrar documentos legalmente vinculantes completamente en línea, lo que elimina la necesidad de imprimir, escanear o enviar correo. Cargue el documento, defina los campos de firma y envíelos a los destinatarios para obtener firmas rápidas y seguras. Foxit eSign es totalmente compatible con las principales leyes de firma electrónica, como ESIGN y UETA, usa el cifrado para proteger los documentos en tránsito y en reposo, y admite la autenticación multifactor para garantizar que solo los firmantes autorizados puedan acceder a sus documentos y firmarlos.
El conector foxit eSign para Microsoft Power Automate le permite automatizar el flujo de trabajo completo de firma de documentos, desde la creación de sobres y el envío de los sobres para su firma, el seguimiento del estado, la descarga de documentos completados, la administración de plantillas y la activación de acciones de bajada cuando se producen eventos de sobre.
Publisher: Foxit Corporation
Prerequisites
Para usar este conector, necesitará lo siguiente:
- Un plan de Microsoft Power Apps o Power Automate con acceso personalizado al conector o al conector Premium
- Una cuenta de Foxit eSign: cree una aquí
- Acceso de API habilitado en la cuenta de Foxit eSign (consulte Obtención de credenciales a continuación)
Obtención de credenciales
- Cree una cuenta de Foxit eSign si aún no tiene una.
- Póngase en contacto con el equipo de Foxit Sales para solicitar el acceso a la API para que esté habilitado en su cuenta. Una vez aprobado, el acceso a la API se activará en su cuenta.
- En Power Automate, busque Foxit eSign en la lista de conectores y seleccione Crear conexión.
- Se le redirigirá a la página de inicio de sesión de Foxit eSign. Inicie sesión con sus credenciales de Foxit eSign para autorizar la conexión.
- Una vez autorizado, la conexión está lista para usarse en los flujos.
Getting Started
Después de crear una conexión, puede empezar a crear flujos mediante el conector foxit eSign:
- Use desencadenadores para iniciar un flujo automáticamente cuando se produzca un evento de sobre (por ejemplo, cuando todas las partes hayan firmado).
- Use acciones para crear sobres, enviar recordatorios de firma, descargar documentos completados, administrar plantillas, etc.
- Encadene varias acciones juntas; por ejemplo, cree un sobre a partir de una plantilla, espere al desencadenador totalmente ejecutado y, a continuación, descargue el documento firmado y almacénelo en SharePoint.
Desencadenadores admitidos
| Trigger | Description |
|---|---|
| Cuando se envía un sobre | Se desencadena cuando se envía un sobre a los destinatarios. Requiere el nivel de webhook establecido en Cuenta. |
| Cuando se ve un sobre | Se desencadena cuando se abre un destinatario y ve el sobre. |
| Cuando se firma un sobre | Se activa cuando un destinatario firma el sobre. |
| Cuando se cancela un sobre | Se desencadena cuando un destinatario o el remitente cancelan un sobre. |
| Cuando se ejecuta un sobre por completo | Se desencadena cuando todos los destinatarios han firmado y el sobre se completa. |
| Cuando se elimina un sobre | Se desencadena cuando se elimina un sobre. |
Acciones soportadas
Sobres
| Acción | Description |
|---|---|
| Creación de sobre a partir de la dirección URL | Crea y envía un sobre mediante una dirección URL pdf accesible públicamente. |
| Creación de sobre desde Base64 | Crea y envía un sobre mediante un documento PDF codificado en Base64. |
| Crear sobre a partir de una plantilla | Crea y envía un sobre a partir de una plantilla de Foxit eSign existente. |
| Obtener detalles del sobre | Recupera los detalles completos y el estado actual de un sobre. |
| Obtener identificadores de sobre | Recupera una lista de identificadores de sobre en función de los criterios de filtro. |
| Enviar recordatorio de firma | Envía una notificación de recordatorio a los firmantes pendientes de un sobre. |
| Descargar archivos de sobre | Descarga todos los documentos firmados en un sobre como un archivo ZIP. |
| Descargar PDF de documento único | Descarga un único documento de un sobre como PDF. |
| Mover sobres a la papelera de reciclaje | Mueve uno o varios sobres a la papelera de reciclaje. |
| Cancelar sobre | Cancela un sobre y notifica a los destinatarios. |
| Eliminar sobres | Elimina permanentemente uno o varios sobres. |
| Obtener historial de actividad de sobre | Recupera el registro de actividad completo de un sobre. |
| Obtener historial de sobres eliminados | Recupera el historial de sobres eliminados en la cuenta. |
Templates
| Acción | Description |
|---|---|
| Crear plantilla a partir de la dirección URL | Crea una plantilla de firma reutilizable mediante una dirección URL de PDF accesible públicamente. |
| Creación de una plantilla a partir de Base64 | Crea una plantilla de firma reutilizable mediante un documento PDF codificado en Base64. |
| Obtener detalles de la plantilla | Recupera los detalles completos de una plantilla específica, incluidas las definiciones de campo. |
| Obtener plantillas por identificadores de plantilla | Recupera los detalles de una o varias plantillas por sus identificadores. |
| Obtener una lista de todas las plantillas | Recupera todas las plantillas disponibles en la cuenta. |
Webhooks
| Acción | Description |
|---|---|
| Enumerar todos los canales de webhook | Devuelve una lista de todos los canales de webhook configurados en la cuenta. |
| Obtener detalles del canal de webhook | Recupera los detalles de un canal de webhook específico. |
Grupos de correo electrónico
| Acción | Description |
|---|---|
| Crear grupo de correo electrónico | Crea un nuevo grupo de correo electrónico para usarlo como destinatarios en sobres. |
| Obtener detalles del grupo de correo electrónico | Recupera los detalles y los miembros de un grupo de correo electrónico. |
Informes
| Acción | Description |
|---|---|
| Descargar informe | Descarga un informe de actividad de cuenta en formato Microsoft Excel. |
Problemas conocidos y limitaciones
Límite de velocidad: la API foxit eSign permite hasta 4000 solicitudes por 5 minutos por cuenta. Las solicitudes que superan este límite reciben una
429 Too Many Requestsrespuesta. Se recomienda implementar lógica de reintento con retroceso exponencial en los flujos para controlar esto correctamente.Límite de tamaño de archivo: el tamaño máximo de archivo por documento es de 25 MB. Este límite se aplica a archivos individuales, no al tamaño total del sobre.
Cancelación de suscripción automática de webhook: debido a una limitación en la API de eliminación de webhook de Foxit eSign (que usa un método POST en lugar de DELETE), Power Automate no puede limpiar automáticamente las suscripciones de canal de webhook cuando se elimina o modifica un flujo basado en desencadenadores. Use la acción Enumerar todos los canales de webhook para identificar los canales activos y el portal foxit eSign para quitar suscripciones al retirar un flujo.
Cuando se envía un sobre: solo nivel de cuenta: el desencadenador "Cuando se envía un sobre" solo se activa cuando el nivel de webhook se establece en Cuenta. No se activa para los sobres creados en el nivel de aplicación de API . Asegúrese de seleccionar Nivel de cuenta al configurar este desencadenador.
Disponibilidad regional: el conector está disponible tanto para las cuentas de norteamérica (NA1) como para las regiones de la UE. Seleccione la región de servidor adecuada al configurar la conexión. La conexión a la región incorrecta provocará errores de autenticación.
Tamaño del documento Base64: cuando se usa el sobre crear desde Base64 o crear plantilla a partir de acciones base64, la cadena codificada en Base64 debe corresponder a un archivo de origen no superior a 25 MB.
Apoyo
Para obtener soporte técnico para desarrolladores, póngase en contacto con el equipo de Foxit eSign en devsupport@foxitsoftware.com.
Para enviar un caso de soporte técnico, visite https://kb.foxit.com/s/submit-a-case.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Cancelar la suscripción al desencadenador de webhook |
Elimina una suscripción de canal de webhook activa por su identificador de canal. Use esta acción para limpiar las suscripciones de webhook que ya no son necesarias. |
| Cancelar sobre |
Cancela un sobre enviado. Los destinatarios ya no podrán firmar los documentos. |
| Creación de sobre a partir de la dirección URL |
Crea y envía un sobre mediante direcciones URL PDF accesibles públicamente. Proporcione las direcciones URL del documento y los detalles del destinatario para iniciar el proceso de firma. |
| Creación de sobre desde Base64 |
Crea y envía un sobre mediante un documento PDF codificado en Base64. |
| Creación de una plantilla a partir de Base64 |
Crea una plantilla con una cadena PDF codificada en Base64. Úselo cuando el archivo PDF ya esté disponible como una cadena Base64 en el flujo, por ejemplo, desde un archivo SharePoint o un documento de OneDrive. |
| Crear grupo de correo electrónico |
Crea un nuevo grupo de correo electrónico que se puede usar para enviar sobres a varios destinatarios a la vez. |
| Crear plantilla a partir de la dirección URL |
Crea una plantilla con una dirección URL pdf accesible públicamente. |
| Crear sobre a partir de una plantilla |
Crea y envía un sobre mediante una plantilla existente. Los detalles del destinatario se pueden personalizar. |
| Descargar archivos de sobre |
Descarga los documentos completados de un sobre como un archivo. |
| Descargar informe |
Descarga un informe de actividad de sobre como un archivo Microsoft Excel. Use los filtros para restringir los resultados por estado, intervalo de fechas, nombre de sobre, autor o firmante. |
| Descargar PDF de documento único |
Descarga un único documento de un sobre como un archivo PDF. |
| Eliminar sobres |
Elimina permanentemente uno o varios sobres. |
| Enumerar todos los canales de webhook |
Devuelve una lista de todos los canales de webhook configurados en su cuenta. |
| Enviar recordatorio de firma |
Envía una notificación de recordatorio a los destinatarios pendientes de un sobre, que les pide que completen la firma. |
| Mover sobres a la papelera de reciclaje |
Mueve uno o varios sobres a la papelera de reciclaje. Los sobres de la papelera de reciclaje no se eliminan permanentemente. |
| Obtener detalles de la plantilla |
Recupera los detalles completos de una plantilla específica, incluidos sus campos y destinatarios. |
| Obtener detalles del canal de webhook |
Recupera los detalles de un canal de webhook específico. |
| Obtener detalles del grupo de correo electrónico |
Recupera los detalles de un grupo de correo electrónico existente. |
| Obtener detalles del sobre |
Recupera detalles completos de un sobre, incluido su estado, destinatarios y documentos. |
| Obtener historial de actividad de sobre |
Recupera un registro de actividad completo para un sobre, que muestra todas las acciones realizadas por los destinatarios y el remitente. |
| Obtener historial de sobres eliminados |
Recupera un historial de sobres que se han eliminado o movido a la papelera de reciclaje. |
| Obtener identificadores de sobre |
Devuelve una lista de identificadores de sobre filtrados por estado. Úselo para buscar sobres en un estado específico. |
| Obtener plantillas por identificadores de plantilla |
Recupera los detalles de una o varias plantillas por sus identificadores. |
| Obtener una lista de todas las plantillas |
Devuelve una lista de todas las plantillas disponibles en su cuenta. |
Cancelar la suscripción al desencadenador de webhook
Elimina una suscripción de canal de webhook activa por su identificador de canal. Use esta acción para limpiar las suscripciones de webhook que ya no son necesarias.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de canal
|
channelId | True | integer |
Identificador del canal de webhook que se va a eliminar. |
Cancelar sobre
Cancela un sobre enviado. Los destinatarios ya no podrán firmar los documentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
folderId | True | integer |
Identificador del sobre que se va a cancelar. |
|
Motivo de cancelación
|
reason_for_cancellation | True | string |
Motivo para cancelar este sobre. Esto se registra en el historial de actividad del sobre. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Identificadores de sobre cancelados
|
folders cancelled | array of integer |
Lista de identificadores de sobre que se cancelaron correctamente. |
Creación de sobre a partir de la dirección URL
Crea y envía un sobre mediante direcciones URL PDF accesibles públicamente. Proporcione las direcciones URL del documento y los detalles del destinatario para iniciar el proceso de firma.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del sobre
|
folderName | True | string |
Nombre de este sobre. |
|
Tipo de entrada
|
inputType | string |
Especifica el formato de origen del documento. Establezca en url para proporcionar direcciones URL de archivo o base64 para proporcionar contenido de archivo codificado en Base64. |
|
|
Direcciones URL de archivo
|
fileUrls | True | array of string |
Matriz de direcciones URL accesibles públicamente que apuntan a los documentos que se van a agregar a este sobre. |
|
Nombres de archivo
|
fileNames | True | array of string |
Matriz de nombres para mostrar para cada documento, en el mismo orden que las direcciones URL de archivo. |
|
Nombre
|
firstName | True | string |
Nombre del destinatario. |
|
Apellido
|
lastName | True | string |
Apellido del destinatario. |
|
dirección Email
|
emailId | True | string |
Dirección de correo electrónico del destinatario. |
|
permissions
|
permission | True | string | |
|
Secuencia
|
sequence | True | integer |
Use este campo para asignar un número de secuencia a un destinatario en la lista de partes de destinatarios. Use números de secuencia únicos para cada entidad a partir de 1, como 1,2,3,4...... Si una sola persona aparece varias veces en el flujo de trabajo de firma, asigne una secuencia diferente cada vez que se repita el destinatario. |
|
signerAuthLevels
|
signerAuthLevel | string |
Nivel de autenticación que un firmante aprovechará con fines de comprobación. |
|
|
Marcador de posición es
|
isPlaceholder | boolean |
Use este campo para iniciar la entidad es un marcador de posición. Nota: 1. firstName, lastName, el valor del parámetro emailId debe estar en blanco de esta entidad. 2. Para agregar el marcador de posición, se debe volver a guardar un destinatario con el permiso "PARTY_ASSIGNER". |
|
|
Rol de destinatario
|
partyRole | string |
Use este campo para asignar un rol de marcador de posición. |
|
|
Permitir cambio de nombre
|
allowNameChange | string |
El valor puede ser true o false Use este parámetro para permitir que el firmante actualice primero y el apellido antes de completar el proceso de firma. |
|
|
Secuencia de flujo de trabajo
|
workflowSequence | integer |
Asigne un número de secuencia de flujo de trabajo a este destinatario. Cuando la secuencia de inicio de sesión está habilitada, los destinatarios reciben su invitación de firma en orden ascendente de secuencia. |
|
|
Id. de correo electrónico de host
|
hostEmailId | string |
Dirección de correo electrónico del administrador de In-Person. |
|
|
Código de acceso
|
userDefinedAccessCode | string |
El parámetro contendrá Código de acceso cuando el valor "signerAuthLevel" esté establecido como "Código de acceso definido por el usuario" para la autenticación. Nota: 1. Los códigos no distinguen mayúsculas de minúsculas. 2. El sistema no envía este código, por lo que debe compartir este código directamente con el firmante. 3. El código de acceso puede contener alfabetos, números y los siguientes caracteres especiales: @,&,,{,}%,(,),~,|,!,+,^. |
|
|
La entidad es grupo de correo electrónico
|
partyIsEmailGroup | boolean |
Use este parámetro al crear una entidad como masiva. Nota: Si este parámetro es true, firstName, lastName y emailId de esta entidad se omitirán. |
|
|
Id. de grupo de correo electrónico
|
emailGroupId | integer |
Pase el correo electrónico el identificador de grupo que desea usar para crear de forma masiva. |
|
|
Single Signer Bulk
|
allowSingleSignerInBulk | boolean |
Use este parámetro para permitir que solo una persona inicie sesión en el grupo de correo electrónico. |
|
|
Código de marcado
|
dialingCode | string |
Use este campo para asignar códigos de acceso telefónico de país como prefijos de número de móvil a un destinatario de la lista de destinatarios. |
|
|
Número de móvil
|
mobileNumber | string |
Use este campo para asignar un número de móvil a un destinatario en la lista de partes de destinatarios. |
|
|
Campos
|
Fields | object | ||
|
Enviar ahora
|
sendNow | boolean |
Cuando está habilitada, Foxit eSign envía inmediatamente un vínculo de firma único a la dirección de correo electrónico de cada destinatario. Deshabilite esta opción para guardar el sobre como borrador en su lugar. |
|
|
Crear sesión de firma insertada
|
createEmbeddedSigningSession | True | boolean |
El token de sesión de firma se generará sin enviar correos electrónicos a los destinatarios. |
|
Crear sesión de firma insertada para todas las partes
|
createEmbeddedSigningSessionForAllParties | boolean |
Si se establece en true, se generará una dirección URL de firma incrustada para cada destinatario del sobre. |
|
|
Procesar etiquetas de texto
|
processTextTags | True | boolean |
El valor puede ser true o false. Este campo se usa para determinar si Foxit eSign debe analizar los documentos de etiquetas de texto para convertirlos en campos Foxit eSign. |
|
Procesar campos de Acro
|
processAcroFields | True | boolean |
Este campo se usa para determinar si Foxit eSign debe analizar los documentos de AcroFields para convertirlos en campos Foxit eSign. |
|
Secuencia de inicio de sesión
|
signInSequence | boolean |
Este campo se usa para determinar si los destinatarios firmarán los documentos de sobre en una secuencia. Si es false, todos los destinatarios reciben correo electrónico de invitación simultáneamente. Cuando es true, cada destinatario recibe el correo electrónico de invitación sucesivamente después de que el destinatario anterior complete la tarea necesaria, como firmar los documentos o rellenar campos, etc. |
|
|
Habilitar en persona
|
inPersonEnable | boolean |
Este campo se usa para iniciar el proceso de firma en persona que se puede completar fácilmente en cualquier dispositivo en cuestión de minutos y evitar firmas basadas en correo electrónico cuando sea necesario. Si es false, todos los destinatarios reciben el correo electrónico de invitación simultáneamente. Cuando es true, el administrador en persona recibe un correo electrónico de invitación para iniciar el proceso de firma del firmante. |
|
|
Corregir partes de destinatarios
|
fixRecipientParties | boolean |
Si es true, en la vista de envío insertada no puede cambiar las partes del sobre que ya se han agregado como parte de esta solicitud. |
|
|
Corregir documentos
|
fixDocuments | boolean |
Si es true, en el envío incrustado no puede cambiar los documentos del sobre que ya se han agregado como parte de esta solicitud. |
|
|
Enviar dirección URL correcta
|
sendSuccessUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje, a la que se redirigirá el firmante después de enviar correctamente la carpeta en la vista de envío incrustada. |
|
|
Dirección URL de error de envío
|
sendErrorUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje, a la que se redirigirá el firmante si se produce un error durante el envío de la carpeta en la vista de envío incrustada. |
|
|
Creación de una sesión de envío insertada
|
createEmbeddedSendingSession | boolean |
Si se establece en true, generará un token incrustado para abrir la vista de preparación del documento de Foxit eSign. |
|
|
Identificadores de correo electrónico de firmantes incrustados
|
embeddedSignersEmailIds | array of string |
Matriz de identificadores de correo electrónico de destinatarios para los que se debe crear una sesión de firma insertada. Identificadores de correo electrónico de los destinatarios agregados en la lista de partes. |
|
|
Sign Success Url
|
signSuccessUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá después de iniciar sesión correctamente en la vista de firma insertada. |
|
|
Dirección URL de rechazo de signo
|
signDeclineUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si rechaza iniciar sesión en la vista de firma insertada. |
|
|
Sign Later Url
|
signLaterUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si decide iniciar sesión más adelante en la vista de firma incrustada. |
|
|
Dirección URL del error de inicio de sesión
|
signErrorUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si se produce un error durante la firma del documento en la vista de firma incrustada. |
|
|
Permitir enviar ahora y sesión de firma insertada
|
allowSendNowAndEmbeddedSigningSession | boolean |
Si se establece como true, Foxit eSign enviará un vínculo de firma único a cada destinatario. Esto solo es aplicable cuando los parámetros sendNow y createEmbeddedSigningSession son true. |
|
|
Validación avanzada de correo electrónico
|
allowAdvancedEmailValidation | boolean |
Valide la dirección de correo electrónico de las partes cuando se establezca como true. |
|
|
Firmar la dirección URL de éxito de todas las partes
|
signSuccessUrlAllParties | boolean |
Si se establece como true, el firmante se redirigirá a la dirección URL proporcionada en signSuccessUrl después de firmar correctamente. Esto solo es aplicable cuando sendNow es true. |
|
|
Id. de plantilla de correo electrónico
|
emailTemplateId | integer |
Pase el identificador de plantilla de correo electrónico para enviar las plantillas de correo electrónico distintas de las plantillas de correo electrónico predeterminadas. |
|
|
Identificador de instrucción del firmante
|
signerInstructionId | integer |
Pase el identificador de instrucción para enviar instrucciones del firmante que no sean las instrucciones predeterminadas del firmante. |
|
|
Identificador de instrucción de confirmación
|
confirmationInstructionId | string |
Pase el identificador de instrucción de confirmación para enviar instrucciones de confirmación que no sean las instrucciones de confirmación predeterminadas. |
|
|
Color del tema
|
themeColor | string |
Escriba el valor CSS para establecer el color del tema. |
|
|
Expiración de sesión
|
sessionExpire | boolean |
Establezca como true para iniciar la expiración de la sesión de firma incrustada. |
|
|
Caducidad
|
expiry | integer |
Obligatorio si sessionExpire es true. Escriba la duración en milisegundos de la expiración en la sesión de firma incrustada. |
|
|
Nombre del campo dependiente
|
dependentFieldName | True | string |
Nombre del campo cuya visibilidad está controlada por el campo primario. |
|
Nombre del campo primario
|
parentFieldName | True | string |
Nombre del campo primario cuyo valor controla la visibilidad del campo dependiente. Tipos de campo primario admitidos: campo de texto, cuadro de texto, casilla, radiobutton, lista desplegable. |
|
Valor del campo primario
|
parentFieldValue | True | string |
Valor del campo primario que desencadena el campo dependiente para que sea visible. Para los campos de casilla y botón de radio, use activado o desactivado. |
|
Opciones
|
options | True | string |
Opciones de coincidencia adicionales para campos primarios basados en texto. Valores aceptados: isblank, allowNull, contains. |
|
Metadatos
|
metadata | object |
Debe estar en el par clave-valor. Se permiten 1000 pares de valores clave máximos. |
|
|
Correo electrónico del remitente
|
senderEmail | string |
Escriba el correo electrónico de otro usuario en su cuenta que se usará para enviar esta carpeta de documentos a las partes del destinatario. |
|
|
Ocultar el botón Agregarme
|
hideAddMeButton | boolean |
Si es true, ocultará el botón "Agregarme" en las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar el botón Agregar nuevo
|
hideAddNewButton | boolean |
Si es true, ocultará el botón "Agregar nuevo" en las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar el botón Agregar grupo
|
hideAddGroupButton | boolean |
Si es true, ocultará el botón "Agregar grupo" de las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar nombre de campo para destinatarios
|
hideFieldNameForRecipients | boolean |
Ocultar nombres de campo para destinatarios para campos de entrada de datos y campos avanzados. (Excepto botón de radio, Casilla, Imagen e Hipervínculo). |
|
|
Ocultar borde de casilla
|
hideCheckboxBorder | boolean |
Los bordes de checkbox se ocultarán en los documentos ejecutados. |
|
|
Ocultar opción de selección del firmante
|
hideSignerSelectOption | boolean |
Si es true, ocultará el cuadro de entrada "Nombre de firmante o correo electrónico existente" en Las partes del destinatario en una sesión de envío incrustada. |
|
|
Ocultar acciones del firmante
|
hideSignerActions | boolean |
Si es true, ocultará las acciones del firmante "editar", "cambiar" y "quitar" en las partes destinatarios en una sesión de envío incrustada. |
|
|
Ocultar nombre del remitente
|
hideSenderName | boolean |
Si es true, ocultará el nombre del remitente en las partes destinatarios en una sesión de envío incrustada. |
|
|
Ocultar nombre de carpeta
|
hideFolderName | boolean |
Si es true, ocultará el nombre de carpeta en la navegación en ambas sesiones incrustadas. |
|
|
Ocultar el nombre de los documentos
|
hideDocumentsName | boolean |
Si es true, ocultará el nombre del documento en ambas sesiones incrustadas. |
|
|
Ocultar rechazar para firmar
|
hideDeclineToSign | boolean |
Si es true, ocultará la opción "Rechazar a firmar" para el firmante. |
|
|
Ocultar más acción
|
hideMoreAction | boolean |
Si es true, ocultará el botón "Más acciones" en la sesión de envío o firma. En el caso de "Enviar ahora": true, no ocultará nada. |
|
|
Ocultar el botón Enviar
|
hideSendButton | boolean |
Si es true, ocultará el botón Enviar en la sesión de envío incrustada. |
|
|
Ocultar campo obligatorio siguiente
|
hideNextRequiredFieldbtn | boolean |
Si se establece en true, oculta el botón de navegación que mueve los firmantes al siguiente campo obligatorio. |
|
|
Se requieren ambas sesiones insertadas
|
requiredBothEmbeddedSession | boolean |
Si es true, generará las direcciones URL de envío y firma incrustadas juntas. |
|
|
Contraseña de sobre
|
folderPassword | string |
El firmante o autor necesitará esta contraseña para abrir el documento firmado digitalmente. Si el parámetro se mantiene en blanco, no se requerirá ninguna contraseña para abrir el documento firmado digitalmente. |
|
|
Habilitar paso a paso
|
enableStepByStep | boolean |
Para habilitar la acción paso a paso en la sesión de envío insertada. |
|
|
Ocultar la opción Agregar partes
|
hideAddPartiesOption | boolean |
Si es true, ocultará la opción para agregar partes en el modo borrador y creación de plantillas. |
|
|
Autofirme
|
selfSign | boolean |
Habilita autofirmado insertado a través de las API. Este parámetro solo es aplicable cuando el parámetro createEmbeddedSendingSession es true. |
|
|
Dirección URL correcta del firmante propio
|
selfSignerSuccessUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje en su sitio web o aplicación, a la que se redirigirá el usuario después de que autofirme correctamente el envío de la carpeta en la vista de envío incrustada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID
|
folder.folderId | integer |
Identificador único del sobre recién creado. Úselo en acciones posteriores para hacer referencia a este sobre. |
|
Nombre
|
folder.folderName | string |
Nombre del sobre recién creado. |
|
Nombre personalizado
|
folder.folderCustomName | string |
Un nombre personalizado para el sobre. |
|
Password
|
folder.folderPassword | string |
Contraseña de acceso para el sobre, si se establece. |
|
Id. del creador
|
folder.folderAuthorId | integer |
Identificador único del creador del sobre. |
|
Nombre del creador
|
folder.folderAuthorFirstName | string |
Nombre del creador del sobre. |
|
Apellidos del creador
|
folder.folderAuthorLastName | string |
Apellidos del creador del sobre. |
|
Correo electrónico del creador
|
folder.folderAuthorEmail | string |
Dirección de correo electrónico del creador del sobre. |
|
Rol de creador
|
folder.folderAuthorRole | string |
Rol del creador del sobre. |
|
Id. de empresa
|
folder.folderCompanyId | integer |
Identificador único de la empresa que posee el sobre. |
|
Fecha de creación
|
folder.folderCreationDate | integer |
Fecha en que se creó el sobre (marca de tiempo de Unix en milisegundos). |
|
Fecha de envío
|
folder.folderSentDate | integer |
Fecha en que se envió el sobre (marca de tiempo de Unix en milisegundos). |
|
Situación
|
folder.folderStatus | string |
Estado actual del sobre. |
|
Campo personalizado 1
|
folder.custom_field1 | string |
Primer campo de metadatos personalizado para el sobre. |
|
Campo personalizado 2
|
folder.custom_field2 | string |
Segundo campo de metadatos personalizado para el sobre. |
|
Metadatos
|
folder.metadata | string |
Metadatos personalizados asociados al sobre. |
|
ID de documento
|
folder.folderDocumentIds | array of integer |
Lista de identificadores de documento incluidos en el sobre. |
|
Documentos
|
folder.documentsList | array of object |
Lista de documentos en el sobre. |
|
Id. de documento
|
folder.documentsList.documentId | integer |
Identificador único del documento. |
|
Id. de contrato
|
folder.documentsList.contractId | integer |
Identificador único del contrato. |
|
Id. de empresa
|
folder.documentsList.companyId | integer |
Identificador único de la empresa. |
|
Autor
|
folder.documentsList.contractCreatedBy | integer |
Identificador de usuario de la persona que creó el contrato. |
|
Creado el
|
folder.documentsList.contractCreatedOn | string |
Fecha y hora en que se creó el contrato. |
|
Tipo contrato
|
folder.documentsList.contractType | string |
Tipo del contrato. |
|
Estado del contrato
|
folder.documentsList.contractStatus | string |
Estado actual del contrato. |
|
Editable
|
folder.documentsList.editable | boolean |
Indica si el elemento se puede editar. |
|
Id. de la versión
|
folder.documentsList.contractVersionId | integer |
Identificador único de la versión del contrato. |
|
Nombre de la versión
|
folder.documentsList.contractVersionName | string |
Nombre de la versión del contrato. |
|
Descripción de la versión
|
folder.documentsList.contractVersionDesc | string |
Descripción de la versión del contrato. |
|
Versión creada por
|
folder.documentsList.versionCreatedby | integer |
Identificador de usuario de la persona que creó esta versión. |
|
Versión creada en
|
folder.documentsList.versionCreatedOn | string |
Fecha y hora en que se creó esta versión. |
|
Número de versión
|
folder.documentsList.contractVersionNumber | integer |
Número de versión del contrato. |
|
Origen de la transacción
|
folder.documentsList.contractTransactionSource | string |
Sistema de origen que inició la transacción del contrato. |
|
Recipientes
|
folder.folderRecipientParties | array of object |
Lista de partes de destinatarios para este sobre. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyDetails.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
folder.folderRecipientParties.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
folder.folderRecipientParties.partyDetails.lastName | string |
Apellidos del destinatario. |
|
dirección Email
|
folder.folderRecipientParties.partyDetails.emailId | string |
Dirección de correo electrónico del destinatario. |
|
Marcador de posición
|
folder.folderRecipientParties.partyDetails.placeholder | boolean |
Indica si esta entidad es un destinatario de marcador de posición. |
|
Dirección
|
folder.folderRecipientParties.partyDetails.address | string |
Dirección física del destinatario. |
|
Fecha de creación
|
folder.folderRecipientParties.partyDetails.dateCreated | integer |
Fecha en que se creó el registro (marca de tiempo de Unix en milisegundos). |
|
Rechazar correos electrónicos
|
folder.folderRecipientParties.partyDetails.optOutEmails | boolean |
Indica si el destinatario ha optado por no recibir notificaciones por correo electrónico. |
|
Identificador de destinatario único
|
folder.folderRecipientParties.partyDetails.uniquePartyId | string |
Identificador único del sistema para este destinatario. |
|
Nivel de autenticación
|
folder.folderRecipientParties.partyDetails.authenticationLevel | string |
Método de autenticación necesario para este destinatario. |
|
Fecha de actualización de contraseña
|
folder.folderRecipientParties.partyDetails.passwordUpdateDate | string |
Fecha en que se actualizó la contraseña por última vez. |
|
Estado actualizado de contraseña
|
folder.folderRecipientParties.partyDetails.passwordUpdateStatus | boolean |
Indica si la contraseña se ha actualizado. |
|
Id. de empresa
|
folder.folderRecipientParties.partyDetails.companyId | integer |
Identificador único de la empresa. |
|
Rol de usuario
|
folder.folderRecipientParties.partyDetails.userRole | string |
El rol asignado al usuario. |
|
Departamento
|
folder.folderRecipientParties.partyDetails.department | string |
Departamento al que pertenece el usuario. |
|
Title
|
folder.folderRecipientParties.partyDetails.title | string |
el puesto del usuario. |
|
Activo
|
folder.folderRecipientParties.partyDetails.active | boolean |
Indica si el usuario o el registro están activos. |
|
Configuración regional
|
folder.folderRecipientParties.partyDetails.requestLocale | string |
Configuración regional del usuario. |
|
Uso compartido con Dept
|
folder.folderRecipientParties.partyDetails.share_among_department | boolean |
Indica si los sobres se comparten entre el departamento. |
|
Código de marcado
|
folder.folderRecipientParties.partyDetails.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.folderRecipientParties.partyDetails.mobileNumber | string |
Número de teléfono móvil. |
|
Filtro de estado
|
folder.folderRecipientParties.partyDetails.docStatusFilter | string |
Filtro para el estado del documento. |
|
Filtro de fecha
|
folder.folderRecipientParties.partyDetails.docDateFilter | string |
Filtro para la fecha del documento. |
|
Acceso seguro a campos
|
folder.folderRecipientParties.partyDetails.userSecureFieldAccess | boolean |
Indica si el usuario tiene acceso a campos seguros. |
|
Expandir barra lateral
|
folder.folderRecipientParties.partyDetails.expandSidebar | boolean |
Indica si la barra lateral se expande de forma predeterminada. |
|
Validación de correo electrónico de Adv
|
folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation | boolean |
Indica si la validación avanzada de correo electrónico está habilitada. |
|
Id. de administrador
|
folder.folderRecipientParties.partyDetails.managerId | string |
Identificador único del administrador del usuario. |
|
Recuento de inicios de sesión
|
folder.folderRecipientParties.partyDetails.loginCount | integer |
Número de veces que el usuario ha iniciado sesión. |
|
Correo electrónico de restablecimiento de contraseña
|
folder.folderRecipientParties.partyDetails.sendMailForPasswordReset | boolean |
Indica si se debe enviar un correo electrónico de restablecimiento de contraseña. |
|
Id. de departamento
|
folder.folderRecipientParties.partyDetails.departmentId | string |
Identificador único del departamento. |
|
Empresa principal
|
folder.folderRecipientParties.partyDetails.userPrimaryCompany | integer |
La empresa principal asociada al usuario. |
|
Tipo de dispositivo
|
folder.folderRecipientParties.partyDetails.deviceType | string |
Tipo de dispositivo usado. |
|
Token de dispositivo
|
folder.folderRecipientParties.partyDetails.deviceToken | string |
Token de notificación de inserción para el dispositivo. |
|
Descripción del subcontratista
|
folder.folderRecipientParties.partyDetails.subcontractorDescription | string |
Descripción del subcontratista o firmante externo. |
|
Organización de subcontratistas
|
folder.folderRecipientParties.partyDetails.subcontractorOrganization | string |
Nombre de la organización del subcontratista o firmante externo. |
|
Fecha de incorporación del subcontratista
|
folder.folderRecipientParties.partyDetails.subcAddedDate | integer |
Fecha en que se agregó el subcontratista (marca de tiempo de Unix en milisegundos). |
|
Source
|
folder.folderRecipientParties.partyDetails.source | string |
Sistema de origen desde el que se agregó el firmante externo. |
|
Código de marcado
|
folder.folderRecipientParties.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.folderRecipientParties.mobileNumber | string |
Número de teléfono móvil. |
|
Tipo de firma
|
folder.folderRecipientParties.signerSignatureType | string |
Tipo de firma que usará el firmante. |
|
Permisos
|
folder.folderRecipientParties.contractPermissions | string |
Permisos concedidos a esta parte para el contrato. |
|
Orden de firma
|
folder.folderRecipientParties.partySequence | integer |
Número de secuencia de orden de firma para este destinatario. |
|
Secuencia de flujo de trabajo
|
folder.folderRecipientParties.workflowSignSequence | integer |
Número de secuencia de firma de flujo de trabajo. |
|
Id. de sobre
|
folder.folderRecipientParties.envelopeId | integer |
Identificador único del sobre. |
|
Id. de empresa del destinatario
|
folder.folderRecipientParties.partyCompanyId | integer |
Identificador único de la empresa asociada a este destinatario. |
|
Modo de uso compartido
|
folder.folderRecipientParties.sharingMode | string |
Modo de uso compartido para este sobre. |
|
Dirección URL de acceso del destinatario
|
folder.folderRecipientParties.folderAccessURL | string |
La dirección URL que el destinatario puede usar para acceder al sobre y firmarlo. |
|
Modo de seguridad
|
folder.folderRecipientParties.securityMode | string |
Modo de seguridad aplicado a este sobre. |
|
Comments
|
folder.folderRecipientParties.extraComments | string |
Comentarios adicionales incluidos con el sobre. |
|
Permitir cambio de nombre
|
folder.folderRecipientParties.allowNameChange | boolean |
Indica si el destinatario puede actualizar su nombre. |
|
Nombre actualizado
|
folder.folderRecipientParties.signerNameUpdated | boolean |
Indica si el firmante ha actualizado su nombre. |
|
Nivel de autenticación del firmante
|
folder.folderRecipientParties.signerAuthenticationLevel | string |
Nivel de autenticación necesario para el firmante. |
|
Código de acceso
|
folder.folderRecipientParties.userDefinedAccessCode | string |
Código de acceso personalizado definido para el firmante. |
|
Id. de firma
|
folder.folderRecipientParties.signatureId | string |
Identificador único de la firma. |
|
Rol de destinatario
|
folder.folderRecipientParties.partyRole | string |
Rol asignado a este destinatario en el flujo de trabajo de firma. |
|
Campo de empresa
|
folder.folderRecipientParties.companyFieldValue | string |
Valor del campo nombre de la compañía en la firma. |
|
Campo de título
|
folder.folderRecipientParties.titleFieldValue | string |
Valor del campo de título de la firma. |
|
Motivo de la firma
|
folder.folderRecipientParties.reasonSigning | string |
Motivo por el que el destinatario firma el documento. |
|
Campo de pago agregado
|
folder.folderRecipientParties.payFieldAdded | boolean |
Indica si se ha agregado un campo de pago. |
|
Beneficiario
|
folder.folderRecipientParties.payee | boolean |
Indica si este destinatario es el receptor. |
|
Pago periódico
|
folder.folderRecipientParties.recurringFieldExist | boolean |
Indica si existe un campo de pago periódico. |
|
Imprimir y firmar listo
|
folder.folderRecipientParties.printAndSignCompleted | boolean |
Indica si se ha completado el proceso de impresión y firma. |
|
Pagado
|
folder.folderRecipientParties.paid | boolean |
Indica si se ha completado el pago. |
|
Firmante opcional permitido
|
folder.folderRecipientParties.allowOptionalSigner | boolean |
Indica si este destinatario es un firmante opcional. |
|
Firmantes opcionales
|
folder.folderRecipientParties.optionalSigners | array of integer |
Lista de identificadores de entidad de firmante opcionales para este sobre. |
|
Dirección URL de firma del autor
|
folder.folderAccessURLForAuthor | string |
Dirección URL que el remitente puede usar para acceder al sobre. |
|
Dirección URL de acceso de borrador
|
folder.draftFolderAccessURL | string |
Dirección URL usada para acceder a la versión de borrador del sobre. |
|
Firma de sala de juntas
|
folder.boardRoomSign | boolean |
Indica si el modo de firma de sala de juntas está habilitado. |
|
Incluir logotipo
|
folder.includeLogo | boolean |
Indica si el logotipo de la empresa se incluye en los correos electrónicos. |
|
Color de fondo del botón
|
folder.email_btnBgColor | string |
Color de fondo del botón de correo electrónico. |
|
Color del texto del botón
|
folder.email_btnTxtColor | string |
Color de texto del botón de correo electrónico. |
|
Logotipo de correo electrónico
|
folder.emailTemplateLogo | string |
Dirección URL del logotipo usada en la plantilla de correo electrónico. |
|
Id. de plantilla de correo electrónico
|
folder.emailTemplateId | integer |
Identificador único de la plantilla de correo electrónico. |
|
Encabezado de correo electrónico
|
folder.emailHeader | string |
Texto del encabezado usado en los correos electrónicos de notificación. |
|
Pie de página de correo electrónico
|
folder.emailFooter | string |
Texto del pie de página usado en los correos electrónicos de notificación. |
|
Purga programada
|
folder.purgeFlag | boolean |
Indica si el sobre está programado para purgar. |
|
Purgar fecha de inicio
|
folder.purgeStartDate | string |
Fecha a partir de la cual se programa la purga. |
|
Purgar fecha de finalización
|
folder.purgeEndDate | string |
Fecha en la que se ha programado la purga para completarse. |
|
Id. de envío masivo
|
folder.bulkId | integer |
Identificador único de la operación de envío masivo. |
|
Exigir orden de firma
|
folder.enforceSignWorkflow | boolean |
Indica si los destinatarios deben iniciar sesión en la secuencia definida. |
|
Paso actual
|
folder.currentWorkflowStep | integer |
Paso actual del flujo de trabajo de firma. |
|
Origen de la transacción
|
folder.transactionSource | string |
Sistema de origen que inició esta transacción. |
|
Editable
|
folder.editable | boolean |
Indica si el elemento se puede editar. |
|
firma de In-Person
|
folder.inPersonSignable | boolean |
Indica si el sobre se puede iniciar sesión en persona. |
|
Invalidar recordatorios
|
folder.overrideAccountReminders | boolean |
Indica si se invalida la configuración de aviso de nivel de cuenta. |
|
Invalidar delegación
|
folder.overrideAccountRecipientDelegation | boolean |
Indica si la configuración de delegación de nivel de cuenta se invalida. |
|
Permitir delegación
|
folder.allowRecipientsToDelegate | boolean |
Indica si los destinatarios pueden delegar la firma. |
|
ID
|
folder.envelopeId | integer |
Identificador único del sobre. |
|
Nombre
|
folder.envelopeName | string |
Nombre del sobre. |
|
Id. del originador
|
folder.envelopeOriginatorId | integer |
Identificador único del usuario que creó el sobre. |
|
Id. de empresa
|
folder.envelopeCompanyId | integer |
Identificador único de la empresa que posee el sobre. |
|
Date
|
folder.envelopeDate | integer |
Fecha en que se creó el sobre (marca de tiempo de Unix en milisegundos). |
|
Fecha compartida
|
folder.envelopeSharedDate | integer |
Fecha en que se compartió el sobre (marca de tiempo de Unix en milisegundos). |
|
Situación
|
folder.envelopeStatus | string |
Estado actual del sobre. |
|
Identificadores de contrato
|
folder.envelopeContractIds | array of integer |
Lista de identificadores de contrato asociados a este sobre. |
|
Permisos de destinatario
|
folder.envelopePartyPermissions | array of object |
Lista de permisos de destinatario para este sobre. |
|
Id. del destinatario
|
folder.envelopePartyPermissions.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
folder.envelopePartyPermissions.partyDetails.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
folder.envelopePartyPermissions.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
folder.envelopePartyPermissions.partyDetails.lastName | string |
Apellidos del destinatario. |
|
dirección Email
|
folder.envelopePartyPermissions.partyDetails.emailId | string |
Dirección de correo electrónico del destinatario. |
|
Marcador de posición
|
folder.envelopePartyPermissions.partyDetails.placeholder | boolean |
Indica si esta entidad es un destinatario de marcador de posición. |
|
Dirección
|
folder.envelopePartyPermissions.partyDetails.address | string |
Dirección física del destinatario. |
|
Fecha de creación
|
folder.envelopePartyPermissions.partyDetails.dateCreated | integer |
Fecha en que se creó el registro (marca de tiempo de Unix en milisegundos). |
|
Rechazar correos electrónicos
|
folder.envelopePartyPermissions.partyDetails.optOutEmails | boolean |
Indica si el destinatario ha optado por no recibir notificaciones por correo electrónico. |
|
Identificador de destinatario único
|
folder.envelopePartyPermissions.partyDetails.uniquePartyId | string |
Identificador único del sistema para este destinatario. |
|
Nivel de autenticación
|
folder.envelopePartyPermissions.partyDetails.authenticationLevel | string |
Método de autenticación necesario para este destinatario. |
|
Fecha de actualización de contraseña
|
folder.envelopePartyPermissions.partyDetails.passwordUpdateDate | string |
Fecha en que se actualizó la contraseña por última vez. |
|
Estado actualizado de contraseña
|
folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus | boolean |
Indica si la contraseña se ha actualizado. |
|
Id. de empresa
|
folder.envelopePartyPermissions.partyDetails.companyId | integer |
Identificador único de la empresa. |
|
Rol de usuario
|
folder.envelopePartyPermissions.partyDetails.userRole | string |
El rol asignado al usuario. |
|
Departamento
|
folder.envelopePartyPermissions.partyDetails.department | string |
Departamento al que pertenece el usuario. |
|
Title
|
folder.envelopePartyPermissions.partyDetails.title | string |
el puesto del usuario. |
|
Activo
|
folder.envelopePartyPermissions.partyDetails.active | boolean |
Indica si el usuario o el registro están activos. |
|
Configuración regional
|
folder.envelopePartyPermissions.partyDetails.requestLocale | string |
Configuración regional del usuario. |
|
Uso compartido con Dept
|
folder.envelopePartyPermissions.partyDetails.share_among_department | boolean |
Indica si los sobres se comparten entre el departamento. |
|
Código de marcado
|
folder.envelopePartyPermissions.partyDetails.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.envelopePartyPermissions.partyDetails.mobileNumber | string |
Número de teléfono móvil. |
|
Filtro de estado
|
folder.envelopePartyPermissions.partyDetails.docStatusFilter | string |
Filtro para el estado del documento. |
|
Filtro de fecha
|
folder.envelopePartyPermissions.partyDetails.docDateFilter | string |
Filtro para la fecha del documento. |
|
Acceso seguro a campos
|
folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess | boolean |
Indica si el usuario tiene acceso a campos seguros. |
|
Expandir barra lateral
|
folder.envelopePartyPermissions.partyDetails.expandSidebar | boolean |
Indica si la barra lateral se expande de forma predeterminada. |
|
Validación de correo electrónico de Adv
|
folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation | boolean |
Indica si la validación avanzada de correo electrónico está habilitada. |
|
Id. de administrador
|
folder.envelopePartyPermissions.partyDetails.managerId | string |
Identificador único del administrador del usuario. |
|
Recuento de inicios de sesión
|
folder.envelopePartyPermissions.partyDetails.loginCount | integer |
Número de veces que el usuario ha iniciado sesión. |
|
Correo electrónico de restablecimiento de contraseña
|
folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset | boolean |
Indica si se debe enviar un correo electrónico de restablecimiento de contraseña. |
|
Id. de departamento
|
folder.envelopePartyPermissions.partyDetails.departmentId | string |
Identificador único del departamento. |
|
Empresa principal
|
folder.envelopePartyPermissions.partyDetails.userPrimaryCompany | integer |
La empresa principal asociada al usuario. |
|
Tipo de dispositivo
|
folder.envelopePartyPermissions.partyDetails.deviceType | string |
Tipo de dispositivo usado. |
|
Token de dispositivo
|
folder.envelopePartyPermissions.partyDetails.deviceToken | string |
Token de notificación de inserción para el dispositivo. |
|
Descripción del subcontratista
|
folder.envelopePartyPermissions.partyDetails.subcontractorDescription | string |
Descripción del subcontratista o firmante externo. |
|
Organización de subcontratistas
|
folder.envelopePartyPermissions.partyDetails.subcontractorOrganization | string |
Nombre de la organización del subcontratista o firmante externo. |
|
Fecha de incorporación del subcontratista
|
folder.envelopePartyPermissions.partyDetails.subcAddedDate | integer |
Fecha en que se agregó el subcontratista (marca de tiempo de Unix en milisegundos). |
|
Source
|
folder.envelopePartyPermissions.partyDetails.source | string |
Sistema de origen desde el que se agregó el firmante externo. |
|
Código de marcado
|
folder.envelopePartyPermissions.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.envelopePartyPermissions.mobileNumber | string |
Número de teléfono móvil. |
|
Tipo de firma
|
folder.envelopePartyPermissions.signerSignatureType | string |
Tipo de firma que usará el firmante. |
|
Permisos
|
folder.envelopePartyPermissions.contractPermissions | string |
Permisos concedidos a esta parte para el contrato. |
|
Orden de firma
|
folder.envelopePartyPermissions.partySequence | integer |
Número de secuencia de orden de firma para este destinatario. |
|
Secuencia de flujo de trabajo
|
folder.envelopePartyPermissions.workflowSignSequence | integer |
Número de secuencia de firma de flujo de trabajo. |
|
Id. de sobre
|
folder.envelopePartyPermissions.envelopeId | integer |
Identificador único del sobre. |
|
Id. de empresa del destinatario
|
folder.envelopePartyPermissions.partyCompanyId | integer |
Identificador único de la empresa asociada a este destinatario. |
|
Modo de uso compartido
|
folder.envelopePartyPermissions.sharingMode | string |
Modo de uso compartido para este sobre. |
|
Dirección URL de acceso del destinatario
|
folder.envelopePartyPermissions.folderAccessURL | string |
La dirección URL que el destinatario puede usar para acceder al sobre y firmarlo. |
|
Modo de seguridad
|
folder.envelopePartyPermissions.securityMode | string |
Modo de seguridad aplicado a este sobre. |
|
Comments
|
folder.envelopePartyPermissions.extraComments | string |
Comentarios adicionales incluidos con el sobre. |
|
Permitir cambio de nombre
|
folder.envelopePartyPermissions.allowNameChange | boolean |
Indica si el destinatario puede actualizar su nombre. |
|
Nombre actualizado
|
folder.envelopePartyPermissions.signerNameUpdated | boolean |
Indica si el firmante ha actualizado su nombre. |
|
Nivel de autenticación del firmante
|
folder.envelopePartyPermissions.signerAuthenticationLevel | string |
Nivel de autenticación necesario para el firmante. |
|
Código de acceso
|
folder.envelopePartyPermissions.userDefinedAccessCode | string |
Código de acceso personalizado definido para el firmante. |
|
Id. de firma
|
folder.envelopePartyPermissions.signatureId | string |
Identificador único de la firma. |
|
Rol de destinatario
|
folder.envelopePartyPermissions.partyRole | string |
Rol asignado a este destinatario en el flujo de trabajo de firma. |
|
Campo de empresa
|
folder.envelopePartyPermissions.companyFieldValue | string |
Valor del campo nombre de la compañía en la firma. |
|
Campo de título
|
folder.envelopePartyPermissions.titleFieldValue | string |
Valor del campo de título de la firma. |
|
Motivo de la firma
|
folder.envelopePartyPermissions.reasonSigning | string |
Motivo por el que el destinatario firma el documento. |
|
Campo de pago agregado
|
folder.envelopePartyPermissions.payFieldAdded | boolean |
Indica si se ha agregado un campo de pago. |
|
Beneficiario
|
folder.envelopePartyPermissions.payee | boolean |
Indica si este destinatario es el receptor. |
|
Pago periódico
|
folder.envelopePartyPermissions.recurringFieldExist | boolean |
Indica si existe un campo de pago periódico. |
|
Imprimir y firmar listo
|
folder.envelopePartyPermissions.printAndSignCompleted | boolean |
Indica si se ha completado el proceso de impresión y firma. |
|
Pagado
|
folder.envelopePartyPermissions.paid | boolean |
Indica si se ha completado el pago. |
|
Nivel de autenticación
|
folder.envelopeAuthenticationLevel | string |
Nivel de autenticación necesario para el sobre. |
|
Single Signer Bulk
|
folder.allowSingleSignerInBulk | boolean |
Indica si se permite un firmante único en modo de envío masivo. |
|
nomenclatura de File-Based
|
folder.folderNameBasedOnFileNaming | boolean |
Indica si el nombre de la carpeta se basa en el nombre de archivo. |
|
Nombre de File-Based de documento
|
folder.documentNameBasedOnFileNaming | boolean |
Indica si el nombre del documento se basa en el nombre de archivo. |
|
Nombre del File-Based de certificado
|
folder.certificateNameBasedOnFileNaming | boolean |
Indica si el nombre del certificado se basa en el nombre de archivo. |
|
Nomenclatura de archivos anteriores a exec
|
folder.enableFileNamingBeforeExecution | boolean |
Indica si la nomenclatura de archivos está habilitada antes de la ejecución del documento. |
|
Pago agregado
|
folder.payeeAddedd | boolean |
Indica si se ha agregado un beneficiario. |
|
Self-Signing habilitado
|
folder.selfSignerEnabled | boolean |
Indica si el modo de autofirma está habilitado. |
|
Notary Enabled
|
folder.notaryEnabled | boolean |
Indica si la firma notaria está habilitada. |
|
Visibilidad limitada
|
folder.limitedVisibilityFlag | boolean |
Indica si la visibilidad limitada está habilitada para este sobre. |
|
Visibilidad posterior al inicio de sesión
|
folder.postSigningVisibility | boolean |
Indica si la visibilidad posterior a la firma está habilitada. |
|
Firma mojada
|
folder.wetSignatureEnabled | boolean |
Indica si las firmas húmedas están habilitadas. |
|
Combinar habilitado
|
folder.mergeEnabled | boolean |
Indica si la combinación de documentos está habilitada. |
|
Sesiones de firma insertadas
|
embeddedSigningSessions | array of object |
La lista de sesiones de firma incrustadas, una por destinatario. Solo está presente cuando createEmbeddedSigningSession es true. |
|
Correo electrónico del firmante
|
embeddedSigningSessions.emailIdOfSigner | string |
Dirección de correo electrónico del destinatario para esta sesión de firma incrustada. |
|
Token de firma
|
embeddedSigningSessions.embeddedToken | string |
Token único para la sesión de firma incrustada de este destinatario. |
|
Dirección URL de sesión de firma
|
embeddedSigningSessions.embeddedSessionURL | string |
Dirección URL que se va a abrir o insertar para que este destinatario firme el documento. |
|
Token de envío insertado
|
embeddedToken | string |
Token para la sesión de envío insertada. Solo está presente cuando createEmbeddedSendingSession es true. |
|
Enviar dirección URL de sesión
|
embeddedSessionURL | string |
Dirección URL que se va a abrir o insertar para que el autor del sobre prepare y envíe el sobre. Solo está presente cuando createEmbeddedSendingSession es true. |
|
Result
|
result | string |
Resultado de la operación. |
|
Message
|
message | string |
Mensaje que describe el resultado de la operación. |
Creación de sobre desde Base64
Crea y envía un sobre mediante un documento PDF codificado en Base64.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del sobre
|
folderName | True | string |
Nombre de este sobre. |
|
Tipo de entrada
|
inputType | string |
Tipo de entrada para el origen del documento. Se ha corregido a base64 para esta acción. |
|
|
Cadenas de archivo Base64
|
base64FileString | True | array of string |
Matriz de documentos PDF codificados en Base64 que se van a enviar. |
|
Nombres de archivo
|
fileNames | True | array of string |
Matriz de nombres para mostrar para cada documento, en el mismo orden que la matriz Cadena de archivo Base64. |
|
Nombre
|
firstName | True | string |
Nombre del destinatario. |
|
Apellido
|
lastName | True | string |
Apellido del destinatario. |
|
dirección Email
|
emailId | True | string |
Dirección de correo electrónico del destinatario. |
|
permissions
|
permission | True | string | |
|
Secuencia
|
sequence | True | integer |
Use este campo para asignar un número de secuencia a un destinatario en la lista de partes de destinatarios. Use números de secuencia únicos para cada entidad a partir de 1, como 1,2,3,4...... Si una sola persona aparece varias veces en el flujo de trabajo de firma, asigne una secuencia diferente cada vez que se repita el destinatario. |
|
signerAuthLevels
|
signerAuthLevel | string |
Nivel de autenticación que un firmante aprovechará con fines de comprobación. |
|
|
Marcador de posición es
|
isPlaceholder | boolean |
Use este campo para iniciar la entidad es un marcador de posición. Nota: 1. firstName, lastName, el valor del parámetro emailId debe estar en blanco de esta entidad. 2. Para agregar el marcador de posición, se debe volver a guardar un destinatario con el permiso "PARTY_ASSIGNER". |
|
|
Rol de destinatario
|
partyRole | string |
Use este campo para asignar un rol de marcador de posición. |
|
|
Permitir cambio de nombre
|
allowNameChange | string |
El valor puede ser true o false Use este parámetro para permitir que el firmante actualice primero y el apellido antes de completar el proceso de firma. |
|
|
Secuencia de flujo de trabajo
|
workflowSequence | integer |
Asigne un número de secuencia de flujo de trabajo a este destinatario. Cuando la secuencia de inicio de sesión está habilitada, los destinatarios reciben su invitación de firma en orden ascendente de secuencia. |
|
|
Id. de correo electrónico de host
|
hostEmailId | string |
Dirección de correo electrónico del administrador de In-Person. |
|
|
Código de acceso
|
userDefinedAccessCode | string |
El parámetro contendrá Código de acceso cuando el valor "signerAuthLevel" esté establecido como "Código de acceso definido por el usuario" para la autenticación. Nota: 1. Los códigos no distinguen mayúsculas de minúsculas. 2. El sistema no envía este código, por lo que debe compartir este código directamente con el firmante. 3. El código de acceso puede contener alfabetos, números y los siguientes caracteres especiales: @,&,,{,}%,(,),~,|,!,+,^. |
|
|
La entidad es grupo de correo electrónico
|
partyIsEmailGroup | boolean |
Use este parámetro al crear una entidad como masiva. Nota: Si este parámetro es true, firstName, lastName y emailId de esta entidad se omitirán. |
|
|
Id. de grupo de correo electrónico
|
emailGroupId | integer |
Pase el correo electrónico el identificador de grupo que desea usar para crear de forma masiva. |
|
|
Single Signer Bulk
|
allowSingleSignerInBulk | boolean |
Use este parámetro para permitir que solo una persona inicie sesión en el grupo de correo electrónico. |
|
|
Código de marcado
|
dialingCode | string |
Use este campo para asignar códigos de acceso telefónico de país como prefijos de número de móvil a un destinatario de la lista de destinatarios. |
|
|
Número de móvil
|
mobileNumber | string |
Use este campo para asignar un número de móvil a un destinatario en la lista de partes de destinatarios. |
|
|
Campos
|
Fields | object | ||
|
Enviar ahora
|
sendNow | boolean |
Cuando está habilitada, Foxit eSign envía inmediatamente un vínculo de firma único a la dirección de correo electrónico de cada destinatario. Deshabilite esta opción para guardar el sobre como borrador en su lugar. |
|
|
Crear sesión de firma insertada
|
createEmbeddedSigningSession | True | boolean |
El token de sesión de firma se generará sin enviar correos electrónicos a los destinatarios. |
|
Crear sesión de firma insertada para todas las partes
|
createEmbeddedSigningSessionForAllParties | boolean |
Si se establece en true, se generará una dirección URL de firma incrustada para cada destinatario del sobre. |
|
|
Procesar etiquetas de texto
|
processTextTags | True | boolean |
El valor puede ser true o false. Este campo se usa para determinar si Foxit eSign debe analizar los documentos de etiquetas de texto para convertirlos en campos Foxit eSign. |
|
Procesar campos de Acro
|
processAcroFields | True | boolean |
Este campo se usa para determinar si Foxit eSign debe analizar los documentos de AcroFields para convertirlos en campos Foxit eSign. |
|
Secuencia de inicio de sesión
|
signInSequence | boolean |
Este campo se usa para determinar si los destinatarios firmarán los documentos de sobre en una secuencia. Si es false, todos los destinatarios reciben correo electrónico de invitación simultáneamente. Cuando es true, cada destinatario recibe el correo electrónico de invitación sucesivamente después de que el destinatario anterior complete la tarea necesaria, como firmar los documentos o rellenar campos, etc. |
|
|
Habilitar en persona
|
inPersonEnable | boolean |
Este campo se usa para iniciar el proceso de firma en persona que se puede completar fácilmente en cualquier dispositivo en cuestión de minutos y evitar firmas basadas en correo electrónico cuando sea necesario. Si es false, todos los destinatarios reciben el correo electrónico de invitación simultáneamente. Cuando es true, el administrador en persona recibe un correo electrónico de invitación para iniciar el proceso de firma del firmante. |
|
|
Corregir partes de destinatarios
|
fixRecipientParties | boolean |
Si es true, en la vista de envío insertada no puede cambiar las partes del sobre que ya se han agregado como parte de esta solicitud. |
|
|
Corregir documentos
|
fixDocuments | boolean |
Si es true, en el envío incrustado no puede cambiar los documentos del sobre que ya se han agregado como parte de esta solicitud. |
|
|
Enviar dirección URL correcta
|
sendSuccessUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje, a la que se redirigirá el firmante después de enviar correctamente la carpeta en la vista de envío incrustada. |
|
|
Dirección URL de error de envío
|
sendErrorUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje, a la que se redirigirá el firmante si se produce un error durante el envío de la carpeta en la vista de envío incrustada. |
|
|
Creación de una sesión de envío insertada
|
createEmbeddedSendingSession | boolean |
Si se establece en true, generará un token incrustado para abrir la vista de preparación del documento de Foxit eSign. |
|
|
Identificadores de correo electrónico de firmantes incrustados
|
embeddedSignersEmailIds | array of string |
Matriz de identificadores de correo electrónico de destinatarios para los que se debe crear una sesión de firma insertada. Identificadores de correo electrónico de los destinatarios agregados en la lista de partes. |
|
|
Sign Success Url
|
signSuccessUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá después de iniciar sesión correctamente en la vista de firma insertada. |
|
|
Dirección URL de rechazo de signo
|
signDeclineUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si rechaza iniciar sesión en la vista de firma insertada. |
|
|
Sign Later Url
|
signLaterUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si decide iniciar sesión más adelante en la vista de firma incrustada. |
|
|
Dirección URL del error de inicio de sesión
|
signErrorUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si se produce un error durante la firma del documento en la vista de firma incrustada. |
|
|
Permitir enviar ahora y sesión de firma insertada
|
allowSendNowAndEmbeddedSigningSession | boolean |
Si se establece como true, Foxit eSign enviará un vínculo de firma único a cada destinatario. Esto solo es aplicable cuando los parámetros sendNow y createEmbeddedSigningSession son true. |
|
|
Validación avanzada de correo electrónico
|
allowAdvancedEmailValidation | boolean |
Valide la dirección de correo electrónico de las partes cuando se establezca como true. |
|
|
Firmar la dirección URL de éxito de todas las partes
|
signSuccessUrlAllParties | boolean |
Si se establece como true, el firmante se redirigirá a la dirección URL proporcionada en signSuccessUrl después de firmar correctamente. Esto solo es aplicable cuando sendNow es true. |
|
|
Id. de plantilla de correo electrónico
|
emailTemplateId | integer |
Pase el identificador de plantilla de correo electrónico para enviar las plantillas de correo electrónico distintas de las plantillas de correo electrónico predeterminadas. |
|
|
Identificador de instrucción del firmante
|
signerInstructionId | integer |
Pase el identificador de instrucción para enviar instrucciones del firmante que no sean las instrucciones predeterminadas del firmante. |
|
|
Identificador de instrucción de confirmación
|
confirmationInstructionId | string |
Pase el identificador de instrucción de confirmación para enviar instrucciones de confirmación que no sean las instrucciones de confirmación predeterminadas. |
|
|
Color del tema
|
themeColor | string |
Escriba el valor CSS para establecer el color del tema. |
|
|
Expiración de sesión
|
sessionExpire | boolean |
Establezca como true para iniciar la expiración de la sesión de firma incrustada. |
|
|
Caducidad
|
expiry | integer |
Obligatorio si sessionExpire es true. Escriba la duración en milisegundos de la expiración en la sesión de firma incrustada. |
|
|
Nombre del campo dependiente
|
dependentFieldName | True | string |
Nombre del campo cuya visibilidad está controlada por el campo primario. |
|
Nombre del campo primario
|
parentFieldName | True | string |
Nombre del campo primario cuyo valor controla la visibilidad del campo dependiente. Tipos de campo primario admitidos: campo de texto, cuadro de texto, casilla, radiobutton, lista desplegable. |
|
Valor del campo primario
|
parentFieldValue | True | string |
Valor del campo primario que desencadena el campo dependiente para que sea visible. Para los campos de casilla y botón de radio, use activado o desactivado. |
|
Opciones
|
options | True | string |
Opciones de coincidencia adicionales para campos primarios basados en texto. Valores aceptados: isblank, allowNull, contains. |
|
Metadatos
|
metadata | object |
Debe estar en el par clave-valor. Se permiten 1000 pares de valores clave máximos. |
|
|
Correo electrónico del remitente
|
senderEmail | string |
Escriba el correo electrónico de otro usuario en su cuenta que se usará para enviar esta carpeta de documentos a las partes del destinatario. |
|
|
Ocultar el botón Agregarme
|
hideAddMeButton | boolean |
Si es true, ocultará el botón "Agregarme" en las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar el botón Agregar nuevo
|
hideAddNewButton | boolean |
Si es true, ocultará el botón "Agregar nuevo" en las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar el botón Agregar grupo
|
hideAddGroupButton | boolean |
Si es true, ocultará el botón "Agregar grupo" de las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar nombre de campo para destinatarios
|
hideFieldNameForRecipients | boolean |
Ocultar nombres de campo para destinatarios para campos de entrada de datos y campos avanzados. (Excepto botón de radio, Casilla, Imagen e Hipervínculo). |
|
|
Ocultar borde de casilla
|
hideCheckboxBorder | boolean |
Los bordes de checkbox se ocultarán en los documentos ejecutados. |
|
|
Ocultar opción de selección del firmante
|
hideSignerSelectOption | boolean |
Si es true, ocultará el cuadro de entrada "Nombre de firmante o correo electrónico existente" en Las partes del destinatario en una sesión de envío incrustada. |
|
|
Ocultar acciones del firmante
|
hideSignerActions | boolean |
Si es true, ocultará las acciones del firmante "editar", "cambiar" y "quitar" en las partes destinatarios en una sesión de envío incrustada. |
|
|
Ocultar nombre del remitente
|
hideSenderName | boolean |
Si es true, ocultará el nombre del remitente en las partes destinatarios en una sesión de envío incrustada. |
|
|
Ocultar nombre de carpeta
|
hideFolderName | boolean |
Si es true, ocultará el nombre de carpeta en la navegación en ambas sesiones incrustadas. |
|
|
Ocultar el nombre de los documentos
|
hideDocumentsName | boolean |
Si es true, ocultará el nombre del documento en ambas sesiones incrustadas. |
|
|
Ocultar rechazar para firmar
|
hideDeclineToSign | boolean |
Si es true, ocultará la opción "Rechazar a firmar" para el firmante. |
|
|
Ocultar más acción
|
hideMoreAction | boolean |
Si es true, ocultará el botón "Más acciones" en la sesión de envío o firma. En el caso de "Enviar ahora": true, no ocultará nada. |
|
|
Ocultar el botón Enviar
|
hideSendButton | boolean |
Si es true, ocultará el botón Enviar en la sesión de envío incrustada. |
|
|
Ocultar campo obligatorio siguiente
|
hideNextRequiredFieldbtn | boolean |
Si se establece en true, oculta el botón de navegación que mueve los firmantes al siguiente campo obligatorio. |
|
|
Se requieren ambas sesiones insertadas
|
requiredBothEmbeddedSession | boolean |
Si es true, generará las direcciones URL de envío y firma incrustadas juntas. |
|
|
Contraseña de sobre
|
folderPassword | string |
El firmante o autor necesitará esta contraseña para abrir el documento firmado digitalmente. Si el parámetro se mantiene en blanco, no se requerirá ninguna contraseña para abrir el documento firmado digitalmente. |
|
|
Habilitar paso a paso
|
enableStepByStep | boolean |
Para habilitar la acción paso a paso en la sesión de envío insertada. |
|
|
Ocultar la opción Agregar partes
|
hideAddPartiesOption | boolean |
Si es true, ocultará la opción para agregar partes en el modo borrador y creación de plantillas. |
|
|
Autofirme
|
selfSign | boolean |
Habilita autofirmado insertado a través de las API. Este parámetro solo es aplicable cuando el parámetro createEmbeddedSendingSession es true. |
|
|
Dirección URL correcta del firmante propio
|
selfSignerSuccessUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje en su sitio web o aplicación, a la que se redirigirá el usuario después de que autofirme correctamente el envío de la carpeta en la vista de envío incrustada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID
|
folder.folderId | integer |
Identificador único del sobre recién creado. Úselo en acciones posteriores para hacer referencia a este sobre. |
|
Nombre
|
folder.folderName | string |
Nombre del sobre recién creado. |
|
Nombre personalizado
|
folder.folderCustomName | string |
Un nombre personalizado para el sobre. |
|
Password
|
folder.folderPassword | string |
Contraseña de acceso para el sobre, si se establece. |
|
Id. del creador
|
folder.folderAuthorId | integer |
Identificador único del creador del sobre. |
|
Nombre del creador
|
folder.folderAuthorFirstName | string |
Nombre del creador del sobre. |
|
Apellidos del creador
|
folder.folderAuthorLastName | string |
Apellidos del creador del sobre. |
|
Correo electrónico del creador
|
folder.folderAuthorEmail | string |
Dirección de correo electrónico del creador del sobre. |
|
Rol de creador
|
folder.folderAuthorRole | string |
Rol del creador del sobre. |
|
Id. de empresa
|
folder.folderCompanyId | integer |
Identificador único de la empresa que posee el sobre. |
|
Fecha de creación
|
folder.folderCreationDate | integer |
Fecha en que se creó el sobre (marca de tiempo de Unix en milisegundos). |
|
Fecha de envío
|
folder.folderSentDate | integer |
Fecha en que se envió el sobre (marca de tiempo de Unix en milisegundos). |
|
Situación
|
folder.folderStatus | string |
Estado actual del sobre. |
|
Campo personalizado 1
|
folder.custom_field1 | string |
Primer campo de metadatos personalizado para el sobre. |
|
Campo personalizado 2
|
folder.custom_field2 | string |
Segundo campo de metadatos personalizado para el sobre. |
|
Metadatos
|
folder.metadata | string |
Metadatos personalizados asociados al sobre. |
|
ID de documento
|
folder.folderDocumentIds | array of integer |
Lista de identificadores de documento incluidos en el sobre. |
|
Documentos
|
folder.documentsList | array of object |
Lista de documentos en el sobre. |
|
Id. de documento
|
folder.documentsList.documentId | integer |
Identificador único del documento. |
|
Id. de contrato
|
folder.documentsList.contractId | integer |
Identificador único del contrato. |
|
Id. de empresa
|
folder.documentsList.companyId | integer |
Identificador único de la empresa. |
|
Autor
|
folder.documentsList.contractCreatedBy | integer |
Identificador de usuario de la persona que creó el contrato. |
|
Creado el
|
folder.documentsList.contractCreatedOn | string |
Fecha y hora en que se creó el contrato. |
|
Tipo contrato
|
folder.documentsList.contractType | string |
Tipo del contrato. |
|
Estado del contrato
|
folder.documentsList.contractStatus | string |
Estado actual del contrato. |
|
Editable
|
folder.documentsList.editable | boolean |
Indica si el elemento se puede editar. |
|
Id. de la versión
|
folder.documentsList.contractVersionId | integer |
Identificador único de la versión del contrato. |
|
Nombre de la versión
|
folder.documentsList.contractVersionName | string |
Nombre de la versión del contrato. |
|
Descripción de la versión
|
folder.documentsList.contractVersionDesc | string |
Descripción de la versión del contrato. |
|
Versión creada por
|
folder.documentsList.versionCreatedby | integer |
Identificador de usuario de la persona que creó esta versión. |
|
Versión creada en
|
folder.documentsList.versionCreatedOn | string |
Fecha y hora en que se creó esta versión. |
|
Número de versión
|
folder.documentsList.contractVersionNumber | integer |
Número de versión del contrato. |
|
Origen de la transacción
|
folder.documentsList.contractTransactionSource | string |
Sistema de origen que inició la transacción del contrato. |
|
Recipientes
|
folder.folderRecipientParties | array of object |
Lista de partes de destinatarios para este sobre. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyDetails.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
folder.folderRecipientParties.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
folder.folderRecipientParties.partyDetails.lastName | string |
Apellidos del destinatario. |
|
dirección Email
|
folder.folderRecipientParties.partyDetails.emailId | string |
Dirección de correo electrónico del destinatario. |
|
Marcador de posición
|
folder.folderRecipientParties.partyDetails.placeholder | boolean |
Indica si esta entidad es un destinatario de marcador de posición. |
|
Dirección
|
folder.folderRecipientParties.partyDetails.address | string |
Dirección física del destinatario. |
|
Fecha de creación
|
folder.folderRecipientParties.partyDetails.dateCreated | integer |
Fecha en que se creó el registro (marca de tiempo de Unix en milisegundos). |
|
Rechazar correos electrónicos
|
folder.folderRecipientParties.partyDetails.optOutEmails | boolean |
Indica si el destinatario ha optado por no recibir notificaciones por correo electrónico. |
|
Identificador de destinatario único
|
folder.folderRecipientParties.partyDetails.uniquePartyId | string |
Identificador único del sistema para este destinatario. |
|
Nivel de autenticación
|
folder.folderRecipientParties.partyDetails.authenticationLevel | string |
Método de autenticación necesario para este destinatario. |
|
Fecha de actualización de contraseña
|
folder.folderRecipientParties.partyDetails.passwordUpdateDate | string |
Fecha en que se actualizó la contraseña por última vez. |
|
Estado actualizado de contraseña
|
folder.folderRecipientParties.partyDetails.passwordUpdateStatus | boolean |
Indica si la contraseña se ha actualizado. |
|
Id. de empresa
|
folder.folderRecipientParties.partyDetails.companyId | integer |
Identificador único de la empresa. |
|
Rol de usuario
|
folder.folderRecipientParties.partyDetails.userRole | string |
El rol asignado al usuario. |
|
Departamento
|
folder.folderRecipientParties.partyDetails.department | string |
Departamento al que pertenece el usuario. |
|
Title
|
folder.folderRecipientParties.partyDetails.title | string |
el puesto del usuario. |
|
Activo
|
folder.folderRecipientParties.partyDetails.active | boolean |
Indica si el usuario o el registro están activos. |
|
Configuración regional
|
folder.folderRecipientParties.partyDetails.requestLocale | string |
Configuración regional del usuario. |
|
Uso compartido con Dept
|
folder.folderRecipientParties.partyDetails.share_among_department | boolean |
Indica si los sobres se comparten entre el departamento. |
|
Código de marcado
|
folder.folderRecipientParties.partyDetails.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.folderRecipientParties.partyDetails.mobileNumber | string |
Número de teléfono móvil. |
|
Filtro de estado
|
folder.folderRecipientParties.partyDetails.docStatusFilter | string |
Filtro para el estado del documento. |
|
Filtro de fecha
|
folder.folderRecipientParties.partyDetails.docDateFilter | string |
Filtro para la fecha del documento. |
|
Acceso seguro a campos
|
folder.folderRecipientParties.partyDetails.userSecureFieldAccess | boolean |
Indica si el usuario tiene acceso a campos seguros. |
|
Expandir barra lateral
|
folder.folderRecipientParties.partyDetails.expandSidebar | boolean |
Indica si la barra lateral se expande de forma predeterminada. |
|
Validación de correo electrónico de Adv
|
folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation | boolean |
Indica si la validación avanzada de correo electrónico está habilitada. |
|
Id. de administrador
|
folder.folderRecipientParties.partyDetails.managerId | string |
Identificador único del administrador del usuario. |
|
Recuento de inicios de sesión
|
folder.folderRecipientParties.partyDetails.loginCount | integer |
Número de veces que el usuario ha iniciado sesión. |
|
Correo electrónico de restablecimiento de contraseña
|
folder.folderRecipientParties.partyDetails.sendMailForPasswordReset | boolean |
Indica si se debe enviar un correo electrónico de restablecimiento de contraseña. |
|
Id. de departamento
|
folder.folderRecipientParties.partyDetails.departmentId | string |
Identificador único del departamento. |
|
Empresa principal
|
folder.folderRecipientParties.partyDetails.userPrimaryCompany | integer |
La empresa principal asociada al usuario. |
|
Tipo de dispositivo
|
folder.folderRecipientParties.partyDetails.deviceType | string |
Tipo de dispositivo usado. |
|
Token de dispositivo
|
folder.folderRecipientParties.partyDetails.deviceToken | string |
Token de notificación de inserción para el dispositivo. |
|
Descripción del subcontratista
|
folder.folderRecipientParties.partyDetails.subcontractorDescription | string |
Descripción del subcontratista o firmante externo. |
|
Organización de subcontratistas
|
folder.folderRecipientParties.partyDetails.subcontractorOrganization | string |
Nombre de la organización del subcontratista o firmante externo. |
|
Fecha de incorporación del subcontratista
|
folder.folderRecipientParties.partyDetails.subcAddedDate | integer |
Fecha en que se agregó el subcontratista (marca de tiempo de Unix en milisegundos). |
|
Source
|
folder.folderRecipientParties.partyDetails.source | string |
Sistema de origen desde el que se agregó el firmante externo. |
|
Código de marcado
|
folder.folderRecipientParties.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.folderRecipientParties.mobileNumber | string |
Número de teléfono móvil. |
|
Tipo de firma
|
folder.folderRecipientParties.signerSignatureType | string |
Tipo de firma que usará el firmante. |
|
Permisos
|
folder.folderRecipientParties.contractPermissions | string |
Permisos concedidos a esta parte para el contrato. |
|
Orden de firma
|
folder.folderRecipientParties.partySequence | integer |
Número de secuencia de orden de firma para este destinatario. |
|
Secuencia de flujo de trabajo
|
folder.folderRecipientParties.workflowSignSequence | integer |
Número de secuencia de firma de flujo de trabajo. |
|
Id. de sobre
|
folder.folderRecipientParties.envelopeId | integer |
Identificador único del sobre. |
|
Id. de empresa del destinatario
|
folder.folderRecipientParties.partyCompanyId | integer |
Identificador único de la empresa asociada a este destinatario. |
|
Modo de uso compartido
|
folder.folderRecipientParties.sharingMode | string |
Modo de uso compartido para este sobre. |
|
Dirección URL de acceso del destinatario
|
folder.folderRecipientParties.folderAccessURL | string |
La dirección URL que el destinatario puede usar para acceder al sobre y firmarlo. |
|
Modo de seguridad
|
folder.folderRecipientParties.securityMode | string |
Modo de seguridad aplicado a este sobre. |
|
Comments
|
folder.folderRecipientParties.extraComments | string |
Comentarios adicionales incluidos con el sobre. |
|
Permitir cambio de nombre
|
folder.folderRecipientParties.allowNameChange | boolean |
Indica si el destinatario puede actualizar su nombre. |
|
Nombre actualizado
|
folder.folderRecipientParties.signerNameUpdated | boolean |
Indica si el firmante ha actualizado su nombre. |
|
Nivel de autenticación del firmante
|
folder.folderRecipientParties.signerAuthenticationLevel | string |
Nivel de autenticación necesario para el firmante. |
|
Código de acceso
|
folder.folderRecipientParties.userDefinedAccessCode | string |
Código de acceso personalizado definido para el firmante. |
|
Id. de firma
|
folder.folderRecipientParties.signatureId | string |
Identificador único de la firma. |
|
Rol de destinatario
|
folder.folderRecipientParties.partyRole | string |
Rol asignado a este destinatario en el flujo de trabajo de firma. |
|
Campo de empresa
|
folder.folderRecipientParties.companyFieldValue | string |
Valor del campo nombre de la compañía en la firma. |
|
Campo de título
|
folder.folderRecipientParties.titleFieldValue | string |
Valor del campo de título de la firma. |
|
Motivo de la firma
|
folder.folderRecipientParties.reasonSigning | string |
Motivo por el que el destinatario firma el documento. |
|
Campo de pago agregado
|
folder.folderRecipientParties.payFieldAdded | boolean |
Indica si se ha agregado un campo de pago. |
|
Beneficiario
|
folder.folderRecipientParties.payee | boolean |
Indica si este destinatario es el receptor. |
|
Pago periódico
|
folder.folderRecipientParties.recurringFieldExist | boolean |
Indica si existe un campo de pago periódico. |
|
Imprimir y firmar listo
|
folder.folderRecipientParties.printAndSignCompleted | boolean |
Indica si se ha completado el proceso de impresión y firma. |
|
Pagado
|
folder.folderRecipientParties.paid | boolean |
Indica si se ha completado el pago. |
|
Firmante opcional permitido
|
folder.folderRecipientParties.allowOptionalSigner | boolean |
Indica si este destinatario es un firmante opcional. |
|
Firmantes opcionales
|
folder.folderRecipientParties.optionalSigners | array of integer |
Lista de identificadores de entidad de firmante opcionales para este sobre. |
|
Dirección URL de firma del autor
|
folder.folderAccessURLForAuthor | string |
Dirección URL que el remitente puede usar para acceder al sobre. |
|
Dirección URL de acceso de borrador
|
folder.draftFolderAccessURL | string |
Dirección URL usada para acceder a la versión de borrador del sobre. |
|
Firma de sala de juntas
|
folder.boardRoomSign | boolean |
Indica si el modo de firma de sala de juntas está habilitado. |
|
Incluir logotipo
|
folder.includeLogo | boolean |
Indica si el logotipo de la empresa se incluye en los correos electrónicos. |
|
Color de fondo del botón
|
folder.email_btnBgColor | string |
Color de fondo del botón de correo electrónico. |
|
Color del texto del botón
|
folder.email_btnTxtColor | string |
Color de texto del botón de correo electrónico. |
|
Logotipo de correo electrónico
|
folder.emailTemplateLogo | string |
Dirección URL del logotipo usada en la plantilla de correo electrónico. |
|
Id. de plantilla de correo electrónico
|
folder.emailTemplateId | integer |
Identificador único de la plantilla de correo electrónico. |
|
Encabezado de correo electrónico
|
folder.emailHeader | string |
Texto del encabezado usado en los correos electrónicos de notificación. |
|
Pie de página de correo electrónico
|
folder.emailFooter | string |
Texto del pie de página usado en los correos electrónicos de notificación. |
|
Purga programada
|
folder.purgeFlag | boolean |
Indica si el sobre está programado para purgar. |
|
Purgar fecha de inicio
|
folder.purgeStartDate | string |
Fecha a partir de la cual se programa la purga. |
|
Purgar fecha de finalización
|
folder.purgeEndDate | string |
Fecha en la que se ha programado la purga para completarse. |
|
Id. de envío masivo
|
folder.bulkId | integer |
Identificador único de la operación de envío masivo. |
|
Exigir orden de firma
|
folder.enforceSignWorkflow | boolean |
Indica si los destinatarios deben iniciar sesión en la secuencia definida. |
|
Paso actual
|
folder.currentWorkflowStep | integer |
Paso actual del flujo de trabajo de firma. |
|
Origen de la transacción
|
folder.transactionSource | string |
Sistema de origen que inició esta transacción. |
|
Editable
|
folder.editable | boolean |
Indica si el elemento se puede editar. |
|
firma de In-Person
|
folder.inPersonSignable | boolean |
Indica si el sobre se puede iniciar sesión en persona. |
|
Invalidar recordatorios
|
folder.overrideAccountReminders | boolean |
Indica si se invalida la configuración de aviso de nivel de cuenta. |
|
Invalidar delegación
|
folder.overrideAccountRecipientDelegation | boolean |
Indica si la configuración de delegación de nivel de cuenta se invalida. |
|
Permitir delegación
|
folder.allowRecipientsToDelegate | boolean |
Indica si los destinatarios pueden delegar la firma. |
|
ID
|
folder.envelopeId | integer |
Identificador único del sobre. |
|
Nombre
|
folder.envelopeName | string |
Nombre del sobre. |
|
Id. del originador
|
folder.envelopeOriginatorId | integer |
Identificador único del usuario que creó el sobre. |
|
Id. de empresa
|
folder.envelopeCompanyId | integer |
Identificador único de la empresa que posee el sobre. |
|
Date
|
folder.envelopeDate | integer |
Fecha en que se creó el sobre (marca de tiempo de Unix en milisegundos). |
|
Fecha compartida
|
folder.envelopeSharedDate | integer |
Fecha en que se compartió el sobre (marca de tiempo de Unix en milisegundos). |
|
Situación
|
folder.envelopeStatus | string |
Estado actual del sobre. |
|
Identificadores de contrato
|
folder.envelopeContractIds | array of integer |
Lista de identificadores de contrato asociados a este sobre. |
|
Permisos de destinatario
|
folder.envelopePartyPermissions | array of object |
Lista de permisos de destinatario para este sobre. |
|
Id. del destinatario
|
folder.envelopePartyPermissions.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
folder.envelopePartyPermissions.partyDetails.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
folder.envelopePartyPermissions.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
folder.envelopePartyPermissions.partyDetails.lastName | string |
Apellidos del destinatario. |
|
dirección Email
|
folder.envelopePartyPermissions.partyDetails.emailId | string |
Dirección de correo electrónico del destinatario. |
|
Marcador de posición
|
folder.envelopePartyPermissions.partyDetails.placeholder | boolean |
Indica si esta entidad es un destinatario de marcador de posición. |
|
Dirección
|
folder.envelopePartyPermissions.partyDetails.address | string |
Dirección física del destinatario. |
|
Fecha de creación
|
folder.envelopePartyPermissions.partyDetails.dateCreated | integer |
Fecha en que se creó el registro (marca de tiempo de Unix en milisegundos). |
|
Rechazar correos electrónicos
|
folder.envelopePartyPermissions.partyDetails.optOutEmails | boolean |
Indica si el destinatario ha optado por no recibir notificaciones por correo electrónico. |
|
Identificador de destinatario único
|
folder.envelopePartyPermissions.partyDetails.uniquePartyId | string |
Identificador único del sistema para este destinatario. |
|
Nivel de autenticación
|
folder.envelopePartyPermissions.partyDetails.authenticationLevel | string |
Método de autenticación necesario para este destinatario. |
|
Fecha de actualización de contraseña
|
folder.envelopePartyPermissions.partyDetails.passwordUpdateDate | string |
Fecha en que se actualizó la contraseña por última vez. |
|
Estado actualizado de contraseña
|
folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus | boolean |
Indica si la contraseña se ha actualizado. |
|
Id. de empresa
|
folder.envelopePartyPermissions.partyDetails.companyId | integer |
Identificador único de la empresa. |
|
Rol de usuario
|
folder.envelopePartyPermissions.partyDetails.userRole | string |
El rol asignado al usuario. |
|
Departamento
|
folder.envelopePartyPermissions.partyDetails.department | string |
Departamento al que pertenece el usuario. |
|
Title
|
folder.envelopePartyPermissions.partyDetails.title | string |
el puesto del usuario. |
|
Activo
|
folder.envelopePartyPermissions.partyDetails.active | boolean |
Indica si el usuario o el registro están activos. |
|
Configuración regional
|
folder.envelopePartyPermissions.partyDetails.requestLocale | string |
Configuración regional del usuario. |
|
Uso compartido con Dept
|
folder.envelopePartyPermissions.partyDetails.share_among_department | boolean |
Indica si los sobres se comparten entre el departamento. |
|
Código de marcado
|
folder.envelopePartyPermissions.partyDetails.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.envelopePartyPermissions.partyDetails.mobileNumber | string |
Número de teléfono móvil. |
|
Filtro de estado
|
folder.envelopePartyPermissions.partyDetails.docStatusFilter | string |
Filtro para el estado del documento. |
|
Filtro de fecha
|
folder.envelopePartyPermissions.partyDetails.docDateFilter | string |
Filtro para la fecha del documento. |
|
Acceso seguro a campos
|
folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess | boolean |
Indica si el usuario tiene acceso a campos seguros. |
|
Expandir barra lateral
|
folder.envelopePartyPermissions.partyDetails.expandSidebar | boolean |
Indica si la barra lateral se expande de forma predeterminada. |
|
Validación de correo electrónico de Adv
|
folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation | boolean |
Indica si la validación avanzada de correo electrónico está habilitada. |
|
Id. de administrador
|
folder.envelopePartyPermissions.partyDetails.managerId | string |
Identificador único del administrador del usuario. |
|
Recuento de inicios de sesión
|
folder.envelopePartyPermissions.partyDetails.loginCount | integer |
Número de veces que el usuario ha iniciado sesión. |
|
Correo electrónico de restablecimiento de contraseña
|
folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset | boolean |
Indica si se debe enviar un correo electrónico de restablecimiento de contraseña. |
|
Id. de departamento
|
folder.envelopePartyPermissions.partyDetails.departmentId | string |
Identificador único del departamento. |
|
Empresa principal
|
folder.envelopePartyPermissions.partyDetails.userPrimaryCompany | integer |
La empresa principal asociada al usuario. |
|
Tipo de dispositivo
|
folder.envelopePartyPermissions.partyDetails.deviceType | string |
Tipo de dispositivo usado. |
|
Token de dispositivo
|
folder.envelopePartyPermissions.partyDetails.deviceToken | string |
Token de notificación de inserción para el dispositivo. |
|
Descripción del subcontratista
|
folder.envelopePartyPermissions.partyDetails.subcontractorDescription | string |
Descripción del subcontratista o firmante externo. |
|
Organización de subcontratistas
|
folder.envelopePartyPermissions.partyDetails.subcontractorOrganization | string |
Nombre de la organización del subcontratista o firmante externo. |
|
Fecha de incorporación del subcontratista
|
folder.envelopePartyPermissions.partyDetails.subcAddedDate | integer |
Fecha en que se agregó el subcontratista (marca de tiempo de Unix en milisegundos). |
|
Source
|
folder.envelopePartyPermissions.partyDetails.source | string |
Sistema de origen desde el que se agregó el firmante externo. |
|
Código de marcado
|
folder.envelopePartyPermissions.dialingCode | string |
El código de marcado internacional para el número de teléfono. |
|
Número de móvil
|
folder.envelopePartyPermissions.mobileNumber | string |
Número de teléfono móvil. |
|
Tipo de firma
|
folder.envelopePartyPermissions.signerSignatureType | string |
Tipo de firma que usará el firmante. |
|
Permisos
|
folder.envelopePartyPermissions.contractPermissions | string |
Permisos concedidos a esta parte para el contrato. |
|
Orden de firma
|
folder.envelopePartyPermissions.partySequence | integer |
Número de secuencia de orden de firma para este destinatario. |
|
Secuencia de flujo de trabajo
|
folder.envelopePartyPermissions.workflowSignSequence | integer |
Número de secuencia de firma de flujo de trabajo. |
|
Id. de sobre
|
folder.envelopePartyPermissions.envelopeId | integer |
Identificador único del sobre. |
|
Id. de empresa del destinatario
|
folder.envelopePartyPermissions.partyCompanyId | integer |
Identificador único de la empresa asociada a este destinatario. |
|
Modo de uso compartido
|
folder.envelopePartyPermissions.sharingMode | string |
Modo de uso compartido para este sobre. |
|
Dirección URL de acceso del destinatario
|
folder.envelopePartyPermissions.folderAccessURL | string |
La dirección URL que el destinatario puede usar para acceder al sobre y firmarlo. |
|
Modo de seguridad
|
folder.envelopePartyPermissions.securityMode | string |
Modo de seguridad aplicado a este sobre. |
|
Comments
|
folder.envelopePartyPermissions.extraComments | string |
Comentarios adicionales incluidos con el sobre. |
|
Permitir cambio de nombre
|
folder.envelopePartyPermissions.allowNameChange | boolean |
Indica si el destinatario puede actualizar su nombre. |
|
Nombre actualizado
|
folder.envelopePartyPermissions.signerNameUpdated | boolean |
Indica si el firmante ha actualizado su nombre. |
|
Nivel de autenticación del firmante
|
folder.envelopePartyPermissions.signerAuthenticationLevel | string |
Nivel de autenticación necesario para el firmante. |
|
Código de acceso
|
folder.envelopePartyPermissions.userDefinedAccessCode | string |
Código de acceso personalizado definido para el firmante. |
|
Id. de firma
|
folder.envelopePartyPermissions.signatureId | string |
Identificador único de la firma. |
|
Rol de destinatario
|
folder.envelopePartyPermissions.partyRole | string |
Rol asignado a este destinatario en el flujo de trabajo de firma. |
|
Campo de empresa
|
folder.envelopePartyPermissions.companyFieldValue | string |
Valor del campo nombre de la compañía en la firma. |
|
Campo de título
|
folder.envelopePartyPermissions.titleFieldValue | string |
Valor del campo de título de la firma. |
|
Motivo de la firma
|
folder.envelopePartyPermissions.reasonSigning | string |
Motivo por el que el destinatario firma el documento. |
|
Campo de pago agregado
|
folder.envelopePartyPermissions.payFieldAdded | boolean |
Indica si se ha agregado un campo de pago. |
|
Beneficiario
|
folder.envelopePartyPermissions.payee | boolean |
Indica si este destinatario es el receptor. |
|
Pago periódico
|
folder.envelopePartyPermissions.recurringFieldExist | boolean |
Indica si existe un campo de pago periódico. |
|
Imprimir y firmar listo
|
folder.envelopePartyPermissions.printAndSignCompleted | boolean |
Indica si se ha completado el proceso de impresión y firma. |
|
Pagado
|
folder.envelopePartyPermissions.paid | boolean |
Indica si se ha completado el pago. |
|
Nivel de autenticación
|
folder.envelopeAuthenticationLevel | string |
Nivel de autenticación necesario para el sobre. |
|
Single Signer Bulk
|
folder.allowSingleSignerInBulk | boolean |
Indica si se permite un firmante único en modo de envío masivo. |
|
nomenclatura de File-Based
|
folder.folderNameBasedOnFileNaming | boolean |
Indica si el nombre de la carpeta se basa en el nombre de archivo. |
|
Nombre de File-Based de documento
|
folder.documentNameBasedOnFileNaming | boolean |
Indica si el nombre del documento se basa en el nombre de archivo. |
|
Nombre del File-Based de certificado
|
folder.certificateNameBasedOnFileNaming | boolean |
Indica si el nombre del certificado se basa en el nombre de archivo. |
|
Nomenclatura de archivos anteriores a exec
|
folder.enableFileNamingBeforeExecution | boolean |
Indica si la nomenclatura de archivos está habilitada antes de la ejecución del documento. |
|
Pago agregado
|
folder.payeeAddedd | boolean |
Indica si se ha agregado un beneficiario. |
|
Self-Signing habilitado
|
folder.selfSignerEnabled | boolean |
Indica si el modo de autofirma está habilitado. |
|
Notary Enabled
|
folder.notaryEnabled | boolean |
Indica si la firma notaria está habilitada. |
|
Visibilidad limitada
|
folder.limitedVisibilityFlag | boolean |
Indica si la visibilidad limitada está habilitada para este sobre. |
|
Visibilidad posterior al inicio de sesión
|
folder.postSigningVisibility | boolean |
Indica si la visibilidad posterior a la firma está habilitada. |
|
Firma mojada
|
folder.wetSignatureEnabled | boolean |
Indica si las firmas húmedas están habilitadas. |
|
Combinar habilitado
|
folder.mergeEnabled | boolean |
Indica si la combinación de documentos está habilitada. |
|
Sesiones de firma insertadas
|
embeddedSigningSessions | array of object |
La lista de sesiones de firma incrustadas, una por destinatario. Solo está presente cuando createEmbeddedSigningSession es true. |
|
Correo electrónico del firmante
|
embeddedSigningSessions.emailIdOfSigner | string |
Dirección de correo electrónico del destinatario para esta sesión de firma incrustada. |
|
Token de firma
|
embeddedSigningSessions.embeddedToken | string |
Token único para la sesión de firma incrustada de este destinatario. |
|
Dirección URL de sesión de firma
|
embeddedSigningSessions.embeddedSessionURL | string |
Dirección URL que se va a abrir o insertar para que este destinatario firme el documento. |
|
Token de envío insertado
|
embeddedToken | string |
Token para la sesión de envío insertada. Solo está presente cuando createEmbeddedSendingSession es true. |
|
Enviar dirección URL de sesión
|
embeddedSessionURL | string |
Dirección URL que se va a abrir o insertar para que el autor del sobre prepare y envíe el sobre. Solo está presente cuando createEmbeddedSendingSession es true. |
|
Result
|
result | string |
Resultado de la operación. |
|
Message
|
message | string |
Mensaje que describe el resultado de la operación. |
Creación de una plantilla a partir de Base64
Crea una plantilla con una cadena PDF codificada en Base64. Úselo cuando el archivo PDF ya esté disponible como una cadena Base64 en el flujo, por ejemplo, desde un archivo SharePoint o un documento de OneDrive.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la plantilla
|
templateName | True | string |
Nombre de la plantilla. Debe terminar con la extensión .pdf (por ejemplo, onboarding.pdf). |
|
Cadena de archivo Base64
|
base64FileString | True | string |
Cadena BASE64 de un PDF para la creación de plantillas. Debe ser accesible públicamente al crear la plantilla. |
|
Tipo de entrada
|
inputType | True | string |
Método de entrada del documento. Establezca siempre en "base64" para esta acción. |
|
Procesar etiquetas de texto
|
processTextTags | True | boolean |
Cuando se habilita, Foxit eSign examinará el documento para etiquetas de texto y los convertirá automáticamente en campos de firma. |
|
Procesar campos de Acro
|
processAcroFields | True | boolean |
Cuando se habilita, Foxit eSign examinará el documento para AcroFields y los convertirá automáticamente en campos de firma. |
|
Compartir todo
|
shareAll | True | boolean |
Comparta esta plantilla con todos los usuarios de su cuenta. |
|
Número de partes
|
numberOfParties | True | integer |
Número de partes de destinatarios para esta plantilla. Debe ser menor que 20. |
|
Color del tema
|
themeColor | string |
Valor de color CSS para personalizar el tema de la sesión de plantilla incrustada (por ejemplo, #42caf4). |
|
|
Crear Email
|
authorEmail | string |
Dirección de correo electrónico de otro usuario de la cuenta que se va a establecer como autor de esta plantilla. |
|
|
Crear sesión de plantilla insertada
|
createEmbeddedTemplateSession | boolean |
Si se establece en true, se crea una sesión de plantilla insertada para que pueda abrir el editor de plantillas foxit eSign directamente y arrastrar y colocar campos en la plantilla. |
|
|
Dirección URL de redireccionamiento
|
redirectURL | string |
Si crear sesión de plantilla incrustada es true, la dirección URL a la que redirigir el usuario después de hacer clic en Guardar y cerrar en el editor de plantillas incrustado. |
|
|
Ocultar plantilla de envío
|
hideSendTemplate | boolean |
Si es true, el botón Enviar está oculto en el editor de plantillas incrustado. |
|
|
Corregir partes de destinatarios
|
fixRecipientParties | boolean |
Si es true, los destinatarios ya agregados no se pueden cambiar en el editor de plantillas incrustado. |
|
|
Campos
|
Fields | object | ||
|
permissions
|
permission | True | string | |
|
Secuencia
|
sequence | True | integer |
Número de secuencia único para esta entidad, a partir de 1. Define el orden de firma cuando la secuencia de inicio de sesión está habilitada. |
|
Rol de destinatario
|
partyRole | True | string |
Rol asignado a esta entidad en la plantilla. |
|
Ocultar más acción
|
hideMoreAction | boolean |
Si es true, el botón Más acciones se oculta en la sesión de plantilla incrustada. |
|
|
Ocultar compartir con todos
|
hideShareWithAll | boolean |
Si es true, la opción Compartir con todo está oculta en la sesión de plantilla incrustada. |
|
|
Ocultar agregar entidad
|
hideAddParty | boolean |
Si es true, todas las opciones de agregar entidad se ocultan en la sesión de plantilla incrustada. |
|
|
Botón Ocultarme
|
hideMeButton | boolean |
Si es true, el botón Me de las partes destinatarios está oculto en la sesión de plantilla insertada. |
|
|
Ocultar otros botones
|
hideOthersButton | boolean |
Si es true, el botón Otros de las partes destinatarios se oculta en la sesión de plantilla insertada. |
|
|
Ocultar nombre de campo para destinatarios
|
hideFieldNameForRecipients | boolean |
Si es true, los nombres de campo están ocultos de los destinatarios para la entrada de datos y los campos avanzados. |
|
|
Ocultar borde de casilla
|
hideCheckboxBorder | boolean |
Si es true, los bordes de casilla están ocultos en los documentos ejecutados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la operación se realizó correctamente (por ejemplo, "correcto"). |
|
Message
|
message | string |
Descripción del resultado de la operación. |
|
ID
|
template.templateId | integer |
Identificador único de la plantilla creada. Úselo para crear sobres a partir de esta plantilla. |
|
Nombre
|
template.templateName | string |
El nombre de la plantilla. |
|
Description
|
template.templateDesc | string |
Descripción de la plantilla. |
|
Tipo
|
template.templateType | string |
Tipo de la plantilla. |
|
Fecha de creación
|
template.templateCreationDate | string |
Fecha en que se creó la plantilla. |
|
Fecha de última actualización
|
template.templateLastUpdateDate | string |
Fecha en que la plantilla se actualizó por última vez. |
|
Editable
|
template.editable | boolean |
Indica si se puede editar la plantilla. |
|
Número de partes
|
template.numberOfParties | integer |
Número de entidades de destinatario definidas en la plantilla. |
|
Total de páginas
|
template.totalPages | integer |
Número total de páginas del documento de plantilla. |
|
Id. de empresa
|
template.companyId | integer |
El identificador de la empresa a la que pertenece esta plantilla. |
|
Compartido con todos
|
template.shareAll | boolean |
Indica si esta plantilla se comparte con todos los usuarios de la cuenta. |
|
Permisos de entidad
|
template.templatePartyPermissions | array of object |
La lista de roles de destinatario y sus permisos definidos en esta plantilla. |
|
Id. de parte
|
template.templatePartyPermissions.template_party_id | integer |
Identificador único de esta entrada de entidad de plantilla. |
|
ID
|
template.templatePartyPermissions.templateId | integer |
El identificador de la plantilla a la que pertenece esta entidad. |
|
Permisos
|
template.templatePartyPermissions.templatePermissions | string |
Permisos de firma para esta entidad (por ejemplo, FILL_FIELDS_AND_SIGN). |
|
Orden de firma
|
template.templatePartyPermissions.partySequence | integer |
Posición del pedido de firma para esta entidad. |
|
Rol de entidad
|
template.templatePartyPermissions.templatePartyRole | string |
Nombre de rol asignado a esta entidad en la plantilla. Úselo al crear un sobre a partir de la plantilla. |
|
Id. de usuario
|
template.templateCreatedBy.partyId | integer |
Identificador único del usuario. |
|
Nombre
|
template.templateCreatedBy.firstName | string |
Nombre del usuario. |
|
Apellido
|
template.templateCreatedBy.lastName | string |
Apellidos del usuario. |
|
Correo Electrónico
|
template.templateCreatedBy.emailId | string |
La dirección de correo electrónico del usuario. |
|
Campos de plantilla
|
allfields | array of object |
Lista de todos los campos de firma y formulario definidos en la plantilla. |
|
Id. de campo
|
allfields.fieldTagId | integer |
Identificador único del campo. |
|
Identificador de plantilla
|
allfields.templateId | integer |
Identificador de la plantilla a la que pertenece este campo. |
|
Id. de empresa
|
allfields.companyId | integer |
La cuenta de empresa a la que pertenece este campo. |
|
Tipo de campo
|
allfields.fieldType | string |
El tipo del campo (por ejemplo, campo de signo, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield). |
|
Número de página
|
allfields.documentPageNumber | integer |
Número de página del documento donde se coloca este campo. |
|
Parte responsable
|
allfields.partyResponsible | integer |
Número de secuencia de entidad responsable de rellenar este campo. |
|
Secuencia de fiesta
|
allfields.partyResponsibleSequence | integer |
Posición de secuencia del responsable. |
|
Id. de documento de campo
|
allfields.docFieldId | string |
Identificador de nivel de documento para este campo. |
|
Depende
|
allfields.dependent | boolean |
Indica si la visibilidad de este campo depende del valor de otro campo. |
|
Orden de tabulación
|
allfields.tabOrder | integer |
Orden de tabulación para navegar entre campos. |
|
Obligatorio
|
allfields.required | boolean |
Indica si este campo debe rellenarse antes de que se pueda firmar el documento. |
|
Nombre de campo personalizado
|
allfields.customFieldName | string |
Nombre personalizado asignado a este campo. |
|
Compartir todo
|
allfields.shareAll | boolean |
Indica si este campo se comparte con todos los usuarios. |
|
Permitir edición
|
allfields.allowEdit | boolean |
Indica si el destinatario puede editar este campo. |
|
Nombre del campo de texto
|
allfields.textfieldName | string |
Etiqueta del campo de texto (aplicable cuando fieldType es 'textfield'). |
|
Value
|
allfields.value | string |
Valor rellenado previamente o escrito del campo. |
|
Tamaño de fuente
|
allfields.fontSize | integer |
Tamaño de fuente usado para el texto de este campo. |
|
Color de fuente
|
allfields.fontColor | string |
Color de fuente utilizado para el texto de este campo (por ejemplo, #000000). |
|
Solo lectura
|
allfields.readOnly | boolean |
Indica si el campo es de solo lectura y el destinatario no puede editarlo. |
|
Varias líneas
|
allfields.multiLine | boolean |
Indica si el campo de texto acepta varias líneas de entrada (aplicable cuando fieldType es 'textfield'). |
|
Límite de caracteres
|
allfields.characterLimit | integer |
Número máximo de caracteres permitidos en el campo (aplicable cuando fieldType es 'textfield'). |
|
Nombre del campo de fecha
|
allfields.datefieldName | string |
Etiqueta del campo de fecha (aplicable cuando fieldType es 'datefield'). |
|
Formato de fecha
|
allfields.dateFormat | string |
El formato de fecha usado por este campo (por ejemplo, MM/DD/AAAA) (aplicable cuando fieldType es 'datefield'). |
|
Nombre de la casilla
|
allfields.cbname | string |
Etiqueta del campo de casilla (aplicable cuando fieldType es 'checkboxfield'). |
|
Grupo de casillas
|
allfields.cbgroup | string |
Nombre de grupo de esta casilla (aplicable cuando fieldType es 'checkboxfield'). |
|
Comprobado
|
allfields.checked | boolean |
Indica si la casilla está activada de forma predeterminada (aplicable cuando fieldType es 'checkboxfield'). |
|
Nombre de campo protegido
|
allfields.securedfieldName | string |
Etiqueta del campo protegido (aplicable cuando fieldType es "securedfield"). |
|
Caracteres que se van a mostrar
|
allfields.charToDisplay | integer |
Número de caracteres sin máscara que se van a mostrar al final de un valor de campo protegido (aplicable cuando fieldType es "securedfield"). |
|
Id. de firma
|
allfields.signatureId | string |
Identificador de la firma aplicada a este campo de signo (aplicable cuando fieldType es "signfield"). |
|
Imagen inicial
|
allfields.initialImage | string |
Los datos de imagen de las iniciales aplicadas a este campo (aplicable cuando fieldType es "initialfield"). |
|
Nombre del campo de datos adjuntos
|
allfields.attachmentfieldName | string |
Nombre del campo de datos adjuntos (aplicable cuando fieldType es "attachmentfield"). |
|
Descripción de los datos adjuntos
|
allfields.attachmentfieldDescription | string |
Descripción de lo que se va a adjuntar (aplicable cuando fieldType es "attachmentfield"). |
Crear grupo de correo electrónico
Crea un nuevo grupo de correo electrónico que se puede usar para enviar sobres a varios destinatarios a la vez.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del grupo
|
emailGroupName | True | string |
Nombre del nuevo grupo de correo electrónico. |
|
Descripción del grupo
|
emailGroupDescription | string |
Descripción opcional del grupo de correo electrónico. |
|
|
Permitir validación avanzada de correo electrónico
|
allowAdvancedEmailValidation | boolean |
Cuando está habilitada, Foxit eSign valida que todas las direcciones de correo electrónico del grupo son accesibles antes de enviar. |
|
|
Nombre
|
firstName | True | string |
Nombre del destinatario. |
|
Apellido
|
lastName | True | string |
Apellido del destinatario. |
|
Correo Electrónico
|
emailId | True | string |
Dirección de correo electrónico del destinatario. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Message
|
message | string |
Mensaje de confirmación para la acción realizada. |
|
Identificador de grupo
|
emailGroup.groupId | integer |
Identificador único del grupo de correo electrónico. Use este identificador al enviar sobres al grupo. |
|
Nombre del grupo
|
emailGroup.groupName | string |
Nombre del grupo de correo electrónico. |
|
Descripción del grupo
|
emailGroup.groupDesc | string |
Descripción del grupo de correo electrónico. |
|
Fecha de creación
|
emailGroup.dateCreated | integer |
Fecha en que se creó el grupo de correo electrónico, en milisegundos unix. |
|
Id. de empresa
|
emailGroup.companyId | integer |
La cuenta de empresa a la que pertenece este grupo de correo electrónico. |
|
Parties
|
emailGroup.parties | array of object |
Lista de destinatarios del grupo de correo electrónico. |
|
Nombre
|
emailGroup.parties.firstName | string |
Nombre del destinatario. |
|
Apellido
|
emailGroup.parties.lastName | string |
Apellido del destinatario. |
|
Correo Electrónico
|
emailGroup.parties.emailId | string |
Dirección de correo electrónico del destinatario. |
Crear plantilla a partir de la dirección URL
Crea una plantilla con una dirección URL pdf accesible públicamente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de la plantilla
|
templateName | True | string |
Nombre de la plantilla. Debe terminar con la extensión .pdf (por ejemplo, onboarding.pdf). |
|
Dirección URL de plantilla
|
templateUrl | True | string |
Dirección URL de acceso público del documento PDF que se va a usar como plantilla. |
|
Tipo de entrada
|
inputType | True | string |
Método de entrada del documento. Establezca siempre en "url" para esta acción. |
|
Procesar etiquetas de texto
|
processTextTags | True | boolean |
Cuando se habilita, Foxit eSign examinará el documento para etiquetas de texto y los convertirá automáticamente en campos de firma. |
|
Procesar campos de Acro
|
processAcroFields | True | boolean |
Cuando se habilita, Foxit eSign examinará el documento para AcroFields y los convertirá automáticamente en campos de firma. |
|
Compartir todo
|
shareAll | True | boolean |
Comparta esta plantilla con todos los usuarios de su cuenta. |
|
Número de partes
|
numberOfParties | True | integer |
Agregue el número de partes de la plantilla. Los valores de este parámetro deben ser inferiores a 20. |
|
Color del tema
|
themeColor | string |
Escriba un valor css para un color para cambiar el tema de createEmbeddedTemplateSession . |
|
|
Crear Email
|
authorEmail | string |
Escriba el correo electrónico de otro usuario en una cuenta que se usará como autor de esta plantilla. |
|
|
Crear sesión de plantilla insertada
|
createEmbeddedTemplateSession | boolean |
Si se establece como true, una sesión de plantilla insertada para abrir directamente la vista de preparación de la plantilla foxit eSign. Arrastrar y colocar varios campos en la plantilla estarán disponibles. |
|
|
Url de redireccionamiento
|
redirectURL | string |
Si createEmbeddedTemplateSession es true, se puede escribir la dirección URL absoluta para la página de aterrizaje en cualquier sitio web o aplicación, a la que se redirigirá el usuario después de hacer clic en "guardar y cerrar" en la vista de plantilla incrustada. |
|
|
Ocultar plantilla de envío
|
hideSendTemplate | boolean |
Si es true, ocultará el botón Enviar en una vista de plantilla incrustada. |
|
|
Corregir partes de destinatarios
|
fixRecipientParties | boolean |
Si es true, en la vista de plantilla insertada no puede cambiar las partes del sobre que ya se han agregado. |
|
|
Campos
|
Fields | object | ||
|
permissions
|
permission | True | string | |
|
Secuencia
|
sequence | True | integer |
Número de secuencia único para esta entidad, a partir de 1. Define el orden de firma cuando la secuencia de inicio de sesión está habilitada. |
|
Rol de destinatario
|
partyRole | True | string |
Rol asignado a esta entidad en la plantilla. |
|
Ocultar más acción
|
hideMoreAction | boolean |
Si es true, ocultará el botón "Más acciones" en la sesión de plantilla. |
|
|
Ocultar compartir con todos
|
hideShareWithAll | boolean |
Si es true, ocultará la opción "Compartir con todos" en la sesión de plantilla. |
|
|
Ocultar agregar entidad
|
hideAddParty | boolean |
Si es true, ocultará todas las opciones de agregar entidad en una sesión de plantilla insertada. |
|
|
Botón Ocultarme
|
hideMeButton | boolean |
Si es true, ocultará el botón "Me" en las partes destinatarios en una sesión de plantilla insertada. |
|
|
Ocultar otros botones
|
hideOthersButton | boolean |
Si es true, ocultará el botón "Otros" de las partes destinatarios en una sesión de plantilla insertada. |
|
|
Ocultar la opción Seleccionar contacto existente
|
hideExistingContactSelectOption | boolean |
Si es true, ocultará el cuadro de entrada "Buscar y agregar contacto existente" en Las partes del destinatario en una sesión de plantilla insertada. |
|
|
Ocultar nombre de campo para destinatarios
|
hideFieldNameForRecipients | boolean |
Ocultar nombres de campo para destinatarios para campos de entrada de datos y campos avanzados. (Excepto botón de radio, Casilla, Imagen e Hipervínculo). |
|
|
Ocultar borde de casilla
|
hideCheckboxBorder | boolean |
Los bordes de checkbox se ocultarán en los documentos ejecutados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la operación se realizó correctamente (por ejemplo, "correcto"). |
|
Message
|
message | string |
Descripción del resultado de la operación. |
|
ID
|
template.templateId | integer |
Identificador único de la plantilla creada. Úselo para crear sobres a partir de esta plantilla. |
|
Nombre
|
template.templateName | string |
El nombre de la plantilla. |
|
Description
|
template.templateDesc | string |
Descripción de la plantilla. |
|
Tipo
|
template.templateType | string |
Tipo de la plantilla. |
|
Fecha de creación
|
template.templateCreationDate | string |
Fecha en que se creó la plantilla. |
|
Fecha de última actualización
|
template.templateLastUpdateDate | string |
Fecha en que la plantilla se actualizó por última vez. |
|
Editable
|
template.editable | boolean |
Indica si se puede editar la plantilla. |
|
Número de partes
|
template.numberOfParties | integer |
Número de entidades de destinatario definidas en la plantilla. |
|
Total de páginas
|
template.totalPages | integer |
Número total de páginas del documento de plantilla. |
|
Id. de empresa
|
template.companyId | integer |
El identificador de la empresa a la que pertenece esta plantilla. |
|
Compartido con todos
|
template.shareAll | boolean |
Indica si esta plantilla se comparte con todos los usuarios de la cuenta. |
|
Patrón de nombre personalizado
|
template.templateCustomName | string |
Patrón de nombre personalizado aplicado a sobres creados a partir de esta plantilla. |
|
Permisos de entidad
|
template.templatePartyPermissions | array of object |
La lista de roles de destinatario y sus permisos definidos en esta plantilla. |
|
Id. de parte
|
template.templatePartyPermissions.template_party_id | integer |
Identificador único de esta entrada de entidad de plantilla. |
|
ID
|
template.templatePartyPermissions.templateId | integer |
El identificador de la plantilla a la que pertenece esta entidad. |
|
Permisos
|
template.templatePartyPermissions.templatePermissions | string |
Permisos de firma para esta entidad (por ejemplo, FILL_FIELDS_AND_SIGN). |
|
Orden de firma
|
template.templatePartyPermissions.partySequence | integer |
Posición del pedido de firma para esta entidad. |
|
Rol de entidad
|
template.templatePartyPermissions.templatePartyRole | string |
Nombre de rol asignado a esta entidad en la plantilla. Úselo al crear un sobre a partir de la plantilla. |
|
Id. de parte
|
template.templatePartyPermissions.partyId | integer |
Identificador de la entidad asignada a este rol, si se ha asignado previamente. |
|
Id. de usuario
|
template.templateCreatedBy.partyId | integer |
Identificador único del usuario. |
|
Nombre
|
template.templateCreatedBy.firstName | string |
Nombre del usuario. |
|
Apellido
|
template.templateCreatedBy.lastName | string |
Apellidos del usuario. |
|
Correo Electrónico
|
template.templateCreatedBy.emailId | string |
La dirección de correo electrónico del usuario. |
|
Id. de empresa
|
template.templateCreatedBy.companyId | integer |
Identificador de la empresa a la que pertenece el usuario. |
|
Rol de usuario
|
template.templateCreatedBy.userRole | string |
El rol del usuario dentro de su organización. |
|
Activo
|
template.templateCreatedBy.active | boolean |
Indica si la cuenta del usuario está activa. |
|
Id. de usuario
|
template.templateLastUpdatedBy.partyId | integer |
Identificador único del usuario. |
|
Nombre
|
template.templateLastUpdatedBy.firstName | string |
Nombre del usuario. |
|
Apellido
|
template.templateLastUpdatedBy.lastName | string |
Apellidos del usuario. |
|
Correo Electrónico
|
template.templateLastUpdatedBy.emailId | string |
La dirección de correo electrónico del usuario. |
|
Id. de empresa
|
template.templateLastUpdatedBy.companyId | integer |
Identificador de la empresa a la que pertenece el usuario. |
|
Rol de usuario
|
template.templateLastUpdatedBy.userRole | string |
El rol del usuario dentro de su organización. |
|
Activo
|
template.templateLastUpdatedBy.active | boolean |
Indica si la cuenta del usuario está activa. |
|
Campos de plantilla
|
allfields | array of object |
Lista de todos los campos de firma y formulario definidos en la plantilla. |
|
Id. de campo
|
allfields.fieldTagId | integer |
Identificador único del campo. |
|
Identificador de plantilla
|
allfields.templateId | integer |
Identificador de la plantilla a la que pertenece este campo. |
|
Id. de empresa
|
allfields.companyId | integer |
La cuenta de empresa a la que pertenece este campo. |
|
Tipo de campo
|
allfields.fieldType | string |
El tipo del campo (por ejemplo, campo de signo, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield). |
|
Número de página
|
allfields.documentPageNumber | integer |
Número de página del documento donde se coloca este campo. |
|
Parte responsable
|
allfields.partyResponsible | integer |
Número de secuencia de entidad responsable de rellenar este campo. |
|
Secuencia de fiesta
|
allfields.partyResponsibleSequence | integer |
Posición de secuencia del responsable. |
|
Id. de documento de campo
|
allfields.docFieldId | string |
Identificador de nivel de documento para este campo. |
|
Depende
|
allfields.dependent | boolean |
Indica si la visibilidad de este campo depende del valor de otro campo. |
|
Orden de tabulación
|
allfields.tabOrder | integer |
Orden de tabulación para navegar entre campos. |
|
Obligatorio
|
allfields.required | boolean |
Indica si este campo debe rellenarse antes de que se pueda firmar el documento. |
|
Nombre de campo personalizado
|
allfields.customFieldName | string |
Nombre personalizado asignado a este campo. |
|
Compartir todo
|
allfields.shareAll | boolean |
Indica si este campo se comparte con todos los usuarios. |
|
Permitir edición
|
allfields.allowEdit | boolean |
Indica si el destinatario puede editar este campo. |
|
Nombre del campo de texto
|
allfields.textfieldName | string |
Etiqueta del campo de texto (aplicable cuando fieldType es 'textfield'). |
|
Value
|
allfields.value | string |
Valor rellenado previamente o escrito del campo. |
|
Tamaño de fuente
|
allfields.fontSize | integer |
Tamaño de fuente usado para el texto de este campo. |
|
Color de fuente
|
allfields.fontColor | string |
Color de fuente utilizado para el texto de este campo (por ejemplo, #000000). |
|
Solo lectura
|
allfields.readOnly | boolean |
Indica si el campo es de solo lectura y el destinatario no puede editarlo. |
|
Varias líneas
|
allfields.multiLine | boolean |
Indica si el campo de texto acepta varias líneas de entrada (aplicable cuando fieldType es 'textfield'). |
|
Límite de caracteres
|
allfields.characterLimit | integer |
Número máximo de caracteres permitidos en el campo (aplicable cuando fieldType es 'textfield'). |
|
Nombre del campo de fecha
|
allfields.datefieldName | string |
Etiqueta del campo de fecha (aplicable cuando fieldType es 'datefield'). |
|
Formato de fecha
|
allfields.dateFormat | string |
El formato de fecha usado por este campo (por ejemplo, MM/DD/AAAA) (aplicable cuando fieldType es 'datefield'). |
|
Nombre de la casilla
|
allfields.cbname | string |
Etiqueta del campo de casilla (aplicable cuando fieldType es 'checkboxfield'). |
|
Grupo de casillas
|
allfields.cbgroup | string |
Nombre de grupo de esta casilla (aplicable cuando fieldType es 'checkboxfield'). |
|
Comprobado
|
allfields.checked | boolean |
Indica si la casilla está activada de forma predeterminada (aplicable cuando fieldType es 'checkboxfield'). |
|
Nombre de campo protegido
|
allfields.securedfieldName | string |
Etiqueta del campo protegido (aplicable cuando fieldType es "securedfield"). |
|
Caracteres que se van a mostrar
|
allfields.charToDisplay | integer |
Número de caracteres sin máscara que se van a mostrar al final de un valor de campo protegido (aplicable cuando fieldType es "securedfield"). |
|
Id. de firma
|
allfields.signatureId | string |
Identificador de la firma aplicada a este campo de signo (aplicable cuando fieldType es "signfield"). |
|
Imagen inicial
|
allfields.initialImage | string |
Los datos de imagen de las iniciales aplicadas a este campo (aplicable cuando fieldType es "initialfield"). |
|
Nombre del campo de datos adjuntos
|
allfields.attachmentfieldName | string |
Nombre del campo de datos adjuntos (aplicable cuando fieldType es "attachmentfield"). |
|
Descripción de los datos adjuntos
|
allfields.attachmentfieldDescription | string |
Descripción de lo que se va a adjuntar (aplicable cuando fieldType es "attachmentfield"). |
Crear sobre a partir de una plantilla
Crea y envía un sobre mediante una plantilla existente. Los detalles del destinatario se pueden personalizar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del sobre
|
folderName | string |
Nombre de la carpeta o documentos. Si no se proporciona este valor, el nombre de la carpeta de documentos se mantiene igual que los nombres de las plantillas. |
|
|
Identificadores de plantilla
|
templateIds | True | array of integer |
Matriz de identificadores de plantilla que desea usar para crear los documentos de esta carpeta. |
|
Campos
|
fields | object |
Puede pasar los valores de campo usados en las plantillas para rellenarlos previamente en los documentos creados a partir de la plantilla. FIELD_NAME es el nombre del campo usado en la plantilla. FIELD_VALUE es el valor del campo de documento. |
|
|
Validación avanzada de correo electrónico
|
allowAdvancedEmailValidation | boolean |
Valide las direcciones de correo electrónico de las partes cuando se establezca como true. |
|
|
Nombre
|
firstName | True | string |
Nombre del destinatario. |
|
Apellido
|
lastName | True | string |
Apellido del destinatario. |
|
dirección Email
|
emailId | True | string |
Dirección de correo electrónico del destinatario. |
|
permissions
|
permission | True | string | |
|
Secuencia
|
sequence | True | integer |
Use este campo para asignar un número de secuencia a un destinatario en la lista de partes de destinatarios. Use números de secuencia únicos para cada entidad a partir de 1, como 1,2,3,4...... Si una sola persona aparece varias veces en el flujo de trabajo de firma, asigne una secuencia diferente cada vez que se repita el destinatario. |
|
signerAuthLevels
|
signerAuthLevel | string |
Nivel de autenticación que un firmante aprovechará con fines de comprobación. |
|
|
Marcador de posición es
|
isPlaceholder | boolean |
Use este campo para iniciar la entidad es un marcador de posición. Nota: 1. firstName, lastName, el valor del parámetro emailId debe estar en blanco de esta entidad. 2. Para agregar el marcador de posición, se debe volver a guardar un destinatario con el permiso "PARTY_ASSIGNER". |
|
|
Rol de destinatario
|
partyRole | string |
Use este campo para asignar un rol de marcador de posición. |
|
|
Permitir cambio de nombre
|
allowNameChange | string |
El valor puede ser true o false Use este parámetro para permitir que el firmante actualice primero y el apellido antes de completar el proceso de firma. |
|
|
Secuencia de flujo de trabajo
|
workflowSequence | integer |
Asigne un número de secuencia de flujo de trabajo a este destinatario. Cuando la secuencia de inicio de sesión está habilitada, los destinatarios reciben su invitación de firma en orden ascendente de secuencia. |
|
|
Id. de correo electrónico de host
|
hostEmailId | string |
Dirección de correo electrónico del administrador de In-Person. |
|
|
Código de acceso
|
userDefinedAccessCode | string |
El parámetro contendrá Código de acceso cuando el valor "signerAuthLevel" esté establecido como "Código de acceso definido por el usuario" para la autenticación. Nota: 1. Los códigos no distinguen mayúsculas de minúsculas. 2. El sistema no envía este código, por lo que debe compartir este código directamente con el firmante. 3. El código de acceso puede contener alfabetos, números y los siguientes caracteres especiales: @,&,,{,}%,(,),~,|,!,+,^. |
|
|
La entidad es grupo de correo electrónico
|
partyIsEmailGroup | boolean |
Use este parámetro al crear una entidad como masiva. Nota: Si este parámetro es true, firstName, lastName y emailId de esta entidad se omitirán. |
|
|
Id. de grupo de correo electrónico
|
emailGroupId | integer |
Pase el correo electrónico el identificador de grupo que desea usar para crear de forma masiva. |
|
|
Single Signer Bulk
|
allowSingleSignerInBulk | boolean |
Use este parámetro para permitir que solo una persona inicie sesión en el grupo de correo electrónico. |
|
|
Código de marcado
|
dialingCode | string |
Use este campo para asignar códigos de acceso telefónico de país como prefijos de número de móvil a un destinatario de la lista de destinatarios. |
|
|
Número de móvil
|
mobileNumber | string |
Use este campo para asignar un número de móvil a un destinatario en la lista de partes de destinatarios. |
|
|
Contraseña de sobre
|
folderPassword | string |
El firmante o autor necesitará esta contraseña para abrir el documento firmado digitalmente. Si el parámetro se mantiene en blanco, no se requerirá ninguna contraseña para abrir el documento firmado digitalmente. |
|
|
Secuencia de inicio de sesión
|
signInSequence | boolean |
Este campo se usa para determinar si los destinatarios firmarán los documentos de sobre en una secuencia. Si es false, todos los destinatarios reciben correo electrónico de invitación simultáneamente. Cuando es true, cada destinatario recibe el correo electrónico de invitación sucesivamente después de que el destinatario anterior complete la tarea necesaria, como firmar los documentos o rellenar campos, etc. |
|
|
Habilitar en persona
|
inPersonEnable | boolean |
Este campo se usa para iniciar el proceso de firma en persona que se puede completar fácilmente en cualquier dispositivo en cuestión de minutos y evitar firmas basadas en correo electrónico cuando sea necesario. Si es false, todos los destinatarios reciben el correo electrónico de invitación simultáneamente. Cuando es true, el administrador en persona recibe un correo electrónico de invitación para iniciar el proceso de firma del firmante. |
|
|
Enviar ahora
|
sendNow | boolean |
Cuando está habilitada, Foxit eSign envía inmediatamente un vínculo de firma único a la dirección de correo electrónico de cada destinatario. Deshabilite esta opción para guardar el sobre como borrador en su lugar. |
|
|
Firmar la dirección URL de éxito de todas las partes
|
signSuccessUrlAllParties | boolean |
Si se establece como true, el firmante se redirigirá a la dirección URL proporcionada en signSuccessUrl después de firmar correctamente. Esto solo es aplicable cuando sendNow es true. |
|
|
Creación de una sesión de envío insertada
|
createEmbeddedSendingSession | boolean |
Si se establece en true, generará una dirección URL incrustada para abrir la vista de preparación del documento de Foxit eSign. |
|
|
Corregir partes de destinatarios
|
fixRecipientParties | boolean |
Si es true, en la vista de envío insertada no puede cambiar las partes del sobre que ya se han agregado como parte de esta solicitud. |
|
|
Corregir documentos
|
fixDocuments | boolean |
Si es true, en el envío incrustado no puede cambiar los documentos del sobre que ya se han agregado como parte de esta solicitud. |
|
|
Enviar dirección URL correcta
|
sendSuccessUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje, a la que se redirigirá el firmante después de enviar correctamente la carpeta en la vista de envío incrustada. |
|
|
Dirección URL de error de envío
|
sendErrorUrl | string |
Escriba la dirección URL absoluta de la página de aterrizaje, a la que se redirigirá el firmante si se produce un error durante el envío de la carpeta en la vista de envío incrustada. |
|
|
Ocultar opción de selección del firmante
|
hideSignerSelectOption | boolean |
Si es true, ocultará el cuadro de entrada "Nombre de firmante o correo electrónico existente" en Las partes del destinatario en una sesión de envío incrustada. |
|
|
Ocultar acciones del firmante
|
hideSignerActions | boolean |
Si es true, ocultará las acciones del firmante "editar", "cambiar" y "quitar" en las partes destinatarios en una sesión de envío incrustada. |
|
|
Ocultar nombre del remitente
|
hideSenderName | boolean |
Si es true, ocultará el nombre del remitente en las partes destinatarios en una sesión de envío incrustada. |
|
|
Ocultar el botón Enviar
|
hideSendButton | boolean |
Si es true, ocultará el botón Enviar en la sesión de envío incrustada. |
|
|
Ocultar nombre de carpeta
|
hideFolderName | boolean |
Si es true, ocultará el nombre de carpeta en la navegación en ambas sesiones incrustadas. |
|
|
Ocultar el nombre de los documentos
|
hideDocumentsName | boolean |
Si es true, ocultará el nombre del documento en ambas sesiones incrustadas. |
|
|
Ocultar el botón Agregarme
|
hideAddMeButton | boolean |
Si es true, ocultará el botón "Agregarme" en las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar el botón Agregar nuevo
|
hideAddNewButton | boolean |
Si es true, ocultará el botón "Agregar nuevo" en las partes destinatarios en una sesión de envío insertada. |
|
|
Ocultar el botón Agregar grupo
|
hideAddGroupButton | boolean |
Si es true, ocultará el botón "Agregar grupo" de las partes destinatarios en una sesión de envío insertada. |
|
|
Crear sesión de firma insertada
|
createEmbeddedSigningSession | boolean |
El token de sesión de firma se generará sin enviar correos electrónicos a los destinatarios. |
|
|
Crear sesión de firma insertada para todas las partes
|
createEmbeddedSigningSessionForAllParties | boolean |
Si se establece en true, se genera una dirección URL de firma incrustada para cada destinatario del sobre. Si es false, solo los destinatarios enumerados en Identificadores de correo electrónico de firmantes incrustados reciben una sesión insertada. |
|
|
Identificadores de correo electrónico de firmantes incrustados
|
embeddedSignersEmailIds | array of string |
Matriz de identificadores de correo electrónico de destinatarios para los que se debe crear una sesión de firma insertada. Identificadores de correo electrónico de los destinatarios agregados en la lista de partes. |
|
|
Sign Success Url
|
signSuccessUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá después de iniciar sesión correctamente en la vista de firma insertada. |
|
|
Dirección URL de rechazo de signo
|
signDeclineUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si rechaza iniciar sesión en la vista de firma insertada. |
|
|
Sign Later Url
|
signLaterUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si decide iniciar sesión más adelante en la vista de firma incrustada. |
|
|
Dirección URL del error de inicio de sesión
|
signErrorUrl | string |
Escriba la dirección URL absoluta para los firmantes a los que se redirigirá si se produce un error durante la firma del documento en la vista de firma incrustada. |
|
|
Ocultar siguiente campo obligatorio Btn
|
hideNextRequiredFieldBtn | boolean |
Si se establece en true, oculta el botón de navegación que mueve los firmantes al siguiente campo obligatorio. |
|
|
Color del tema
|
themeColor | string |
Escriba el valor CSS para establecer el color del tema. |
|
|
Ocultar rechazar para firmar
|
hideDeclineToSign | boolean |
Si se establece en true, oculta la opción Rechazar a firmar en la pantalla de firma. |
|
|
Ocultar más acción
|
hideMoreAction | boolean |
Si se establece en true, oculta el botón Más acciones en la sesión de envío y firma. No tiene ningún efecto cuando Enviar ahora es true. |
|
|
Ocultar la opción Agregar partes
|
hideAddPartiesOption | boolean |
Si se establece en true, oculta la opción para agregar entidades en el modo borrador y creación de plantillas. |
|
|
Expiración de sesión
|
sessionExpire | boolean |
Establezca como true para iniciar la expiración de la sesión de firma incrustada. |
|
|
Caducidad
|
expiry | integer |
Obligatorio si sessionExpire es true. Escriba la duración en milisegundos de la expiración en la sesión de firma incrustada. |
|
|
Correo electrónico del remitente
|
senderEmail | string |
Escriba el correo electrónico de otro usuario en su cuenta que se usará para enviar esta carpeta de documentos a las partes del destinatario. |
|
|
Permitir enviar ahora y sesión de firma insertada
|
allowSendNowAndEmbeddedSigningSession | boolean |
Si se establece en true, Foxit eSign envía un correo electrónico de invitación de firma a cada destinatario y también genera un vínculo de firma incrustado para los destinatarios cuyo correo electrónico se incluye en El correo electrónico del firmante incrustado. Tanto el correo electrónico como el vínculo incrustado están activos simultáneamente. |
|
|
Habilitar paso a paso
|
enableStepByStep | boolean |
Para habilitar la acción paso a paso en la sesión de envío insertada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la operación se realizó correctamente (por ejemplo, "correcto"). |
|
Message
|
message | string |
Descripción del resultado de la operación. |
|
Sesiones de firma insertadas
|
embeddedSigningSessions | array of object |
La lista de sesiones de firma incrustadas, una por destinatario. Solo está presente cuando createEmbeddedSigningSession es true. |
|
Correo electrónico del firmante
|
embeddedSigningSessions.emailIdOfSigner | string |
Dirección de correo electrónico del destinatario para esta sesión de firma incrustada. |
|
Token de firma
|
embeddedSigningSessions.embeddedToken | string |
Token único para la sesión de firma incrustada de este destinatario. |
|
Dirección URL de sesión de firma
|
embeddedSigningSessions.embeddedSessionURL | string |
Dirección URL que se va a abrir o insertar para que este destinatario firme el documento. |
|
Token de envío insertado
|
embeddedToken | string |
Token para la sesión de envío insertada. Solo está presente cuando createEmbeddedSendingSession es true. |
|
Enviar dirección URL de sesión
|
embeddedSessionURL | string |
Dirección URL que se va a abrir o insertar para que el autor del sobre prepare y envíe el sobre. Solo está presente cuando createEmbeddedSendingSession es true. |
|
ID
|
folder.folderId | integer |
Identificador único del sobre creado. Úselo para hacer referencia al sobre en acciones posteriores. |
|
Nombre
|
folder.folderName | string |
Nombre del sobre. |
|
Nombre personalizado
|
folder.folderCustomName | string |
Nombre personalizado asignado al sobre. |
|
Password
|
folder.folderPassword | string |
Contraseña establecida para el sobre, si existe. |
|
Id. de autor
|
folder.folderAuthorId | integer |
Identificador único del usuario que creó el sobre. |
|
Nombre del autor
|
folder.folderAuthorFirstName | string |
Nombre del creador del sobre. |
|
Apellidos del autor
|
folder.folderAuthorLastName | string |
Apellido del creador del sobre. |
|
Crear Email
|
folder.folderAuthorEmail | string |
Dirección de correo electrónico del creador del sobre. |
|
Rol de autor
|
folder.folderAuthorRole | string |
Rol de cuenta del creador del sobre. |
|
Id. de empresa
|
folder.folderCompanyId | integer |
Identificador único de la empresa a la que pertenece el sobre. |
|
Fecha de creación
|
folder.folderCreationDate | integer |
Fecha y hora en que se creó el sobre, en milisegundos unix. |
|
Fecha de envío
|
folder.folderSentDate | integer |
Fecha y hora en que se envió el sobre a los destinatarios, en milisegundos de Unix. |
|
Situación
|
folder.folderStatus | string |
Estado actual del sobre (por ejemplo, SHARED, EXECUTED, DRAFT, CANCELLED). |
|
Campo personalizado 1
|
folder.custom_field1 | string |
Valor del campo personalizado 1 establecido en el sobre. |
|
Campo personalizado 2
|
folder.custom_field2 | string |
Valor del campo personalizado 2 establecido en el sobre. |
|
Metadatos
|
folder.metadata | string |
Cualquier metadato adicional asociado al sobre. |
|
ID de documento
|
folder.folderDocumentIds | array of integer |
Lista de identificadores de documento incluidos en este sobre. |
|
Documentos
|
folder.documentsList | array of object |
Detalles de cada documento incluido en el sobre. |
|
Id. de documento
|
folder.documentsList.documentId | integer |
Identificador único del documento. |
|
Id. de contrato
|
folder.documentsList.contractId | integer |
Identificador único del contrato asociado a este documento. |
|
Id. de empresa
|
folder.documentsList.companyId | integer |
Identificador único de la empresa a la que pertenece este documento. |
|
Autor
|
folder.documentsList.contractCreatedBy | integer |
Identificador de usuario de la persona que creó el contrato. |
|
Creado el
|
folder.documentsList.contractCreatedOn | string |
Fecha en que se creó el contrato. |
|
Tipo contrato
|
folder.documentsList.contractType | string |
Tipo del contrato. |
|
Estado del documento
|
folder.documentsList.contractStatus | string |
Estado de firma actual del documento (por ejemplo, WAITING_FOR_SIGNATURE, EXECUTED). |
|
Editable
|
folder.documentsList.editable | boolean |
Indica si el documento se puede editar. |
|
Id. de la versión
|
folder.documentsList.contractVersionId | integer |
Identificador único de la versión del documento actual. |
|
Nombre de la versión
|
folder.documentsList.contractVersionName | string |
Nombre de la versión del documento actual. |
|
Descripción de la versión
|
folder.documentsList.contractVersionDesc | string |
Descripción de la versión actual del documento. |
|
Versión creada por
|
folder.documentsList.versionCreatedby | integer |
Identificador de usuario de la persona que creó esta versión del documento. |
|
Versión creada en
|
folder.documentsList.versionCreatedOn | string |
Fecha en que se creó esta versión del documento. |
|
Número de versión
|
folder.documentsList.contractVersionNumber | integer |
Número de versión del documento. |
|
Origen de la transacción
|
folder.documentsList.contractTransactionSource | string |
Origen de la transacción del contrato. |
|
Recipientes
|
folder.folderRecipientParties | array of object |
La lista de destinatarios de este sobre, incluidos sus vínculos de firma individuales. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyDetails.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
folder.folderRecipientParties.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
folder.folderRecipientParties.partyDetails.lastName | string |
Apellidos del destinatario. |
|
Correo Electrónico
|
folder.folderRecipientParties.partyDetails.emailId | string |
La dirección de correo electrónico del destinatario. |
|
Marcador de posición es
|
folder.folderRecipientParties.partyDetails.placeholder | boolean |
Indica si este destinatario es un marcador de posición. |
|
Dirección
|
folder.folderRecipientParties.partyDetails.address | string |
Dirección del destinatario. |
|
Fecha de creación de la cuenta
|
folder.folderRecipientParties.partyDetails.dateCreated | integer |
Fecha en que se creó la cuenta del destinatario, en milisegundos de Unix. |
|
Rechazar correos electrónicos
|
folder.folderRecipientParties.partyDetails.optOutEmails | boolean |
Indica si el destinatario ha optado por no recibir notificaciones por correo electrónico. |
|
Identificador de entidad única
|
folder.folderRecipientParties.partyDetails.uniquePartyId | string |
Identificador de cadena único para el destinatario. |
|
Nivel de autenticación
|
folder.folderRecipientParties.partyDetails.authenticationLevel | string |
Nivel de autenticación necesario para este destinatario. |
|
Id. de empresa
|
folder.folderRecipientParties.partyDetails.companyId | integer |
Identificador de la empresa a la que pertenece el destinatario. |
|
Rol de usuario
|
folder.folderRecipientParties.partyDetails.userRole | string |
El papel del destinatario dentro de su organización. |
|
Departamento
|
folder.folderRecipientParties.partyDetails.department | string |
Departamento del destinatario. |
|
Title
|
folder.folderRecipientParties.partyDetails.title | string |
Puesto del destinatario. |
|
Activo
|
folder.folderRecipientParties.partyDetails.active | boolean |
Indica si la cuenta del destinatario está activa. |
|
Código de marcado
|
folder.folderRecipientParties.partyDetails.dialingCode | string |
Código de marcado de país para el número de teléfono del destinatario. |
|
Número de móvil
|
folder.folderRecipientParties.partyDetails.mobileNumber | string |
Número de teléfono móvil del destinatario. |
|
Descripción del subcontratista
|
folder.folderRecipientParties.partyDetails.subcontractorDescription | string |
Una descripción del subcontratista, si procede. |
|
Organización de subcontratistas
|
folder.folderRecipientParties.partyDetails.subcontractorOrganization | string |
El nombre de la organización del subcontratista, si procede. |
|
Fecha de incorporación del subcontratista
|
folder.folderRecipientParties.partyDetails.subcAddedDate | integer |
Fecha en que se agregó el subcontratista, en milisegundos unix. |
|
Source
|
folder.folderRecipientParties.partyDetails.source | string |
Origen a través del cual se agregó el destinatario. |
|
Código de marcado
|
folder.folderRecipientParties.dialingCode | string |
Código de marcado de país para el número de teléfono móvil del destinatario. |
|
Número de móvil
|
folder.folderRecipientParties.mobileNumber | string |
Número de móvil del destinatario. |
|
Tipo de firma
|
folder.folderRecipientParties.signerSignatureType | string |
Tipo de firma permitido para este destinatario. |
|
Permisos
|
folder.folderRecipientParties.contractPermissions | string |
Permisos de firma concedidos a este destinatario (por ejemplo, FILL_FIELDS_AND_SIGN). |
|
Orden de firma
|
folder.folderRecipientParties.partySequence | integer |
Posición de este destinatario en el orden de firma. |
|
Secuencia de flujo de trabajo
|
folder.folderRecipientParties.workflowSignSequence | integer |
Número de secuencia de firma de flujo de trabajo para este destinatario. |
|
Id. de sobre
|
folder.folderRecipientParties.envelopeId | integer |
Identificador del sobre al que pertenece este destinatario. |
|
Id. de empresa de entidad
|
folder.folderRecipientParties.partyCompanyId | integer |
El identificador de la empresa a la que pertenece este destinatario. |
|
Modo de uso compartido
|
folder.folderRecipientParties.sharingMode | string |
Método usado para compartir el documento con este destinatario (por ejemplo, correo electrónico). |
|
Dirección URL de firma
|
folder.folderRecipientParties.folderAccessURL | string |
Dirección URL de firma única para este destinatario. Úselo para compartir el vínculo de firma directamente. |
|
Modo de seguridad
|
folder.folderRecipientParties.securityMode | string |
Modo de seguridad aplicado al acceso de este destinatario. |
|
Comentarios adicionales
|
folder.folderRecipientParties.extraComments | string |
Cualquier comentario adicional incluido en la invitación de firma para este destinatario. |
|
Permitir cambio de nombre
|
folder.folderRecipientParties.allowNameChange | boolean |
Indica si el destinatario puede cambiar su nombre antes de firmar. |
|
Nombre actualizado
|
folder.folderRecipientParties.signerNameUpdated | boolean |
Indica si el destinatario ha actualizado su nombre para mostrar. |
|
Nivel de autenticación
|
folder.folderRecipientParties.signerAuthenticationLevel | string |
Método de autenticación necesario para que este destinatario acceda al documento. |
|
Código de acceso
|
folder.folderRecipientParties.userDefinedAccessCode | string |
Código de acceso personalizado necesario para que este destinatario abra el documento. |
|
Id. de firma
|
folder.folderRecipientParties.signatureId | string |
Identificador de la firma guardada usada por este destinatario. |
|
Rol de destinatario
|
folder.folderRecipientParties.partyRole | string |
Rol asignado a este destinatario en el sobre. |
|
Valor de campo de empresa
|
folder.folderRecipientParties.companyFieldValue | string |
Valor de campo de empresa rellenado previamente para este destinatario. |
|
Valor de campo de título
|
folder.folderRecipientParties.titleFieldValue | string |
Valor de campo de título rellenado previamente para este destinatario. |
|
Motivo de la firma
|
folder.folderRecipientParties.reasonSigning | string |
Motivo de la firma proporcionada por este destinatario. |
|
Campo de pago agregado
|
folder.folderRecipientParties.payFieldAdded | boolean |
Indica si se ha agregado un campo de pago para este destinatario. |
|
¿Es pagador?
|
folder.folderRecipientParties.payee | boolean |
Indica si este destinatario es un beneficiario. |
|
Existe un campo periódico
|
folder.folderRecipientParties.recurringFieldExist | boolean |
Indica si existen campos de pago periódicos para este destinatario. |
|
Imprimir y firmar completado
|
folder.folderRecipientParties.printAndSignCompleted | boolean |
Indica si el destinatario ha completado una acción de impresión y firma. |
|
Permitir firmante opcional
|
folder.folderRecipientParties.allowOptionalSigner | boolean |
Indica si este destinatario se puede omitir como un firmante opcional. |
|
Firmantes opcionales
|
folder.folderRecipientParties.optionalSigners | string |
Lista de firmantes opcionales asociados a este destinatario, si existe. |
|
Pagado
|
folder.folderRecipientParties.paid | boolean |
Indica si este destinatario ha completado el pago. |
|
Dirección URL de acceso del autor
|
folder.folderAccessURLForAuthor | string |
Dirección URL del autor del sobre para acceder al documento. |
|
Dirección URL de acceso de borrador
|
folder.draftFolderAccessURL | string |
Dirección URL para acceder al sobre mientras está en estado de borrador. |
|
Firmar en la sala de juntas
|
folder.boardRoomSign | boolean |
Indica si la firma de sala de juntas está habilitada para este sobre. |
|
Incluir logotipo
|
folder.includeLogo | boolean |
Indica si el logotipo de la empresa se incluye en las notificaciones por correo electrónico. |
|
Color del botón correo electrónico
|
folder.email_btnBgColor | string |
Color de fondo del botón de acción en el correo electrónico de firma. |
|
Color de texto del botón de correo electrónico
|
folder.email_btnTxtColor | string |
Color del texto del botón de acción en el correo electrónico de firma. |
|
Logotipo de correo electrónico
|
folder.emailTemplateLogo | string |
Imagen de logotipo usada en la plantilla de correo electrónico. |
|
Id. de plantilla de correo electrónico
|
folder.emailTemplateId | integer |
Identificador de la plantilla de correo electrónico que se usa para firmar notificaciones. |
|
Encabezado de correo electrónico
|
folder.emailHeader | string |
Texto del encabezado personalizado en los correos electrónicos de notificación de firma. |
|
Pie de página de correo electrónico
|
folder.emailFooter | string |
Texto del pie de página personalizado en los correos electrónicos de notificación de firma. |
|
Purga programada
|
folder.purgeFlag | boolean |
Indica si este sobre está programado para purga automática. |
|
Purgar fecha de inicio
|
folder.purgeStartDate | string |
Fecha a partir de la cual comienza el período de purga. |
|
Purgar fecha de finalización
|
folder.purgeEndDate | string |
Fecha en la que se purgará el sobre. |
|
Id. masivo
|
folder.bulkId | integer |
El identificador del lote de envío masivo al que pertenece este sobre, si existe. |
|
Exigir orden de firma
|
folder.enforceSignWorkflow | boolean |
Indica si los destinatarios deben iniciar sesión en el orden especificado. |
|
Paso de flujo de trabajo actual
|
folder.currentWorkflowStep | integer |
Paso actual del flujo de trabajo de firma. |
|
Origen de la transacción
|
folder.transactionSource | string |
Origen que inició esta transacción de sobre. |
|
Editable
|
folder.editable | boolean |
Indica si el sobre todavía se puede editar. |
|
firma de In-Person
|
folder.inPersonSignable | boolean |
Indica si el sobre se puede iniciar sesión en persona. |
|
Invalidar recordatorios
|
folder.overrideAccountReminders | boolean |
Indica si la configuración de aviso de nivel de cuenta se invalida para este sobre. |
|
Invalidar delegación
|
folder.overrideAccountRecipientDelegation | boolean |
Indica si la configuración de delegación de nivel de cuenta se invalida para este sobre. |
|
Permitir delegación
|
folder.allowRecipientsToDelegate | boolean |
Indica si los destinatarios pueden delegar su firma a otra persona. |
|
ID
|
folder.envelopeId | integer |
Identificador único del sobre. El mismo valor que envelope ID (folderId). |
|
Nombre
|
folder.envelopeName | string |
Nombre del sobre. El mismo valor que El nombre de sobre (folderName). |
|
Id. del originador
|
folder.envelopeOriginatorId | integer |
Identificador de usuario de la persona que creó el sobre. |
|
Id. de empresa
|
folder.envelopeCompanyId | integer |
Identificador de la empresa a la que pertenece el sobre. |
|
Date
|
folder.envelopeDate | integer |
Fecha y hora en que se creó el sobre, en milisegundos unix. |
|
Fecha compartida
|
folder.envelopeSharedDate | integer |
Fecha y hora en que el sobre se compartió con destinatarios, en milisegundos de Unix. |
|
Situación
|
folder.envelopeStatus | string |
Estado actual del sobre. El mismo valor que El estado del sobre (folderStatus). |
|
Identificadores de contrato
|
folder.envelopeContractIds | array of integer |
Lista de identificadores de contrato asociados a este sobre. |
|
Permisos de entidad
|
folder.envelopePartyPermissions | array of object |
La lista de destinatarios y sus permisos de firma. La misma estructura que los destinatarios. |
|
Id. del destinatario
|
folder.envelopePartyPermissions.partyId | integer |
Identificador único del destinatario. |
|
Dirección URL de firma
|
folder.envelopePartyPermissions.folderAccessURL | string |
Dirección URL de firma única para este destinatario. |
|
Permisos
|
folder.envelopePartyPermissions.contractPermissions | string |
Permisos de firma para este destinatario. |
|
Orden de firma
|
folder.envelopePartyPermissions.partySequence | integer |
Posición de este destinatario en el orden de firma. |
|
Nivel de autenticación
|
folder.envelopeAuthenticationLevel | string |
Nivel de autenticación aplicado a todo el sobre. |
|
Permitir el inicio de sesión único masiva
|
folder.allowSingleSignerInBulk | boolean |
Indica si se permite un firmante único en modo de envío masivo. |
|
Nombre basado en el archivo
|
folder.folderNameBasedOnFileNaming | boolean |
Indica si el nombre del sobre se deriva del nombre de archivo. |
|
Nombre del documento basado en el archivo
|
folder.documentNameBasedOnFileNaming | boolean |
Indica si el nombre del documento se deriva del nombre de archivo. |
|
Nombre del certificado basado en el archivo
|
folder.certificateNameBasedOnFileNaming | boolean |
Indica si el nombre del certificado se deriva del nombre de archivo. |
|
Habilitación de la nomenclatura de archivos
|
folder.enableFileNamingBeforeExecution | boolean |
Indica si se solicita la nomenclatura de archivos antes de enviar el sobre. |
|
Pago agregado
|
folder.payeeAddedd | boolean |
Indica si se ha agregado un receptor al sobre. |
|
Autofirmador
|
folder.selfSignerEnabled | boolean |
Indica si el remitente también es un firmante de este sobre. |
|
Notary Enabled
|
folder.notaryEnabled | boolean |
Indica si la certificación está habilitada para este sobre. |
|
Visibilidad limitada
|
folder.limitedVisibilityFlag | boolean |
Indica si está habilitada la visibilidad limitada del documento. |
|
Visibilidad posterior a la firma
|
folder.postSigningVisibility | boolean |
Indica si los destinatarios pueden ver el documento firmado después de la finalización. |
|
Firma mojada habilitada
|
folder.wetSignatureEnabled | boolean |
Indica si las firmas húmedas (manuscritas) están habilitadas para este sobre. |
|
Combinar habilitado
|
folder.mergeEnabled | boolean |
Indica si la combinación de documentos está habilitada para este sobre. |
Descargar archivos de sobre
Descarga los documentos completados de un sobre como un archivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
folderId | True | string |
Identificador único del sobre cuyos documentos desea descargar. |
Devoluciones
- response
- binary
Descargar informe
Descarga un informe de actividad de sobre como un archivo Microsoft Excel. Use los filtros para restringir los resultados por estado, intervalo de fechas, nombre de sobre, autor o firmante.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
envelopeStatus
|
status | string |
Estados de la carpeta por las que filtraremos un informe |
|
|
Fecha de creación a partir de
|
creationDateFrom | string |
Inicio del intervalo fecha de creación. Formato aceptado: AAAA-MM-DD. |
|
|
Fecha de creación a
|
creationDateTo | string |
Fin del intervalo fecha de creación. Formato aceptado: AAAA-MM-DD. |
|
|
Nombre del sobre
|
folderName | string |
Cualquier carpeta que contenga esta cadena. |
|
|
Incluir campos
|
includeFields | string |
Establezca en "true" para incluir valores de campo de sobre en el informe. El valor predeterminado es "false". |
|
|
Crear Email
|
authorEmail | string |
Filtre el informe para incluir solo sobres creados por esta dirección de correo electrónico del autor. |
|
|
Correo electrónico del firmante
|
signerEmail | string |
Filtre el informe para incluir solo sobres en los que esta dirección de correo electrónico sea un firmante. |
Devoluciones
- Archivo de informe
- binary
Descargar PDF de documento único
Descarga un único documento de un sobre como un archivo PDF.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
folderId | True | string |
Identificador único del sobre que contiene el documento que se va a descargar. |
|
Número de documento
|
docNumber | True | string |
Índice del documento que se va a descargar, a partir de 1. |
Devoluciones
- response
- binary
Eliminar sobres
Elimina permanentemente uno o varios sobres.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
folderIds
|
folderIds | array of integer |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la operación se realizó correctamente. |
Enumerar todos los canales de webhook
Devuelve una lista de todos los canales de webhook configurados en su cuenta.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Total de canales
|
total_channel | integer |
Número total de canales de webhook configurados en la cuenta. |
|
Canales de webhook
|
templatesList | array of object |
Lista de todos los canales de webhook de la cuenta. |
|
Id. de canal
|
templatesList.channelId | integer |
Identificador único del canal de webhook. |
|
Id. de empresa
|
templatesList.companyId | integer |
La cuenta de empresa a la que pertenece este canal. |
|
Nombre del canal
|
templatesList.channelName | string |
Nombre del canal de webhook. |
|
URL del Webhook
|
templatesList.webhookUrl | string |
La dirección URL a la que foxit eSign llamará cuando se produzca un evento suscrito. |
|
Secreto de webhook
|
templatesList.webhookSecret | string |
Clave secreta que se usa para comprobar las cargas de webhook. |
|
Fecha de creación
|
templatesList.dateCreated | integer |
Fecha en que se creó el canal, en milisegundos de Unix. |
|
Fecha actualizada
|
templatesList.dateUpdated | integer |
Fecha en que el canal se actualizó por última vez, en milisegundos de Unix. |
|
Nivel de webhook
|
templatesList.webhookLevel | string |
Ámbito del canal de webhook. "Cuenta" (desencadenadores para todos los sobres) o "Aplicación de API" (desencadena solo para sobres creados a través de la API). |
|
Situación
|
templatesList.status | string |
Estado actual del canal. "activo" o "inactivo". |
|
Sobre enviado
|
templatesList.eventsSubscribedMap.folder_sent | boolean |
Se desencadena cuando se envía un sobre a los destinatarios. |
|
Sobre visto
|
templatesList.eventsSubscribedMap.folder_viewed | boolean |
Se desencadena cuando un destinatario abre un sobre. |
|
Sobre firmado
|
templatesList.eventsSubscribedMap.folder_signed | boolean |
Se desencadena cuando un destinatario firma un sobre. |
|
Sobre cancelado
|
templatesList.eventsSubscribedMap.folder_cancelled | boolean |
Se desencadena cuando se cancela un sobre. |
|
Sobre ejecutado
|
templatesList.eventsSubscribedMap.folder_executed | boolean |
Se desencadena cuando todas las partes han firmado y el sobre se ejecuta por completo. |
|
Sobre eliminado
|
templatesList.eventsSubscribedMap.folder_deleted | boolean |
Se desencadena cuando se elimina un sobre. |
Enviar recordatorio de firma
Envía una notificación de recordatorio a los destinatarios pendientes de un sobre, que les pide que completen la firma.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
folderId | True | integer |
Identificador del sobre. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Id. de sobre
|
reminder sent | integer |
Identificador del sobre para el que se envió el aviso. |
Mover sobres a la papelera de reciclaje
Mueve uno o varios sobres a la papelera de reciclaje. Los sobres de la papelera de reciclaje no se eliminan permanentemente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de carpeta
|
folderIds | True | array of integer |
Matriz de identificadores de sobre en los que actuar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la operación se realizó correctamente. |
Obtener detalles de la plantilla
Recupera los detalles completos de una plantilla específica, incluidos sus campos y destinatarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de plantilla
|
templateId | True | string |
Identificador único de la plantilla que se va a recuperar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
ID
|
template.templateId | integer |
Identificador único de la plantilla. |
|
Nombre
|
template.templateName | string |
El nombre de la plantilla. |
|
Description
|
template.templateDesc | string |
Descripción de la plantilla. |
|
Tipo
|
template.templateType | string |
Tipo de la plantilla. |
|
Fecha de creación
|
template.templateCreationDate | integer |
Fecha en que se creó la plantilla, en milisegundos de Unix. |
|
Fecha de última actualización
|
template.templateLastUpdateDate | integer |
Fecha en que la plantilla se actualizó por última vez, en milisegundos de Unix. |
|
Editable
|
template.editable | boolean |
Indica si se puede editar la plantilla. |
|
Número de partes
|
template.numberOfParties | integer |
Número de entidades de firma definidas en la plantilla. |
|
Total de páginas
|
template.totalPages | integer |
Número total de páginas del documento de plantilla. |
|
Id. de empresa
|
template.companyId | integer |
La cuenta de empresa a la que pertenece la plantilla. |
|
Compartir con todos
|
template.shareAll | boolean |
Indica si la plantilla se comparte con todos los usuarios de la cuenta. |
|
Patrón de nombre personalizado
|
template.templateCustomName | string |
Patrón de nombre personalizado aplicado a sobres creados a partir de esta plantilla. |
|
Permisos de entidad
|
template.templatePartyPermissions | array of object |
La lista de roles de destinatario y sus permisos de firma definidos en esta plantilla. |
|
Id. de parte
|
template.templatePartyPermissions.template_party_id | integer |
Identificador único de esta entrada de entidad de plantilla. |
|
ID
|
template.templatePartyPermissions.templateId | integer |
El identificador de la plantilla a la que pertenece esta entidad. |
|
Permisos
|
template.templatePartyPermissions.templatePermissions | string |
Permisos de firma para esta entidad (por ejemplo, FILL_FIELDS_AND_SIGN). |
|
Orden de firma
|
template.templatePartyPermissions.partySequence | integer |
Posición del pedido de firma para esta entidad. |
|
Rol de entidad
|
template.templatePartyPermissions.templatePartyRole | string |
Nombre de rol asignado a esta entidad. Use este valor al crear un sobre a partir de esta plantilla. |
|
Id. de parte
|
template.templatePartyPermissions.partyId | integer |
Identificador de la entidad asignada a este rol, si se ha asignado previamente. |
|
Id. de parte
|
template.templateCreatedBy.partyId | integer |
Identificador único del usuario. |
|
Nombre
|
template.templateCreatedBy.firstName | string |
El primer nombre del usuario. |
|
Apellido
|
template.templateCreatedBy.lastName | string |
Los apellidos del usuario. |
|
Correo Electrónico
|
template.templateCreatedBy.emailId | string |
La dirección de correo electrónico del usuario. |
|
Departamento
|
template.templateCreatedBy.department | string |
El departamento del usuario. |
|
Title
|
template.templateCreatedBy.title | string |
el puesto del usuario. |
|
Activo
|
template.templateCreatedBy.active | boolean |
Indica si la cuenta de usuario está activa. |
|
Id. de parte
|
template.templateLastUpdatedBy.partyId | integer |
Identificador único del usuario. |
|
Nombre
|
template.templateLastUpdatedBy.firstName | string |
El primer nombre del usuario. |
|
Apellido
|
template.templateLastUpdatedBy.lastName | string |
Los apellidos del usuario. |
|
Correo Electrónico
|
template.templateLastUpdatedBy.emailId | string |
La dirección de correo electrónico del usuario. |
|
Departamento
|
template.templateLastUpdatedBy.department | string |
El departamento del usuario. |
|
Title
|
template.templateLastUpdatedBy.title | string |
el puesto del usuario. |
|
Activo
|
template.templateLastUpdatedBy.active | boolean |
Indica si la cuenta de usuario está activa. |
|
Todos los campos
|
allfields | array of object |
Lista de todos los campos definidos en esta plantilla. |
|
Id. de etiqueta de campo
|
allfields.fieldTagId | integer |
Identificador único del campo. |
|
Identificador de plantilla
|
allfields.templateId | integer |
Identificador de la plantilla a la que pertenece este campo. |
|
Id. de empresa
|
allfields.companyId | integer |
La cuenta de empresa a la que pertenece este campo. |
|
Tipo de campo
|
allfields.fieldType | string |
El tipo del campo (por ejemplo, campo de signo, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield). |
|
Número de página
|
allfields.documentPageNumber | integer |
Número de página del documento donde se coloca este campo. |
|
Responsable del usuario
|
allfields.partyResponsible | integer |
Número de secuencia de entidad responsable de completar este campo. |
|
Secuencia de fiesta
|
allfields.partyResponsibleSequence | integer |
Posición de secuencia del responsable. |
|
Id. de campo de documento
|
allfields.docFieldId | string |
Identificador de este campo dentro del documento. |
|
Dependiente
|
allfields.dependent | boolean |
Indica si la visibilidad de este campo depende del valor de otro campo. |
|
Orden de tabulación
|
allfields.tabOrder | integer |
Orden de tabulación para navegar entre campos. |
|
Obligatorio
|
allfields.required | boolean |
Indica si este campo debe completarse antes de que se pueda firmar el documento. |
|
Nombre de campo personalizado
|
allfields.customFieldName | string |
Nombre personalizado asignado a este campo. |
|
Compartir todo
|
allfields.shareAll | boolean |
Indica si este campo se comparte con todos los usuarios. |
|
Permitir edición
|
allfields.allowEdit | boolean |
Indica si el destinatario puede editar este campo. |
|
Nombre del campo de texto
|
allfields.textfieldName | string |
Etiqueta del campo de texto (aplicable cuando fieldType es 'textfield'). |
|
Value
|
allfields.value | string |
Valor rellenado previamente o escrito del campo. |
|
Tamaño de fuente
|
allfields.fontSize | integer |
Tamaño de fuente usado para el texto de este campo. |
|
Color de fuente
|
allfields.fontColor | string |
Color de fuente utilizado para el texto de este campo (por ejemplo, #000000). |
|
Solo lectura
|
allfields.readOnly | boolean |
Indica si el campo es de solo lectura y el destinatario no puede editarlo. |
|
Varias líneas
|
allfields.multiLine | boolean |
Indica si el campo de texto acepta varias líneas de entrada (aplicable cuando fieldType es 'textfield'). |
|
Límite de caracteres
|
allfields.characterLimit | integer |
Número máximo de caracteres permitidos en el campo (aplicable cuando fieldType es 'textfield'). |
|
Nombre del campo de fecha
|
allfields.datefieldName | string |
Etiqueta del campo de fecha (aplicable cuando fieldType es 'datefield'). |
|
Formato de fecha
|
allfields.dateFormat | string |
El formato de fecha usado por este campo (por ejemplo, MM/DD/AAAA) (aplicable cuando fieldType es 'datefield'). |
|
Nombre de la casilla
|
allfields.cbname | string |
Etiqueta del campo de casilla (aplicable cuando fieldType es 'checkboxfield'). |
|
Grupo de casillas
|
allfields.cbgroup | string |
Nombre de grupo de esta casilla, que se usa cuando se vinculan varias casillas (aplicable cuando fieldType es "checkboxfield"). |
|
Comprobado
|
allfields.checked | boolean |
Indica si la casilla está activada de forma predeterminada (aplicable cuando fieldType es 'checkboxfield'). |
|
Nombre de campo protegido
|
allfields.securedfieldName | string |
Etiqueta del campo protegido (aplicable cuando fieldType es "securedfield"). |
|
Caracteres que se van a mostrar
|
allfields.charToDisplay | integer |
Número de caracteres sin máscara que se van a mostrar al final de un valor de campo protegido (aplicable cuando fieldType es "securedfield"). |
|
Id. de firma
|
allfields.signatureId | string |
Identificador de la firma aplicada a este campo de signo (aplicable cuando fieldType es "signfield"). |
|
Imagen inicial
|
allfields.initialImage | string |
Los datos de imagen de las iniciales aplicadas a este campo (aplicable cuando fieldType es "initialfield"). |
|
Nombre del campo de datos adjuntos
|
allfields.attachmentfieldName | string |
Nombre del campo de datos adjuntos (aplicable cuando fieldType es "attachmentfield"). |
|
Descripción de los datos adjuntos
|
allfields.attachmentfieldDescription | string |
Descripción de lo que se va a adjuntar (aplicable cuando fieldType es "attachmentfield"). |
Obtener detalles del canal de webhook
Recupera los detalles de un canal de webhook específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de canal
|
channelId | True | string |
Identificador único del canal de webhook que se va a recuperar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
ID
|
channel.channelId | integer |
Identificador único del canal de webhook. |
|
Id. de empresa
|
channel.companyId | integer |
La cuenta de empresa a la que pertenece este canal. |
|
Nombre
|
channel.channelName | string |
Nombre del canal de webhook. |
|
URL del Webhook
|
channel.webhookUrl | string |
La dirección URL a la que foxit eSign llamará cuando se produzca un evento suscrito. |
|
Secreto de webhook
|
channel.webhookSecret | string |
Clave secreta que se usa para comprobar las cargas de webhook. |
|
Fecha de creación
|
channel.dateCreated | integer |
Fecha en que se creó el canal, en milisegundos de Unix. |
|
Fecha actualizada
|
channel.dateUpdated | integer |
Fecha en que el canal se actualizó por última vez, en milisegundos de Unix. |
|
Nivel de webhook
|
channel.webhookLevel | string |
Ámbito del canal de webhook. "Cuenta" (desencadenadores para todos los sobres) o "Aplicación de API" (desencadena solo para sobres creados a través de la API). |
|
Situación
|
channel.status | string |
Estado actual del canal. "activo" o "inactivo". |
|
Sobre enviado
|
channel.eventsSubscribedMap.folder_sent | boolean |
Se desencadena cuando se envía un sobre a los destinatarios. |
|
Sobre visto
|
channel.eventsSubscribedMap.folder_viewed | boolean |
Se desencadena cuando un destinatario abre un sobre. |
|
Sobre firmado
|
channel.eventsSubscribedMap.folder_signed | boolean |
Se desencadena cuando un destinatario firma un sobre. |
|
Sobre cancelado
|
channel.eventsSubscribedMap.folder_cancelled | boolean |
Se desencadena cuando se cancela un sobre. |
|
Sobre ejecutado
|
channel.eventsSubscribedMap.folder_executed | boolean |
Se desencadena cuando todas las partes han firmado y el sobre se ejecuta por completo. |
|
Sobre eliminado
|
channel.eventsSubscribedMap.folder_deleted | boolean |
Se desencadena cuando se elimina un sobre. |
Obtener detalles del grupo de correo electrónico
Recupera los detalles de un grupo de correo electrónico existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombres de grupo de correo electrónico
|
emailGroupNames | True | array of string |
Matriz de nombres de grupo de correo electrónico usados para identificar los grupos. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Grupos de correo electrónico
|
allEmailGroups | array of object |
La lista de grupos de correo electrónico que coinciden con los nombres de grupo solicitados. |
|
Identificador de grupo
|
allEmailGroups.groupId | integer |
Identificador único del grupo de correo electrónico. |
|
Nombre del grupo
|
allEmailGroups.groupName | string |
Nombre del grupo de correo electrónico. |
|
Descripción del grupo
|
allEmailGroups.groupDesc | string |
Descripción del grupo de correo electrónico. |
|
Fecha de creación
|
allEmailGroups.dateCreated | integer |
Fecha en que se creó el grupo de correo electrónico, en milisegundos unix. |
|
Id. de empresa
|
allEmailGroups.companyId | integer |
La cuenta de empresa a la que pertenece este grupo de correo electrónico. |
|
Parties
|
allEmailGroups.parties | array of object |
Lista de destinatarios de este grupo de correo electrónico. |
|
Nombre
|
allEmailGroups.parties.firstName | string |
Nombre del destinatario. |
|
Apellido
|
allEmailGroups.parties.lastName | string |
Apellido del destinatario. |
|
Correo Electrónico
|
allEmailGroups.parties.emailId | string |
Dirección de correo electrónico del destinatario. |
Obtener detalles del sobre
Recupera detalles completos de un sobre, incluido su estado, destinatarios y documentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
folderId | True | integer |
Identificador único del sobre que se va a recuperar. |
|
Token de acceso
|
access_token | string |
Token de acceso de OAuth 2.0 para la autenticación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la operación se realizó correctamente (por ejemplo, "correcto"). |
|
ID
|
folder.folderId | integer |
Identificador único del sobre. |
|
Nombre
|
folder.folderName | string |
Nombre del sobre. |
|
Id. de autor
|
folder.folderAuthorId | integer |
Identificador único del usuario que creó el sobre. |
|
Nombre del autor
|
folder.folderAuthorFirstName | string |
Nombre del creador del sobre. |
|
Apellidos del autor
|
folder.folderAuthorLastName | string |
Apellido del creador del sobre. |
|
Crear Email
|
folder.folderAuthorEmail | string |
Dirección de correo electrónico del creador del sobre. |
|
Rol de autor
|
folder.folderAuthorRole | string |
Rol de cuenta del creador del sobre. |
|
Id. de empresa
|
folder.folderCompanyId | integer |
Identificador único de la empresa a la que pertenece el sobre. |
|
Fecha de creación
|
folder.folderCreationDate | integer |
Fecha y hora en que se creó el sobre, en milisegundos unix. |
|
Fecha de envío
|
folder.folderSentDate | integer |
Fecha y hora en que se envió el sobre a los destinatarios, en milisegundos de Unix. Null si aún no se ha enviado. |
|
Situación
|
folder.folderStatus | string |
Estado actual del sobre (por ejemplo, SHARED, EXECUTED, DRAFT, CANCELLED). |
|
ID de documento
|
folder.folderDocumentIds | array of integer |
Lista de identificadores de documento incluidos en este sobre. |
|
Documentos
|
folder.documentsList | array of object |
Detalles de cada documento incluido en el sobre. |
|
Id. de documento
|
folder.documentsList.documentId | integer |
Identificador único del documento. |
|
Id. de contrato
|
folder.documentsList.contractId | integer |
Identificador único del contrato asociado a este documento. |
|
Id. de empresa
|
folder.documentsList.companyId | integer |
Identificador único de la empresa a la que pertenece este documento. |
|
Autor
|
folder.documentsList.contractCreatedBy | integer |
Identificador de usuario de la persona que creó el contrato. |
|
Creado el
|
folder.documentsList.contractCreatedOn | integer |
Fecha en que se creó el contrato, en milisegundos de Unix. |
|
Tipo contrato
|
folder.documentsList.contractType | string |
Tipo o categoría del contrato. |
|
Estado del documento
|
folder.documentsList.contractStatus | string |
Estado de firma actual del documento (por ejemplo, WAITING_FOR_SIGNATURE, EXECUTED). |
|
Editable
|
folder.documentsList.editable | boolean |
Indica si el documento se puede editar. |
|
Id. de la versión
|
folder.documentsList.contractVersionId | integer |
Identificador único de la versión del documento actual. |
|
Nombre de la versión
|
folder.documentsList.contractVersionName | string |
Nombre de la versión del documento actual. |
|
Descripción de la versión
|
folder.documentsList.contractVersionDesc | string |
Descripción de la versión actual del documento. |
|
Versión creada por
|
folder.documentsList.versionCreatedby | integer |
Identificador de usuario de la persona que creó esta versión del documento. |
|
Versión creada en
|
folder.documentsList.versionCreatedOn | integer |
Fecha en que se creó esta versión del documento, en milisegundos de Unix. |
|
Número de versión
|
folder.documentsList.contractVersionNumber | integer |
Número de versión del documento. |
|
Recipientes
|
folder.folderRecipientParties | array of object |
La lista de destinatarios de este sobre, incluido su estado de firma y vínculos de acceso. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
folder.folderRecipientParties.partyDetails.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
folder.folderRecipientParties.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
folder.folderRecipientParties.partyDetails.lastName | string |
Apellidos del destinatario. |
|
Correo Electrónico
|
folder.folderRecipientParties.partyDetails.emailId | string |
La dirección de correo electrónico del destinatario. |
|
Dirección
|
folder.folderRecipientParties.partyDetails.address | string |
Dirección del destinatario. |
|
Fecha de creación de la cuenta
|
folder.folderRecipientParties.partyDetails.dateCreated | integer |
Fecha en que se creó la cuenta del destinatario, en milisegundos de Unix. |
|
Permisos
|
folder.folderRecipientParties.contractPermissions | string |
Permisos de firma concedidos a este destinatario (por ejemplo, FILL_FIELDS_AND_SIGN). |
|
Orden de firma
|
folder.folderRecipientParties.partySequence | integer |
Posición de este destinatario en el orden de firma. |
|
Secuencia de flujo de trabajo
|
folder.folderRecipientParties.workflowSignSequence | integer |
Número de secuencia de firma de flujo de trabajo para este destinatario. |
|
Id. de sobre
|
folder.folderRecipientParties.envelopeId | integer |
Identificador del sobre al que pertenece este destinatario. |
|
Modo de uso compartido
|
folder.folderRecipientParties.sharingMode | string |
Método usado para compartir el documento con este destinatario (por ejemplo, correo electrónico). |
|
Dirección URL de firma
|
folder.folderRecipientParties.folderAccessURL | string |
Dirección URL de firma única para este destinatario. Null si el sobre ya se ha completado o cancelado. |
|
Modo de seguridad
|
folder.folderRecipientParties.securityMode | string |
Modo de seguridad aplicado al acceso de este destinatario. |
|
Comentarios adicionales
|
folder.folderRecipientParties.extraComments | string |
Cualquier comentario adicional incluido en la invitación de firma para este destinatario. |
|
Dirección URL de acceso del autor
|
folder.folderAccessURLForAuthor | string |
Dirección URL del autor del sobre para acceder al documento. Valor Null si no es aplicable. |
|
Id. masivo
|
folder.bulkId | integer |
El identificador del lote de envío masivo al que pertenece este sobre, si existe. |
|
Exigir orden de firma
|
folder.enforceSignWorkflow | boolean |
Indica si los destinatarios deben iniciar sesión en el orden especificado. |
|
Paso de flujo de trabajo actual
|
folder.currentWorkflowStep | integer |
Paso actual del flujo de trabajo de firma. |
|
Origen de la transacción
|
folder.transactionSource | string |
Origen que inició esta transacción de sobre. |
|
Editable
|
folder.editable | boolean |
Indica si el sobre todavía se puede editar. |
|
firma de In-Person
|
folder.inPersonSignable | boolean |
Indica si el sobre se puede iniciar sesión en persona. |
|
Invalidar recordatorios
|
folder.overrideAccountReminders | boolean |
Indica si la configuración de aviso de nivel de cuenta se invalida para este sobre. |
|
ID
|
folder.envelopeId | integer |
Identificador único del sobre. El mismo valor que envelope ID (folderId). |
|
Nombre
|
folder.envelopeName | string |
Nombre del sobre. El mismo valor que El nombre de sobre (folderName). |
|
Id. del originador
|
folder.envelopeOriginatorId | integer |
Identificador de usuario de la persona que creó el sobre. |
|
Id. de empresa
|
folder.envelopeCompanyId | integer |
Identificador de la empresa a la que pertenece el sobre. |
|
Date
|
folder.envelopeDate | integer |
Fecha y hora en que se creó el sobre, en milisegundos unix. |
|
Fecha compartida
|
folder.envelopeSharedDate | integer |
Fecha y hora en que el sobre se compartió con destinatarios, en milisegundos de Unix. Null si aún no se ha compartido. |
|
Situación
|
folder.envelopeStatus | string |
Estado actual del sobre. El mismo valor que El estado del sobre (folderStatus). |
|
Identificadores de contrato
|
folder.envelopeContractIds | array of integer |
Lista de identificadores de contrato asociados a este sobre. |
|
Permisos de entidad
|
folder.envelopePartyPermissions | array of object |
La lista de destinatarios y sus permisos de firma. La misma estructura que los destinatarios. |
|
Id. del destinatario
|
folder.envelopePartyPermissions.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
folder.envelopePartyPermissions.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
folder.envelopePartyPermissions.partyDetails.lastName | string |
Apellidos del destinatario. |
|
Correo Electrónico
|
folder.envelopePartyPermissions.partyDetails.emailId | string |
La dirección de correo electrónico del destinatario. |
|
Permisos
|
folder.envelopePartyPermissions.contractPermissions | string |
Permisos de firma para este destinatario. |
|
Orden de firma
|
folder.envelopePartyPermissions.partySequence | integer |
Posición de este destinatario en el orden de firma. |
|
Dirección URL de firma
|
folder.envelopePartyPermissions.folderAccessURL | string |
Dirección URL de firma única para este destinatario. |
|
Todos los campos
|
allFields | array of object |
Lista de todos los campos de firma y formulario colocados en los documentos del sobre. |
|
Id. de campo
|
allFields.fieldTagId | integer |
Identificador único del campo. |
|
Id. de documento
|
allFields.contractId | integer |
Identificador del documento al que pertenece este campo. |
|
Id. de la versión
|
allFields.versionId | integer |
Identificador de versión del documento al que pertenece este campo. |
|
Tipo de campo
|
allFields.fieldType | string |
Tipo del campo (por ejemplo, campo de signo, campo de texto, datefield, campo de casilla, campo desplegable, campo inicial). |
|
Número de página
|
allFields.documentPageNumber | integer |
Número de página donde se coloca este campo. |
|
Id. de documento de campo
|
allFields.docFieldId | string |
Identificador de nivel de documento para este campo. |
|
Parte responsable
|
allFields.partyResponsible | integer |
Identificador de entidad responsable de rellenar este campo. |
|
Depende
|
allFields.dependent | boolean |
Indica si la visibilidad de este campo depende del valor de otro campo. |
|
Obligatorio
|
allFields.required | boolean |
Indica si este campo debe rellenarse antes de que se pueda enviar el documento. |
|
Valor de campo
|
allFields.value | string |
Valor actual del campo, si se rellena. |
|
Valores de campo
|
allFieldsNameValue | array of object |
Lista simplificada de todos los nombres de campo y sus valores actuales. Úselo para leer los datos de campo rellenados de un sobre firmado. |
|
Id. de campo
|
allFieldsNameValue.fieldId | integer |
Identificador único del campo. |
|
Id. de documento
|
allFieldsNameValue.documentId | integer |
Identificador del documento al que pertenece este campo. |
|
Id. de la versión
|
allFieldsNameValue.documentVersionId | integer |
Identificador de versión del documento al que pertenece este campo. |
|
Tipo de campo
|
allFieldsNameValue.fieldType | string |
Tipo del campo (por ejemplo, campo de texto, campo de signo, campo de fecha, campo de verificación, campo de casilla, campo desplegable). |
|
Nombre del campo
|
allFieldsNameValue.name | string |
Etiqueta o nombre del campo tal como se define en la plantilla. |
|
Valor de campo
|
allFieldsNameValue.value | string |
Valor especificado o seleccionado para este campo. |
|
Historial de sobres
|
Folder History | array of object |
Pista de auditoría de todas las acciones realizadas en este sobre, en orden cronológico. |
|
Nombre
|
Folder History.firstName | string |
Nombre de la persona que realizó la acción. |
|
Apellido
|
Folder History.lastName | string |
Apellido de la persona que realizó la acción. |
|
Correo Electrónico
|
Folder History.email | string |
Dirección de correo electrónico de la persona que realizó la acción. |
|
Id. de sobre
|
Folder History.envelopeId | integer |
Identificador del sobre en el que se realizó la acción. |
|
Date
|
Folder History.dateChanged | integer |
Fecha y hora en que se produjo la acción, en milisegundos de Unix. |
|
Id. de parte
|
Folder History.changeDoneByParty | integer |
Identificador de entidad de la persona que realizó la acción. |
|
Acción
|
Folder History.action | string |
La acción realizada en el sobre (por ejemplo, Created, InviteSentTo, InviteAccepted, Signed, Executed). |
Obtener historial de actividad de sobre
Recupera un registro de actividad completo para un sobre, que muestra todas las acciones realizadas por los destinatarios y el remitente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
folderId | True | integer |
Identificador único del sobre cuyo historial de actividad desea recuperar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Id. de sobre
|
details.folderId | integer |
Identificador único del sobre. |
|
Documentos incluidos
|
details.enclosedDocuments | string |
Nombre de los documentos incluidos en el sobre. |
|
Recipientes
|
details.envelopeRecipients | string |
Nombres de todos los destinatarios del sobre. |
|
Author
|
details.author | string |
Nombre del usuario que creó el sobre. |
|
Situación
|
details.status | string |
Estado actual del sobre (por ejemplo, SHARED, EXECUTED, CANCELLED). |
|
Fecha de actividad más reciente
|
details.latestActivityDate | string |
Fecha y hora de la actividad más reciente en el sobre. |
|
Fecha de creación
|
details.dateCreated | string |
Fecha y hora en que se creó el sobre. |
|
Fecha de envío
|
details.dateSent | string |
Fecha y hora en que se envió el sobre a los destinatarios. |
|
Activities
|
details.activities | array of object |
Lista cronológica de todas las acciones realizadas en este sobre. |
|
Activity
|
details.activities.activity | string |
Descripción legible de la acción que se produjo. |
|
Acción
|
details.activities.action | string |
Tipo de acción realizada (por ejemplo, Created, Invitation Sent, Opened, Viewed, Signed). |
|
Usuario
|
details.activities.user | string |
Nombre del usuario que realizó la acción. |
|
Estado del sobre
|
details.activities.folderStatus | string |
Estado del sobre en el momento en que se produjo esta acción. |
|
Time
|
details.activities.time | string |
Fecha y hora en que se produjo la acción. |
|
Source
|
details.activities.source | string |
Origen desde el que se realizó la acción (por ejemplo, Web). |
|
Dirección IP
|
details.activities.ipAddress | string |
Dirección IP desde la que se realizó la acción, si está disponible. |
Obtener historial de sobres eliminados
Recupera un historial de sobres que se han eliminado o movido a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de sobre
|
folderId | True | string |
Identificador único del sobre cuyo historial de eliminación desea recuperar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Información de sobre eliminada
|
Deleted Folder Log Info | array of object |
Información de resumen sobre el sobre eliminado. |
|
Id. de sobre
|
Deleted Folder Log Info.folderId | integer |
Identificador único del sobre eliminado. |
|
Nombre del sobre
|
Deleted Folder Log Info.folderName | string |
Nombre del sobre eliminado. |
|
Nombre del documento
|
Deleted Folder Log Info.documentName | string |
Nombre del documento en el sobre eliminado. |
|
Id. de documento
|
Deleted Folder Log Info.documentId | string |
Identificador único del documento en el sobre eliminado. |
|
Fecha de eliminación
|
Deleted Folder Log Info.deletionDate | integer |
Fecha y hora en que se eliminó el sobre, en milisegundos de Unix. |
|
Eliminado por
|
Deleted Folder Log Info.deletedBy | string |
Nombre del usuario que eliminó el sobre. |
|
Historial de registros de eliminación
|
Deleted Folder Log History | array of object |
Registro paso a paso de todas las acciones de eliminación realizadas en el sobre. |
|
Realizado por
|
Deleted Folder Log History.partiesName | string |
Nombre del usuario que realizó el paso de eliminación. |
|
Source
|
Deleted Folder Log History.source | string |
Origen desde el que se inició la eliminación (por ejemplo, Web, API). |
|
Event
|
Deleted Folder Log History.event | string |
La acción de eliminación específica realizada (por ejemplo, Eliminar carpeta, Eliminar todas las partes de la carpeta). |
Obtener identificadores de sobre
Devuelve una lista de identificadores de sobre filtrados por estado. Úselo para buscar sobres en un estado específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha a partir de
|
dateFrom | True | string |
Inicio del intervalo de fechas de creación del sobre. Formato aceptado: AAAA-MM-DD. |
|
Fecha a
|
dateTo | True | string |
Final del intervalo de fechas de creación del sobre. Formato aceptado: AAAA-MM-DD. El valor dateTo debe estar dentro de 6 meses del valor dateFrom. |
|
Situación
|
status | string |
Filtre los sobres por estado. Valores aceptados: EXECUTED, SHARED, DRAFT, PARCIALMENTE SIGNED, CANCELLED, EXPIRED, DELETED. Si se omite, se devuelven sobres con cualquier estado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Message
|
message | string |
Mensaje de resumen que indica cuántos identificadores de sobre se devolvieron. |
|
Identificadores de sobre
|
allFolderIds | array of integer |
Lista de identificadores de sobre que coinciden con los criterios de filtro. Use estos identificadores con Obtener detalles del sobre para recuperar información completa sobre. |
Obtener plantillas por identificadores de plantilla
Recupera los detalles de una o varias plantillas por sus identificadores.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificadores de plantilla
|
templateIds | True | array of integer |
Matriz de identificadores de plantilla que se van a recuperar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Plantillas totales
|
total_templates | integer |
Número total de plantillas devueltas. |
|
Lista de plantillas
|
templateIdList | object |
Mapa de los datos de plantilla con clave por identificador de plantilla. Cada entrada contiene los detalles de la plantilla y sus campos. |
Obtener una lista de todas las plantillas
Devuelve una lista de todas las plantillas disponibles en su cuenta.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Result
|
result | string |
Indica si la solicitud se ha realizado correctamente. |
|
Plantillas totales
|
total_templates | integer |
Número total de plantillas de la cuenta. |
|
Lista de plantillas
|
templatesList | array of object |
Lista de todas las plantillas disponibles en la cuenta. |
|
Identificador de plantilla
|
templatesList.templateId | integer |
Identificador único de la plantilla. Use este identificador con Create Envelope from Template (Crear sobre desde plantilla) para enviar la plantilla para la firma. |
|
Nombre de la plantilla
|
templatesList.templateName | string |
El nombre de la plantilla. |
|
Descripción de la plantilla
|
templatesList.templateDesc | string |
Descripción de la plantilla. |
|
Tipo de plantilla
|
templatesList.templateType | string |
Tipo o categoría de la plantilla. |
|
Fecha de creación
|
templatesList.templateCreationDate | integer |
Fecha en que se creó la plantilla, en milisegundos de Unix. |
|
Fecha de última actualización
|
templatesList.templateLastUpdateDate | integer |
Fecha en que la plantilla se actualizó por última vez, en milisegundos de Unix. |
|
Editable
|
templatesList.editable | boolean |
Indica si se puede editar la plantilla. |
|
Número de partes
|
templatesList.numberOfParties | integer |
Número de entidades de firma definidas en la plantilla. |
|
Id. de empresa
|
templatesList.companyId | integer |
La cuenta de empresa a la que pertenece la plantilla. |
|
Compartir con todos
|
templatesList.shareAll | boolean |
Indica si la plantilla se comparte con todos los usuarios de la cuenta. |
|
Id. de parte
|
templatesList.templateCreatedBy.partyId | integer |
Identificador único del usuario. |
|
Nombre
|
templatesList.templateCreatedBy.firstName | string |
El primer nombre del usuario. |
|
Apellido
|
templatesList.templateCreatedBy.lastName | string |
Los apellidos del usuario. |
|
Correo Electrónico
|
templatesList.templateCreatedBy.emailId | string |
La dirección de correo electrónico del usuario. |
|
Id. de parte
|
templatesList.templateLastUpdatedBy.partyId | integer |
Identificador único del usuario. |
|
Nombre
|
templatesList.templateLastUpdatedBy.firstName | string |
El primer nombre del usuario. |
|
Apellido
|
templatesList.templateLastUpdatedBy.lastName | string |
Los apellidos del usuario. |
|
Correo Electrónico
|
templatesList.templateLastUpdatedBy.emailId | string |
La dirección de correo electrónico del usuario. |
Desencadenadores
| Cuando se cancela un sobre |
Se desencadena cuando un destinatario o el remitente cancelan un sobre. |
| Cuando se ejecuta un sobre por completo |
Se desencadena cuando todos los destinatarios han firmado y el sobre se ejecuta por completo. |
| Cuando se elimina un sobre |
Se desencadena cuando se elimina un sobre. |
| Cuando se envía un sobre |
Se desencadena cuando se envía un sobre a los destinatarios. Este evento solo se desencadena cuando El nivel de webhook está establecido en "Cuenta". |
| Cuando se firma un sobre |
Se desencadena cuando un destinatario firma el sobre. |
| Cuando se ve un sobre |
Se desencadena cuando se abre un destinatario y ve el sobre. |
Cuando se cancela un sobre
Se desencadena cuando un destinatario o el remitente cancelan un sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del canal
|
channelName | True | string |
Nombre para identificar esta suscripción de webhook en su cuenta. |
|
Nivel de webhook
|
webhookLevel | True | string |
Cuenta: se activa para todos los sobres (web y API). Aplicación de API: se activa solo para los sobres creados a través de la API. |
|
Secreto de webhook
|
webhookSecret | string |
Optional. Foxit eSign firma cada carga de webhook con HMAC-SHA-256 mediante este secreto para su comprobación. |
Devoluciones
Los datos del evento recibidos de Foxit eSign cuando se desencadena un evento de webhook.
- WebhookEventPayload
- WebhookEventPayload
Cuando se ejecuta un sobre por completo
Se desencadena cuando todos los destinatarios han firmado y el sobre se ejecuta por completo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del canal
|
channelName | True | string |
Nombre para identificar esta suscripción de webhook en su cuenta. |
|
Nivel de webhook
|
webhookLevel | True | string |
Cuenta: se activa para todos los sobres (web y API). Aplicación de API: se activa solo para los sobres creados a través de la API. |
|
Secreto de webhook
|
webhookSecret | string |
Optional. Foxit eSign firma cada carga de webhook con HMAC-SHA-256 mediante este secreto para su comprobación. |
Devoluciones
Los datos del evento recibidos de Foxit eSign cuando se desencadena un evento de webhook.
- WebhookEventPayload
- WebhookEventPayload
Cuando se elimina un sobre
Se desencadena cuando se elimina un sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del canal
|
channelName | True | string |
Nombre para identificar esta suscripción de webhook en su cuenta. |
|
Nivel de webhook
|
webhookLevel | True | string |
Cuenta: se activa para todos los sobres (web y API). Aplicación de API: se activa solo para los sobres creados a través de la API. |
|
Secreto de webhook
|
webhookSecret | string |
Optional. Foxit eSign firma cada carga de webhook con HMAC-SHA-256 mediante este secreto para su comprobación. |
Devoluciones
Los datos del evento recibidos de Foxit eSign cuando se desencadena un evento de webhook.
- WebhookEventPayload
- WebhookEventPayload
Cuando se envía un sobre
Se desencadena cuando se envía un sobre a los destinatarios. Este evento solo se desencadena cuando El nivel de webhook está establecido en "Cuenta".
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del canal
|
channelName | True | string |
Nombre para identificar esta suscripción de webhook en su cuenta. |
|
Nivel de webhook
|
webhookLevel | True | string |
Cuenta: se activa para los sobres enviados a través de web o API. Aplicación de API: se activa solo para los sobres creados a través de la API. El evento folder_sent solo se desencadena en el nivel de cuenta. |
|
Secreto de webhook
|
webhookSecret | string |
Optional. Foxit eSign firma cada carga de webhook con HMAC-SHA-256 mediante este secreto para su comprobación. |
Devoluciones
Los datos del evento recibidos de Foxit eSign cuando se desencadena un evento de webhook.
- WebhookEventPayload
- WebhookEventPayload
Cuando se firma un sobre
Se desencadena cuando un destinatario firma el sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del canal
|
channelName | True | string |
Nombre para identificar esta suscripción de webhook en su cuenta. |
|
Nivel de webhook
|
webhookLevel | True | string |
Cuenta: se activa para todos los sobres (web y API). Aplicación de API: se activa solo para los sobres creados a través de la API. |
|
Secreto de webhook
|
webhookSecret | string |
Optional. Foxit eSign firma cada carga de webhook con HMAC-SHA-256 mediante este secreto para su comprobación. |
Devoluciones
Los datos del evento recibidos de Foxit eSign cuando se desencadena un evento de webhook.
- WebhookEventPayload
- WebhookEventPayload
Cuando se ve un sobre
Se desencadena cuando se abre un destinatario y ve el sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del canal
|
channelName | True | string |
Nombre para identificar esta suscripción de webhook en su cuenta. |
|
Nivel de webhook
|
webhookLevel | True | string |
Cuenta: se activa para todos los sobres (web y API). Aplicación de API: se activa solo para los sobres creados a través de la API. |
|
Secreto de webhook
|
webhookSecret | string |
Optional. Foxit eSign firma cada carga de webhook con HMAC-SHA-256 mediante este secreto para su comprobación. |
Devoluciones
Los datos del evento recibidos de Foxit eSign cuando se desencadena un evento de webhook.
- WebhookEventPayload
- WebhookEventPayload
Definiciones
WebhookEventPayload
Los datos del evento recibidos de Foxit eSign cuando se desencadena un evento de webhook.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre del evento
|
event_name | string |
Nombre del evento que se desencadenó (por ejemplo, folder_sent, folder_signed, folder_executed). |
|
Fecha de evento
|
event_date | integer |
Fecha y hora en que se produjo el evento (marca de tiempo de Unix en milisegundos). |
|
ID
|
data.folder.folderId | integer |
Identificador único del sobre. |
|
Nombre
|
data.folder.folderName | string |
Nombre del sobre. |
|
Nombre personalizado
|
data.folder.folderCustomName | string |
Nombre personalizado asignado al sobre. |
|
Password
|
data.folder.folderPassword | string |
Contraseña de acceso para el sobre, si se establece. |
|
Id. del creador
|
data.folder.folderAuthorId | integer |
Identificador de usuario del creador del sobre. |
|
Nombre del creador
|
data.folder.folderAuthorFirstName | string |
Nombre del creador del sobre. |
|
Apellidos del creador
|
data.folder.folderAuthorLastName | string |
Apellido del creador del sobre. |
|
Correo electrónico del creador
|
data.folder.folderAuthorEmail | string |
Dirección de correo electrónico del creador del sobre. |
|
Rol de creador
|
data.folder.folderAuthorRole | string |
Rol de cuenta del creador del sobre. |
|
Id. de empresa
|
data.folder.folderCompanyId | integer |
Identificador de la empresa que posee el sobre. |
|
Fecha de creación
|
data.folder.folderCreationDate | integer |
Fecha en que se creó el sobre (marca de tiempo de Unix en milisegundos). |
|
Fecha de envío
|
data.folder.folderSentDate | integer |
Fecha en que se envió el sobre (marca de tiempo de Unix en milisegundos). |
|
Situación
|
data.folder.folderStatus | string |
Estado actual del sobre. |
|
Campo personalizado 1
|
data.folder.custom_field1 | string |
Primer campo de metadatos personalizado. |
|
Campo personalizado 2
|
data.folder.custom_field2 | string |
Segundo campo de metadatos personalizado. |
|
Metadatos
|
data.folder.metadata | string |
Metadatos personalizados asociados al sobre. |
|
ID de documento
|
data.folder.folderDocumentIds | array of integer |
Lista de identificadores de documento en el sobre. |
|
Documentos
|
data.folder.documentsList | array of object |
Lista de documentos en el sobre. |
|
Id. de documento
|
data.folder.documentsList.documentId | integer |
Identificador único del documento. |
|
Id. de contrato
|
data.folder.documentsList.contractId | integer |
Identificador de contrato de este documento. |
|
Id. de empresa
|
data.folder.documentsList.companyId | integer |
Identificador de empresa de este documento. |
|
Autor
|
data.folder.documentsList.contractCreatedBy | integer |
Identificador de usuario de la persona que creó el contrato. |
|
Creado el
|
data.folder.documentsList.contractCreatedOn | integer |
Fecha en que se creó el contrato (marca de tiempo de Unix en milisegundos). |
|
Tipo contrato
|
data.folder.documentsList.contractType | string |
Tipo del contrato. |
|
Estado del contrato
|
data.folder.documentsList.contractStatus | string |
Estado actual del contrato. |
|
Editable
|
data.folder.documentsList.editable | boolean |
Indica si el documento es editable. |
|
Id. de la versión
|
data.folder.documentsList.contractVersionId | integer |
Identificador de versión del contrato. |
|
Nombre de la versión
|
data.folder.documentsList.contractVersionName | string |
Nombre de la versión del contrato. |
|
Descripción de la versión
|
data.folder.documentsList.contractVersionDesc | string |
Descripción de la versión del contrato. |
|
Versión creada por
|
data.folder.documentsList.versionCreatedby | integer |
Identificador de usuario de la persona que creó esta versión. |
|
Versión creada en
|
data.folder.documentsList.versionCreatedOn | integer |
Fecha en que se creó esta versión (marca de tiempo de Unix en milisegundos). |
|
Número de versión
|
data.folder.documentsList.contractVersionNumber | integer |
Número de versión del contrato. |
|
Origen de la transacción
|
data.folder.documentsList.contractTransactionSource | string |
Sistema de origen que inició el contrato. |
|
Recipientes
|
data.folder.folderRecipientParties | array of object |
Lista de destinatarios para este sobre. |
|
Id. del destinatario
|
data.folder.folderRecipientParties.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
data.folder.folderRecipientParties.partyDetails.partyId | integer |
Identificador único del destinatario. |
|
Nombre
|
data.folder.folderRecipientParties.partyDetails.firstName | string |
Nombre del destinatario. |
|
Apellido
|
data.folder.folderRecipientParties.partyDetails.lastName | string |
Apellidos del destinatario. |
|
Correo Electrónico
|
data.folder.folderRecipientParties.partyDetails.emailId | string |
La dirección de correo electrónico del destinatario. |
|
Marcador de posición
|
data.folder.folderRecipientParties.partyDetails.placeholder | boolean |
Si se trata de un destinatario de marcador de posición. |
|
Dirección
|
data.folder.folderRecipientParties.partyDetails.address | string |
Dirección del destinatario. |
|
Fecha de creación
|
data.folder.folderRecipientParties.partyDetails.dateCreated | integer |
Fecha en que se creó el registro del destinatario (marca de tiempo de Unix en milisegundos). |
|
Rechazar correos electrónicos
|
data.folder.folderRecipientParties.partyDetails.optOutEmails | boolean |
Si el destinatario ha optado por no participar en los correos electrónicos. |
|
Id. único
|
data.folder.folderRecipientParties.partyDetails.uniquePartyId | string |
Identificador único del sistema para este destinatario. |
|
Nivel de autenticación
|
data.folder.folderRecipientParties.partyDetails.authenticationLevel | string |
Método de autenticación para este destinatario. |
|
Fecha de actualización de contraseña
|
data.folder.folderRecipientParties.partyDetails.passwordUpdateDate | string |
Fecha en que se actualizó la contraseña por última vez. |
|
Estado de la contraseña
|
data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus | boolean |
Indica si se ha actualizado la contraseña. |
|
Código de marcado
|
data.folder.folderRecipientParties.dialingCode | string |
El código de marcado internacional. |
|
Mobile
|
data.folder.folderRecipientParties.mobileNumber | string |
Número de móvil del destinatario. |
|
Tipo de firma
|
data.folder.folderRecipientParties.signerSignatureType | string |
Tipo de firma que usará el firmante. |
|
Permisos
|
data.folder.folderRecipientParties.contractPermissions | string |
Permisos concedidos a este destinatario. |
|
Orden de firma
|
data.folder.folderRecipientParties.partySequence | integer |
Orden de firma para este destinatario. |
|
Secuencia de flujo de trabajo
|
data.folder.folderRecipientParties.workflowSignSequence | integer |
Número de secuencia de firma de flujo de trabajo. |
|
Id. de sobre
|
data.folder.folderRecipientParties.envelopeId | integer |
Identificador de sobre asociado a este destinatario. |
|
Id. de empresa del destinatario
|
data.folder.folderRecipientParties.partyCompanyId | integer |
Identificador de empresa de este destinatario. |
|
Modo de uso compartido
|
data.folder.folderRecipientParties.sharingMode | string |
Modo de uso compartido para este destinatario. |
|
Dirección URL de firma de destinatarios
|
data.folder.folderRecipientParties.folderAccessURL | string |
Dirección URL para que este destinatario acceda y firme el sobre. |
|
Modo de seguridad
|
data.folder.folderRecipientParties.securityMode | string |
Modo de seguridad para este destinatario. |
|
Comments
|
data.folder.folderRecipientParties.extraComments | string |
Comentarios adicionales para el destinatario. |
|
Permitir cambio de nombre
|
data.folder.folderRecipientParties.allowNameChange | boolean |
Si el destinatario puede actualizar su nombre. |
|
Nombre actualizado
|
data.folder.folderRecipientParties.signerNameUpdated | boolean |
Si el firmante ha actualizado su nombre. |
|
Nivel de autenticación del firmante
|
data.folder.folderRecipientParties.signerAuthenticationLevel | string |
Nivel de autenticación necesario para el firmante. |
|
Código de acceso
|
data.folder.folderRecipientParties.userDefinedAccessCode | string |
Código de acceso personalizado para el firmante. |
|
Id. de firma
|
data.folder.folderRecipientParties.signatureId | string |
Identificador de la firma aplicada. |
|
Función
|
data.folder.folderRecipientParties.partyRole | string |
Rol de este destinatario en el flujo de trabajo de firma. |
|
Campo de empresa
|
data.folder.folderRecipientParties.companyFieldValue | string |
Valor del campo nombre de la empresa. |
|
Campo de título
|
data.folder.folderRecipientParties.titleFieldValue | string |
Valor del campo de título. |
|
Motivo de la firma
|
data.folder.folderRecipientParties.reasonSigning | string |
Motivo dado para la firma. |
|
Campo de pago agregado
|
data.folder.folderRecipientParties.payFieldAdded | boolean |
Si se agregó un campo de pago. |
|
Beneficiario
|
data.folder.folderRecipientParties.payee | boolean |
Si este destinatario es el beneficiario. |
|
Pago periódico
|
data.folder.folderRecipientParties.recurringFieldExist | boolean |
Si existe un campo de pago periódico. |
|
Imprimir y firmar listo
|
data.folder.folderRecipientParties.printAndSignCompleted | boolean |
Indica si se ha completado la impresión y el signo. |
|
Firmante opcional
|
data.folder.folderRecipientParties.allowOptionalSigner | boolean |
Si este destinatario es un firmante opcional. |
|
Firmantes opcionales
|
data.folder.folderRecipientParties.optionalSigners | array of integer |
Identificadores de entidad de firma opcionales. |
|
Pagado
|
data.folder.folderRecipientParties.paid | boolean |
Indica si se ha completado el pago. |
|
Dirección URL de acceso del autor
|
data.folder.folderAccessURLForAuthor | string |
Dirección URL del autor del sobre para acceder al sobre. |
|
Dirección URL de acceso de borrador
|
data.folder.draftFolderAccessURL | string |
Dirección URL para acceder al sobre en estado borrador. |
|
Firma de sala de juntas
|
data.folder.boardRoomSign | boolean |
Indica si el modo de firma de la sala de juntas está habilitado. |
|
Incluir logotipo
|
data.folder.includeLogo | boolean |
Indica si el logotipo de la empresa está incluido en los correos electrónicos. |
|
Color de fondo del botón
|
data.folder.email_btnBgColor | string |
Color de fondo del botón de acción de correo electrónico. |
|
Color del texto del botón
|
data.folder.email_btnTxtColor | string |
Color de texto del botón de acción de correo electrónico. |
|
Logotipo de correo electrónico
|
data.folder.emailTemplateLogo | string |
Dirección URL del logotipo usada en la plantilla de correo electrónico. |
|
Id. de plantilla de correo electrónico
|
data.folder.emailTemplateId | integer |
Identificador de la plantilla de correo electrónico usada. |
|
Encabezado de correo electrónico
|
data.folder.emailHeader | string |
Texto del encabezado en los correos electrónicos de notificación. |
|
Pie de página de correo electrónico
|
data.folder.emailFooter | string |
Texto del pie de página en los correos electrónicos de notificación. |
|
Purga programada
|
data.folder.purgeFlag | boolean |
Indica si el sobre está programado para purgar. |
|
Purgar fecha de inicio
|
data.folder.purgeStartDate | string |
Fecha de inicio de la programación de purga. |
|
Purgar fecha de finalización
|
data.folder.purgeEndDate | string |
Fecha de finalización de la programación de purga. |
|
Id. masivo
|
data.folder.bulkId | integer |
Identificador de la operación de envío masivo, si procede. |
|
Exigir orden de firma
|
data.folder.enforceSignWorkflow | boolean |
Si los destinatarios deben iniciar sesión en el orden definido. |
|
Paso de flujo de trabajo actual
|
data.folder.currentWorkflowStep | integer |
Paso actual del flujo de trabajo de firma. |
|
Origen de la transacción
|
data.folder.transactionSource | string |
Sistema de origen que inició esta transacción. |
|
Editable
|
data.folder.editable | boolean |
Si el sobre es editable. |
|
firma de In-Person
|
data.folder.inPersonSignable | boolean |
Si el sobre admite la firma en persona. |
|
Invalidar recordatorios
|
data.folder.overrideAccountReminders | boolean |
Indica si se invalida la configuración de aviso de nivel de cuenta. |
|
Invalidar delegación
|
data.folder.overrideAccountRecipientDelegation | boolean |
Si se invalida la configuración de delegación de nivel de cuenta. |
|
Permitir delegación
|
data.folder.allowRecipientsToDelegate | boolean |
Si los destinatarios pueden delegar la firma. |
|
ID
|
data.folder.envelopeId | integer |
Identificador de sobre único (alias de folderId). |
|
Nombre
|
data.folder.envelopeName | string |
Nombre del sobre (alias de folderName). |
|
Id. del originador
|
data.folder.envelopeOriginatorId | integer |
Identificador de usuario que originó el sobre. |
|
Id. de empresa
|
data.folder.envelopeCompanyId | integer |
Identificador de la empresa que posee el sobre. |
|
Date
|
data.folder.envelopeDate | integer |
Fecha en que se creó el sobre (marca de tiempo de Unix en milisegundos). |
|
Fecha compartida
|
data.folder.envelopeSharedDate | integer |
Fecha en que se compartió el sobre (marca de tiempo de Unix en milisegundos). |
|
Situación
|
data.folder.envelopeStatus | string |
Estado actual del sobre. |
|
Identificadores de contrato
|
data.folder.envelopeContractIds | array of integer |
Identificadores de contrato asociados a este sobre. |
|
Permisos de entidad
|
data.folder.envelopePartyPermissions | array of object |
Lista de permisos de destinatarios (misma estructura que Destinatarios). |
|
Id. del destinatario
|
data.folder.envelopePartyPermissions.partyId | integer |
Identificador único del destinatario. |
|
Id. del destinatario
|
data.folder.envelopePartyPermissions.partyDetails.partyId | integer | |
|
Nombre
|
data.folder.envelopePartyPermissions.partyDetails.firstName | string | |
|
Apellido
|
data.folder.envelopePartyPermissions.partyDetails.lastName | string | |
|
Correo Electrónico
|
data.folder.envelopePartyPermissions.partyDetails.emailId | string | |
|
Marcador de posición
|
data.folder.envelopePartyPermissions.partyDetails.placeholder | boolean | |
|
Dirección
|
data.folder.envelopePartyPermissions.partyDetails.address | string | |
|
Fecha de creación
|
data.folder.envelopePartyPermissions.partyDetails.dateCreated | integer | |
|
Rechazar correos electrónicos
|
data.folder.envelopePartyPermissions.partyDetails.optOutEmails | boolean | |
|
Id. único
|
data.folder.envelopePartyPermissions.partyDetails.uniquePartyId | string | |
|
Nivel de autenticación
|
data.folder.envelopePartyPermissions.partyDetails.authenticationLevel | string | |
|
Fecha de actualización de contraseña
|
data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate | string | |
|
Estado de la contraseña
|
data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus | boolean | |
|
Código de marcado
|
data.folder.envelopePartyPermissions.dialingCode | string | |
|
Mobile
|
data.folder.envelopePartyPermissions.mobileNumber | string | |
|
Tipo de firma
|
data.folder.envelopePartyPermissions.signerSignatureType | string | |
|
Permisos
|
data.folder.envelopePartyPermissions.contractPermissions | string | |
|
Orden de firma
|
data.folder.envelopePartyPermissions.partySequence | integer | |
|
Secuencia de flujo de trabajo
|
data.folder.envelopePartyPermissions.workflowSignSequence | integer | |
|
Id. de sobre
|
data.folder.envelopePartyPermissions.envelopeId | integer | |
|
Id. de empresa del destinatario
|
data.folder.envelopePartyPermissions.partyCompanyId | integer | |
|
Modo de uso compartido
|
data.folder.envelopePartyPermissions.sharingMode | string | |
|
Dirección URL de firma de destinatarios
|
data.folder.envelopePartyPermissions.folderAccessURL | string | |
|
Modo de seguridad
|
data.folder.envelopePartyPermissions.securityMode | string | |
|
Comments
|
data.folder.envelopePartyPermissions.extraComments | string | |
|
Permitir cambio de nombre
|
data.folder.envelopePartyPermissions.allowNameChange | boolean | |
|
Nombre actualizado
|
data.folder.envelopePartyPermissions.signerNameUpdated | boolean | |
|
Nivel de autenticación del firmante
|
data.folder.envelopePartyPermissions.signerAuthenticationLevel | string | |
|
Código de acceso
|
data.folder.envelopePartyPermissions.userDefinedAccessCode | string | |
|
Id. de firma
|
data.folder.envelopePartyPermissions.signatureId | string | |
|
Función
|
data.folder.envelopePartyPermissions.partyRole | string | |
|
Campo de empresa
|
data.folder.envelopePartyPermissions.companyFieldValue | string | |
|
Campo de título
|
data.folder.envelopePartyPermissions.titleFieldValue | string | |
|
Motivo de la firma
|
data.folder.envelopePartyPermissions.reasonSigning | string | |
|
Campo de pago agregado
|
data.folder.envelopePartyPermissions.payFieldAdded | boolean | |
|
Beneficiario
|
data.folder.envelopePartyPermissions.payee | boolean | |
|
Pago periódico
|
data.folder.envelopePartyPermissions.recurringFieldExist | boolean | |
|
Imprimir y firmar listo
|
data.folder.envelopePartyPermissions.printAndSignCompleted | boolean | |
|
Firmante opcional
|
data.folder.envelopePartyPermissions.allowOptionalSigner | boolean | |
|
Firmantes opcionales
|
data.folder.envelopePartyPermissions.optionalSigners | array of integer | |
|
Pagado
|
data.folder.envelopePartyPermissions.paid | boolean | |
|
Nivel de autenticación
|
data.folder.envelopeAuthenticationLevel | string |
Nivel de autenticación necesario para el sobre. |
|
Single Signer Bulk
|
data.folder.allowSingleSignerInBulk | boolean |
Indica si se permite un inicio de sesión único en modo masivo. |
|
nombre de carpeta de File-Based
|
data.folder.folderNameBasedOnFileNaming | boolean | |
|
File-Based nombre de documento
|
data.folder.documentNameBasedOnFileNaming | boolean | |
|
nombre del certificado de File-Based
|
data.folder.certificateNameBasedOnFileNaming | boolean | |
|
Nomenclatura de archivos anteriores a exec
|
data.folder.enableFileNamingBeforeExecution | boolean | |
|
Pago agregado
|
data.folder.payeeAddedd | boolean | |
|
Self-Signing habilitado
|
data.folder.selfSignerEnabled | boolean | |
|
Notary Enabled
|
data.folder.notaryEnabled | boolean | |
|
Visibilidad limitada
|
data.folder.limitedVisibilityFlag | boolean | |
|
Visibilidad posterior al inicio de sesión
|
data.folder.postSigningVisibility | boolean | |
|
Firma mojada
|
data.folder.wetSignatureEnabled | boolean | |
|
Combinar habilitado
|
data.folder.mergeEnabled | boolean |
binario
Este es el tipo de datos básico "binary".