Foxit eSign (anteprima)

Foxit eSign è una soluzione di firma elettronica che consente di inviare, firmare e gestire documenti online, eliminando la necessità di stampa, scansione o mailing. Caricare il documento, definire i campi della firma e inviarli ai destinatari per l'associazione legale rapida e legale delle eSignature.

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)

Contact
Name	Supporto di Foxit eSign
URL	https://www.foxit.com
Email	api@foxit.com

Metadati del connettore
Editore	Foxit Software Inc.
Sito web	https://www.foxit.com/esign-pdf/
Informativa sulla privacy	https://www.foxit.com/company/privacy-policy.html
Categorie	Produttività; Contenuto e file

Foxit eSign

Foxit eSign è una soluzione di firma elettronica di livello aziendale che consente alle aziende di inviare, firmare e gestire documenti legalmente vincolanti interamente online, eliminando la necessità di stampa, scansione o mailing. Caricare il documento, definire i campi della firma e inviarli ai destinatari per eSignature veloci e sicure. Foxit eSign è completamente conforme alle principali leggi sulla firma elettronica, tra cui ESIGN e UETA, usa la crittografia per proteggere i documenti in transito e inattivi e supporta l'autenticazione a più fattori per garantire che solo i firmatari autorizzati possano accedere e firmare i documenti.

Il connettore Foxit eSign per Microsoft Power Automate consente di automatizzare il flusso di lavoro completo di firma dei documenti, dalla creazione di buste e dall'invio di buste per la firma, al rilevamento dello stato, al download di documenti completati, alla gestione dei modelli e all'attivazione di azioni downstream quando si verificano gli eventi della busta.

Publisher: Foxit Corporation

Prerequisiti

Per usare questo connettore, è necessario:

Un piano di Microsoft Power Apps o di Power Automate con connettore personalizzato o accesso al connettore Premium
Un account Foxit eSign : crearne uno qui
Accesso all'API abilitato nell'account Foxit eSign (vedere Ottenere credenziali di seguito)

Recupero delle credenziali

Creare un account Foxit eSign se non ne è già disponibile uno.
Contattare il team di Foxit Sales per richiedere l'accesso all'API da abilitare nell'account. Dopo l'approvazione, l'accesso all'API verrà attivato nell'account.
In Power Automate cercare Foxit eSign nell'elenco dei connettori e selezionare Crea connessione.
Si verrà reindirizzati alla pagina di accesso di Foxit eSign. Accedere con le credenziali di Foxit eSign per autorizzare la connessione.
Una volta autorizzata, la connessione è pronta per l'uso nei flussi.

Getting Started

Dopo aver creato una connessione, è possibile iniziare a creare flussi usando il connettore Foxit eSign:

Usare i trigger per avviare automaticamente un flusso quando si verifica un evento envelope, ad esempio quando tutte le parti hanno firmato.
Usare le azioni per creare buste, inviare promemoria di firma, scaricare documenti completati, gestire modelli e altro ancora.
Concatenare più azioni, ad esempio creare una busta da un modello, attendere il trigger completamente eseguito, quindi scaricare il documento firmato e archiviarlo in SharePoint.

Trigger supportati

Grilletto	Description
Quando viene inviata una busta	Viene generato quando una busta viene inviata ai destinatari. Richiede il livello di webhook impostato su Account.
Quando viene visualizzata una busta	Viene generato quando un destinatario apre e visualizza la busta.
Quando una busta è firmata	Viene generato quando un destinatario firma la busta.
Quando una busta viene annullata	Viene generato quando una busta viene annullata da un destinatario o dal mittente.
Quando una busta viene eseguita completamente	Viene generato quando tutti i destinatari hanno firmato e la busta è stata completata completamente.
Quando viene eliminata una busta	Viene generato quando viene eliminata una busta.

Azioni supportate

Buste

Action	Description
Crea busta dall'URL	Crea e invia una busta usando un URL PDF accessibile pubblicamente.
Crea busta da Base64	Crea e invia una busta utilizzando un documento PDF con codifica Base64.
Crea busta da modello	Crea e invia una busta da un modello Foxit eSign esistente.
Ottenere i dettagli della busta	Recupera i dettagli completi e lo stato corrente di una busta.
Ottenere gli ID busta	Recupera un elenco di ID busta in base ai criteri di filtro.
Invia promemoria firma	Invia una notifica di promemoria ai firmatari in sospeso di una busta.
Scaricare i file envelope	Scarica tutti i documenti firmati in una busta come file ZIP.
Scaricare un singolo documento PDF	Scarica un singolo documento da una busta come PDF.
Spostare buste nel Cestino	Sposta una o più buste nel Cestino.
Annulla busta	Annulla una busta e invia una notifica ai destinatari.
Elimina buste	Elimina definitivamente una o più buste.
Get Envelope Activity History	Recupera il log attività completo per una busta.
Ottenere la cronologia busta eliminata	Recupera la cronologia delle buste eliminate nell'account.

Templates

Action	Description
Creare un modello dall'URL	Crea un modello di firma riutilizzabile usando un URL PDF accessibile pubblicamente.
Creare un modello da Base64	Crea un modello di firma riutilizzabile usando un documento PDF con codifica Base64.
Ottenere i dettagli del modello	Recupera i dettagli completi di un modello specifico, incluse le definizioni di campo.
Ottenere modelli in base agli ID modello	Recupera i dettagli per uno o più modelli in base ai relativi ID.
Ottenere un elenco di tutti i modelli	Recupera tutti i modelli disponibili nell'account.

Webhooks

Action	Description
Elencare tutti i canali webhook	Restituisce un elenco di tutti i canali webhook configurati nell'account.
Ottenere i dettagli del canale webhook	Recupera i dettagli di un canale webhook specifico.

Gruppi di posta elettronica

Action	Description
Creare un gruppo di posta elettronica	Crea un nuovo gruppo di posta elettronica da usare come destinatari nelle buste.
Ottenere i dettagli del gruppo di posta elettronica	Recupera i dettagli e i membri di un gruppo di posta elettronica.

Rapporti

Action	Description
Scarica report	Scarica un report attività dell'account in formato Microsoft Excel.

Problemi noti e limitazioni

Limite di frequenza: l'API Foxit eSign consente fino a 4.000 richieste per 5 minuti per account. Le richieste che superano questo limite ricevono una 429 Too Many Requests risposta. È consigliabile implementare la logica di ripetizione dei tentativi con backoff esponenziale nei flussi per gestire questo comportamento normalmente.
Limite dimensioni file: la dimensione massima del file per documento è 25 MB. Questo limite si applica ai singoli file, non alle dimensioni totali della busta.
Annullamento automatico del webhook: a causa di una limitazione nell'API di eliminazione webhook Foxit eSign (che usa un metodo POST anziché DELETE), Power Automate non può pulire automaticamente le sottoscrizioni del canale webhook quando un flusso basato su trigger viene eliminato o modificato. Usare l'azione Elenca tutti i canali webhook per identificare i canali attivi e il portale Foxit eSign per rimuovere le sottoscrizioni quando si rimuove un flusso.
Quando viene inviata una busta - Solo a livello di account: il trigger "Quando viene inviata una busta" viene attivato solo quando il livello del webhook è impostato su Account. Non viene attivato per le buste create a livello di app per le API . Assicurarsi di selezionare Livello account durante la configurazione di questo trigger.
Disponibilità a livello di area: il connettore è disponibile sia per gli account Dell'America del Nord (NA1) che per l'area dell'UE. Selezionare l'area del server appropriata durante la configurazione della connessione. La connessione all'area errata genererà errori di autenticazione.
Dimensioni documento Base64: quando si usa l'opzione Crea busta da Base64 o Crea modello dalle azioni Base64, la stringa con codifica Base64 deve corrispondere a un file di origine non superiore a 25 MB.

Support

Per il supporto per gli sviluppatori, contattare il team Foxit eSign all'indirizzo devsupport@foxitsoftware.com.

Per inviare un caso di supporto, visitare https://kb.foxit.com/s/submit-a-case.

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Annulla busta	Annulla una busta inviata. I destinatari non potranno più firmare i documenti.
Annullare la sottoscrizione del trigger webhook	Elimina una sottoscrizione del canale webhook attiva in base al relativo ID canale. Usare questa azione per pulire le sottoscrizioni webhook non più necessarie.
Crea busta da Base64	Crea e invia una busta utilizzando un documento PDF con codifica Base64.
Crea busta da modello	Crea e invia una busta usando un modello esistente. I dettagli del destinatario possono essere personalizzati.
Crea busta dall'URL	Crea e invia una busta usando URL PDF accessibili pubblicamente. Specificare gli URL del documento e i dettagli del destinatario per avviare il processo di firma.
Creare un gruppo di posta elettronica	Crea un nuovo gruppo di posta elettronica che può essere usato per inviare buste a più destinatari contemporaneamente.
Creare un modello da Base64	Crea un nuovo modello usando una stringa PDF con codifica Base64. Usare questa opzione quando il file PDF è già disponibile come stringa Base64 nel flusso, ad esempio da un file SharePoint o OneDrive documento.
Creare un modello dall'URL	Crea un nuovo modello usando un URL PDF accessibile pubblicamente.
Elencare tutti i canali webhook	Restituisce un elenco di tutti i canali webhook configurati nell'account.
Elimina buste	Elimina definitivamente una o più buste.
Get Envelope Activity History	Recupera un log attività completo per una busta, che mostra tutte le azioni eseguite dai destinatari e dal mittente.
Invia promemoria firma	Invia una notifica di promemoria ai destinatari in sospeso di una busta, chiedendo loro di completare la firma.
Ottenere gli ID busta	Restituisce un elenco di ID busta filtrati in base allo stato. Utilizzare questa opzione per trovare buste in uno stato specifico.
Ottenere i dettagli del canale webhook	Recupera i dettagli di un canale webhook specifico.
Ottenere i dettagli del gruppo di posta elettronica	Recupera i dettagli di un gruppo di posta elettronica esistente.
Ottenere i dettagli del modello	Recupera i dettagli completi di un modello specifico, inclusi i relativi campi e destinatari.
Ottenere i dettagli della busta	Recupera i dettagli completi di una busta, inclusi lo stato, i destinatari e i documenti.
Ottenere la cronologia busta eliminata	Recupera una cronologia delle buste eliminate o spostate nel Cestino.
Ottenere modelli in base agli ID modello	Recupera i dettagli per uno o più modelli in base ai relativi ID.
Ottenere un elenco di tutti i modelli	Restituisce un elenco di tutti i modelli disponibili nell'account.
Scarica report	Scarica un report attività envelope come file di Microsoft Excel. Usare i filtri per restringere i risultati in base allo stato, all'intervallo di date, al nome della busta, all'autore o al firmatario.
Scaricare i file envelope	Scarica i documenti completati da una busta come file.
Scaricare un singolo documento PDF	Scarica un singolo documento da una busta come file PDF.
Spostare buste nel Cestino	Sposta una o più buste nel Cestino. Le buste nel Cestino non vengono eliminate definitivamente.

Annulla busta

ID operazione:: CancelEnvelope

Annulla una busta inviata. I destinatari non potranno più firmare i documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	folderId	True	integer	ID della busta da annullare.
Motivo dell'annullamento	reason_for_cancellation	True	string	Motivo dell'annullamento della busta. Questa operazione viene registrata nella cronologia delle attività envelope.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
ID buste annullate	folders cancelled	array of integer	Elenco di ID busta annullati correttamente.

Annullare la sottoscrizione del trigger webhook

ID operazione:: DeleteTriggerWebhookChannel

Elimina una sottoscrizione del canale webhook attiva in base al relativo ID canale. Usare questa azione per pulire le sottoscrizioni webhook non più necessarie.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID canale	channelId	True	integer	ID del canale webhook da eliminare.

Crea busta da Base64

ID operazione:: CreateEnvelopefromBase64

Crea e invia una busta utilizzando un documento PDF con codifica Base64.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome busta	folderName	True	string	Nome della busta.
Tipo di input	inputType		string	Tipo di input per l'origine del documento. Correzione di base64 per questa azione.
Stringhe di file Base64	base64FileString	True	array of string	Matrice di documenti PDF con codifica Base64 da inviare.
Nomi file	fileNames	True	array of string	Matrice di nomi visualizzati per ogni documento, nello stesso ordine della matrice Di stringhe di file Base64.
Nome di battesimo	firstName	True	string	Nome del destinatario.
Cognome	lastName	True	string	Cognome del destinatario.
Indirizzo e-mail	emailId	True	string	Indirizzo di posta elettronica del destinatario.
permissions	permission	True	string
Sequenza	sequence	True	integer	Utilizzare questo campo per assegnare un numero di sequenza a un destinatario nell'elenco delle parti destinatari. Usa numeri di sequenza univoci per ogni parte a partire da 1, ad esempio 1,2,3,4. Se una singola persona viene visualizzata più volte nel flusso di lavoro di firma, assegnare una sequenza diversa ogni volta che il destinatario viene ripetuto.
signerAuthLevels	signerAuthLevel		string	Livello di autenticazione che un firmatario userà a scopo di verifica
Segnaposto	isPlaceholder		boolean	Utilizzare questo campo per avviare l'entità è un segnaposto. Nota: 1. firstName, lastName, valore del parametro emailId deve essere vuoto di questa parte. 2. Per aggiungere il segnaposto, è necessario che un destinatario venga rieserito con l'autorizzazione 'PARTY_ASSIGNER'.
Ruolo destinatario	partyRole		string	Utilizzare questo campo per assegnare un ruolo di segnaposto.
Consenti modifica nome	allowNameChange		string	Il valore può essere true o false Usare questo parametro per consentire al firmatario di aggiornare il nome e il cognome prima di completare il processo di firma.
Sequenza flusso di lavoro	workflowSequence		integer	Assegnare un numero di sequenza del flusso di lavoro a questo destinatario. Quando la sequenza di accesso è abilitata, i destinatari ricevono l'invito alla firma in ordine crescente della sequenza.
Id di posta elettronica host	hostEmailId		string	Indirizzo di posta elettronica di In-Person Administrator.
Codice di accesso	userDefinedAccessCode		string	Il parametro conterrà il codice di accesso quando il valore "signerAuthLevel" viene impostato su "Codice di accesso definito dall'utente" per l'autenticazione. Nota: 1. I codici non fanno distinzione tra maiuscole e minuscole. 2. Il sistema non invia questo codice, quindi è necessario condividere questo codice direttamente con il firmatario. 3. Il codice di accesso può contenere alfabeti, numeri e caratteri speciali seguenti: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Usare questo parametro durante la creazione di un'entità come bulk. Nota: Se questo parametro è true, firstName, lastName e emailId di questa parte verranno ignorati.
ID gruppo di posta elettronica	emailGroupId		integer	Passare il messaggio di posta elettronica all'ID del gruppo che si vuole usare per creare operazioni bulk.
Single Signer Bulk	allowSingleSignerInBulk		boolean	Usare questo parametro per consentire a una sola persona di accedere al gruppo di posta elettronica.
Composizione del codice	dialingCode		string	Utilizzare questo campo per assegnare i codici di accesso esterno di un paese sono prefissi di numero di cellulare a un destinatario nell'elenco delle parti destinatari.
Numero di cellulare	mobileNumber		string	Utilizzare questo campo per assegnare un numero di cellulare a un destinatario nell'elenco delle parti destinatari.
Campi	Fields		object
Invia ora	sendNow		boolean	Se abilitata, Foxit eSign invia immediatamente un collegamento di firma univoco all'indirizzo di posta elettronica di ogni destinatario. Disabilitare questa opzione per salvare la busta come bozza.
Creare una sessione di firma incorporata	createEmbeddedSigningSession	True	boolean	Il token di sessione di firma verrà generato senza inviare messaggi di posta elettronica ai destinatari.
Creare una sessione di firma incorporata per tutte le parti	createEmbeddedSigningSessionForAllParties		boolean	Se impostato su true, verrà generato un URL di firma incorporato per ogni destinatario nella busta.
Elaborare tag di testo	processTextTags	True	boolean	Il valore può essere true o false. Questo campo viene usato per determinare se Foxit eSign deve analizzare i documenti per i tag di testo per convertirli in campi Foxit eSign.
Elaborare campi Acro	processAcroFields	True	boolean	Questo campo viene usato per determinare se Foxit eSign deve analizzare i documenti per AcroFields per convertirli in campi Foxit eSign.
Sequenza di accesso	signInSequence		boolean	Questo campo viene utilizzato per determinare se i destinatari firmeranno i documenti della busta in una sequenza. Se false, tutti i destinatari ricevono contemporaneamente un messaggio di posta elettronica di invito. Se true, ogni destinatario riceve un messaggio di posta elettronica di invito successivamente dopo che il destinatario precedente completa l'attività richiesta, ad esempio firmare i documenti o compilare i campi e così via.
Abilitazione in persona	inPersonEnable		boolean	Questo campo viene usato per avviare il processo di firma di persona che può essere facilmente completato in qualsiasi dispositivo in pochi minuti ed evita firme basate sulla posta elettronica, se necessario. Se false, tutti i destinatari ricevono simultaneamente il messaggio di posta elettronica di invito. Se true, l'amministratore di persona riceve un messaggio di posta elettronica di invito per avviare il processo di firma per il firmatario.
Correggere le entità destinatari	fixRecipientParties		boolean	Se true, nella visualizzazione di invio incorporata non è possibile modificare le parti per la busta che sono già state aggiunte come parte di questa richiesta.
Correggere i documenti	fixDocuments		boolean	Se true, nell'invio incorporato non è possibile modificare i documenti per la busta già aggiunti come parte di questa richiesta.
Invia URL operazione riuscita	sendSuccessUrl		string	Immettere l'URL assoluto per la pagina di destinazione a cui verrà reindirizzato il firmatario dopo l'invio della cartella nella visualizzazione di invio incorporata.
URL di errore di invio	sendErrorUrl		string	Immettere l'URL assoluto per la pagina di destinazione, a cui verrà reindirizzato il firmatario se si verifica un errore durante l'invio della cartella nella visualizzazione di invio incorporata.
Creare una sessione di invio incorporata	createEmbeddedSendingSession		boolean	Se impostato su true, genererà un token incorporato per aprire il documento che prepara la visualizzazione di Foxit eSign.
ID di posta elettronica dei firmatari incorporati	embeddedSignersEmailIds		array of string	Matrice di ID di posta elettronica dei destinatari per i quali deve essere creata una sessione di firma incorporata. ID di posta elettronica delle parti destinatari aggiunte nell'elenco delle parti.
Sign Success Url	signSuccessUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà eseguito correttamente l'accesso nella visualizzazione di firma incorporata.
Url di rifiuto del segno	signDeclineUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà eseguito il reindirizzamento in caso di rifiuto di accedere alla visualizzazione di firma incorporata.
Firma url successivo	signLaterUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà reindirizzato se sceglie di accedere in un secondo momento nella visualizzazione di firma incorporata.
URL errore di firma	signErrorUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà reindirizzato se si verifica un errore durante la firma del documento nella visualizzazione di firma incorporata.
Consenti sessione di invio ora e firma incorporata	allowSendNowAndEmbeddedSigningSession		boolean	Se impostato su true, Foxit eSign invierà un collegamento di firma univoco a ogni destinatario. Questo è applicabile SOLO quando i parametri sendNow e createEmbeddedSigningSession sono true.
Convalida avanzata della posta elettronica	allowAdvancedEmailValidation		boolean	Convalidare l'indirizzo di posta elettronica delle parti se impostato su true.
Firma url di operazione riuscita tutte le parti	signSuccessUrlAllParties		boolean	Se impostato su true, il firmatario verrà reindirizzato all'URL specificato in signSuccessUrl dopo la firma. Questo è applicabile solo quando sendNow è true.
ID modello di posta elettronica	emailTemplateId		integer	Passare l'ID modello di posta elettronica per inviare i modelli di posta elettronica diversi dai modelli di posta elettronica predefiniti.
ID istruzione del firmatario	signerInstructionId		integer	Passare l'ID istruzione per inviare istruzioni del firmatario diverse dalle istruzioni predefinite del firmatario.
ID istruzione di conferma	confirmationInstructionId		string	Passare l'ID istruzione di conferma per inviare istruzioni di conferma diverse dalle istruzioni di conferma predefinite.
Colore tema	themeColor		string	Immettere il valore CSS per impostare il colore del tema.
Scadenza sessione	sessionExpire		boolean	Impostare su true per avviare la scadenza della sessione di firma incorporata.
Scadenza	expiry		integer	Obbligatorio se sessionExpire è true. Immettere la durata in millisecondi della scadenza nella sessione di firma incorporata.
Nome campo dipendente	dependentFieldName	True	string	Nome del campo la cui visibilità è controllata dal campo padre.
Nome campo padre	parentFieldName	True	string	Nome del campo padre il cui valore controlla la visibilità del campo dipendente. Tipi di campo padre supportati: textfield, casella di testo, casella di controllo, pulsante di opzione, elenco a discesa.
Valore campo padre	parentFieldValue	True	string	Valore del campo padre che attiva la visualizzazione del campo dipendente. Per i campi casella di controllo e pulsante di opzione, usare selezionato o deselezionato.
Opzioni	options	True	string	Opzioni aggiuntive di corrispondenza per i campi padre basati su testo. Valori accettati: isblank, allowNull, contiene.
Metadati	metadata		object	Deve essere nella coppia chiave-valore. Sono consentite al massimo 1000 coppie chiave-valore.
Posta elettronica mittente	senderEmail		string	immettere l'indirizzo di posta elettronica di un altro utente nell'account che verrà usato per l'invio di questi documenti alle parti destinatari.
Nascondi pulsante Aggiungimi	hideAddMeButton		boolean	Se true, nasconderà il pulsante "Aggiungi me" nelle parti destinatari in una sessione di invio incorporata.
Nascondi pulsante Aggiungi nuovo	hideAddNewButton		boolean	Se true, nasconderà il pulsante "Aggiungi nuovo" nelle parti destinatari in una sessione di invio incorporata.
Nascondi pulsante Aggiungi gruppo	hideAddGroupButton		boolean	Se true, nasconderà il pulsante "Aggiungi gruppo" nelle parti destinatari in una sessione di invio incorporata.
Nascondi nome campo per i destinatari	hideFieldNameForRecipients		boolean	Nascondere i nomi dei campi per i destinatari per i campi di immissione dati e i campi avanzati. Ad eccezione del pulsante di opzione, della casella di controllo, dell'immagine e del collegamento ipertestuale.
Nascondi bordo casella di controllo	hideCheckboxBorder		boolean	I bordi della casella di controllo verranno nascosti nei documenti eseguiti.
Nascondi opzione di selezione del firmatario	hideSignerSelectOption		boolean	Se true, nasconderà la casella di input "Nome/messaggio di posta elettronica del firmatario esistente" nelle parti destinatari in una sessione di invio incorporata.
Nascondi azioni del firmatario	hideSignerActions		boolean	Se true, nasconderà le azioni di "modifica", "modifica" e "rimuovi" nei destinatari in una sessione di invio incorporata.
Nascondi nome mittente	hideSenderName		boolean	Se true, nasconderà il nome del mittente nelle parti destinatari in una sessione di invio incorporata.
Nascondi nome cartella	hideFolderName		boolean	Se true, il nome della cartella verrà nascosto nella navigazione in entrambe le sessioni incorporate.
Nascondi nome documenti	hideDocumentsName		boolean	Se true, il nome del documento verrà nascosto in entrambe le sessioni incorporate.
Nascondi rifiuto per firmare	hideDeclineToSign		boolean	Se true, nasconderà l'opzione "Rifiuta di firmare" per il firmatario.
Nascondi altre azioni	hideMoreAction		boolean	Se true, il pulsante "Altre azioni" verrà nascosto nella sessione di invio/firma. Nel caso di "Invia ora": true, non nasconderà nulla.
Nascondi pulsante Invia	hideSendButton		boolean	Se true, il pulsante Invia verrà nascosto nella sessione di invio incorporata.
Nascondi campo obbligatorio successivo	hideNextRequiredFieldbtn		boolean	Se impostato su true, nasconde il pulsante di spostamento che sposta i firmatari al campo obbligatorio successivo.
Sessione incorporata richiesta	requiredBothEmbeddedSession		boolean	Se true, genererà insieme gli URL di invio e firma incorporati.
Password busta	folderPassword		string	Questa password verrà richiesta dal firmatario/autore per aprire il documento firmato digitalmente. Se il parametro viene mantenuto vuoto, non sarà necessaria alcuna password per aprire il documento firmato digitalmente.
Abilitare il passaggio per passaggio	enableStepByStep		boolean	Per abilitare un'azione dettagliata nella sessione di invio incorporata.
Nascondi l'opzione Aggiungi parti	hideAddPartiesOption		boolean	Se true, nasconderà l'opzione per aggiungere parti in modalità bozza e creazione di modelli.
Autofirmato	selfSign		boolean	Abilita l'accesso Self Sign incorporato tramite LE API. Questo parametro è applicabile solo quando il parametro createEmbeddedSendingSession è true.
URL di completamento autofirmato	selfSignerSuccessUrl		string	Immettere l'URL assoluto per la pagina di destinazione nel sito Web o nell'applicazione, a cui l'utente verrà reindirizzato dopo l'invio automatico della cartella nella visualizzazione di invio incorporata.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
ID	folder.folderId	integer	ID univoco della busta appena creata. Utilizzare questa opzione nelle azioni successive per fare riferimento a questa busta.
Name	folder.folderName	string	Nome della busta appena creata.
Nome personalizzato	folder.folderCustomName	string	Nome personalizzato per la busta.
Parola chiave	folder.folderPassword	string	Password di accesso per la busta, se impostata.
ID creatore	folder.folderAuthorId	integer	Identificatore univoco dell'autore della busta.
Nome autore	folder.folderAuthorFirstName	string	Nome dell'autore della busta.
Cognome creatore	folder.folderAuthorLastName	string	Cognome dell'autore della busta.
Messaggio di posta elettronica creatore	folder.folderAuthorEmail	string	Indirizzo di posta elettronica dell'autore della busta.
Ruolo creatore	folder.folderAuthorRole	string	Ruolo dell'autore della busta.
ID aziendale	folder.folderCompanyId	integer	Identificatore univoco della società proprietaria della busta.
Data di creazione	folder.folderCreationDate	integer	Data di creazione della busta (timestamp Unix in millisecondi).
Data di invio	folder.folderSentDate	integer	Data di invio della busta (timestamp Unix in millisecondi).
Condizione	folder.folderStatus	string	Stato corrente della busta.
Campo personalizzato 1	folder.custom_field1	string	Primo campo di metadati personalizzato per la busta.
Campo personalizzato 2	folder.custom_field2	string	Secondo campo di metadati personalizzato per la busta.
Metadati	folder.metadata	string	Metadati personalizzati associati alla busta.
ID dei documenti	folder.folderDocumentIds	array of integer	Elenco di ID documento contenuti nella busta.
Documents	folder.documentsList	array of object	Elenco di documenti nella busta.
ID documento	folder.documentsList.documentId	integer	Identificatore univoco del documento.
ID contratto	folder.documentsList.contractId	integer	Identificatore univoco del contratto.
ID aziendale	folder.documentsList.companyId	integer	Identificatore univoco della società.
Creato da	folder.documentsList.contractCreatedBy	integer	ID utente della persona che ha creato il contratto.
Data di creazione	folder.documentsList.contractCreatedOn	string	Data e ora di creazione del contratto.
Tipo di contratto	folder.documentsList.contractType	string	Tipo del contratto.
Stato contratto	folder.documentsList.contractStatus	string	Stato corrente del contratto.
Modificabile	folder.documentsList.editable	boolean	Indica se l'elemento è modificabile.
ID versione	folder.documentsList.contractVersionId	integer	Identificatore univoco della versione del contratto.
Nome versione	folder.documentsList.contractVersionName	string	Nome della versione del contratto.
Descrizione della versione	folder.documentsList.contractVersionDesc	string	Descrizione della versione del contratto.
Versione creata da	folder.documentsList.versionCreatedby	integer	ID utente della persona che ha creato questa versione.
Versione creata in	folder.documentsList.versionCreatedOn	string	Data e ora di creazione di questa versione.
Numero di versione	folder.documentsList.contractVersionNumber	integer	Numero di versione del contratto.
Origine transazione	folder.documentsList.contractTransactionSource	string	Sistema di origine che ha avviato la transazione del contratto.
Destinatari	folder.folderRecipientParties	array of object	Elenco di entità destinatari per la busta.
ID destinatario	folder.folderRecipientParties.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	folder.folderRecipientParties.partyDetails.partyId	integer	Identificatore univoco del destinatario.
Nome di battesimo	folder.folderRecipientParties.partyDetails.firstName	string	Nome del destinatario.
Cognome	folder.folderRecipientParties.partyDetails.lastName	string	Cognome del destinatario.
Indirizzo e-mail	folder.folderRecipientParties.partyDetails.emailId	string	Indirizzo di posta elettronica del destinatario.
Segnaposto	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se questa parte è un destinatario segnaposto.
Address	folder.folderRecipientParties.partyDetails.address	string	Indirizzo fisico del destinatario.
Data di creazione	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data di creazione del record (timestamp Unix in millisecondi).
Rifiutare esplicitamente i messaggi di posta elettronica	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se il destinatario ha rifiutato esplicitamente le notifiche tramite posta elettronica.
ID destinatario univoco	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificatore di sistema univoco per il destinatario.
Livello di autenticazione	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metodo di autenticazione necessario per questo destinatario.
Data aggiornamento password	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Data dell'ultimo aggiornamento della password.
Stato aggiornato della password	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indica se la password è stata aggiornata.
ID aziendale	folder.folderRecipientParties.partyDetails.companyId	integer	Identificatore univoco della società.
Ruolo utente	folder.folderRecipientParties.partyDetails.userRole	string	Ruolo assegnato all'utente.
Dipartimento	folder.folderRecipientParties.partyDetails.department	string	Reparto a cui appartiene l'utente.
Titolo	folder.folderRecipientParties.partyDetails.title	string	Titolo del lavoro dell'utente.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indica se l'utente o il record è attivo.
Luogo	folder.folderRecipientParties.partyDetails.requestLocale	string	Impostazione delle impostazioni locali per l'utente.
Condividi con Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indica se le buste vengono condivise nel reparto.
Composizione del codice	folder.folderRecipientParties.partyDetails.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numero di telefono cellulare.
Filtro stato	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtro per lo stato del documento.
Filtro data	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtro per la data del documento.
Accesso sicuro al campo	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indica se l'utente ha accesso a campi protetti.
Espandi barra laterale	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indica se la barra laterale è espansa per impostazione predefinita.
Adv. Convalida della posta elettronica	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indica se la convalida avanzata della posta elettronica è abilitata.
ID del Manager	folder.folderRecipientParties.partyDetails.managerId	string	Identificatore univoco del responsabile dell'utente.
Conteggio account di accesso	folder.folderRecipientParties.partyDetails.loginCount	integer	Numero di volte in cui l'utente ha eseguito l'accesso.
Indirizzo di posta elettronica per la reimpostazione della password	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indica se deve essere inviato un messaggio di posta elettronica di reimpostazione della password.
ID reparto	folder.folderRecipientParties.partyDetails.departmentId	string	Identificatore univoco del reparto.
Società primaria	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Società primaria associata all'utente.
Tipo di dispositivo	folder.folderRecipientParties.partyDetails.deviceType	string	Tipo di dispositivo usato.
Token dispositivo	folder.folderRecipientParties.partyDetails.deviceToken	string	Token di notifica push per il dispositivo.
Descrizione subappaltatori	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Descrizione del subappaltatore o del firmatario esterno.
Organizzazione subappaltatori	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nome dell'organizzazione del subappaltatore o firmatario esterno.
Data aggiunta subappaltatori	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Data di aggiunta del subappaltatore (timestamp Unix in millisecondi).
Source	folder.folderRecipientParties.partyDetails.source	string	Sistema di origine da cui è stato aggiunto il firmatario esterno.
Composizione del codice	folder.folderRecipientParties.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.folderRecipientParties.mobileNumber	string	Numero di telefono cellulare.
Tipo di firma	folder.folderRecipientParties.signerSignatureType	string	Tipo di firma che verrà usato dal firmatario.
Autorizzazioni	folder.folderRecipientParties.contractPermissions	string	Autorizzazioni concesse a questa parte per il contratto.
Ordine di firma	folder.folderRecipientParties.partySequence	integer	Numero di sequenza dell'ordine di firma per questo destinatario.
Sequenza flusso di lavoro	folder.folderRecipientParties.workflowSignSequence	integer	Numero di sequenza di firma del flusso di lavoro.
ID busta	folder.folderRecipientParties.envelopeId	integer	Identificatore univoco della busta.
ID società destinatario	folder.folderRecipientParties.partyCompanyId	integer	Identificatore univoco della società associata al destinatario.
Modalità condivisione	folder.folderRecipientParties.sharingMode	string	Modalità di condivisione per questa busta.
URL accesso destinatario	folder.folderRecipientParties.folderAccessURL	string	URL che il destinatario può usare per accedere e firmare la busta.
Modalità di sicurezza	folder.folderRecipientParties.securityMode	string	Modalità di sicurezza applicata alla busta.
Comments	folder.folderRecipientParties.extraComments	string	Commenti aggiuntivi inclusi nella busta.
Consenti modifica nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se il destinatario è autorizzato ad aggiornare il nome.
Nome aggiornato	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se il firmatario ha aggiornato il nome.
Livello di autenticazione del firmatario	folder.folderRecipientParties.signerAuthenticationLevel	string	Livello di autenticazione necessario per il firmatario.
Codice di accesso	folder.folderRecipientParties.userDefinedAccessCode	string	Codice di accesso personalizzato definito per il firmatario.
ID firma	folder.folderRecipientParties.signatureId	string	Identificatore univoco della firma.
Ruolo destinatario	folder.folderRecipientParties.partyRole	string	Ruolo assegnato a questo destinatario nel flusso di lavoro di firma.
Campo società	folder.folderRecipientParties.companyFieldValue	string	Valore del campo nome società nella firma.
Campo titolo	folder.folderRecipientParties.titleFieldValue	string	Valore del campo del titolo nella firma.
Motivo della firma	folder.folderRecipientParties.reasonSigning	string	Motivo per cui il destinatario sta firmando il documento.
Campo pagamento aggiunto	folder.folderRecipientParties.payFieldAdded	boolean	Indica se è stato aggiunto un campo di pagamento.
Beneficiario	folder.folderRecipientParties.payee	boolean	Indica se il destinatario è l'utente a pagamento.
Pagamento ricorrente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se esiste un campo di pagamento ricorrente.
Stampa e firma fine	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se il processo di stampa e firma è stato completato.
Pagato	folder.folderRecipientParties.paid	boolean	Indica se il pagamento è stato completato.
Facoltativo firmatario consentito	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se il destinatario è un firmatario facoltativo.
Firmatari facoltativi	folder.folderRecipientParties.optionalSigners	array of integer	Elenco di ID entità firmatario facoltativi per questa busta.
URL di firma dell'autore	folder.folderAccessURLForAuthor	string	URL che il mittente può usare per accedere alla busta.
Draft Access URL	folder.draftFolderAccessURL	string	URL utilizzato per accedere alla versione bozza della busta.
Firma boardroom	folder.boardRoomSign	boolean	Indica se la modalità di firma della sala riunioni è abilitata.
Includi logo	folder.includeLogo	boolean	Indica se il logo aziendale è incluso nei messaggi di posta elettronica.
Colore sfondo pulsante	folder.email_btnBgColor	string	Colore di sfondo del pulsante di posta elettronica.
Colore testo pulsante	folder.email_btnTxtColor	string	Colore del testo del pulsante di posta elettronica.
Logo e-mail	folder.emailTemplateLogo	string	URL del logo usato nel modello di posta elettronica.
ID modello di posta elettronica	folder.emailTemplateId	integer	Identificatore univoco del modello di posta elettronica.
Intestazione posta elettronica	folder.emailHeader	string	Testo dell'intestazione usato nei messaggi di posta elettronica di notifica.
Piè di pagina del messaggio di posta elettronica	folder.emailFooter	string	Testo del piè di pagina usato nei messaggi di posta elettronica di notifica.
Ripulitura pianificata	folder.purgeFlag	boolean	Indica se la busta è pianificata per l'eliminazione.
Elimina data di inizio	folder.purgeStartDate	string	Data da cui iniziare l'eliminazione.
Data di fine eliminazione	folder.purgeEndDate	string	Data di completamento dell'eliminazione.
ID invio bulk	folder.bulkId	integer	Identificatore univoco dell'operazione di invio bulk.
Imponi ordine di firma	folder.enforceSignWorkflow	boolean	Indica se i destinatari devono accedere alla sequenza definita.
Passaggio corrente	folder.currentWorkflowStep	integer	Passaggio corrente nel flusso di lavoro di firma.
Origine transazione	folder.transactionSource	string	Sistema di origine che ha avviato questa transazione.
Modificabile	folder.editable	boolean	Indica se l'elemento è modificabile.
firma In-Person	folder.inPersonSignable	boolean	Indica se la busta può essere firmata di persona.
Eseguire l'override dei promemoria	folder.overrideAccountReminders	boolean	Indica se le impostazioni di promemoria a livello di account vengono sostituite.
Eseguire l'override della delega	folder.overrideAccountRecipientDelegation	boolean	Indica se le impostazioni di delega a livello di account vengono sostituite.
Consenti delega	folder.allowRecipientsToDelegate	boolean	Indica se i destinatari possono delegare la firma.
ID	folder.envelopeId	integer	Identificatore univoco della busta.
Name	folder.envelopeName	string	Nome della busta.
ID origine	folder.envelopeOriginatorId	integer	Identificatore univoco dell'utente che ha creato la busta.
ID aziendale	folder.envelopeCompanyId	integer	Identificatore univoco della società proprietaria della busta.
Date	folder.envelopeDate	integer	Data di creazione della busta (timestamp Unix in millisecondi).
Data condivisa	folder.envelopeSharedDate	integer	Data di condivisione della busta (timestamp Unix in millisecondi).
Condizione	folder.envelopeStatus	string	Stato corrente della busta.
ID contratto	folder.envelopeContractIds	array of integer	Elenco di ID contratto associati a questa busta.
Autorizzazioni destinatario	folder.envelopePartyPermissions	array of object	Elenco delle autorizzazioni del destinatario per questa busta.
ID destinatario	folder.envelopePartyPermissions.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	folder.envelopePartyPermissions.partyDetails.partyId	integer	Identificatore univoco del destinatario.
Nome di battesimo	folder.envelopePartyPermissions.partyDetails.firstName	string	Nome del destinatario.
Cognome	folder.envelopePartyPermissions.partyDetails.lastName	string	Cognome del destinatario.
Indirizzo e-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	Indirizzo di posta elettronica del destinatario.
Segnaposto	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indica se questa parte è un destinatario segnaposto.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Indirizzo fisico del destinatario.
Data di creazione	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Data di creazione del record (timestamp Unix in millisecondi).
Rifiutare esplicitamente i messaggi di posta elettronica	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indica se il destinatario ha rifiutato esplicitamente le notifiche tramite posta elettronica.
ID destinatario univoco	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Identificatore di sistema univoco per il destinatario.
Livello di autenticazione	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Metodo di autenticazione necessario per questo destinatario.
Data aggiornamento password	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Data dell'ultimo aggiornamento della password.
Stato aggiornato della password	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indica se la password è stata aggiornata.
ID aziendale	folder.envelopePartyPermissions.partyDetails.companyId	integer	Identificatore univoco della società.
Ruolo utente	folder.envelopePartyPermissions.partyDetails.userRole	string	Ruolo assegnato all'utente.
Dipartimento	folder.envelopePartyPermissions.partyDetails.department	string	Reparto a cui appartiene l'utente.
Titolo	folder.envelopePartyPermissions.partyDetails.title	string	Titolo del lavoro dell'utente.
Active	folder.envelopePartyPermissions.partyDetails.active	boolean	Indica se l'utente o il record è attivo.
Luogo	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Impostazione delle impostazioni locali per l'utente.
Condividi con Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indica se le buste vengono condivise nel reparto.
Composizione del codice	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Numero di telefono cellulare.
Filtro stato	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtro per lo stato del documento.
Filtro data	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtro per la data del documento.
Accesso sicuro al campo	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indica se l'utente ha accesso a campi protetti.
Espandi barra laterale	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indica se la barra laterale è espansa per impostazione predefinita.
Adv. Convalida della posta elettronica	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indica se la convalida avanzata della posta elettronica è abilitata.
ID del Manager	folder.envelopePartyPermissions.partyDetails.managerId	string	Identificatore univoco del responsabile dell'utente.
Conteggio account di accesso	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Numero di volte in cui l'utente ha eseguito l'accesso.
Indirizzo di posta elettronica per la reimpostazione della password	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indica se deve essere inviato un messaggio di posta elettronica di reimpostazione della password.
ID reparto	folder.envelopePartyPermissions.partyDetails.departmentId	string	Identificatore univoco del reparto.
Società primaria	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Società primaria associata all'utente.
Tipo di dispositivo	folder.envelopePartyPermissions.partyDetails.deviceType	string	Tipo di dispositivo usato.
Token dispositivo	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Token di notifica push per il dispositivo.
Descrizione subappaltatori	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Descrizione del subappaltatore o del firmatario esterno.
Organizzazione subappaltatori	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Nome dell'organizzazione del subappaltatore o firmatario esterno.
Data aggiunta subappaltatori	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Data di aggiunta del subappaltatore (timestamp Unix in millisecondi).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Sistema di origine da cui è stato aggiunto il firmatario esterno.
Composizione del codice	folder.envelopePartyPermissions.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.envelopePartyPermissions.mobileNumber	string	Numero di telefono cellulare.
Tipo di firma	folder.envelopePartyPermissions.signerSignatureType	string	Tipo di firma che verrà usato dal firmatario.
Autorizzazioni	folder.envelopePartyPermissions.contractPermissions	string	Autorizzazioni concesse a questa parte per il contratto.
Ordine di firma	folder.envelopePartyPermissions.partySequence	integer	Numero di sequenza dell'ordine di firma per questo destinatario.
Sequenza flusso di lavoro	folder.envelopePartyPermissions.workflowSignSequence	integer	Numero di sequenza di firma del flusso di lavoro.
ID busta	folder.envelopePartyPermissions.envelopeId	integer	Identificatore univoco della busta.
ID società destinatario	folder.envelopePartyPermissions.partyCompanyId	integer	Identificatore univoco della società associata al destinatario.
Modalità condivisione	folder.envelopePartyPermissions.sharingMode	string	Modalità di condivisione per questa busta.
URL accesso destinatario	folder.envelopePartyPermissions.folderAccessURL	string	URL che il destinatario può usare per accedere e firmare la busta.
Modalità di sicurezza	folder.envelopePartyPermissions.securityMode	string	Modalità di sicurezza applicata alla busta.
Comments	folder.envelopePartyPermissions.extraComments	string	Commenti aggiuntivi inclusi nella busta.
Consenti modifica nome	folder.envelopePartyPermissions.allowNameChange	boolean	Indica se il destinatario è autorizzato ad aggiornare il nome.
Nome aggiornato	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indica se il firmatario ha aggiornato il nome.
Livello di autenticazione del firmatario	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Livello di autenticazione necessario per il firmatario.
Codice di accesso	folder.envelopePartyPermissions.userDefinedAccessCode	string	Codice di accesso personalizzato definito per il firmatario.
ID firma	folder.envelopePartyPermissions.signatureId	string	Identificatore univoco della firma.
Ruolo destinatario	folder.envelopePartyPermissions.partyRole	string	Ruolo assegnato a questo destinatario nel flusso di lavoro di firma.
Campo società	folder.envelopePartyPermissions.companyFieldValue	string	Valore del campo nome società nella firma.
Campo titolo	folder.envelopePartyPermissions.titleFieldValue	string	Valore del campo del titolo nella firma.
Motivo della firma	folder.envelopePartyPermissions.reasonSigning	string	Motivo per cui il destinatario sta firmando il documento.
Campo pagamento aggiunto	folder.envelopePartyPermissions.payFieldAdded	boolean	Indica se è stato aggiunto un campo di pagamento.
Beneficiario	folder.envelopePartyPermissions.payee	boolean	Indica se il destinatario è l'utente a pagamento.
Pagamento ricorrente	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indica se esiste un campo di pagamento ricorrente.
Stampa e firma fine	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indica se il processo di stampa e firma è stato completato.
Pagato	folder.envelopePartyPermissions.paid	boolean	Indica se il pagamento è stato completato.
Livello di autenticazione	folder.envelopeAuthenticationLevel	string	Livello di autenticazione necessario per la busta.
Single Signer Bulk	folder.allowSingleSignerInBulk	boolean	Indica se un single signer è consentito in modalità di invio bulk.
denominazione File-Based	folder.folderNameBasedOnFileNaming	boolean	Indica se il nome della cartella è basato sul nome del file.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Indica se il nome del documento è basato sul nome del file.
Nome File-Based certificato	folder.certificateNameBasedOnFileNaming	boolean	Indica se il nome del certificato è basato sul nome del file.
Denominazione dei file pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Indica se la denominazione dei file è abilitata prima dell'esecuzione del documento.
Aggiunta di Payee	folder.payeeAddedd	boolean	Indica se è stato aggiunto un payee.
Self-Signing abilitata	folder.selfSignerEnabled	boolean	Indica se la modalità di firma automatica è abilitata.
Notary Enabled	folder.notaryEnabled	boolean	Indica se la firma notaria è abilitata.
Visibilità limitata	folder.limitedVisibilityFlag	boolean	Indica se la visibilità limitata è abilitata per questa busta.
Visibilità post-firma	folder.postSigningVisibility	boolean	Indica se la visibilità post-firma è abilitata.
Firma bagnata	folder.wetSignatureEnabled	boolean	Indica se le firme bagnate sono abilitate.
Merge abilitato	folder.mergeEnabled	boolean	Indica se l'unione dei documenti è abilitata.
Sessioni di firma incorporate	embeddedSigningSessions	array of object	Elenco di sessioni di firma incorporate, una per destinatario. Presente solo quando createEmbeddedSigningSession è true.
Messaggio di posta elettronica del firmatario	embeddedSigningSessions.emailIdOfSigner	string	Indirizzo di posta elettronica del destinatario per questa sessione di firma incorporata.
Token di firma	embeddedSigningSessions.embeddedToken	string	Token univoco per la sessione di firma incorporata del destinatario.
URL sessione di firma	embeddedSigningSessions.embeddedSessionURL	string	URL da aprire o incorporare per il destinatario per firmare il documento.
Token di invio incorporato	embeddedToken	string	Token per la sessione di invio incorporata. È presente solo quando createEmbeddedSendingSession è true.
Invio dell'URL della sessione	embeddedSessionURL	string	URL da aprire o incorporare per l'autore della busta da preparare e inviare la busta. È presente solo quando createEmbeddedSendingSession è true.
Result	result	string	Risultato dell'operazione.
Message	message	string	Messaggio che descrive il risultato dell'operazione.

Crea busta da modello

ID operazione:: CreateEnvelopefromTemplate

Crea e invia una busta usando un modello esistente. I dettagli del destinatario possono essere personalizzati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome busta	folderName		string	Nome della cartella dei documenti. Se questo valore non viene specificato, il nome della cartella dei documenti viene mantenuto uguale ai nomi dei modelli.
ID modello	templateIds	True	array of integer	Matrice di ID modello da usare per creare i documenti per questa cartella.
Campi	fields		object	È possibile passare i valori dei campi usati nei modelli per precompilarli nei documenti creati dal modello. FIELD_NAME è il nome del campo usato nel modello. FIELD_VALUE è il valore del campo del documento.
Convalida avanzata della posta elettronica	allowAdvancedEmailValidation		boolean	Convalidare gli indirizzi di posta elettronica delle parti quando è impostato su true.
Nome di battesimo	firstName	True	string	Nome del destinatario.
Cognome	lastName	True	string	Cognome del destinatario.
Indirizzo e-mail	emailId	True	string	Indirizzo di posta elettronica del destinatario.
permissions	permission	True	string
Sequenza	sequence	True	integer	Utilizzare questo campo per assegnare un numero di sequenza a un destinatario nell'elenco delle parti destinatari. Usa numeri di sequenza univoci per ogni parte a partire da 1, ad esempio 1,2,3,4. Se una singola persona viene visualizzata più volte nel flusso di lavoro di firma, assegnare una sequenza diversa ogni volta che il destinatario viene ripetuto.
signerAuthLevels	signerAuthLevel		string	Livello di autenticazione che un firmatario userà a scopo di verifica
Segnaposto	isPlaceholder		boolean	Utilizzare questo campo per avviare l'entità è un segnaposto. Nota: 1. firstName, lastName, valore del parametro emailId deve essere vuoto di questa parte. 2. Per aggiungere il segnaposto, è necessario che un destinatario venga rieserito con l'autorizzazione 'PARTY_ASSIGNER'.
Ruolo destinatario	partyRole		string	Utilizzare questo campo per assegnare un ruolo di segnaposto.
Consenti modifica nome	allowNameChange		string	Il valore può essere true o false Usare questo parametro per consentire al firmatario di aggiornare il nome e il cognome prima di completare il processo di firma.
Sequenza flusso di lavoro	workflowSequence		integer	Assegnare un numero di sequenza del flusso di lavoro a questo destinatario. Quando la sequenza di accesso è abilitata, i destinatari ricevono l'invito alla firma in ordine crescente della sequenza.
Id di posta elettronica host	hostEmailId		string	Indirizzo di posta elettronica di In-Person Administrator.
Codice di accesso	userDefinedAccessCode		string	Il parametro conterrà il codice di accesso quando il valore "signerAuthLevel" viene impostato su "Codice di accesso definito dall'utente" per l'autenticazione. Nota: 1. I codici non fanno distinzione tra maiuscole e minuscole. 2. Il sistema non invia questo codice, quindi è necessario condividere questo codice direttamente con il firmatario. 3. Il codice di accesso può contenere alfabeti, numeri e caratteri speciali seguenti: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Usare questo parametro durante la creazione di un'entità come bulk. Nota: Se questo parametro è true, firstName, lastName e emailId di questa parte verranno ignorati.
ID gruppo di posta elettronica	emailGroupId		integer	Passare il messaggio di posta elettronica all'ID del gruppo che si vuole usare per creare operazioni bulk.
Single Signer Bulk	allowSingleSignerInBulk		boolean	Usare questo parametro per consentire a una sola persona di accedere al gruppo di posta elettronica.
Composizione del codice	dialingCode		string	Utilizzare questo campo per assegnare i codici di accesso esterno di un paese sono prefissi di numero di cellulare a un destinatario nell'elenco delle parti destinatari.
Numero di cellulare	mobileNumber		string	Utilizzare questo campo per assegnare un numero di cellulare a un destinatario nell'elenco delle parti destinatari.
Password busta	folderPassword		string	Questa password verrà richiesta dal firmatario/autore per aprire il documento firmato digitalmente. Se il parametro viene mantenuto vuoto, non sarà necessaria alcuna password per aprire il documento firmato digitalmente.
Sequenza di accesso	signInSequence		boolean	Questo campo viene utilizzato per determinare se i destinatari firmeranno i documenti della busta in una sequenza. Se false, tutti i destinatari ricevono contemporaneamente un messaggio di posta elettronica di invito. Se true, ogni destinatario riceve un messaggio di posta elettronica di invito successivamente dopo che il destinatario precedente completa l'attività richiesta, ad esempio firmare i documenti o compilare i campi e così via.
Abilitazione in persona	inPersonEnable		boolean	Questo campo viene usato per avviare il processo di firma di persona che può essere facilmente completato in qualsiasi dispositivo in pochi minuti ed evita firme basate sulla posta elettronica, se necessario. Se false, tutti i destinatari ricevono simultaneamente il messaggio di posta elettronica di invito. Se true, l'amministratore di persona riceve un messaggio di posta elettronica di invito per avviare il processo di firma per il firmatario.
Invia ora	sendNow		boolean	Se abilitata, Foxit eSign invia immediatamente un collegamento di firma univoco all'indirizzo di posta elettronica di ogni destinatario. Disabilitare questa opzione per salvare la busta come bozza.
Firma url di operazione riuscita tutte le parti	signSuccessUrlAllParties		boolean	Se impostato su true, il firmatario verrà reindirizzato all'URL specificato in signSuccessUrl dopo la firma. Questo è applicabile solo quando sendNow è true.
Creare una sessione di invio incorporata	createEmbeddedSendingSession		boolean	Se impostato su true, genererà un URL incorporato per aprire la visualizzazione del documento che prepara la visualizzazione di Foxit eSign.
Correggere le entità destinatari	fixRecipientParties		boolean	Se true, nella visualizzazione di invio incorporata non è possibile modificare le parti per la busta che sono già state aggiunte come parte di questa richiesta.
Correggere i documenti	fixDocuments		boolean	Se true, nell'invio incorporato non è possibile modificare i documenti per la busta già aggiunti come parte di questa richiesta.
Invia URL operazione riuscita	sendSuccessUrl		string	Immettere l'URL assoluto per la pagina di destinazione a cui verrà reindirizzato il firmatario dopo l'invio della cartella nella visualizzazione di invio incorporata.
URL di errore di invio	sendErrorUrl		string	Immettere l'URL assoluto per la pagina di destinazione, a cui verrà reindirizzato il firmatario se si verifica un errore durante l'invio della cartella nella visualizzazione di invio incorporata.
Nascondi opzione di selezione del firmatario	hideSignerSelectOption		boolean	Se true, nasconderà la casella di input "Nome/messaggio di posta elettronica del firmatario esistente" nelle parti destinatari in una sessione di invio incorporata.
Nascondi azioni del firmatario	hideSignerActions		boolean	Se true, nasconderà le azioni di "modifica", "modifica" e "rimuovi" nei destinatari in una sessione di invio incorporata.
Nascondi nome mittente	hideSenderName		boolean	Se true, nasconderà il nome del mittente nelle parti destinatari in una sessione di invio incorporata.
Nascondi pulsante Invia	hideSendButton		boolean	Se true, il pulsante Invia verrà nascosto nella sessione di invio incorporata.
Nascondi nome cartella	hideFolderName		boolean	Se true, il nome della cartella verrà nascosto nella navigazione in entrambe le sessioni incorporate.
Nascondi nome documenti	hideDocumentsName		boolean	Se true, il nome del documento verrà nascosto in entrambe le sessioni incorporate.
Nascondi pulsante Aggiungimi	hideAddMeButton		boolean	Se true, nasconderà il pulsante "Aggiungi me" nelle parti destinatari in una sessione di invio incorporata.
Nascondi pulsante Aggiungi nuovo	hideAddNewButton		boolean	Se true, nasconderà il pulsante "Aggiungi nuovo" nelle parti destinatari in una sessione di invio incorporata.
Nascondi pulsante Aggiungi gruppo	hideAddGroupButton		boolean	Se true, nasconderà il pulsante "Aggiungi gruppo" nelle parti destinatari in una sessione di invio incorporata.
Creare una sessione di firma incorporata	createEmbeddedSigningSession		boolean	Il token di sessione di firma verrà generato senza inviare messaggi di posta elettronica ai destinatari.
Creare una sessione di firma incorporata per tutte le parti	createEmbeddedSigningSessionForAllParties		boolean	Se impostato su true, viene generato un URL di firma incorporato per ogni destinatario nella busta. Se false, solo i destinatari elencati negli ID di posta elettronica dei firmatari incorporati ricevono una sessione incorporata.
ID di posta elettronica dei firmatari incorporati	embeddedSignersEmailIds		array of string	Matrice di ID di posta elettronica dei destinatari per i quali deve essere creata una sessione di firma incorporata. ID di posta elettronica delle parti destinatari aggiunte nell'elenco delle parti.
Sign Success Url	signSuccessUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà eseguito correttamente l'accesso nella visualizzazione di firma incorporata.
Url di rifiuto del segno	signDeclineUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà eseguito il reindirizzamento in caso di rifiuto di accedere alla visualizzazione di firma incorporata.
Firma url successivo	signLaterUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà reindirizzato se sceglie di accedere in un secondo momento nella visualizzazione di firma incorporata.
URL errore di firma	signErrorUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà reindirizzato se si verifica un errore durante la firma del documento nella visualizzazione di firma incorporata.
Nascondi successivo campo obbligatorio Btn	hideNextRequiredFieldBtn		boolean	Se impostato su true, nasconde il pulsante di spostamento che sposta i firmatari al campo obbligatorio successivo.
Colore tema	themeColor		string	Immettere il valore CSS per impostare il colore del tema.
Nascondi rifiuto per firmare	hideDeclineToSign		boolean	Se impostato su true, nasconde l'opzione Rifiuta di firma nella schermata di firma.
Nascondi altre azioni	hideMoreAction		boolean	Se impostato su true, nasconde il pulsante Altre azioni nella sessione di invio e firma. Non ha alcun effetto quando Send Now è true.
Nascondi l'opzione Aggiungi parti	hideAddPartiesOption		boolean	Se è impostata su true, nasconde l'opzione per aggiungere parti in modalità bozza e creazione di modelli.
Scadenza sessione	sessionExpire		boolean	Impostare su true per avviare la scadenza della sessione di firma incorporata.
Scadenza	expiry		integer	Obbligatorio se sessionExpire è true. Immettere la durata in millisecondi della scadenza nella sessione di firma incorporata.
Posta elettronica mittente	senderEmail		string	immettere l'indirizzo di posta elettronica di un altro utente nell'account che verrà usato per l'invio di questi documenti alle parti destinatari.
Consenti sessione di invio ora e firma incorporata	allowSendNowAndEmbeddedSigningSession		boolean	Se impostato su true, Foxit eSign invia un messaggio di posta elettronica di invito alla firma a ogni destinatario e genera anche un collegamento di firma incorporato per i destinatari il cui messaggio di posta elettronica è incluso nel messaggio di posta elettronica di accesso incorporato. Sia il messaggio di posta elettronica che il collegamento incorporato sono attivi contemporaneamente.
Abilitare il passaggio per passaggio	enableStepByStep		boolean	Per abilitare un'azione dettagliata nella sessione di invio incorporata.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se l'operazione ha avuto esito positivo, ad esempio "operazione riuscita".
Message	message	string	Descrizione del risultato dell'operazione.
Sessioni di firma incorporate	embeddedSigningSessions	array of object	Elenco di sessioni di firma incorporate, una per destinatario. Presente solo quando createEmbeddedSigningSession è true.
Messaggio di posta elettronica del firmatario	embeddedSigningSessions.emailIdOfSigner	string	Indirizzo di posta elettronica del destinatario per questa sessione di firma incorporata.
Token di firma	embeddedSigningSessions.embeddedToken	string	Token univoco per la sessione di firma incorporata del destinatario.
URL sessione di firma	embeddedSigningSessions.embeddedSessionURL	string	URL da aprire o incorporare per il destinatario per firmare il documento.
Token di invio incorporato	embeddedToken	string	Token per la sessione di invio incorporata. È presente solo quando createEmbeddedSendingSession è true.
Invio dell'URL della sessione	embeddedSessionURL	string	URL da aprire o incorporare per l'autore della busta da preparare e inviare la busta. È presente solo quando createEmbeddedSendingSession è true.
ID	folder.folderId	integer	ID univoco della busta creata. Utilizzare questa opzione per fare riferimento alla busta nelle azioni successive.
Name	folder.folderName	string	Nome della busta.
Nome personalizzato	folder.folderCustomName	string	Nome personalizzato assegnato alla busta.
Parola chiave	folder.folderPassword	string	Password impostata per la busta, se presente.
ID autore	folder.folderAuthorId	integer	ID univoco dell'utente che ha creato la busta.
Nome autore	folder.folderAuthorFirstName	string	Nome dell'autore della busta.
Cognome autore	folder.folderAuthorLastName	string	Cognome dell'autore della busta.
Autore Email	folder.folderAuthorEmail	string	Indirizzo di posta elettronica dell'autore della busta.
Ruolo autore	folder.folderAuthorRole	string	Ruolo dell'account dell'autore della busta.
ID aziendale	folder.folderCompanyId	integer	ID univoco della società a cui appartiene la busta.
Data di creazione	folder.folderCreationDate	integer	Data e ora di creazione della busta, in millisecondi Unix.
Data di invio	folder.folderSentDate	integer	Data e ora di invio della busta ai destinatari, in millisecondi Unix.
Condizione	folder.folderStatus	string	Stato corrente della busta ,ad esempio SHARED, EXECUTED, DRAFT, CANCELLED.
Campo personalizzato 1	folder.custom_field1	string	Valore del campo personalizzato 1 impostato sulla busta.
Campo personalizzato 2	folder.custom_field2	string	Valore del campo personalizzato 2 impostato sulla busta.
Metadati	folder.metadata	string	Eventuali metadati aggiuntivi associati alla busta.
ID dei documenti	folder.folderDocumentIds	array of integer	Elenco di ID documento inclusi in questa busta.
Documents	folder.documentsList	array of object	Dettagli di ogni documento incluso nella busta.
ID documento	folder.documentsList.documentId	integer	Identificatore univoco del documento.
ID contratto	folder.documentsList.contractId	integer	Identificatore univoco del contratto associato a questo documento.
ID aziendale	folder.documentsList.companyId	integer	ID univoco della società a cui appartiene questo documento.
Creato da	folder.documentsList.contractCreatedBy	integer	ID utente della persona che ha creato il contratto.
Data di creazione	folder.documentsList.contractCreatedOn	string	Data di creazione del contratto.
Tipo di contratto	folder.documentsList.contractType	string	Tipo del contratto.
Stato documento	folder.documentsList.contractStatus	string	Stato di firma corrente del documento (ad esempio, WAITING_FOR_SIGNATURE, EXECUTED).
Modificabile	folder.documentsList.editable	boolean	Indica se il documento può essere modificato.
ID versione	folder.documentsList.contractVersionId	integer	ID univoco della versione corrente del documento.
Nome versione	folder.documentsList.contractVersionName	string	Nome della versione corrente del documento.
Descrizione della versione	folder.documentsList.contractVersionDesc	string	Descrizione della versione corrente del documento.
Versione creata da	folder.documentsList.versionCreatedby	integer	ID utente della persona che ha creato la versione del documento.
Versione creata in	folder.documentsList.versionCreatedOn	string	Data di creazione della versione del documento.
Numero di versione	folder.documentsList.contractVersionNumber	integer	Numero di versione del documento.
Origine transazione	folder.documentsList.contractTransactionSource	string	Origine della transazione del contratto.
Destinatari	folder.folderRecipientParties	array of object	Elenco dei destinatari per questa busta, inclusi i singoli collegamenti di firma.
ID destinatario	folder.folderRecipientParties.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	folder.folderRecipientParties.partyDetails.partyId	integer	Identificatore univoco del destinatario.
Nome di battesimo	folder.folderRecipientParties.partyDetails.firstName	string	Nome del destinatario.
Cognome	folder.folderRecipientParties.partyDetails.lastName	string	Cognome del destinatario.
Email	folder.folderRecipientParties.partyDetails.emailId	string	Indirizzo e-mail del destinatario.
Segnaposto	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se il destinatario è un segnaposto.
Address	folder.folderRecipientParties.partyDetails.address	string	Indirizzo del destinatario.
Data creazione account	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data di creazione dell'account del destinatario, in millisecondi Unix.
Rifiutare esplicitamente i messaggi di posta elettronica	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se il destinatario ha rifiutato esplicitamente le notifiche tramite posta elettronica.
ID entità univoco	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificatore di stringa univoco per il destinatario.
Livello di autenticazione	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Livello di autenticazione necessario per questo destinatario.
ID aziendale	folder.folderRecipientParties.partyDetails.companyId	integer	ID della società a cui appartiene il destinatario.
Ruolo utente	folder.folderRecipientParties.partyDetails.userRole	string	Ruolo del destinatario all'interno dell'organizzazione.
Dipartimento	folder.folderRecipientParties.partyDetails.department	string	Reparto del destinatario.
Titolo	folder.folderRecipientParties.partyDetails.title	string	Titolo di lavoro del destinatario.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indica se l'account del destinatario è attivo.
Composizione del codice	folder.folderRecipientParties.partyDetails.dialingCode	string	Codice paese per il numero di telefono del destinatario.
Numero di cellulare	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numero di telefono cellulare del destinatario.
Descrizione subappaltatori	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Descrizione del subappaltatore, se applicabile.
Organizzazione subappaltatori	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nome dell'organizzazione del subappaltatore, se applicabile.
Data aggiunta subappaltatori	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Data in cui è stato aggiunto il subappaltatore, in millisecondi Unix.
Source	folder.folderRecipientParties.partyDetails.source	string	Origine tramite cui è stato aggiunto il destinatario.
Composizione del codice	folder.folderRecipientParties.dialingCode	string	Codice paese dialling per il numero di cellulare del destinatario.
Numero di cellulare	folder.folderRecipientParties.mobileNumber	string	Numero di cellulare del destinatario.
Tipo di firma	folder.folderRecipientParties.signerSignatureType	string	Tipo di firma consentito per il destinatario.
Autorizzazioni	folder.folderRecipientParties.contractPermissions	string	Autorizzazioni di firma concesse al destinatario, ad esempio FILL_FIELDS_AND_SIGN.
Ordine di firma	folder.folderRecipientParties.partySequence	integer	Posizione del destinatario nell'ordine di firma.
Sequenza flusso di lavoro	folder.folderRecipientParties.workflowSignSequence	integer	Numero di sequenza di firma del flusso di lavoro per questo destinatario.
ID busta	folder.folderRecipientParties.envelopeId	integer	ID della busta a cui appartiene il destinatario.
ID società di entità	folder.folderRecipientParties.partyCompanyId	integer	ID della società a cui appartiene il destinatario.
Modalità condivisione	folder.folderRecipientParties.sharingMode	string	Metodo utilizzato per condividere il documento con questo destinatario (ad esempio, posta elettronica).
URL di firma	folder.folderRecipientParties.folderAccessURL	string	URL di firma univoco per questo destinatario. Usare questa opzione per condividere direttamente il collegamento di firma.
Modalità di sicurezza	folder.folderRecipientParties.securityMode	string	Modalità di sicurezza applicata all'accesso del destinatario.
Commenti aggiuntivi	folder.folderRecipientParties.extraComments	string	Eventuali commenti aggiuntivi inclusi nell'invito alla firma per questo destinatario.
Consenti modifica nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se il destinatario è autorizzato a modificare il nome prima della firma.
Nome aggiornato	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se il destinatario ha aggiornato il nome visualizzato.
Livello di autenticazione	folder.folderRecipientParties.signerAuthenticationLevel	string	Metodo di autenticazione necessario per consentire al destinatario di accedere al documento.
Codice di accesso	folder.folderRecipientParties.userDefinedAccessCode	string	Codice di accesso personalizzato necessario per aprire il documento da parte del destinatario.
ID firma	folder.folderRecipientParties.signatureId	string	ID della firma salvata utilizzata dal destinatario.
Ruolo destinatario	folder.folderRecipientParties.partyRole	string	Ruolo assegnato a questo destinatario nella busta.
Valore campo società	folder.folderRecipientParties.companyFieldValue	string	Valore del campo società precompilato per il destinatario.
Valore campo titolo	folder.folderRecipientParties.titleFieldValue	string	Valore del campo titolo precompilato per il destinatario.
Motivo della firma	folder.folderRecipientParties.reasonSigning	string	Motivo della firma fornita dal destinatario.
Campo pagamento aggiunto	folder.folderRecipientParties.payFieldAdded	boolean	Indica se è stato aggiunto un campo di pagamento per il destinatario.
È Payee	folder.folderRecipientParties.payee	boolean	Indica se il destinatario è un payee.
Campo ricorrente esistente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se esistono campi di pagamento ricorrenti per il destinatario.
Stampa e firma completata	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se il destinatario ha completato un'azione di stampa e firma.
Consenti firmatario facoltativo	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se il destinatario può essere ignorato come firmatario facoltativo.
Firmatari facoltativi	folder.folderRecipientParties.optionalSigners	string	Elenco di firmatari facoltativi associati al destinatario, se presenti.
Pagato	folder.folderRecipientParties.paid	boolean	Indica se il destinatario ha completato il pagamento.
URL di accesso autore	folder.folderAccessURLForAuthor	string	URL dell'autore della busta per accedere al documento.
Draft Access URL	folder.draftFolderAccessURL	string	URL per accedere alla busta mentre è in stato bozza.
Segno sala bacheca	folder.boardRoomSign	boolean	Indica se la firma della sala riunioni è abilitata per questa busta.
Includi logo	folder.includeLogo	boolean	Indica se il logo aziendale è incluso nelle notifiche tramite posta elettronica.
Colore pulsante posta elettronica	folder.email_btnBgColor	string	Colore di sfondo del pulsante azione nel messaggio di posta elettronica di firma.
Colore testo pulsante posta elettronica	folder.email_btnTxtColor	string	Colore del testo del pulsante azione nel messaggio di posta elettronica di firma.
Logo e-mail	folder.emailTemplateLogo	string	Immagine del logo usata nel modello di posta elettronica.
ID modello di posta elettronica	folder.emailTemplateId	integer	ID del modello di posta elettronica usato per la firma delle notifiche.
Intestazione posta elettronica	folder.emailHeader	string	Testo dell'intestazione personalizzato nei messaggi di posta elettronica di notifica di firma.
Piè di pagina del messaggio di posta elettronica	folder.emailFooter	string	Testo del piè di pagina personalizzato nei messaggi di posta elettronica di notifica di firma.
Ripulitura pianificata	folder.purgeFlag	boolean	Indica se la busta è pianificata per l'eliminazione automatica.
Elimina data di inizio	folder.purgeStartDate	string	Data da cui inizia il periodo di ripulitura.
Data di fine eliminazione	folder.purgeEndDate	string	Data in cui verrà rimossa la busta.
Bulk ID	folder.bulkId	integer	ID del batch di invio bulk a cui appartiene questa busta, se presente.
Imponi ordine di firma	folder.enforceSignWorkflow	boolean	Indica se i destinatari devono accedere all'ordine specificato.
Passaggio flusso di lavoro corrente	folder.currentWorkflowStep	integer	Passaggio corrente nel flusso di lavoro di firma.
Origine transazione	folder.transactionSource	string	Origine che ha avviato questa transazione envelope.
Modificabile	folder.editable	boolean	Indica se è ancora possibile modificare la busta.
firma In-Person	folder.inPersonSignable	boolean	Indica se la busta può essere firmata di persona.
Eseguire l'override dei promemoria	folder.overrideAccountReminders	boolean	Indica se le impostazioni del promemoria a livello di account vengono sostituite per questa busta.
Eseguire l'override della delega	folder.overrideAccountRecipientDelegation	boolean	Indica se le impostazioni di delega a livello di account vengono sostituite per questa busta.
Consenti delega	folder.allowRecipientsToDelegate	boolean	Indica se i destinatari possono delegare la firma a un'altra persona.
ID	folder.envelopeId	integer	ID univoco della busta. Stesso valore dell'ID busta (folderId).
Name	folder.envelopeName	string	Nome della busta. Stesso valore di Envelope Name (folderName).
ID origine	folder.envelopeOriginatorId	integer	ID utente della persona che ha creato la busta.
ID aziendale	folder.envelopeCompanyId	integer	ID della società a cui appartiene la busta.
Date	folder.envelopeDate	integer	Data e ora di creazione della busta, in millisecondi Unix.
Data condivisa	folder.envelopeSharedDate	integer	La data e l'ora in cui la busta è stata condivisa con i destinatari, in millisecondi Unix.
Condizione	folder.envelopeStatus	string	Stato corrente della busta. Stesso valore di Stato busta (folderStatus).
ID contratto	folder.envelopeContractIds	array of integer	Elenco di ID contratto associati a questa busta.
Autorizzazioni di entità	folder.envelopePartyPermissions	array of object	Elenco dei destinatari e delle relative autorizzazioni di firma. Stessa struttura di Recipients.
ID destinatario	folder.envelopePartyPermissions.partyId	integer	Identificatore univoco del destinatario.
URL di firma	folder.envelopePartyPermissions.folderAccessURL	string	URL di firma univoco per questo destinatario.
Autorizzazioni	folder.envelopePartyPermissions.contractPermissions	string	Autorizzazioni di firma per questo destinatario.
Ordine di firma	folder.envelopePartyPermissions.partySequence	integer	Posizione del destinatario nell'ordine di firma.
Livello di autenticazione	folder.envelopeAuthenticationLevel	string	Livello di autenticazione applicato all'intera busta.
Consenti l'accesso Single Sign-On bulk	folder.allowSingleSignerInBulk	boolean	Indica se un single signer è consentito in modalità di invio bulk.
Nome basato sul file	folder.folderNameBasedOnFileNaming	boolean	Indica se il nome della busta è derivato dal nome del file.
Nome documento basato sul file	folder.documentNameBasedOnFileNaming	boolean	Indica se il nome del documento è derivato dal nome del file.
Nome certificato basato su file	folder.certificateNameBasedOnFileNaming	boolean	Indica se il nome del certificato è derivato dal nome del file.
Abilitare la denominazione dei file	folder.enableFileNamingBeforeExecution	boolean	Indica se la denominazione dei file viene richiesta prima dell'invio della busta.
Aggiunta di Payee	folder.payeeAddedd	boolean	Indica se un beneficiario è stato aggiunto alla busta.
Autofirmato	folder.selfSignerEnabled	boolean	Indica se il mittente è anche un firmatario della busta.
Notary Enabled	folder.notaryEnabled	boolean	Indica se la notarizzazione è abilitata per questa busta.
Visibilità limitata	folder.limitedVisibilityFlag	boolean	Indica se è abilitata la visibilità limitata dei documenti.
Visibilità post-firma	folder.postSigningVisibility	boolean	Indica se i destinatari possono visualizzare il documento firmato dopo il completamento.
Firma bagnata abilitata	folder.wetSignatureEnabled	boolean	Indica se le firme bagnate (scritte a mano) sono abilitate per questa busta.
Merge abilitato	folder.mergeEnabled	boolean	Indica se l'unione dei documenti è abilitata per questa busta.

