Signo insonorizado (versión preliminar)

Use firma insonorizada para automatizar flujos de trabajo de firmas electrónicas seguras para documentos PDF y DOCX. Las organizaciones pueden crear solicitudes de firma de uno o varios documentos, asignar destinatarios y roles de firma, realizar un seguimiento del estado, descargar archivos PDF completados y eliminar documentos. Una cuenta de firma insonorizada, un plan que admita las acciones seleccionadas y los tipos de firma, y se requiere un token de API válido.

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)      - Gobierno de EE. UU. (GCC High)      - China Cloud operado por 21Vianet      - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes:      - Regiones de Azure Government      - Regiones de Azure China      - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes:      - Gobierno de EE. UU. (GCC)      - Gobierno de EE. UU. (GCC High)      - China Cloud operado por 21Vianet      - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes:      - Gobierno de EE. UU. (GCC)      - Gobierno de EE. UU. (GCC High)      - China Cloud operado por 21Vianet      - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Soporte de la API
URL	https://sproof.com
Correo Electrónico	support@sproof.com

Metadatos del conector
Publicador	sproof GmbH
Website	https://www.sproof.com/en/sign/
Directiva de privacidad	https://www.sproof.com/en/privacy-policy-app/
Categorías	Productividad; Contenido y archivos

Signo insonorizado

Visión general

sproof Sign permite a las organizaciones automatizar flujos de trabajo de firma electrónica para documentos PDF y DOCX. El conector puede crear solicitudes de firma de documento único o sobres de varios documentos, asignar destinatarios y roles de firma, recuperar el estado de la solicitud, descargar documentos completados y eliminar documentos.

Prerequisites

Para usar el conector, necesita lo siguiente:

• Una cuenta de sign insonorizada.
• Un plan de firma insonorizado con acceso a api y compatibilidad con las acciones y tipos de firma necesarios.
• Un token de Sign API de firma insonorizado válido.

Autenticación

El conector usa la autenticación de token de API. Para crear una conexión, escriba un token de Sign API insonorizado válido asociado a su cuenta. Mantenga el token seguro y reemplácelo si se revoca o regenera.

Acciones soportadas

• Crear solicitud de firma : crea una solicitud para un documento o un sobre que contiene varios documentos. Se pueden configurar destinatarios, roles de firma, orden de firma, posiciones de firma y otras opciones de invitación.
• Crear solicitud de firma mediante marcadores de posición : crea una solicitud mediante marcadores de posición almacenados en un documento cargado. La información del destinatario y las posiciones de firma se extraen de esos marcadores de posición.
• Obtener el estado de la solicitud : recupera el estado actual y el estado de firma de una solicitud de firma mediante su identificador de miembro.
• Obtener documento : descarga un documento como pdf binario o como PDF codificado en Base64.
• Eliminar documento : elimina un documento o quita el acceso de un miembro, según el identificador de miembro proporcionado, el rol del miembro y si el documento pertenece a un sobre.

Limitaciones y requisitos conocidos

• Los documentos de entrada se deben proporcionar como contenido PDF o DOCX codificado en Base64.
• Un sobre puede contener un máximo de 25 documentos.
• Se requiere un nombre de sobre cuando se envía más de un documento.
• Las solicitudes basadas en marcadores de posición requieren marcadores de posición con formato correcto en el documento cargado.
• En el caso de las solicitudes basadas en marcadores de posición, los destinatarios y las posiciones de firma se obtienen del documento en lugar de escribirse manualmente.
• Las acciones disponibles, los tipos de firma y los proveedores dependen de la cuenta y el plan de firma insonorizados conectados.
• El comportamiento de eliminación de documentos depende de si el identificador de miembro proporcionado pertenece al remitente o a un destinatario y si el documento forma parte de un sobre.

Apoyo

Para obtener soporte técnico de API o conector, póngase en contacto con support@sproof.com.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre	Tipo	Description	Obligatorio
token	securestring	"token" für diese API	True

