SigningHub (versión preliminar)

SigningHub by Ascertia ofrece un conjunto completo de firmas digitales de elevada confianza y automatización del flujo de trabajo de documentos. Este conector permite a las empresas autenticar de forma segura a los usuarios, iniciar solicitudes de firma de documentos y administrar ciclos de aprobación de un extremo a otro. Diseñado para cumplir rigurosas normas de seguridad globales, garantiza que los flujos de trabajo automatizados permanezcan legalmente ejecutables, transparentes y altamente seguros en toda la organización.

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)

Contacto
Nombre	Apoyo
URL	https://www.signinghub.com/contact-us/
Correo Electrónico	[email protected]

Metadatos del conector
Publisher	Ascertia Limited.
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Sitio web	https://signinghub.com
Directiva de privacidad	https://www.signinghub.com/privacy-policy
Categories	Contenido y archivos; Productividad

Conector de SigningHub

SigningHub proporciona una API REST completa que permite a las organizaciones automatizar y administrar flujos de trabajo de firma de documentos digitales. Con este conector, puede integrar SigningHub con Power Automate para simplificar los procesos de aprobación de documentos y automatizar las acciones de firma dentro de flujos de trabajo personalizados.

Este conector permite la automatización de la firma de documentos y otras acciones de SigningHub directamente dentro de flujos de Power Automate, lo que ayuda a las organizaciones a crear flujos de trabajo de documentos eficaces y seguros.

Publisher: Ascertia

Prerrequisitos

Para usar este conector, debe tener:

Una cuenta activa de SigningHub (https://www.signinghub.com).
Una integración válida definida en SigningHub.

Obtención de credenciales

Rellene los campos Formulario de inicio de sesión con los siguientes valores:

Correo electrónico: el correo electrónico de la cuenta de SigningHub.
Contraseña: la contraseña de la cuenta de SigningHub.
Id. de cliente de API: Ascertia o el administrador de la empresa proporcionarán el identificador de cliente de API para usar el conector.
Secreto de cliente de API: Ascertia o el administrador de la empresa proporcionarán el secreto de cliente de API para usar el conector.
DIRECCIÓN URL de API: la dirección URL de la API de SigningHub, de forma predeterminada https://api.signinghub.com

Operaciones admitidas

Este conector proporciona cierta cobertura de la API REST de SigningHub. Para obtener una lista de las acciones admitidas y sus parámetros, consulte la Guía de la API de SigningHub.

Soporte y vínculos

Limitaciones

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

Acciones

Actualización posterior al procesamiento	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un marcador de posición a un flujo de trabajo de un documento en un paquete.
Actualizar autenticación de usuario de flujo de trabajo (apertura de documentos) del paquete enterprise	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar las autenticaciones del paquete y la duración del acceso para los destinatarios. El administrador de empresa o el usuario de empresa también pueden usar esta API si se usó la variable "ámbito" en la solicitud de autenticación.
Actualizar campo CheckBox	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo de casilla de un documento en un paquete. Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios. Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI. No se puede actualizar el ancho y el alto. Seguirán siendo los mismos que cuando se agregaron.
Actualizar campo de firma digital	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo de firma digital de un documento en un paquete. Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios. Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI.
Actualizar campo en persona	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo de firma en persona de un documento en un paquete. Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios. Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI.
Actualizar campo inicial	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo inicial de un documento en un paquete. Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios. Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI.
Actualizar campo RadioBox	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un botón de radio de un documento en un paquete. Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios. Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI. No se puede actualizar el ancho y el alto. Seguirán siendo los mismos que cuando se agregaron.
Actualizar campo TextBox	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un cuadro de texto de un documento en un paquete. Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios. Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI.
Actualizar código QR	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un código QR de un documento en un paquete.
Actualizar datos adjuntos	Las aplicaciones empresariales pueden usar esta API de servicio para cargar datos adjuntos en un documento.
Actualizar detalles del flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los detalles del flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento, pero las aplicaciones empresariales quieren invalidar los detalles del permiso de certificación o posterior al procesamiento. El identificador del paquete se proporciona en la dirección URL del recurso.
Actualizar directiva de Certify para un documento	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar la configuración de firma de certificación de un documento de un paquete.
Actualizar el orden de los usuarios del flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar el orden del destinatario en el flujo de trabajo.
Actualizar espacio compartido	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar el espacio compartido. La disponibilidad de actualizar espacios compartidos está sujeta al rol de usuario de empresa asignado. Para permitir esta aprovisionamiento, el administrador de empresa habilitará la opción "Administrar espacio compartido" en Roles Document Settings (Configuración del documento de roles>).
Actualizar marcador de posición	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un marcador de posición en el flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento y las aplicaciones empresariales quieren invalidar los detalles de un marcador de posición específico dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el titular del lugar del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo. Aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
Actualizar permisos de usuario de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los permisos de flujo de trabajo de un usuario que ya se ha agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento y las aplicaciones empresariales quieren invalidar los permisos dentro del flujo de trabajo. El identificador del paquete de documento se proporciona en la dirección URL del recurso y el usuario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo.
Actualizar recordatorios de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los recordatorios de flujo de trabajo de un destinatario que ya se ha agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de que se haya aplicado una plantilla a un documento y las aplicaciones empresariales quieran invalidar la configuración de recordatorios dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el destinatario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo.
Actualizar usuario de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los detalles de un destinatario, grupo o marcador de posición que ya se ha agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento y las aplicaciones empresariales quieren invalidar los detalles de un usuario específico dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el destinatario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo. Tenga en cuenta que, mientras que la preparación del documento de tipo XML, solo admite los tipos de rol "SIGNER", "REVIEWER" y "CARBON_COPY".
Agregar campo CheckBox	Las aplicaciones empresariales pueden usar esta API de servicio para agregar una casilla a un documento de un paquete. Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo. Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios. Si no se proporcionan parámetros de ancho y alto, se asignará un tamaño predeterminado de 10x10. Si se proporciona ancho o alto (o ambos), el sistema comparará estos valores proporcionados entre sí. El valor mayor entre ancho y alto se asignará a ambas dimensiones.
Agregar campo de firma digital	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un campo de firma digital a un documento de un paquete. Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo. Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios.
Agregar campo en persona	Las aplicaciones empresariales pueden usar esta API de servicio para un campo de firma de persona de complemento en un documento de un paquete. Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo. Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios. Para hospedar una reunión en persona, un usuario de SigningHub debe formar parte del flujo de trabajo. Deben agregarse con el rol "INPERSON_HOST" o "SIGNER". Para la opción host no requieren un campo de firma o entrada en el documento, y el campo de firma en persona puede estar firmado por el usuario registrado que no es SigningHub. Tenga en cuenta que se trata de un escenario de flujo de trabajo especial en el que se espera que el usuario y el destinatario de SigningHub estén en la misma ubicación. Este tipo de firma no está pensado para su uso mediante el cual un documento se comparte con destinatarios a través del vínculo de correo electrónico en el método de integración flexible normal.
Agregar campo inicial	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un campo inicial a un documento de un paquete. Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo. Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios.
Agregar campo RadioBox	Las aplicaciones empresariales pueden usar esta API de servicio para agregar una casilla a un documento de un paquete. Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo. Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios. Si no se proporcionan parámetros de ancho y alto, se asignará un tamaño predeterminado de 10x10. Si se proporciona ancho o alto (o ambos), el sistema comparará estos valores proporcionados entre sí. El valor mayor entre ancho y alto se asignará a ambas dimensiones.
Agregar campo TextBox	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un campo de entrada de texto a un documento de un paquete. Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo. Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios.
Agregar código QR	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un código QR a un documento de un paquete.
Agregar grupos al flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para agregar grupos como destinatario a un flujo de trabajo. Un grupo signingHub significa que cualquier miembro del grupo puede realizar la acción, es decir, iniciar sesión en nombre de todos los miembros del grupo. Tenga en cuenta que el grupo se agregará como último usuario o grupo en el flujo de trabajo. Por lo tanto, es posible que sea necesario seguir trabajando para quitar un usuario o grupo actual, ya presente en el flujo de trabajo. Aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
Agregar marcador de posición al flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un marcador de posición a un flujo de trabajo de un paquete. Se requiere un marcador de posición cuando no conoce la identidad del destinatario previsto en un flujo de trabajo. Tenga en cuenta que el marcador de posición se agregará como último usuario del flujo de trabajo. Por lo tanto, es posible que sea necesario seguir trabajando para quitar un usuario o grupo actual, ya presente en el flujo de trabajo. Agregar un marcador de posición le permite continuar y agregar campos de firma o entrada al documento, que luego se pueden asignar a usuarios individuales en una fase posterior. Aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
Agregar o actualizar documento desde la biblioteca	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un documento de la biblioteca del usuario a un paquete. El identificador de paquete se proporciona en la dirección URL, el identificador del documento también debe proporcionarse como "document_id" en la dirección URL del recurso para identificar el documento de biblioteca que se va a copiar. Tenga en cuenta que ya debe existir un paquete para poder agregar un documento mediante esta llamada.
Agregar paquete	Esta API de servicio se usa para agregar o crear un paquete de documentos para contener uno o varios documentos. A continuación, este paquete se puede usar para agregar documentos y destinatarios para iniciar un nuevo flujo de trabajo. Como se indicó anteriormente, esta llamada es obligatoria si desea trabajar con documentos. Debe existir un paquete para poder cargar o agregar documentos a SigningHub.. Incluso un único documento forma parte de un paquete: un paquete que contiene un documento. Nota: Se puede cambiar el nombre de un paquete si es necesario una vez creado.
Agregar usuarios al flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para agregar destinatarios a un flujo de trabajo. Esta llamada solo agregará un destinatario al flujo de trabajo. Es decir, ningún campo del documento se asignará automáticamente a los nuevos destinatarios ni creará ningún campo nuevo. Tenga en cuenta que los destinatarios se agregarán como la última persona del flujo de trabajo. Por lo tanto, es posible que sea necesario seguir trabajando para quitar los destinatarios actuales que ya están presentes en el flujo de trabajo. Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento. Tenga en cuenta que la entrada acepta uno o varios usuarios en una sola llamada. En esta llamada específica, el usuario es una persona física conocida. Sin embargo, las mismas reglas se aplican a grupos y marcadores de posición. En cualquiera de estos casos, el destinatario se convierte en un grupo de usuarios en el que cualquier miembro del grupo puede firmar el documento o un marcador de posición. Este último caso se usa cuando no conoce la identidad del firmante previsto. Nota El orden de firma del flujo de trabajo de SigningHub comienza en "1". Por lo tanto, agregar un usuario al flujo de trabajo sin destinatarios actuales comienza un nuevo recuento de pedidos de firma. El parámetro "signing_order" es obligatorio si el tipo de flujo de trabajo es "personalizado". Importante, el uso de esta llamada API puede afectar al tipo de flujo de trabajo. Si hay destinatarios actuales en un flujo de trabajo secuencial y se agrega uno nuevo con el mismo orden de firma que un destinatario actual, esa parte del flujo de trabajo cambia automáticamente de secuencial a paralela. Por lo tanto, el flujo de trabajo general es ahora de tipo personalizado en lugar de puramente secuencial. Agregar un destinatario con el mismo orden de firma que dos o destinatarios paralelos no cambia el flujo de trabajo. Solo hay tres o más destinatarios en ese punto concreto del flujo de trabajo; todo en orden paralelo. Tenga en cuenta que, aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
Aplicar plantilla de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para aplicar una plantilla de flujo de trabajo a un documento. El identificador de documento en el que se debe aplicar la plantilla se proporciona en la dirección URL del recurso. Cuando el identificador de documento se establece en 0, la plantilla se aplicará a todos los doucments de un pacakge. Al aplicar la plantilla, es importante recordar estos dos puntos importantes: Punto 1: si la plantilla que se aplica se crea con un PDF que ya contiene campos de formulario, asegúrese de que el documento en el que se aplica esta plantilla debe contener estos campos de formulario de antemano y SigningHub NO creará esos campos de formulario a través de la plantilla, sino que solo aplicará los datos del formulario y asígnelos a los usuarios respectivos. Punto 2: Si se crea la plantilla en la que se agregan manualmente campos de formulario (por lo tanto, no están presentes en el PDF originalmente) a través de SigningHub, por ejemplo, campo de firma, inicial, firma en persona, casillas, botones de radio, campos de texto, etc., al aplicar dicha plantilla, estos campos de formulario se crearán en el documento de destino incluso si estos campos de formulario ya estaban presentes en el documento.
Aprobación del documento de Gatekeeper	Las aplicaciones empresariales pueden usar esta API de servicio para que un usuario especificado apruebe un documento en el orden.
Aprobar documento	Las aplicaciones empresariales pueden usar esta API de servicio para aprobar un documento por parte de un usuario especificado en el orden.
Asignar campo de documento	Las aplicaciones empresariales pueden usar esta API de servicio para asignar usuarios a campos de entrada, por ejemplo, campos de firma y, por tanto, definir el orden de firma. Los campos ya deben estar presentes en el documento y los usuarios deben estar presentes en el flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso, junto con el identificador del paquete. Cuando los destinatarios están en un flujo de trabajo, se numeran, empezando por uno y contando para cada uno adicional. Por lo tanto, si hay tres usuarios en un flujo de trabajo, se numeran "1", "2" y "3" respetuosamente. Esta llamada API permite asignar un usuario por su número de pedido de flujo de trabajo a un campo de entrada en el documento.
Cambiar el nombre del paquete	Esta API de servicio se usa para cambiar el nombre de un paquete de documentos. El paquete de documentos se identifica mediante su identificador único en la dirección URL de la llamada.
Cambiar nombre del documento	Las aplicaciones empresariales pueden usar esta API de servicio para cambiar el nombre de un documento de un paquete.
Campos de autoplace	Las aplicaciones empresariales pueden llamar a esta API para agregar campos de formulario definidos por el usuario o firma a un documento en función del criterio de búsqueda proporcionado. Las opciones de selección de ubicación son: a la izquierda, a la derecha, a la parte superior e inferior. El documento es la búsqueda y se procesan todas las instancias de los criterios de búsqueda cumplidos. Esto le permite agregar varios campos con una llamada. Por ejemplo, cargue un documento y coloque automáticamente un campo de firma a la derecha de todas las instancias de la palabra "Firmar aquí:". Esto ahorra tiempo y garantiza que no se pierdan firmas del flujo de trabajo. La llamada API admite todos los tipos de campos; es decir, campo electrónico, digital, en persona, iniciales y de texto, etc. Además, la llamada API admite la variable "order". Esto significa que puede asignar automáticamente un conjunto de campos de firma a un solo usuario. Por lo tanto, la llamada se puede repetir para colocar y asignar campos de firma a más de un usuario del flujo de trabajo. Al menos un usuario debe existir en un flujo de trabajo para que los campos de firma se puedan agregar al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo. Esta llamada API se puede usar varias veces en el mismo documento. La razón para hacerlo es atender a varios firmantes en un documento. El destinatario o firmante se identifica mediante la variable "order" pasada en la llamada. Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios.
Cargar documento	Las aplicaciones empresariales pueden usar esta API de servicio para agregar un documento a un paquete de documentos vinculado a la cuenta de un usuario empresarial. La información del documento se envía en el encabezado de solicitud HTTP y los bytes del documento se envían en el cuerpo de la solicitud HTTP. Nota SigningHub convertirá los formatos de documento admitidos en PDF si el encabezado "x-convert-document" está establecido en un valor de "true". El único caso admitido en el que este valor se establece en "false" es conservar Word formato y documentos XML. SigningHub admite una amplia variedad de formatos de documento, cada uno de los cuales se puede convertir en formato PDF al cargarse. Haga clic aquí para obtener la lista completa. Nota Los documentos PDF no se modifican al cargarlos en el sistema. Tenga en cuenta que ya debe existir un paquete para poder agregar un documento mediante esta llamada.
Compartir paquete de documentos	Las aplicaciones empresariales pueden usar esta API de servicio para compartir un paquete de documentos con los firmantes e iniciar un nuevo flujo de trabajo. El documento ya debe haberse preparado aplicando una plantilla y actualizando opcionalmente los usuarios y las acciones definidas en la plantilla. El identificador de paquete que se va a compartir se proporciona en la dirección URL del recurso.
Descargar datos adjuntos	Las aplicaciones empresariales pueden usar esta API de servicio para descargar los datos adjuntos de un documento.
Descargar documento	Las aplicaciones empresariales pueden usar esta API de servicio para descargar los bytes del documento. El identificador del paquete y el identificador de documento se proporcionan en la dirección URL del recurso.
Descargar paquete	Las aplicaciones empresariales pueden usar esta API de servicio para descargar el paquete de documentos en formato binario. El identificador del paquete se proporciona en la dirección URL del recurso. Si el paquete contiene solo un documento, la descarga es el documento PDF binario. Como alternativa, si el paquete tiene más de un documento, la descarga es el archivo ZIP binario de todos los documentos. Los encabezados x-password y x-otp son opcionales. Son necesarios si el propietario del documento los establece durante la fase de creación del flujo de trabajo.
Documento de rechazo de Gatekeeper	Las aplicaciones empresariales pueden usar esta API de servicio para rechazar un documento por parte de un usuario especificado en el orden.
Documento de recuperación	Las aplicaciones empresariales pueden usar esta API de servicio para detener un flujo de trabajo en curso. El identificador del documento se proporciona en la dirección URL del recurso. Después de recuperar el estado del documento cambia automáticamente a "DRAFT".
Eliminar campo de documento	Las aplicaciones empresariales pueden usar esta API de servicio para eliminar un campo de documento en un paquete.
Eliminar datos adjuntos	Las aplicaciones empresariales pueden usar esta API de servicio para eliminar los datos adjuntos de un documento.
Eliminar documento	Las aplicaciones empresariales pueden usar esta API de servicio para eliminar un documento de un paquete.
Eliminar espacio compartido	Las aplicaciones empresariales pueden usar esta API de servicio para eliminar el espacio compartido. La disponibilidad de eliminar espacios compartidos está sujeta al rol de usuario de empresa asignado. Para permitir esta aprovisionamiento, el administrador de empresa habilitará la opción "Administrar espacio compartido" en Roles Document Settings (Configuración del documento de roles>).
Eliminar paquete	Las aplicaciones empresariales pueden usar esta API de servicio para eliminar un documento de la bandeja de entrada de usuario. El identificador del paquete se proporciona en la dirección URL del recurso como "{package_id}". Si el estado del documento está pendiente, se rechazará automáticamente como resultado de la operación de eliminación. Si el estado del documento es SHARED, el documento se recupera automáticamente y el flujo de trabajo se detiene antes de que se elimine el documento.
Eliminar usuario de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para eliminar el destinatario del flujo de trabajo.
Enviar documento	Uno de los roles de SigningHub se denomina "Editor". Esto permite que un destinatario edite campos de entrada en un documento, pero no requiere una firma. Una vez completado, el destinatario envía sus cambios. El botón usado en la GUI se denomina "Enviar". Esta es la operación equivalente para que un editor envíe sus cambios a través de una llamada API. Haga clic en SigningHub Roles para obtener una descripción de todos los roles de destinatario del flujo de trabajo disponibles.
Estado de firma masiva	Las aplicaciones empresariales pueden usar esta API para obtener el estado de una transacción de firma masiva específica junto con los detalles de los paquetes de documentos procesados por la API de paquetes de firma masiva . Debe llamar a esta API después de la API de paquetes de firma masiva. El firmante se identifica mediante el token de acceso presentado en la llamada. Por lo tanto, se requiere la autenticación del firmante antes de realizar esta llamada. No se puede autenticar como administrador de empresa con la variable de ámbito y firmar un documento en nombre de un usuario. El token de acceso debe emitirse al firmante como resultado de la autenticación directa. Para la firma ras, la propiedad ACTION se REMOTE_AUTHORIZATION_REQURIED y la propiedad STATUS estará PENDIENTE, lo que indica que la solicitud debe estar autorizada mediante el dispositivo móvil. Si se produce un error en el proceso de firma en algún documento debido a distintos niveles de garantía configurados y el usuario quiere volver a iniciar el proceso de firma para completar el proceso de firma en documentos con errores, la propiedad ACTION se REINITIATE_SIGNING_PROCESS y la propiedad STATUS estará pendiente.
Finalizar el procesamiento	Las aplicaciones empresariales pueden usar esta API de servicio para finalizar el procesamiento de documentos después de firmar todos los campos de firma. Este método se usa principalmente en aplicaciones móviles de SigningHub nativas para iOS y Android y casos de uso web móviles. Las aplicaciones empresariales generales que emplean una estrecha integración en su portal respectivo no necesitan llamar a este método. Sin embargo, cuando se usa Sign Document API (y, por lo tanto, el usuario no se presenta una representación visual del documento al que se solicita firmar) se requiere una llamada a esta API para asegurarse de que el flujo de trabajo respectivo continúa o se completa. Por ejemplo, una vez que se hayan aplicado todas las firmas mediante la llamada "blind" Sign Document API, el documento no se mostrará como estado "Completado" al propietario hasta que se invoque esta API. El propietario del documento verá un estado de "En curso" hasta que se llame a esta API. Dentro de las aplicaciones móviles nativas de SigningHub y los casos de uso web móviles, esta llamada es necesaria para asegurarse de que cada usuario complete sus respectivas acciones con respecto a SigningHub.Por ejemplo, después de que un firmante haya firmado un documento en La aplicación SigningHub, la aplicación invoca este método para asegurarse de que el flujo de trabajo continúa procesando y se notifica al siguiente firmante, y el estado del documento está disponible a través de la dirección URL de devolución de llamada configurada.
Firmar documento	Las aplicaciones empresariales pueden usar esta API de servicio para firmar un documento (tanto electrónico como digital) sin mostrar el documento al usuario final mediante SigningHub. Por ejemplo, una aplicación empresarial puede tener otro método para mostrar el documento al usuario, y solo se requiere la funcionalidad de firma de SigningHub o, para las operaciones masivas, puede justificarse firmar sin necesidad de que el usuario vea y apruebe cada documento individualmente. Si hay cambios que se guardarán en el documento antes de la firma, se debe llamar a fill Form Fields API antes de llamar a Sign Document API. Tenga en cuenta que los campos de entrada obligatorios de un documento requieren completarse antes de que esta API se complete correctamente. El firmante se identifica mediante el token de acceso presentado en la llamada. Por lo tanto, se requiere la autenticación del firmante antes de realizar esta llamada. No se puede autenticar como administrador de empresa con la variable de ámbito y firmar un documento en nombre de un usuario. El token de acceso debe emitirse al firmante como resultado de la autenticación directa. Cuando se completa esta llamada, es importante que si el firmante era el último firmante de un documento al que se invoca la llamada a la API Finish Document . El motivo es que, sin llamar a esa API, el documento permanecerá en estado "En curso" al propietario del documento. Una vez que se haya llamado a la API, el estado cambiará a "Completado" para el propietario del documento. Una vez firmado el documento, la respuesta de comprobación se puede ver desde Get Document Verification API. Uso de OTP en primer o segundo factor para la autenticación Si la autenticación de OTP está activada para la operación de firma del lado servidor, las aplicaciones cliente deberán generar un OTP para el número de móvil mediante la autenticación del firmante a través de la llamada API de OTP . Las aplicaciones empresariales respectivas deben recuperar el OTP del uso y enviarlo al realizar la llamada API. Esto se hace mediante el encabezado "x-otp" de la solicitud.
Flujo de trabajo completo en el medio (finalizar flujo de trabajo)	Las aplicaciones empresariales pueden marcar el flujo de trabajo completado incluso en medio del flujo de trabajo. Use esta API de servicio para cambiar el estado del flujo de trabajo a completado. Si hay destinatarios que aún no han firmado el documento. Su firma no será necesaria más y no podrá ver el documento en su bandeja de entrada. El token de portador debe pertenecer al propietario del documento o al administrador de empresa puede usar la variable de ámbito para obtener el token de acceso en nombre del propietario del documento para realizar esta acción.
Iniciales de relleno	Las aplicaciones empresariales pueden usar esta API de servicio para rellenar un campo inicial en un documento por parte de un usuario especificado en el orden.
Mover el paquete a la carpeta Espacio compartido o personalizado	Las aplicaciones empresariales pueden usar esta API de servicio para mover el paquete de documentos a un espacio compartido o a la carpeta personalizada del usuario.
Obtención de la autenticación de usuario de flujo de trabajo (apertura de documentos) del paquete enterprise	Las aplicaciones empresariales pueden usar esta API de servicio para obtener la configuración de seguridad de acceso habilitada para el paquete. Los destinatarios para los que se configura la seguridad se identifican mediante el orden en la dirección URL. El identificador del paquete también se identifica en la dirección URL de la solicitud. Los destinatarios no podrán acceder al paquete de documentos fuera del ámbito de esta duración si la seguridad de acceso está habilitada. El propietario del documento también puede configurar la seguridad basada en autenticación del paquete para un destinatario.
Obtener archivos adjuntos	Las aplicaciones empresariales pueden usar esta API de servicio para obtener los datos adjuntos de un documento.
Obtener campos de documento	Las aplicaciones empresariales pueden usar esta API de servicio para obtener campos de documento, es decir, iniciales, en personas, campos de firma o campos de formulario.
Obtener contactos	Las aplicaciones empresariales pueden usar esta API de servicio para retieve los contactos tanto de contactos personales como empresariales para el usuario actual. Es posible buscar en función del criterio proporcionado bajo el encabezado "x-search-text". Además, es posible buscar contactos específicos de un usuario o el de la empresa a la que pertenece el usuario. La información de respuesta de búsqueda contiene la dirección de correo electrónico del usuario y el nombre de usuario correspondiente.
Obtener detalles del documento	Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles del documento. El identificador del documento se proporciona en la dirección URL como "{document_id}".
Obtener detalles del flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles del flujo de trabajo del paquete.
Obtener detalles del paquete	Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles de un paquete. La aplicación empresarial también puede usar esta API para realizar acciones en nombre del usuario empresarial a través de "Autenticación de ámbito".
Obtener directiva de certificación para un documento	Las aplicaciones empresariales pueden usar esta API de servicio para obtener la configuración de firma de certificación de un documento en un paquete.
Obtener espacio compartido	Las aplicaciones empresariales pueden usar esta API de servicio para obtener un espacio compartido específico. Esta API devuelve información sobre el espacio compartido, su propietario y colaborador.
Obtener historial de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para recuperar la lista de acciones realizadas en un documento. El identificador del paquete se proporciona en la dirección URL del recurso. El campo de búsqueda (encabezado x-search-text) está diseñado para correo electrónico, nombre de documento, acción, infokey e infovalue.
Obtener informe de evidencia del proceso	Las aplicaciones empresariales pueden usar esta API de servicio para descargar el informe de evidencia del proceso de flujo de trabajo de un documento.
Obtener paquetes	Las aplicaciones empresariales pueden usar esta API de servicio para obtener una lista de documentos filtrados por diferentes estados. Los usuarios pueden dividir los registros en páginas proporcionando una serie de registros por página.
Obtener permisos de usuario de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para obtener permisos de documento para un destinatario. El destinatario se identifica mediante el orden del flujo de trabajo. El identificador del paquete se proporciona en la dirección URL del recurso.
Obtener plantillas	Las aplicaciones empresariales pueden usar esta API de servicio para obtener una lista de plantillas para el usuario actual. Es posible buscar en función del criterio proporcionado bajo el encabezado "x-search-text". Además, es posible buscar en las plantillas personales de un usuario o en las plantillas empresariales, según lo permitido en su rol de usuario por su administrador de empresa.
Obtener plantillas empresariales	Las aplicaciones empresariales pueden usar esta API de servicio para obtener la lista de plantillas empresariales del usuario actual. Esto significa que el administrador de empresa o el usuario de empresa si se usó la variable "ámbito" en la solicitud de autenticación. Es posible buscar en función del criterio proporcionado bajo el encabezado "x-search-text".
Obtener recordatorio de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los recordatorios de los destinatarios que ya se han agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de que se haya aplicado una plantilla a un documento y las aplicaciones empresariales quieran invalidar la configuración de recordatorios dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el destinatario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo.
Obtener usuarios de flujo de trabajo	Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles del flujo de trabajo del paquete.
Paquetes de firma masiva	Las aplicaciones empresariales pueden usar esta API para firmar, compartir o firmar y compartir varios documentos (tanto electrónicos como digitales) sin mostrar los documentos al usuario final. Esta API necesita información de la aplicación empresarial sobre los paquetes de documentos y los detalles de las firmas, los campos en persona e iniciales. Cuando se complete correctamente la transacción de firma masiva, la API devolverá los estados y los identificadores de transacción de los paquetes de documentos. A diferencia de Sign Document API, esta API no solo firma un paquete de documentos, sino que también la marca como aprobada y revisada en función de si el destinatario es un firmante, editor o revisor. Cualquier paquete de documento para el que el estado devuelva como COMPLETADO se ha firmado, aprobado o revisado por esta API. La firma masiva funciona con todos los métodos de autenticación en tiempo de firma. Si SIGN se pasa como bulk_action y el paquete está en estado Borrador, firmar y compartir se realizará automáticamente. Debe llamar a esta API después de la API Pre Bulk Sign Documents . En caso de que tenga que realizar cambios en cualquiera de los documentos antes de firmarlo, se debe llamar a la API Fill Form Fields antes de llamar a la API Pre Bulk Sign Document. Recuerde que los campos de entrada obligatorios de un documento requieren completarse antes de que esta API se complete correctamente; mientras que los campos rellenados automáticamente (como Nombre, Correo electrónico, Fecha, Título del trabajo, etc.) se rellenarán automáticamente. El firmante se identifica mediante el token de acceso presentado en la llamada. Por lo tanto, se requiere la autenticación del firmante antes de realizar esta llamada. No se puede autenticar como administrador de empresa con la variable de ámbito y firmar un documento en nombre de un usuario. El token de acceso debe emitirse al firmante como resultado de la autenticación directa. Una vez firmado el documento, la respuesta de comprobación se puede ver desde la API de estado de firma masiva . Uso de OTP en primer o segundo factor para la autenticación En caso de que la autenticación de OTP esté activada para la operación de firma del lado servidor, las aplicaciones cliente deberán generar un OTP para el número de móvil mediante la autenticación de firma masiva a través de la llamada API de OTP. Las aplicaciones empresariales respectivas deben recuperar el OTP del uso y enviarlo al realizar la llamada API. Esto se hace mediante el encabezado "x-otp" de la solicitud.
Rechazar documento	Las aplicaciones empresariales pueden usar esta API de servicio para rechazar un documento por parte de un usuario especificado en el orden.
Rellenar campos de formulario	Las aplicaciones empresariales pueden usar esta API de servicio para rellenar uno o varios campos de formulario en un documento por parte de un usuario especificado en el orden.

Actualización posterior al procesamiento

Id. de la operación:: V4_Workflow_UpdateWorkflowPostProcess

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un marcador de posición a un flujo de trabajo de un documento en un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. del paquete de documento para el que se está actualizando el procesamiento posterior.
enabled	enabled	True	boolean	True, si el procesamiento posterior está activado para el paquete.
contacts	contacts		array of string
nombre	name	True	string
email	email	True	string
message	message		string	Mensaje de cadena personalizado para todos los contactos. El mensaje forma parte del correo electrónico enviado a los contactos.
google_drive	google_drive		boolean	True, si el documento se va a cargar en la cuenta de Google proporcionada después de la finalización del flujo de trabajo.
dropbox	dropbox		boolean	True, si el documento se va a cargar en la cuenta de Dropbox proporcionada después de la finalización del flujo de trabajo.
onedrive	onedrive		boolean	True, si el documento se va a cargar en la cuenta de OneDrive proporcionada después de la finalización del flujo de trabajo.
workflow_recipients	workflow_recipients	True	boolean	True, si el informe de finalización del flujo de trabajo se va a enviar a todos los destinatarios del flujo de trabajo cuando se ejecuta el procesamiento posterior. El valor predeterminado es Falso.
document_processing_report	document_processing_report	True	boolean	True, si enviar el informe de procesamiento de documentos (XML) se habilitará para el flujo de trabajo.

Devoluciones

response: object

Actualizar autenticación de usuario de flujo de trabajo (apertura de documentos) del paquete enterprise

Id. de la operación:: V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar las autenticaciones del paquete y la duración del acceso para los destinatarios. El administrador de empresa o el usuario de empresa también pueden usar esta API si se usó la variable "ámbito" en la solicitud de autenticación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se va a actualizar la seguridad y la autenticación de acceso de flujo de trabajo.
Orden del destinatario	order	True	integer	Orden del destinatario en el flujo de trabajo para el que se actualizará la seguridad de acceso y la autenticación.
apply_to_all	apply_to_all	True	boolean	True, si la seguridad de acceso o las autenticaciones se van a aplicar en todos los destinatarios del flujo de trabajo.
autenticación	authentication	True		Tiene los datos de acceso aauthentication
authentication_signing	authentication_signing			Tiene los datos de autenticación de firma
access_duration	access_duration	True		Tiene la duración del acceso del flujo de trabajo.

Devoluciones

response: object

Actualizar campo CheckBox

Id. de la operación:: V4_Checkbox_UpdateCheckBox

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo de casilla de un documento en un paquete.

Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios. Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI.

No se puede actualizar el ancho y el alto. Seguirán siendo los mismos que cuando se agregaron.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre actual del campo, que se va a actualizar.
renamed_as	renamed_as		string	Se ha actualizado el nombre del campo si se pretende cambiar el nombre.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
valor	value		string	Valor del campo. Los valores posibles son "true" o "false"
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
validation_rule	validation_rule		string	Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Actualizar campo de firma digital

Id. de la operación:: V4_Signature_UpdateSignature

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo de firma digital de un documento en un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre actual del campo, que se va a actualizar.
level_of_assurance	level_of_assurance		array of string	Nivel de garantía que se va a actualizar. Los valores posibles son "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
renamed_as	renamed_as		string	Se ha actualizado el nombre del campo si se pretende cambiar el nombre del campo.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
Monitor	display		string	Visibilidad del campo que se va a actualizar, los valores posibles son "VISIBLE" e "INVISIBLE"
authentication_signing	authentication_signing			Autenticación de campos
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Actualizar campo en persona

Id. de la operación:: V4_InPerson_UpdateInPerson

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo de firma en persona de un documento en un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre actual del campo, que se va a actualizar.
renamed_as	renamed_as		string	se ha actualizado el nombre del campo, si se pretende cambiar el nombre.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
marcador de posición	placeholder		string	Identificador de cadena para el campo en persona, puede ser Customer, Jack, CEO, etc.
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
Monitor	display		string	Visibilidad del campo que se va a actualizar, los valores posibles son "VISIBLE" e "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Nivel de garantía que se va a actualizar. Los valores posibles son "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
authentication_signing	authentication_signing			Autenticación de campos
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Actualizar campo inicial

Id. de la operación:: V4_Initials_UpdateInitial

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un campo inicial de un documento en un paquete.

Tenga en cuenta que se pueden cambiar todos los parámetros de entrada. Si desea conservar la configuración actual, envíela en la llamada sin cambios.

Por lo tanto, puede usar los mismos parámetros que al agregar el campo de entrada o la información devuelta por Obtener campos de documento. Este último se puede usar cuando se aplicó una plantilla o se creó el documento mediante la interfaz GUI.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre actual del campo, que se va a actualizar.
renamed_as	renamed_as		string	Se ha actualizado el nombre del campo si se pretende cambiar el nombre.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.

Devoluciones

response: object

Actualizar campo RadioBox

Id. de la operación:: V4_Radio_UpdateRadioBox

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un botón de radio de un documento en un paquete.

No se puede actualizar el ancho y el alto. Seguirán siendo los mismos que cuando se agregaron.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre actual del campo, que se va a actualizar.
renamed_as	renamed_as		string	Se ha actualizado el nombre del campo si se pretende cambiar el nombre.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
valor	value		string	Valor del campo. Los valores posibles son "true" o "false"
validation_rule	validation_rule	True		Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
radio_group_name	radio_group_name	True	string	Nombre de grupo al que pertenece el campo.
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.

Devoluciones

response: object

Actualizar campo TextBox

Id. de la operación:: V4_TextBox_UpdateTextBox

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un cuadro de texto de un documento en un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre actual del campo, que se va a actualizar.
field_locale	field_locale		string	Campo local. Los valores posibles son ar-AE \| en-US. Opcional y el valor predeterminado serán en-US. Este valor es importante para el tipo "DATE".
renamed_as	renamed_as		string	Se ha actualizado el nombre del campo si se pretende cambiar el nombre.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
valor	value		string	Valor del campo. Para type = DATE, se espera que el valor siga el formato ISO 8601. Siguiendo el formato AAAA-MM-DD hh:mm:ss +00. Como los valores son para los campos de fecha, las aplicaciones cliente pueden enviar aaaa-MM-DD e ignorar hh:mm:ss +00. Si el valor no tiene el formato adecuado, se devolverá un error.
longitud_máxima	max_length	True	integer	Longitud máxima del valor permitido en el campo. Debe estar comprendido entre 1 y 9999
field_type	field_type	True		Tipo de campo con respecto a la aceptación del tipo de valores, los valores posibles son "NUMBER" o "TEXT".
validation_rule	validation_rule	True		Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
font	font			Fuente del texto de los campos
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
marcador de posición	placeholder		string	Los desarrolladores pueden proporcionar sus propios textos de marcador de posición. Estos marcadores de posición aparecen en los campos de texto mientras ven el documento en el visor.
format	format		string	Formato de texto del campo. Solo se usa para el campo de tipo de fecha. Los valores posibles son: m/d m/d/yy m/d/aaaa mm/dd/aaaa dd/mm/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-aaaa d-mmm-aaaa dd-mmm-aaaa dd-mmm-aaaa yy-mm-dd aaaa-mm-dd mmm-aaaa mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyy
validación	validation			Validations

Devoluciones

response: object

Actualizar código QR

Id. de la operación:: V4_QR_UpdateQRCode

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un código QR de un documento en un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre actual del campo, que se va a actualizar.
renamed_as	renamed_as		string	Se ha actualizado el nombre del campo si se pretende cambiar el nombre.
page_no	page_no	True	integer	Número de página para el que es necesario actualizar el campo
dimensions	dimensions	True		Dimensiones de campo
datos	data		string	Los datos de texto sin formato que se van a codificar en el código QR. El valor predeterminado es la dirección URL generada para acceder al documento relacionado. Por ejemplo, {base_url}/document/{document_unique_id}
options	options			Configuración con respecto a las opciones
color	color			Configuración con respecto al color
logotipo	logo			Configuración con respecto al logotipo

Devoluciones

Body: UpdateQrCodeResponse

Actualizar datos adjuntos

Id. de la operación:: V4_Attachment_UploadAttachment

Las aplicaciones empresariales pueden usar esta API de servicio para cargar datos adjuntos en un documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento al que se deben agregar los datos adjuntos.
Contenido del archivo adjunto	body	True	binary	Este es el documento en formato binario sin formato.
Nombre del campo	x-field-name		string	Nombre del campo si es necesario. Esto es opcional y con el campo de datos adjuntos de nombre de campo se procesa. Además, el valor recomendado para el parámetro de nombre de campo está en formato codificado en Base64.
Nombre del archivo	x-file-name	True	string	Es el nombre del archivo con la extensión .
Contraseña del documento	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
contraseña de One-Time	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

Body: AddAttachmentResponse

Actualizar detalles del flujo de trabajo

Id. de la operación:: V4_Workflow_UpdateWorkflow

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los detalles del flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento, pero las aplicaciones empresariales quieren invalidar los detalles del permiso de certificación o posterior al procesamiento. El identificador del paquete se proporciona en la dirección URL del recurso.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se deben actualizar los detalles del flujo de trabajo.
workflow_type	workflow_type			Tipo de flujo de trabajo para el paquete, por ejemplo (SERIAL,PARALLEL,INDIVIDUAL,CUSTOM). Si no se proporciona ningún valor, se conservará el valor anterior.
workflow_mode	workflow_mode			Modo de flujo de trabajo del paquete, por ejemplo (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). Si el modo de flujo de trabajo está establecido en ONLY_ME, no se puede agregar ningún colaborador al paquete de otro usuario autenticado.
continue_on_decline	continue_on_decline		boolean	True, si el flujo de trabajo debe continuar incluso si algún destinatario rechaza el documento. Si no se proporciona ningún valor, se conservará el valor anterior.
message	message		string	Un mensaje de cadena personalizado del propietario del documento a cada destinatario, este mensaje aparece en el correo electrónico para compartir, así como en la pantalla. Si no se proporciona ningún valor, se conservará el valor anterior.
comments	comments		boolean	Permitir comentarios

Devoluciones

response: object

Actualizar directiva de Certify para un documento

Id. de la operación:: V4_Documents_UpdateCertifyPolicy

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar la configuración de firma de certificación de un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento en el que se va a realizar la acción.
certifique	certify			Certifique el objeto de configuración del documento.
lock_form_fields	lock_form_fields	True	boolean	True si los campos de formulario se van a bloquear después de la última firma del documento actual.

Devoluciones

response: object

Actualizar el orden de los usuarios del flujo de trabajo

Id. de la operación:: V4_Workflow_WorkflowUserUpdateOrder

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar el orden del destinatario en el flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete al que se van a agregar los destinatarios.
Pedido	order	True	integer	Orden existente del destinatario que se va a actualizar.
order	order	True	integer	Orden del destinatario que se va a actualizar.

Devoluciones

response: object

Actualizar espacio compartido

Id. de la operación:: V4_WorkSpace_UpdateSharedSpace

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar el espacio compartido. La disponibilidad de actualizar espacios compartidos está sujeta al rol de usuario de empresa asignado. Para permitir esta aprovisionamiento, el administrador de empresa habilitará la opción "Administrar espacio compartido" en Roles Document Settings (Configuración del documento de roles>).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de espacio compartido	id	True	integer	Identificador del espacio compartido que desea actualizar
nombre	name		string	Nombre del espacio compartido
nombre	name	True	string	Nombre del miembro del espacio de trabajo
email	email	True	string	Dirección de correo electrónico del miembro del espacio de trabajo

Devoluciones

response: object

Actualizar marcador de posición

Id. de la operación:: V4_Workflow_WorkflowUpdatePlaceholder

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar un marcador de posición en el flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento y las aplicaciones empresariales quieren invalidar los detalles de un marcador de posición específico dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el titular del lugar del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo. Aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete para el que se va a agregar el marcador de posición.
Pedido	order	True	integer	Orden del destinatario en el flujo de trabajo.
marcador de posición	placeholder		string	Nombre del nuevo marcador de posición que se va a agregar en el flujo de trabajo. Si no se proporciona ningún valor, se conservará el valor anterior.
email_notification	email_notification		boolean	Al establecer su valor en "true", se envía una notificación por correo electrónico al usuario cuando llega su turno al flujo de trabajo. Al establecer su valor en "false" no se envía la notificación por correo electrónico al usuario en su turno. Si no se proporciona ningún valor, se conservará el valor anterior.
role	role	True		Rol del grupo como destinatario en el flujo de trabajo. El valor posible es "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" y "INPERSON_HOST". Si no se proporciona ningún valor, se conservará el valor anterior. Sin embargo, aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
signing_order	signing_order		integer	Orden en el que los destinatarios firmarán el flujo de trabajo. Este orden de firma es importante cuando el tipo de flujo de trabajo se establece en "CUSTOM".

Devoluciones

response: object

Actualizar permisos de usuario de flujo de trabajo

Id. de la operación:: V4_WorkflowPermission_UpdateWorkflowPermissions

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los permisos de flujo de trabajo de un usuario que ya se ha agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento y las aplicaciones empresariales quieren invalidar los permisos dentro del flujo de trabajo. El identificador del paquete de documento se proporciona en la dirección URL del recurso y el usuario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se van a actualizar los permisos de flujo de trabajo.
Pedido	order	True	integer	Orden del destinatario para el que se van a actualizar los permisos de flujo de trabajo.
apply_to_all	apply_to_all	True	boolean	True, si los permisos se van a aplicar en todos los destinatarios del flujo de trabajo.
permissions	permissions	True		Tiene todos los permisos que se van a permitir en el flujo de trabajo.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Actualizar recordatorios de flujo de trabajo

Id. de la operación:: V4_Workflow_UpdateWorkflowReminder

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los recordatorios de flujo de trabajo de un destinatario que ya se ha agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de que se haya aplicado una plantilla a un documento y las aplicaciones empresariales quieran invalidar la configuración de recordatorios dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el destinatario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se actualizarán los recordatorios de flujo de trabajo.
Pedido	order	True	integer	El orden del usuario para el que se van a actualizar los recordatorios del flujo de trabajo.
apply_to_all	apply_to_all	True	boolean	True, si se va a aplicar la configuración de recordatorio en todos los destinatarios del flujo de trabajo.
enabled	enabled	True	boolean	True, si se va a habilitar la configuración del aviso.
frecuencia	frequency		string	Frecuencia de recordatorio. Los valores posibles son DAYS \| HORAS.
remind_after	remind_after	True	integer	Obligatorio, en caso de que la propiedad habilitada sea true. Número de días después del cual se enviaría el primer aviso al usuario de flujo de trabajo.
repetir	repeat			Los avisos se enviarían repetidamente al usuario.

Devoluciones

response: object

Actualizar usuario de flujo de trabajo

Id. de la operación:: V4_Workflow_WorkflowUserUpdate

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los detalles de un destinatario, grupo o marcador de posición que ya se ha agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de aplicar una plantilla a un documento y las aplicaciones empresariales quieren invalidar los detalles de un usuario específico dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el destinatario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo. Tenga en cuenta que, mientras que la preparación del documento de tipo XML, solo admite los tipos de rol "SIGNER", "REVIEWER" y "CARBON_COPY".

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se debe actualizar el usuario de flujo de trabajo.
Pedido	order	True	integer	Orden del usuario en el flujo de trabajo.
user_email	user_email		string	Dirección de correo electrónico del nuevo usuario que se va a actualizar en el flujo de trabajo. Si no se proporciona ningún valor, se conservará el valor anterior.
nombre_de_usuario	user_name		string	Nombre del destinatario que se va a actualizar. Si no se proporciona ningún valor, se conservará el valor anterior.
email_notification	email_notification		boolean	Al establecer su valor en "true", se envía una notificación por correo electrónico al usuario cuando llega su turno al flujo de trabajo. Al establecer su valor en "false" no se envía la notificación por correo electrónico al usuario en su turno. Si no se proporciona ningún valor, se conservará el valor anterior.
mobile_number	mobile_number		string	Número de móvil. Si no se proporciona ningún valor, se conservará el valor anterior.
role	role	True		Rol del destinatario que se va a actualizar. Los valores posibles son "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" o "INPERSON_HOST". Si no se proporciona ningún valor, se conservará el valor anterior. Sin embargo, aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
signing_order	signing_order		integer	Orden en el que los destinatarios firmarán el flujo de trabajo. Este orden de firma es importante cuando el tipo de flujo de trabajo se establece en "CUSTOM".
email_language_code	email_language_code		string	código de idioma de correo electrónico
delivery_method	delivery_method	True		Método de entrega del destinatario en el flujo de trabajo. Los valores posibles son "EMAIL", "SMS" o "EMAIL_AND_SMS". El valor predeterminado sería EMAIL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

Body: UpdateCollaboratorResponse

Agregar campo CheckBox

Id. de la operación:: V4_Checkbox_AddCheckBox

Las aplicaciones empresariales pueden usar esta API de servicio para agregar una casilla a un documento de un paquete.

Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo.

Consulte Agregar usuarios al flujo de trabajo para obtener más información. Tenga en cuenta que si tiene un documento con una plantilla aplicada o ha aplicado uno mediante las API, el flujo de trabajo ya contendrá usuarios.

Si no se proporcionan parámetros de ancho y alto, se asignará un tamaño predeterminado de 10x10. Si se proporciona ancho o alto (o ambos), el sistema comparará estos valores proporcionados entre sí. El valor mayor entre ancho y alto se asignará a ambas dimensiones.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
order	order	True	integer	Orden del usuario en el flujo de trabajo para el que se va a agregar el campo.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
field_name	field_name		string	Nombre del campo proporcionado que se va a agregar. Si no se proporciona, el sistema asignará un nombre único generado automáticamente al campo.
valor	value		string	Valor del campo. Los valores posibles son "true" o "false"
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
validation_rule	validation_rule		string	Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".

Devoluciones

Body: AddFieldResponse

Agregar campo de firma digital

Id. de la operación:: V4_Signature_AddSignature

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un campo de firma digital a un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se deben actualizar los detalles del flujo de trabajo.
Id. de documento	documentId	True	integer	Identificador de documento donde se va a agregar el campo.
order	order	True	integer	Orden del destinatario para el que se va a crear el campo.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
field_name	field_name		string	Nombre del campo que se va a agregar. Si no se proporciona, el sistema asignará un nombre único generado automáticamente al campo.
level_of_assurance	level_of_assurance		array of string	Nivel de garantía que se va a agregar. Los valores posibles son "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
Monitor	display		string	Visibilidad del campo que se va a agregar, los valores posibles son "VISIBLE" y "INVISIBLE"
authentication_signing	authentication_signing			Autenticación de campos

Devoluciones

Body: SignatureFieldResponse

Agregar campo en persona

Id. de la operación:: V4_InPerson_AddInPerson

Las aplicaciones empresariales pueden usar esta API de servicio para un campo de firma de persona de complemento en un documento de un paquete.

Para hospedar una reunión en persona, un usuario de SigningHub debe formar parte del flujo de trabajo. Deben agregarse con el rol "INPERSON_HOST" o "SIGNER". Para la opción host no requieren un campo de firma o entrada en el documento, y el campo de firma en persona puede estar firmado por el usuario registrado que no es SigningHub.

Tenga en cuenta que se trata de un escenario de flujo de trabajo especial en el que se espera que el usuario y el destinatario de SigningHub estén en la misma ubicación. Este tipo de firma no está pensado para su uso mediante el cual un documento se comparte con destinatarios a través del vínculo de correo electrónico en el método de integración flexible normal.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
order	order	True	integer	Orden del usuario en el flujo de trabajo para el que se va a agregar el campo.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
field_name	field_name		string	Nombre del campo que se va a agregar. Si no se proporciona, el sistema asignará un nombre único generado automáticamente al campo.
marcador de posición	placeholder	True	string	Identificador de cadena para el campo inperson, puede ser Customer, Jack, CEO, etc.
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
Monitor	display		string	Visibilidad del campo que se va a agregar, los valores posibles son "VISIBLE" y "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Nivel de garantía que se va a actualizar. Los valores posibles son "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
authentication_signing	authentication_signing			Autenticación de campos

Devoluciones

Body: AddFieldResponse

Agregar campo inicial

Id. de la operación:: V4_Initials_AddInitial

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un campo inicial a un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
order	order	True	integer	Orden del usuario en el flujo de trabajo para el que se va a agregar el campo.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
field_name	field_name		string	Nombre del campo que se va a agregar. Si no se proporciona, el sistema asignará un nombre único generado automáticamente al campo.
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.

Devoluciones

Body: AddFieldResponse

Agregar campo RadioBox

Id. de la operación:: V4_Radio_AddRadioBox

Las aplicaciones empresariales pueden usar esta API de servicio para agregar una casilla a un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
order	order	True	integer	Orden del usuario en el flujo de trabajo para el que se va a agregar el campo.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
field_name	field_name		string	Nombre del campo proporcionado que se va a agregar. Si no se proporciona, el sistema asignará un nombre único generado automáticamente al campo.
valor	value		string	Valor del campo. Los valores posibles son "true" o "false"
validation_rule	validation_rule	True		Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
radio_group_name	radio_group_name	True	string
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.

Devoluciones

Body: AddFieldResponse

Agregar campo TextBox

Id. de la operación:: V4_TextBox_AddTextBox

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un campo de entrada de texto a un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
order	order	True	integer	Orden del usuario en el flujo de trabajo para el que se va a agregar el campo.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
type	type	True		Tipo del campo, los valores posibles son "TEXT", "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Todos los campos de texto que no sean texto se rellenan automáticamente en modo pendiente con los atributos o datos del destinatario.
valor	value		string	Valor del campo. Para type = DATE, se espera que el valor siga el formato ISO 8601. Siguiendo el formato AAAA-MM-DD hh:mm:ss +00. Como los valores son para los campos de fecha, las aplicaciones cliente pueden enviar aaaa-MM-DD e ignorar hh:mm:ss +00. Si el valor no tiene el formato adecuado, se devolverá un error.
marcador de posición	placeholder		string	Texto del marcador de posición para el campo de texto. Para nombre, correo electrónico, empresa, puesto y fecha, el valor del marcador de posición puede ser "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Los desarrolladores pueden enviar sus propios marcadores de posición para sobrescribir los valores predeterminados. Para los desarrolladores de "TEXT" pueden proporcionar sus propios textos de marcador de posición. Estos marcadores de posición aparecen en los campos de texto mientras ven el documento en el visor.
longitud_máxima	max_length	True	integer	Longitud máxima del valor permitido en el campo. Debe estar comprendido entre 1 y 9999
format	format		string	Formato de texto del campo. Solo se usa para el campo de tipo de fecha. Los valores posibles son: m/d m/d/yy m/d/aaaa mm/dd/aaaa dd/mm/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-aaaa d-mmm-aaaa dd-mmm-aaaa dd-mmm-aaaa yy-mm-dd aaaa-mm-dd mmm-aaaa mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyy
field_name	field_name		string	Nombre del campo que se va a agregar. Si no se proporciona, el sistema asignará un nombre único generado automáticamente al campo.
field_locale	field_locale		string	Campo local. Los valores posibles son ar-AE \| en-US. Opcional y el valor predeterminado serán en-US. Este valor es importante para el tipo "DATE".
field_type	field_type	True		Tipo de campo con respecto a la aceptación del tipo de valores, los valores posibles son "NUMBER" o "TEXT".
validation_rule	validation_rule	True		Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
validación	validation			Validations
font	font	True		Fuente del texto de los campos
x	x	True	double	Ubicación izquierda del campo en píxel.
y	y	True	double	Ubicación superior del campo en píxel.
Ancho	width	True	double	Ancho del campo en píxel.
altura	height	True	double	Alto del campo en píxel.
multilínea	multiline	True	boolean	Si se establece en true, se creará un campo de área de texto.

Devoluciones

Body: AddFieldResponse

Agregar código QR

Id. de la operación:: V4_QR_AddQRCode

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un código QR a un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
page_no	page_no	True	integer	Número de página en el que se va a crear el campo.
field_name	field_name		string	Nombre del campo proporcionado que se va a agregar. Si no se proporciona, el sistema asignará un nombre único generado automáticamente al campo.
dimensions	dimensions	True		Dimensiones de campo
datos	data		string	Los datos de texto sin formato que se van a codificar en el código QR. El valor predeterminado es la dirección URL generada para acceder al documento relacionado. Por ejemplo, {base_url}/document/{document_unique_id}
options	options			Configuración con respecto a las opciones
color	color			Configuración con respecto al color
logotipo	logo			Configuración con respecto al logotipo

Devoluciones

Body: AddQrCodeResponse

Agregar grupos al flujo de trabajo

Id. de la operación:: V4_Workflow_WorkflowAddGroup

Las aplicaciones empresariales pueden usar esta API de servicio para agregar grupos como destinatario a un flujo de trabajo. Un grupo signingHub significa que cualquier miembro del grupo puede realizar la acción, es decir, iniciar sesión en nombre de todos los miembros del grupo.

Tenga en cuenta que el grupo se agregará como último usuario o grupo en el flujo de trabajo. Por lo tanto, es posible que sea necesario seguir trabajando para quitar un usuario o grupo actual, ya presente en el flujo de trabajo. Aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete para el que se va a agregar el grupo.
group_name	group_name		string	Nombre del nuevo grupo que se va a agregar en el flujo de trabajo.
email_notification	email_notification	True	boolean	Al establecer su valor en "true", se envía una notificación por correo electrónico al usuario cuando llega su turno al flujo de trabajo. Al establecer su valor en "false" no se envía la notificación por correo electrónico al usuario en su turno. Si no se proporciona ningún valor, se establecerá el valor predeterminado de "true".
role	role	True		Rol del grupo como destinatario en el flujo de trabajo. El valor posible es "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" y "INPERSON_HOST". Sin embargo, aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
signing_order	signing_order		integer	Orden en el que los destinatarios firmarán el flujo de trabajo. Este orden de firma es importante cuando el tipo de flujo de trabajo se establece en "CUSTOM".

Devoluciones

response: array of CollaboratorGroupResponse

Agregar marcador de posición al flujo de trabajo

Id. de la operación:: V4_Workflow_WorkflowAddPlaceholder

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un marcador de posición a un flujo de trabajo de un paquete. Se requiere un marcador de posición cuando no conoce la identidad del destinatario previsto en un flujo de trabajo.

Tenga en cuenta que el marcador de posición se agregará como último usuario del flujo de trabajo. Por lo tanto, es posible que sea necesario seguir trabajando para quitar un usuario o grupo actual, ya presente en el flujo de trabajo.

Agregar un marcador de posición le permite continuar y agregar campos de firma o entrada al documento, que luego se pueden asignar a usuarios individuales en una fase posterior. Aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete para el que se va a agregar el marcador de posición.
marcador de posición	placeholder		string	Nombre del nuevo marcador de posición que se va a agregar en el flujo de trabajo.
email_notification	email_notification	True	boolean	Al establecer su valor en "true", se envía una notificación por correo electrónico al usuario cuando llega su turno al flujo de trabajo. Al establecer su valor en "false" no se envía la notificación por correo electrónico al usuario en su turno.
role	role	True		Rol del grupo como destinatario en el flujo de trabajo. El valor posible es "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" y "INPERSON_HOST". Sin embargo, aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
signing_order	signing_order		integer	Orden en el que los destinatarios firmarán el flujo de trabajo. Este orden de firma es importante cuando el tipo de flujo de trabajo se establece en "CUSTOM".

Devoluciones

response: array of CollaboratorPlaceholderResponse

Agregar o actualizar documento desde la biblioteca

Id. de la operación:: V4_Documents_UploadFromLibrary

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un documento de la biblioteca del usuario a un paquete. El identificador de paquete se proporciona en la dirección URL, el identificador del documento también debe proporcionarse como "document_id" en la dirección URL del recurso para identificar el documento de biblioteca que se va a copiar.

Tenga en cuenta que ya debe existir un paquete para poder agregar un documento mediante esta llamada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete del paquete al que se va a agregar el documento.
Id. de documento	documentId	True	integer	Identificador del documento de biblioteca que necesita agregar o actualizar
Id. de documento antiguo	x-document-id		string	Identificador del documento antiguo del paquete actual que se debe actualizar

Devoluciones

Body: UploadDocumentLibraryResponse

Agregar paquete

Id. de la operación:: V4_Package_AddPackage

Esta API de servicio se usa para agregar o crear un paquete de documentos para contener uno o varios documentos. A continuación, este paquete se puede usar para agregar documentos y destinatarios para iniciar un nuevo flujo de trabajo.

Como se indicó anteriormente, esta llamada es obligatoria si desea trabajar con documentos. Debe existir un paquete para poder cargar o agregar documentos a SigningHub..

Incluso un único documento forma parte de un paquete: un paquete que contiene un documento.

Nota: Se puede cambiar el nombre de un paquete si es necesario una vez creado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
package_name	package_name		string	Nombre del paquete. El nombre del paquete predeterminado siempre es "Sin título" si no se proporciona el package_name.
workflow_mode	workflow_mode	True		Modo del flujo de trabajo, hay tres tipos de modos de flujo de trabajo admitidos en la aplicación. Los valores posibles son "ONLY_ME", "ME_AND_OTHERS" y "ONLY_OTHERS"
folder_name	folder_name		string	Nombre de la carpeta. Se usará para cargar el paquete en cualquier carpeta del usuario, ya sea una carpeta personalizada o una carpeta compartida.

Devoluciones

Body: AddPackageResponse

Agregar usuarios al flujo de trabajo

Id. de la operación:: V4_Workflow_WorkflowAddUser

Las aplicaciones empresariales pueden usar esta API de servicio para agregar destinatarios a un flujo de trabajo. Esta llamada solo agregará un destinatario al flujo de trabajo. Es decir, ningún campo del documento se asignará automáticamente a los nuevos destinatarios ni creará ningún campo nuevo.

Tenga en cuenta que los destinatarios se agregarán como la última persona del flujo de trabajo. Por lo tanto, es posible que sea necesario seguir trabajando para quitar los destinatarios actuales que ya están presentes en el flujo de trabajo.

Al menos un usuario debe existir en un flujo de trabajo antes de que se puedan agregar campos (entrada y firma) al documento.

Tenga en cuenta que la entrada acepta uno o varios usuarios en una sola llamada.

En esta llamada específica, el usuario es una persona física conocida. Sin embargo, las mismas reglas se aplican a grupos y marcadores de posición. En cualquiera de estos casos, el destinatario se convierte en un grupo de usuarios en el que cualquier miembro del grupo puede firmar el documento o un marcador de posición. Este último caso se usa cuando no conoce la identidad del firmante previsto.

Nota El orden de firma del flujo de trabajo de SigningHub comienza en "1". Por lo tanto, agregar un usuario al flujo de trabajo sin destinatarios actuales comienza un nuevo recuento de pedidos de firma. El parámetro "signing_order" es obligatorio si el tipo de flujo de trabajo es "personalizado".

Importante, el uso de esta llamada API puede afectar al tipo de flujo de trabajo. Si hay destinatarios actuales en un flujo de trabajo secuencial y se agrega uno nuevo con el mismo orden de firma que un destinatario actual, esa parte del flujo de trabajo cambia automáticamente de secuencial a paralela. Por lo tanto, el flujo de trabajo general es ahora de tipo personalizado en lugar de puramente secuencial. Agregar un destinatario con el mismo orden de firma que dos o destinatarios paralelos no cambia el flujo de trabajo. Solo hay tres o más destinatarios en ese punto concreto del flujo de trabajo; todo en orden paralelo.

Tenga en cuenta que, aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete de SigningHub al que se van a agregar los destinatarios.
user_email	user_email		string	Dirección de correo electrónico del usuario que se va a agregar en el flujo de trabajo.
nombre_de_usuario	user_name	True	string	Nombre del destinatario que se va a agregar en el flujo de trabajo.
user_national_id	user_national_id		string	Identificador nacional del usuario del destinatario
email_notification	email_notification	True	boolean	Si se establece como true, SigningHub enviará notificaciones al usuario por correo electrónico según la configuración de notificación de usuario y propietario del documento. Un valor false significa que no se enviará ninguna notificación al usuario a lo largo del flujo de trabajo.
role	role	True		Rol del destinatario en el flujo de trabajo. Los valores posibles son "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" o "INPERSON_HOST". Sin embargo, aunque la preparación del documento de tipo XML, solo los tipos de rol admitidos son "SIGNER", "REVIEWER" y "CARBON_COPY"
signing_order	signing_order		integer	Orden del destinatario en el flujo de trabajo. Este orden de firma es obligatorio cuando el tipo de flujo de trabajo es "CUSTOM".
delivery_method	delivery_method	True		Método de entrega del destinatario en el flujo de trabajo. Los valores posibles son "EMAIL", "SMS" o "EMAIL_AND_SMS". El valor predeterminado sería EMAIL.
mobile_number	mobile_number		string	Número de teléfono móvil

Devoluciones

response: array of CollaboratorResponse

Aplicar plantilla de flujo de trabajo

Id. de la operación:: V4_Workflow_ApplyTemplate

Las aplicaciones empresariales pueden usar esta API de servicio para aplicar una plantilla de flujo de trabajo a un documento. El identificador de documento en el que se debe aplicar la plantilla se proporciona en la dirección URL del recurso. Cuando el identificador de documento se establece en 0, la plantilla se aplicará a todos los doucments de un pacakge.

Al aplicar la plantilla, es importante recordar estos dos puntos importantes:

Punto 1: si la plantilla que se aplica se crea con un PDF que ya contiene campos de formulario, asegúrese de que el documento en el que se aplica esta plantilla debe contener estos campos de formulario de antemano y SigningHub NO creará esos campos de formulario a través de la plantilla, sino que solo aplicará los datos del formulario y asígnelos a los usuarios respectivos.

Punto 2: Si se crea la plantilla en la que se agregan manualmente campos de formulario (por lo tanto, no están presentes en el PDF originalmente) a través de SigningHub, por ejemplo, campo de firma, inicial, firma en persona, casillas, botones de radio, campos de texto, etc., al aplicar dicha plantilla, estos campos de formulario se crearán en el documento de destino incluso si estos campos de formulario ya estaban presentes en el documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete del paquete al que se debe aplicar la plantilla.
Id. de documento	documentId	True	integer	Identificador de documento en el que se debe aplicar la plantilla. Si el valor se establece en 0, si se va a aplicar la plantilla en todos los documentos del paquete.
template_name	template_name	True	string	Nombre de la plantilla que se va a aplicar en el documento.
apply_to_all	apply_to_all	True	boolean	True, si se va a aplicar la plantilla en todos los documentos del paquete.

Devoluciones

Body: DocumentDetailsResponse

Aprobación del documento de Gatekeeper

Id. de la operación:: V4_Package_GatekeeperApprove

Las aplicaciones empresariales pueden usar esta API de servicio para que un usuario especificado apruebe un documento en el orden.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a aprobar.
razón	reason		string	Motivo para aprobar un paquete.
Contraseña de acceso a documentos	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
Contraseña de One-Time de documento	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.

Devoluciones

response: object

Aprobar documento

Id. de la operación:: V4_Package_Approve

Las aplicaciones empresariales pueden usar esta API de servicio para aprobar un documento por parte de un usuario especificado en el orden.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a aprobar.
razón	reason		string	Motivo para aprobar un paquete.
Contraseña de acceso a documentos	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
Contraseña de One-Time de documento	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Asignar campo de documento

Id. de la operación:: V4_Fields_AutoAssignField

Las aplicaciones empresariales pueden usar esta API de servicio para asignar usuarios a campos de entrada, por ejemplo, campos de firma y, por tanto, definir el orden de firma. Los campos ya deben estar presentes en el documento y los usuarios deben estar presentes en el flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso, junto con el identificador del paquete.

Cuando los destinatarios están en un flujo de trabajo, se numeran, empezando por uno y contando para cada uno adicional. Por lo tanto, si hay tres usuarios en un flujo de trabajo, se numeran "1", "2" y "3" respetuosamente. Esta llamada API permite asignar un usuario por su número de pedido de flujo de trabajo a un campo de entrada en el documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se debe actualizar el usuario de flujo de trabajo.
field_name	field_name	True	string	Nombre del campo de firma que se va a asignar.
radio_group_name	radio_group_name		string	proporcionar el nombre del grupo para el cuadro de radio
order	order	True	integer	Orden del usuario en el flujo de trabajo al que se asigna el campo.
level_of_assurance	level_of_assurance		array of string	Nivel de garantía que se va a agregar. Los valores posibles son "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

Devoluciones

response: object

Cambiar el nombre del paquete

Id. de la operación:: V4_Package_RenamePackage

Esta API de servicio se usa para cambiar el nombre de un paquete de documentos.

El paquete de documentos se identifica mediante su identificador único en la dirección URL de la llamada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId_bulkAction	True	integer	Id. de paquete para cambiar el nombre de .
package_name	package_name	True	string	Nuevo nombre del paquete de documentos.

Devoluciones

response: object

Cambiar nombre del documento

Id. de la operación:: V4_Documents_RenameDocument

Las aplicaciones empresariales pueden usar esta API de servicio para cambiar el nombre de un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento al que se va a realizar la acción.
document_name	document_name	True	string	Nuevo nombre del documento.

Devoluciones

Body: DocumentResponse

Campos de autoplace

Id. de la operación:: V4_Fields_AutoPlace

Las aplicaciones empresariales pueden llamar a esta API para agregar campos de formulario definidos por el usuario o firma a un documento en función del criterio de búsqueda proporcionado. Las opciones de selección de ubicación son: a la izquierda, a la derecha, a la parte superior e inferior. El documento es la búsqueda y se procesan todas las instancias de los criterios de búsqueda cumplidos. Esto le permite agregar varios campos con una llamada. Por ejemplo, cargue un documento y coloque automáticamente un campo de firma a la derecha de todas las instancias de la palabra "Firmar aquí:". Esto ahorra tiempo y garantiza que no se pierdan firmas del flujo de trabajo.

La llamada API admite todos los tipos de campos; es decir, campo electrónico, digital, en persona, iniciales y de texto, etc.

Además, la llamada API admite la variable "order". Esto significa que puede asignar automáticamente un conjunto de campos de firma a un solo usuario. Por lo tanto, la llamada se puede repetir para colocar y asignar campos de firma a más de un usuario del flujo de trabajo.

Al menos un usuario debe existir en un flujo de trabajo para que los campos de firma se puedan agregar al documento de esta manera. El número de pedido corresponde al destinatario del flujo de trabajo. Por lo tanto, este número debe ser igual o menor que el número total de usuarios del flujo de trabajo. En el ejemplo siguiente se asigna este nuevo campo de firma a la primera persona del flujo de trabajo.

Esta llamada API se puede usar varias veces en el mismo documento. La razón para hacerlo es atender a varios firmantes en un documento. El destinatario o firmante se identifica mediante la variable "order" pasada en la llamada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento para el que se solicitan los campos.
search_text	search_text		string	Word que debe buscarse en el documento.
order	order	True	integer	Orden del usuario al que se asignarán automáticamente los campos. Flujo de trabajo en SigningHub ordena a los destinatarios. Esta lista comienza con "1" para el primer firmante designado.
colocación	placement		string	Si se encuentra el texto, los campos se colocarán en el documento. La ubicación del campo se puede mencionar en este atributo. Los valores posibles de colocación de un campo son LEFT, RIGHT, TOP, BOTTOM. Si no se proporciona ningún valor, el valor predeterminado será LEFT.
field_type	field_type		string	Tipo de campo que se va a crear en el documento. Los valores posibles son "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"
level_of_assurance	level_of_assurance		array of string	Nivel de garantía que se va a actualizar. Los valores posibles son "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
dimensions	dimensions			Dimensiones de un campo que se va a crear en el documento. La ubicación X e Y se calcula automáticamente. La API solo puede configurar el ancho y el alto para el campo. Si no se proporcionan dimensiones predeterminadas, se seguirán las dimensiones predeterminadas. es de 200 x 80 píxeles.
marcador de posición	placeholder		string	Proporcione una nota en el caso de datos adjuntos obligatorios.
radio_group_name	radio_group_name		string	El nombre del grupo solo es necesario al agregar un campo tipo Radio Box para agrupar varios cuadros de radio.
format	format		string	Formato de texto del campo. Solo se usa para el campo de tipo de fecha. Los valores posibles son: m/d m/d/yy m/d/aaaa mm/dd/aaaa dd/mm/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-aaaa d-mmm-aaaa dd-mmm-aaaa dd-mmm-aaaa yy-mm-dd aaaa-mm-dd mmm-aaaa mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyy
valor	value		string	Valor que el usuario quiere mostrar en el campo.
longitud_máxima	max_length	True	integer	Longitud máxima del valor permitido en el campo. Debe estar comprendido entre 1 y 9999
validation_rule	validation_rule		string	Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
validación	validation			Validations
font	font			Fuente del texto de los campos
multilínea	multiline	True	boolean	Esto pertenece al tipo de campo Área de texto y Si se establece en true, el campo de área de texto se crearía con la opción de varias líneas.

Devoluciones

response: array of AutoPlaceFieldsResponse

Cargar documento

Id. de la operación:: V4_Documents_UploadStream

Las aplicaciones empresariales pueden usar esta API de servicio para agregar un documento a un paquete de documentos vinculado a la cuenta de un usuario empresarial. La información del documento se envía en el encabezado de solicitud HTTP y los bytes del documento se envían en el cuerpo de la solicitud HTTP. Nota SigningHub convertirá los formatos de documento admitidos en PDF si el encabezado "x-convert-document" está establecido en un valor de "true". El único caso admitido en el que este valor se establece en "false" es conservar Word formato y documentos XML.

SigningHub admite una amplia variedad de formatos de documento, cada uno de los cuales se puede convertir en formato PDF al cargarse. Haga clic aquí para obtener la lista completa.

Nota Los documentos PDF no se modifican al cargarlos en el sistema.

Tenga en cuenta que ya debe existir un paquete para poder agregar un documento mediante esta llamada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se va a agregar el documento.
Contenido del archivo	body	True	binary	Este es el documento en formato binario sin formato.
Nombre del archivo	x-file-name		string	Es el nombre del archivo con la extensión .
Convertir documento	x-convert-document		string	Esto identifica si se va a convertir el documento a un PDF o si se debe conservar en su formato original. Tenga en cuenta que el único formato original admitido actualmente es Word y XML. Todos los demás tipos de documento producirán un error si este valor de encabezado está establecido en "false". Si se carga un documento PDF, se puede omitir este encabezado.
Source	x-source		string	Esta es la identificación del origen del documento desde el que se carga el documento, por ejemplo, "Mi aplicación".

Devoluciones

Body: UploadDocument

Compartir paquete de documentos

Id. de la operación:: V4_Workflow_StartWorkflow

Las aplicaciones empresariales pueden usar esta API de servicio para compartir un paquete de documentos con los firmantes e iniciar un nuevo flujo de trabajo. El documento ya debe haberse preparado aplicando una plantilla y actualizando opcionalmente los usuarios y las acciones definidas en la plantilla. El identificador de paquete que se va a compartir se proporciona en la dirección URL del recurso.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Paquete de documento que se va a compartir.

Devoluciones

response: array of StartWorkflowResponse

Descargar datos adjuntos

Id. de la operación:: V4_Attachment_DownloadAttachment

Las aplicaciones empresariales pueden usar esta API de servicio para descargar los datos adjuntos de un documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento al que se agregan los datos adjuntos.
Identificador de datos adjuntos	attachment_id	True	integer	Identificador de los datos adjuntos.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Descargar documento

Id. de la operación:: V4_Documents_DownloadDocumentBytes

Las aplicaciones empresariales pueden usar esta API de servicio para descargar los bytes del documento. El identificador del paquete y el identificador de documento se proporcionan en la dirección URL del recurso.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento que se va a descargar.
Contraseña del documento	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
contraseña de One-Time (OTP)	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Descargar paquete

Id. de la operación:: V4_Package_DownloadPackageBytes

Las aplicaciones empresariales pueden usar esta API de servicio para descargar el paquete de documentos en formato binario.

El identificador del paquete se proporciona en la dirección URL del recurso.

Si el paquete contiene solo un documento, la descarga es el documento PDF binario.

Como alternativa, si el paquete tiene más de un documento, la descarga es el archivo ZIP binario de todos los documentos.

Los encabezados x-password y x-otp son opcionales. Son necesarios si el propietario del documento los establece durante la fase de creación del flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId_bulkAction	True	integer	Identificador del paquete que se va a descargar.
ID de documento	document-ids		array	El parámetro Id. de documento es opcional. Si x-combine-files se establece en true, los documentos se combinarán en función de los documentos mencionados del paquete.
Contraseña de acceso a documentos	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
Contraseña de One-Time de documento	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Combinar archivos	x-combine-files		string	El valor predeterminado es false, establecido en "true" para combinar todo el paquete de documentos en un único archivo PDF.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Documento de rechazo de Gatekeeper

Id. de la operación:: V4_Package_GatekeeperDecline

Las aplicaciones empresariales pueden usar esta API de servicio para rechazar un documento por parte de un usuario especificado en el orden.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a rechazar.
razón	reason		string	Motivo proporcionado por el usuario para rechazarlo.

Devoluciones

response: object

Documento de recuperación

Id. de la operación:: V4_Workflow_RecallWorkflow

Las aplicaciones empresariales pueden usar esta API de servicio para detener un flujo de trabajo en curso. El identificador del documento se proporciona en la dirección URL del recurso. Después de recuperar el estado del documento cambia automáticamente a "DRAFT".

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a recuperar.

Devoluciones

response: object

Eliminar campo de documento

Id. de la operación:: V4_Fields_DeleteDocumentField

Las aplicaciones empresariales pueden usar esta API de servicio para eliminar un campo de documento en un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se va a realizar la acción.
field_name	field_name	True	string	Nombre del campo que se va a eliminar.

Devoluciones

response: object

Eliminar datos adjuntos

Id. de la operación:: V4_Attachment_DeleteAttachment

Las aplicaciones empresariales pueden usar esta API de servicio para eliminar los datos adjuntos de un documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento al que se agregan los datos adjuntos.
Identificador de datos adjuntos	attachment_id	True	integer	Identificador de los datos adjuntos.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Eliminar documento

Id. de la operación:: V4_Documents_DeleteDocument

Las aplicaciones empresariales pueden usar esta API de servicio para eliminar un documento de un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento que se va a eliminar.

Devoluciones

Body: DocumentResponse

Eliminar espacio compartido

Id. de la operación:: V4_WorkSpace_DeleteSharedSpace

Las aplicaciones empresariales pueden usar esta API de servicio para eliminar el espacio compartido. La disponibilidad de eliminar espacios compartidos está sujeta al rol de usuario de empresa asignado. Para permitir esta aprovisionamiento, el administrador de empresa habilitará la opción "Administrar espacio compartido" en Roles Document Settings (Configuración del documento de roles>).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de espacio compartido	id	True	integer	Identificador del espacio compartido que desea eliminar

Devoluciones

response: object

Eliminar paquete

Id. de la operación:: V4_Package_DeletePackage

Las aplicaciones empresariales pueden usar esta API de servicio para eliminar un documento de la bandeja de entrada de usuario. El identificador del paquete se proporciona en la dirección URL del recurso como "{package_id}". Si el estado del documento está pendiente, se rechazará automáticamente como resultado de la operación de eliminación. Si el estado del documento es SHARED, el documento se recupera automáticamente y el flujo de trabajo se detiene antes de que se elimine el documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId_bulkAction	True	integer	Id. de paquete del paquete que contiene el documento.

Devoluciones

response: object

Eliminar usuario de flujo de trabajo

Id. de la operación:: V4_Workflow_WorkflowDeleteUser

Las aplicaciones empresariales pueden usar esta API de servicio para eliminar el destinatario del flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete del que se va a eliminar el destinatario.
Pedido	order	True	integer	Orden del destinatario en el flujo de trabajo que se va a eliminar.

Devoluciones

response: object

Enviar documento

Id. de la operación:: V4_Package_Submit

Uno de los roles de SigningHub se denomina "Editor". Esto permite que un destinatario edite campos de entrada en un documento, pero no requiere una firma. Una vez completado, el destinatario envía sus cambios. El botón usado en la GUI se denomina "Enviar".

Esta es la operación equivalente para que un editor envíe sus cambios a través de una llamada API.

Haga clic en SigningHub Roles para obtener una descripción de todos los roles de destinatario del flujo de trabajo disponibles.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete de SigningHub que contiene el documento que se va a enviar.
Contraseña de acceso a documentos	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
Contraseña de One-Time de documento	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Estado de firma masiva

Id. de la operación:: V4_Signing_BulkSignStatus

Las aplicaciones empresariales pueden usar esta API para obtener el estado de una transacción de firma masiva específica junto con los detalles de los paquetes de documentos procesados por la API de paquetes de firma masiva .

Debe llamar a esta API después de la API de paquetes de firma masiva.

El firmante se identifica mediante el token de acceso presentado en la llamada. Por lo tanto, se requiere la autenticación del firmante antes de realizar esta llamada. No se puede autenticar como administrador de empresa con la variable de ámbito y firmar un documento en nombre de un usuario. El token de acceso debe emitirse al firmante como resultado de la autenticación directa.

Para la firma ras, la propiedad ACTION se REMOTE_AUTHORIZATION_REQURIED y la propiedad STATUS estará PENDIENTE, lo que indica que la solicitud debe estar autorizada mediante el dispositivo móvil. Si se produce un error en el proceso de firma en algún documento debido a distintos niveles de garantía configurados y el usuario quiere volver a iniciar el proceso de firma para completar el proceso de firma en documentos con errores, la propiedad ACTION se REINITIATE_SIGNING_PROCESS y la propiedad STATUS estará pendiente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificador_de_transacción	transaction_id		string	Número de identificación de la transacción de firma masiva
Acción masiva	bulk_action	True	string	Acción masiva que se va a realizar. Los valores posibles son: SIGN \| COMPARTIR

Devoluciones

Body: BulkSignStatusResponse

Finalizar el procesamiento

Id. de la operación:: V4_Package_Finish

Las aplicaciones empresariales pueden usar esta API de servicio para finalizar el procesamiento de documentos después de firmar todos los campos de firma. Este método se usa principalmente en aplicaciones móviles de SigningHub nativas para iOS y Android y casos de uso web móviles. Las aplicaciones empresariales generales que emplean una estrecha integración en su portal respectivo no necesitan llamar a este método. Sin embargo, cuando se usa Sign Document API (y, por lo tanto, el usuario no se presenta una representación visual del documento al que se solicita firmar) se requiere una llamada a esta API para asegurarse de que el flujo de trabajo respectivo continúa o se completa. Por ejemplo, una vez que se hayan aplicado todas las firmas mediante la llamada "blind" Sign Document API, el documento no se mostrará como estado "Completado" al propietario hasta que se invoque esta API. El propietario del documento verá un estado de "En curso" hasta que se llame a esta API.

Dentro de las aplicaciones móviles nativas de SigningHub y los casos de uso web móviles, esta llamada es necesaria para asegurarse de que cada usuario complete sus respectivas acciones con respecto a SigningHub.Por ejemplo, después de que un firmante haya firmado un documento en La aplicación SigningHub, la aplicación invoca este método para asegurarse de que el flujo de trabajo continúa procesando y se notifica al siguiente firmante, y el estado del documento está disponible a través de la dirección URL de devolución de llamada configurada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a finalizar.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Firmar documento

Id. de la operación:: V4_Signing_SignDocument

Las aplicaciones empresariales pueden usar esta API de servicio para firmar un documento (tanto electrónico como digital) sin mostrar el documento al usuario final mediante SigningHub. Por ejemplo, una aplicación empresarial puede tener otro método para mostrar el documento al usuario, y solo se requiere la funcionalidad de firma de SigningHub o, para las operaciones masivas, puede justificarse firmar sin necesidad de que el usuario vea y apruebe cada documento individualmente. Si hay cambios que se guardarán en el documento antes de la firma, se debe llamar a fill Form Fields API antes de llamar a Sign Document API. Tenga en cuenta que los campos de entrada obligatorios de un documento requieren completarse antes de que esta API se complete correctamente.

Cuando se completa esta llamada, es importante que si el firmante era el último firmante de un documento al que se invoca la llamada a la API Finish Document . El motivo es que, sin llamar a esa API, el documento permanecerá en estado "En curso" al propietario del documento. Una vez que se haya llamado a la API, el estado cambiará a "Completado" para el propietario del documento.

Una vez firmado el documento, la respuesta de comprobación se puede ver desde Get Document Verification API.

Uso de OTP en primer o segundo factor para la autenticación

Si la autenticación de OTP está activada para la operación de firma del lado servidor, las aplicaciones cliente deberán generar un OTP para el número de móvil mediante la autenticación del firmante a través de la llamada API de OTP . Las aplicaciones empresariales respectivas deben recuperar el OTP del uso y enviarlo al realizar la llamada API. Esto se hace mediante el encabezado "x-otp" de la solicitud.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que contiene el documento para la firma.
Id. de documento	documentId	True	integer	Identificador del documento que se va a firmar.
field_name	field_name	True	string	Identificador único del campo de firma del documento.
hand_signature_image	hand_signature_image		string	Imagen de cadena codificada en Base64 del aspecto de la firma visible, que se coloca en el documento. Tenga en cuenta que esto se puede recuperar de la configuración personal del usuario mediante esta llamada. (La respuesta es binaria, por lo que la aplicación empresarial debe codificarla en Base64 antes de enviarla en esta llamada API).
hand_signature_method	hand_signature_method			Nombre del método de firma de mano por usuario para firmar. En caso de que no se proporcione ningún método de firma de mano, el valor predeterminado será DRAW.
signing_reason	signing_reason		string	Motivo de firma proporcionado por el destinatario. Nota: Indicación del tipo de compromiso para documentos XML
signing_location	signing_location		string	Configuración regional del firmante proporcionado por el destinatario.
contact_information	contact_information		string	Información de contacto del firmante proporcionado por el destinatario.
nombre_de_usuario	user_name		string	Nombre del firmante proporcionado por el destinatario. Tenga en cuenta que esto solo se aplica a las operaciones de firma en persona.
user_password	user_password		string	Contraseña proporcionada por el usuario sujeto a la configuración de firma del usuario.
appearance_design	appearance_design		string	Nombre de la apariencia de la firma proporcionada por el usuario para firmar. En caso de que no se proporcione ningún nombre de apariencia, se usará la apariencia seleccionada predeterminada. Los valores posibles son "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE"
signing_capacity	signing_capacity		string	Nombre de la capacidad de firma o perfil de certificación con el que se va a firmar el documento. Si no se proporciona la capacidad predeterminada, se usará para firmar. El nombre proporcionado debe ser exactamente igual que el perfil real debido a la distinción entre mayúsculas y minúsculas.
skip_verification	skip_verification	True	boolean	No se devuelve ninguna comprobación de firma en el cuerpo de la respuesta cuando se establece como true. Valor predeterminado de este parámetro establecido en false.
signing_server	signing_server		string	Nombre del servidor de firma con el que se va a firmar el documento.
autenticación	authentication			El objeto de autenticación es opcional y contiene opciones de autenticación releadas
contraseña de One-Time (OTP)	x-otp		string	OTP se usa como autenticación de segundo factor para la operación de firma.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.
Originador móvil	x-mobile		string	Definir el originador(Web/Mobile) de la solicitud o acción

Devoluciones

Body: SignDocumentResponse

Flujo de trabajo completo en el medio (finalizar flujo de trabajo)

Id. de la operación:: V4_Workflow_MarkWorkflowCompleted

Las aplicaciones empresariales pueden marcar el flujo de trabajo completado incluso en medio del flujo de trabajo. Use esta API de servicio para cambiar el estado del flujo de trabajo a completado. Si hay destinatarios que aún no han firmado el documento. Su firma no será necesaria más y no podrá ver el documento en su bandeja de entrada. El token de portador debe pertenecer al propietario del documento o al administrador de empresa puede usar la variable de ámbito para obtener el token de acceso en nombre del propietario del documento para realizar esta acción.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete del que se va a eliminar el destinatario.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Iniciales de relleno

Id. de la operación:: V4_Initials_Fill

Las aplicaciones empresariales pueden usar esta API de servicio para rellenar un campo inicial en un documento por parte de un usuario especificado en el orden.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento.
field_name	field_name	True	string	Identificador único del campo del documento.
imagen	image	True	string	Imagen base64 utilizada para rellenar las iniciales.
method	method			Nombre del método de firma de mano por usuario para firmar. En caso de que no se proporcione ningún método de firma de mano, el valor predeterminado será DRAW. valores posibles DRAW,TEXT,UPLOAD,SIGNATURE_PAD
apply_to_all	apply_to_all	True	boolean	True si se van a rellenar todas las iniciales.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Mover el paquete a la carpeta Espacio compartido o personalizado

Id. de la operación:: V4_Folder_MovePackage

Las aplicaciones empresariales pueden usar esta API de servicio para mover el paquete de documentos a un espacio compartido o a la carpeta personalizada del usuario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete que debe moverse a la carpeta
folder_name	folder_name	True	string	Nombre de carpeta de destino en el que el paquete debe moverse

Devoluciones

response: object

Obtención de la autenticación de usuario de flujo de trabajo (apertura de documentos) del paquete enterprise

Id. de la operación:: V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

Las aplicaciones empresariales pueden usar esta API de servicio para obtener la configuración de seguridad de acceso habilitada para el paquete. Los destinatarios para los que se configura la seguridad se identifican mediante el orden en la dirección URL. El identificador del paquete también se identifica en la dirección URL de la solicitud. Los destinatarios no podrán acceder al paquete de documentos fuera del ámbito de esta duración si la seguridad de acceso está habilitada. El propietario del documento también puede configurar la seguridad basada en autenticación del paquete para un destinatario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se va a actualizar la seguridad y la autenticación de acceso de flujo de trabajo.
Orden del destinatario	order	True	integer	Orden del destinatario en el flujo de trabajo para el que se actualizará la seguridad de acceso y la autenticación.

Devoluciones

Body: EnterpriseAccessResponse

Obtener archivos adjuntos

Id. de la operación:: V4_Attachment_GetAttachments

Las aplicaciones empresariales pueden usar esta API de servicio para obtener los datos adjuntos de un documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento al que se agregan los datos adjuntos.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: array of GetAttachmentResponse

Obtener campos de documento

Id. de la operación:: V4_Fields_GetAllDocumentFields

Las aplicaciones empresariales pueden usar esta API de servicio para obtener campos de documento, es decir, iniciales, en personas, campos de firma o campos de formulario.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento para el que se solicitan los campos.
Página No	pageNo	True	integer	Página no del documento para el que se solicitan los campos. Si no se proporcionan campos de todo el documento si no se proporciona el número de página.
Originador	x-mobile		string	Definir el originador(Web/Mobile) de la solicitud o acción

Devoluciones

Body: FieldsResponse

Obtener contactos

Id. de la operación:: V4_Contacts_Get

Las aplicaciones empresariales pueden usar esta API de servicio para retieve los contactos tanto de contactos personales como empresariales para el usuario actual.

Es posible buscar en función del criterio proporcionado bajo el encabezado "x-search-text". Además, es posible buscar contactos específicos de un usuario o el de la empresa a la que pertenece el usuario.

La información de respuesta de búsqueda contiene la dirección de correo electrónico del usuario y el nombre de usuario correspondiente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Registros por página	recordPerPage	True	integer	Número total de registros que se van a recuperar en una página.
Número de página	pageNo	True	integer	Número de página que se va a recuperar.
Ordenar por	sort-by		string	Ordene el resultado por posibles valores mencionados anteriormente.
Ascendente	asc		boolean	Ordene el conjunto de resultados de forma ascendente o descendente.
Buscar texto	x-search-text		string	Buscar texto si es necesario. Esto es opcional y sin ella se devuelve toda la lista. Además, el valor recomendado para el parámetro de texto de búsqueda está en formato codificado en Base64.
Solo contactos empresariales	x-enterprise		string	Cuando se establece como "true" solo se devolverá la lista de contactos empresariales. En el caso de "false" solo se devolverá la lista de contactos del usuario. Si no establece el encabezado, se devolverán las listas de contactos de la empresa y del usuario.
Total de registros	x-total-records		string	Número total de registros encontrados con los criterios de búsqueda proporcionados.

Devoluciones

response: array of ContactResponse

Obtener detalles del documento

Id. de la operación:: V4_Documents_GetDocumentDetails

Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles del documento. El identificador del documento se proporciona en la dirección URL como "{document_id}".

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador de documento para el que se solicitan los detalles del documento.
Contraseña del documento	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
contraseña de One-Time (OTP)	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

Body: DocumentDetailsResponse

Obtener detalles del flujo de trabajo

Id. de la operación:: V4_Workflow_GetWorkflowDetail

Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles del flujo de trabajo del paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a descargar.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

Body: WorkflowDetailsResponse

Obtener detalles del paquete

Id. de la operación:: V4_Package_GetPackageDetails

Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles de un paquete. La aplicación empresarial también puede usar esta API para realizar acciones en nombre del usuario empresarial a través de "Autenticación de ámbito".

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete de documento.

Devoluciones

Body: GetPackageDetailsResponse

Obtener directiva de certificación para un documento

Id. de la operación:: V4_Documents_GetCertifyPolicy

Las aplicaciones empresariales pueden usar esta API de servicio para obtener la configuración de firma de certificación de un documento en un paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete del paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento que se va a descargar.

Devoluciones

Body: CertifyPolicyResponse

Obtener espacio compartido

Id. de la operación:: V4_WorkSpace_GetSharedSpace

Las aplicaciones empresariales pueden usar esta API de servicio para obtener un espacio compartido específico. Esta API devuelve información sobre el espacio compartido, su propietario y colaborador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de espacio compartido	id	True	integer	Identificador del espacio compartido que desea obtener

Devoluciones

Body: WorkSpaceResponse

Obtener historial de flujo de trabajo

Id. de la operación:: V4_Workflow_GetWorkflowHistory

Las aplicaciones empresariales pueden usar esta API de servicio para recuperar la lista de acciones realizadas en un documento. El identificador del paquete se proporciona en la dirección URL del recurso. El campo de búsqueda (encabezado x-search-text) está diseñado para correo electrónico, nombre de documento, acción, infokey e infovalue.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del documento para el que se requiere el registro.
Número de página	pageNo	True	integer	Número de página que se va a recuperar.
Registros por página	recordsPerPage	True	integer	Número total de registros que se van a recuperar en una página.
Buscar texto	x-search-text		string	El campo de búsqueda (encabezado x-search-text) está diseñado para correo electrónico, nombre de documento, acción, infokey e infovalue.

Devoluciones

Body: WorkflowHistoryResponse

Obtener informe de evidencia del proceso

Id. de la operación:: V4_WorkflowEvidenceReport_DownloadBytes

Las aplicaciones empresariales pueden usar esta API de servicio para descargar el informe de evidencia del proceso de flujo de trabajo de un documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del documento.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Obtener paquetes

Id. de la operación:: V4_Package_GetAllPackages

Las aplicaciones empresariales pueden usar esta API de servicio para obtener una lista de documentos filtrados por diferentes estados. Los usuarios pueden dividir los registros en páginas proporcionando una serie de registros por página.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Estado del documento	document_status	True	string	Filtrar por estado del documento los valores posibles son ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS.
Número de página	pageNo	True	integer	Número de página, según la división de registros por página.
Registros por página	recordPerPage	True	integer	Número de registros necesarios para capturarse en una solicitud.
Nombre del paquete	package-name		string	Nombre del paquete
Id. de paquete	package-id		integer	Id. de paquete
Desde	recipient-from		string	Desde
Para	recipient-to		string	Para
Id. de documento	document-id		integer	Id. de documento
Expiración (días)	expiry		integer	Expiración (días)
A partir de la fecha de modificación	modified-from		date-time	A partir de la fecha de modificación
Fecha de modificación	modified-to		date-time	Fecha de modificación
From Size (KB)	size-from		integer	From Size (KB)
Tamaño (KB)	size-to		integer	Tamaño (KB)
Documentos certificados	certified-documents		boolean	Solo documentos firmados certificados
Campos de formulario	form-fields		boolean	Solo los documentos que tienen campos de formulario
Datos adjuntos	attachments		boolean	Solo los documentos que tienen datos adjuntos
Tipo de documento	document-type		string	Tipo de documento como XML, PDF, DOCX, etc.
Ordenar por	sort-by		string	Ordenar los registros resultantes según su elección
Orden ascendente	asc		boolean	Ordenó los registros resultantes por orden ascendente o descendente
Estados del documento	document-statuses		array	Tipo de documento
Propiedad de	owned-by		string	Los valores posibles propiedad del filtro son ME_OTHERS, ME, OTROS.
Nombre del formulario inteligente	smart-form		string	Nombre del formulario inteligente
Nombre de carpeta	x-folder		string	Nombre de carpeta desde donde se van a capturar los documentos. Los valores posibles son INBOX y ARCHIVE. Además, el valor recomendado para el parámetro x-folder está en formato codificado en Base64.
Buscar texto	x-search-text		string	Buscar texto enviado en encabezados para una mayor filtración de los documentos. Se puede buscar el identificador del paquete, el nombre y el propietario del documento. Además, el valor recomendado para el parámetro de texto de búsqueda está en formato codificado en Base64.
Total de registros	x-total-records		string	Número total de registros encontrados con los criterios de búsqueda proporcionados.
Source	x-source		string	Esta es la identificación del origen del documento desde el que se carga el documento, por ejemplo, "Mi aplicación".
Detalles del destinatario	x-recipient-details		string	Si se pasa "true" a los detalles del destinatario con respecto a la duración del acceso al documento se proporcionará a lo largo de la información de rechazo.

Devoluciones

response: array of GetPackagesResponse

Obtener permisos de usuario de flujo de trabajo

Id. de la operación:: V4_WorkflowPermission_GetWorkflowPermissions

Las aplicaciones empresariales pueden usar esta API de servicio para obtener permisos de documento para un destinatario. El destinatario se identifica mediante el orden del flujo de trabajo. El identificador del paquete se proporciona en la dirección URL del recurso.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de documento para el que se debe actualizar el usuario de flujo de trabajo.
Pedido	order	True	integer	El orden del usuario en el flujo de trabajo para el que se solicitan los permisos. Al proporcionar el valor 0 en orden, el servicio devolvería los permisos de colaborador agregado más recientemente en el flujo de trabajo.

Devoluciones

Body: WorkflowPermissionResponse

Obtener plantillas

Id. de la operación:: V4_Settings_GetTemplates

Las aplicaciones empresariales pueden usar esta API de servicio para obtener una lista de plantillas para el usuario actual.

Es posible buscar en función del criterio proporcionado bajo el encabezado "x-search-text". Además, es posible buscar en las plantillas personales de un usuario o en las plantillas empresariales, según lo permitido en su rol de usuario por su administrador de empresa.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Número de registros por página	recordPerPage	True	integer	Número total de registros que se van a recuperar en una página.
Número de página que se va a recuperar	pageNo	True	integer	Número de página que se va a recuperar.
Ordenar por columna	sort-by		string	Ordenar por columna. Los valores posibles son CREATED_ON y NAME. El valor predeterminado es ordenar por CREATED_ON
Asc	asc		boolean	El orden de lista resultante. La lista resultante predeterminada será descendente.
Buscar texto	x-search-text		string	Buscar texto si es necesario. Esto es opcional y sin ella se devuelve toda la lista. Además, el valor recomendado para el parámetro de texto de búsqueda está en formato codificado en Base64.
Solo plantillas empresariales	x-enterprise		string	Cuando se establece como "true" solo se devolverá la lista de plantillas empresariales. En el caso de "false" solo se devolverá la lista de plantillas del usuario. Si no establece el encabezado, se devolverán las listas de plantillas de empresa y de usuario.
Número total de registros	x-total-records		string	Número total de registros encontrados con los criterios de búsqueda proporcionados.

Devoluciones

response: array of TemplateResponse

Obtener plantillas empresariales

Id. de la operación:: V4_Template_GetEnterpriseTemplates

Las aplicaciones empresariales pueden usar esta API de servicio para obtener la lista de plantillas empresariales del usuario actual. Esto significa que el administrador de empresa o el usuario de empresa si se usó la variable "ámbito" en la solicitud de autenticación.

Es posible buscar en función del criterio proporcionado bajo el encabezado "x-search-text".

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Número de registros por página	recordPerPage	True	integer	Número total de registros que se van a recuperar en una página.
Número de página que se va a recuperar	pageNo	True	integer	Número de página que se va a recuperar.
Ordenar por columna	sort-by		string	Ordene el resultado por posibles valores mencionados anteriormente.
Ordenar el conjunto de resultados	asc		boolean	Ordene el conjunto de resultados de forma ascendente o descendente.
Filtrar por identificadores de plantilla	id		array	Busque por identificadores de plantilla.
Buscar texto	x-search-text		string	Buscar texto si es necesario. Esto es opcional y sin ella se devuelve toda la lista. Además, el valor recomendado para el parámetro de texto de búsqueda está en formato codificado en Base64.
Número total de registros	x-total-records		string	Número total de registros encontrados con los criterios de búsqueda proporcionados.

Devoluciones

response: array of EnterpriseTemplateResponse

Obtener recordatorio de flujo de trabajo

Id. de la operación:: V4_Workflow_GetWorkflowReminder

Las aplicaciones empresariales pueden usar esta API de servicio para actualizar los recordatorios de los destinatarios que ya se han agregado a un flujo de trabajo. Normalmente, esta llamada es útil después de que se haya aplicado una plantilla a un documento y las aplicaciones empresariales quieran invalidar la configuración de recordatorios dentro del flujo de trabajo. El identificador del documento de flujo de trabajo se proporciona en la dirección URL del recurso y el destinatario del flujo de trabajo se identifica mediante el orden en el que se agrega al flujo de trabajo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador de paquete para el que se actualizarán los recordatorios de flujo de trabajo.
Pedido	order	True	integer	El orden del usuario para el que se van a actualizar los recordatorios del flujo de trabajo.

Devoluciones

Body: ReminderResponse

Obtener usuarios de flujo de trabajo

Id. de la operación:: V4_Workflow_GetWorkflowUsers

Las aplicaciones empresariales pueden usar esta API de servicio para obtener los detalles del flujo de trabajo del paquete.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a descargar.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: array of WorkflowRecipient

Paquetes de firma masiva

Id. de la operación:: V4_Signing_BulkSignDocuments

Las aplicaciones empresariales pueden usar esta API para firmar, compartir o firmar y compartir varios documentos (tanto electrónicos como digitales) sin mostrar los documentos al usuario final. Esta API necesita información de la aplicación empresarial sobre los paquetes de documentos y los detalles de las firmas, los campos en persona e iniciales. Cuando se complete correctamente la transacción de firma masiva, la API devolverá los estados y los identificadores de transacción de los paquetes de documentos.

A diferencia de Sign Document API, esta API no solo firma un paquete de documentos, sino que también la marca como aprobada y revisada en función de si el destinatario es un firmante, editor o revisor. Cualquier paquete de documento para el que el estado devuelva como COMPLETADO se ha firmado, aprobado o revisado por esta API.

La firma masiva funciona con todos los métodos de autenticación en tiempo de firma.

Si SIGN se pasa como bulk_action y el paquete está en estado Borrador, firmar y compartir se realizará automáticamente.

Debe llamar a esta API después de la API Pre Bulk Sign Documents .

En caso de que tenga que realizar cambios en cualquiera de los documentos antes de firmarlo, se debe llamar a la API Fill Form Fields antes de llamar a la API Pre Bulk Sign Document. Recuerde que los campos de entrada obligatorios de un documento requieren completarse antes de que esta API se complete correctamente; mientras que los campos rellenados automáticamente (como Nombre, Correo electrónico, Fecha, Título del trabajo, etc.) se rellenarán automáticamente.

Una vez firmado el documento, la respuesta de comprobación se puede ver desde la API de estado de firma masiva .

Uso de OTP en primer o segundo factor para la autenticación

En caso de que la autenticación de OTP esté activada para la operación de firma del lado servidor, las aplicaciones cliente deberán generar un OTP para el número de móvil mediante la autenticación de firma masiva a través de la llamada API de OTP. Las aplicaciones empresariales respectivas deben recuperar el OTP del uso y enviarlo al realizar la llamada API. Esto se hace mediante el encabezado "x-otp" de la solicitud.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
sistemas de identificación	ids		array of integer	Matriz de los identificadores de paquete de documento seleccionados para la firma masiva.
hand_signature_initials_image	hand_signature_initials_image		string	Imagen base64 utilizada para rellenar las iniciales
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
hand_signature_image	hand_signature_image		string	Imagen de cadena codificada en Base64 de la apariencia de la firma visible
hand_signature_method	hand_signature_method			Nombre del método de firma de mano por usuario para firmar. En caso de que no se proporcione ningún método de firma de mano, el valor predeterminado será DRAW. valores posibles DRAW,TEXT,UPLOAD,SIGNATURE_PAD
signing_reason	signing_reason		string	Motivo de firma proporcionado por el destinatario.
signing_location	signing_location		string	Configuración regional del firmante proporcionado por el destinatario
contact_information	contact_information		string	Información de contacto del firmante proporcionado por el destinatario
appearance_design	appearance_design		string	Nombre de la apariencia de la firma proporcionada por el usuario para firmar. En caso de que no se proporcione ningún nombre de apariencia, se usará la apariencia seleccionada predeterminada. Los valores posibles son "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_server	signing_server		string	Nombre del servidor de firma con el que se va a firmar el documento
signing_capacity	signing_capacity		string	Nombre de la capacidad de firma o perfil de certificación con el que se va a firmar el documento
autenticación	authentication			El objeto de autenticación es opcional y contiene opciones de autenticación releadas
identificador_de_transacción	transaction_id		string	id. de transacción del proceso de firma iniciado de nuevo
Id. de paquete	packageId_bulkAction	True	string	Acción masiva que se va a realizar. Los valores posibles son: SIGN \| COMPARTIR
Firma de OTP	x-otp		string	OTP/TOTP usado como autenticación de firma de documentos o factor segundo para la operación de firma.
Contraseña de acceso a documentos	x-open-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
Contraseña de One-Time de documento	x-open-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.
Originador móvil	x-mobile		string	Definir el originador(Web/Mobile) de la solicitud o acción

Devoluciones

Body: BulkSignResponse

Rechazar documento

Id. de la operación:: V4_Package_Decline

Las aplicaciones empresariales pueden usar esta API de servicio para rechazar un documento por parte de un usuario especificado en el orden.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Identificador del paquete que se va a rechazar.
razón	reason		string	Motivo proporcionado por el usuario para rechazarlo.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Rellenar campos de formulario

Id. de la operación:: V4_Fields_FillFormFields

Las aplicaciones empresariales pueden usar esta API de servicio para rellenar uno o varios campos de formulario en un documento por parte de un usuario especificado en el orden.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de paquete	packageId	True	integer	Id. de paquete al que se agrega el documento.
Id. de documento	documentId	True	integer	Identificador del documento.
auto_save	auto_save	True	boolean	El valor predeterminado es Falso. True, si los campos de formulario se guardan sin intervención del usuario, por ejemplo, al cerrar el documento o presionar hacia atrás. Para Firma, Iniciales, In-persons, Reviewing, Submit actions the value is false.
field_name	field_name	True	string	Identificador único del campo del documento.
valor	value		string	Valor del campo que se va a guardar en el documento.
field_name	field_name	True	string	Identificador único del campo del documento.
radio_group_name	radio_group_name		string	Nombre de grupo al que pertenece el botón de radio.
valor	value	True	boolean	Valor del campo que se va a guardar en el documento.
field_name	field_name	True	string	Identificador único del campo del documento.
valor	value	True	boolean	Valor del campo que se va a guardar en el documento.
field_name	field_name	True	string	Identificador único del campo del documento.
valor	value		string	Valor del campo que se va a guardar en el documento.
field_name	field_name	True	string	Identificador único del campo del documento.
valor	value		string	Valor del campo que se va a guardar en el documento.
Contraseña del documento	x-password		string	Contraseña establecida por el propietario del documento para acceder al documento, si existe. Si no se ha establecido la contraseña, el valor será NULL.
contraseña de One-Time (OTP)	x-otp		string	El One-Time Contraseña (OTP) establecido por el propietario del documento para acceder al documento, si existe. Si no se ha establecido el OTP, el valor será NULL.
Id. de carpeta	x-folder-id		string	Especifique el identificador de carpeta para recuperar los elementos de carpeta cuando una carpeta de espacio compartido esté implicada.

Devoluciones

response: object

Definiciones

ElectronicSealRecipient

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string
level_of_assurance	level_of_assurance	string

ReminderResponse

Nombre	Ruta de acceso	Tipo	Description
enabled	enabled	boolean	True, si los recordatorios están habilitados para el destinatario
frecuencia	frequency	string	Frecuencia de recordatorio. Los valores posibles son DAYS \| HORAS.
remind_after	remind_after	integer	Número de días después del cual se enviaría el primer aviso al usuario de flujo de trabajo.
repetir	repeat		Repita el objeto con los detalles del aviso que se repite o no.

AddQrCodeResponse

Nombre	Ruta de acceso	Tipo	Description
datos	data	string	Datos generados por código QR
field_name	field_name	string	Nombre del campo creado en el documento.
valor	value	string	El valor será la imagen base64 de QrCode.

AddFieldResponse

Nombre	Ruta de acceso	Tipo	Description
field_name	field_name	string	Nombre del campo creado en el documento.
created_on	created_on	string	Fecha y hora de creación de campos.

SignatureFieldResponse

Nombre	Ruta de acceso	Tipo	Description
field_name	field_name	string	Nombre del campo creado en el documento.
created_on	created_on	string	Fecha y hora de creación de campos.

UpdateQrCodeResponse

Nombre	Ruta de acceso	Tipo	Description
valor	value	string	El valor será la imagen base64 de QrCode.

CertifyResponse

Nombre	Ruta de acceso	Tipo	Description
enabled	enabled	boolean	True, si la configuración de firma de certificación está habilitada para el documento.
allowed_permissions	allowed_permissions	array of string	Certifique el conjunto de nivel de permisos para el documento con la configuración de firma de certificación.
default_permission	default_permission	string

GroupMemberResponse

Nombre	Ruta de acceso	Tipo	Description
user_email	user_email	string	Dirección de correo electrónico del miembro del grupo
nombre_de_usuario	user_name	string	Nombre de usuario del miembro del grupo

ColaboradorResponse

Nombre	Ruta de acceso	Tipo	Description
user_email	user_email	string	Correo electrónico del usuario
signing_order	signing_order	integer	Orden de firma
guest_user	guest_user	boolean	Usuario invitado
email_language_code	email_language_code	string	Código de idioma de correo electrónico
permiso	permission		Permisos para el destinatario en el paquete de documentos
recordatorio	reminder		Configuración de recordatorio del destinatario.

WorkflowPermissionResponse

Nombre	Ruta de acceso	Tipo	Description
print	print	boolean	True, si se permite imprimir para este destinatario.
descargar	download	boolean	True, si se permite la descarga.
add_text	add_text	boolean	True, si se permite agregar anotación de texto en el documento.
change_recipients	change_recipients	boolean	True, si el destinatario del orden actual puede cambiar otros destinatarios del flujo de trabajo después de compartir el flujo de trabajo.
add_attachment	add_attachment	boolean	True, si se permiten datos adjuntos y combinación de documentos PDF.
legal_notice	legal_notice		Aviso legal establecido por el propietario del destinatario.
archivo adjunto	attachment		Datos adjuntos

EnterpriseTemplateResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador de la plantilla
nombre	name	string	Nombre de la plantilla.
pública	public	boolean	La respuesta es "true" si la plantilla de empresa está marcada como pública. De lo contrario, se devolverá "false"
read_only	read_only	boolean	Respuesta de "true" si la plantilla es de solo lectura y el usuario no puede realizar ningún cambio en el flujo de trabajo después de aplicar esta plantilla. De lo contrario, "false".
descripción	description	string	Descripción de la plantilla
created_on	created_on	string	Fecha y hora en que se creó la plantilla
roles	roles	array of EnterpriseTemplateRole
Documentos	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre del rol de empresa asignado al usuario.
id	id	integer	Identificador del rol de empresa asignado al usuario.

TemplateDocumentResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Id. del documento de plantilla
nombre	name	string	Nombre del documento de plantilla.

Next_signer_email

Nombre	Ruta de acceso	Tipo	Description
user_email	user_email	string	Dirección de correo electrónico del siguiente firmante.
nombre_de_usuario	user_name	string	Nombre del siguiente firmante.

WorkflowRecipient

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Orden del destinatario en el flujo de trabajo.
user_email	user_email	string	Dirección de correo electrónico del destinatario si el usuario no es un grupo.
nombre_de_usuario	user_name	string	Nombre del destinatario si el usuario no es un grupo.
mobile_number	mobile_number	string	Número de móvil
delivery_method	delivery_method	string	Método de entrega del destinatario Valores posibles: EMAIL, SMS o EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Punto de conexión de API para acceder al recurso, esto solo se proporcionará para los firmantes principales. Por ejemplo, será null para group/delegator/gatekeeper, etc. Esta dirección URL no garantiza que exista la imagen del firmante. Si la imagen existe, se proporcionará pulsando la dirección URL definida; de lo contrario, será una cadena vacía.
group_name	group_name	string	Nombre de grupo del destinatario si el destinatario es un grupo.
group_members	group_members	array of GroupMemberResponse	Lista de direcciones de correo electrónico de los miembros del grupo si el destinatario es un grupo.
delegado	delegatee	string	Delegar la dirección de correo electrónico, si el destinatario no es un grupo.
delegatee_name	delegatee_name	string	Nombre del usuario delegado, si el destinatario no es un grupo.
role	role	string	Rol de flujo de trabajo en el que se agregó el destinatario. Este rol no es el rol de empresa. Los valores posibles son "SIGNER", "REVIEWER","CARBON_COPY" y "EDITOR".
razón	reason	string	Motivo proporcionado por el usuario al rechazar, aprobar o enviar un documento.
process_status	process_status	string	Estado de procesamiento de documentos para el destinatario. Los valores posibles son "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDIT" o "INVALID".
processed_on	processed_on	string	Fecha y hora en que se procesó el documento.
processed_as	processed_as	string	El usuario puede procesar el campo como COLABORADOR, DELEGATOR, GROUP_MEMBER o PROPIETARIO.
processed_by	processed_by	string	Dirección de correo electrónico del usuario que procesó el documento.
marcador de posición	placeholder	string	Texto del marcador de posición si el destinatario es un marcador de posición
signing_order	signing_order	integer	Orden en el que los destinatarios firmarán el flujo de trabajo. Este orden de firma es importante cuando el tipo de flujo de trabajo se establece en "CUSTOM".
user_national_id	user_national_id	string	Número de identidad nacional del usuario. Esto ayuda a identificar al usuario en el flujo de trabajo.
guest_user	guest_user	boolean	Usuario de Gest
email_language_code	email_language_code	string	código de idioma de correo electrónico
electronic_seal	electronic_seal	ElectronicSealRecipient
gatekeepers	gatekeepers		Gatekeepers

EnterpriseAccessResponse

Nombre	Ruta de acceso	Description
autenticación	authentication	Objeto de autenticación con los detalles de los métodos de autenticación aplicados en el documento para el destinatario.
authentication_signing	authentication_signing	Firma de autenticación para el paquete
access_duration	access_duration	Objeto de duración de acceso con los detalles de los valores de acceso para el destinatario.

GetPackageDetailsResponse

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre del paquete de documentos.
propietario	owner	DocumentOwner
read_only	read_only	boolean	True si la plantilla aplicada es de solo lectura. El usuario no podrá realizar ningún cambio si se aplica una plantilla de solo lectura.
document_status	document_status	string	Estado del documento para el usuario que ha iniciado sesión. Los valores posibles son "DRAFT", "INPROGRESS", "PENDING", "DECLINED" o "COMPLETED".
Documentos	documents	array of DocumentDetails

DocumentOwner

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre del propietario del paquete de documento.
email	email	string	Correo electrónico del propietario del paquete de documento.

DocumentDetails

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Id. del documento recién creado.
nombre	name	string	Nombre del documento.
uploaded_on	uploaded_on	string	Fecha y hora en que se cargó el documento.
modified_on	modified_on	string	Fecha y hora en que se modificó por última vez el documento.
tamaño	size	integer	Tamaño del documento en bytes.
type	type	string	Tipo del documento, por ejemplo, "PDF".
source	source	string	Identifica dónde se cargó el documento, por ejemplo, "Mi aplicación".

TemplateResponse

Nombre	Ruta de acceso	Tipo	Description
template_id	template_id	integer	Aquí se devuelve el identificador de la plantilla.
template_name	template_name	string	Nombre de la plantilla.
template_public	template_public	boolean	La respuesta es "true" si la plantilla de empresa está marcada como pública. De lo contrario, se devolverá "false"
read_only	read_only	boolean	Respuesta de "true" si la plantilla es de solo lectura y el usuario no puede realizar ningún cambio en el flujo de trabajo después de aplicar esta plantilla. De lo contrario, "false".
created_on	created_on	string	Fecha y hora en que se creó la plantilla
descripción	description	string	Descripción de la plantilla
empresa	enterprise	boolean	True, si el usuario pertenece a una empresa.
Documentos	documents	array of TemplateDocumentResponse
smart_form	smart_form		Formulario inteligente

StartWorkflowResponse

Nombre	Ruta de acceso	Tipo	Description
package_id	package_id	integer	Id. de paquete del paquete que acaba de compartir. En caso de uso compartido individual, se crean más paquetes y se comparten con los destinatarios. LA API devuelve una matriz de paquetes junto con identificadores de documentos recién creados.
Documentos	documents	array of integer	Matriz de identificadores de documento que formaban parte del paquete antes de compartir.

WorkflowDetailsResponse

Nombre	Ruta de acceso	Tipo	Description
package_id	package_id	integer	Id. de paquete del paquete de documento.
package_name	package_name	string	Nombre del paquete de documentos.
shared_package	shared_package	boolean	paquete compartido
package_owner	package_owner	string	Dirección de correo electrónico del propietario del paquete de documento.
owner_name	owner_name	string	Nombre del propietario del paquete de documento.
package_status	package_status	string	Estado del documento para el usuario que ha iniciado sesión. Los valores posibles son "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" o "COMPLETED".
folder	folder	string	Nombre de la carpeta que contiene el paquete de documentos.
folder_id	folder_id	integer	Identificador de la carpeta que contiene el paquete de documentos.
gatekeeper	gatekeeper	boolean
next_signer	next_signer	string	Nombre del siguiente firmante si el documento está en estado compartido.
next_signer_email	next_signer_email	array of Next_signer_email	Objeto que contiene el siguiente nombre de usuario y dirección de correo electrónico de los firmantes. En el caso del firmante de grupo, tendrá una lista de direcciones de correo electrónico de todos los miembros del grupo.
uploaded_on	uploaded_on	string	Fecha y hora en que se cargó el documento.
modified_on	modified_on	string	Fecha y hora en que se modificó por última vez el documento.
flujo de trabajo	workflow		Objeto de flujo de trabajo con los detalles del flujo de trabajo.
Documentos	documents	array of WorkflowDocumentsResponse	Lista de documentos que se cargan en el paquete.
users	users	array of WorkflowUserResponse	Lista de destinatarios para el flujo de trabajo.

WorkflowDocumentsResponse

Nombre	Ruta de acceso	Tipo	Description
document_id	document_id	integer	Identificador del documento.
document_name	document_name	string	Nombre del documento.
document_type	document_type	string	Extensión de documento original cuando el documento se cargó antes de la conversión al PDF.
document_order	document_order	integer	Orden del documento en el paquete del documento.
document_source	document_source	string	Origen del documento desde el que se cargó el documento.
update_required	update_required	boolean	True si es necesario actualizar el documento
document_height	document_height	integer	Alto del documento PDF.
document_width	document_width	integer	Ancho del documento PDF.
document_pages	document_pages	integer	Número total de páginas del documento.
created_on	created_on	string	Fecha y hora en que se cargó el documento.
modified_on	modified_on	string	Fecha y hora en que se modificó por última vez el documento.
form_fields	form_fields	boolean	True, si el documento tiene campos de formulario.
template	template		Objeto de plantilla que se aplica en el documento junto con los detalles de la plantilla.
certifique	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	True, si el documento está establecido para bloquear los campos de formulario con la última firma digital del documento.
bloqueado	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Metadatos del documento pdf: true si el documento pdf tiene campos de firma firmados
attachments	attachments	boolean	True, si el documento tiene datos adjuntos.
conformance_level	conformance_level	string	Nivel de conformidad del documento
document_size	document_size	integer	Tamaño del documento.
Formato	formatted	boolean	Esta propiedad es para el documento XML, que tiene el formato o no.

WorkflowUserResponse

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Orden del destinatario en el flujo de trabajo.
nombre_de_usuario	user_name	string	Nombre del destinatario si el destinatario no es un grupo. Si el destinatario es un marcador de posición, contendrá el nombre del marcador de posición.
user_email	user_email	string	Dirección de correo electrónico del destinatario si el destinatario no es un grupo o marcador de posición.
mobile_number	mobile_number	string	Número de móvil
delivery_method	delivery_method	string	Método de entrega del destinatario Valores posibles: EMAIL, SMS o EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Punto de conexión de API para acceder al recurso, esto solo se proporcionará para los firmantes principales. Por ejemplo, será null para group/delegator/gatekeeper, etc. Esta dirección URL no garantiza que exista la imagen del firmante. Si la imagen existe, se proporcionará pulsando la dirección URL definida; de lo contrario, será una cadena vacía.
group_name	group_name	string	Nombre del grupo si el destinatario es un grupo.
group_members	group_members	array of string	Lista de todas las direcciones de correo electrónico y nombres de los usuarios.
delegator	delegator	string	Dirección de correo electrónico del usuario que se delega a este destinatario.
gatekeeper	gatekeeper	string	Dirección de correo electrónico del usuario que es gatekeeper para este destinatario.
gatekeepers	gatekeepers		Gatekeepers
role	role	string	Rol del destinatario, es decir, "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" o "INPERSON_HOST".
process_status	process_status	string	Estado de procesamiento de documentos para el destinatario. Los valores posibles son "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDIT" o "INVALID".
processed_on	processed_on	string	Fecha y hora en que se procesó el documento.
processed_as	processed_as	string	El usuario puede procesar el campo como COLABORADOR, DELEGATOR, GROUP_MEMBER o PROPIETARIO.
processed_by	processed_by	string	Dirección de correo electrónico del usuario que procesó el documento.
razón	reason	string	Motivo proporcionado por el usuario al rechazar, aprobar o enviar un documento.
marcador de posición	placeholder	string	Texto del marcador de posición si el destinatario es un marcador de posición.
permiso	permission		Permisos para el destinatario establecido por el propietario del paquete de documentos.
authentications	authentications		Objeto authentications con los detalles de las autenticaciones y valores de acceso configurados para el destinatario.
recordatorio	reminder		Objeto Reminder con los detalles de la configuración del recordatorio.
signing_order	signing_order	integer	Orden en el que los destinatarios firmarán el flujo de trabajo. Este orden de firma es importante cuando el tipo de flujo de trabajo se establece en "CUSTOM".
user_national_id	user_national_id	string	Número de identidad nacional del usuario. Esto ayuda a identificar al usuario en el flujo de trabajo.
guest_user	guest_user	boolean	Usuario de Gest
email_language_code	email_language_code	string	Código de idioma de correo electrónico
electronic_seal	electronic_seal		sello electrónico

DocumentDetailsResponse

Nombre	Ruta de acceso	Tipo	Description
document_id	document_id	integer	Id. del documento recién creado.
document_name	document_name	string	Nombre del documento.
document_order	document_order	integer
document_type	document_type	string	Tipo del documento, por ejemplo, "PDF".
document_width	document_width	integer	Ancho del documento en formato PDF.
document_height	document_height	integer	Alto del documento en formato PDF.
document_source	document_source	string	Identifica dónde se cargó el documento, por ejemplo, "Mi aplicación".
document_pages	document_pages	integer	Total de páginas del documento.
form_fields	form_fields	boolean	True si el documento tiene campos de formulario.
lock_form_fields	lock_form_fields	boolean	True si se habilita el bloqueo de campos de formulario con la última firma.
uploaded_on	uploaded_on	string	Fecha y hora en que se cargó el documento.
modified_on	modified_on	string	Fecha y hora en que se modificó por última vez el documento.
certifique	certify		Configuración de firma certificada para el documento.
template	template		Detalles de la plantilla, si la plantilla se aplica en el documento.

AddAttachmentResponse

Nombre	Ruta de acceso	Tipo	Description
attachment_id	attachment_id	integer	Id. de datos adjuntos

GetAttachmentResponse

Nombre	Ruta de acceso	Tipo	Description
attachment_id	attachment_id	integer	Id. de datos adjuntos
attachment_name	attachment_name	string	Nombre de datos adjuntos

AddPackageResponse

Nombre	Ruta de acceso	Tipo	Description
package_id	package_id	integer	Identificador del paquete que se usará más adelante para compartir, descargar y obtener el estado del documento.
workflow_mode	workflow_mode	string	Modo de flujo de trabajo que se establece al agregar el paquete.
workflow_type	workflow_type	string	Tipo del flujo de trabajo. Los valores posibles son "SERIAL", "PARALLEL", "INDIVIDUAL" y "CUSTOM".

GetPackagesResponse

Nombre	Ruta de acceso	Tipo	Description
package_id	package_id	integer	Id. de paquete del paquete de documento.
package_name	package_name	string	Nombre del paquete de documentos.
package_owner	package_owner	string	Dirección de correo electrónico del propietario del paquete de documento.
owner_name	owner_name	string	Nombre del propietario del paquete de documento.
shared_package	shared_package	boolean	Paquete compartido
gatekeeper_package	gatekeeper_package	boolean	Paquete de Gatekeeper
package_status	package_status	string	Estado del documento para el usuario que ha iniciado sesión. Los valores posibles son "DRAFT", "INPROGRESS", "PENDING", "DECLINED" o "COMPLETED".
extensión	extension	string	Extensión del paquete de documento
workflow_mode	workflow_mode	string	Modo de flujo de trabajo
folder	folder	string	Nombre de la carpeta que contiene el paquete de documentos.
folder_id	folder_id	integer	Identificador de la carpeta que contiene el paquete de documentos.
no leído	unread	boolean	True, si el destinatario aún no lee el documento.
next_signer	next_signer	string	Nombre del siguiente firmante si el documento está en estado compartido.
next_signer_email	next_signer_email	array of Next_signer_email	Objeto que contiene el siguiente nombre de usuario y dirección de correo electrónico de los firmantes. En el caso del firmante de grupo, tendrá una lista de direcciones de correo electrónico de todos los miembros del grupo.
uploaded_on	uploaded_on	string	Fecha y hora en que se cargó el documento.
modified_on	modified_on	string	Fecha y hora en que se modificó por última vez el documento.
access_duration	access_duration		Especifique la fecha y hora de inicio y finalización para que un destinatario acceda al documento. El destinatario no podrá acceder al documento más allá de esta duración. Si el documento no se procesa en el tiempo especificado, el documento se considerará rechazado. Esto se proporcionará si "x-recipient-details" se pasa como true en el encabezado.
rechazar	decline		Detalles de rechazo del documento si se rechaza manualmente o se realiza automáticamente a través de Core. Esto se proporcionará si "x-recipient-details" se pasa como true en el encabezado.
tamaño	size	integer	Tamaño del documento en bytes.

DocumentResponse

Nombre	Ruta de acceso	Tipo	Description
package_name	package_name	string	Nombre del paquete de documento

UploadDocument

Nombre	Ruta de acceso	Tipo	Description
documentId	documentId	integer	Esta propiedad se conserva para la compatibilidad con versiones anteriores y se quitará en versiones posteriores. Use document_id en su lugar.
documentid	documentid	integer	Identificador del documento que se usará más adelante para compartir, descargar y obtener el estado del documento. se quitará más adelante document_id se usará
document_id	document_id	integer	Identificador del documento que se usará más adelante para compartir, descargar y obtener el estado del documento.
document_name	document_name	string	Nombre del documento.
document_order	document_order	integer	Orden del documento en el paquete
document_type	document_type	string	Tipo del documento, por ejemplo, "PDF".
document_source	document_source	string	Identifica dónde se cargó el documento, por ejemplo, "Mi aplicación".
document_width	document_width	integer	Ancho del documento en formato PDF.
document_height	document_height	integer	Alto del documento en formato PDF.
document_pages	document_pages	integer	Total de páginas del documento.
uploaded_on	uploaded_on	date-time	Fecha y hora en que se cargó el documento.
modified_on	modified_on	date-time	Fecha y hora en que se modificó por última vez el documento.
lock_form_fields	lock_form_fields	boolean	True si se habilita el bloqueo de campos de formulario con la última firma.
certifique	certify		Configuración de firma certificada para el documento.
document_size	document_size	integer	Tamaño del documento cargado en bytes
metadata	metadata		Información de metadatos de pdf del documento cargado
package_name	package_name	string	El nombre del paquete de documentos

CertifyPolicyResponse

Nombre	Ruta de acceso	Tipo	Description
certifique	certify		Certifique la configuración de firma del documento.
lock_form_fields	lock_form_fields	boolean	True si los campos de formulario se van a bloquear en el PDF después de la última firma digital del documento actual.

BulkSignResponse

Nombre	Ruta de acceso	Tipo	Description
estado	status	string
identificador_de_transacción	transaction_id	string

BulkSignStatusResponse

Nombre	Ruta de acceso	Tipo	Description
estado	status	string
Paquetes	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Nombre	Ruta de acceso	Tipo	Description
id	id	integer
nombre	name	string
estado	status	string
acción	action	string	Clave de acción necesaria si existe
error	error	string
porcentaje	percentage	integer
Documentos	documents	array of BulkSignActionDocumentModel	Documentos del paquete actual

BulkSignActionDocumentModel

Nombre	Ruta de acceso	Tipo	Description
id	id	integer
Campos	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Nombre	Ruta de acceso	Tipo
nombre	name	string
hash	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Nombre	Ruta de acceso	Tipo	Description
field_name	field_name	string	Nombre del campo para el que se solicitó la comprobación.
estado	status	string	Devuelve el estado del campo de firma. Los valores son SIGNED, PENDING. El estado ayuda en la firma remota autorizada habilitada para eIDAS. Si la solicitud de firma se envía al dispositivo móvil, el estado está pendiente.
identificador_de_transacción	transaction_id	string	Este parámetro se usa mientras se firma RAS
verificación	verification		Comprobación de firmas
authentication_access_token	authentication_access_token	string	Contendrá el id_token OIDC cuando el usuario se autentique a través de OIDC.

AutoPlaceFieldsResponse

Nombre	Ruta de acceso	Tipo	Description
field_name	field_name	string	Nombre del campo generado automáticamente por la API.

ContactResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	id del contacto.
nombre_de_usuario	user_name	string	Nombre de usuario del contacto.
user_email	user_email	string	Dirección de correo electrónico del contacto.
mobile_number	mobile_number	string	Número móvil del contacto.
empresa	enterprise	boolean	True, si el contacto es enterprise.
user_national_id	user_national_id	string	Número de identidad nacional del contacto
created_on	created_on	string	DateTime cuando se agrega el contacto.

WorkSpaceMembers

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre del miembro del espacio de trabajo
email	email	string	Dirección de correo electrónico del miembro del espacio de trabajo

WorkSpaceResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador del espacio compartido
nombre	name	string	Nombre del espacio compartido
propietario	owner		Propietario del espacio compartido
Miembros	members	array of WorkSpaceMembers	Miembros del espacio compartido

UploadDocumentLibraryResponse

Nombre	Ruta de acceso	Tipo	Description
document_id	document_id	integer	Id. del documento recién creado.
document_name	document_name	string	Nombre del documento.
document_size	document_size	integer	Tamaño del documento cargado en bytes
document_order	document_order	integer	Orden del documento
document_type	document_type	string	Tipo del documento, por ejemplo, "PDF".
document_source	document_source	string	Identifica dónde se cargó el documento, por ejemplo, "Mi aplicación".
document_width	document_width	integer	Ancho del documento en formato PDF.
document_height	document_height	integer	Alto del documento en formato PDF.
document_pages	document_pages	integer	Total de páginas del documento.
uploaded_on	uploaded_on	date-time	Fecha y hora en que se cargó el documento.
modified_on	modified_on	date-time	Fecha y hora en que se modificó por última vez el documento.
form_fields	form_fields	boolean	True si el documento tiene campos de formulario.
lock_form_fields	lock_form_fields	boolean	True si se habilita el bloqueo de campos de formulario con la última firma.
certifique	certify		Configuración de firma certificada para el documento.
template	template		Detalles de la plantilla, si la plantilla se aplica en el documento.
package_name	package_name	string	Nombre del paquete
metadata	metadata		Información de metadatos de pdf del documento cargado

WorkflowHistoryResponse

Nombre	Ruta de acceso	Tipo	Description
package_id	package_id	integer	Identificador del paquete para el que se solicita el historial de flujo de trabajo.
package_name	package_name	string
package_owner	package_owner	string	Dirección de correo electrónico del propietario del paquete.
owner_name	owner_name	string	Nombre del propietario del paquete.
package_status	package_status	string	Estado del paquete o documento con el usuario que ha iniciado sesión. Los valores posibles son "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" o "COMPLETED".
next_signer	next_signer	string	Nombre del siguiente destinatario.
next_signer_email	next_signer_email	array of Next_signer_email	Objeto que tiene el nombre y la dirección de correo electrónico del siguiente destinatario.
Documentos	documents	array of WorkflowDocumentsResponse
Acciones	actions	array of DocumentLogsActions

DocumentLogsActions

Nombre	Ruta de acceso	Tipo	Description
log_id	log_id	integer	Identificador de una acción realizada en el documento.
date_time	date_time	string	Fecha y hora en que se realizó la acción.
action_type	action_type	string
user_email	user_email	string	Correo electrónico del usuario que realizó la acción.
nombre_de_usuario	user_name	string	Nombre del usuario que realizó la acción.
enterprise_name	enterprise_name	string	Nombre de Enterprise al que pertenece el usuario. Si el usuario no pertenece a una empresa, este elemento no está presente.
información	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

Nombre	Ruta de acceso	Tipo	Description
type	type	string	El tipo de información adicional sobre la acción, por ejemplo, "SIGNING_METHOD", lo que significa lo que el usuario del método de firma usó para firmar el documento.
valor	value	string	Valor de la información adicional sobre la acción, por ejemplo, "LOCAL", lo que significa que el usuario firmó el documento mediante credenciales mantenidas localmente.

UpdateCollaboratorResponse

Nombre	Ruta de acceso	Tipo	Description
user_email	user_email	string	Correo electrónico del usuario
signing_order	signing_order	integer	Orden de firma
guest_user	guest_user	boolean	Usuario invitado
email_language_code	email_language_code	string	Código de idioma de correo electrónico

CollaboratorGroupResponse

Nombre	Ruta de acceso	Tipo	Description
permiso	permission		Permisos para el destinatario en el paquete de documentos
recordatorio	reminder		Configuración de recordatorio del destinatario.
signing_order	signing_order	integer	Orden de firma

ColaboradorPlaceholderResponse

Nombre	Ruta de acceso	Tipo	Description
permiso	permission		Permisos para el destinatario en el paquete de documentos
recordatorio	reminder		Configuración de recordatorio del destinatario.
signing_order	signing_order	integer	Orden de firma

FieldsResponse

Nombre	Ruta de acceso	Tipo	Description
firma	signature	array of DigitalSignatureFieldResponse	Lista de todas las firmas digitales del documento.
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
iniciales	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
items	in_person_signature	object
Mensaje de texto	text	array of TextFieldResponse
radio	radio	array of RadioFieldResponse
casilla	checkbox	array of CheckboxFieldResponse
desplegable	dropdown	array of DropdownFieldResponse
listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
archivo adjunto	attachment	array of AttachmentFieldResponse
comentario	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
type	type	string	Si se asigna o no el campo, los valores posibles son ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN y PLACEHOLDER.
process_status	process_status	string	Indica si el campo se procesa o no. Los valores posibles son UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Fecha y hora en la que se procesa el documento.
processed_as	processed_as	string	Usuario que procesó el campo como COLABORADOR, DELEGADO, GROUP_MEMBER o PROPIETARIO.
created_on	created_on	string	Fecha y hora en la que se agrega el campo
processed_by	processed_by	string	Dirección de correo electrónico del usuario que procesó el campo.
dimensions	dimensions	FieldDimenssionResponse
verificación	verification		Devuelve la respuesta de comprobación del campo de firma. En caso de que no haya ninguna comprobación, se devuelve null.
nid	nid	string
Monitor	display	string	Devuelve el valor de visibilidad del campo de firma digital, los valores posibles son "VISIBLE" y "INVISIBLE".
level_of_assurance	level_of_assurance	array of string
autenticación	authentication		Autenticación

FieldDimenssionResponse

Nombre	Ruta de acceso	Tipo	Description
campo	field	FieldResponse
página	page	PageResponse

FieldResponse

Nombre	Ruta de acceso	Tipo	Description
x	x	double	Ubicación izquierda del campo en píxel.
y	y	double	Ubicación superior del campo en píxel.
Ancho	width	double	Ancho del campo en píxel.
altura	height	double	Alto del campo en píxel.

PageResponse

Nombre	Ruta de acceso	Tipo	Description
Ancho	width	float	Ancho de la página donde se coloca el campo en el PDF.
altura	height	float	Alto de la página donde se coloca el campo en el PDF.

HandSignatureFieldResponse

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
type	type	string	Si se asigna o no el campo, los valores posibles son ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN y PLACEHOLDER.
process_status	process_status	string	Indica si el campo se procesa o no. Los valores posibles son UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Fecha y hora en la que se procesa el documento.
processed_as	processed_as	string	Usuario que procesó el campo como COLABORADOR, DELEGADO, GROUP_MEMBER o PROPIETARIO.
processed_by	processed_by	string	Dirección de correo electrónico del usuario que procesó el campo.
dimensions	dimensions	FieldDimenssionResponse
nid	nid	string

ElectronicSignatureFieldResponse

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Dirección de correo electrónico del usuario que procesó el campo.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
type	type	string	Si se asigna o no el campo, los valores posibles son ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN y PLACEHOLDER.
process_status	process_status	string	Indica si el campo se procesa o no. Los valores posibles son UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Fecha y hora en la que se procesa el documento.
processed_as	processed_as	string	Usuario que procesó el campo como COLABORADOR, DELEGADO, GROUP_MEMBER o PROPIETARIO.
processed_by	processed_by	string	Dirección de correo electrónico del usuario que procesó el campo.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	El subtipo de firma puede ser una firma WITNESS. Si las firmas de testigo están habilitadas en el plan de servicio, los campos E-Signature se firman con un certificado común compartido por todos los usuarios del plan de servicio. Los valores posibles son WITNESS o NONE.
autenticación	authentication		Autenticación
verificación	verification		Devuelve la respuesta de comprobación del campo. En caso de que no haya ninguna comprobación, se devuelve null.
nid	nid	string
Monitor	display	string	Devuelve el valor de visibilidad del campo de firma electrónica, los valores posibles son "VISIBLE" y "INVISIBLE".

InitialFieldResponse

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
process_status	process_status	string	Indica si el campo se procesa o no. Los valores posibles son UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Fecha y hora en la que se procesa el documento.
processed_as	processed_as	string	Usuario que procesó el campo como COLABORADOR, DELEGADO, GROUP_MEMBER o PROPIETARIO.
processed_by	processed_by	string	Dirección de correo electrónico del usuario que procesó el campo.
dimensions	dimensions	FieldDimenssionResponse
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.

TextFieldResponse

Nombre	Ruta de acceso	Tipo	Description
field_locale	field_locale	string	Campo local. Los valores posibles son ar-AE \| en-US. Opcional y el valor predeterminado serán en-US. Este valor es importante para el tipo "DATE".
required	required	boolean	True si el campo necesario en pdf
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
tab_order	tab_order	integer	Orden de tabulación en el documento PDF
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
type	type	string	Tipo del campo de texto, los valores posibles son "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".
valor	value	string	Valor del campo. Para el tipo = DATE o format_type = DATE, se espera que el valor siga el formato ISO 8601. Siguiendo el formato AAAA-MM-DD hh:mm:ss +00. Como los valores son para los campos de fecha, las aplicaciones cliente pueden enviar aaaa-MM-DD e ignorar hh:mm:ss +00. Si el valor no tiene el formato adecuado, se devolverá un error.
read_only	read_only	boolean	True, si el campo está marcado como de solo lectura en el documento PDF.
validation_rule	validation_rule	string	Una o varias reglas para la validación de los campos, los valores posibles son "OBLIGATORIO" o "OPCIONAL".
validación	validation		Este objeto es para que se pase value obligatorio.
visible	visible	boolean	True, si el campo no está oculto en el documento PDF.
multilínea	multiline	boolean	True, si el campo es de varias líneas en el documento PDF.
font	font	FontResponse
longitud_máxima	max_length	integer	Longitud máxima del contenido que se puede rellenar en el campo.
format_type	format_type	string	Si field es un cuadro de texto, puede seguir diferentes tipos de entrada. Los valores posibles son ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME o DATE.
marcador de posición	placeholder	string	Texto del marcador de posición para el campo del cuadro de texto.
format	format	string	Formato de texto del campo. Solo se usa para el campo de tipo de fecha. Los valores posibles son: m/d m/d/yy m/d/aaaa mm/dd/aaaa dd/mm/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-aaaa d-mmm-aaaa dd-mmm-aaaa dd-mmm-aaaa yy-mm-dd aaaa-mm-dd mmm-aaaa mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyy
color	color	string	Color del texto en los campos de formulario.
border_color	border_color	string	Color del borde del campo de formulario.
información sobre herramientas	tooltip	string	información sobre herramientas del campo de formulario.
field_rotation	field_rotation	integer	Rotación de campos
alinear	align	string	Alineación de texto para el campo de formulario. Los valores posibles son "RIGHT", "LEFT", "CENTER" o "JUSTIFY"
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Nombre	Ruta de acceso	Tipo	Description
required	required	boolean	True si el campo necesario en pdf
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
tab_order	tab_order	integer	Orden de tabulación en el documento PDF.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
type	type	string
valor	value	boolean	Valor del campo.
read_only	read_only	boolean	True, si el campo está marcado como de solo lectura en el documento PDF.
validation_rule	validation_rule	string	Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
radio_group_name	radio_group_name	string	Nombre de grupo al que pertenece el campo.
Comprobado	checked	boolean	True, si el campo está seleccionado
visible	visible	boolean	True si el campo no está oculto en el documento PDF.
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Color del texto en los campos de formulario.
border_color	border_color	string	Color del borde del campo de formulario.
información sobre herramientas	tooltip	string	información sobre herramientas del campo de formulario.
field_rotation	field_rotation	integer	Rotación de campos

CheckboxFieldResponse

Nombre	Ruta de acceso	Tipo	Description
required	required	boolean	True si el campo necesario en pdf
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
tab_order	tab_order	integer	Orden de tabulación en el documento PDF
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
type	type	string
valor	value	boolean	Valor del campo.
read_only	read_only	boolean	True, si el campo está marcado como de solo lectura en el documento PDF.
Comprobado	checked	boolean	True si el campo está seleccionado.
visible	visible	boolean	True si el campo no está oculto en el documento PDF.
validation_rule	validation_rule	string	Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Color del texto en los campos de formulario.
border_color	border_color	string	Color del borde del campo de formulario.
información sobre herramientas	tooltip	string	información sobre herramientas del campo de formulario.
field_rotation	field_rotation	integer	Rotación de campos

DropdownFieldResponse

Nombre	Ruta de acceso	Tipo	Description
required	required	boolean	True si el campo necesario en pdf
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
tab_order	tab_order	integer	Orden de tabulación en el documento PDF.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
validation_rule	validation_rule	string	Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
read_only	read_only	boolean	True, si el campo está marcado como de solo lectura en el documento PDF.
valor	value	string	Valor del campo .
opciones	choices	array of string	Opciones disponibles para la lista desplegable para elegir un valor.
visible	visible	boolean	True, si el campo no está oculto en el documento PDF.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Color del texto en los campos de formulario.
border_color	border_color	string	Color del borde del campo de formulario.
información sobre herramientas	tooltip	string	información sobre herramientas del campo de formulario.
field_rotation	field_rotation	integer	Rotación de campos

ListBoxFieldResponse

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Orden del destinatario al que se asigna este campo. Si el campo no está asignado a nadie, el valor será NULL.
tab_order	tab_order	integer	Orden de tabulación en el documento PDF.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
incrustado	embedded	boolean	True, si el campo forma parte del documento PDF.
validation_rule	validation_rule	string	Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
read_only	read_only	boolean	True, si el campo está marcado como de solo lectura en el documento PDF.
valor	value	string	Valor del campo.
opciones	choices	array of string	Opciones disponibles para la lista desplegable para elegir un valor.
visible	visible	boolean	True, si el campo no está oculto en el documento PDF.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Color del texto en los campos de formulario.
border_color	border_color	string	Color del borde del campo de formulario.
información sobre herramientas	tooltip	string	información sobre herramientas del campo de formulario.
field_rotation	field_rotation	integer	Rotación de campos

FontResponse

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre de fuente del campo de texto. Para los campos definidos por el usuario SigningHub solo admiten "COURIER", "HELVETICA". En el caso de los campos existentes en un archivo PDF, el valor de fuente puede ser cualquier cosa que se establezca en el PDF.
tamaño	size	integer	Tamaño de fuente del campo de texto.
embedded_size	embedded_size	double	Tamaño de la fuente en el documento PDF original.

QrCodeResponse

Nombre	Ruta de acceso	Tipo	Description
field_name	field_name	string	Identificador único del campo.
type	type	string	Tipo de campo PDF_FIELD_TYPE como QR
page_no	page_no	integer	Número de página del documento en el que existe el campo.
valor	value	string	QrCode generado en base64 se proporcionará de forma automática en modo borrador
dimensions	dimensions	FieldDimenssionResponse
datos	data	string	Los datos de texto sin formato que se van a codificar en el código QR. El valor predeterminado es la dirección URL generada para acceder al documento relacionado. Por ejemplo, {base_url}/document/{document_unique_id}
options	options		Configuración con respecto a las opciones
color	color		Configuración con respecto al color
logotipo	logo		Configuración con respecto al logotipo

AttachmentFieldResponse

Nombre	Ruta de acceso	Tipo	Description
order	order	integer	Orden del destinatario al que se asigna este campo.
display_order	display_order	integer	Mostrar el orden según el visor de SigningHub.
field_name	field_name	string	Identificador único del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
process_status	process_status	string	Indica si el campo se procesa o no. Los valores posibles son UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Fecha y hora en la que se procesa el documento.
processed_as	processed_as	string	Usuario que procesó el campo como COLABORADOR, DELEGADO, GROUP_MEMBER o PROPIETARIO.
processed_by	processed_by	string	Dirección de correo electrónico del usuario que procesó el campo.
attachmentRefId	attachmentRefId	integer	Attachmet ref id
nota	note	string	Attachmet note Only in case of "MANDATORY" attachment rule
validation_rule	validation_rule		Una o varias reglas para la validación de los campos posibles valores son "OBLIGATORIO" o "OPCIONAL".
dimensions	dimensions		Dimentions

CommentFieldResponse

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Id. de campo de comentario
page_no	page_no	integer	Número de página del documento en el que existe el campo.
unread_count	unread_count	integer	Comentarios no leídos
privado	private	boolean	Privada
destinatarios	recipients	array of CommentFieldRecipientResponse	Recipientes
dimensions	dimensions		Dimensiones

UniqueIdentifierFieldResponse

Nombre	Ruta de acceso	Tipo	Description
field_name	field_name	string	Identificador único del campo.
valor	value	string	Valor del campo.
page_no	page_no	integer	Número de página del documento en el que existe el campo.
font	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

Nombre	Ruta de acceso	Tipo	Description
nombre_de_usuario	user_name	string	Nombre de usuario
user_email	user_email	string	Correo electrónico del usuario

object

Este es el tipo 'objeto'.