Crea busta dall'URL

ID operazione:: CreateEnvelopefromURL

Crea e invia una busta usando URL PDF accessibili pubblicamente. Specificare gli URL del documento e i dettagli del destinatario per avviare il processo di firma.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome busta	folderName	True	string	Nome della busta.
Tipo di input	inputType		string	Specifica il formato dell'origine del documento. Impostare su URL per fornire URL di file o base64 per fornire contenuto di file con codifica Base64.
URL file	fileUrls	True	array of string	Matrice di URL accessibili pubblicamente che puntano ai documenti da aggiungere a questa busta.
Nomi file	fileNames	True	array of string	Matrice di nomi visualizzati per ogni documento, nello stesso ordine degli URL di file.
Nome di battesimo	firstName	True	string	Nome del destinatario.
Cognome	lastName	True	string	Cognome del destinatario.
Indirizzo e-mail	emailId	True	string	Indirizzo di posta elettronica del destinatario.
permissions	permission	True	string
Sequenza	sequence	True	integer	Utilizzare questo campo per assegnare un numero di sequenza a un destinatario nell'elenco delle parti destinatari. Usa numeri di sequenza univoci per ogni parte a partire da 1, ad esempio 1,2,3,4. Se una singola persona viene visualizzata più volte nel flusso di lavoro di firma, assegnare una sequenza diversa ogni volta che il destinatario viene ripetuto.
signerAuthLevels	signerAuthLevel		string	Livello di autenticazione che un firmatario userà a scopo di verifica
Segnaposto	isPlaceholder		boolean	Utilizzare questo campo per avviare l'entità è un segnaposto. Nota: 1. firstName, lastName, valore del parametro emailId deve essere vuoto di questa parte. 2. Per aggiungere il segnaposto, è necessario che un destinatario venga rieserito con l'autorizzazione 'PARTY_ASSIGNER'.
Ruolo destinatario	partyRole		string	Utilizzare questo campo per assegnare un ruolo di segnaposto.
Consenti modifica nome	allowNameChange		string	Il valore può essere true o false Usare questo parametro per consentire al firmatario di aggiornare il nome e il cognome prima di completare il processo di firma.
Sequenza flusso di lavoro	workflowSequence		integer	Assegnare un numero di sequenza del flusso di lavoro a questo destinatario. Quando la sequenza di accesso è abilitata, i destinatari ricevono l'invito alla firma in ordine crescente della sequenza.
Id di posta elettronica host	hostEmailId		string	Indirizzo di posta elettronica di In-Person Administrator.
Codice di accesso	userDefinedAccessCode		string	Il parametro conterrà il codice di accesso quando il valore "signerAuthLevel" viene impostato su "Codice di accesso definito dall'utente" per l'autenticazione. Nota: 1. I codici non fanno distinzione tra maiuscole e minuscole. 2. Il sistema non invia questo codice, quindi è necessario condividere questo codice direttamente con il firmatario. 3. Il codice di accesso può contenere alfabeti, numeri e caratteri speciali seguenti: @,&,{,},%,(,),~,\|,!,+,^.
Party Is Email Group	partyIsEmailGroup		boolean	Usare questo parametro durante la creazione di un'entità come bulk. Nota: Se questo parametro è true, firstName, lastName e emailId di questa parte verranno ignorati.
ID gruppo di posta elettronica	emailGroupId		integer	Passare il messaggio di posta elettronica all'ID del gruppo che si vuole usare per creare operazioni bulk.
Single Signer Bulk	allowSingleSignerInBulk		boolean	Usare questo parametro per consentire a una sola persona di accedere al gruppo di posta elettronica.
Composizione del codice	dialingCode		string	Utilizzare questo campo per assegnare i codici di accesso esterno di un paese sono prefissi di numero di cellulare a un destinatario nell'elenco delle parti destinatari.
Numero di cellulare	mobileNumber		string	Utilizzare questo campo per assegnare un numero di cellulare a un destinatario nell'elenco delle parti destinatari.
Campi	Fields		object
Invia ora	sendNow		boolean	Se abilitata, Foxit eSign invia immediatamente un collegamento di firma univoco all'indirizzo di posta elettronica di ogni destinatario. Disabilitare questa opzione per salvare la busta come bozza.
Creare una sessione di firma incorporata	createEmbeddedSigningSession	True	boolean	Il token di sessione di firma verrà generato senza inviare messaggi di posta elettronica ai destinatari.
Creare una sessione di firma incorporata per tutte le parti	createEmbeddedSigningSessionForAllParties		boolean	Se impostato su true, verrà generato un URL di firma incorporato per ogni destinatario nella busta.
Elaborare tag di testo	processTextTags	True	boolean	Il valore può essere true o false. Questo campo viene usato per determinare se Foxit eSign deve analizzare i documenti per i tag di testo per convertirli in campi Foxit eSign.
Elaborare campi Acro	processAcroFields	True	boolean	Questo campo viene usato per determinare se Foxit eSign deve analizzare i documenti per AcroFields per convertirli in campi Foxit eSign.
Sequenza di accesso	signInSequence		boolean	Questo campo viene utilizzato per determinare se i destinatari firmeranno i documenti della busta in una sequenza. Se false, tutti i destinatari ricevono contemporaneamente un messaggio di posta elettronica di invito. Se true, ogni destinatario riceve un messaggio di posta elettronica di invito successivamente dopo che il destinatario precedente completa l'attività richiesta, ad esempio firmare i documenti o compilare i campi e così via.
Abilitazione in persona	inPersonEnable		boolean	Questo campo viene usato per avviare il processo di firma di persona che può essere facilmente completato in qualsiasi dispositivo in pochi minuti ed evita firme basate sulla posta elettronica, se necessario. Se false, tutti i destinatari ricevono simultaneamente il messaggio di posta elettronica di invito. Se true, l'amministratore di persona riceve un messaggio di posta elettronica di invito per avviare il processo di firma per il firmatario.
Correggere le entità destinatari	fixRecipientParties		boolean	Se true, nella visualizzazione di invio incorporata non è possibile modificare le parti per la busta che sono già state aggiunte come parte di questa richiesta.
Correggere i documenti	fixDocuments		boolean	Se true, nell'invio incorporato non è possibile modificare i documenti per la busta già aggiunti come parte di questa richiesta.
Invia URL operazione riuscita	sendSuccessUrl		string	Immettere l'URL assoluto per la pagina di destinazione a cui verrà reindirizzato il firmatario dopo l'invio della cartella nella visualizzazione di invio incorporata.
URL di errore di invio	sendErrorUrl		string	Immettere l'URL assoluto per la pagina di destinazione, a cui verrà reindirizzato il firmatario se si verifica un errore durante l'invio della cartella nella visualizzazione di invio incorporata.
Creare una sessione di invio incorporata	createEmbeddedSendingSession		boolean	Se impostato su true, genererà un token incorporato per aprire il documento che prepara la visualizzazione di Foxit eSign.
ID di posta elettronica dei firmatari incorporati	embeddedSignersEmailIds		array of string	Matrice di ID di posta elettronica dei destinatari per i quali deve essere creata una sessione di firma incorporata. ID di posta elettronica delle parti destinatari aggiunte nell'elenco delle parti.
Sign Success Url	signSuccessUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà eseguito correttamente l'accesso nella visualizzazione di firma incorporata.
Url di rifiuto del segno	signDeclineUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà eseguito il reindirizzamento in caso di rifiuto di accedere alla visualizzazione di firma incorporata.
Firma url successivo	signLaterUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà reindirizzato se sceglie di accedere in un secondo momento nella visualizzazione di firma incorporata.
URL errore di firma	signErrorUrl		string	Immettere l'URL assoluto per i firmatari a cui verrà reindirizzato se si verifica un errore durante la firma del documento nella visualizzazione di firma incorporata.
Consenti sessione di invio ora e firma incorporata	allowSendNowAndEmbeddedSigningSession		boolean	Se impostato su true, Foxit eSign invierà un collegamento di firma univoco a ogni destinatario. Questo è applicabile SOLO quando i parametri sendNow e createEmbeddedSigningSession sono true.
Convalida avanzata della posta elettronica	allowAdvancedEmailValidation		boolean	Convalidare l'indirizzo di posta elettronica delle parti se impostato su true.
Firma url di operazione riuscita tutte le parti	signSuccessUrlAllParties		boolean	Se impostato su true, il firmatario verrà reindirizzato all'URL specificato in signSuccessUrl dopo la firma. Questo è applicabile solo quando sendNow è true.
ID modello di posta elettronica	emailTemplateId		integer	Passare l'ID modello di posta elettronica per inviare i modelli di posta elettronica diversi dai modelli di posta elettronica predefiniti.
ID istruzione del firmatario	signerInstructionId		integer	Passare l'ID istruzione per inviare istruzioni del firmatario diverse dalle istruzioni predefinite del firmatario.
ID istruzione di conferma	confirmationInstructionId		string	Passare l'ID istruzione di conferma per inviare istruzioni di conferma diverse dalle istruzioni di conferma predefinite.
Colore tema	themeColor		string	Immettere il valore CSS per impostare il colore del tema.
Scadenza sessione	sessionExpire		boolean	Impostare su true per avviare la scadenza della sessione di firma incorporata.
Scadenza	expiry		integer	Obbligatorio se sessionExpire è true. Immettere la durata in millisecondi della scadenza nella sessione di firma incorporata.
Nome campo dipendente	dependentFieldName	True	string	Nome del campo la cui visibilità è controllata dal campo padre.
Nome campo padre	parentFieldName	True	string	Nome del campo padre il cui valore controlla la visibilità del campo dipendente. Tipi di campo padre supportati: textfield, casella di testo, casella di controllo, pulsante di opzione, elenco a discesa.
Valore campo padre	parentFieldValue	True	string	Valore del campo padre che attiva la visualizzazione del campo dipendente. Per i campi casella di controllo e pulsante di opzione, usare selezionato o deselezionato.
Opzioni	options	True	string	Opzioni aggiuntive di corrispondenza per i campi padre basati su testo. Valori accettati: isblank, allowNull, contiene.
Metadati	metadata		object	Deve essere nella coppia chiave-valore. Sono consentite al massimo 1000 coppie chiave-valore.
Posta elettronica mittente	senderEmail		string	immettere l'indirizzo di posta elettronica di un altro utente nell'account che verrà usato per l'invio di questi documenti alle parti destinatari.
Nascondi pulsante Aggiungimi	hideAddMeButton		boolean	Se true, nasconderà il pulsante "Aggiungi me" nelle parti destinatari in una sessione di invio incorporata.
Nascondi pulsante Aggiungi nuovo	hideAddNewButton		boolean	Se true, nasconderà il pulsante "Aggiungi nuovo" nelle parti destinatari in una sessione di invio incorporata.
Nascondi pulsante Aggiungi gruppo	hideAddGroupButton		boolean	Se true, nasconderà il pulsante "Aggiungi gruppo" nelle parti destinatari in una sessione di invio incorporata.
Nascondi nome campo per i destinatari	hideFieldNameForRecipients		boolean	Nascondere i nomi dei campi per i destinatari per i campi di immissione dati e i campi avanzati. Ad eccezione del pulsante di opzione, della casella di controllo, dell'immagine e del collegamento ipertestuale.
Nascondi bordo casella di controllo	hideCheckboxBorder		boolean	I bordi della casella di controllo verranno nascosti nei documenti eseguiti.
Nascondi opzione di selezione del firmatario	hideSignerSelectOption		boolean	Se true, nasconderà la casella di input "Nome/messaggio di posta elettronica del firmatario esistente" nelle parti destinatari in una sessione di invio incorporata.
Nascondi azioni del firmatario	hideSignerActions		boolean	Se true, nasconderà le azioni di "modifica", "modifica" e "rimuovi" nei destinatari in una sessione di invio incorporata.
Nascondi nome mittente	hideSenderName		boolean	Se true, nasconderà il nome del mittente nelle parti destinatari in una sessione di invio incorporata.
Nascondi nome cartella	hideFolderName		boolean	Se true, il nome della cartella verrà nascosto nella navigazione in entrambe le sessioni incorporate.
Nascondi nome documenti	hideDocumentsName		boolean	Se true, il nome del documento verrà nascosto in entrambe le sessioni incorporate.
Nascondi rifiuto per firmare	hideDeclineToSign		boolean	Se true, nasconderà l'opzione "Rifiuta di firmare" per il firmatario.
Nascondi altre azioni	hideMoreAction		boolean	Se true, il pulsante "Altre azioni" verrà nascosto nella sessione di invio/firma. Nel caso di "Invia ora": true, non nasconderà nulla.
Nascondi pulsante Invia	hideSendButton		boolean	Se true, il pulsante Invia verrà nascosto nella sessione di invio incorporata.
Nascondi campo obbligatorio successivo	hideNextRequiredFieldbtn		boolean	Se impostato su true, nasconde il pulsante di spostamento che sposta i firmatari al campo obbligatorio successivo.
Sessione incorporata richiesta	requiredBothEmbeddedSession		boolean	Se true, genererà insieme gli URL di invio e firma incorporati.
Password busta	folderPassword		string	Questa password verrà richiesta dal firmatario/autore per aprire il documento firmato digitalmente. Se il parametro viene mantenuto vuoto, non sarà necessaria alcuna password per aprire il documento firmato digitalmente.
Abilitare il passaggio per passaggio	enableStepByStep		boolean	Per abilitare un'azione dettagliata nella sessione di invio incorporata.
Nascondi l'opzione Aggiungi parti	hideAddPartiesOption		boolean	Se true, nasconderà l'opzione per aggiungere parti in modalità bozza e creazione di modelli.
Autofirmato	selfSign		boolean	Abilita l'accesso Self Sign incorporato tramite LE API. Questo parametro è applicabile solo quando il parametro createEmbeddedSendingSession è true.
URL di completamento autofirmato	selfSignerSuccessUrl		string	Immettere l'URL assoluto per la pagina di destinazione nel sito Web o nell'applicazione, a cui l'utente verrà reindirizzato dopo l'invio automatico della cartella nella visualizzazione di invio incorporata.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
ID	folder.folderId	integer	ID univoco della busta appena creata. Utilizzare questa opzione nelle azioni successive per fare riferimento a questa busta.
Name	folder.folderName	string	Nome della busta appena creata.
Nome personalizzato	folder.folderCustomName	string	Nome personalizzato per la busta.
Parola chiave	folder.folderPassword	string	Password di accesso per la busta, se impostata.
ID creatore	folder.folderAuthorId	integer	Identificatore univoco dell'autore della busta.
Nome autore	folder.folderAuthorFirstName	string	Nome dell'autore della busta.
Cognome creatore	folder.folderAuthorLastName	string	Cognome dell'autore della busta.
Messaggio di posta elettronica creatore	folder.folderAuthorEmail	string	Indirizzo di posta elettronica dell'autore della busta.
Ruolo creatore	folder.folderAuthorRole	string	Ruolo dell'autore della busta.
ID aziendale	folder.folderCompanyId	integer	Identificatore univoco della società proprietaria della busta.
Data di creazione	folder.folderCreationDate	integer	Data di creazione della busta (timestamp Unix in millisecondi).
Data di invio	folder.folderSentDate	integer	Data di invio della busta (timestamp Unix in millisecondi).
Condizione	folder.folderStatus	string	Stato corrente della busta.
Campo personalizzato 1	folder.custom_field1	string	Primo campo di metadati personalizzato per la busta.
Campo personalizzato 2	folder.custom_field2	string	Secondo campo di metadati personalizzato per la busta.
Metadati	folder.metadata	string	Metadati personalizzati associati alla busta.
ID dei documenti	folder.folderDocumentIds	array of integer	Elenco di ID documento contenuti nella busta.
Documents	folder.documentsList	array of object	Elenco di documenti nella busta.
ID documento	folder.documentsList.documentId	integer	Identificatore univoco del documento.
ID contratto	folder.documentsList.contractId	integer	Identificatore univoco del contratto.
ID aziendale	folder.documentsList.companyId	integer	Identificatore univoco della società.
Creato da	folder.documentsList.contractCreatedBy	integer	ID utente della persona che ha creato il contratto.
Data di creazione	folder.documentsList.contractCreatedOn	string	Data e ora di creazione del contratto.
Tipo di contratto	folder.documentsList.contractType	string	Tipo del contratto.
Stato contratto	folder.documentsList.contractStatus	string	Stato corrente del contratto.
Modificabile	folder.documentsList.editable	boolean	Indica se l'elemento è modificabile.
ID versione	folder.documentsList.contractVersionId	integer	Identificatore univoco della versione del contratto.
Nome versione	folder.documentsList.contractVersionName	string	Nome della versione del contratto.
Descrizione della versione	folder.documentsList.contractVersionDesc	string	Descrizione della versione del contratto.
Versione creata da	folder.documentsList.versionCreatedby	integer	ID utente della persona che ha creato questa versione.
Versione creata in	folder.documentsList.versionCreatedOn	string	Data e ora di creazione di questa versione.
Numero di versione	folder.documentsList.contractVersionNumber	integer	Numero di versione del contratto.
Origine transazione	folder.documentsList.contractTransactionSource	string	Sistema di origine che ha avviato la transazione del contratto.
Destinatari	folder.folderRecipientParties	array of object	Elenco di entità destinatari per la busta.
ID destinatario	folder.folderRecipientParties.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	folder.folderRecipientParties.partyDetails.partyId	integer	Identificatore univoco del destinatario.
Nome di battesimo	folder.folderRecipientParties.partyDetails.firstName	string	Nome del destinatario.
Cognome	folder.folderRecipientParties.partyDetails.lastName	string	Cognome del destinatario.
Indirizzo e-mail	folder.folderRecipientParties.partyDetails.emailId	string	Indirizzo di posta elettronica del destinatario.
Segnaposto	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se questa parte è un destinatario segnaposto.
Address	folder.folderRecipientParties.partyDetails.address	string	Indirizzo fisico del destinatario.
Data di creazione	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data di creazione del record (timestamp Unix in millisecondi).
Rifiutare esplicitamente i messaggi di posta elettronica	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se il destinatario ha rifiutato esplicitamente le notifiche tramite posta elettronica.
ID destinatario univoco	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificatore di sistema univoco per il destinatario.
Livello di autenticazione	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metodo di autenticazione necessario per questo destinatario.
Data aggiornamento password	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Data dell'ultimo aggiornamento della password.
Stato aggiornato della password	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indica se la password è stata aggiornata.
ID aziendale	folder.folderRecipientParties.partyDetails.companyId	integer	Identificatore univoco della società.
Ruolo utente	folder.folderRecipientParties.partyDetails.userRole	string	Ruolo assegnato all'utente.
Dipartimento	folder.folderRecipientParties.partyDetails.department	string	Reparto a cui appartiene l'utente.
Titolo	folder.folderRecipientParties.partyDetails.title	string	Titolo del lavoro dell'utente.
Active	folder.folderRecipientParties.partyDetails.active	boolean	Indica se l'utente o il record è attivo.
Luogo	folder.folderRecipientParties.partyDetails.requestLocale	string	Impostazione delle impostazioni locali per l'utente.
Condividi con Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indica se le buste vengono condivise nel reparto.
Composizione del codice	folder.folderRecipientParties.partyDetails.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numero di telefono cellulare.
Filtro stato	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtro per lo stato del documento.
Filtro data	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtro per la data del documento.
Accesso sicuro al campo	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indica se l'utente ha accesso a campi protetti.
Espandi barra laterale	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indica se la barra laterale è espansa per impostazione predefinita.
Adv. Convalida della posta elettronica	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indica se la convalida avanzata della posta elettronica è abilitata.
ID del Manager	folder.folderRecipientParties.partyDetails.managerId	string	Identificatore univoco del responsabile dell'utente.
Conteggio account di accesso	folder.folderRecipientParties.partyDetails.loginCount	integer	Numero di volte in cui l'utente ha eseguito l'accesso.
Indirizzo di posta elettronica per la reimpostazione della password	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indica se deve essere inviato un messaggio di posta elettronica di reimpostazione della password.
ID reparto	folder.folderRecipientParties.partyDetails.departmentId	string	Identificatore univoco del reparto.
Società primaria	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Società primaria associata all'utente.
Tipo di dispositivo	folder.folderRecipientParties.partyDetails.deviceType	string	Tipo di dispositivo usato.
Token dispositivo	folder.folderRecipientParties.partyDetails.deviceToken	string	Token di notifica push per il dispositivo.
Descrizione subappaltatori	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Descrizione del subappaltatore o del firmatario esterno.
Organizzazione subappaltatori	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nome dell'organizzazione del subappaltatore o firmatario esterno.
Data aggiunta subappaltatori	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Data di aggiunta del subappaltatore (timestamp Unix in millisecondi).
Source	folder.folderRecipientParties.partyDetails.source	string	Sistema di origine da cui è stato aggiunto il firmatario esterno.
Composizione del codice	folder.folderRecipientParties.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.folderRecipientParties.mobileNumber	string	Numero di telefono cellulare.
Tipo di firma	folder.folderRecipientParties.signerSignatureType	string	Tipo di firma che verrà usato dal firmatario.
Autorizzazioni	folder.folderRecipientParties.contractPermissions	string	Autorizzazioni concesse a questa parte per il contratto.
Ordine di firma	folder.folderRecipientParties.partySequence	integer	Numero di sequenza dell'ordine di firma per questo destinatario.
Sequenza flusso di lavoro	folder.folderRecipientParties.workflowSignSequence	integer	Numero di sequenza di firma del flusso di lavoro.
ID busta	folder.folderRecipientParties.envelopeId	integer	Identificatore univoco della busta.
ID società destinatario	folder.folderRecipientParties.partyCompanyId	integer	Identificatore univoco della società associata al destinatario.
Modalità condivisione	folder.folderRecipientParties.sharingMode	string	Modalità di condivisione per questa busta.
URL accesso destinatario	folder.folderRecipientParties.folderAccessURL	string	URL che il destinatario può usare per accedere e firmare la busta.
Modalità di sicurezza	folder.folderRecipientParties.securityMode	string	Modalità di sicurezza applicata alla busta.
Comments	folder.folderRecipientParties.extraComments	string	Commenti aggiuntivi inclusi nella busta.
Consenti modifica nome	folder.folderRecipientParties.allowNameChange	boolean	Indica se il destinatario è autorizzato ad aggiornare il nome.
Nome aggiornato	folder.folderRecipientParties.signerNameUpdated	boolean	Indica se il firmatario ha aggiornato il nome.
Livello di autenticazione del firmatario	folder.folderRecipientParties.signerAuthenticationLevel	string	Livello di autenticazione necessario per il firmatario.
Codice di accesso	folder.folderRecipientParties.userDefinedAccessCode	string	Codice di accesso personalizzato definito per il firmatario.
ID firma	folder.folderRecipientParties.signatureId	string	Identificatore univoco della firma.
Ruolo destinatario	folder.folderRecipientParties.partyRole	string	Ruolo assegnato a questo destinatario nel flusso di lavoro di firma.
Campo società	folder.folderRecipientParties.companyFieldValue	string	Valore del campo nome società nella firma.
Campo titolo	folder.folderRecipientParties.titleFieldValue	string	Valore del campo del titolo nella firma.
Motivo della firma	folder.folderRecipientParties.reasonSigning	string	Motivo per cui il destinatario sta firmando il documento.
Campo pagamento aggiunto	folder.folderRecipientParties.payFieldAdded	boolean	Indica se è stato aggiunto un campo di pagamento.
Beneficiario	folder.folderRecipientParties.payee	boolean	Indica se il destinatario è l'utente a pagamento.
Pagamento ricorrente	folder.folderRecipientParties.recurringFieldExist	boolean	Indica se esiste un campo di pagamento ricorrente.
Stampa e firma fine	folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se il processo di stampa e firma è stato completato.
Pagato	folder.folderRecipientParties.paid	boolean	Indica se il pagamento è stato completato.
Facoltativo firmatario consentito	folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se il destinatario è un firmatario facoltativo.
Firmatari facoltativi	folder.folderRecipientParties.optionalSigners	array of integer	Elenco di ID entità firmatario facoltativi per questa busta.
URL di firma dell'autore	folder.folderAccessURLForAuthor	string	URL che il mittente può usare per accedere alla busta.
Draft Access URL	folder.draftFolderAccessURL	string	URL utilizzato per accedere alla versione bozza della busta.
Firma boardroom	folder.boardRoomSign	boolean	Indica se la modalità di firma della sala riunioni è abilitata.
Includi logo	folder.includeLogo	boolean	Indica se il logo aziendale è incluso nei messaggi di posta elettronica.
Colore sfondo pulsante	folder.email_btnBgColor	string	Colore di sfondo del pulsante di posta elettronica.
Colore testo pulsante	folder.email_btnTxtColor	string	Colore del testo del pulsante di posta elettronica.
Logo e-mail	folder.emailTemplateLogo	string	URL del logo usato nel modello di posta elettronica.
ID modello di posta elettronica	folder.emailTemplateId	integer	Identificatore univoco del modello di posta elettronica.
Intestazione posta elettronica	folder.emailHeader	string	Testo dell'intestazione usato nei messaggi di posta elettronica di notifica.
Piè di pagina del messaggio di posta elettronica	folder.emailFooter	string	Testo del piè di pagina usato nei messaggi di posta elettronica di notifica.
Ripulitura pianificata	folder.purgeFlag	boolean	Indica se la busta è pianificata per l'eliminazione.
Elimina data di inizio	folder.purgeStartDate	string	Data da cui iniziare l'eliminazione.
Data di fine eliminazione	folder.purgeEndDate	string	Data di completamento dell'eliminazione.
ID invio bulk	folder.bulkId	integer	Identificatore univoco dell'operazione di invio bulk.
Imponi ordine di firma	folder.enforceSignWorkflow	boolean	Indica se i destinatari devono accedere alla sequenza definita.
Passaggio corrente	folder.currentWorkflowStep	integer	Passaggio corrente nel flusso di lavoro di firma.
Origine transazione	folder.transactionSource	string	Sistema di origine che ha avviato questa transazione.
Modificabile	folder.editable	boolean	Indica se l'elemento è modificabile.
firma In-Person	folder.inPersonSignable	boolean	Indica se la busta può essere firmata di persona.
Eseguire l'override dei promemoria	folder.overrideAccountReminders	boolean	Indica se le impostazioni di promemoria a livello di account vengono sostituite.
Eseguire l'override della delega	folder.overrideAccountRecipientDelegation	boolean	Indica se le impostazioni di delega a livello di account vengono sostituite.
Consenti delega	folder.allowRecipientsToDelegate	boolean	Indica se i destinatari possono delegare la firma.
ID	folder.envelopeId	integer	Identificatore univoco della busta.
Name	folder.envelopeName	string	Nome della busta.
ID origine	folder.envelopeOriginatorId	integer	Identificatore univoco dell'utente che ha creato la busta.
ID aziendale	folder.envelopeCompanyId	integer	Identificatore univoco della società proprietaria della busta.
Date	folder.envelopeDate	integer	Data di creazione della busta (timestamp Unix in millisecondi).
Data condivisa	folder.envelopeSharedDate	integer	Data di condivisione della busta (timestamp Unix in millisecondi).
Condizione	folder.envelopeStatus	string	Stato corrente della busta.
ID contratto	folder.envelopeContractIds	array of integer	Elenco di ID contratto associati a questa busta.
Autorizzazioni destinatario	folder.envelopePartyPermissions	array of object	Elenco delle autorizzazioni del destinatario per questa busta.
ID destinatario	folder.envelopePartyPermissions.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	folder.envelopePartyPermissions.partyDetails.partyId	integer	Identificatore univoco del destinatario.
Nome di battesimo	folder.envelopePartyPermissions.partyDetails.firstName	string	Nome del destinatario.
Cognome	folder.envelopePartyPermissions.partyDetails.lastName	string	Cognome del destinatario.
Indirizzo e-mail	folder.envelopePartyPermissions.partyDetails.emailId	string	Indirizzo di posta elettronica del destinatario.
Segnaposto	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indica se questa parte è un destinatario segnaposto.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Indirizzo fisico del destinatario.
Data di creazione	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Data di creazione del record (timestamp Unix in millisecondi).
Rifiutare esplicitamente i messaggi di posta elettronica	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indica se il destinatario ha rifiutato esplicitamente le notifiche tramite posta elettronica.
ID destinatario univoco	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Identificatore di sistema univoco per il destinatario.
Livello di autenticazione	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Metodo di autenticazione necessario per questo destinatario.
Data aggiornamento password	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Data dell'ultimo aggiornamento della password.
Stato aggiornato della password	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indica se la password è stata aggiornata.
ID aziendale	folder.envelopePartyPermissions.partyDetails.companyId	integer	Identificatore univoco della società.
Ruolo utente	folder.envelopePartyPermissions.partyDetails.userRole	string	Ruolo assegnato all'utente.
Dipartimento	folder.envelopePartyPermissions.partyDetails.department	string	Reparto a cui appartiene l'utente.
Titolo	folder.envelopePartyPermissions.partyDetails.title	string	Titolo del lavoro dell'utente.
Active	folder.envelopePartyPermissions.partyDetails.active	boolean	Indica se l'utente o il record è attivo.
Luogo	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Impostazione delle impostazioni locali per l'utente.
Condividi con Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indica se le buste vengono condivise nel reparto.
Composizione del codice	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Numero di telefono cellulare.
Filtro stato	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtro per lo stato del documento.
Filtro data	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtro per la data del documento.
Accesso sicuro al campo	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indica se l'utente ha accesso a campi protetti.
Espandi barra laterale	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indica se la barra laterale è espansa per impostazione predefinita.
Adv. Convalida della posta elettronica	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indica se la convalida avanzata della posta elettronica è abilitata.
ID del Manager	folder.envelopePartyPermissions.partyDetails.managerId	string	Identificatore univoco del responsabile dell'utente.
Conteggio account di accesso	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Numero di volte in cui l'utente ha eseguito l'accesso.
Indirizzo di posta elettronica per la reimpostazione della password	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indica se deve essere inviato un messaggio di posta elettronica di reimpostazione della password.
ID reparto	folder.envelopePartyPermissions.partyDetails.departmentId	string	Identificatore univoco del reparto.
Società primaria	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Società primaria associata all'utente.
Tipo di dispositivo	folder.envelopePartyPermissions.partyDetails.deviceType	string	Tipo di dispositivo usato.
Token dispositivo	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Token di notifica push per il dispositivo.
Descrizione subappaltatori	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Descrizione del subappaltatore o del firmatario esterno.
Organizzazione subappaltatori	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Nome dell'organizzazione del subappaltatore o firmatario esterno.
Data aggiunta subappaltatori	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Data di aggiunta del subappaltatore (timestamp Unix in millisecondi).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Sistema di origine da cui è stato aggiunto il firmatario esterno.
Composizione del codice	folder.envelopePartyPermissions.dialingCode	string	Codice di composizione internazionale per il numero di telefono.
Numero di cellulare	folder.envelopePartyPermissions.mobileNumber	string	Numero di telefono cellulare.
Tipo di firma	folder.envelopePartyPermissions.signerSignatureType	string	Tipo di firma che verrà usato dal firmatario.
Autorizzazioni	folder.envelopePartyPermissions.contractPermissions	string	Autorizzazioni concesse a questa parte per il contratto.
Ordine di firma	folder.envelopePartyPermissions.partySequence	integer	Numero di sequenza dell'ordine di firma per questo destinatario.
Sequenza flusso di lavoro	folder.envelopePartyPermissions.workflowSignSequence	integer	Numero di sequenza di firma del flusso di lavoro.
ID busta	folder.envelopePartyPermissions.envelopeId	integer	Identificatore univoco della busta.
ID società destinatario	folder.envelopePartyPermissions.partyCompanyId	integer	Identificatore univoco della società associata al destinatario.
Modalità condivisione	folder.envelopePartyPermissions.sharingMode	string	Modalità di condivisione per questa busta.
URL accesso destinatario	folder.envelopePartyPermissions.folderAccessURL	string	URL che il destinatario può usare per accedere e firmare la busta.
Modalità di sicurezza	folder.envelopePartyPermissions.securityMode	string	Modalità di sicurezza applicata alla busta.
Comments	folder.envelopePartyPermissions.extraComments	string	Commenti aggiuntivi inclusi nella busta.
Consenti modifica nome	folder.envelopePartyPermissions.allowNameChange	boolean	Indica se il destinatario è autorizzato ad aggiornare il nome.
Nome aggiornato	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indica se il firmatario ha aggiornato il nome.
Livello di autenticazione del firmatario	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Livello di autenticazione necessario per il firmatario.
Codice di accesso	folder.envelopePartyPermissions.userDefinedAccessCode	string	Codice di accesso personalizzato definito per il firmatario.
ID firma	folder.envelopePartyPermissions.signatureId	string	Identificatore univoco della firma.
Ruolo destinatario	folder.envelopePartyPermissions.partyRole	string	Ruolo assegnato a questo destinatario nel flusso di lavoro di firma.
Campo società	folder.envelopePartyPermissions.companyFieldValue	string	Valore del campo nome società nella firma.
Campo titolo	folder.envelopePartyPermissions.titleFieldValue	string	Valore del campo del titolo nella firma.
Motivo della firma	folder.envelopePartyPermissions.reasonSigning	string	Motivo per cui il destinatario sta firmando il documento.
Campo pagamento aggiunto	folder.envelopePartyPermissions.payFieldAdded	boolean	Indica se è stato aggiunto un campo di pagamento.
Beneficiario	folder.envelopePartyPermissions.payee	boolean	Indica se il destinatario è l'utente a pagamento.
Pagamento ricorrente	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indica se esiste un campo di pagamento ricorrente.
Stampa e firma fine	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indica se il processo di stampa e firma è stato completato.
Pagato	folder.envelopePartyPermissions.paid	boolean	Indica se il pagamento è stato completato.
Livello di autenticazione	folder.envelopeAuthenticationLevel	string	Livello di autenticazione necessario per la busta.
Single Signer Bulk	folder.allowSingleSignerInBulk	boolean	Indica se un single signer è consentito in modalità di invio bulk.
denominazione File-Based	folder.folderNameBasedOnFileNaming	boolean	Indica se il nome della cartella è basato sul nome del file.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Indica se il nome del documento è basato sul nome del file.
Nome File-Based certificato	folder.certificateNameBasedOnFileNaming	boolean	Indica se il nome del certificato è basato sul nome del file.
Denominazione dei file pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Indica se la denominazione dei file è abilitata prima dell'esecuzione del documento.
Aggiunta di Payee	folder.payeeAddedd	boolean	Indica se è stato aggiunto un payee.
Self-Signing abilitata	folder.selfSignerEnabled	boolean	Indica se la modalità di firma automatica è abilitata.
Notary Enabled	folder.notaryEnabled	boolean	Indica se la firma notaria è abilitata.
Visibilità limitata	folder.limitedVisibilityFlag	boolean	Indica se la visibilità limitata è abilitata per questa busta.
Visibilità post-firma	folder.postSigningVisibility	boolean	Indica se la visibilità post-firma è abilitata.
Firma bagnata	folder.wetSignatureEnabled	boolean	Indica se le firme bagnate sono abilitate.
Merge abilitato	folder.mergeEnabled	boolean	Indica se l'unione dei documenti è abilitata.
Sessioni di firma incorporate	embeddedSigningSessions	array of object	Elenco di sessioni di firma incorporate, una per destinatario. Presente solo quando createEmbeddedSigningSession è true.
Messaggio di posta elettronica del firmatario	embeddedSigningSessions.emailIdOfSigner	string	Indirizzo di posta elettronica del destinatario per questa sessione di firma incorporata.
Token di firma	embeddedSigningSessions.embeddedToken	string	Token univoco per la sessione di firma incorporata del destinatario.
URL sessione di firma	embeddedSigningSessions.embeddedSessionURL	string	URL da aprire o incorporare per il destinatario per firmare il documento.
Token di invio incorporato	embeddedToken	string	Token per la sessione di invio incorporata. È presente solo quando createEmbeddedSendingSession è true.
Invio dell'URL della sessione	embeddedSessionURL	string	URL da aprire o incorporare per l'autore della busta da preparare e inviare la busta. È presente solo quando createEmbeddedSendingSession è true.
Result	result	string	Risultato dell'operazione.
Message	message	string	Messaggio che descrive il risultato dell'operazione.

