Segno sproof (anteprima)

Usare sign sproof per automatizzare flussi di lavoro di firma elettronica sicuri per documenti PDF e DOCX. Le organizzazioni possono creare richieste di firma singola o multipla, assegnare destinatari e ruoli di firma, tenere traccia dello stato, scaricare pdf completati ed eliminare documenti. Un account Sign a prova, un piano che supporta le azioni selezionate e i tipi di firma e un token API valido sono necessari.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Service	Class	Regions
Copilot Studio	Premium	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Standard	Tutte le aree di App per la logica , ad eccezione delle seguenti:      - Aree di Azure per enti pubblici      - Aree di Azure Cina      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Premium	Tutte le aree di Power Apps , ad eccezione dei seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Premium	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Nome	Supporto dell'API
URL	https://sproof.com
Email	support@sproof.com

Metadati del connettore
Editore	sproof GmbH
Sito web	https://www.sproof.com/en/sign/
Informativa sulla privacy	https://www.sproof.com/en/privacy-policy-app/
Categories	Produttività; Contenuto e file

segno di prova

Overview

sproof Sign consente alle organizzazioni di automatizzare i flussi di lavoro di firma elettronica per documenti PDF e DOCX. Il connettore può creare richieste di firma a documento singolo o buste multi-documento, assegnare destinatari e ruoli di firma, recuperare lo stato della richiesta, scaricare documenti completati ed eliminare documenti.

Prerequisiti

Per usare il connettore, è necessario:

• Un account Sign infallibile.
• Un piano di firma senza problemi con accesso all'API e supporto per le azioni e i tipi di firma necessari.
• Token DELL'API Sign valido.

Authentication

Il connettore usa l'autenticazione basata su token API. Creare una connessione immettendo un token API Sign valido associato all'account. Mantenere il token sicuro e sostituirlo se viene revocato o rigenerato.

Azioni supportate

• Crea una richiesta di firma : crea una richiesta per un documento o una busta contenente più documenti. È possibile configurare destinatari, ruoli di firma, ordine di firma, posizioni di firma e altre impostazioni di invito.
• Creare una richiesta di firma usando segnaposto : crea una richiesta usando segnaposto archiviati in un documento caricato. Le informazioni sul destinatario e le posizioni della firma vengono estratte da tali segnaposto.
• Ottiene lo stato della richiesta : recupera lo stato corrente e lo stato di firma di una richiesta di firma usando il relativo ID membro.
• Recupera documento : scarica un documento come PDF binario o come PDF con codifica Base64.
• Elimina documento : elimina un documento o rimuove l'accesso di un membro, a seconda dell'ID membro fornito, del ruolo del membro e del fatto che il documento appartenga a una busta.

Limitazioni e requisiti noti

• I documenti di input devono essere forniti come contenuto PDF o DOCX con codifica Base64.
• Una busta può contenere un massimo di 25 documenti.
• Quando vengono inviati più documenti, è necessario un nome di busta.
• Le richieste basate su segnaposto richiedono segnaposto formattati correttamente nel documento caricato.
• Per le richieste basate su segnaposto, i destinatari e le posizioni di firma vengono ottenuti dal documento anziché immessi manualmente.
• Le azioni disponibili, i tipi di firma e i provider dipendono dall'account sign e dal piano di firma connessi.
• Il comportamento di eliminazione dei documenti dipende dal fatto che l'ID membro fornito appartenga al mittente o a un destinatario e che il documento faccia parte di una busta.

Support

Per il supporto del connettore o dell'API, contattare support@sproof.com.

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita	Parametri per la creazione della connessione.	Tutte le aree geografiche	Non condivisibile

Predefinito

Applicabile: tutte le regioni

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome	Tipo	Description	Obbligatorio
token	securestring	API "token" für diese	True

Azioni