Acciones

Creación de una solicitud de firma	Esta es la nueva solicitud de firma de creación. Además de crear una invitación de documento única, ahora admite la creación de sobres y la carga de varios documentos a la vez al enviar invitaciones.
Creación de una solicitud de firma mediante marcadores de posición	Crea una solicitud de firma mediante marcadores de posición almacenados en el documento cargado. Los destinatarios y las posiciones de firma se extraen del documento.
Eliminar documento	Elimina un documento o quita el acceso de un miembro a él, en función de si el proporcionado memberId pertenece al remitente o al destinatario, y si el documento forma parte de un sobre. Documentos en un sobre El parámetro all de consulta no tiene ningún efecto para los documentos de un sobre. Con el remitente memberId: Se elimina un único documento para el remitente y todos los destinatarios. El documento se quita del sobre. Con el destinatario memberId: Todos los documentos del sobre se quitan para el destinatario. El destinatario se marca como declined en todos los documentos que se eliminaron para el destinatario. Los documentos permanecen disponibles para todos los demás miembros del documento. Documentos únicos Con el remitente memberId y all=true: El documento se elimina para el remitente y todos los destinatarios. Con el remitente memberId y all=false: El documento solo se elimina para el remitente. El documento permanece disponible para los demás destinatarios del documento. Con el destinatario memberId: El destinatario se marca como declined en el documento. El documento permanece disponible para todos los demás miembros del documento.
Obtención del estado de la solicitud	Obtiene el estado de una solicitud de firma. Devuelve un objeto JSON de documento o un error. El parámetro lo devuelve la solicitud post en el documento y está asociado al correo electrónico de los remitentes.
Obtener documento	Obtenga el documento firmado como cadena binaria o codificada en Base64.

Creación de una solicitud de firma

Id. de la operación:

CreateSignatureRequest