Creare un gruppo di posta elettronica

ID operazione:: CreateEmailGroup

Crea un nuovo gruppo di posta elettronica che può essere usato per inviare buste a più destinatari contemporaneamente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome del gruppo	emailGroupName	True	string	Nome del nuovo gruppo di posta elettronica.
Descrizione gruppo	emailGroupDescription		string	Descrizione facoltativa per il gruppo di posta elettronica.
Consenti convalida avanzata della posta elettronica	allowAdvancedEmailValidation		boolean	Se abilitata, Foxit eSign verifica che tutti gli indirizzi di posta elettronica nel gruppo siano raggiungibili prima dell'invio.
Nome di battesimo	firstName	True	string	Nome del destinatario.
Cognome	lastName	True	string	Cognome del destinatario.
Email	emailId	True	string	Indirizzo di posta elettronica del destinatario.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
Message	message	string	Messaggio di conferma per l'azione eseguita.
ID del Gruppo	emailGroup.groupId	integer	Identificatore univoco del gruppo di posta elettronica. Usare questo ID quando si inviano buste al gruppo.
Nome del gruppo	emailGroup.groupName	string	Nome del gruppo di posta elettronica.
Descrizione gruppo	emailGroup.groupDesc	string	Descrizione del gruppo di posta elettronica.
Data di creazione	emailGroup.dateCreated	integer	Data di creazione del gruppo di posta elettronica, in millisecondi Unix.
ID aziendale	emailGroup.companyId	integer	L'account aziendale a cui appartiene questo gruppo di posta elettronica.
Parties	emailGroup.parties	array of object	Elenco di destinatari nel gruppo di posta elettronica.
Nome di battesimo	emailGroup.parties.firstName	string	Nome del destinatario.
Cognome	emailGroup.parties.lastName	string	Cognome del destinatario.
Email	emailGroup.parties.emailId	string	Indirizzo di posta elettronica del destinatario.

Creare un modello da Base64

ID operazione:: CreateTemplatefromBase64

Crea un nuovo modello usando una stringa PDF con codifica Base64. Usare questa opzione quando il file PDF è già disponibile come stringa Base64 nel flusso, ad esempio da un file SharePoint o OneDrive documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome del modello	templateName	True	string	Nome del modello. Deve terminare con l'estensione .pdf (ad esempio, onboarding.pdf).
Stringa di file Base64	base64FileString	True	string	Stringa BASE64 di un PDF per la creazione del modello. Deve essere accessibile pubblicamente quando si crea il modello.
Tipo di input	inputType	True	string	Metodo di input per il documento. Impostare sempre su "base64" per questa azione.
Elaborare tag di testo	processTextTags	True	boolean	Se abilitata, Foxit eSign analizzerà il documento per i tag di testo e li convertirà automaticamente in campi della firma.
Elaborare campi Acro	processAcroFields	True	boolean	Se abilitata, Foxit eSign analizzerà il documento per AcroFields e li convertirà automaticamente in campi di firma.
Condividi tutto	shareAll	True	boolean	Condividere questo modello con tutti gli utenti nell'account.
Numero di parti	numberOfParties	True	integer	Numero di entità destinatari per questo modello. Deve essere minore di 20.
Colore tema	themeColor		string	Valore del colore CSS per personalizzare il tema della sessione modello incorporata (ad esempio, #42caf4).
Autore Email	authorEmail		string	Indirizzo di posta elettronica di un altro utente nell'account da impostare come autore di questo modello.
Creare una sessione modello incorporata	createEmbeddedTemplateSession		boolean	Se è impostata su true, viene creata una sessione modello incorporata in modo da poter aprire direttamente l'editor di modelli Foxit eSign e trascinare i campi nel modello.
URL di reindirizzamento	redirectURL		string	Se create Embedded Template Session è true, l'URL a cui reindirizzare l'utente dopo aver fatto clic su Salva e chiudi nell'editor di modelli incorporato.
Nascondi modello di invio	hideSendTemplate		boolean	Se true, il pulsante Invia è nascosto nell'editor di modelli incorporato.
Correggere le entità destinatari	fixRecipientParties		boolean	Se true, le entità destinatari già aggiunte non possono essere modificate nell'editor di modelli incorporato.
Campi	Fields		object
permissions	permission	True	string
Sequenza	sequence	True	integer	Numero di sequenza univoco per questa parte, a partire da 1. Definisce l'ordine di firma quando la sequenza di accesso è abilitata.
Ruolo destinatario	partyRole	True	string	Ruolo assegnato a questa parte nel modello.
Nascondi altre azioni	hideMoreAction		boolean	Se true, il pulsante Altre azioni viene nascosto nella sessione modello incorporata.
Nascondi condivisione con tutti	hideShareWithAll		boolean	Se true, l'opzione Condividi con tutto è nascosta nella sessione modello incorporata.
Nascondi componente aggiuntivo	hideAddParty		boolean	Se true, tutte le opzioni di aggiunta di entità vengono nascoste nella sessione modello incorporata.
Nascondi pulsante Me	hideMeButton		boolean	Se true, il pulsante Me in Recipient Party è nascosto nella sessione di modello incorporata.
Nascondi altri pulsante	hideOthersButton		boolean	Se true, il pulsante Altri nelle parti destinatari viene nascosto nella sessione di modello incorporata.
Nascondi nome campo per i destinatari	hideFieldNameForRecipients		boolean	Se true, i nomi dei campi vengono nascosti ai destinatari per l'immissione dei dati e i campi avanzati.
Nascondi bordo casella di controllo	hideCheckboxBorder		boolean	Se true, i bordi delle caselle di controllo sono nascosti nei documenti eseguiti.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se l'operazione ha avuto esito positivo, ad esempio "operazione riuscita".
Message	message	string	Descrizione del risultato dell'operazione.
ID	template.templateId	integer	ID univoco del modello creato. Usare questa opzione per creare buste da questo modello.
Name	template.templateName	string	Nome del modello.
Description	template.templateDesc	string	Descrizione del modello.
Tipo	template.templateType	string	Tipo del modello.
Data di creazione	template.templateCreationDate	string	Data di creazione del modello.
Data ultimo aggiornamento	template.templateLastUpdateDate	string	Data dell'ultimo aggiornamento del modello.
Modificabile	template.editable	boolean	Indica se il modello può essere modificato.
Numero di parti	template.numberOfParties	integer	Numero di entità destinatari definite nel modello.
Totale pagine	template.totalPages	integer	Numero totale di pagine nel documento modello.
ID aziendale	template.companyId	integer	ID della società a cui appartiene questo modello.
Condiviso con tutti	template.shareAll	boolean	Indica se questo modello viene condiviso con tutti gli utenti nell'account.
Autorizzazioni di entità	template.templatePartyPermissions	array of object	Elenco dei ruoli destinatario e delle relative autorizzazioni definite in questo modello.
ID parte	template.templatePartyPermissions.template_party_id	integer	ID univoco di questa voce di entità del modello.
ID	template.templatePartyPermissions.templateId	integer	ID del modello a cui appartiene questa entità.
Autorizzazioni	template.templatePartyPermissions.templatePermissions	string	Autorizzazioni di firma per questa entità, ad esempio FILL_FIELDS_AND_SIGN.
Ordine di firma	template.templatePartyPermissions.partySequence	integer	Posizione dell'ordine di firma per questa parte.
Ruolo di entità	template.templatePartyPermissions.templatePartyRole	string	Nome del ruolo assegnato a questa entità nel modello. Usare questa opzione durante la creazione di una busta dal modello.
ID utente	template.templateCreatedBy.partyId	integer	ID univoco dell'utente.
Nome di battesimo	template.templateCreatedBy.firstName	string	Nome dell'utente.
Cognome	template.templateCreatedBy.lastName	string	Cognome dell'utente.
Email	template.templateCreatedBy.emailId	string	Indirizzo di posta elettronica dell'utente.
Campi modello	allfields	array of object	Elenco di tutti i campi di firma e modulo definiti nel modello.
ID campo	allfields.fieldTagId	integer	Identificatore univoco del campo.
ID modello	allfields.templateId	integer	ID del modello a cui appartiene questo campo.
ID aziendale	allfields.companyId	integer	L'account aziendale a cui appartiene questo campo.
Tipo di campo	allfields.fieldType	string	Tipo del campo (ad esempio, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numero pagina	allfields.documentPageNumber	integer	Numero di pagina del documento in cui è posizionato questo campo.
Parte responsabile	allfields.partyResponsible	integer	Numero di sequenza di entità responsabile della compilazione di questo campo.
Sequenza di entità	allfields.partyResponsibleSequence	integer	Posizione della sequenza della parte responsabile.
ID documento campo	allfields.docFieldId	string	Identificatore a livello di documento per questo campo.
Dipende	allfields.dependent	boolean	Indica se la visibilità di questo campo dipende dal valore di un altro campo.
Ordine di tabulazioni	allfields.tabOrder	integer	Ordine di tabulazioni per lo spostamento tra i campi.
Obbligatorio	allfields.required	boolean	Indica se questo campo deve essere compilato prima che il documento possa essere firmato.
Nome campo personalizzato	allfields.customFieldName	string	Nome personalizzato assegnato a questo campo.
Condividi tutto	allfields.shareAll	boolean	Indica se questo campo è condiviso con tutti gli utenti.
Consenti modifica	allfields.allowEdit	boolean	Indica se questo campo può essere modificato dal destinatario.
Nome campo testo	allfields.textfieldName	string	Etichetta del campo di testo (applicabile quando fieldType è 'textfield').
Value	allfields.value	string	Valore precompilato o immesso del campo.
Dimensioni carattere	allfields.fontSize	integer	Dimensione del carattere utilizzata per il testo in questo campo.
Colore carattere	allfields.fontColor	string	Colore del carattere utilizzato per il testo in questo campo (ad esempio, #000000).
Sola lettura	allfields.readOnly	boolean	Indica se il campo è di sola lettura e non può essere modificato dal destinatario.
Multilinea	allfields.multiLine	boolean	Indica se il campo di testo accetta più righe di input (applicabile quando fieldType è 'textfield').
Limite di caratteri	allfields.characterLimit	integer	Numero massimo di caratteri consentiti nel campo (applicabile quando fieldType è 'textfield').
Nome campo data	allfields.datefieldName	string	Etichetta del campo data (applicabile quando fieldType è 'datefield').
Formato data	allfields.dateFormat	string	Formato di data utilizzato da questo campo (ad esempio, MM/GG/AAAA) (applicabile quando fieldType è 'datefield').
Nome casella di controllo	allfields.cbname	string	Etichetta del campo della casella di controllo (applicabile quando fieldType è 'checkboxfield').
Casella di controllo Gruppo	allfields.cbgroup	string	Nome del gruppo per questa casella di controllo (applicabile quando fieldType è 'checkboxfield').
Verificato	allfields.checked	boolean	Indica se la casella di controllo è selezionata per impostazione predefinita (applicabile quando fieldType è 'checkboxfield').
Nome campo protetto	allfields.securedfieldName	string	Etichetta del campo protetto (applicabile quando fieldType è 'securedfield').
Caratteri da visualizzare	allfields.charToDisplay	integer	Numero di caratteri non mascherati da visualizzare alla fine di un valore di campo protetto (applicabile quando fieldType è 'securedfield').
ID firma	allfields.signatureId	string	ID della firma applicata a questo campo di firma (applicabile quando fieldType è 'signfield').
Immagine iniziale	allfields.initialImage	string	Dati dell'immagine per le iniziali applicate a questo campo (applicabile quando fieldType è 'initialfield').
Nome campo allegato	allfields.attachmentfieldName	string	Nome del campo allegato (applicabile quando fieldType è 'attachmentfield').
Descrizione allegato	allfields.attachmentfieldDescription	string	Descrizione di cosa allegare (applicabile quando fieldType è 'attachmentfield').

Creare un modello dall'URL

ID operazione:: CreateTemplatefromURL

Crea un nuovo modello usando un URL PDF accessibile pubblicamente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome del modello	templateName	True	string	Nome del modello. Deve terminare con l'estensione .pdf (ad esempio, onboarding.pdf).
URL modello	templateUrl	True	string	URL accessibile pubblicamente del documento PDF da usare come modello.
Tipo di input	inputType	True	string	Metodo di input per il documento. Impostare sempre su "url" per questa azione.
Elaborare tag di testo	processTextTags	True	boolean	Se abilitata, Foxit eSign analizzerà il documento per i tag di testo e li convertirà automaticamente in campi della firma.
Elaborare campi Acro	processAcroFields	True	boolean	Se abilitata, Foxit eSign analizzerà il documento per AcroFields e li convertirà automaticamente in campi di firma.
Condividi tutto	shareAll	True	boolean	Condividere questo modello con tutti gli utenti nell'account.
Numero di parti	numberOfParties	True	integer	Aggiungere il numero di parti nel modello. I valori di questo parametro devono essere inferiori a 20.
Colore tema	themeColor		string	Immettere un valore css per un colore per modificare il tema di createEmbeddedTemplateSession.
Autore Email	authorEmail		string	Immettere l'indirizzo di posta elettronica di un altro utente in un account che verrà usato come autore per questo modello.
Creare una sessione modello incorporata	createEmbeddedTemplateSession		boolean	Se impostato su true, una sessione di modello incorporata per aprire direttamente il modello Foxit eSign che prepara la visualizzazione. Sarà disponibile il trascinamento e il rilascio di vari campi nel modello.
URL di reindirizzamento	redirectURL		string	Se createEmbeddedTemplateSession è true, l'URL assoluto può essere immesso per la pagina di destinazione in qualsiasi sito Web o applicazione, a cui l'utente verrà reindirizzato dopo aver fatto clic su "Salva e chiudi" nella visualizzazione modello incorporata.
Nascondi modello di invio	hideSendTemplate		boolean	Se true, il pulsante Invia verrà nascosto in una visualizzazione modello incorporata.
Correggere le entità destinatari	fixRecipientParties		boolean	Se true, nella visualizzazione modello incorporata non è possibile modificare le parti per la busta che sono già state aggiunte.
Campi	Fields		object
permissions	permission	True	string
Sequenza	sequence	True	integer	Numero di sequenza univoco per questa parte, a partire da 1. Definisce l'ordine di firma quando la sequenza di accesso è abilitata.
Ruolo destinatario	partyRole	True	string	Ruolo assegnato a questa parte nel modello.
Nascondi altre azioni	hideMoreAction		boolean	Se true, il pulsante "Altre azioni" verrà nascosto nella sessione del modello.
Nascondi condivisione con tutti	hideShareWithAll		boolean	Se true, l'opzione "Condividi con tutto" verrà nascosta nella sessione del modello.
Nascondi componente aggiuntivo	hideAddParty		boolean	Se true, nasconderà tutte le opzioni dell'entità in una sessione modello incorporata.
Nascondi pulsante Me	hideMeButton		boolean	Se true, nasconderà il pulsante "Me" sulle parti destinatari in una sessione di modello incorporata.
Nascondi altri pulsante	hideOthersButton		boolean	Se true, nasconderà il pulsante "Altri" nelle parti destinatari in una sessione di modello incorporata.
Nascondi opzione seleziona contatto esistente	hideExistingContactSelectOption		boolean	Se true, nasconde la casella di input "Trova e aggiungi contatto esistente" nelle parti destinatari in una sessione modello incorporata.
Nascondi nome campo per i destinatari	hideFieldNameForRecipients		boolean	Nascondere i nomi dei campi per i destinatari per i campi di immissione dati e i campi avanzati. Ad eccezione del pulsante di opzione, della casella di controllo, dell'immagine e del collegamento ipertestuale.
Nascondi bordo casella di controllo	hideCheckboxBorder		boolean	I bordi della casella di controllo verranno nascosti nei documenti eseguiti.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se l'operazione ha avuto esito positivo, ad esempio "operazione riuscita".
Message	message	string	Descrizione del risultato dell'operazione.
ID	template.templateId	integer	ID univoco del modello creato. Usare questa opzione per creare buste da questo modello.
Name	template.templateName	string	Nome del modello.
Description	template.templateDesc	string	Descrizione del modello.
Tipo	template.templateType	string	Tipo del modello.
Data di creazione	template.templateCreationDate	string	Data di creazione del modello.
Data ultimo aggiornamento	template.templateLastUpdateDate	string	Data dell'ultimo aggiornamento del modello.
Modificabile	template.editable	boolean	Indica se il modello può essere modificato.
Numero di parti	template.numberOfParties	integer	Numero di entità destinatari definite nel modello.
Totale pagine	template.totalPages	integer	Numero totale di pagine nel documento modello.
ID aziendale	template.companyId	integer	ID della società a cui appartiene questo modello.
Condiviso con tutti	template.shareAll	boolean	Indica se questo modello viene condiviso con tutti gli utenti nell'account.
Modello di nome personalizzato	template.templateCustomName	string	Modello di nome personalizzato applicato alle buste create da questo modello.
Autorizzazioni di entità	template.templatePartyPermissions	array of object	Elenco dei ruoli destinatario e delle relative autorizzazioni definite in questo modello.
ID parte	template.templatePartyPermissions.template_party_id	integer	ID univoco di questa voce di entità del modello.
ID	template.templatePartyPermissions.templateId	integer	ID del modello a cui appartiene questa entità.
Autorizzazioni	template.templatePartyPermissions.templatePermissions	string	Autorizzazioni di firma per questa entità, ad esempio FILL_FIELDS_AND_SIGN.
Ordine di firma	template.templatePartyPermissions.partySequence	integer	Posizione dell'ordine di firma per questa parte.
Ruolo di entità	template.templatePartyPermissions.templatePartyRole	string	Nome del ruolo assegnato a questa entità nel modello. Usare questa opzione durante la creazione di una busta dal modello.
ID parte	template.templatePartyPermissions.partyId	integer	ID della parte assegnata a questo ruolo, se pre-assegnata.
ID utente	template.templateCreatedBy.partyId	integer	ID univoco dell'utente.
Nome di battesimo	template.templateCreatedBy.firstName	string	Nome dell'utente.
Cognome	template.templateCreatedBy.lastName	string	Cognome dell'utente.
Email	template.templateCreatedBy.emailId	string	Indirizzo di posta elettronica dell'utente.
ID aziendale	template.templateCreatedBy.companyId	integer	ID della società a cui appartiene l'utente.
Ruolo utente	template.templateCreatedBy.userRole	string	Ruolo dell'utente all'interno dell'organizzazione.
Active	template.templateCreatedBy.active	boolean	Indica se l'account dell'utente è attivo.
ID utente	template.templateLastUpdatedBy.partyId	integer	ID univoco dell'utente.
Nome di battesimo	template.templateLastUpdatedBy.firstName	string	Nome dell'utente.
Cognome	template.templateLastUpdatedBy.lastName	string	Cognome dell'utente.
Email	template.templateLastUpdatedBy.emailId	string	Indirizzo di posta elettronica dell'utente.
ID aziendale	template.templateLastUpdatedBy.companyId	integer	ID della società a cui appartiene l'utente.
Ruolo utente	template.templateLastUpdatedBy.userRole	string	Ruolo dell'utente all'interno dell'organizzazione.
Active	template.templateLastUpdatedBy.active	boolean	Indica se l'account dell'utente è attivo.
Campi modello	allfields	array of object	Elenco di tutti i campi di firma e modulo definiti nel modello.
ID campo	allfields.fieldTagId	integer	Identificatore univoco del campo.
ID modello	allfields.templateId	integer	ID del modello a cui appartiene questo campo.
ID aziendale	allfields.companyId	integer	L'account aziendale a cui appartiene questo campo.
Tipo di campo	allfields.fieldType	string	Tipo del campo (ad esempio, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numero pagina	allfields.documentPageNumber	integer	Numero di pagina del documento in cui è posizionato questo campo.
Parte responsabile	allfields.partyResponsible	integer	Numero di sequenza di entità responsabile della compilazione di questo campo.
Sequenza di entità	allfields.partyResponsibleSequence	integer	Posizione della sequenza della parte responsabile.
ID documento campo	allfields.docFieldId	string	Identificatore a livello di documento per questo campo.
Dipende	allfields.dependent	boolean	Indica se la visibilità di questo campo dipende dal valore di un altro campo.
Ordine di tabulazioni	allfields.tabOrder	integer	Ordine di tabulazioni per lo spostamento tra i campi.
Obbligatorio	allfields.required	boolean	Indica se questo campo deve essere compilato prima che il documento possa essere firmato.
Nome campo personalizzato	allfields.customFieldName	string	Nome personalizzato assegnato a questo campo.
Condividi tutto	allfields.shareAll	boolean	Indica se questo campo è condiviso con tutti gli utenti.
Consenti modifica	allfields.allowEdit	boolean	Indica se questo campo può essere modificato dal destinatario.
Nome campo testo	allfields.textfieldName	string	Etichetta del campo di testo (applicabile quando fieldType è 'textfield').
Value	allfields.value	string	Valore precompilato o immesso del campo.
Dimensioni carattere	allfields.fontSize	integer	Dimensione del carattere utilizzata per il testo in questo campo.
Colore carattere	allfields.fontColor	string	Colore del carattere utilizzato per il testo in questo campo (ad esempio, #000000).
Sola lettura	allfields.readOnly	boolean	Indica se il campo è di sola lettura e non può essere modificato dal destinatario.
Multilinea	allfields.multiLine	boolean	Indica se il campo di testo accetta più righe di input (applicabile quando fieldType è 'textfield').
Limite di caratteri	allfields.characterLimit	integer	Numero massimo di caratteri consentiti nel campo (applicabile quando fieldType è 'textfield').
Nome campo data	allfields.datefieldName	string	Etichetta del campo data (applicabile quando fieldType è 'datefield').
Formato data	allfields.dateFormat	string	Formato di data utilizzato da questo campo (ad esempio, MM/GG/AAAA) (applicabile quando fieldType è 'datefield').
Nome casella di controllo	allfields.cbname	string	Etichetta del campo della casella di controllo (applicabile quando fieldType è 'checkboxfield').
Casella di controllo Gruppo	allfields.cbgroup	string	Nome del gruppo per questa casella di controllo (applicabile quando fieldType è 'checkboxfield').
Verificato	allfields.checked	boolean	Indica se la casella di controllo è selezionata per impostazione predefinita (applicabile quando fieldType è 'checkboxfield').
Nome campo protetto	allfields.securedfieldName	string	Etichetta del campo protetto (applicabile quando fieldType è 'securedfield').
Caratteri da visualizzare	allfields.charToDisplay	integer	Numero di caratteri non mascherati da visualizzare alla fine di un valore di campo protetto (applicabile quando fieldType è 'securedfield').
ID firma	allfields.signatureId	string	ID della firma applicata a questo campo di firma (applicabile quando fieldType è 'signfield').
Immagine iniziale	allfields.initialImage	string	Dati dell'immagine per le iniziali applicate a questo campo (applicabile quando fieldType è 'initialfield').
Nome campo allegato	allfields.attachmentfieldName	string	Nome del campo allegato (applicabile quando fieldType è 'attachmentfield').
Descrizione allegato	allfields.attachmentfieldDescription	string	Descrizione di cosa allegare (applicabile quando fieldType è 'attachmentfield').

Elencare tutti i canali webhook

ID operazione:: ListallWebhookChannels

Restituisce un elenco di tutti i canali webhook configurati nell'account.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
Totale canali	total_channel	integer	Numero totale di canali webhook configurati nell'account.
Canali webhook	templatesList	array of object	Elenco di tutti i canali webhook nell'account.
ID canale	templatesList.channelId	integer	Identificatore univoco del canale webhook.
ID aziendale	templatesList.companyId	integer	L'account aziendale a cui appartiene questo canale.
Nome canale	templatesList.channelName	string	Nome del canale webhook.
URL del Webhook	templatesList.webhookUrl	string	L'URL che Foxit eSign chiamerà quando si verifica un evento sottoscritto.
Segreto webhook	templatesList.webhookSecret	string	Chiave privata usata per verificare i payload del webhook.
Data di creazione	templatesList.dateCreated	integer	Data di creazione del canale, in millisecondi Unix.
Data aggiornamento	templatesList.dateUpdated	integer	Data dell'ultimo aggiornamento del canale, in millisecondi Unix.
Livello webhook	templatesList.webhookLevel	string	Ambito del canale webhook. "Account" (trigger per tutte le buste) o "App per le API" (trigger solo per le buste create tramite l'API).
Condizione	templatesList.status	string	Stato corrente del canale. 'active' o 'deactive'.
Busta inviata	templatesList.eventsSubscribedMap.folder_sent	boolean	Attiva quando una busta viene inviata ai destinatari.
Busta visualizzata	templatesList.eventsSubscribedMap.folder_viewed	boolean	Attiva quando una busta viene aperta da un destinatario.
Busta firmata	templatesList.eventsSubscribedMap.folder_signed	boolean	Attiva quando una busta è firmata da un destinatario.
Busta annullata	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Si attiva quando una busta viene annullata.
Busta eseguita	templatesList.eventsSubscribedMap.folder_executed	boolean	Trigger quando tutte le parti hanno firmato e la busta viene eseguita completamente.
Busta eliminata	templatesList.eventsSubscribedMap.folder_deleted	boolean	Attiva quando viene eliminata una busta.

Elimina buste

ID operazione:: DeleteEnvelopes

Elimina definitivamente una o più buste.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cartella	folderIds	True	array of integer	Matrice di ID busta su cui agire.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se l'operazione è riuscita.

Get Envelope Activity History

ID operazione:: GetEnvelopeActivityHistory

Recupera un log attività completo per una busta, che mostra tutte le azioni eseguite dai destinatari e dal mittente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	folderId	True	integer	Identificatore univoco della busta di cui si desidera recuperare la cronologia attività.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
ID busta	details.folderId	integer	Identificatore univoco della busta.
Documenti racchiusi	details.enclosedDocuments	string	Nome dei documenti racchiusi nella busta.
Destinatari	details.envelopeRecipients	string	Nomi di tutti i destinatari nella busta.
Autore	details.author	string	Nome dell'utente che ha creato la busta.
Condizione	details.status	string	Stato corrente della busta (ad esempio, SHARED, EXECUTED, CANCELLED).
Data attività più recente	details.latestActivityDate	string	Data e ora dell'attività più recente nella busta.
Data di creazione	details.dateCreated	string	Data e ora di creazione della busta.
Data invio	details.dateSent	string	Data e ora di invio della busta ai destinatari.
Activities	details.activities	array of object	Elenco cronologico di tutte le azioni eseguite sulla busta.
Activity	details.activities.activity	string	Descrizione leggibile dell'azione che si è verificata.
Action	details.activities.action	string	Tipo di azione eseguita, ad esempio Created, Invitation Sent, Opened, Viewed, Signed.
User	details.activities.user	string	Nome dell'utente che ha eseguito l'azione.
Stato busta	details.activities.folderStatus	string	Stato della busta al momento in cui si è verificata l'azione.
Time	details.activities.time	string	Data e ora in cui si è verificata l'azione.
Source	details.activities.source	string	Origine da cui è stata eseguita l'azione (ad esempio, Web).
Indirizzo IP	details.activities.ipAddress	string	Indirizzo IP da cui è stata eseguita l'azione, se disponibile.

Invia promemoria firma

ID operazione:: SendSignatureReminder

Invia una notifica di promemoria ai destinatari in sospeso di una busta, chiedendo loro di completare la firma.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	folderId	True	integer	ID della busta.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
ID busta	reminder sent	integer	ID della busta per cui è stato inviato il promemoria.

Ottenere gli ID busta

ID operazione:: GetEnvelopeIds

Restituisce un elenco di ID busta filtrati in base allo stato. Utilizzare questa opzione per trovare buste in uno stato specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Data da	dateFrom	True	string	Inizio dell'intervallo di date di creazione busta. Formato accettato: AAAA-MM-GG.
Data a	dateTo	True	string	Fine dell'intervallo di date di creazione busta. Formato accettato: AAAA-MM-GG. Il valore dateTo deve essere compreso tra 6 mesi del valore dateFrom.
Condizione	status		string	Filtra le buste in base allo stato. Valori accettati: EXECUTED, SHARED, DRAFT, PARTIALLY SIGNED, CANCELLED, EXPIRED, DELETED. Se omesso, vengono restituite buste con qualsiasi stato.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
Message	message	string	Messaggio di riepilogo che indica il numero di ID busta restituiti.
ID busta	allFolderIds	array of integer	Elenco di ID busta corrispondenti ai criteri di filtro. Usa questi ID con Recupera dettagli busta per recuperare informazioni complete sulla busta.

Ottenere i dettagli del canale webhook

ID operazione:: GetWebhookChannelDetails

Recupera i dettagli di un canale webhook specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID canale	channelId	True	string	Identificatore univoco del canale webhook da recuperare.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
ID	channel.channelId	integer	Identificatore univoco del canale webhook.
ID aziendale	channel.companyId	integer	L'account aziendale a cui appartiene questo canale.
Name	channel.channelName	string	Nome del canale webhook.
URL del Webhook	channel.webhookUrl	string	L'URL che Foxit eSign chiamerà quando si verifica un evento sottoscritto.
Segreto webhook	channel.webhookSecret	string	Chiave privata usata per verificare i payload del webhook.
Data di creazione	channel.dateCreated	integer	Data di creazione del canale, in millisecondi Unix.
Data aggiornamento	channel.dateUpdated	integer	Data dell'ultimo aggiornamento del canale, in millisecondi Unix.
Livello webhook	channel.webhookLevel	string	Ambito del canale webhook. "Account" (trigger per tutte le buste) o "App per le API" (trigger solo per le buste create tramite l'API).
Condizione	channel.status	string	Stato corrente del canale. 'active' o 'deactive'.
Busta inviata	channel.eventsSubscribedMap.folder_sent	boolean	Attiva quando una busta viene inviata ai destinatari.
Busta visualizzata	channel.eventsSubscribedMap.folder_viewed	boolean	Attiva quando una busta viene aperta da un destinatario.
Busta firmata	channel.eventsSubscribedMap.folder_signed	boolean	Attiva quando una busta è firmata da un destinatario.
Busta annullata	channel.eventsSubscribedMap.folder_cancelled	boolean	Si attiva quando una busta viene annullata.
Busta eseguita	channel.eventsSubscribedMap.folder_executed	boolean	Trigger quando tutte le parti hanno firmato e la busta viene eseguita completamente.
Busta eliminata	channel.eventsSubscribedMap.folder_deleted	boolean	Attiva quando viene eliminata una busta.

Ottenere i dettagli del gruppo di posta elettronica

ID operazione:: GetEmailGroupDetails

Recupera i dettagli di un gruppo di posta elettronica esistente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nomi dei gruppi di posta elettronica	emailGroupNames	True	array of string	Matrice di nomi di gruppi di posta elettronica usati per identificare i gruppi.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Gruppi di posta elettronica	allEmailGroups	array of object	Elenco di gruppi di posta elettronica corrispondenti ai nomi dei gruppi richiesti.
ID del Gruppo	allEmailGroups.groupId	integer	Identificatore univoco del gruppo di posta elettronica.
Nome del gruppo	allEmailGroups.groupName	string	Nome del gruppo di posta elettronica.
Descrizione gruppo	allEmailGroups.groupDesc	string	Descrizione del gruppo di posta elettronica.
Data di creazione	allEmailGroups.dateCreated	integer	Data di creazione del gruppo di posta elettronica, in millisecondi Unix.
ID aziendale	allEmailGroups.companyId	integer	L'account aziendale a cui appartiene questo gruppo di posta elettronica.
Parties	allEmailGroups.parties	array of object	Elenco dei destinatari in questo gruppo di posta elettronica.
Nome di battesimo	allEmailGroups.parties.firstName	string	Nome del destinatario.
Cognome	allEmailGroups.parties.lastName	string	Cognome del destinatario.
Email	allEmailGroups.parties.emailId	string	Indirizzo di posta elettronica del destinatario.

Ottenere i dettagli del modello

ID operazione:: GetTemplateDetails

Recupera i dettagli completi di un modello specifico, inclusi i relativi campi e destinatari.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID modello	templateId	True	string	Identificatore univoco del modello da recuperare.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
ID	template.templateId	integer	Identificatore univoco del modello.
Name	template.templateName	string	Nome del modello.
Description	template.templateDesc	string	Descrizione del modello.
Tipo	template.templateType	string	Tipo del modello.
Data di creazione	template.templateCreationDate	integer	Data di creazione del modello, in millisecondi Unix.
Data ultimo aggiornamento	template.templateLastUpdateDate	integer	Data dell'ultimo aggiornamento del modello, in millisecondi Unix.
Modificabile	template.editable	boolean	Indica se il modello può essere modificato.
Numero di parti	template.numberOfParties	integer	Numero di parti di firma definite nel modello.
Totale pagine	template.totalPages	integer	Numero totale di pagine nel documento modello.
ID aziendale	template.companyId	integer	L'account aziendale a cui appartiene il modello.
Condividi con tutti	template.shareAll	boolean	Indica se il modello è condiviso con tutti gli utenti nell'account.
Modello di nome personalizzato	template.templateCustomName	string	Modello di nome personalizzato applicato alle buste create da questo modello.
Autorizzazioni di entità	template.templatePartyPermissions	array of object	Elenco dei ruoli del destinatario e delle relative autorizzazioni di firma definite in questo modello.
ID parte	template.templatePartyPermissions.template_party_id	integer	ID univoco di questa voce di entità del modello.
ID	template.templatePartyPermissions.templateId	integer	ID del modello a cui appartiene questa entità.
Autorizzazioni	template.templatePartyPermissions.templatePermissions	string	Autorizzazioni di firma per questa entità, ad esempio FILL_FIELDS_AND_SIGN.
Ordine di firma	template.templatePartyPermissions.partySequence	integer	Posizione dell'ordine di firma per questa parte.
Ruolo di entità	template.templatePartyPermissions.templatePartyRole	string	Nome del ruolo assegnato a questa entità. Usare questo valore quando si crea una busta da questo modello.
ID parte	template.templatePartyPermissions.partyId	integer	ID della parte assegnata a questo ruolo, se pre-assegnata.
ID parte	template.templateCreatedBy.partyId	integer	Identificatore univoco dell'utente.
Nome di battesimo	template.templateCreatedBy.firstName	string	Nome dell'utente.
Cognome	template.templateCreatedBy.lastName	string	Cognome dell'utente.
Email	template.templateCreatedBy.emailId	string	Indirizzo di posta elettronica dell'utente.
Dipartimento	template.templateCreatedBy.department	string	Reparto dell'utente.
Titolo	template.templateCreatedBy.title	string	Titolo del lavoro dell'utente.
Active	template.templateCreatedBy.active	boolean	Indica se l'account utente è attivo.
ID parte	template.templateLastUpdatedBy.partyId	integer	Identificatore univoco dell'utente.
Nome di battesimo	template.templateLastUpdatedBy.firstName	string	Nome dell'utente.
Cognome	template.templateLastUpdatedBy.lastName	string	Cognome dell'utente.
Email	template.templateLastUpdatedBy.emailId	string	Indirizzo di posta elettronica dell'utente.
Dipartimento	template.templateLastUpdatedBy.department	string	Reparto dell'utente.
Titolo	template.templateLastUpdatedBy.title	string	Titolo del lavoro dell'utente.
Active	template.templateLastUpdatedBy.active	boolean	Indica se l'account utente è attivo.
Tutti i campi	allfields	array of object	Elenco di tutti i campi definiti in questo modello.
ID tag campo	allfields.fieldTagId	integer	Identificatore univoco del campo.
ID modello	allfields.templateId	integer	ID del modello a cui appartiene questo campo.
ID aziendale	allfields.companyId	integer	L'account aziendale a cui appartiene questo campo.
Tipo di campo	allfields.fieldType	string	Tipo del campo (ad esempio, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numero pagina	allfields.documentPageNumber	integer	Numero di pagina del documento in cui è posizionato questo campo.
Responsabile dell'entità	allfields.partyResponsible	integer	Numero di sequenza di entità responsabile del completamento di questo campo.
Sequenza di entità	allfields.partyResponsibleSequence	integer	Posizione della sequenza della parte responsabile.
ID campo doc	allfields.docFieldId	string	Identificatore di questo campo all'interno del documento.
Dipendente	allfields.dependent	boolean	Indica se la visibilità di questo campo dipende dal valore di un altro campo.
Ordine di tabulazioni	allfields.tabOrder	integer	Ordine di tabulazioni per lo spostamento tra i campi.
Obbligatorio	allfields.required	boolean	Indica se questo campo deve essere completato prima che il documento possa essere firmato.
Nome campo personalizzato	allfields.customFieldName	string	Nome personalizzato assegnato a questo campo.
Condividi tutto	allfields.shareAll	boolean	Indica se questo campo è condiviso con tutti gli utenti.
Consenti modifica	allfields.allowEdit	boolean	Indica se questo campo può essere modificato dal destinatario.
Nome campo testo	allfields.textfieldName	string	Etichetta del campo di testo (applicabile quando fieldType è 'textfield').
Value	allfields.value	string	Valore precompilato o immesso del campo.
Dimensioni carattere	allfields.fontSize	integer	Dimensione del carattere utilizzata per il testo in questo campo.
Colore carattere	allfields.fontColor	string	Colore del carattere utilizzato per il testo in questo campo (ad esempio, #000000).
Sola lettura	allfields.readOnly	boolean	Indica se il campo è di sola lettura e non può essere modificato dal destinatario.
Multilinea	allfields.multiLine	boolean	Indica se il campo di testo accetta più righe di input (applicabile quando fieldType è 'textfield').
Limite di caratteri	allfields.characterLimit	integer	Numero massimo di caratteri consentiti nel campo (applicabile quando fieldType è 'textfield').
Nome campo data	allfields.datefieldName	string	Etichetta del campo data (applicabile quando fieldType è 'datefield').
Formato data	allfields.dateFormat	string	Formato di data utilizzato da questo campo (ad esempio, MM/GG/AAAA) (applicabile quando fieldType è 'datefield').
Nome casella di controllo	allfields.cbname	string	Etichetta del campo della casella di controllo (applicabile quando fieldType è 'checkboxfield').
Casella di controllo Gruppo	allfields.cbgroup	string	Il nome del gruppo per questa casella di controllo, utilizzato quando vengono collegate più caselle di controllo (applicabile quando fieldType è "checkboxfield").
Verificato	allfields.checked	boolean	Indica se la casella di controllo è selezionata per impostazione predefinita (applicabile quando fieldType è 'checkboxfield').
Nome campo protetto	allfields.securedfieldName	string	Etichetta del campo protetto (applicabile quando fieldType è 'securedfield').
Caratteri da visualizzare	allfields.charToDisplay	integer	Numero di caratteri non mascherati da visualizzare alla fine di un valore di campo protetto (applicabile quando fieldType è 'securedfield').
ID firma	allfields.signatureId	string	ID della firma applicata a questo campo di firma (applicabile quando fieldType è 'signfield').
Immagine iniziale	allfields.initialImage	string	Dati dell'immagine per le iniziali applicate a questo campo (applicabile quando fieldType è 'initialfield').
Nome campo allegato	allfields.attachmentfieldName	string	Nome del campo allegato (applicabile quando fieldType è 'attachmentfield').
Descrizione allegato	allfields.attachmentfieldDescription	string	Descrizione di cosa allegare (applicabile quando fieldType è 'attachmentfield').

Ottenere i dettagli della busta

ID operazione:: GetEnvelopeDetails

Recupera i dettagli completi di una busta, inclusi lo stato, i destinatari e i documenti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	folderId	True	integer	Identificatore univoco della busta da recuperare.
Token di accesso	access_token		string	Token di accesso OAuth 2.0 per l'autenticazione.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se l'operazione ha avuto esito positivo, ad esempio "operazione riuscita".
ID	folder.folderId	integer	ID univoco della busta.
Name	folder.folderName	string	Nome della busta.
ID autore	folder.folderAuthorId	integer	ID univoco dell'utente che ha creato la busta.
Nome autore	folder.folderAuthorFirstName	string	Nome dell'autore della busta.
Cognome autore	folder.folderAuthorLastName	string	Cognome dell'autore della busta.
Autore Email	folder.folderAuthorEmail	string	Indirizzo di posta elettronica dell'autore della busta.
Ruolo autore	folder.folderAuthorRole	string	Ruolo dell'account dell'autore della busta.
ID aziendale	folder.folderCompanyId	integer	ID univoco della società a cui appartiene la busta.
Data di creazione	folder.folderCreationDate	integer	Data e ora di creazione della busta, in millisecondi Unix.
Data di invio	folder.folderSentDate	integer	Data e ora di invio della busta ai destinatari, in millisecondi Unix. Null se non è ancora stato inviato.
Condizione	folder.folderStatus	string	Stato corrente della busta ,ad esempio SHARED, EXECUTED, DRAFT, CANCELLED.
ID dei documenti	folder.folderDocumentIds	array of integer	Elenco di ID documento inclusi in questa busta.
Documents	folder.documentsList	array of object	Dettagli di ogni documento incluso nella busta.
ID documento	folder.documentsList.documentId	integer	Identificatore univoco del documento.
ID contratto	folder.documentsList.contractId	integer	Identificatore univoco del contratto associato a questo documento.
ID aziendale	folder.documentsList.companyId	integer	ID univoco della società a cui appartiene questo documento.
Creato da	folder.documentsList.contractCreatedBy	integer	ID utente della persona che ha creato il contratto.
Data di creazione	folder.documentsList.contractCreatedOn	integer	Data di creazione del contratto, in millisecondi Unix.
Tipo di contratto	folder.documentsList.contractType	string	Tipo o categoria del contratto.
Stato documento	folder.documentsList.contractStatus	string	Stato di firma corrente del documento (ad esempio, WAITING_FOR_SIGNATURE, EXECUTED).
Modificabile	folder.documentsList.editable	boolean	Indica se il documento può essere modificato.
ID versione	folder.documentsList.contractVersionId	integer	ID univoco della versione corrente del documento.
Nome versione	folder.documentsList.contractVersionName	string	Nome della versione corrente del documento.
Descrizione della versione	folder.documentsList.contractVersionDesc	string	Descrizione della versione corrente del documento.
Versione creata da	folder.documentsList.versionCreatedby	integer	ID utente della persona che ha creato la versione del documento.
Versione creata in	folder.documentsList.versionCreatedOn	integer	Data di creazione della versione del documento, espressa in millisecondi Unix.
Numero di versione	folder.documentsList.contractVersionNumber	integer	Numero di versione del documento.
Destinatari	folder.folderRecipientParties	array of object	Elenco dei destinatari per questa busta, inclusi lo stato di firma e i collegamenti di accesso.
ID destinatario	folder.folderRecipientParties.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	folder.folderRecipientParties.partyDetails.partyId	integer	Identificatore univoco del destinatario.
Nome di battesimo	folder.folderRecipientParties.partyDetails.firstName	string	Nome del destinatario.
Cognome	folder.folderRecipientParties.partyDetails.lastName	string	Cognome del destinatario.
Email	folder.folderRecipientParties.partyDetails.emailId	string	Indirizzo e-mail del destinatario.
Address	folder.folderRecipientParties.partyDetails.address	string	Indirizzo del destinatario.
Data creazione account	folder.folderRecipientParties.partyDetails.dateCreated	integer	Data di creazione dell'account del destinatario, in millisecondi Unix.
Autorizzazioni	folder.folderRecipientParties.contractPermissions	string	Autorizzazioni di firma concesse al destinatario, ad esempio FILL_FIELDS_AND_SIGN.
Ordine di firma	folder.folderRecipientParties.partySequence	integer	Posizione del destinatario nell'ordine di firma.
Sequenza flusso di lavoro	folder.folderRecipientParties.workflowSignSequence	integer	Numero di sequenza di firma del flusso di lavoro per questo destinatario.
ID busta	folder.folderRecipientParties.envelopeId	integer	ID della busta a cui appartiene il destinatario.
Modalità condivisione	folder.folderRecipientParties.sharingMode	string	Metodo utilizzato per condividere il documento con questo destinatario (ad esempio, posta elettronica).
URL di firma	folder.folderRecipientParties.folderAccessURL	string	URL di firma univoco per questo destinatario. Null se la busta è già stata completata o annullata.
Modalità di sicurezza	folder.folderRecipientParties.securityMode	string	Modalità di sicurezza applicata all'accesso del destinatario.
Commenti aggiuntivi	folder.folderRecipientParties.extraComments	string	Eventuali commenti aggiuntivi inclusi nell'invito alla firma per il destinatario.
URL di accesso autore	folder.folderAccessURLForAuthor	string	URL dell'autore della busta per accedere al documento. Null se non applicabile.
Bulk ID	folder.bulkId	integer	ID del batch di invio bulk a cui appartiene questa busta, se presente.
Imponi ordine di firma	folder.enforceSignWorkflow	boolean	Indica se i destinatari devono accedere all'ordine specificato.
Passaggio flusso di lavoro corrente	folder.currentWorkflowStep	integer	Passaggio corrente nel flusso di lavoro di firma.
Origine transazione	folder.transactionSource	string	Origine che ha avviato questa transazione envelope.
Modificabile	folder.editable	boolean	Indica se è ancora possibile modificare la busta.
firma In-Person	folder.inPersonSignable	boolean	Indica se la busta può essere firmata di persona.
Eseguire l'override dei promemoria	folder.overrideAccountReminders	boolean	Indica se le impostazioni del promemoria a livello di account vengono sostituite per questa busta.
ID	folder.envelopeId	integer	ID univoco della busta. Stesso valore dell'ID busta (folderId).
Name	folder.envelopeName	string	Nome della busta. Stesso valore di Envelope Name (folderName).
ID origine	folder.envelopeOriginatorId	integer	ID utente della persona che ha creato la busta.
ID aziendale	folder.envelopeCompanyId	integer	ID della società a cui appartiene la busta.
Date	folder.envelopeDate	integer	Data e ora di creazione della busta, in millisecondi Unix.
Data condivisa	folder.envelopeSharedDate	integer	La data e l'ora in cui la busta è stata condivisa con i destinatari, in millisecondi Unix. Null se non è ancora stato condiviso.
Condizione	folder.envelopeStatus	string	Stato corrente della busta. Stesso valore di Stato busta (folderStatus).
ID contratto	folder.envelopeContractIds	array of integer	Elenco di ID contratto associati a questa busta.
Autorizzazioni di entità	folder.envelopePartyPermissions	array of object	Elenco dei destinatari e delle relative autorizzazioni di firma. Stessa struttura di Recipients.
ID destinatario	folder.envelopePartyPermissions.partyId	integer	Identificatore univoco del destinatario.
Nome di battesimo	folder.envelopePartyPermissions.partyDetails.firstName	string	Nome del destinatario.
Cognome	folder.envelopePartyPermissions.partyDetails.lastName	string	Cognome del destinatario.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	Indirizzo e-mail del destinatario.
Autorizzazioni	folder.envelopePartyPermissions.contractPermissions	string	Autorizzazioni di firma per questo destinatario.
Ordine di firma	folder.envelopePartyPermissions.partySequence	integer	Posizione del destinatario nell'ordine di firma.
URL di firma	folder.envelopePartyPermissions.folderAccessURL	string	URL di firma univoco per questo destinatario.
Tutti i campi	allFields	array of object	Elenco di tutti i campi di firma e modulo inseriti nei documenti della busta.
ID campo	allFields.fieldTagId	integer	Identificatore univoco del campo.
ID documento	allFields.contractId	integer	ID del documento a cui appartiene questo campo.
ID versione	allFields.versionId	integer	ID versione del documento a cui appartiene questo campo.
Tipo di campo	allFields.fieldType	string	Tipo del campo (ad esempio, signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
Numero pagina	allFields.documentPageNumber	integer	Numero di pagina in cui si trova questo campo.
ID documento campo	allFields.docFieldId	string	Identificatore a livello di documento per questo campo.
Parte responsabile	allFields.partyResponsible	integer	ID dell'entità responsabile della compilazione di questo campo.
Dipende	allFields.dependent	boolean	Indica se la visibilità di questo campo dipende dal valore di un altro campo.
Obbligatorio	allFields.required	boolean	Indica se questo campo deve essere compilato prima che il documento possa essere inviato.
Valore del campo	allFields.value	string	Valore corrente del campo, se compilato.
Valori dei campi	allFieldsNameValue	array of object	Elenco semplificato di tutti i nomi di campo e dei relativi valori correnti. Utilizzare questa opzione per leggere i dati dei campi compilati da una busta firmata.
ID campo	allFieldsNameValue.fieldId	integer	Identificatore univoco del campo.
ID documento	allFieldsNameValue.documentId	integer	ID del documento a cui appartiene questo campo.
ID versione	allFieldsNameValue.documentVersionId	integer	ID versione del documento a cui appartiene questo campo.
Tipo di campo	allFieldsNameValue.fieldType	string	Tipo del campo ,ad esempio textfield, signfield, datefield, checkboxfield, dropdownfield.
Nome campo	allFieldsNameValue.name	string	Etichetta o nome del campo come definito nel modello.
Valore del campo	allFieldsNameValue.value	string	Valore immesso o selezionato per questo campo.
Cronologia busta	Folder History	array of object	Il audit trail di tutte le azioni eseguite su questa busta, in ordine cronologico.
Nome di battesimo	Folder History.firstName	string	Nome della persona che ha eseguito l'azione.
Cognome	Folder History.lastName	string	Cognome della persona che ha eseguito l'azione.
Email	Folder History.email	string	Indirizzo di posta elettronica della persona che ha eseguito l'azione.
ID busta	Folder History.envelopeId	integer	ID della busta in cui è stata eseguita l'azione.
Date	Folder History.dateChanged	integer	Data e ora in cui si è verificata l'azione, in millisecondi Unix.
ID parte	Folder History.changeDoneByParty	integer	ID entità della persona che ha eseguito l'azione.
Action	Folder History.action	string	Azione eseguita sulla busta (ad esempio, Created, InviteSentTo, InviteAccepted, Signed, Executed).

Ottenere la cronologia busta eliminata

ID operazione:: GetDeletedEnvelopeHistory

Recupera una cronologia delle buste eliminate o spostate nel Cestino.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	folderId	True	string	Identificatore univoco della busta di cui si desidera recuperare la cronologia di eliminazione.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
Informazioni sulla busta eliminata	Deleted Folder Log Info	array of object	Informazioni di riepilogo sulla busta eliminata.
ID busta	Deleted Folder Log Info.folderId	integer	Identificatore univoco della busta eliminata.
Nome busta	Deleted Folder Log Info.folderName	string	Nome della busta eliminata.
Nome documento	Deleted Folder Log Info.documentName	string	Nome del documento nella busta eliminata.
ID documento	Deleted Folder Log Info.documentId	string	Identificatore univoco del documento nella busta eliminata.
Data eliminazione	Deleted Folder Log Info.deletionDate	integer	Data e ora di eliminazione della busta, espressa in millisecondi Unix.
Eliminato da	Deleted Folder Log Info.deletedBy	string	Nome dell'utente che ha eliminato la busta.
Cronologia log di eliminazione	Deleted Folder Log History	array of object	Log dettagliato di tutte le azioni di eliminazione eseguite sulla busta.
Eseguito da	Deleted Folder Log History.partiesName	string	Nome dell'utente che ha eseguito il passaggio di eliminazione.
Source	Deleted Folder Log History.source	string	Origine da cui è stata avviata l'eliminazione ,ad esempio Web, API.
Event	Deleted Folder Log History.event	string	Azione di eliminazione specifica eseguita, ad esempio Elimina cartella, Elimina tutte le parti dalla cartella.

Ottenere modelli in base agli ID modello

ID operazione:: GetTemplatesbyTemplateIds

Recupera i dettagli per uno o più modelli in base ai relativi ID.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID modello	templateIds	True	array of integer	Matrice di ID modello da recuperare.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
Totale modelli	total_templates	integer	Numero totale di modelli restituiti.
Elenco modelli	templateIdList	object	Mappa dei dati del modello con chiave in base all'ID modello. Ogni voce contiene i dettagli del modello e i relativi campi.

Ottenere un elenco di tutti i modelli

ID operazione:: GetalistofallTemplates

Restituisce un elenco di tutti i modelli disponibili nell'account.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se la richiesta ha avuto esito positivo.
Totale modelli	total_templates	integer	Numero totale di modelli nell'account.
Elenco modelli	templatesList	array of object	Elenco di tutti i modelli disponibili nell'account.
ID modello	templatesList.templateId	integer	Identificatore univoco del modello. Usare questo ID con Crea busta da modello per inviare il modello per la firma.
Nome del modello	templatesList.templateName	string	Nome del modello.
Descrizione modello	templatesList.templateDesc	string	Descrizione del modello.
Tipo di modello	templatesList.templateType	string	Tipo o categoria del modello.
Data di creazione	templatesList.templateCreationDate	integer	Data di creazione del modello, in millisecondi Unix.
Data ultimo aggiornamento	templatesList.templateLastUpdateDate	integer	Data dell'ultimo aggiornamento del modello, in millisecondi Unix.
Modificabile	templatesList.editable	boolean	Indica se il modello può essere modificato.
Numero di parti	templatesList.numberOfParties	integer	Numero di parti di firma definite nel modello.
ID aziendale	templatesList.companyId	integer	L'account aziendale a cui appartiene il modello.
Condividi con tutti	templatesList.shareAll	boolean	Indica se il modello è condiviso con tutti gli utenti nell'account.
ID parte	templatesList.templateCreatedBy.partyId	integer	Identificatore univoco dell'utente.
Nome di battesimo	templatesList.templateCreatedBy.firstName	string	Nome dell'utente.
Cognome	templatesList.templateCreatedBy.lastName	string	Cognome dell'utente.
Email	templatesList.templateCreatedBy.emailId	string	Indirizzo di posta elettronica dell'utente.
ID parte	templatesList.templateLastUpdatedBy.partyId	integer	Identificatore univoco dell'utente.
Nome di battesimo	templatesList.templateLastUpdatedBy.firstName	string	Nome dell'utente.
Cognome	templatesList.templateLastUpdatedBy.lastName	string	Cognome dell'utente.
Email	templatesList.templateLastUpdatedBy.emailId	string	Indirizzo di posta elettronica dell'utente.

Scarica report

ID operazione:: DownloadReport

Scarica un report attività envelope come file di Microsoft Excel. Usare i filtri per restringere i risultati in base allo stato, all'intervallo di date, al nome della busta, all'autore o al firmatario.

Parametri

Nome	Chiave	Tipo	Descrizione
envelopeStatus	status	string	Gli stati della cartella in base al quale verrà filtrato un report
Data di creazione da	creationDateFrom	string	Inizio dell'intervallo Data di creazione. Formato accettato: AAAA-MM-GG.
Data di creazione a	creationDateTo	string	Fine dell'intervallo data di creazione. Formato accettato: AAAA-MM-GG.
Nome busta	folderName	string	Qualsiasi cartella contenente questa stringa.
Includi campi	includeFields	string	Impostare su "true" per includere i valori dei campi envelope nel report. Il valore predefinito è 'false'.
Autore Email	authorEmail	string	Filtrare il report in modo da includere solo le buste create dall'indirizzo di posta elettronica dell'autore.
Messaggio di posta elettronica del firmatario	signerEmail	string	Filtrare il report in modo da includere solo buste in cui questo indirizzo di posta elettronica è un firmatario.

Valori restituiti

Report File: binary

Scaricare i file envelope

ID operazione:: DownloadEnvelopeFiles

Scarica i documenti completati da una busta come file.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	folderId	True	string	Identificatore univoco della busta di cui si desidera scaricare i documenti.

Valori restituiti

response: binary

Scaricare un singolo documento PDF

ID operazione:: DownloadSingleDocumentPDF

Scarica un singolo documento da una busta come file PDF.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	folderId	True	string	Identificatore univoco della busta contenente il documento da scaricare.
Numero documento	docNumber	True	string	Indice del documento da scaricare, a partire da 1.

Valori restituiti

response: binary

Spostare buste nel Cestino

ID operazione:: MoveEnvelopestoRecycleBin

Sposta una o più buste nel Cestino. Le buste nel Cestino non vengono eliminate definitivamente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID cartella	folderIds	True	array of integer	Matrice di ID busta su cui agire.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Result	result	string	Indica se l'operazione è riuscita.

Trigger

Quando una busta viene annullata	Attiva quando una busta viene annullata da un destinatario o dal mittente.
Quando una busta viene eseguita completamente	Attiva quando tutti i destinatari hanno firmato e la busta viene eseguita completamente.
Quando una busta è firmata	Si attiva quando un destinatario firma la busta.
Quando viene eliminata una busta	Attiva quando viene eliminata una busta.
Quando viene inviata una busta	Attiva quando una busta viene inviata ai destinatari. Questo evento viene generato solo quando il livello del webhook è impostato su "Account".
Quando viene visualizzata una busta	Si attiva quando un destinatario apre e visualizza la busta.

Quando una busta viene annullata

ID operazione:: TriggerEnvelopeCancelled

Attiva quando una busta viene annullata da un destinatario o dal mittente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome canale	channelName	True	string	Nome per identificare questa sottoscrizione webhook nell'account.
Livello webhook	webhookLevel	True	string	Account: viene attivato per tutte le buste (Web e API). App per le API: viene attivata solo per le buste create tramite l'API.
Segreto webhook	webhookSecret		string	Facoltativo. Foxit eSign firma ogni payload del webhook con HMAC-SHA-256 usando questo segreto per la verifica.

Valori restituiti

I dati dell'evento ricevuti da Foxit eSign quando viene generato un evento webhook.

WebhookEventPayload: WebhookEventPayload

Quando una busta viene eseguita completamente

ID operazione:: TriggerEnvelopeExecuted

Attiva quando tutti i destinatari hanno firmato e la busta viene eseguita completamente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome canale	channelName	True	string	Nome per identificare questa sottoscrizione webhook nell'account.
Livello webhook	webhookLevel	True	string	Account: viene attivato per tutte le buste (Web e API). App per le API: viene attivata solo per le buste create tramite l'API.
Segreto webhook	webhookSecret		string	Facoltativo. Foxit eSign firma ogni payload del webhook con HMAC-SHA-256 usando questo segreto per la verifica.

Valori restituiti

I dati dell'evento ricevuti da Foxit eSign quando viene generato un evento webhook.

WebhookEventPayload: WebhookEventPayload

Quando una busta è firmata

ID operazione:: TriggerEnvelopeSigned

Si attiva quando un destinatario firma la busta.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome canale	channelName	True	string	Nome per identificare questa sottoscrizione webhook nell'account.
Livello webhook	webhookLevel	True	string	Account: viene attivato per tutte le buste (Web e API). App per le API: viene attivata solo per le buste create tramite l'API.
Segreto webhook	webhookSecret		string	Facoltativo. Foxit eSign firma ogni payload del webhook con HMAC-SHA-256 usando questo segreto per la verifica.

Valori restituiti

I dati dell'evento ricevuti da Foxit eSign quando viene generato un evento webhook.

WebhookEventPayload: WebhookEventPayload

Quando viene eliminata una busta

ID operazione:: TriggerEnvelopeDeleted

Attiva quando viene eliminata una busta.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome canale	channelName	True	string	Nome per identificare questa sottoscrizione webhook nell'account.
Livello webhook	webhookLevel	True	string	Account: viene attivato per tutte le buste (Web e API). App per le API: viene attivata solo per le buste create tramite l'API.
Segreto webhook	webhookSecret		string	Facoltativo. Foxit eSign firma ogni payload del webhook con HMAC-SHA-256 usando questo segreto per la verifica.

Valori restituiti

I dati dell'evento ricevuti da Foxit eSign quando viene generato un evento webhook.

WebhookEventPayload: WebhookEventPayload

Quando viene inviata una busta

ID operazione:: TriggerEnvelopeSent

Attiva quando una busta viene inviata ai destinatari. Questo evento viene generato solo quando il livello del webhook è impostato su "Account".

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome canale	channelName	True	string	Nome per identificare questa sottoscrizione webhook nell'account.
Livello webhook	webhookLevel	True	string	Account: viene attivato per le buste inviate tramite web o API. App per le API: viene attivata solo per le buste create tramite l'API. L'evento folder_sent viene generato solo a livello di account.
Segreto webhook	webhookSecret		string	Facoltativo. Foxit eSign firma ogni payload del webhook con HMAC-SHA-256 usando questo segreto per la verifica.

Valori restituiti

I dati dell'evento ricevuti da Foxit eSign quando viene generato un evento webhook.

WebhookEventPayload: WebhookEventPayload

Quando viene visualizzata una busta

ID operazione:: TriggerEnvelopeViewed

Si attiva quando un destinatario apre e visualizza la busta.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome canale	channelName	True	string	Nome per identificare questa sottoscrizione webhook nell'account.
Livello webhook	webhookLevel	True	string	Account: viene attivato per tutte le buste (Web e API). App per le API: viene attivata solo per le buste create tramite l'API.
Segreto webhook	webhookSecret		string	Facoltativo. Foxit eSign firma ogni payload del webhook con HMAC-SHA-256 usando questo segreto per la verifica.

Valori restituiti

I dati dell'evento ricevuti da Foxit eSign quando viene generato un evento webhook.

WebhookEventPayload: WebhookEventPayload

Definizioni

WebhookEventPayload

I dati dell'evento ricevuti da Foxit eSign quando viene generato un evento webhook.

Nome	Percorso	Tipo	Descrizione
Nome evento	event_name	string	Nome dell'evento generato( ad esempio, folder_sent, folder_signed folder_executed).
Data evento	event_date	integer	Data e ora in cui si è verificato l'evento (timestamp Unix in millisecondi).
ID	data.folder.folderId	integer	ID univoco della busta.
Name	data.folder.folderName	string	Nome della busta.
Nome personalizzato	data.folder.folderCustomName	string	Nome personalizzato assegnato alla busta.
Parola chiave	data.folder.folderPassword	string	Password di accesso per la busta, se impostata.
ID creatore	data.folder.folderAuthorId	integer	ID utente dell'autore della busta.
Nome autore	data.folder.folderAuthorFirstName	string	Nome dell'autore della busta.
Cognome creatore	data.folder.folderAuthorLastName	string	Cognome dell'autore della busta.
Messaggio di posta elettronica creatore	data.folder.folderAuthorEmail	string	Indirizzo di posta elettronica dell'autore della busta.
Ruolo creatore	data.folder.folderAuthorRole	string	Ruolo dell'account dell'autore della busta.
ID aziendale	data.folder.folderCompanyId	integer	ID società proprietario della busta.
Data di creazione	data.folder.folderCreationDate	integer	Data di creazione della busta (timestamp Unix in millisecondi).
Data di invio	data.folder.folderSentDate	integer	Data di invio della busta (timestamp Unix in millisecondi).
Condizione	data.folder.folderStatus	string	Stato corrente della busta.
Campo personalizzato 1	data.folder.custom_field1	string	Primo campo di metadati personalizzato.
Campo personalizzato 2	data.folder.custom_field2	string	Secondo campo di metadati personalizzato.
Metadati	data.folder.metadata	string	Metadati personalizzati associati alla busta.
ID dei documenti	data.folder.folderDocumentIds	array of integer	Elenco di ID documento nella busta.
Documents	data.folder.documentsList	array of object	Elenco di documenti nella busta.
ID documento	data.folder.documentsList.documentId	integer	Identificatore univoco del documento.
ID contratto	data.folder.documentsList.contractId	integer	ID contratto per questo documento.
ID aziendale	data.folder.documentsList.companyId	integer	ID società per questo documento.
Creato da	data.folder.documentsList.contractCreatedBy	integer	ID utente della persona che ha creato il contratto.
Data di creazione	data.folder.documentsList.contractCreatedOn	integer	Data di creazione del contratto (timestamp Unix in millisecondi).
Tipo di contratto	data.folder.documentsList.contractType	string	Tipo del contratto.
Stato contratto	data.folder.documentsList.contractStatus	string	Stato corrente del contratto.
Modificabile	data.folder.documentsList.editable	boolean	Indica se il documento è modificabile.
ID versione	data.folder.documentsList.contractVersionId	integer	ID versione del contratto.
Nome versione	data.folder.documentsList.contractVersionName	string	Nome della versione del contratto.
Descrizione della versione	data.folder.documentsList.contractVersionDesc	string	Descrizione della versione del contratto.
Versione creata da	data.folder.documentsList.versionCreatedby	integer	ID utente della persona che ha creato questa versione.
Versione creata in	data.folder.documentsList.versionCreatedOn	integer	Data di creazione di questa versione (timestamp Unix in millisecondi).
Numero di versione	data.folder.documentsList.contractVersionNumber	integer	Numero di versione del contratto.
Origine transazione	data.folder.documentsList.contractTransactionSource	string	Sistema di origine che ha avviato il contratto.
Destinatari	data.folder.folderRecipientParties	array of object	Elenco di destinatari per la busta.
ID destinatario	data.folder.folderRecipientParties.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	data.folder.folderRecipientParties.partyDetails.partyId	integer	ID univoco del destinatario.
Nome di battesimo	data.folder.folderRecipientParties.partyDetails.firstName	string	Nome del destinatario.
Cognome	data.folder.folderRecipientParties.partyDetails.lastName	string	Cognome del destinatario.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	Indirizzo e-mail del destinatario.
Segnaposto	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Indica se si tratta di un destinatario segnaposto.
Address	data.folder.folderRecipientParties.partyDetails.address	string	Indirizzo del destinatario.
Data di creazione	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	Data di creazione del record del destinatario (timestamp Unix in millisecondi).
Rifiutare esplicitamente i messaggi di posta elettronica	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indica se il destinatario ha rifiutato esplicitamente i messaggi di posta elettronica.
ID univoco	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificatore di sistema univoco per il destinatario.
Livello di autenticazione	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	Metodo di autenticazione per questo destinatario.
Data aggiornamento password	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Data dell'ultimo aggiornamento della password.
Stato password	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indica se la password è stata aggiornata.
Composizione del codice	data.folder.folderRecipientParties.dialingCode	string	Codice di composizione internazionale.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	Numero di cellulare del destinatario.
Tipo di firma	data.folder.folderRecipientParties.signerSignatureType	string	Tipo di firma che verrà usato dal firmatario.
Autorizzazioni	data.folder.folderRecipientParties.contractPermissions	string	Autorizzazioni concesse a questo destinatario.
Ordine di firma	data.folder.folderRecipientParties.partySequence	integer	Ordine di firma per il destinatario.
Sequenza flusso di lavoro	data.folder.folderRecipientParties.workflowSignSequence	integer	Numero di sequenza di firma del flusso di lavoro.
ID busta	data.folder.folderRecipientParties.envelopeId	integer	ID busta associato al destinatario.
ID società destinatario	data.folder.folderRecipientParties.partyCompanyId	integer	ID società del destinatario.
Modalità condivisione	data.folder.folderRecipientParties.sharingMode	string	Modalità di condivisione per il destinatario.
URL di firma del destinatario	data.folder.folderRecipientParties.folderAccessURL	string	URL del destinatario per accedere e firmare la busta.
Modalità di sicurezza	data.folder.folderRecipientParties.securityMode	string	Modalità di sicurezza per questo destinatario.
Comments	data.folder.folderRecipientParties.extraComments	string	Commenti aggiuntivi per il destinatario.
Consenti modifica nome	data.folder.folderRecipientParties.allowNameChange	boolean	Indica se il destinatario può aggiornare il nome.
Nome aggiornato	data.folder.folderRecipientParties.signerNameUpdated	boolean	Indica se il firmatario ha aggiornato il nome.
Livello di autenticazione del firmatario	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Livello di autenticazione necessario per il firmatario.
Codice di accesso	data.folder.folderRecipientParties.userDefinedAccessCode	string	Codice di accesso personalizzato per il firmatario.
ID firma	data.folder.folderRecipientParties.signatureId	string	ID della firma applicata.
Ruolo	data.folder.folderRecipientParties.partyRole	string	Ruolo di questo destinatario nel flusso di lavoro di firma.
Campo società	data.folder.folderRecipientParties.companyFieldValue	string	Valore del campo nome società.
Campo titolo	data.folder.folderRecipientParties.titleFieldValue	string	Valore del campo titolo.
Motivo della firma	data.folder.folderRecipientParties.reasonSigning	string	Motivo della firma.
Campo pagamento aggiunto	data.folder.folderRecipientParties.payFieldAdded	boolean	Indica se è stato aggiunto un campo di pagamento.
Beneficiario	data.folder.folderRecipientParties.payee	boolean	Indica se il destinatario è l'utente a pagamento.
Pagamento ricorrente	data.folder.folderRecipientParties.recurringFieldExist	boolean	Indica se esiste un campo di pagamento ricorrente.
Stampa e firma fine	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Indica se la stampa e il segno sono stati completati.
Firmatario facoltativo	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Indica se il destinatario è un firmatario facoltativo.
Firmatari facoltativi	data.folder.folderRecipientParties.optionalSigners	array of integer	ID di entità di firma facoltativi.
Pagato	data.folder.folderRecipientParties.paid	boolean	Indica se il pagamento è stato completato.
URL di accesso autore	data.folder.folderAccessURLForAuthor	string	URL dell'autore della busta per accedere alla busta.
Draft Access URL	data.folder.draftFolderAccessURL	string	URL per accedere alla busta in stato bozza.
Firma boardroom	data.folder.boardRoomSign	boolean	Indica se la modalità di firma della sala riunioni è abilitata.
Includi logo	data.folder.includeLogo	boolean	Indica se il logo aziendale è incluso nei messaggi di posta elettronica.
Colore sfondo pulsante	data.folder.email_btnBgColor	string	Colore di sfondo del pulsante azione di posta elettronica.
Colore testo pulsante	data.folder.email_btnTxtColor	string	Colore del testo del pulsante azione di posta elettronica.
Logo e-mail	data.folder.emailTemplateLogo	string	URL del logo usato nel modello di posta elettronica.
ID modello di posta elettronica	data.folder.emailTemplateId	integer	ID del modello di posta elettronica usato.
Intestazione posta elettronica	data.folder.emailHeader	string	Testo dell'intestazione nei messaggi di posta elettronica di notifica.
Piè di pagina del messaggio di posta elettronica	data.folder.emailFooter	string	Testo del piè di pagina nei messaggi di posta elettronica di notifica.
Ripulitura pianificata	data.folder.purgeFlag	boolean	Indica se la busta è pianificata per l'eliminazione.
Elimina data di inizio	data.folder.purgeStartDate	string	Data di inizio per la pianificazione dell'eliminazione.
Data di fine eliminazione	data.folder.purgeEndDate	string	Data di fine per la pianificazione dell'eliminazione.
Bulk ID	data.folder.bulkId	integer	ID operazione di invio bulk, se applicabile.
Imponi ordine di firma	data.folder.enforceSignWorkflow	boolean	Indica se i destinatari devono accedere all'ordine definito.
Passaggio flusso di lavoro corrente	data.folder.currentWorkflowStep	integer	Passaggio corrente nel flusso di lavoro di firma.
Origine transazione	data.folder.transactionSource	string	Sistema di origine che ha avviato questa transazione.
Modificabile	data.folder.editable	boolean	Indica se la busta è modificabile.
firma In-Person	data.folder.inPersonSignable	boolean	Indica se la busta supporta la firma di persona.
Eseguire l'override dei promemoria	data.folder.overrideAccountReminders	boolean	Indica se le impostazioni del promemoria a livello di account vengono sostituite.
Eseguire l'override della delega	data.folder.overrideAccountRecipientDelegation	boolean	Indica se le impostazioni di delega a livello di account vengono sostituite.
Consenti delega	data.folder.allowRecipientsToDelegate	boolean	Indica se i destinatari possono delegare la firma.
ID	data.folder.envelopeId	integer	ID busta univoco (alias di folderId).
Name	data.folder.envelopeName	string	Nome busta (alias di folderName).
ID origine	data.folder.envelopeOriginatorId	integer	ID utente che ha avuto origine la busta.
ID aziendale	data.folder.envelopeCompanyId	integer	ID società proprietario della busta.
Date	data.folder.envelopeDate	integer	Data di creazione della busta (timestamp Unix in millisecondi).
Data condivisa	data.folder.envelopeSharedDate	integer	Data di condivisione della busta (timestamp Unix in millisecondi).
Condizione	data.folder.envelopeStatus	string	Stato corrente della busta.
ID contratto	data.folder.envelopeContractIds	array of integer	ID contratto associati a questa busta.
Autorizzazioni di entità	data.folder.envelopePartyPermissions	array of object	Elenco delle autorizzazioni del destinatario (stessa struttura di Destinatari).
ID destinatario	data.folder.envelopePartyPermissions.partyId	integer	Identificatore univoco del destinatario.
ID destinatario	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Nome di battesimo	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Cognome	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Segnaposto	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Data di creazione	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Rifiutare esplicitamente i messaggi di posta elettronica	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
ID univoco	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Livello di autenticazione	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Data aggiornamento password	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Stato password	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Composizione del codice	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Tipo di firma	data.folder.envelopePartyPermissions.signerSignatureType	string
Autorizzazioni	data.folder.envelopePartyPermissions.contractPermissions	string
Ordine di firma	data.folder.envelopePartyPermissions.partySequence	integer
Sequenza flusso di lavoro	data.folder.envelopePartyPermissions.workflowSignSequence	integer
ID busta	data.folder.envelopePartyPermissions.envelopeId	integer
ID società destinatario	data.folder.envelopePartyPermissions.partyCompanyId	integer
Modalità condivisione	data.folder.envelopePartyPermissions.sharingMode	string
URL di firma del destinatario	data.folder.envelopePartyPermissions.folderAccessURL	string
Modalità di sicurezza	data.folder.envelopePartyPermissions.securityMode	string
Comments	data.folder.envelopePartyPermissions.extraComments	string
Consenti modifica nome	data.folder.envelopePartyPermissions.allowNameChange	boolean
Nome aggiornato	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Livello di autenticazione del firmatario	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Codice di accesso	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
ID firma	data.folder.envelopePartyPermissions.signatureId	string
Ruolo	data.folder.envelopePartyPermissions.partyRole	string
Campo società	data.folder.envelopePartyPermissions.companyFieldValue	string
Campo titolo	data.folder.envelopePartyPermissions.titleFieldValue	string
Motivo della firma	data.folder.envelopePartyPermissions.reasonSigning	string
Campo pagamento aggiunto	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Beneficiario	data.folder.envelopePartyPermissions.payee	boolean
Pagamento ricorrente	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Stampa e firma fine	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Firmatario facoltativo	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Firmatari facoltativi	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Pagato	data.folder.envelopePartyPermissions.paid	boolean
Livello di autenticazione	data.folder.envelopeAuthenticationLevel	string	Livello di autenticazione necessario per la busta.
Single Signer Bulk	data.folder.allowSingleSignerInBulk	boolean	Indica se un single signer è consentito in modalità bulk.
nome cartella File-Based	data.folder.folderNameBasedOnFileNaming	boolean
File-Based Nome documento	data.folder.documentNameBasedOnFileNaming	boolean
nome certificato File-Based	data.folder.certificateNameBasedOnFileNaming	boolean
Denominazione dei file pre-Exec	data.folder.enableFileNamingBeforeExecution	boolean
Aggiunta di Payee	data.folder.payeeAddedd	boolean
Self-Signing abilitata	data.folder.selfSignerEnabled	boolean
Notary Enabled	data.folder.notaryEnabled	boolean
Visibilità limitata	data.folder.limitedVisibilityFlag	boolean
Visibilità post-firma	data.folder.postSigningVisibility	boolean
Firma bagnata	data.folder.wetSignatureEnabled	boolean
Merge abilitato	data.folder.mergeEnabled	boolean

binary

Si tratta del tipo di dati di base 'binary'.