Creare una richiesta di firma	Si tratta della nuova richiesta di creazione della firma. Oltre a creare un singolo invito a un documento, ora supporta la creazione di buste e il caricamento di più documenti contemporaneamente durante l'invio di inviti.
Creare una richiesta di firma usando segnaposto	Crea una richiesta di firma utilizzando segnaposto archiviati nel documento caricato. I destinatari e le posizioni delle firme vengono estratti dal documento.
Elimina documento	Elimina un documento o rimuove l'accesso di un membro, a seconda che l'oggetto fornito memberId appartenga al mittente o a un destinatario e che il documento faccia parte di una busta. Documenti in busta Il parametro all di query non ha alcun effetto per i documenti in una busta. Con il mittente memberId: Viene eliminato un singolo documento per il mittente e tutti i destinatari. Il documento viene rimosso dalla busta. Con il destinatario memberId: Tutti i documenti nella busta vengono rimossi per il destinatario. Il destinatario viene contrassegnato come declined in tutti i documenti eliminati per il destinatario. I documenti rimangono disponibili per tutti gli altri membri del documento. Singoli documenti Con il mittente memberId e all=true: Il documento viene eliminato per il mittente e per tutti i destinatari. Con il mittente memberId e all=false: Il documento viene eliminato solo per il mittente. Il documento rimane disponibile per gli altri destinatari del documento. Con il destinatario memberId: Il destinatario è contrassegnato come declined nel documento. Il documento rimane disponibile per tutti gli altri membri del documento.
Ottenere lo stato della richiesta	Ottenere lo stato di una richiesta di firma. Restituisce un oggetto JSON del documento o un errore. Il parametro viene restituito dalla richiesta post sul documento ed è associato al messaggio di posta elettronica dei mittenti.
Ottenere un documento	Ottiene un documento firmato come stringa binaria o con codifica Base64.

Creare una richiesta di firma

ID operazione:

CreateSignatureRequest