Esta es la nueva solicitud de firma de creación. Además de crear una invitación de documento única, ahora admite la creación de sobres y la carga de varios documentos a la vez al enviar invitaciones.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
email	email	True	string	Correo electrónico del remitente. Debe pertenecer a un miembro del plan.
firstName	firstName	True	string	Nombre del remitente.
lastName	lastName		string	Apellidos del remitente.
role	role		string	Rol del remitente en todos los documentos.
email	email		string	Correo electrónico del destinatario.
firstName	firstName		string	Nombre del destinatario.
lastName	lastName		string	Apellidos del destinatario.
doNotSendEmails	doNotSendEmails		boolean	Si se establece true en ningún correo electrónico se envía al destinatario.
customId	customId		string	Para usarse solo cuando se desconoce la dirección de correo electrónico del destinatario en el momento de invitar. Esto solo funciona cuando invita a los destinatarios (no para preparar rutas) y desea usar fastlane. customId permite generar previamente un vínculo de firma único para un destinatario antes de enviar una invitación. Debe ser una cadena única alfanumérica de al menos 70 caracteres. Nota: El customId solo se puede usar para compilar el vínculo del destinatario a un documento. No se puede usar para otras solicitudes en lugar de memberId. Para obtener más información sobre la construcción de direcciones URL, consulte Apertura de un documento con un identificador personalizado.
useFastlane	useFastlane		boolean	Si se establece en true el firmante recibe un vínculo de Fastlane en el correo electrónico de invitación.
phoneNumber	phoneNumber		string	Número de teléfono de este destinatario. Esto se usa para la comprobación de SMS. (por ejemplo: +43 699 1234 1234).
privateMessage	privateMessage		string	Un mensaje privado para este destinatario específico.
inPersonMode	inPersonMode		boolean	Cuando esta opción está habilitada, se pedirá al destinatario de la solicitud de firma que firme el documento en persona y no se envíe ningún correo electrónico. Este modo solo está disponible mediante el tipo de firma SES.
signatureTypes	signatureTypes		array of string	Tipos de firmas permitidas para este destinatario. Opciones: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Esta etiqueta determina el proveedor de identidades que se usará para el proceso de firma. Elija entre un conjunto predefinido de proveedores admitidos. Nota1: Algunos proveedores solo están disponibles para determinados signatureTypes, por ejemplo onetimeqes , requerirán "signatureType" : ["qualifiedPlusIdent"] Nota2: Cuando se usa sproof-qualified como proveedor predeterminado, el destinatario debe tener una cuenta insonorizada activa con una licencia de Usuario+ activa.
canChange	canChange		boolean	Boolean para indicar si el destinatario invitado debe poder cambiar el proveedor de firmas.
country	country		string	El país predeterminado, si está en blanco establecido en todo, se devolverá un error con los países disponibles para la etiqueta de proveedor elegida.
dueDate	dueDate		YYYY-MM-DD	Fecha hasta la que se puede firmar el documento. Esta fecha de vencimiento se muestra al destinatario en el correo electrónico de invitación y también está visible en la sección de detalles del documento del panel. Sirve como fecha límite para completar el proceso de firma.
reminderInterval	reminderInterval		number	Especifica el número de días entre correos electrónicos de recordatorio.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Fecha a partir de la cual se deben enviar avisos
inviteLanguage	inviteLanguage		string	Especifica el idioma de los correos electrónicos enviados a usuarios anónimos que no tienen una cuenta. En el caso de los usuarios con una cuenta, se usará en su lugar el idioma seleccionado en su perfil.
message	message		string	Mensaje personalizado enviado a los destinatarios dentro del correo electrónico.
subject	subject		string	Línea de asunto del correo electrónico enviado a los destinatarios.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Si se establece en true, el pdf se envía como datos adjuntos a todos los destinatarios del documento (si es menor que 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Cuando esta opción está habilitada, el destinatario de la solicitud de firma se limitará a firmar o rechazar el documento y no podrá desplazarse fuera de la página.
allowForwarding	allowForwarding		boolean	Permita el reenvío de la invitación.
collabSigningMode	collabSigningMode		object	Objeto donde cada clave representa una ronda de firma y su valor correspondiente indica si la firma colaborativa está habilitada para esa ronda. Si el valor es true, solo se requiere una firma para completar la ronda de firma especificada y continuar con la siguiente ronda. Por ejemplo, { '1': true } significa que en la ronda de firma '1', solo se necesita una firma.
usePlaceholders	usePlaceholders		boolean	Si es true, los marcadores de posición de texto o formFields almacenados en el documento se usarán para invitar a destinatarios.
inPersonSigning	inPersonSigning		boolean	Cuando es true, el destinatario obtiene un elemento emergente donde necesita dibujar manualmente una firma.
folderName	folderName		string	Si se proporciona, se creará un sobre que contiene todos los documentos de documentDataArray. (Obligatorio si se envía más de un documento)
callbackUrl	callbackUrl		string	Una solicitud POST, incluido el documento, se enviará a esta dirección URL cuando se cree una nueva firma o cuando un destinatario rechace el documento. En caso de error, se ha implementado un mecanismo de reintento para asegurarse de que se reintenta la solicitud.
returnUrl	returnUrl		string	Vínculo del botón devolver después de firmar un documento
returnBtnText	returnBtnText		string	Texto del botón devolver después de firmar un documento
datos	data	True	string	Datos del documento (PDF o DOCX) en formato base64.
mimetype	mimetype		string	Tipo MIME de datos codificados en base64 PDF o DOCX, necesario si el documento no es un pdf
nombre de archivo	fileName	True	string	Nombre del archivo
label	label		string	Etiqueta personalizada que se puede enviar para organizar documentos.
página	page	True	integer	Número de la página en la que se encuentra el cuadro, con la primera página siendo 0.
pageWidth	pageWidth		integer	Cualquier valor entero que describa el ancho de página. Cuanto mayor sea el número, mejor será la precisión al colocar el cuadro en el espacio x y. En una página A4, tenemos 478 como valor predeterminado.
pageHeight	pageHeight		integer	Cualquier valor entero que describa el alto de la página. Cuanto mayor sea el número, mejor será la precisión al colocar el cuadro en el espacio x y. En una página A4, tenemos 676 como valor predeterminado.
x	x	True	float	Representa la posición horizontal del cuadro como un porcentaje del ancho de página. El origen (0,0) está en la parte superior izquierda de la página. Un valor de 0,1 significa que el cuadro se coloca en 10% del ancho de página de la izquierda.
y	y	True	float	Representa la posición vertical del cuadro como un porcentaje del alto de página. El origen (0,0) está en la parte superior izquierda de la página. Un valor de 0,1 significa que el cuadro se coloca en 10% del alto de la página desde la parte superior.
width	width	True	float	Ancho del cuadro basado en dimensiones de página, similares a las coordenadas x e y. Es un float que representa un porcentaje de pageWidth.
altura	height	True	float	Alto del cuadro en función de las dimensiones de página, similares a las coordenadas x e y. Es un valor float que representa un porcentaje de pageHeight.
id	id	True	string	Un identificador único para este cuadro, generado de cualquier manera que desee.
label	label		string	Texto del marcador de posición, como el nombre del campo, por ejemplo, "Fecha de nacimiento".
value	value		string	Valor predeterminado para el cuadro. Puede ser null. Si el cuadro es de tipo "chooseBox", el valor puede ser NULL o una de las cadenas definidas en las opciones.
Solo lectura	readonly		boolean	Si se establece en true, la persona invitada no puede modificar el valor de este cuadro.
required	required		boolean	Si se establece en true, la persona invitada no puede firmar el documento sin rellenar este cuadro.
type	type	True	string
multilínea	multiline		boolean	Indica si se permiten varias líneas.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Cada cuadro de radio se puede asignar a un grupo.
signatureTypes	signatureTypes		array of string	Los tipos de firmas que se permiten para este destinatario pueden sobrescribirse mediante tipos de firma de destinatario. Opciones: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId es un campo opcional que se usa para hacer referencia cruzada al documento cargado. Si se proporciona, le permite asignar un identificador de referencia personalizado al documento, que se devolverá como parte del objeto de documento en futuras respuestas de API. Esto puede ser útil para realizar un seguimiento o organizar documentos mediante un sistema externo o un flujo de trabajo.
language	language		string	Idioma del documento.
folderId	folderId		string	Identificador de una carpeta en la que se deben insertar los documentos. Esto solo es posible cuando inviteData y folderName no están definidos.
isAttachment	isAttachment		boolean	isAttachment no es necesario en este caso.
Detalles del destinatario	recipientDetails	True	object	Detalles del destinatario clavedos por correo electrónico del destinatario. Ejemplo: {""mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}.
useFastlane	useFastlane		boolean	Si se establece en true el firmante recibe un vínculo de Fastlane en el correo electrónico de invitación.
fastlaneProfileId	fastlaneProfileId		uuid	Especifique el perfil de Fastlane que se debe usar con este documento. (useFastlane debe establecerse en true).

Devoluciones

Body

EnvelopeResponse

Creación de una solicitud de firma mediante marcadores de posición

Id. de la operación:

CreateSignatureRequestUsingPlaceholders

Crea una solicitud de firma mediante marcadores de posición almacenados en el documento cargado. Los destinatarios y las posiciones de firma se extraen del documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
email	email	True	string	Correo electrónico del remitente. Debe pertenecer a un miembro del plan.
firstName	firstName	True	string	Nombre del remitente.
lastName	lastName		string	Apellidos del remitente.
role	role		string	Rol del remitente en todos los documentos.
email	email		string	Correo electrónico del destinatario.
firstName	firstName		string	Nombre del destinatario.
lastName	lastName		string	Apellidos del destinatario.
doNotSendEmails	doNotSendEmails		boolean	Si se establece true en ningún correo electrónico se envía al destinatario.
customId	customId		string	Para usarse solo cuando se desconoce la dirección de correo electrónico del destinatario en el momento de invitar. Esto solo funciona cuando invita a los destinatarios (no para preparar rutas) y desea usar fastlane. customId permite generar previamente un vínculo de firma único para un destinatario antes de enviar una invitación. Debe ser una cadena única alfanumérica de al menos 70 caracteres. Nota: El customId solo se puede usar para compilar el vínculo del destinatario a un documento. No se puede usar para otras solicitudes en lugar de memberId. Para obtener más información sobre la construcción de direcciones URL, consulte Apertura de un documento con un identificador personalizado.
useFastlane	useFastlane		boolean	Si se establece en true el firmante recibe un vínculo de Fastlane en el correo electrónico de invitación.
phoneNumber	phoneNumber		string	Número de teléfono de este destinatario. Esto se usa para la comprobación de SMS. (por ejemplo: +43 699 1234 1234).
privateMessage	privateMessage		string	Un mensaje privado para este destinatario específico.
inPersonMode	inPersonMode		boolean	Cuando esta opción está habilitada, se pedirá al destinatario de la solicitud de firma que firme el documento en persona y no se envíe ningún correo electrónico. Este modo solo está disponible mediante el tipo de firma SES.
signatureTypes	signatureTypes		array of string	Tipos de firmas permitidas para este destinatario. Opciones: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Esta etiqueta determina el proveedor de identidades que se usará para el proceso de firma. Elija entre un conjunto predefinido de proveedores admitidos. Nota1: Algunos proveedores solo están disponibles para determinados signatureTypes, por ejemplo onetimeqes , requerirán "signatureType" : ["qualifiedPlusIdent"] Nota2: Cuando se usa sproof-qualified como proveedor predeterminado, el destinatario debe tener una cuenta insonorizada activa con una licencia de Usuario+ activa.
canChange	canChange		boolean	Boolean para indicar si el destinatario invitado debe poder cambiar el proveedor de firmas.
country	country		string	El país predeterminado, si está en blanco establecido en todo, se devolverá un error con los países disponibles para la etiqueta de proveedor elegida.
dueDate	dueDate		YYYY-MM-DD	Fecha hasta la que se puede firmar el documento. Esta fecha de vencimiento se muestra al destinatario en el correo electrónico de invitación y también está visible en la sección de detalles del documento del panel. Sirve como fecha límite para completar el proceso de firma.
reminderInterval	reminderInterval		number	Especifica el número de días entre correos electrónicos de recordatorio.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Fecha a partir de la cual se deben enviar avisos
inviteLanguage	inviteLanguage		string	Especifica el idioma de los correos electrónicos enviados a usuarios anónimos que no tienen una cuenta. En el caso de los usuarios con una cuenta, se usará en su lugar el idioma seleccionado en su perfil.
message	message		string	Mensaje personalizado enviado a los destinatarios dentro del correo electrónico.
subject	subject		string	Línea de asunto del correo electrónico enviado a los destinatarios.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Si se establece en true, el pdf se envía como datos adjuntos a todos los destinatarios del documento (si es menor que 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Cuando esta opción está habilitada, el destinatario de la solicitud de firma se limitará a firmar o rechazar el documento y no podrá desplazarse fuera de la página.
allowForwarding	allowForwarding		boolean	Permita el reenvío de la invitación.
collabSigningMode	collabSigningMode		object	Objeto donde cada clave representa una ronda de firma y su valor correspondiente indica si la firma colaborativa está habilitada para esa ronda. Si el valor es true, solo se requiere una firma para completar la ronda de firma especificada y continuar con la siguiente ronda. Por ejemplo, { '1': true } significa que en la ronda de firma '1', solo se necesita una firma.
inPersonSigning	inPersonSigning		boolean	Cuando es true, el destinatario obtiene un elemento emergente donde necesita dibujar manualmente una firma.
folderName	folderName		string	Si se proporciona, se creará un sobre que contiene todos los documentos de documentDataArray. (Obligatorio si se envía más de un documento)
callbackUrl	callbackUrl		string	Una solicitud POST, incluido el documento, se enviará a esta dirección URL cuando se cree una nueva firma o cuando un destinatario rechace el documento. En caso de error, se ha implementado un mecanismo de reintento para asegurarse de que se reintenta la solicitud.
returnUrl	returnUrl		string	Vínculo del botón devolver después de firmar un documento
returnBtnText	returnBtnText		string	Texto del botón devolver después de firmar un documento
datos	data	True	string	Datos del documento (PDF o DOCX) en formato base64.
mimetype	mimetype		string	Tipo MIME de datos codificados en base64 PDF o DOCX, necesario si el documento no es un pdf
nombre de archivo	fileName	True	string	Nombre del archivo
label	label		string	Etiqueta personalizada que se puede enviar para organizar documentos.
página	page	True	integer	Número de la página en la que se encuentra el cuadro, con la primera página siendo 0.
pageWidth	pageWidth		integer	Cualquier valor entero que describa el ancho de página. Cuanto mayor sea el número, mejor será la precisión al colocar el cuadro en el espacio x y. En una página A4, tenemos 478 como valor predeterminado.
pageHeight	pageHeight		integer	Cualquier valor entero que describa el alto de la página. Cuanto mayor sea el número, mejor será la precisión al colocar el cuadro en el espacio x y. En una página A4, tenemos 676 como valor predeterminado.
x	x	True	float	Representa la posición horizontal del cuadro como un porcentaje del ancho de página. El origen (0,0) está en la parte superior izquierda de la página. Un valor de 0,1 significa que el cuadro se coloca en 10% del ancho de página de la izquierda.
y	y	True	float	Representa la posición vertical del cuadro como un porcentaje del alto de página. El origen (0,0) está en la parte superior izquierda de la página. Un valor de 0,1 significa que el cuadro se coloca en 10% del alto de la página desde la parte superior.
width	width	True	float	Ancho del cuadro basado en dimensiones de página, similares a las coordenadas x e y. Es un float que representa un porcentaje de pageWidth.
altura	height	True	float	Alto del cuadro en función de las dimensiones de página, similares a las coordenadas x e y. Es un valor float que representa un porcentaje de pageHeight.
id	id	True	string	Un identificador único para este cuadro, generado de cualquier manera que desee.
label	label		string	Texto del marcador de posición, como el nombre del campo, por ejemplo, "Fecha de nacimiento".
value	value		string	Valor predeterminado para el cuadro. Puede ser null. Si el cuadro es de tipo "chooseBox", el valor puede ser NULL o una de las cadenas definidas en las opciones.
Solo lectura	readonly		boolean	Si se establece en true, la persona invitada no puede modificar el valor de este cuadro.
required	required		boolean	Si se establece en true, la persona invitada no puede firmar el documento sin rellenar este cuadro.
type	type	True	string
multilínea	multiline		boolean	Indica si se permiten varias líneas.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Cada cuadro de radio se puede asignar a un grupo.
signatureTypes	signatureTypes		array of string	Los tipos de firmas que se permiten para este destinatario pueden sobrescribirse mediante tipos de firma de destinatario. Opciones: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId es un campo opcional que se usa para hacer referencia cruzada al documento cargado. Si se proporciona, le permite asignar un identificador de referencia personalizado al documento, que se devolverá como parte del objeto de documento en futuras respuestas de API. Esto puede ser útil para realizar un seguimiento o organizar documentos mediante un sistema externo o un flujo de trabajo.
language	language		string	Idioma del documento.
folderId	folderId		string	Identificador de una carpeta en la que se deben insertar los documentos. Esto solo es posible cuando inviteData y folderName no están definidos.
isAttachment	isAttachment		boolean	isAttachment no es necesario en este caso.
useFastlane	useFastlane		boolean	Si se establece en true el firmante recibe un vínculo de Fastlane en el correo electrónico de invitación.
fastlaneProfileId	fastlaneProfileId		uuid	Especifique el perfil de Fastlane que se debe usar con este documento. (useFastlane debe establecerse en true).

Devoluciones

Body

EnvelopeResponse

Eliminar documento

Id. de la operación:

DeleteDocument

Elimina un documento o quita el acceso de un miembro a él, en función de si el proporcionado memberId pertenece al remitente o al destinatario, y si el documento forma parte de un sobre.

Documentos en un sobre

El parámetro all de consulta no tiene ningún efecto para los documentos de un sobre.

Con el remitente memberId:

• Se elimina un único documento para el remitente y todos los destinatarios.
• El documento se quita del sobre.

Con el destinatario memberId:

• Todos los documentos del sobre se quitan para el destinatario.
• El destinatario se marca como declined en todos los documentos que se eliminaron para el destinatario.
• Los documentos permanecen disponibles para todos los demás miembros del documento.

Documentos únicos

Con el remitente memberId y all=true:

• El documento se elimina para el remitente y todos los destinatarios.

Con el remitente memberId y all=false:

• El documento solo se elimina para el remitente.
• El documento permanece disponible para los demás destinatarios del documento.

Con el destinatario memberId:

• El destinatario se marca como declined en el documento.
• El documento permanece disponible para todos los demás miembros del documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de miembro	memberId	True	string	Id. de miembro
Eliminar para todos los destinatarios	all		boolean	Solo es relevante para documentos únicos cuando el proporcionado memberId pertenece al remitente. Si se establece en true, el documento se elimina para el remitente y todos los destinatarios. Si se establece en false, el documento solo se elimina para el remitente y permanece disponible para los demás destinatarios. Este parámetro no tiene ningún efecto para los documentos de un sobre (valor predeterminado = true) o cuando el proporcionado memberId pertenece a un destinatario.

Devoluciones

response

DeleteDocumentResponse

Obtención del estado de la solicitud

Id. de la operación:

GetSignatureStatus

Obtiene el estado de una solicitud de firma. Devuelve un objeto JSON de documento o un error. El parámetro lo devuelve la solicitud post en el documento y está asociado al correo electrónico de los remitentes.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de miembro	memberId	True	string	Id. de miembro

Devoluciones

Body

DocumentStatusForFlow

Obtener documento

Id. de la operación:

GetDocument

Obtenga el documento firmado como cadena binaria o codificada en Base64.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de miembro	memberId	True	string	Id. de miembro
Formato de descarga	format		string	Especifica el formato de respuesta. Se usa pdf para PDF binario y base64 para una respuesta codificada en Base64. Respuesta de ejemplo base64 : json { "base64": "JVBERi0xLjQKJe..." }

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
base64	base64	string	Contenido PDF codificado en Base64

Definiciones

DeleteDocumentResponse

Eliminar respuesta del documento

string

EnvelopeResponse

Nombre	Ruta de acceso	Tipo	Description
folderId	folderId	string
folderName	folderName	string
documentos	documents	array of object
id	documents.id	string
name	documents.name	string
language	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Fecha y hora en que los recordatorios comienzan a enviarse (cadena de fecha y hora ISO 8601)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	Fecha y hora en que se creó el documento (cadena de fecha y hora ISO 8601)
callbackUrl	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
signingRound	documents.signingRound	number
isTemplate	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
linkExpiresAt	documents.linkExpiresAt	string
derivedFromLink	documents.derivedFromLink	boolean
state	documents.state	string
complianceLevel	documents.complianceLevel	string
allowForwarding	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
dueDate	documents.dueDate	date-time	Fecha de vencimiento del documento (cadena de fecha y hora ISO 8601)
focusedSigningMode	documents.focusedSigningMode	boolean
linkMaxSignaturesEnabled	documents.linkMaxSignaturesEnabled	boolean
linkMaxSignatures	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
sendOutFinishedPdf	documents.sendOutFinishedPdf	boolean
signatureTypes	documents.signatureTypes	array of string
members	documents.members	array of MemberResponseSchema
miembro	documents.member	MemberResponseSchema
buzones	documents.boxes	array of DocumentResponseBox	Un cuadro de campo de formulario en la respuesta del documento. Esto solo se devuelve si el documento tiene campos de formulario. Si el documento está firmado, el documento devolverá cuadros con los valores que se rellenaron.
vencida	documents.overdue	boolean

DocumentResponseBox

Nombre	Ruta de acceso	Tipo	Description
id	id	string
type	type	string
value	value	string	Valor del campo de cuadro. Puede ser una cadena (incluida la cadena vacía), booleano o null en función del tipo de cuadro.
label	label	string

MemberResponseSchema

Nombre	Ruta de acceso	Tipo	Description
id	id	string
documentId	documentId	string
email	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	Fecha y hora en que se creó el miembro (cadena de fecha y hora ISO 8601)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Fecha y hora en que se envió la notificación de eliminación (cadena de fecha y hora ISO 8601)
manualMenteLastEmailSent	manuallyLastEmailSent	date-time	Fecha y hora en que se envió el último correo electrónico manual (cadena de fecha y hora ISO 8601)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Datos de posición de firma con campos adicionales específicos de la respuesta. Los campos cardStyle, pageWidth y pageHeight son opcionales y pueden no estar presentes en todas las respuestas de API.
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	Fecha y hora en que el miembro rechazó (cadena de fecha y hora ISO 8601)
signingOrder	signingOrder	number
onDemand	onDemand	string
recipientId	recipientId	string
signatureTypes	signatureTypes	array of string
signatureTypesActive	signatureTypesActive	boolean
privateMessage	privateMessage	string
customId	customId	string
useFastlane	useFastlane	boolean
role	role	string
approvedAt	approvedAt	date-time	Fecha y hora en que se aprobó el miembro (cadena de fecha y hora ISO 8601)
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
firmas	signatures	array of string
signedAt	signedAt	date-time	Fecha y hora en que el miembro firmado (cadena de fecha y hora ISO 8601)

MemberSignaturePositionResponse

Datos de posición de firma con campos adicionales específicos de la respuesta. Los campos cardStyle, pageWidth y pageHeight son opcionales y pueden no estar presentes en todas las respuestas de API.

Nombre	Ruta de acceso	Tipo	Description
Productos		SignaturePositionResponse	Datos de posición de firma con campos adicionales específicos de la respuesta. Los campos cardStyle, pageWidth y pageHeight son opcionales y pueden no estar presentes en todas las respuestas de API.

SignaturePositionResponse

Datos de posición de firma con campos adicionales específicos de la respuesta. Los campos cardStyle, pageWidth y pageHeight son opcionales y pueden no estar presentes en todas las respuestas de API.

Nombre	Ruta de acceso	Tipo	Description
página	page	integer	Número de página, empezando por 0.
x	x	number	Coordenada x de la posición superior izquierda de las firmas
y	y	number	coordenada y de la posición superior izquierda de las firmas
width	width	number	Ancho de la firma.
altura	height	number	Alto de la firma.
cardStyle	cardStyle	string	Estilo visual de la tarjeta de firma. Este campo es opcional y es posible que no se devuelva en todas las respuestas.
pageWidth	pageWidth	number	Ancho de la página en píxeles. Este campo es opcional y es posible que no se devuelva en todas las respuestas.
pageHeight	pageHeight	number	Alto de la página en píxeles. Este campo es opcional y es posible que no se devuelva en todas las respuestas.

DocumentStatusForFlow

Nombre	Ruta de acceso	Tipo	Description
id	id	string
name	name	string
state	state	string	Estado actual del documento. Los valores posibles son: draft, pending, declined, completed, attachment, manualPending, manuallyCompleted
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean