Compartir a través de

SignNow

SignNow permite flujos de trabajo seguros, compatibles y listos para auditoría para empresas, legal, RR. HH., atención sanitaria y equipos financieros. Envíe y realice un seguimiento de las solicitudes de firma en el orden basado en roles, rellene previamente los campos de documentos y administre grupos de documentos mediante el conector SignNow.

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

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC 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 China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Centro de ayuda
URL https://support.signnow.com/
Correo Electrónico integrations@pdffiller.com
Metadatos del conector
Publicador DaDaDocs
Website https://signnow.com
Directiva de privacidad https://www.signnow.com/privacy_policy
Categorías Productividad; Recursos humanos

Conector de SignNow

SignNow permite flujos de trabajo seguros, compatibles y listos para auditoría para empresas, legal, RR. HH., atención sanitaria y equipos financieros. Envíe y realice un seguimiento de las solicitudes de firma en el orden basado en roles, rellene previamente los campos de documentos y administre grupos de documentos mediante el conector SignNow.

Requisitos previos

Necesitará una cuenta de SignNow y una suscripción a la API de SignNow para continuar.

Implementación del ejemplo

En primer lugar, actualice el valor clientId en el apiProperties.json con el suyo propio.

Ejecute los siguientes comandos y siga las indicaciones:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Acciones y desencadenadores admitidos

Consulte la documentación para obtener más información.

Limitaciones

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

Acciones

Cancelar invitación

Cancelación de invitación de firma
Cargar documento

Carga de un documento en SignNow
Creación de un documento a partir de una plantilla

Generación de un documento a partir de una plantilla seleccionada
Creación de un grupo de documentos a partir de la plantilla de grupo

Crear el grupo de documentos a partir de una plantilla de grupo seleccionada
Creación de un grupo de documentos a partir de varios archivos

Cree un grupo de documentos cargando varios archivos como cadenas codificadas en base64.
Crear invitación insertada de documento

Esta acción crea una invitación de firma incrustada para un documento. Una vez creada la invitación, genere un vínculo de firma incrustado.
Crear invitación insertada de grupo de documentos

Esta acción crea una invitación de firma incrustada para un grupo de documentos. Una vez creada la invitación, genere un vínculo de firma incrustado.
Crear vínculo de envío incrustado de documentos

Esta acción genera un vínculo de envío incrustado para un documento específico, lo que permite a los usuarios de terceros preparar y enviar el documento para la firma.
Crear vínculo de envío incrustado de grupo de documentos

Esta acción genera un vínculo de envío incrustado para un grupo de documentos específico, lo que permite a los usuarios de terceros preparar y enviar el grupo de documentos para la firma.
Crear vínculo de firma

Generar un vínculo al documento y compartirlo para que el documento esté firmado
Descargar documento

Descargar un documento de SignNow
Eliminar documento

Eliminación de un documento de SignNow
Eliminar invitación insertada de documento

Esta acción elimina una invitación incrustada para un documento.
Eliminar invitación insertada de grupo de documentos

Esta acción elimina una invitación incrustada para un grupo de documentos específico.
En desuso: invitación avanzada a documentos

La acción está en desuso. Invite request with manualmente defined schema (Invitar solicitud con esquema definido manualmente). Permite configurar la invitación para un documento que se generará en el futuro.
En desuso: invitación para firmar el grupo de documentos

La acción está en desuso. Invitar a otros usuarios a rellenar y firmar el grupo de documentos
En desuso: invitar a firmar

La acción está en desuso. Invitar a otros usuarios a rellenar y firmar el documento
Generar vínculo de invitación incrustado de grupo de documentos

Esta acción genera un vínculo para la invitación insertada del grupo de documentos.
Generar vínculo de invitación insertado de documento

Esta acción genera un vínculo para la invitación insertada del documento.
Invitar a firmar documento

Esta acción crea y envía una invitación de campo para que se firme un documento.
Invitar a firmar grupo de documentos

Esta acción crea una invitación para firmar un grupo de documentos. Puede configurar un flujo de trabajo de varios pasos, donde diferentes destinatarios actúan en el grupo de documentos en distintas fases.
Obtener campos de documento

Recuperar valores de los campos rellenables en el documento
Obtener campos de documento [EN DESUSO]

Esta acción ha quedado en desuso. Use Obtener campos de documento en su lugar.

Obtiene los valores de campo del documento.
Obtener el estado de invitación de documento

Esta acción recupera información sobre una invitación de documento, incluido el estado de cada paso y acción.
Obtener el estado de invitación del grupo de documentos

Esta acción recupera información sobre una invitación de grupo de documentos, incluido el estado de cada paso y acción.
Obtener esquema de documento [EN DESUSO]

Esta acción ha quedado en desuso. En su lugar, use Get document schema (Obtener esquema de documento ).

Obtención del esquema de documentos de OpenAPI
Obtener grupo de documentos

Recuperar una lista de grupos de documentos del usuario
Obtener grupos de documentos

Recuperar una lista de grupos de documentos del usuario
Obtener información del documento

Obtenga propiedades de documento como name, id, create/update dates, etc.
Obtener lista de documentos

Recuperar una lista de documentos del usuario
Prerrellenar valores de campo de documento

Rellenar automáticamente los campos rellenables en el documento con valores específicos
Prerrellenar valores de campo de documento [EN DESUSO]

Esta acción ha quedado en desuso. En su lugar, use prerrellenar valores de campo de documento .

Rellenar previamente los valores y propiedades del campo.
Prerrellenar valores de campo del grupo de documentos

Rellenar automáticamente los campos rellenables en los documentos con valores específicos
Prerrellenar valores de campo inteligente

Rellenar previamente los valores del campo inteligente para el documento especificado
Reemplazar destinatarios en invitación de documento

Esta acción reemplaza a los destinatarios de la invitación del documento en función de sus roles. También permite actualizar la configuración de invitación, como el tipo de autenticación, los días de expiración y otros parámetros avanzados para cada rol.
Reemplazar destinatarios en invitación de grupo de documentos

Esta acción reemplaza a los destinatarios de una invitación de grupo de documentos por su identificador de invitación. También puede establecer una expiración de invitación, recordatorios, reasignar permisos y opciones de rechazo para cada documento.
Rellenar previamente los valores de campo inteligente del grupo de documentos

Rellenar automáticamente campos inteligentes en los documentos con valores específicos

Cancelar invitación

Id. de la operación:
CancelInvite

Cancelación de invitación de firma

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 doc_id True string

Especificar el identificador de documento para la cancelación de invitación de firma

Devoluciones

response
object

Cargar documento

Id. de la operación:
UploadDocument

Carga de un documento en SignNow

Parámetros

Nombre Clave Requerido Tipo Description
Archivo
 file True file

Archivo que se va a cargar

Devoluciones

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

Identificador de documento único

Creación de un documento a partir de una plantilla

Id. de la operación:
CreateFromTemplate

Generación de un documento a partir de una plantilla seleccionada

Parámetros

Nombre Clave Requerido Tipo Description
Plantilla de documento
 doc_id True string

Selección de una plantilla de la lista
Nombre del documento
 document_name string

Escriba el nuevo nombre de archivo para el documento.

Devoluciones

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

Identificador de documento único

Creación de un grupo de documentos a partir de la plantilla de grupo

Id. de la operación:
CreateFromTemplateGroup

Crear el grupo de documentos a partir de una plantilla de grupo seleccionada

Parámetros

Nombre Clave Requerido Tipo Description
Plantilla de grupo
 doc_group_id True string

Seleccione la plantilla de grupo de la lista.
Nombre del grupo de documentos
 group_name string

Escriba un nuevo nombre para el grupo de documentos.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de grupo de documentos
 id DocumentGroupId

Identificador de grupo de documentos único

Creación de un grupo de documentos a partir de varios archivos

Id. de la operación:
CreateDocGroupFromFiles

Cree un grupo de documentos cargando varios archivos como cadenas codificadas en base64.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del grupo de documentos
 group_name True string

Escriba un nombre para el grupo de documentos.
Nombre del documento
 name True string

Nombre del documento con extensión: Report.pdf, Letter.docx etc.
Contenido del archivo
 content True string

Cadena codificada en Base64 que representa el contenido del documento

Devoluciones

Body
CreateDocumentGroupFromFilesResponse

Crear invitación insertada de documento

Id. de la operación:
CreateEmbeddedInvites

Esta acción crea una invitación de firma incrustada para un documento. Una vez creada la invitación, genere un vínculo de firma incrustado.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 id True string

Id. de documento
Correo electrónico del firmante
 email True email

Dirección de correo electrónico del destinatario
Rol
 role True string

Nombre de rol de destinatario, por ejemplo, "Firmante 1" (no se admiten roles de visor)
Pedido
 order True integer

Orden de firma
Fórmula de nombre
 name_formula string

Fórmula para generar un nombre de documento completado mediante un prefijo (cualquier texto) y datos de campo rellenables. Ejemplo: 'Contract|signer_name|signed_date', donde 'Contract' es el prefijo y 'signer_name' y 'signed_date' son nombres de campos rellenables
Rol
 role True string

Nombre de rol de destinatario, por ejemplo, "Firmante 1" (no se admiten roles de visor)
Language
 language string

Especifica el idioma de la sesión de firma y los correos electrónicos de notificación del firmante. Valores posibles: En para inglés, es para español y fr para francés. Si no se establece, el idioma viene determinado por el idioma de la cuenta de SignNow.
Nombre
 first_name string

Nombre del destinatario
Apellido
 last_name string

Apellidos del destinatario
Nombre de firma preestablecido obligatorio
 required_preset_signature_name string

Texto rellenado previamente para el campo de firma, bloqueado para su edición por el destinatario. No se puede usar con "prefill_signature_name" o "force_new_signature".
Nombre de firma de prerrellenar
 prefill_signature_name string

Cadena con un nombre de firma que aparece cuando un firmante hace clic en un campo de firma. El firmante puede editar la firma.
Requerir nueva firma
 force_new_signature boolean

Define si el firmante puede usar su firma guardada o no. Si se establece en "true", el firmante debe agregar una nueva firma. Si se establece en "false", el firmante puede usar la firma guardada.
Uri de redirección
 redirect_uri string

Vínculo que se abre una vez completada la sesión de firma
Rechazar URI de redirección
 decline_redirect_uri string

Vínculo que se abre después de que el destinatario rechaza firmar el documento.
Cerrar URI de redirección
 close_redirect_uri string

Vínculo que se abre cuando el destinatario hace clic en Guardar progreso y Finalizar más tarde durante una sesión de firma o Cerrar en modo de vista
Destino de redireccionamiento
 redirect_target string

Determina si se va a abrir el URI de redireccionamiento en una nueva pestaña del explorador o en la misma pestaña después de la sesión de firma. Valores posibles: "En la nueva pestaña" – abre el vínculo en una nueva pestaña, "En la misma pestaña" - abre el vínculo en la misma pestaña.
Tipo de autenticación
 authentication_type string

Tipo de autenticación usado para la autenticación de destinatarios durante la sesión de firma. Valores permitidos: 'Contraseña', 'Llamada telefónica' y 'Sms'
Contraseña de autenticación
 authentication_password string

Contraseña establecida para la autenticación del firmante. Obligatorio para el tipo de autenticación "Password"
Teléfono de autenticación
 authentication_phone string

Número de teléfono usado para autenticar el firmante. Obligatorio para el tipo de autenticación "Llamada telefónica" y "Sms". Ejemplo: +1XXXXXXXXXXXX
Mensaje sms de autenticación
 authentication_sms_message string

Mensaje sms personalizado enviado al firmante, que contiene el marcador de posición {password}. Se usa con el tipo de autenticación "Sms". Sin este parámetro, el firmante recibe un sms predeterminado con una contraseña generada automáticamente (código de desbloqueo): "SignNow document invite unlock code: 123456" Example: Enter the password {password} to unlock your document
Tipo de entrega
 delivery_type string

Define cómo se envía la invitación.
Expiración del vínculo
 link_expiration integer

En cuántos minutos expira la invitación de correo electrónico. Solo se puede usar si "Delivery type=email". Intervalo válido: 15–43200 minutos
Expiración de sesión
 session_expiration integer

En cuántos minutos expira la sesión de firma. Si se genera un vínculo para esta invitación, se restablece la expiración de la sesión. Solo se aplica cuando "Delivery type=email" y para las acciones "sign". Intervalo válido: 15–1440 minutos
Firma QES
 signature string

Tipo de QES. Valores posibles: 'Eideasy', 'Nom151'. Se usa para solicitar firmas QES de firmantes. Todos los firmantes de la invitación deben usar el mismo tipo de firma. Para crear una invitación con QES, el usuario debe pertenecer a una organización con QES habilitado

Devoluciones

Nombre Ruta de acceso Tipo Description
datos
 data array of object

Data
Id
 data.id string

Identificador de la invitación insertada creada
Correo Electrónico
 data.email string

Correo electrónico del destinatario
Id. de rol
 data.role_id string

Id. de rol de destinatario
Pedido
 data.order integer

Orden de firma del destinatario
Estado
 data.status string

Estado de invitación incrustado

Crear invitación insertada de grupo de documentos

Id. de la operación:
CreateDocGroupEmbeddedInvites

Esta acción crea una invitación de firma incrustada para un grupo de documentos. Una vez creada la invitación, genere un vínculo de firma incrustado.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo de documentos
 id True string

Id. de grupo de documentos
Pedido
 order True integer

Paso de pedido de firma. Todos los firmantes asignados a un paso específico order (por ejemplo, order: 1) reciben el correo electrónico de invitación simultáneamente. Los correos electrónicos del siguiente paso de pedido (por ejemplo, order: 2) solo se envían después de que se completen todas las acciones del paso de pedido anterior.
Correo Electrónico
 email True string

Dirección de correo electrónico del destinatario
Id. de documento
 id True string

Identificador del documento
Rol
 role string

Rol de destinatario en el documento. No se deben especificar roles para la acción 'view'
Acción
 action True string

Acción necesaria del destinatario en el documento. Valores permitidos: 'sign', 'view'
Pedido
 order True string

Paso de pedido de firma
Correo Electrónico
 email True string

Dirección de correo electrónico del destinatario
Language
 language string

Especifica el idioma de la sesión de firma y los correos electrónicos de notificación del firmante. Valores posibles: En para inglés, es para español y fr para francés. Si no se establece, el idioma viene determinado por el idioma de la cuenta de SignNow.
Nombre
 first_name string

Nombre del destinatario
Apellido
 last_name string

Apellidos del destinatario
Nombre de firma preestablecido obligatorio
 required_preset_signature_name string

Texto rellenado previamente para el campo de firma, bloqueado para su edición por el destinatario
Uri de redirección
 redirect_uri string

Vínculo que se abre una vez completada la sesión de firma
Rechazar URI de redirección
 decline_redirect_uri string

Vínculo que se abre después de que el destinatario rechaza firmar el documento.
Cerrar URI de redirección
 close_redirect_uri string

Vínculo que se abre cuando el destinatario hace clic en Guardar progreso y Finalizar más tarde durante una sesión de firma o Cerrar en modo de vista
Destino de redireccionamiento
 redirect_target string

Determina si se va a abrir el URI de redireccionamiento en una nueva pestaña del explorador o en la misma pestaña después de la sesión de firma. Valores posibles: "En la nueva pestaña" – abre el vínculo en una nueva pestaña, "En la misma pestaña" - abre el vínculo en la misma pestaña.
Tipo de entrega
 delivery_type string

Define cómo se envía la invitación.
Expiración del vínculo
 link_expiration integer

En cuántos minutos expira la invitación de correo electrónico. Solo se puede usar si "Delivery type=email". Intervalo válido: 15–43200 minutos
Expiración de sesión
 session_expiration integer

En cuántos minutos expira la sesión de firma. Si se genera un vínculo para esta invitación, se restablece la expiración de la sesión. Solo se aplica cuando "Delivery type=email" y para las acciones "sign". Intervalo válido: 15–1440 minutos
Tipo de autenticación
 authentication_type string

Tipo de autenticación usado para la autenticación de destinatarios durante la sesión de firma. Valores permitidos: 'Contraseña', 'Llamada telefónica' y 'Sms'
Contraseña de autenticación
 authentication_password string

Contraseña establecida para la autenticación del firmante. Obligatorio para el tipo de autenticación "Password"
Teléfono de autenticación
 authentication_phone string

Número de teléfono usado para autenticar el firmante. Obligatorio para el tipo de autenticación "Llamada telefónica" y "Sms". Ejemplo: +1XXXXXXXXXXXX
Mensaje sms de autenticación
 authentication_sms_message string

Mensaje sms personalizado enviado al firmante, que contiene el marcador de posición {password}. Se usa con el tipo de autenticación "Sms". Sin este parámetro, el firmante recibe un sms predeterminado con una contraseña generada automáticamente (código de desbloqueo): "SignNow document invite unlock code: 123456". Ejemplo: Escriba la contraseña {password} para desbloquear el documento
Firma QES
 signature string

Tipo de QES. Valores posibles: 'Eideasy', 'Nom151'. Se usa para solicitar firmas QES de firmantes. Todos los firmantes de la invitación deben usar el mismo tipo de firma. Para crear una invitación con QES, el usuario debe pertenecer a una organización con QES habilitado

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de invitación
 id string

Identificador de la invitación insertada creada

Crear vínculo de envío incrustado de documentos

Id. de la operación:
CreateEmbeddedInviteSettingsLink

Esta acción genera un vínculo de envío incrustado para un documento específico, lo que permite a los usuarios de terceros preparar y enviar el documento para la firma.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 id True string

Id. de documento
Tipo
 type string

Especifica el paso de envío en el que se debe abrir el vínculo. Valores posibles: 'Invitar': abre la página Enviar invitación para el documento, donde el usuario puede agregar correos electrónicos de firmante, asunto, mensaje, etc. 'Documento': abre el documento en el editor para agregar campos rellenables y, a continuación, abre la página Enviar invitación.
Uri de redirección
 redirect_uri string

Página que se abre después de configurar el envío incrustado. Obligatorio si se agrega "Destino de redirección"
Expiración del vínculo
 link_expiration integer

Especifica cuántos minutos permanecerá activo el vínculo. Intervalo permitido: de 15 a 45 minutos. Los usuarios de nivel de administrador pueden establecer la duración hasta un máximo de 43200 minutos.
Destino de redireccionamiento
 redirect_target string

Determina si se va a abrir el URI de redireccionamiento en una nueva pestaña del explorador o en la misma pestaña después de la sesión de firma. Valores posibles: "En la nueva pestaña" – abre el vínculo en una nueva pestaña, "En la misma pestaña" - abre el vínculo en la misma pestaña.

Devoluciones

Nombre Ruta de acceso Tipo Description
URL
 url string

Vínculo al envío de documentos insertados

Crear vínculo de envío incrustado de grupo de documentos

Id. de la operación:
CreateDocGroupEmbeddedInviteSettingsLink

Esta acción genera un vínculo de envío incrustado para un grupo de documentos específico, lo que permite a los usuarios de terceros preparar y enviar el grupo de documentos para la firma.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo de documentos
 id True string

Id. de grupo de documentos
Tipo
 type string

Especifica el paso de envío en el que debe abrirse el vínculo incrustado: "administrar" : abre el vínculo en la página Agregar documentos al grupo de documentos; 'editar': abre el vínculo en el editor; 'send-invite': abre el vínculo en la página Enviar invitación
Uri de redirección
 redirect_uri string

Página que se abre después de configurar el envío incrustado. Obligatorio si se agrega "Destino de redirección"
Expiración del vínculo
 link_expiration integer

Especifica cuántos minutos permanecerá activo el vínculo. Intervalo permitido: de 15 a 45 minutos. Los usuarios de nivel de administrador pueden establecer la duración hasta un máximo de 43200 minutos.
Destino de redireccionamiento
 redirect_target string

Determina si se va a abrir el URI de redireccionamiento en una nueva pestaña del explorador o en la misma pestaña después de la sesión de firma. Valores posibles: "En la nueva pestaña" – abre el vínculo en una nueva pestaña, "En la misma pestaña" - abre el vínculo en la misma pestaña.

Devoluciones

Nombre Ruta de acceso Tipo Description
URL
 url string

Vínculo al grupo de documentos incrustado que envía

Crear vínculo de firma

Id. de la operación:
CreateSigningLink

Generar un vínculo al documento y compartirlo para que el documento esté firmado

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 doc_id True string

Especificar un identificador de documento único o seleccionar un documento de la lista
fields
 fields dynamic

Devoluciones

Nombre Ruta de acceso Tipo Description
URL
 url_no_signup string

Vínculo de firma

Descargar documento

Id. de la operación:
DownloadDocument

Descargar un documento de SignNow

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 doc_id True string

Especificar un identificador de documento único o seleccionar un documento de la lista
Formato
 mode string

Selección de un formato de documento para descargar

Devoluciones

response
binary

Eliminar documento

Id. de la operación:
DeleteDoc

Eliminación de un documento de SignNow

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 doc_id True string

Especificar un identificador de documento único

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado de eliminación de documentos

Eliminar invitación insertada de documento

Id. de la operación:
DeleteEmbeddedInvites

Esta acción elimina una invitación incrustada para un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 id True string

Id. de documento

Eliminar invitación insertada de grupo de documentos

Id. de la operación:
DeleteDocGroupEmbeddedInvites

Esta acción elimina una invitación incrustada para un grupo de documentos específico.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo de documentos
 id True string

Id. de grupo de documentos

En desuso: invitación avanzada a documentos

Id. de la operación:
SendUserDefinedInvite

La acción está en desuso. Invite request with manualmente defined schema (Invitar solicitud con esquema definido manualmente). Permite configurar la invitación para un documento que se generará en el futuro.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 doc_id True string

Proporcionar un identificador de documento
Nombre
 role string

Nombre de rol del firmante
Correo electrónico
 email email

Especificar correo electrónico para el firmante
Número de teléfono (Invitar a través de SMS)
 phone_invite string

Especifique el número de teléfono del destinatario +XXXXXXXXXXXX. Obligatorio para Invitar a través de SMS.
Pedido
 order integer

Establecer el orden de firma de varios firmantes
Asunto personalizado
 subject string

Agregar asunto personalizado para el firmante
Mensaje personalizado
 message string

Agregar mensaje personalizado para el firmante
Tipo de autenticación
 authentication_type string

Comprobación de la identidad del usuario mediante contraseña, SMS o llamada telefónica
Contraseña
 password string

Establecer la contraseña del tipo de autenticación Contraseña
Teléfono
 phone string

Especificar el número de teléfono +XXXXXXXXXXXX para tipo de autenticación Teléfono o SMS
Días hasta la expiración
 expiration_days integer

Obtener el firmante recibir una notificación en cuántos días expira la invitación
Enviar recordatorio en
 reminder integer

Número de días después de enviar la invitación para realizar un seguimiento automático con un recordatorio de correo electrónico
Enviar recordatorio cada X días
 remind_repeat integer

El destinatario recibirá un correo electrónico de recordatorio cada cantidad de días establecida.
Permitir reenvío
 reassign boolean

Permitir que el firmante delegue la firma a otra persona
Mostrar rechazo en la firma
 decline_by_signature boolean

Marcar un campo de firma como Rechazar para firmar si el destinatario se negó a firmar el documento
CC
 cc string

Mensajes de correo electrónico separados por comas que se copiarán en la invitación
Asunto
 subject string

Escriba el asunto.
Message
 message string

Escriba el mensaje.
Enviar un correo electrónico a todas las partes al finalizar
 on_complete string

Todas las partes reciben un correo electrónico de notificación cuando se firma el documento

Devoluciones

response
object

En desuso: invitación para firmar el grupo de documentos

Id. de la operación:
SendGroupInvite

La acción está en desuso. Invitar a otros usuarios a rellenar y firmar el grupo de documentos

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template True boolean

Especificar si se deben recuperar grupos de documentos o plantillas de grupo
Grupo de documentos
 template_group_id True string

Seleccione el grupo de documentos de la lista.
body
 body True dynamic

Devoluciones

response
object

En desuso: invitar a firmar

Id. de la operación:
SendInvite

La acción está en desuso. Invitar a otros usuarios a rellenar y firmar el documento

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template True boolean

Especificar si se deben recuperar documentos o plantillas
Documento
 template_id True string

Selección de una plantilla de la lista
body
 body True dynamic

Devoluciones

response
object

Generar vínculo de invitación incrustado de grupo de documentos

Id. de la operación:
GenerateDocGroupEmbeddedInviteLink

Esta acción genera un vínculo para la invitación insertada del grupo de documentos.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo de documentos
 id True string

Id. de grupo de documentos
Id. de invitación insertado del grupo de documentos
 invite_id True string

Id. de la invitación insertada del grupo de documentos de la acción "Crear invitación insertada de grupo de documentos"
Correo Electrónico
 email True email

Dirección de correo electrónico del destinatario
Expiración del vínculo
 link_expiration integer

Especifica cuántos minutos permanecerá activo el vínculo. Intervalo válido:15-45 minutos
Expiración de sesión
 session_expiration integer

Especifica cuántos minutos permanecerá activa la sesión de firma. Intervalo válido:15-1440 minutos

Devoluciones

Nombre Ruta de acceso Tipo Description
Vínculo de invitación incrustado
 link string

Vínculo para la invitación insertada del grupo de documentos

Generar vínculo de invitación insertado de documento

Id. de la operación:
GenerateEmbeddedInviteLink

Esta acción genera un vínculo para la invitación insertada del documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 id True string

Id. de documento
Id. de invitación de campo
 field_invite_id True string

Id. de invitación insertado de la acción "Crear invitación insertada de documento"
Expiración del vínculo
 link_expiration integer

Especifica cuántos minutos permanecerá activo el vínculo. Intervalo válido:15-45 minutos
Expiración de sesión
 session_expiration integer

Especifica cuántos minutos permanecerá activa la sesión de firma. Intervalo válido:15-1440 minutos

Devoluciones

Nombre Ruta de acceso Tipo Description
Link
 data.link string

Vínculo de invitación insertado generado para el documento

Invitar a firmar documento

Id. de la operación:
InviteToSignAllOptions

Esta acción crea y envía una invitación de campo para que se firme un documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 id True string

Id. de documento
Correo Electrónico
 email string

Dirección de correo electrónico del destinatario
Grupo de correo electrónico
 email_group string

Un grupo de usuarios que deben recibir la invitación. Cuando uno de los usuarios firma el documento, se considera completado. Debe usarse con el parámetro avanzado "grupos de correo electrónico". Obligatorio si no se agrega 'Email' o 'Phone Invite', pero no se puede usar al mismo tiempo con cualquiera de estos parámetros.
Invitación de teléfono
 phone_invite string

Número de teléfono del destinatario. Obligatorio para invitar a través de SMS
Rol
 role True string

Nombre del rol de destinatario. Por ejemplo, Firmante 1, Firmante 2
Pedido
 order True integer

Orden de firma. El orden de firma define la secuencia en la que los destinatarios deben firmar o rellenar un documento. Una vez que todos los destinatarios de un paso de pedido completen la firma, el documento continúa con el siguiente paso de orden (por ejemplo, 2, 3). Varios destinatarios pueden compartir el mismo orden de firma
Rol
 role True string

Nombre de rol de destinatario, usado para asignar parámetros avanzados
Nombre de firma de prerrellenar
 prefill_signature_name string

Texto rellenado previamente en el campo de firma, disponible para su edición por firmante
Nombre de firma preestablecido obligatorio
 required_preset_signature_name string

Texto rellenado previamente para el campo de firma, bloqueado para su edición por el destinatario. No se puede usar con "Prerrellenar nombre de firma" o "Requerir nueva firma".
Requerir nueva firma
 force_new_signature boolean

Define si el firmante puede usar una firma guardada. False: el firmante puede usar una firma guardada; True: el firmante debe crear una nueva firma.
Permitir reenvío
 reassign boolean

Define si el destinatario puede reenviar la invitación a otra dirección de correo electrónico. 'true': el destinatario puede reenviar la invitación; 'false': el destinatario no puede reenviar la invitación
Permitir rechazar por firma
 decline_by_signature boolean

Define si se va a mostrar la opción Rechazar a firmar en los campos de firma. True : muestra la opción de rechazo; false: ocultar la opción de rechazo
Enviar recordatorio en X días
 remind_after integer

X días después de la invitación, un recepiente recibe un correo electrónico de recordatorio (de 1 a 179 días). Debe ser menor que "Días hasta la expiración".
Enviar recordatorio en X días antes de la expiración
 remind_before integer

X días antes de la expiración, un recepiente obtiene un correo electrónico de recordatorio (de 1 a 179 días). Debe ser menor que "Días hasta la expiración".
Enviar recordatorio cada X días
 remind_repeat integer

Un recepiente recibe un correo electrónico de recordatorio cada x días después de enviar la invitación (de 1 a 7 días)
Días hasta la expiración
 expiration_days integer

En X días, la invitación expira (de 3 a 180 días)
Tipo de autenticación
 authentication_type string

Tipo de autenticación usado para la autenticación de destinatarios durante la sesión de firma. Valores permitidos: 'Contraseña', 'Llamada telefónica' y 'Sms'
Contraseña de autenticación
 password string

Contraseña establecida para la autenticación del firmante. Obligatorio para el tipo de autenticación "Password"
Teléfono de autenticación
 phone string

Número de teléfono usado para autenticar el firmante. Obligatorio para el tipo de autenticación "Llamada telefónica" y "Sms". Ejemplo: +1XXXXXXXXXXXX
Mensaje sms de autenticación
 authentication_sms_message string

Mensaje sms personalizado enviado al firmante, que contiene el marcador de posición {password}. Se usa con el tipo de autenticación "Sms". Sin este parámetro, el firmante recibe un sms predeterminado con una contraseña generada automáticamente (código de desbloqueo): "SignNow document invite unlock code: 123456". Ejemplo: Escriba la contraseña {password} para desbloquear el documento
Asunto
 subject string

Asunto de correo electrónico personalizado para el destinatario
Message
 message string

Mensaje de correo electrónico personalizado para el destinatario
Uri de redirección
 redirect_uri string

Cuando se completan y firman todos los campos solicitados, el firmante se redirige a este URI.
Destino de redireccionamiento
 redirect_target string

Determina si se va a abrir el URI de redireccionamiento en una nueva pestaña del explorador o en la misma pestaña después de la sesión de firma. Valores posibles: "En la nueva pestaña" – abre el vínculo en una nueva pestaña, "En la misma pestaña" - abre el vínculo en la misma pestaña.
Rechazar URI de redirección
 decline_redirect_uri string

Vínculo que se abre después de que el destinatario haya rechazado el documento.
Cerrar URI de redirección
 close_redirect_uri string

Vínculo que se abre cuando el destinatario hace clic en Guardar progreso y Finalizar más tarde durante una sesión de firma o Cerrar en modo de vista
Está finalizado el redireccionamiento cancelado
 is_finish_redirect_canceled boolean

Especifica si la configuración de redirección de finalización se cancela para la organización. True: se cancela el redireccionamiento; False: el redireccionamiento permanece activo.
Se ha cancelado la redirección de cierre
 is_close_redirect_canceled boolean

Especifica si la configuración de redirección de progreso de guardado se cancela para la organización. True: se cancela el redireccionamiento; False: el redireccionamiento permanece activo.
¿Se cancela la redirección de rechazo?
 is_decline_redirect_canceled boolean

Especifica si la configuración de redirección de rechazo se cancela para la organización. True: se cancela el redireccionamiento; False: el redireccionamiento permanece activo.
Language
 language string

Especifica el idioma de la sesión de firma y los correos electrónicos de notificación del firmante. Valores posibles: En para inglés, es para español y fr para francés. Si no se establece, el idioma viene determinado por el idioma de la cuenta de SignNow.
Correo Electrónico
 email True string

Dirección de correo electrónico del visor
Rol
 role True string

Nombre del rol del visor
Pedido
 order True integer

Entero: el orden de envío, a partir de 1
Rol
 role True string

Nombre del rol del visor. Se usa para asignar parámetros avanzados
Asunto
 subject string

Asunto de correo electrónico personalizado para el visor
Message
 message string

Mensaje de correo electrónico personalizado para el visor
Correo Electrónico
 email True string

Dirección de correo electrónico del aprobador
Rol
 role True string

Nombre del rol aprobador
Pedido
 order True integer

Orden de recepción de la solicitud de aprobación
Rol
 role True string

Nombre del rol aprobador. Se usa para asignar parámetros avanzados
Días de expiración
 expiration_days integer

Número de días antes de que expire la invitación
Message
 message string

Mensaje de correo electrónico personalizado para el aprobador
Asunto
 subject string

Asunto de correo electrónico personalizado para el aprobador
Tipo de autenticación
 authentication_type string

Tipo de autenticación usado para la autenticación de destinatarios durante la sesión de firma. Valores permitidos: 'Contraseña', 'Llamada telefónica' y 'Sms'
Contraseña
 password string

Contraseña establecida para la autenticación del firmante. Obligatorio para el tipo de autenticación "Password"
Teléfono
 phone string

Número de teléfono usado para autenticar el firmante. Obligatorio para el tipo de autenticación "Llamada telefónica" y "Sms". Ejemplo: +1XXXXXXXXXXXX
Mensaje sms de autenticación
 authentication_sms_message string

Mensaje sms personalizado enviado al firmante, que contiene el marcador de posición {password}. Se usa con el tipo de autenticación "Sms". Sin este parámetro, el firmante recibe un sms predeterminado con una contraseña generada automáticamente (código de desbloqueo): "SignNow document invite unlock code: 123456". Ejemplo: Escriba la contraseña {password} para desbloquear el documento
Uri de redirección
 redirect_uri string

Dirección URL que se abre después de que el aprobador apruebe el documento.
Destino de redireccionamiento
 redirect_target string

Determina si se va a abrir el URI de redireccionamiento en una nueva pestaña del explorador o en la misma pestaña después de la sesión de firma. Valores posibles: "En la nueva pestaña" – abre el vínculo en una nueva pestaña, "En la misma pestaña" - abre el vínculo en la misma pestaña.
De
 from string

Dirección de correo electrónico del remitente. Solo se puede usar el correo electrónico asociado a su cuenta de SignNow (correo electrónico de inicio de sesión). Si se deja en blanco, se establece automáticamente.
identificación
 id string

Identificador de un grupo de correo electrónico. Identificador único de 40 caracteres que se debe crear de antemano
Nombre
 name string

Nombre del grupo. Úselo en el campo Grupo de correo electrónico de firmantes >
Correo Electrónico
 email string

Dirección de correo electrónico que debe recibir una invitación
Correo Electrónico
 email string

Dirección de correo electrónico que debe recibir una invitación
Nombre
 name string

Nombre del paso
Correo Electrónico
 email string

Dirección de correo electrónico del destinatario CC
Step
 step integer

El orden de envío, a partir de 1
Asunto
 subject string

Asunto del correo electrónico para todos los destinatarios
Message
 message string

Mensaje de correo electrónico para todos los destinatarios
Asunto CC
 cc_subject string

Asunto del correo electrónico cc para todos los destinatarios cc
Mensaje CC
 cc_message string

Mensaje de correo electrónico CC para todos los destinatarios cc
Firma QES
 signature string

Tipo de QES. Valores posibles: 'Eideasy', 'Nom151'. Se usa para solicitar firmas QES de firmantes. Todos los firmantes de la invitación deben usar el mismo tipo de firma. Para crear una invitación con QES, el usuario debe pertenecer a una organización con QES habilitado

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado

Invitar a firmar grupo de documentos

Id. de la operación:
InviteToSignDocGroupAllOptions

Esta acción crea una invitación para firmar un grupo de documentos. Puede configurar un flujo de trabajo de varios pasos, donde diferentes destinatarios actúan en el grupo de documentos en distintas fases.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo de documentos
 id True string

Id. de grupo de documentos
Pedido
 order True integer

Orden de firma: 1 : los destinatarios firman primero el grupo de documentos y, a continuación, el grupo de documentos se envía a 2,3, etc. Varios destinatarios pueden contener el mismo orden de firma
Correo Electrónico
 email string

Dirección de correo electrónico del destinatario
Grupo de correo electrónico
 email_group string

Un grupo de contactos de destinatarios
Nombre del rol
 role_name True string

Nombre de rol de destinatario en el documento (se puede usar para identificar los campos del documento asignado a este destinatario en particular)
Acción
 action True string

Acción permitida con un documento. Valores posibles: Ver, Firmar, Aprobar
Id. de documento
 document_id True string

Identificador del documento en el que se requieren acciones de este destinatario
Nombre de firma preestablecido obligatorio
 required_preset_signature_name string

Texto rellenado previamente para el campo de firma, bloqueado para su edición por el destinatario
Permitir reenvío
 allow_reassign boolean

Define si el destinatario puede reenviar la invitación a otra dirección de correo electrónico. 'true': el destinatario puede reenviar la invitación; 'false': el destinatario no puede reenviar la invitación
Permitir rechazar por firma
 decline_by_signature boolean

Define si se va a mostrar la opción Rechazar a firmar en los campos de firma. True: mostrar la opción de rechazo; False: ocultar la opción de rechazo
Tipo de autenticación
 type string

Tipo de autenticación usado para la autenticación de destinatarios durante la sesión de firma. Valores permitidos: 'Contraseña', 'Llamada telefónica' y 'Sms'
Contraseña
 value string

Contraseña establecida para la autenticación del firmante. Obligatorio para el tipo de autenticación "Password"
Teléfono
 phone string

Número de teléfono usado para autenticar el firmante. Obligatorio para el tipo de autenticación "Llamada telefónica" y "Sms". Ejemplo: +1XXXXXXXXXXXX
Message
 message string

Mensaje sms personalizado enviado al firmante, que contiene el marcador de posición {password}. Se usa con el tipo de autenticación "Sms". Sin este parámetro, el firmante recibe un sms predeterminado con una contraseña generada automáticamente (código de desbloqueo): "SignNow document invite unlock code: 123456"
MerchantId
 merchant_id string

Identificador de la cuenta de comerciante agregada a la organización
Moneda
 currency string

Moneda de pago solicitada
Importe
 amount string

Importe de pago solicitado
Uri
 redirect_uri string

Cuando se completan y firman todos los campos solicitados, el firmante se redirige a este URI.
Destino de redireccionamiento
 redirect_target string

Determina si se va a abrir el URI de redireccionamiento en una nueva pestaña del explorador o en la misma pestaña después de la sesión de firma. Valores posibles: "En la nueva pestaña" – abre el vínculo en una nueva pestaña, "En la misma pestaña" - abre el vínculo en la misma pestaña.
Rechazar URI de redirección
 decline_redirect_uri string

Vínculo que se abre después de que el destinatario haya rechazado el documento.
Cerrar URI de redirección
 close_redirect_uri string

Vínculo que se abre cuando un firmante hace clic en Guardar progreso y Finalizar más tarde durante una sesión de firma o Cerrar en modo de vista
Está finalizado el redireccionamiento cancelado
 is_finish_redirect_canceled boolean

Especifica si la configuración de redirección de finalización se cancela para la organización. True: se cancela el redireccionamiento; False: el redireccionamiento permanece activo.
Se ha cancelado la redirección de cierre
 is_close_redirect_canceled boolean

Especifica si la configuración de redirección de progreso de guardado se cancela para la organización. True: se cancela el redireccionamiento; False: el redireccionamiento permanece activo.
¿Se cancela la redirección de rechazo?
 is_decline_redirect_canceled boolean

Especifica si la configuración de redirección de rechazo se cancela para la organización. True: se cancela el redireccionamiento; False: el redireccionamiento permanece activo.
Language
 language string

Especifica el idioma de la sesión de firma y los correos electrónicos de notificación del firmante. Valores posibles: En para inglés, es para español y fr para francés. Si no se establece, el idioma viene determinado por el idioma de la cuenta de SignNow.
Pedido
 order True integer

Orden de firma: 1 : los destinatarios firman primero el grupo de documentos y, a continuación, el grupo de documentos se envía a 2,3, etc. Varios destinatarios pueden contener el mismo orden de firma
Correo Electrónico
 email True string

Dirección de correo electrónico del destinatario
Grupo de correo electrónico
 email_group string

Un grupo de contactos de destinatarios
Asunto
 subject string

Asunto de correo electrónico personalizado para el destinatario
Message
 message string

Mensaje de correo electrónico personalizado para el destinatario
Días hasta la expiración
 expiration_days integer

En x días, la invitación expira (de 3 a 180 días)
Enviar recordatorio en X días
 remind_after integer

X días después de la invitación, un recepiente recibe un correo electrónico de recordatorio (de 1 a 179 días). Debe ser menor que los días de expiración.
Enviar recordatorio en X días antes de la expiración
 remind_before integer

X días antes de la expiración, un recepiente obtiene un correo electrónico de recordatorio (de 1 a 179 días). Debe ser menor que los días de expiración.
Enviar recordatorio cada X días
 remind_repeat integer

Un recepiente recibe un correo electrónico de recordatorio cada x días después de enviar la invitación (de 1 a 7 días)
Id
 id string

Identificador de un grupo de correo electrónico. Identificador único de 40 caracteres que se debe crear de antemano
Nombre
 name string

Nombre del grupo. Úselo en el "Grupo de correos electrónicos de pasos > de invitación"
Correo Electrónico
 email string

Dirección de correo electrónico que debe recibir una invitación
Correo Electrónico
 email string

Dirección de correo electrónico del destinatario que recibirá el correo electrónico de finalización
Deshabilitar datos adjuntos de documentos
 disable_document_attachment boolean

Si se deshabilita el envío de datos adjuntos del documento con el correo electrónico de finalización. Valores posibles: False: habilitar datos adjuntos del documento, True: deshabilitar los datos adjuntos del documento
Asunto
 subject string

Asunto personalizado para el correo electrónico de finalización
Message
 message string

Mensaje personalizado para el correo electrónico de finalización
Firmar como combinado
 sign_as_merged boolean

Si es true, permite al usuario de API enviar una invitación que se abre como grupo de documentos combinado en un único documento.
Marca de tiempo del cliente
 client_timestamp integer

Marca de tiempo de la invitación del grupo de documentos
Correo Electrónico
 email string

Dirección de correo electrónico que debe recibir una invitación
Firma QES
 signature string

Tipo de QES. Valores posibles: 'Eideasy', 'Nom151'. Se usa para solicitar firmas QES de firmantes. Todos los firmantes de la invitación deben usar el mismo tipo de firma. Para crear una invitación con QES, el usuario debe pertenecer a una organización con QES habilitado

Devoluciones

Nombre Ruta de acceso Tipo Description
Id
 id string

Id. de invitación del grupo de documentos
Vínculo de invitación pendiente
 pending_invite_link string

Vínculo de invitación pendiente

Obtener campos de documento

Id. de la operación:
GetDocFields_V2

Recuperar valores de los campos rellenables en el documento

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template_id True string

Especificar una plantilla de documento para obtener campos de
Id. de documento
 doc_id True string

Especificar un identificador de documento único

Devoluciones

Las salidas de esta operación son dinámicas.

Obtener campos de documento [EN DESUSO]

Id. de la operación:
GetDocFields

Esta acción ha quedado en desuso. Use Obtener campos de documento en su lugar.

Obtiene los valores de campo del documento.

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template_id True string

Especificar una plantilla de documento para obtener campos de
Id. de documento
 doc_id True string

Especificar un identificador de documento único

Devoluciones

Las salidas de esta operación son dinámicas.

Obtener el estado de invitación de documento

Id. de la operación:
GetInviteStatus

Esta acción recupera información sobre una invitación de documento, incluido el estado de cada paso y acción.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 id True string

Id. de documento

Devoluciones

Nombre Ruta de acceso Tipo Description
Documento rechazado
 is_document_declined boolean

True si el firmante o aprobador rechazó el documento; de lo contrario, false
steps
 steps array of object

Steps
Orden de firma
 steps.signing_order integer

Orden de firma
Correo electrónico del destinatario
 steps.signer_email string

Dirección de correo electrónico del destinatario
Nombre del rol
 steps.role_name string

Nombre del rol de destinatario
Tipo de acción
 steps.action_type string

Acción necesaria del destinatario en el documento. Valores posibles: 'Sign', 'View', 'Approve' o 'FreeFormSign'
Id. de invitación
 steps.invite_id string

Id. de invitación
Estado
 steps.status string

Estado de firma. Valores posibles: 'created', 'pending', 'fulfilled', 'canceled', 'skipped'
Declined
 steps.declined boolean

Devuelve "true" si el destinatario de este paso rechazó el documento.
Motivo del rechazo
 steps.decline_reason string

Mensaje proporcionado por el destinatario al rechazar el documento
Creado
 steps.created integer

Fecha en que se creó el paso
Actualizado
 steps.updated integer

Fecha en la que se actualizó por última vez el estado del paso

Obtener el estado de invitación del grupo de documentos

Id. de la operación:
GetDocumentGroupInviteStatus

Esta acción recupera información sobre una invitación de grupo de documentos, incluido el estado de cada paso y acción.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo de documentos
 id True string

Id. de grupo de documentos

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de invitación del grupo de documentos
 document_group_invite_id string

Id. de invitación del grupo de documentos
Estado del grupo de documentos
 status string

Estado de firma del grupo de documentos. Valores posibles: 'created', 'pending', 'fulfilled', 'canceled'
Correo electrónico del propietario
 owner_email string

Dirección de correo electrónico del propietario del grupo de documentos
Grupo de documentos rechazado
 is_document_declined boolean

Devuelve "true" si un firmante o aprobador rechaza algún documento del grupo; de lo contrario, devuelve "false"
steps
 steps array of object

Steps
Id. de paso
 steps.step_id string

Id. de paso de la invitación del grupo de documentos
Orden de firma
 steps.signing_order integer

Orden de firma
Id. de documento
 steps.document_id string

Id. de documento
Nombre del documento
 steps.document_name string

Nombre del documento
Correo electrónico del firmante
 steps.signer_email string

Dirección de correo electrónico del destinatario
Nombre del rol
 steps.role_name string

Nombre del rol de destinatario
Tipo de acción
 steps.action_type string

Acción necesaria del destinatario en el documento. Valores posibles: 'Sign', 'View', 'Approve' o 'FreeFormSign'
Id. de invitación de paso
 steps.invite_id string

Identificador del paso de invitación
Estado
 steps.status string

Estado de firma del paso
Declined
 steps.declined boolean

True si el destinatario de este paso rechazó el documento
Motivo del rechazo
 steps.decline_reason string

Mensaje proporcionado por el destinatario al rechazar el documento
Creado
 steps.created integer

Fecha en que se creó el paso
Actualizado
 steps.updated integer

Fecha en la que se actualizó por última vez el estado del paso

Obtener esquema de documento [EN DESUSO]

Id. de la operación:
GetDocSchema

Esta acción ha quedado en desuso. En su lugar, use Get document schema (Obtener esquema de documento ).

Obtención del esquema de documentos de OpenAPI

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 doc_id string

Especificar un identificador de documento único
Filtro de tipo de campo
 select string

Separe con una coma qué tipos de campo desea recuperar

Devoluciones

Nombre Ruta de acceso Tipo Description
Propiedades
 properties object

Obtener grupo de documentos

Id. de la operación:
GetDocumentGroup

Recuperar una lista de grupos de documentos del usuario

Parámetros

Nombre Clave Requerido Tipo Description
Plantilla de grupo
 doc_group_id True string

Seleccione la plantilla de grupo de la lista.
Template
 template True boolean

Especificar si se debe recuperar un grupo de documentos o una plantilla de grupo

Devoluciones

Body
DocumentGroupProperties

Obtener grupos de documentos

Id. de la operación:
GetListDocGroups

Recuperar una lista de grupos de documentos del usuario

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template True boolean

Especificar si se deben recuperar grupos de documentos o plantillas de grupo
Limit
 limit integer

Número total de elementos devueltos (entre 1 y 50)
Desplazar
 offset integer

Desplazamiento (basado en cero) del primer elemento de la colección que se va a devolver

Devoluciones

Body
DocumentGroupsResponse

Obtener información del documento

Id. de la operación:
GetDoc

Obtenga propiedades de documento como name, id, create/update dates, etc.

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template True boolean

Especificar si se deben recuperar documentos o plantillas
Id. de documento
 doc_id True string

Especificar un identificador de documento único o seleccionar un documento de la lista

Devoluciones

Body
DocumentProperties

Obtener lista de documentos

Id. de la operación:
GetListDoc

Recuperar una lista de documentos del usuario

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template boolean

Especificar si se deben recuperar documentos o plantillas
Incluir plantilla predeterminada
 includeDefaultTemplate boolean

Especificar si se debe agregar una plantilla predeterminada a la lista de plantillas

Devoluciones

response
array of DocumentProperties

Prerrellenar valores de campo de documento

Id. de la operación:
UpdateFieldValues_V2

Rellenar automáticamente los campos rellenables en el documento con valores específicos

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template_id True string

Especificar una plantilla de documento para obtener campos de
Id. de documento
 doc_id True string

Especificar un identificador de documento único
fields
 fields dynamic

Devoluciones

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

Identificador de documento único

Prerrellenar valores de campo de documento [EN DESUSO]

Id. de la operación:
UpdateFieldValues

Esta acción ha quedado en desuso. En su lugar, use prerrellenar valores de campo de documento .

Rellenar previamente los valores y propiedades del campo.

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template_id True string

Especificar una plantilla de documento para obtener campos de
Id. de documento
 doc_id True string

Especificar un identificador de documento único
fields
 fields dynamic

Devoluciones

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

Identificador de documento único

Prerrellenar valores de campo del grupo de documentos

Id. de la operación:
UpdateGroupFieldValues

Rellenar automáticamente los campos rellenables en los documentos con valores específicos

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template_group_id True string

Especificar una plantilla de grupo de documentos para obtener campos de
Id. de grupo de documentos
 doc_group_id True string

Especificar un identificador de grupo de documentos único
fields
 fields dynamic

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de grupo de documentos
 id DocumentGroupId

Identificador de grupo de documentos único

Prerrellenar valores de campo inteligente

Id. de la operación:
PrefillSmartFields

Rellenar previamente los valores del campo inteligente para el documento especificado

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template_id True string

Especificar una plantilla de documento para obtener campos de
Id. de documento
 doc_id True string

Especificar un identificador de documento único
fields
 fields dynamic

Reemplazar destinatarios en invitación de documento

Id. de la operación:
ReplaceRecipientsInDocumentInvite

Esta acción reemplaza a los destinatarios de la invitación del documento en función de sus roles. También permite actualizar la configuración de invitación, como el tipo de autenticación, los días de expiración y otros parámetros avanzados para cada rol.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de documento
 id True string

Id. de documento
Rol
 role True string

Nombre de rol del destinatario que se va a reemplazar
Nuevo correo electrónico
 email True string

Nuevo correo electrónico de destinatario
Rol
 role True string

Nombre de rol que requiere parámetros de invitación adicionales
Días de expiración
 expiration_days integer

En cuántos días expira la invitación. 30 días máximo
Permitir rechazar por firma
 decline_by_signature boolean

Define si se va a mostrar la opción Rechazar a firmar en los campos de firma. True: mostrar la opción de rechazo; False: ocultar la opción de rechazo
Recordatorio
 reminder integer

En cuántos días se envía un aviso al destinatario. 30 días máximo
Tipo de autenticación
 authentication_type string

Tipo de autenticación usado para la autenticación de destinatarios durante la sesión de firma. Valores permitidos: 'Contraseña', 'Llamada telefónica' y 'Sms'
Contraseña de autenticación
 authentication_password string

Contraseña establecida para la autenticación del firmante. Obligatorio para el tipo de autenticación "Password"
Teléfono de autenticación
 authentication_phone string

Número de teléfono usado para autenticar el firmante. Obligatorio para el tipo de autenticación "Llamada telefónica" y "Sms". Ejemplo: +1XXXXXXXXXXXX
Mensaje sms de autenticación
 authentication_sms_message string

Mensaje sms personalizado enviado al firmante, que contiene el marcador de posición {password}. Se usa con el tipo de autenticación "Sms". Sin este parámetro, el firmante recibe un sms predeterminado con una contraseña generada automáticamente (código de desbloqueo): "SignNow document invite unlock code: 123456". Ejemplo: Escriba la contraseña {password} para desbloquear el documento

Devoluciones

Nombre Ruta de acceso Tipo Description
Reemplazos
 replacements array of object

Detalles de los nuevos destinatarios
Nuevo id. de invitación
 replacements.new_invite_id string

El nuevo identificador de invitación de campo
Rol
 replacements.role string

Nombre de rol del destinatario que se ha reemplazado
Nuevo correo electrónico
 replacements.new_email string

Nuevo correo electrónico de destinatario

Reemplazar destinatarios en invitación de grupo de documentos

Id. de la operación:
ReplaceRecipientsInDocumentGroupInvite

Esta acción reemplaza a los destinatarios de una invitación de grupo de documentos por su identificador de invitación. También puede establecer una expiración de invitación, recordatorios, reasignar permisos y opciones de rechazo para cada documento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de grupo de documentos
 id True string

Id. de grupo de documentos
Id. de invitación
 invite_id True string

Id. de invitación del grupo de documentos
Id. de paso
 step_id string

Identificador del paso de invitación de la invitación del grupo de documentos
Destinatario que se va a reemplazar
 recipient_to_update string

Correo electrónico del destinatario que se va a reemplazar
Nuevo destinatario
 new_recipient string

Correo electrónico del nuevo destinatario
Días de expiración
 expiration_days integer

En cuántos días expira la invitación; 30 días máximo
Recordatorio
 reminder integer

En cuántos días enviar un aviso al firmante; 30 días máximo
Id. de documento
 document_id True string

Id. de documento del grupo de documentos
Permitir reenvío
 allow_forwarding boolean

Indica si se va a permitir que los destinatarios vuelvan a asignar esta invitación a otra dirección de correo electrónico. Valores posibles: False: no permitido. True: permitido.
Permitir rechazar por firma
 decline_by_signature boolean

Define si se va a mostrar la opción Rechazar a firmar en los campos de firma. True: mostrar la opción de rechazo; False: ocultar la opción de rechazo

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado del reemplazo de destinatarios

Rellenar previamente los valores de campo inteligente del grupo de documentos

Id. de la operación:
UpdateGroupSmartFieldValues

Rellenar automáticamente campos inteligentes en los documentos con valores específicos

Parámetros

Nombre Clave Requerido Tipo Description
Template
 template_group_id True string

Especificar una plantilla de grupo de documentos para obtener campos de
Id. de grupo de documentos
 doc_group_id True string

Especificar un identificador de grupo de documentos único
fields
 fields dynamic

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de grupo de documentos
 id DocumentGroupId

Identificador de grupo de documentos único

Desencadenadores

Flujo de inicio en el evento de documento

Seleccione el evento en el que se va a desencadenar: la invitación de firma nueva o actualizada; cuando alguien crea, actualiza, completa o elimina un documento
Flujo de inicio en el evento de documento [EN DESUSO]

Esta acción ha quedado en desuso. En su lugar, use Start flow on document event (Flujo de inicio en el evento de documento ).

Puede crear un desencadenador para uno de estos eventos: creación de documentos, actualización de documentos, eliminación de documentos, document complete, invite create, invite update

Flujo de inicio en el evento de documento

Id. de la operación:
Triggers_V2

Seleccione el evento en el que se va a desencadenar: la invitación de firma nueva o actualizada; cuando alguien crea, actualiza, completa o elimina un documento

Parámetros

Nombre Clave Requerido Tipo Description
Event
 event True string

Seleccionar evento que debe desencadenar el flujo

Devoluciones

Nombre Ruta de acceso Tipo Description
Event
 meta.event string

Evento de documento que provocó el desencadenador.
Id. de documento
 content.document_id string

Identificador único del documento de destino que provocó el evento.
Nombre del documento
 content.document_name string

Nombre de archivo de documento de destino sin extensión

Flujo de inicio en el evento de documento [EN DESUSO]

Id. de la operación:
Triggers

Esta acción ha quedado en desuso. En su lugar, use Start flow on document event (Flujo de inicio en el evento de documento ).

Puede crear un desencadenador para uno de estos eventos: creación de documentos, actualización de documentos, eliminación de documentos, document complete, invite create, invite update

Parámetros

Nombre Clave Requerido Tipo Description
Event
 event True string

Seleccione el evento que debe desencadenar flow.

Devoluciones

Nombre Ruta de acceso Tipo Description
Marca de tiempo
 meta.timestamp integer

Fecha y hora en que se produjo el evento (formato de marca de tiempo de Unix).
Event
 meta.event string

Evento de documento que provocó el desencadenador.
Id. de documento
 content.document_id string

Identificador único del documento de destino que provocó el evento.
Nombre del documento
 content.document_name string

Nombre de archivo de documento de destino sin extensión

Definiciones

DocumentProperties

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

Identificador de documento único
Nombre del documento
 document_name string

Nombre de archivo de documento sin extensión
Recuento de páginas
 page_count integer

Número de páginas del documento
Creado
 created integer

Fecha y hora en que se creó el documento en formato de marca de tiempo de Unix
Actualizado
 updated integer

Fecha y hora en que se actualizó el documento en formato de marca de tiempo de Unix
Nombre de la plantilla
 original_filename string

Nombre de archivo de plantilla con extensión (si existe)
Identificador de plantilla
 origin_document_id string

Id. de documento de plantilla (si existe)
¿Es plantilla?
 template boolean

true si el documento es plantilla.
Estado del documento
 status string

Estado del documento

DocumentGroupsResponse

Nombre Ruta de acceso Tipo Description
document_groups
 document_groups array of DocumentGroupProperties
Recuento total de grupos de documentos
 document_group_total_count integer

Número total de grupos de documentos en la cuenta de SignNow

DocumentGroupProperties

Nombre Ruta de acceso Tipo Description
Id. de grupo de documentos
 group_id DocumentGroupId

Identificador de grupo de documentos único
Nombre del grupo de documentos
 group_name string

Nombre del grupo de documentos
Documentos
 documents array of DocumentGroupDocumentProperties

Documentos

DocumentGroupDocumentProperties

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

Identificador de documento único
Nombre del documento
 document_name string

Nombre de archivo de documento sin extensión
Identificador de plantilla
 origin_document_id string

Id. de documento de plantilla (si existe)

CreateDocumentGroupFromFilesResponse

Nombre Ruta de acceso Tipo Description
Nombre del grupo de documentos
 group_name string

Nombre del grupo de documentos
Id. de grupo de documentos
 group_id string

Identificador del grupo de documentos
Documentos
 documents array of object
Id. de documento
 documents.id DocumentId

Identificador de documento único
Nombre del documento
 documents.name string

Nombre del documento

DocumentId

Identificador de documento único

Identificador de documento único

Id. de documento
string

DocumentGroupId

Identificador de grupo de documentos único

Identificador de grupo de documentos único

Id. de grupo de documentos
string

objeto

Este es el tipo 'objeto'.

binario

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