Si tratta della nuova richiesta di creazione della firma. Oltre a creare un singolo invito a un documento, ora supporta la creazione di buste e il caricamento di più documenti contemporaneamente durante l'invio di inviti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
email	email	True	string	Messaggio di posta elettronica del mittente. Deve appartenere a un membro del piano.
firstName	firstName	True	string	Nome del mittente.
lastName	lastName		string	Cognome del mittente.
Ruolo	role		string	Ruolo del mittente in tutti i documenti.
email	email		string	Messaggio di posta elettronica del destinatario.
firstName	firstName		string	Nome del destinatario.
lastName	lastName		string	Cognome del destinatario.
doNotSendEmails	doNotSendEmails		boolean	Se impostato su true nessun messaggio di posta elettronica viene inviato al destinatario.
customId	customId		string	Da usare solo quando l'indirizzo di posta elettronica del destinatario è sconosciuto al momento dell'invito. Questo funziona solo quando si invitano i destinatari (non per le route di preparazione) e si vuole usare fastlane. customId consente di pre-generare un collegamento di firma univoco per un destinatario prima di inviare un invito. Deve essere una stringa alfanumerica univoca di almeno 70 caratteri. Nota: customId può essere usato solo per compilare il collegamento del destinatario a un documento. Non può essere usato per altre richieste anziché per memberId. Per informazioni dettagliate sulla costruzione di URL, vedere Apertura di un documento con un ID personalizzato
useFastlane	useFastlane		boolean	Se impostato sul true firmatario riceve un collegamento Fastlane nel messaggio di posta elettronica di invito.
phoneNumber	phoneNumber		string	Numero di telefono del destinatario. Viene usato per la verifica TRAMITE SMS. (ad esempio: +43 699 1234 1234).
privateMessage	privateMessage		string	Messaggio privato per questo destinatario specifico.
inPersonMode	inPersonMode		boolean	Quando questa opzione è abilitata, il destinatario della richiesta di firma dovrà firmare il documento di persona e non viene inviato alcun messaggio di posta elettronica. Questa modalità è disponibile solo usando il tipo di firma SES
signatureTypes	signatureTypes		array of string	Tipi di firme consentite per il destinatario. Opzioni: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Questo tag determina il provider di identità che verrà usato per il processo di firma. Scegliere tra un set predefinito di provider supportati. Nota1: Alcuni provider sono disponibili solo per determinati signatureType, ad esempio onetimeqes richiederanno "signatureType" : ["qualifiedPlusIdent"] Nota2: Quando si usa sproof-qualified come provider predefinito, il destinatario deve avere un account a prova attivo con una licenza User+ attiva.
canChange	canChange		boolean	Valore booleano per indicare se il destinatario invitato deve essere in grado di modificare il provider di firme
country	country		string	Il paese predefinito, se vuoto è impostato su tutti, verrà restituito un errore con i paesi disponibili per il tag del provider scelto
DueDate	dueDate		YYYY-MM-DD	Data fino alla quale il documento può essere firmato. Questa data di scadenza viene visualizzata al destinatario nel messaggio di posta elettronica di invito ed è visibile anche nella sezione dei dettagli del documento del dashboard. Funge da scadenza per completare il processo di firma.
reminderInterval	reminderInterval		number	Specifica il numero di giorni tra i messaggi di posta elettronica dei promemoria.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Data da cui inviare promemoria
inviteLanguage	inviteLanguage		string	Specifica la lingua dei messaggi di posta elettronica inviati a utenti anonimi che non dispongono di un account. Per gli utenti con un account, verrà invece usata la lingua selezionata nel profilo.
message	message		string	Messaggio personalizzato inviato ai destinatari all'interno del messaggio di posta elettronica.
subject	subject		string	Riga dell'oggetto del messaggio di posta elettronica inviato ai destinatari.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Se impostato su true, il pdf viene inviato come allegato a tutti i destinatari del documento (se è inferiore a 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Quando questa opzione è abilitata, il destinatario della richiesta di firma sarà limitato alla firma o al rifiuto del documento e non sarà in grado di spostarsi dalla pagina.
allowForwarding	allowForwarding		boolean	Consentire l'inoltro dell'invito.
collabSigningMode	collabSigningMode		object	Oggetto in cui ogni chiave rappresenta un ciclo di firma e il valore corrispondente indica se la firma collaborativa è abilitata per tale round. Se il valore è true, è necessaria una sola firma per completare l'arrotondamento di firma specificato e procedere con il round successivo. Ad esempio, { '1': true } significa che nella firma '1' è necessaria una sola firma.
usePlaceholders	usePlaceholders		boolean	Se true, i segnaposto di testo/formFields archiviati nel documento verranno utilizzati per invitare i destinatari.
inPersonSigning	inPersonSigning		boolean	Se true, il destinatario ottiene un popup in cui deve disegnare manualmente una firma
folderName	folderName		string	Se specificato, verrà creata una busta contenente tutti i documenti in documentDataArray. (Obbligatorio se vengono inviati più documenti)
callbackUrl	callbackUrl		string	Una richiesta POST, incluso il documento, verrà inviata a questo URL quando viene creata una nuova firma o quando un destinatario rifiuta il documento. In caso di errore, viene eseguito un meccanismo di ripetizione dei tentativi per assicurarsi che la richiesta venga ritentata.
returnUrl	returnUrl		string	Collegamento del pulsante restituito dopo la firma di un documento
returnBtnText	returnBtnText		string	Testo del pulsante restituito dopo la firma di un documento
Dati	data	True	string	Dati del documento (PDF o DOCX) in formato base64.
mimetype	mimetype		string	Tipo MIME di dati con codifica Base64 PDF o DOCX, obbligatorio se il documento non è un pdf
fileName	fileName	True	string	Nome del file
label	label		string	Etichetta personalizzata che può essere inviata per organizzare i documenti.
pagina	page	True	integer	Numero della pagina in cui si trova la casella, con la prima pagina impostata su 0.
Pagewidth	pageWidth		integer	Qualsiasi valore intero che descrive la larghezza della pagina. Maggiore è il numero, maggiore è la precisione durante il posizionamento della casella nello spazio x y. In una pagina A4 il valore predefinito è 478.
Pageheight	pageHeight		integer	Qualsiasi valore intero che descrive l'altezza della pagina. Maggiore è il numero, maggiore è la precisione durante il posizionamento della casella nello spazio x y. In una pagina A4 il valore predefinito è 676.
x	x	True	float	Rappresenta la posizione orizzontale della casella come percentuale della larghezza della pagina. L'origine (0,0) si trova in alto a sinistra nella pagina. Il valore 0,1 indica che la casella è posizionata a 10% della larghezza della pagina a sinistra.
y	y	True	float	Rappresenta la posizione verticale della casella come percentuale dell'altezza della pagina. L'origine (0,0) si trova in alto a sinistra nella pagina. Il valore 0,1 indica che la casella è posizionata a 10% dell'altezza della pagina dall'alto.
width	width	True	float	Larghezza della casella in base alle dimensioni della pagina, analogamente alle coordinate x e y. Si tratta di un valore float che rappresenta una percentuale di pageWidth.
height	height	True	float	Altezza della casella in base alle dimensioni della pagina, simili alle coordinate x e y. Si tratta di un valore float che rappresenta una percentuale di pageHeight.
id	id	True	string	ID univoco per questa casella, generato in qualsiasi modo.
label	label		string	Testo segnaposto, ad esempio il nome del campo, ad esempio "Data di nascita".
value	value		string	Valore predefinito per la casella. Può essere Null. Se la casella è di tipo 'chooseBox', il valore può essere Null o una delle stringhe definite nelle opzioni.
sola lettura	readonly		boolean	Se impostato su true, la persona invitata non può modificare il valore di questa casella.
required	required		boolean	Se impostato su true, la persona invitata non può firmare il documento senza compilare questa casella.
type	type	True	string
multilinea	multiline		boolean	Indica se sono consentite più righe.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Ogni casella di opzione può essere assegnata a un gruppo.
signatureTypes	signatureTypes		array of string	I tipi di firme consentiti per questo destinatario possono essere sovrascritti dai tipi di firma del destinatario. Opzioni: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId è un campo facoltativo usato per fare riferimento incrociato al documento caricato. Se specificato, consente di assegnare un identificatore di riferimento personalizzato al documento, che verrà restituito come parte dell'oggetto documento nelle risposte API future. Ciò può essere utile per tenere traccia o organizzare i documenti in base a un sistema esterno o a un flusso di lavoro.
language	language		string	Lingua del documento.
folderId	folderId		string	ID di una cartella in cui inserire i documenti. Ciò è possibile solo quando inviteData e folderName non sono definiti.
isAttachment	isAttachment		boolean	isAttachment non è necessario in questo caso.
Dettagli destinatario	recipientDetails	True	object	Dettagli del destinatario con chiave tramite posta elettronica del destinatario. Esempio: {""mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}.
useFastlane	useFastlane		boolean	Se impostato sul true firmatario riceve un collegamento Fastlane nel messaggio di posta elettronica di invito.
fastlaneProfileId	fastlaneProfileId		uuid	Specificare il profilo Fastlane che deve essere utilizzato con questo documento. (useFastlane deve essere impostato su true).

Valori restituiti

Corpo

EnvelopeResponse

Creare una richiesta di firma usando segnaposto

ID operazione:

CreateSignatureRequestUsingPlaceholders

Crea una richiesta di firma utilizzando segnaposto archiviati nel documento caricato. I destinatari e le posizioni delle firme vengono estratti dal documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
email	email	True	string	Messaggio di posta elettronica del mittente. Deve appartenere a un membro del piano.
firstName	firstName	True	string	Nome del mittente.
lastName	lastName		string	Cognome del mittente.
Ruolo	role		string	Ruolo del mittente in tutti i documenti.
email	email		string	Messaggio di posta elettronica del destinatario.
firstName	firstName		string	Nome del destinatario.
lastName	lastName		string	Cognome del destinatario.
doNotSendEmails	doNotSendEmails		boolean	Se impostato su true nessun messaggio di posta elettronica viene inviato al destinatario.
customId	customId		string	Da usare solo quando l'indirizzo di posta elettronica del destinatario è sconosciuto al momento dell'invito. Questo funziona solo quando si invitano i destinatari (non per le route di preparazione) e si vuole usare fastlane. customId consente di pre-generare un collegamento di firma univoco per un destinatario prima di inviare un invito. Deve essere una stringa alfanumerica univoca di almeno 70 caratteri. Nota: customId può essere usato solo per compilare il collegamento del destinatario a un documento. Non può essere usato per altre richieste anziché per memberId. Per informazioni dettagliate sulla costruzione di URL, vedere Apertura di un documento con un ID personalizzato
useFastlane	useFastlane		boolean	Se impostato sul true firmatario riceve un collegamento Fastlane nel messaggio di posta elettronica di invito.
phoneNumber	phoneNumber		string	Numero di telefono del destinatario. Viene usato per la verifica TRAMITE SMS. (ad esempio: +43 699 1234 1234).
privateMessage	privateMessage		string	Messaggio privato per questo destinatario specifico.
inPersonMode	inPersonMode		boolean	Quando questa opzione è abilitata, il destinatario della richiesta di firma dovrà firmare il documento di persona e non viene inviato alcun messaggio di posta elettronica. Questa modalità è disponibile solo usando il tipo di firma SES
signatureTypes	signatureTypes		array of string	Tipi di firme consentite per il destinatario. Opzioni: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Questo tag determina il provider di identità che verrà usato per il processo di firma. Scegliere tra un set predefinito di provider supportati. Nota1: Alcuni provider sono disponibili solo per determinati signatureType, ad esempio onetimeqes richiederanno "signatureType" : ["qualifiedPlusIdent"] Nota2: Quando si usa sproof-qualified come provider predefinito, il destinatario deve avere un account a prova attivo con una licenza User+ attiva.
canChange	canChange		boolean	Valore booleano per indicare se il destinatario invitato deve essere in grado di modificare il provider di firme
country	country		string	Il paese predefinito, se vuoto è impostato su tutti, verrà restituito un errore con i paesi disponibili per il tag del provider scelto
DueDate	dueDate		YYYY-MM-DD	Data fino alla quale il documento può essere firmato. Questa data di scadenza viene visualizzata al destinatario nel messaggio di posta elettronica di invito ed è visibile anche nella sezione dei dettagli del documento del dashboard. Funge da scadenza per completare il processo di firma.
reminderInterval	reminderInterval		number	Specifica il numero di giorni tra i messaggi di posta elettronica dei promemoria.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Data da cui inviare promemoria
inviteLanguage	inviteLanguage		string	Specifica la lingua dei messaggi di posta elettronica inviati a utenti anonimi che non dispongono di un account. Per gli utenti con un account, verrà invece usata la lingua selezionata nel profilo.
message	message		string	Messaggio personalizzato inviato ai destinatari all'interno del messaggio di posta elettronica.
subject	subject		string	Riga dell'oggetto del messaggio di posta elettronica inviato ai destinatari.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Se impostato su true, il pdf viene inviato come allegato a tutti i destinatari del documento (se è inferiore a 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Quando questa opzione è abilitata, il destinatario della richiesta di firma sarà limitato alla firma o al rifiuto del documento e non sarà in grado di spostarsi dalla pagina.
allowForwarding	allowForwarding		boolean	Consentire l'inoltro dell'invito.
collabSigningMode	collabSigningMode		object	Oggetto in cui ogni chiave rappresenta un ciclo di firma e il valore corrispondente indica se la firma collaborativa è abilitata per tale round. Se il valore è true, è necessaria una sola firma per completare l'arrotondamento di firma specificato e procedere con il round successivo. Ad esempio, { '1': true } significa che nella firma '1' è necessaria una sola firma.
inPersonSigning	inPersonSigning		boolean	Se true, il destinatario ottiene un popup in cui deve disegnare manualmente una firma
folderName	folderName		string	Se specificato, verrà creata una busta contenente tutti i documenti in documentDataArray. (Obbligatorio se vengono inviati più documenti)
callbackUrl	callbackUrl		string	Una richiesta POST, incluso il documento, verrà inviata a questo URL quando viene creata una nuova firma o quando un destinatario rifiuta il documento. In caso di errore, viene eseguito un meccanismo di ripetizione dei tentativi per assicurarsi che la richiesta venga ritentata.
returnUrl	returnUrl		string	Collegamento del pulsante restituito dopo la firma di un documento
returnBtnText	returnBtnText		string	Testo del pulsante restituito dopo la firma di un documento
Dati	data	True	string	Dati del documento (PDF o DOCX) in formato base64.
mimetype	mimetype		string	Tipo MIME di dati con codifica Base64 PDF o DOCX, obbligatorio se il documento non è un pdf
fileName	fileName	True	string	Nome del file
label	label		string	Etichetta personalizzata che può essere inviata per organizzare i documenti.
pagina	page	True	integer	Numero della pagina in cui si trova la casella, con la prima pagina impostata su 0.
Pagewidth	pageWidth		integer	Qualsiasi valore intero che descrive la larghezza della pagina. Maggiore è il numero, maggiore è la precisione durante il posizionamento della casella nello spazio x y. In una pagina A4 il valore predefinito è 478.
Pageheight	pageHeight		integer	Qualsiasi valore intero che descrive l'altezza della pagina. Maggiore è il numero, maggiore è la precisione durante il posizionamento della casella nello spazio x y. In una pagina A4 il valore predefinito è 676.
x	x	True	float	Rappresenta la posizione orizzontale della casella come percentuale della larghezza della pagina. L'origine (0,0) si trova in alto a sinistra nella pagina. Il valore 0,1 indica che la casella è posizionata a 10% della larghezza della pagina a sinistra.
y	y	True	float	Rappresenta la posizione verticale della casella come percentuale dell'altezza della pagina. L'origine (0,0) si trova in alto a sinistra nella pagina. Il valore 0,1 indica che la casella è posizionata a 10% dell'altezza della pagina dall'alto.
width	width	True	float	Larghezza della casella in base alle dimensioni della pagina, analogamente alle coordinate x e y. Si tratta di un valore float che rappresenta una percentuale di pageWidth.
height	height	True	float	Altezza della casella in base alle dimensioni della pagina, simili alle coordinate x e y. Si tratta di un valore float che rappresenta una percentuale di pageHeight.
id	id	True	string	ID univoco per questa casella, generato in qualsiasi modo.
label	label		string	Testo segnaposto, ad esempio il nome del campo, ad esempio "Data di nascita".
value	value		string	Valore predefinito per la casella. Può essere Null. Se la casella è di tipo 'chooseBox', il valore può essere Null o una delle stringhe definite nelle opzioni.
sola lettura	readonly		boolean	Se impostato su true, la persona invitata non può modificare il valore di questa casella.
required	required		boolean	Se impostato su true, la persona invitata non può firmare il documento senza compilare questa casella.
type	type	True	string
multilinea	multiline		boolean	Indica se sono consentite più righe.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Ogni casella di opzione può essere assegnata a un gruppo.
signatureTypes	signatureTypes		array of string	I tipi di firme consentiti per questo destinatario possono essere sovrascritti dai tipi di firma del destinatario. Opzioni: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId è un campo facoltativo usato per fare riferimento incrociato al documento caricato. Se specificato, consente di assegnare un identificatore di riferimento personalizzato al documento, che verrà restituito come parte dell'oggetto documento nelle risposte API future. Ciò può essere utile per tenere traccia o organizzare i documenti in base a un sistema esterno o a un flusso di lavoro.
language	language		string	Lingua del documento.
folderId	folderId		string	ID di una cartella in cui inserire i documenti. Ciò è possibile solo quando inviteData e folderName non sono definiti.
isAttachment	isAttachment		boolean	isAttachment non è necessario in questo caso.
useFastlane	useFastlane		boolean	Se impostato sul true firmatario riceve un collegamento Fastlane nel messaggio di posta elettronica di invito.
fastlaneProfileId	fastlaneProfileId		uuid	Specificare il profilo Fastlane che deve essere utilizzato con questo documento. (useFastlane deve essere impostato su true).

Valori restituiti

Corpo

EnvelopeResponse

Elimina documento

ID operazione:

DeleteDocument

Elimina un documento o rimuove l'accesso di un membro, a seconda che l'oggetto fornito memberId appartenga al mittente o a un destinatario e che il documento faccia parte di una busta.

Documenti in busta

Il parametro all di query non ha alcun effetto per i documenti in una busta.

Con il mittente memberId:

• Viene eliminato un singolo documento per il mittente e tutti i destinatari.
• Il documento viene rimosso dalla busta.

Con il destinatario memberId:

• Tutti i documenti nella busta vengono rimossi per il destinatario.
• Il destinatario viene contrassegnato come declined in tutti i documenti eliminati per il destinatario.
• I documenti rimangono disponibili per tutti gli altri membri del documento.

Singoli documenti

Con il mittente memberId e all=true:

• Il documento viene eliminato per il mittente e per tutti i destinatari.

Con il mittente memberId e all=false:

• Il documento viene eliminato solo per il mittente.
• Il documento rimane disponibile per gli altri destinatari del documento.

Con il destinatario memberId:

• Il destinatario è contrassegnato come declined nel documento.
• Il documento rimane disponibile per tutti gli altri membri del documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID membro	memberId	True	string	ID membro
Elimina per tutti i destinatari	all		boolean	Rilevante solo per i singoli documenti quando l'oggetto fornito memberId appartiene al mittente. Se impostato su true, il documento viene eliminato per il mittente e per tutti i destinatari. Se impostato su false, il documento viene eliminato solo per il mittente e rimane disponibile per gli altri destinatari. Questo parametro non ha alcun effetto per i documenti in una busta (impostazione predefinita = true) o quando l'oggetto fornito memberId appartiene a un destinatario.

Valori restituiti

response

DeleteDocumentResponse

Ottenere lo stato della richiesta

ID operazione:

GetSignatureStatus

Ottenere lo stato di una richiesta di firma. Restituisce un oggetto JSON del documento o un errore. Il parametro viene restituito dalla richiesta post sul documento ed è associato al messaggio di posta elettronica dei mittenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID membro	memberId	True	string	ID membro

Valori restituiti

Corpo

DocumentStatusForFlow

Ottenere un documento

ID operazione:

GetDocument

Ottiene un documento firmato come stringa binaria o con codifica Base64.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID membro	memberId	True	string	ID membro
Formato di download	format		string	Specifica il formato di risposta. Usare pdf per file PDF binari e base64 per una risposta con codifica Base64. Risposta di esempio base64 : json { "base64": "JVBERi0xLjQKJe..." }

Valori restituiti

Nome	Percorso	Tipo	Descrizione
base64	base64	string	Contenuto PDF con codifica Base64

Definizioni

DeleteDocumentResponse

Elimina risposta documento

string

EnvelopeResponse

Nome	Percorso	Tipo	Descrizione
folderId	folderId	string
folderName	folderName	string
Documenti	documents	array of object
id	documents.id	string
nome	documents.name	string
language	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Data e ora in cui i promemoria iniziano a essere inviati (stringa datetime ISO 8601)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	Data e ora di creazione del documento (stringa datetime 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	Scadenza del documento (stringa datetime 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
membro	documents.member	MemberResponseSchema
Scatole	documents.boxes	array of DocumentResponseBox	Casella del campo modulo nella risposta al documento. Viene restituito solo se il documento contiene campi modulo. Se il documento è firmato, il documento restituirà caselle con i valori compilati.
scaduto	documents.overdue	boolean

DocumentResponseBox

Nome	Percorso	Tipo	Descrizione
id	id	string
type	type	string
value	value	string	Valore del campo casella. Può essere una stringa (inclusa una stringa vuota), un valore booleano o null a seconda del tipo di casella.
label	label	string

MemberResponseSchema

Nome	Percorso	Tipo	Descrizione
id	id	string
documentId	documentId	string
email	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	Data e ora di creazione del membro (stringa datetime ISO 8601)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Data e ora di invio della notifica di eliminazione (stringa datetime ISO 8601)
manuallyLastEmailSent	manuallyLastEmailSent	date-time	Data e ora dell'invio dell'ultimo messaggio di posta elettronica manuale (stringa datetime ISO 8601)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Dati sulla posizione della firma con campi aggiuntivi specifici della risposta. I campi cardStyle, pageWidth e pageHeight sono facoltativi e potrebbero non essere presenti in tutte le risposte api.
doNotSendEmails	doNotSendEmails	boolean
rifiutatoAt	declinedAt	date-time	Data e ora in cui il membro ha rifiutato (stringa datetime 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
Ruolo	role	string
approvedAt	approvedAt	date-time	Data e ora di approvazione del membro (stringa datetime ISO 8601)
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
Firme	signatures	array of string
signedAt	signedAt	date-time	Data e ora di firma del membro (stringa datetime ISO 8601)

MemberSignaturePositionResponse

Dati sulla posizione della firma con campi aggiuntivi specifici della risposta. I campi cardStyle, pageWidth e pageHeight sono facoltativi e potrebbero non essere presenti in tutte le risposte api.

Nome	Percorso	Tipo	Descrizione
Elementi		SignaturePositionResponse	Dati sulla posizione della firma con campi aggiuntivi specifici della risposta. I campi cardStyle, pageWidth e pageHeight sono facoltativi e potrebbero non essere presenti in tutte le risposte api.

SignaturePositionResponse

Dati sulla posizione della firma con campi aggiuntivi specifici della risposta. I campi cardStyle, pageWidth e pageHeight sono facoltativi e potrebbero non essere presenti in tutte le risposte api.

Nome	Percorso	Tipo	Descrizione
pagina	page	integer	Numero di pagina, a partire da 0.
x	x	number	coordinata x della posizione superiore sinistra delle firme
y	y	number	Coordinata y della posizione superiore sinistra delle firme
width	width	number	Larghezza della firma.
height	height	number	Altezza della firma.
cardStyle	cardStyle	string	Stile di visualizzazione della scheda della firma. Questo campo è facoltativo e potrebbe non essere restituito in tutte le risposte.
Pagewidth	pageWidth	number	Larghezza della pagina in pixel. Questo campo è facoltativo e potrebbe non essere restituito in tutte le risposte.
Pageheight	pageHeight	number	Altezza della pagina in pixel. Questo campo è facoltativo e potrebbe non essere restituito in tutte le risposte.

DocumentStatusForFlow

Nome	Percorso	Tipo	Descrizione
id	id	string
nome	name	string
state	state	string	Stato corrente del documento. I valori possibili sono: draft, pending, declined, completed, attachment, manuallyPending, manuallyCompleted
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean