SigningHub (anteprima)

SigningHub by Ascertia offre una suite completa per firme digitali ad alta attendibilità e automazione del flusso di lavoro dei documenti. Questo connettore consente alle aziende di autenticare gli utenti in modo sicuro, avviare richieste di firma dei documenti e gestire cicli di approvazione end-to-end. Progettato per soddisfare rigorosi standard di sicurezza globali, garantisce che i flussi di lavoro automatizzati rimangano legalmente applicabili, trasparenti e altamente sicuri nell'intera organizzazione.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Di alta qualità	Tutte le aree 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	Normale	Tutte le aree di App per la logica , ad eccezione delle seguenti: - aree Azure per enti pubblici - Azure cina - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Di alta qualità	Tutte le aree Power Apps 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)
Power Automate	Di alta qualità	Tutte le aree Power Automate ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Name	Support
URL	https://www.signinghub.com/contact-us/
Email	support@ascertia.com

Metadati del connettore
Publisher	Ascertia Limited.
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Sito web	https://signinghub.com
Informativa sulla privacy	https://www.signinghub.com/privacy-policy
Categories	Contenuto e file; Produttività

Connettore SigningHub

SigningHub offre un'API REST completa che consente alle organizzazioni di automatizzare e gestire flussi di lavoro di firma dei documenti digitali. Usando questo connettore, è possibile integrare SigningHub con Power Automate per semplificare i processi di approvazione dei documenti e automatizzare le azioni di firma all'interno di flussi di lavoro personalizzati.

Questo connettore consente l'automazione della firma dei documenti e di altre azioni SigningHub direttamente all'interno dei flussi di Power Automate, consentendo alle organizzazioni di creare flussi di lavoro di documenti efficienti e sicuri.

Publisher: Ascertia

Prerequisiti

Per usare questo connettore, è necessario disporre di:

Un account SigningHub attivo (https://www.signinghub.com).
Integrazione valida definita in SigningHub.

Come ottenere le credenziali

Compilare i campi Modulo di accesso con i valori seguenti:

Posta elettronica: indirizzo di posta elettronica dell'account SigningHub.
Password: password dell'account SigningHub.
ID client API: Ascertia o l'amministratore aziendale fornirà l'ID client API per l'uso del connettore.
Segreto client API: Ascertia o l'amministratore aziendale fornirà il segreto client API per l'uso del connettore.
URL API: URL DELL'API SigningHub, per impostazione predefinita https://api.signinghub.com

Operazioni supportate

Questo connettore offre una copertura dell'API REST SigningHub. Per un elenco delle azioni supportate e dei relativi parametri, vedere La Guida all'API SigningHub.

Supporto e collegamenti

Limiti per la limitazione delle richieste

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

Azioni

Aggiorna campo CheckBox	Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo casella di controllo di un documento in un pacchetto. Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata. È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI. Non è possibile aggiornare la larghezza e l'altezza. Rimarranno uguali a quando sono stati aggiunti.
Aggiorna campo di persona	Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo di firma di persona di un documento in un pacchetto. Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata. È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI.
Aggiorna campo firma digitale	Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo di firma digitale di un documento in un pacchetto. Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata. È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI.
Aggiorna campo iniziale	Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo iniziale di un documento in un pacchetto. Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata. È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI.
Aggiorna campo RadioBox	Le applicazioni aziendali possono usare questa API del servizio per aggiornare un pulsante di opzione di un documento in un pacchetto. Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata. È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI. Non è possibile aggiornare la larghezza e l'altezza. Rimarranno uguali a quando sono stati aggiunti.
Aggiorna campo TextBox	Le applicazioni aziendali possono usare questa API del servizio per aggiornare una casella di testo di un documento in un pacchetto. Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata. È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI.
Aggiorna segnaposto	Le applicazioni aziendali possono usare questa API del servizio per aggiornare un segnaposto nel flusso di lavoro. In genere questa chiamata è utile dopo che un modello è stato applicato a un documento e alle applicazioni aziendali vuole eseguire l'override dei dettagli di un segnaposto specifico all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il segnaposto del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro. Durante la preparazione dei documenti di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
Aggiornamento post-elaborazione	Le applicazioni aziendali possono usare questa API di servizio per aggiungere segnaposto a un flusso di lavoro un documento in un pacchetto.
Aggiornare i criteri di certificazione per un documento	Le applicazioni aziendali possono usare questa API di servizio per aggiornare le impostazioni di firma di certificazione per un documento in un pacchetto.
Aggiornare i dettagli del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiornare i dettagli del flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento, ma le applicazioni aziendali vogliono eseguire l'override dell'autorizzazione di certificazione o dopo l'elaborazione dei dettagli. L'ID pacchetto viene fornito nell'URL della risorsa.
Aggiornare i promemoria del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiornare i promemoria del flusso di lavoro per un destinatario già aggiunto a un flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento e alle applicazioni aziendali che desiderano eseguire l'override delle impostazioni dei promemoria all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il destinatario del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro.
Aggiornare il codice a matrice	Le applicazioni aziendali possono usare questa API di servizio per aggiornare un codice a matrice di un documento in un pacchetto.
Aggiornare l'autenticazione utente del flusso di lavoro (apertura documento) del pacchetto Enterprise	Le applicazioni aziendali possono usare questa API del servizio per aggiornare le autenticazioni dei pacchetti e la durata di accesso per i destinatari. Questa API può essere usata anche dall'amministratore dell'organizzazione o dall'utente dell'organizzazione se la variabile "ambito" è stata usata nella richiesta di autenticazione
Aggiornare l'ordine degli utenti del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiornare l'ordine del destinatario nel flusso di lavoro.
Aggiornare l'utente del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiornare i dettagli di un destinatario, di un gruppo o di un titolare del posto che è già stato aggiunto a un flusso di lavoro. In genere questa chiamata è utile dopo che un modello è stato applicato a un documento e alle applicazioni aziendali vuole eseguire l'override dei dettagli di un utente specifico all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il destinatario del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro. Nota, mentre la preparazione del documento di tipo XML supporta solo i tipi di ruolo "SIGNER", "REVIEWER" e "CARBON_COPY".
Aggiornare le autorizzazioni utente del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiornare le autorizzazioni del flusso di lavoro per un utente già aggiunto a un flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento e alle applicazioni aziendali che desiderano eseguire l'override delle autorizzazioni all'interno del flusso di lavoro. L'ID del pacchetto del documento viene fornito nell'URL della risorsa e l'utente del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro.
Aggiornare lo spazio condiviso	Le applicazioni aziendali possono usare questa API del servizio per aggiornare lo spazio condiviso. La disponibilità degli spazi condivisi per l'aggiornamento è soggetta al ruolo utente dell'organizzazione assegnato. Per consentire questo provisioning Enterprise Admin abiliterà l'opzione "Gestisci spazio condiviso" in Impostazioni documento ruoli>.
Aggiungere codice a matrice	Le applicazioni aziendali possono usare questa API di servizio per aggiungere un codice a matrice a un documento in un pacchetto.
Aggiungere gruppi al flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiungere gruppi come destinatari a un flusso di lavoro. Un gruppo SigningHub indica che qualsiasi membro del gruppo può eseguire l'azione, ovvero firmare, per conto di tutti i membri del gruppo. Si noti che il gruppo verrà aggiunto come ultimo utente/gruppo nel flusso di lavoro. Di conseguenza, potrebbe essere necessario eseguire ulteriori operazioni per rimuovere un utente/gruppo corrente, già presente nel flusso di lavoro. Durante la preparazione dei documenti di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
Aggiungere o aggiornare un documento dalla raccolta	Le applicazioni aziendali possono usare questa API di servizio per aggiungere un documento dalla raccolta dell'utente a un pacchetto. L'ID pacchetto viene fornito nell'URL, l'ID del documento deve essere fornito anche come "document_id" nell'URL della risorsa per identificare il documento della raccolta da copiare. Si noti che un pacchetto deve esistere già prima di poter aggiungere un documento usando questa chiamata.
Aggiungere segnaposto al flusso di lavoro	Le applicazioni aziendali possono usare questa API di servizio per aggiungere segnaposto a un flusso di lavoro in un pacchetto. Un segnaposto è obbligatorio quando non si conosce l'identità del destinatario previsto in un flusso di lavoro. Si noti che il segnaposto verrà aggiunto come ultimo utente nel flusso di lavoro. Di conseguenza, potrebbe essere necessario eseguire ulteriori operazioni per rimuovere un utente/gruppo corrente, già presente nel flusso di lavoro. L'aggiunta di un segnaposto consente di procedere e aggiungere campi di firma e/o di input al documento, che possono quindi essere assegnati a singoli utenti in una fase successiva. Durante la preparazione dei documenti di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
Aggiungere utenti al flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiungere destinatari a un flusso di lavoro. Questa chiamata aggiungerà solo un destinatario al flusso di lavoro. Ovvero, nessun campo attualmente presente nel documento verrà assegnato automaticamente ai nuovi destinatari, né verrà creato alcun nuovo campo. Si noti che i destinatari verranno aggiunti come ultima persona nel flusso di lavoro. Di conseguenza, potrebbe essere necessario eseguire ulteriori operazioni per rimuovere uno o più destinatari correnti già presenti nel flusso di lavoro. Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento. Si noti che l'input accetta uno o più utenti in una singola chiamata. In questa chiamata specifica l'utente è una persona fisica nota. Tuttavia, le stesse regole si applicano ai gruppi e ai segnaposto. In uno di questi casi il destinatario diventa un gruppo di utenti in cui qualsiasi membro del gruppo può firmare il documento o un segnaposto. Quest'ultimo caso viene utilizzato quando non si conosce l'identità del firmatario previsto. Nota L'ordine di firma del flusso di lavoro SigningHub inizia da "1". Di conseguenza, l'aggiunta di un utente al flusso di lavoro senza destinatari correnti inizia un nuovo conteggio degli ordini di firma. Il parametro "signing_order" è obbligatorio se il tipo di flusso di lavoro è "custom". Importante, l'uso di questa chiamata API può influire sul tipo di flusso di lavoro. Se sono presenti destinatari correnti in un flusso di lavoro sequenziale e ne viene aggiunto uno nuovo con lo stesso ordine di firma di un destinatario corrente, tale parte del flusso di lavoro cambia automaticamente da sequenziale a parallela. Di conseguenza, il flusso di lavoro è ora di tipo personalizzato anziché puramente sequenziale. L'aggiunta di un destinatario con lo stesso ordine di firma di due o destinatari paralleli non modifica il flusso di lavoro. Ci sono semplicemente tre o più destinatari in quel particolare punto del flusso di lavoro; tutto in ordine parallelo. Si noti che, mentre la preparazione del documento di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
Aggiungi campo CheckBox	Le applicazioni aziendali possono usare questa API del servizio per aggiungere una casella di controllo a un documento in un pacchetto. Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro. Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti. Se non vengono specificati parametri di larghezza e altezza, verrà assegnata una dimensione predefinita di 10x10. Se viene specificata una larghezza o un'altezza (o entrambe), il sistema confronta questi valori forniti tra loro. Il valore maggiore tra larghezza e altezza verrà assegnato a entrambe le dimensioni.
Aggiungi campo firma digitale	Le applicazioni aziendali possono usare questa API di servizio per aggiungere un campo di firma digitale a un documento in un pacchetto. Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro. Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti.
Aggiungi campo iniziale	Le applicazioni aziendali possono usare questa API di servizio per aggiungere un campo iniziale a un documento in un pacchetto. Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro. Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti.
Aggiungi campo RadioBox	Le applicazioni aziendali possono usare questa API del servizio per aggiungere una casella di controllo a un documento in un pacchetto. Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro. Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti. Se non vengono specificati parametri di larghezza e altezza, verrà assegnata una dimensione predefinita di 10x10. Se viene specificata una larghezza o un'altezza (o entrambe), il sistema confronta questi valori forniti tra loro. Il valore maggiore tra larghezza e altezza verrà assegnato a entrambe le dimensioni.
Aggiungi campo TextBox	Le applicazioni aziendali possono usare questa API di servizio per aggiungere un campo di input di testo a un documento in un pacchetto. Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro. Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti.
Aggiungi pacchetto	Questa API del servizio viene usata per aggiungere/creare un pacchetto di documento per contenere uno o più documenti. Questo pacchetto può quindi essere usato per aggiungere documenti e destinatari per avviare un nuovo flusso di lavoro. Come indicato in precedenza, questa chiamata è obbligatoria se si desidera lavorare con i documenti. Un pacchetto deve esistere prima di poter caricare o aggiungere documenti a SigningHub.. Anche un singolo documento fa parte di un pacchetto: un pacchetto contenente un documento. Nota: un pacchetto può essere rinominato se necessario dopo la creazione.
Applica modello flusso di lavoro	Le applicazioni aziendali possono usare questa API di servizio per applicare un modello di flusso di lavoro a un documento. L'ID documento sul quale deve essere applicato il modello viene fornito nell'URL della risorsa. Quando l'ID documento è impostato su 0, il modello verrà applicato a tutti i doucments in un pacakge. Durante l'applicazione del modello è importante ricordare questi due punti importanti: Punto 1: se il modello applicato viene creato utilizzando un PDF che contiene già campi modulo, assicurarsi che il documento in cui questo modello sia applicato deve contenere in anticipo questi campi modulo e SigningHub non creerà tali campi modulo tramite il modello, ma applica solo i dati del modulo e assegna ai rispettivi utenti. Punto 2: se il modello applicato viene creato in cui i campi modulo vengono aggiunti manualmente (quindi non presenti in origine nel PDF) tramite SigningHub, ad esempio il campo della firma iniziale, la firma di persona, le caselle di opzione, i pulsanti di opzione, i campi di testo e così via, quando si applica tale modello, questi campi modulo verranno creati nel documento di destinazione anche se questi campi modulo erano già presenti nel documento di destinazione.
Approvare il documento	Le applicazioni aziendali possono usare questa API di servizio per approvare un documento da parte di un utente specificato nell'ordine.
Assegnare un campo documento	Le applicazioni aziendali possono usare questa API del servizio per assegnare gli utenti ai campi di input, ad esempio campi di firma e quindi definire l'ordine di firma. I campi devono essere già presenti nel documento e gli utenti devono essere presenti nel flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa, insieme all'identificatore del pacchetto. Quando i destinatari si trovano in un flusso di lavoro, vengono numerati, a partire da uno e contando per ognuno di essi aggiuntivi. Pertanto, se sono presenti tre utenti in un flusso di lavoro, sono numerati "1", "2" e "3" rispettosamente. Questa chiamata API consente di assegnare un utente in base al numero di ordine del flusso di lavoro, a un campo di input nel documento.
Campi di autosostituimento	Le applicazioni aziendali possono chiamare questa API per aggiungere campi di modulo definiti dall'utente o firma a un documento in base al criterio di ricerca fornito. Le opzioni di posizionamento sono: a sinistra, a destra, in alto e in basso. Il documento viene cercato e vengono elaborate tutte le istanze dei criteri di ricerca soddisfatti. In questo modo è possibile aggiungere più campi con una sola chiamata. Ad esempio, caricare un documento e inserire automaticamente un campo di firma a destra di tutte le istanze della parola "Sign here:". Ciò consente di risparmiare tempo e garantisce che non vengano perse firme dal flusso di lavoro. La chiamata API supporta tutti i tipi di campi; ovvero elettronica, digitale, in persona, iniziali, campo di testo e così via. Inoltre, la chiamata API supporta la variabile "order". Ciò significa che è possibile assegnare automaticamente un set di campi di firma a un singolo utente. Di conseguenza, la chiamata può essere ripetuta per inserire e assegnare campi di firma a più utenti nel flusso di lavoro. Almeno un utente deve esistere in un flusso di lavoro prima che i campi della firma possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro. Questa chiamata API può essere usata più volte nello stesso documento. Il motivo di questa operazione è quello di soddisfare più firmatari su un documento. Il destinatario o il firmatario è identificato dalla variabile "order" passata nella chiamata. Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti.
Campi modulo di riempimento	Le applicazioni aziendali possono usare questa API di servizio per compilare uno o più campi modulo in un documento da parte di un utente specificato nell'ordine.
Campo Componente aggiuntivo persona	Le applicazioni aziendali possono usare questa API del servizio per un campo di firma di persona aggiunto a un documento in un pacchetto. Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro. Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti. Per ospitare una riunione di persona, un utente di SigningHub deve far parte del flusso di lavoro. Devono essere aggiunti con role "INPERSON_HOST" o "SIGNER". Per l'opzione host che non richiedono una firma o un campo di input nel documento e il campo della firma di persona può essere firmato dall'utente registrato non SigningHub. Si noti che si tratta di uno scenario speciale del flusso di lavoro in cui si prevede che l'utente e il destinatario di SigningHub si troverebbero nella stessa posizione. Questo tipo di firma non è destinato all'uso in base al quale un documento viene condiviso con i destinatari tramite collegamento di posta elettronica nel normale metodo di integrazione libero.
Carica allegato	Le applicazioni aziendali possono usare questa API di servizio per caricare un allegato in un documento.
Carica documento	Le applicazioni aziendali possono usare questa API di servizio per aggiungere un documento a un pacchetto di documenti collegato all'account di un utente aziendale. Le informazioni sul documento vengono inviate nell'intestazione della richiesta HTTP e i byte dei documenti vengono inviati nel corpo della richiesta HTTP. Nota SigningHub convertirà i formati di documento supportati in PDF se l'intestazione "x-convert-document" è impostata su "true". L'unico caso supportato in cui questo valore è impostato su "false" consiste nel conservare Word formato e documenti XML. SigningHub supporta un'ampia gamma di formati di documento, ognuno dei quali può essere convertito in formato PDF al caricamento. Fare clic qui per l'elenco completo. Nota I documenti PDF non vengono modificati al caricamento nel sistema. Si noti che un pacchetto deve esistere già prima di poter aggiungere un documento usando questa chiamata.
Compilare le iniziali	Le applicazioni aziendali possono usare questa API di servizio per compilare un campo iniziale in un documento da parte di un utente specificato nell'ordine.
Completare l'elaborazione	Le applicazioni aziendali possono usare questa API di servizio per completare l'elaborazione dei documenti dopo la firma di tutti i campi della firma. Questo metodo viene usato principalmente dalle app native SigningHub per dispositivi mobili per iOS e Android e dai casi d'uso Web per dispositivi mobili. Le applicazioni aziendali generali che usano una stretta integrazione nel rispettivo portale non devono chiamare questo metodo. Tuttavia, quando si usa l'API Firma documento (e quindi l'utente non viene presentato con una rappresentazione visiva del documento richiesto per firmare) la chiamata a questa API è necessaria per garantire che il rispettivo flusso di lavoro continui o venga completato. Ad esempio, dopo che tutte le firme sono state applicate usando l'API del documento di firma "blind" chiamano il documento, il documento non verrà visualizzato come stato "Completato" al proprietario fino a quando non viene richiamata questa API. Il proprietario del documento visualizzerà lo stato "In corso" fino a quando questa API non viene chiamata. All'interno di app native SigningHub per dispositivi mobili e casi d'uso Web per dispositivi mobili, questa chiamata è necessaria per garantire che ogni utente completi le rispettive azioni rispetto a SigningHub.Ad esempio, dopo che un firmatario ha firmato un documento nell'app SigningHub, questo metodo viene richiamato dall'applicazione per garantire che il flusso di lavoro continui a essere elaborato e il successivo firmatario riceve una notifica, e lo stato del documento è disponibile tramite l'URL di callback configurato.
Condividi pacchetto documento	Le applicazioni aziendali possono usare questa API del servizio per condividere un pacchetto di documenti con i firmatari e avviare un nuovo flusso di lavoro. Il documento dovrebbe essere già stato preparato applicando un modello e, facoltativamente, aggiornando gli utenti e le azioni definiti nel modello. L'ID del pacchetto da condividere viene fornito nell'URL della risorsa.
Documento di approvazione di Gatekeeper	Le applicazioni aziendali possono usare questa API del servizio per approvare un documento da parte di un utente specificato nell'ordine.
Documento di rifiuto di Gatekeeper	Le applicazioni aziendali possono usare questa API del servizio per rifiutare un documento da parte di un utente specificato nell'ordine.
Documento richiamo	Le applicazioni aziendali possono usare questa API del servizio per arrestare un flusso di lavoro in corso. L'ID documento viene fornito nell'URL della risorsa. Dopo aver richiamato lo stato del documento cambia automaticamente in "DRAFT".
Elimina allegato	Le applicazioni aziendali possono usare questa API di servizio per eliminare l'allegato di un documento.
Elimina campo documento	Le applicazioni aziendali possono usare questa API di servizio per eliminare un campo di documento in un pacchetto.
Elimina pacchetto	Le applicazioni aziendali possono usare questa API del servizio per eliminare un documento dalla posta in arrivo dell'utente. L'ID pacchetto viene fornito nell'URL della risorsa come "{package_id}". Se lo stato del documento è IN SOSPESO, viene automaticamente rifiutato in seguito all'operazione di eliminazione. Se lo stato del documento è SHARED, il documento viene richiamato automaticamente e il flusso di lavoro viene arrestato prima dell'eliminazione del documento.
Elimina spazio condiviso	Le applicazioni aziendali possono usare questa API del servizio per eliminare lo spazio condiviso. La disponibilità dell'eliminazione di spazi condivisi è soggetta al ruolo utente dell'organizzazione assegnato. Per consentire questo provisioning Enterprise Admin abiliterà l'opzione "Gestisci spazio condiviso" in Impostazioni documento ruoli>.
Eliminare l'utente del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per eliminare il destinatario del flusso di lavoro.
Eliminare un documento	Le applicazioni aziendali possono usare questa API di servizio per eliminare un documento in un pacchetto.
Firma documento	Le applicazioni aziendali possono usare questa API del servizio per firmare un documento (sia elettronico che digitale) senza visualizzare il documento all'utente finale usando SigningHub. Ad esempio, un'applicazione aziendale può avere un altro metodo per visualizzare il documento all'utente e solo la funzionalità di firma di SigningHub è necessaria oppure per le operazioni bulk può essere giustificato firmare senza richiedere all'utente di visualizzare e approvare singolarmente ogni documento. Se sono presenti modifiche da salvare nel documento prima della firma, è necessario chiamare l'API Campi modulo di riempimento prima di chiamare l'API Firma documento. Si noti che tutti i campi di input obbligatori in un documento richiedono il completamento prima del completamento dell'API. Il firmatario è identificato dal token di accesso presentato nella chiamata. Pertanto, l'autenticazione del firmatario è necessaria prima di effettuare questa chiamata. Non è possibile eseguire l'autenticazione come amministratore dell'organizzazione con la variabile di ambito e firmare un documento per conto di un utente. Il token di accesso deve essere rilasciato al firmatario in seguito all'autenticazione diretta. Quando questa chiamata viene completata, è importante che se il firmatario è l'ultimo firmatario per un documento richiamato dalla chiamata ALL'API Fine documento . Il motivo è dovuto al fatto che senza chiamare tale API il documento rimarrà in stato "In corso" al proprietario del documento. Dopo aver chiamato l'API, lo stato passerà a "Completato" per il proprietario del documento. Dopo la firma del documento, la risposta di verifica può essere visualizzata dall'API Recupera verifica documento . Utilizzo OTP primo o secondo fattore per l'autenticazione Se l'autenticazione OTP è attivata per l'operazione di firma lato server, le applicazioni client dovranno generare un OTP per il numero di cellulare usando l'autenticazione del firmatario tramite chiamata API OTP. Le rispettive applicazioni aziendali devono recuperare il codice OTP dall'uso e inviarlo durante l'esecuzione della chiamata API. Questa operazione viene eseguita usando l'intestazione "x-otp" nella richiesta.
Flusso di lavoro completo nel centro (termina flusso di lavoro)	Le applicazioni aziendali possono contrassegnare il flusso di lavoro completato anche al centro del flusso di lavoro. Usare questa API del servizio per modificare lo stato del flusso di lavoro in modo che sia completato. Se sono presenti destinatari che non hanno ancora firmato il documento. La firma non sarà più necessaria e non sarà più in grado di visualizzare il documento nella posta in arrivo. Il token di connessione deve appartenere al proprietario del documento o all'amministratore dell'organizzazione può usare la variabile di ambito per ottenere il token di accesso per conto del proprietario del documento per eseguire questa azione.
Invia documento	Uno dei ruoli SigningHub è denominato "Editor". Ciò consente a un destinatario di modificare i campi di input in un documento, ma non richiede una firma. Una volta completato, il destinatario invia le modifiche. Il pulsante usato nell'interfaccia utente grafica è denominato "Submit". Si tratta dell'operazione equivalente per un editor per inviare le modifiche tramite una chiamata API. Fare clic su SigningHub Roles (Ruoli di SigningHub ) per una descrizione di tutti i ruoli destinatari del flusso di lavoro disponibili.
Ottenere contatti	Le applicazioni aziendali possono usare questa API di servizio per ritirare i contatti sia da contatti personali che aziendali per l'utente corrente. È possibile eseguire ricerche in base al criterio fornito nell'intestazione "x-search-text". Inoltre, è possibile cercare i contatti specifici di un utente o quella dell'azienda a cui appartiene l'utente. Le informazioni sulla risposta di ricerca contengono l'indirizzo di posta elettronica dell'utente e il rispettivo nome utente.
Ottenere gli utenti del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per ottenere i dettagli del flusso di lavoro per il pacchetto.
Ottenere i criteri di certificazione per un documento	Le applicazioni aziendali possono usare questa API di servizio per certificare le impostazioni di firma di un documento in un pacchetto.
Ottenere i dettagli del documento	Le applicazioni aziendali possono usare questa API di servizio per ottenere i dettagli del documento. L'ID documento viene fornito nell'URL come "{document_id}".
Ottenere i dettagli del flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per ottenere i dettagli del flusso di lavoro per il pacchetto.
Ottenere i dettagli del pacchetto	Le applicazioni aziendali possono usare questa API del servizio per ottenere i dettagli di un pacchetto. Questa API può essere usata anche dall'applicazione aziendale per eseguire azioni per conto dell'utente aziendale tramite "Autenticazione ambito".
Ottenere l'autenticazione utente del flusso di lavoro (apertura documento) di Enterprise Package	Le applicazioni aziendali possono usare questa API del servizio per abilitare le impostazioni di sicurezza di accesso per il pacchetto. I destinatari per i quali la sicurezza è configurata vengono identificati dall'ordine nell'URL. L'ID pacchetto viene identificato anche nell'URL della richiesta. I destinatari non potranno accedere al pacchetto del documento all'esterno dell'ambito di questa durata se la sicurezza di accesso è abilitata. Il proprietario del documento può anche configurare la sicurezza basata sull'autenticazione del pacchetto per un destinatario.
Ottenere la cronologia del flusso di lavoro	Le applicazioni aziendali possono usare questa API di servizio per recuperare l'elenco di azioni eseguite in un documento. L'ID pacchetto viene fornito nell'URL della risorsa. Il campo di ricerca (intestazione x-search-text) è destinato a posta elettronica, nome documento, azione, infokey e infovalue.
Ottenere le autorizzazioni utente del flusso di lavoro	Le applicazioni aziendali possono usare questa API di servizio per ottenere le autorizzazioni per i documenti per un destinatario. Il destinatario viene identificato dall'ordine nel flusso di lavoro. L'ID del pacchetto viene fornito nell'URL della risorsa.
Ottenere lo spazio condiviso	Le applicazioni aziendali possono usare questa API di servizio per ottenere uno spazio condiviso specifico. Questa API restituisce informazioni sullo spazio condiviso, sul proprietario e sul collaboratore.
Ottenere modelli	Le applicazioni aziendali possono usare questa API di servizio per ottenere un elenco di modelli per l'utente corrente. È possibile eseguire ricerche in base al criterio fornito nell'intestazione "x-search-text". Inoltre, è possibile eseguire ricerche nei modelli personali di un utente o nei modelli aziendali in base al ruolo utente consentito dall'amministratore dell'organizzazione.
Ottenere modelli enterprise	Le applicazioni aziendali possono usare questa API di servizio per ottenere l'elenco dei modelli aziendali dell'utente corrente. Ciò significa che l'amministratore dell'organizzazione o l'utente dell'organizzazione se la variabile "ambito" è stata usata nella richiesta di autenticazione. È possibile eseguire ricerche in base al criterio fornito nell'intestazione "x-search-text".
Ottenere pacchetti	Le applicazioni aziendali possono usare questa API di servizio per ottenere un elenco di documenti filtrati in base a stati diversi. Gli utenti possono dividere i record in pagine fornendo un numero di record per pagina.
Ottenere un report di evidenza del processo	Le applicazioni aziendali possono usare questa API di servizio per scaricare il report delle prove del processo del flusso di lavoro di un documento.
Ottieni allegati	Le applicazioni aziendali possono usare questa API di servizio per ottenere gli allegati di un documento.
Pacchetti di firma bulk	Le applicazioni aziendali possono usare questa API per firmare,condividere/firmare e condividere più documenti (sia elettronici che digitali) senza visualizzare i documenti all'utente finale. Questa API richiede informazioni dall'applicazione aziendale sui pacchetti di documenti e i dettagli delle firme, dei campi di persona e iniziali. Al termine della transazione di firma bulk, l'API restituirà gli stati e gli ID transazione dei pacchetti di documento. A differenza dell'API Firma documento, questa API non solo firma un pacchetto di documento, ma lo contrassegna anche come approvato e esaminato in base al fatto che il destinatario sia un firmatario, un editor o un revisore. Qualsiasi pacchetto di documento per il quale lo stato restituisce come COMPLETED è stato firmato, approvato o esaminato da questa API. La firma bulk funziona con tutti i metodi di autenticazione in fase di firma. Se SIGN viene passato come bulk_action e il pacchetto è in stato Bozza, l'esecuzione di Sign and Share verrà eseguita automaticamente. È necessario chiamare questa API dopo l'API Pre-Bulk Sign Documents . Se è necessario apportare modifiche in uno dei documenti prima della firma, è necessario chiamare l'API Campi modulo di riempimento prima di chiamare l'API Pre-Bulk Sign Document. Tenere presente che tutti i campi di input obbligatori in un documento richiedono il completamento prima che questa API venga completata correttamente; mentre, i campi popolati automaticamente (ad esempio Nome, Posta elettronica, Data, Titolo processo e così via) verranno compilati automaticamente. Il firmatario è identificato dal token di accesso presentato nella chiamata. Pertanto, l'autenticazione del firmatario è necessaria prima di effettuare questa chiamata. Non è possibile eseguire l'autenticazione come amministratore dell'organizzazione con la variabile di ambito e firmare un documento per conto di un utente. Il token di accesso deve essere rilasciato al firmatario in seguito all'autenticazione diretta. Dopo la firma del documento, la risposta di verifica può essere visualizzata dall'API Stato della firma bulk . Utilizzo OTP primo o secondo fattore per l'autenticazione Nel caso in cui l'autenticazione OTP sia attivata per l'operazione di firma lato server, le applicazioni client dovranno generare un OTP per il numero di cellulare usando l'autenticazione con firma bulk tramite chiamata API OTP . Le rispettive applicazioni aziendali devono recuperare il codice OTP dall'uso e inviarlo durante l'esecuzione della chiamata API. Questa operazione viene eseguita usando l'intestazione "x-otp" nella richiesta.
Recupera campi documento	Le applicazioni aziendali possono usare questa API di servizio per ottenere campi documento, ad esempio iniziali, in-persons, campi di firma o campi modulo.
Recupera promemoria flusso di lavoro	Le applicazioni aziendali possono usare questa API del servizio per aggiornare i promemoria per i destinatari che sono già stati aggiunti a un flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento e alle applicazioni aziendali che desiderano eseguire l'override delle impostazioni dei promemoria all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il destinatario del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro.
Rifiuta documento	Le applicazioni aziendali possono usare questa API di servizio per rifiutare un documento da parte di un utente specificato nell'ordine.
Rinomina pacchetto	Questa API del servizio viene usata per rinominare un pacchetto di documento. Il pacchetto del documento è identificato dal relativo identificatore univoco nell'URL della chiamata.
Rinominare il documento	Le applicazioni aziendali possono usare questa API di servizio per rinominare un documento in un pacchetto.
Scarica allegato	Le applicazioni aziendali possono usare questa API di servizio per scaricare l'allegato di un documento.
Scarica documento	Le applicazioni aziendali possono usare questa API di servizio per scaricare i byte dei documenti. L'ID pacchetto e l'ID documento vengono forniti nell'URL della risorsa.
Scaricare il pacchetto	Le applicazioni aziendali possono usare questa API di servizio per scaricare il pacchetto del documento in formato binario. L'ID pacchetto viene fornito nell'URL della risorsa. Se il pacchetto contiene un solo documento, il download è il documento PDF binario. In alternativa, se il pacchetto contiene più documenti, il download è il file ZIP binario di tutti i documenti. Le intestazioni x-password e x-otp sono facoltative. Sono necessari se il proprietario del documento li imposta durante la fase di creazione del flusso di lavoro.
Spostare il pacchetto nella cartella Spazio personalizzato o condiviso	Le applicazioni aziendali possono usare questa API di servizio per spostare il pacchetto del documento in uno spazio condiviso o nella cartella personalizzata dell'utente.
Stato firma bulk	Le applicazioni aziendali possono usare questa API per ottenere lo stato di una transazione di firma in blocco specifica insieme ai dettagli dei pacchetti di documenti elaborati dall'API Pacchetti di firma bulk . È necessario chiamare questa API dopo l'API pacchetti di firma bulk. Il firmatario è identificato dal token di accesso presentato nella chiamata. Pertanto, l'autenticazione del firmatario è necessaria prima di effettuare questa chiamata. Non è possibile eseguire l'autenticazione come amministratore dell'organizzazione con la variabile di ambito e firmare un documento per conto di un utente. Il token di accesso deve essere rilasciato al firmatario in seguito all'autenticazione diretta. Per la firma RAS, la proprietà ACTION verrà REMOTE_AUTHORIZATION_REQURIED e la proprietà STATUS sarà IN SOSPESO, a indicare che la richiesta deve essere autorizzata usando il dispositivo mobile. Se il processo di firma non riesce in un documento a causa di diversi livelli di garanzia configurati e l'utente vuole avviare nuovamente il processo di firma per completare il processo di firma nei documenti non riusciti, la proprietà ACTION verrà REINITIATE_SIGNING_PROCESS e la proprietà STATUS sarà IN SOSPESO.

Aggiorna campo CheckBox

ID operazione:: V4_Checkbox_UpdateCheckBox

Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo casella di controllo di un documento in un pacchetto.

Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata. È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI.

Non è possibile aggiornare la larghezza e l'altezza. Rimarranno uguali a quando sono stati aggiunti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome corrente del campo da aggiornare.
renamed_as	renamed_as		string	Nome aggiornato del campo se la ridenominazione è prevista.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
valore	value		string	Valore del campo. I valori possibili sono "true" o "false"
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
validation_rule	validation_rule		string	Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Aggiorna campo di persona

ID operazione:: V4_InPerson_UpdateInPerson

Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo di firma di persona di un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome corrente del campo da aggiornare.
renamed_as	renamed_as		string	nome aggiornato del campo, se la ridenominazione è prevista.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
segnaposto	placeholder		string	Identificatore stringa per il campo di persona, può essere Customer, Jack, CEO e così via.
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
schermo	display		string	Visibilità del campo da aggiornare, i valori possibili sono "VISIBLE" e "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Livello di garanzia da aggiornare. I valori possibili sono "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
authentication_signing	authentication_signing			Autenticazione sul campo
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Aggiorna campo firma digitale

ID operazione:: V4_Signature_UpdateSignature

Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo di firma digitale di un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome corrente del campo da aggiornare.
level_of_assurance	level_of_assurance		array of string	Livello di garanzia da aggiornare. I valori possibili sono "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
renamed_as	renamed_as		string	Nome aggiornato del campo se si intende rinominare il campo.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
schermo	display		string	Visibilità del campo da aggiornare, i valori possibili sono "VISIBLE" e "INVISIBLE"
authentication_signing	authentication_signing			Autenticazione sul campo
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Aggiorna campo iniziale

ID operazione:: V4_Initials_UpdateInitial

Le applicazioni aziendali possono usare questa API di servizio per aggiornare un campo iniziale di un documento in un pacchetto.

Si noti che è possibile modificare tutti i parametri di input. Se si desidera mantenere l'impostazione corrente, inviarla nella chiamata invariata.

È quindi possibile usare gli stessi parametri di quando è stato aggiunto il campo di input o le informazioni restituite da Recupera campi documento. Quest'ultimo può essere usato quando è stato applicato un modello o il documento è stato creato usando l'interfaccia GUI.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome corrente del campo da aggiornare.
renamed_as	renamed_as		string	Nome aggiornato del campo se la ridenominazione è prevista.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.

Valori restituiti

response: object

Aggiorna campo RadioBox

ID operazione:: V4_Radio_UpdateRadioBox

Le applicazioni aziendali possono usare questa API del servizio per aggiornare un pulsante di opzione di un documento in un pacchetto.

Non è possibile aggiornare la larghezza e l'altezza. Rimarranno uguali a quando sono stati aggiunti.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome corrente del campo da aggiornare.
renamed_as	renamed_as		string	Nome aggiornato del campo se la ridenominazione è prevista.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
valore	value		string	Valore del campo. I valori possibili sono "true" o "false"
validation_rule	validation_rule	True		Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
radio_group_name	radio_group_name	True	string	Nome del gruppo a cui appartiene il campo.
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.

Valori restituiti

response: object

Aggiorna campo TextBox

ID operazione:: V4_TextBox_UpdateTextBox

Le applicazioni aziendali possono usare questa API del servizio per aggiornare una casella di testo di un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome corrente del campo da aggiornare.
field_locale	field_locale		string	Campo locale. I valori possibili sono ar-AE \| en-US. Facoltativo e predefinito sarà en-US. Questo valore è importante per il tipo "DATE".
renamed_as	renamed_as		string	Nome aggiornato del campo se la ridenominazione è prevista.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
valore	value		string	Valore del campo. Per type = DATE, il valore deve seguire il formato ISO 8601. Dopo il formato AAAA-MM-DD hh:mm:ss +00. Poiché i valori sono per i campi data le applicazioni client possono inviare YYYY-MM-DD e ignorare hh:mm:ss +00. Se il valore non è nel formato corretto, verrà restituito un errore.
lunghezza_massima	max_length	True	integer	Lunghezza massima del valore consentito nel campo. Deve essere compreso tra 1 e 9999
field_type	field_type	True		Il tipo di campo rispetto all'accettazione del tipo di valori, i valori possibili sono "NUMBER" o "TEXT".
validation_rule	validation_rule	True		Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
font	font			Tipo di carattere del testo dei campi
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
segnaposto	placeholder		string	Gli sviluppatori possono fornire un proprio testo segnaposto. Questi segnaposto vengono visualizzati nei campi di testo durante la visualizzazione del documento nel visualizzatore.
format	format		string	Formato testo del campo. Utilizzato solo per il campo tipo di data. I valori possibili sono m/d m/d/yy m/d/aaaaa mm/gg/yy mm/gg/aaaa mm/yy mm/aaaaa d-mmm d-mmm-yy gg-mmm-aaa gg-mmm-yy gg-mmm-yyyy yy-mm-dd aaaa-mm-gg mmm-yy mmm-yyyy mmmm-yy mmmm-aaa mmmm d, aaaaa gg/mm/yy ddmmmyyy
convalida	validation			Validations

Valori restituiti

response: object

Aggiorna segnaposto

ID operazione:: V4_Workflow_WorkflowUpdatePlaceholder

Le applicazioni aziendali possono usare questa API del servizio per aggiornare un segnaposto nel flusso di lavoro. In genere questa chiamata è utile dopo che un modello è stato applicato a un documento e alle applicazioni aziendali vuole eseguire l'override dei dettagli di un segnaposto specifico all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il segnaposto del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro. Durante la preparazione dei documenti di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto per il quale deve essere aggiunto il segnaposto.
Ordinamento	order	True	integer	Ordine del destinatario nel flusso di lavoro.
segnaposto	placeholder		string	Nome del nuovo segnaposto da aggiungere nel flusso di lavoro. Se non viene specificato alcun valore, il valore precedente verrà conservato.
email_notification	email_notification		boolean	L'impostazione del valore su "true" invia all'utente una notifica tramite posta elettronica quando arriva il suo turno nel flusso di lavoro. L'impostazione del relativo valore su "false" non invia la notifica tramite posta elettronica all'utente al suo turno. Se non viene specificato alcun valore, il valore precedente verrà conservato.
ruolo	role	True		Ruolo del gruppo come destinatario nel flusso di lavoro. Il valore possibile è "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" e "INPERSON_HOST". Se non viene specificato alcun valore, il valore precedente verrà conservato. Tuttavia, mentre la preparazione del documento di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordine in cui il flusso di lavoro verrà firmato dai destinatari. Questo ordine di firma è importante quando il tipo di flusso di lavoro è impostato su "CUSTOM".

Valori restituiti

response: object

Aggiornamento post-elaborazione

ID operazione:: V4_Workflow_UpdateWorkflowPostProcess

Le applicazioni aziendali possono usare questa API di servizio per aggiungere segnaposto a un flusso di lavoro un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto del documento per il quale viene aggiornata la post-elaborazione.
enabled	enabled	True	boolean	True, se la post-elaborazione è attivata per il pacchetto.
contacts	contacts		array of string
nome	name	True	string
posta elettronica	email	True	string
message	message		string	Messaggio stringa personalizzato per tutti i contatti. Il messaggio diventa parte del messaggio inviato ai contatti.
google_drive	google_drive		boolean	True, se il documento deve essere caricato nell'account Google fornito dopo il completamento del flusso di lavoro.
Dropbox	dropbox		boolean	True, se il documento deve essere caricato nell'account dropbox fornito dopo il completamento del flusso di lavoro.
onedrive	onedrive		boolean	True, se il documento deve essere caricato nell'account oneDrive fornito dopo il completamento del flusso di lavoro.
workflow_recipients	workflow_recipients	True	boolean	True, se il report di completamento del flusso di lavoro deve essere inviato a tutti i destinatari del flusso di lavoro quando viene eseguita la post-elaborazione. Il valore predefinito è false.
document_processing_report	document_processing_report	True	boolean	True, se per il flusso di lavoro deve essere abilitato Inviare il report di elaborazione dei documenti (XML)

Valori restituiti

response: object

Aggiornare i criteri di certificazione per un documento

ID operazione:: V4_Documents_UpdateCertifyPolicy

Le applicazioni aziendali possono usare questa API di servizio per aggiornare le impostazioni di firma di certificazione per un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento in cui deve essere eseguita l'azione.
Certificare	certify			Certificare l'oggetto impostazioni per il documento.
lock_form_fields	lock_form_fields	True	boolean	True se i campi modulo devono essere bloccati dopo l'ultima firma del documento corrente.

Valori restituiti

response: object

Aggiornare i dettagli del flusso di lavoro

ID operazione:: V4_Workflow_UpdateWorkflow

Le applicazioni aziendali possono usare questa API del servizio per aggiornare i dettagli del flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento, ma le applicazioni aziendali vogliono eseguire l'override dell'autorizzazione di certificazione o dopo l'elaborazione dei dettagli. L'ID pacchetto viene fornito nell'URL della risorsa.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per il quale è necessario aggiornare i dettagli del flusso di lavoro.
workflow_type	workflow_type			Tipo di flusso di lavoro per il pacchetto, ad esempio (SERIAL, PARALLEL, INDIVIDUAL, CUSTOM). Se non viene specificato alcun valore, il valore precedente verrà conservato.
workflow_mode	workflow_mode			Modalità flusso di lavoro del pacchetto, ad esempio ONLY_ME, ME_AND_OTHERS ONLY_OTHERS). Se la modalità flusso di lavoro è impostata su ONLY_ME non è possibile aggiungere alcun collaboratore al pacchetto di altri utenti autenticati
continue_on_decline	continue_on_decline		boolean	True, se il flusso di lavoro deve continuare anche se un destinatario rifiuta il documento. Se non viene specificato alcun valore, il valore precedente verrà conservato.
message	message		string	Un messaggio stringa personalizzato dal proprietario del documento a ogni destinatario, questo messaggio viene visualizzato nel messaggio di posta elettronica di condivisione e sullo schermo. Se non viene specificato alcun valore, il valore precedente verrà conservato.
comments	comments		boolean	Consentire commenti

Valori restituiti

response: object

Aggiornare i promemoria del flusso di lavoro

ID operazione:: V4_Workflow_UpdateWorkflowReminder

Le applicazioni aziendali possono usare questa API del servizio per aggiornare i promemoria del flusso di lavoro per un destinatario già aggiunto a un flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento e alle applicazioni aziendali che desiderano eseguire l'override delle impostazioni dei promemoria all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il destinatario del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per il quale aggiornare i promemoria del flusso di lavoro.
Ordinamento	order	True	integer	Ordine dell'utente per cui aggiornare i promemoria del flusso di lavoro.
apply_to_all	apply_to_all	True	boolean	True, se le impostazioni del promemoria devono essere applicate a tutti i destinatari del flusso di lavoro.
enabled	enabled	True	boolean	True, se le impostazioni del promemoria devono essere abilitate.
frequenza	frequency		string	Frequenza promemoria. I valori possibili sono DAYS \| ORE.
remind_after	remind_after	True	integer	Obbligatorio, in caso di proprietà abilitata, true. Numero di giorni dopo i quali il primo promemoria verrebbe inviato all'utente del flusso di lavoro.
ripetere	repeat			I promemoria vengono inviati ripetutamente all'utente.

Valori restituiti

response: object

Aggiornare il codice a matrice

ID operazione:: V4_QR_UpdateQRCode

Le applicazioni aziendali possono usare questa API di servizio per aggiornare un codice a matrice di un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome corrente del campo da aggiornare.
renamed_as	renamed_as		string	Nome aggiornato del campo se la ridenominazione è prevista.
page_no	page_no	True	integer	Numero di pagina per il quale è necessario aggiornare il campo
dimensions	dimensions	True		Dimensioni campo
data	data		string	Dati di testo normale da codificare nel codice a matrice. Il valore predefinito è l'URL generato per accedere al documento correlato. ad esempio {base_url}/document/{document_unique_id}
options	options			Impostazioni relative alle opzioni
color	color			Impostazioni relative al colore
logo	logo			Impostazioni relative al logo

Valori restituiti

Corpo: UpdateQrCodeResponse

Aggiornare l'autenticazione utente del flusso di lavoro (apertura documento) del pacchetto Enterprise

ID operazione:: V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

Le applicazioni aziendali possono usare questa API del servizio per aggiornare le autenticazioni dei pacchetti e la durata di accesso per i destinatari. Questa API può essere usata anche dall'amministratore dell'organizzazione o dall'utente dell'organizzazione se la variabile "ambito" è stata usata nella richiesta di autenticazione

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per il quale è necessario aggiornare la sicurezza e l'autenticazione dell'accesso al flusso di lavoro.
Ordine destinatario	order	True	integer	Ordine del destinatario nel flusso di lavoro per cui aggiornare la sicurezza e l'autenticazione dell'accesso.
apply_to_all	apply_to_all	True	boolean	True, se la sicurezza di accesso o le autenticazioni devono essere applicate a tutti i destinatari del flusso di lavoro.
autenticazione	authentication	True		Ha l'accesso a dati di autenticazione
authentication_signing	authentication_signing			Ha i dati di autenticazione di firma
access_duration	access_duration	True		Ha la durata di accesso del flusso di lavoro

Valori restituiti

response: object

Aggiornare l'ordine degli utenti del flusso di lavoro

ID operazione:: V4_Workflow_WorkflowUserUpdateOrder

Le applicazioni aziendali possono usare questa API del servizio per aggiornare l'ordine del destinatario nel flusso di lavoro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto a cui devono essere aggiunti i destinatari.
Ordinamento	order	True	integer	Ordine esistente del destinatario da aggiornare.
order	order	True	integer	Ordine del destinatario da aggiornare.

Valori restituiti

response: object

Aggiornare l'utente del flusso di lavoro

ID operazione:: V4_Workflow_WorkflowUserUpdate

Le applicazioni aziendali possono usare questa API del servizio per aggiornare i dettagli di un destinatario, di un gruppo o di un titolare del posto che è già stato aggiunto a un flusso di lavoro. In genere questa chiamata è utile dopo che un modello è stato applicato a un documento e alle applicazioni aziendali vuole eseguire l'override dei dettagli di un utente specifico all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il destinatario del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro. Nota, mentre la preparazione del documento di tipo XML supporta solo i tipi di ruolo "SIGNER", "REVIEWER" e "CARBON_COPY".

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per il quale l'utente del flusso di lavoro deve essere aggiornato.
Ordinamento	order	True	integer	Ordine dell'utente nel flusso di lavoro.
user_email	user_email		string	Indirizzo di posta elettronica del nuovo utente da aggiornare nel flusso di lavoro. Se non viene specificato alcun valore, il valore precedente verrà conservato.
user_name	user_name		string	Nome del destinatario da aggiornare. Se non viene specificato alcun valore, il valore precedente verrà conservato.
email_notification	email_notification		boolean	L'impostazione del valore su "true" invia all'utente una notifica tramite posta elettronica quando arriva il suo turno nel flusso di lavoro. L'impostazione del relativo valore su "false" non invia la notifica tramite posta elettronica all'utente al suo turno. Se non viene specificato alcun valore, il valore precedente verrà conservato.
mobile_number	mobile_number		string	Numero di cellulare. Se non viene specificato alcun valore, il valore precedente verrà conservato.
ruolo	role	True		Ruolo del destinatario da aggiornare. I valori possibili sono "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" o "INPERSON_HOST". Se non viene specificato alcun valore, il valore precedente verrà conservato. Tuttavia, mentre la preparazione del documento di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordine in cui il flusso di lavoro verrà firmato dai destinatari. Questo ordine di firma è importante quando il tipo di flusso di lavoro è impostato su "CUSTOM".
email_language_code	email_language_code		string	codice della lingua di posta elettronica
delivery_method	delivery_method	True		Metodo di recapito del destinatario nel flusso di lavoro. I valori possibili sono "EMAIL", "SMS" o "EMAIL_AND_SMS". Il valore predefinito sarà EMAIL
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

Corpo: UpdateCollaboratorResponse

Aggiornare le autorizzazioni utente del flusso di lavoro

ID operazione:: V4_WorkflowPermission_UpdateWorkflowPermissions

Le applicazioni aziendali possono usare questa API del servizio per aggiornare le autorizzazioni del flusso di lavoro per un utente già aggiunto a un flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento e alle applicazioni aziendali che desiderano eseguire l'override delle autorizzazioni all'interno del flusso di lavoro. L'ID del pacchetto del documento viene fornito nell'URL della risorsa e l'utente del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per cui aggiornare le autorizzazioni del flusso di lavoro.
Ordinamento	order	True	integer	Ordine del destinatario per cui aggiornare le autorizzazioni del flusso di lavoro.
apply_to_all	apply_to_all	True	boolean	True, se le autorizzazioni devono essere applicate a tutti i destinatari nel flusso di lavoro.
permissions	permissions	True		Dispone di tutte le autorizzazioni da consentire nel flusso di lavoro
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Aggiornare lo spazio condiviso

ID operazione:: V4_WorkSpace_UpdateSharedSpace

Le applicazioni aziendali possono usare questa API del servizio per aggiornare lo spazio condiviso. La disponibilità degli spazi condivisi per l'aggiornamento è soggetta al ruolo utente dell'organizzazione assegnato. Per consentire questo provisioning Enterprise Admin abiliterà l'opzione "Gestisci spazio condiviso" in Impostazioni documento ruoli>.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID spazio condiviso	id	True	integer	ID dello spazio condiviso da aggiornare
nome	name		string	Nome dello spazio condiviso
nome	name	True	string	Nome del membro dello spazio di lavoro
posta elettronica	email	True	string	Indirizzo di posta elettronica del membro dello spazio di lavoro

Valori restituiti

response: object

Aggiungere codice a matrice

ID operazione:: V4_QR_AddQRCode

Le applicazioni aziendali possono usare questa API di servizio per aggiungere un codice a matrice a un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
field_name	field_name		string	Nome del campo specificato da aggiungere. Se non specificato, il sistema assegnerà un nome univoco generato automaticamente al campo.
dimensions	dimensions	True		Dimensioni campo
data	data		string	Dati di testo normale da codificare nel codice a matrice. Il valore predefinito è l'URL generato per accedere al documento correlato. ad esempio {base_url}/document/{document_unique_id}
options	options			Impostazioni relative alle opzioni
color	color			Impostazioni relative al colore
logo	logo			Impostazioni relative al logo

Valori restituiti

Corpo: AddQrCodeResponse

Aggiungere gruppi al flusso di lavoro

ID operazione:: V4_Workflow_WorkflowAddGroup

Le applicazioni aziendali possono usare questa API del servizio per aggiungere gruppi come destinatari a un flusso di lavoro. Un gruppo SigningHub indica che qualsiasi membro del gruppo può eseguire l'azione, ovvero firmare, per conto di tutti i membri del gruppo.

Si noti che il gruppo verrà aggiunto come ultimo utente/gruppo nel flusso di lavoro. Di conseguenza, potrebbe essere necessario eseguire ulteriori operazioni per rimuovere un utente/gruppo corrente, già presente nel flusso di lavoro. Durante la preparazione dei documenti di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto per il quale deve essere aggiunto il gruppo.
nome_del_gruppo	group_name		string	Nome del nuovo gruppo da aggiungere nel flusso di lavoro.
email_notification	email_notification	True	boolean	L'impostazione del valore su "true" invia all'utente una notifica tramite posta elettronica quando arriva il suo turno nel flusso di lavoro. L'impostazione del relativo valore su "false" non invia la notifica tramite posta elettronica all'utente al suo turno. Se non viene specificato alcun valore, verrà impostato il valore predefinito "true".
ruolo	role	True		Ruolo del gruppo come destinatario nel flusso di lavoro. Il valore possibile è "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" e "INPERSON_HOST". Tuttavia, mentre la preparazione del documento di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordine in cui il flusso di lavoro verrà firmato dai destinatari. Questo ordine di firma è importante quando il tipo di flusso di lavoro è impostato su "CUSTOM".

Valori restituiti

response: array of CollaboratorGroupResponse

Aggiungere o aggiornare un documento dalla raccolta

ID operazione:: V4_Documents_UploadFromLibrary

Le applicazioni aziendali possono usare questa API di servizio per aggiungere un documento dalla raccolta dell'utente a un pacchetto. L'ID pacchetto viene fornito nell'URL, l'ID del documento deve essere fornito anche come "document_id" nell'URL della risorsa per identificare il documento della raccolta da copiare.

Si noti che un pacchetto deve esistere già prima di poter aggiungere un documento usando questa chiamata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento della raccolta che deve essere aggiunto/aggiornato
ID documento precedente	x-document-id		string	ID del documento precedente del pacchetto corrente che deve essere aggiornato

Valori restituiti

Corpo: UploadDocumentLibraryResponse

Aggiungere segnaposto al flusso di lavoro

ID operazione:: V4_Workflow_WorkflowAddPlaceholder

Le applicazioni aziendali possono usare questa API di servizio per aggiungere segnaposto a un flusso di lavoro in un pacchetto. Un segnaposto è obbligatorio quando non si conosce l'identità del destinatario previsto in un flusso di lavoro.

Si noti che il segnaposto verrà aggiunto come ultimo utente nel flusso di lavoro. Di conseguenza, potrebbe essere necessario eseguire ulteriori operazioni per rimuovere un utente/gruppo corrente, già presente nel flusso di lavoro.

L'aggiunta di un segnaposto consente di procedere e aggiungere campi di firma e/o di input al documento, che possono quindi essere assegnati a singoli utenti in una fase successiva. Durante la preparazione dei documenti di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto per il quale deve essere aggiunto il segnaposto.
segnaposto	placeholder		string	Nome del nuovo segnaposto da aggiungere nel flusso di lavoro.
email_notification	email_notification	True	boolean	L'impostazione del valore su "true" invia all'utente una notifica tramite posta elettronica quando arriva il suo turno nel flusso di lavoro. L'impostazione del relativo valore su "false" non invia la notifica tramite posta elettronica all'utente al suo turno.
ruolo	role	True		Ruolo del gruppo come destinatario nel flusso di lavoro. Il valore possibile è "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" e "INPERSON_HOST". Tuttavia, mentre la preparazione del documento di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordine in cui il flusso di lavoro verrà firmato dai destinatari. Questo ordine di firma è importante quando il tipo di flusso di lavoro è impostato su "CUSTOM".

Valori restituiti

response: array of CollaboratorPlaceholderResponse

Aggiungere utenti al flusso di lavoro

ID operazione:: V4_Workflow_WorkflowAddUser

Le applicazioni aziendali possono usare questa API del servizio per aggiungere destinatari a un flusso di lavoro. Questa chiamata aggiungerà solo un destinatario al flusso di lavoro. Ovvero, nessun campo attualmente presente nel documento verrà assegnato automaticamente ai nuovi destinatari, né verrà creato alcun nuovo campo.

Si noti che i destinatari verranno aggiunti come ultima persona nel flusso di lavoro. Di conseguenza, potrebbe essere necessario eseguire ulteriori operazioni per rimuovere uno o più destinatari correnti già presenti nel flusso di lavoro.

Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento.

Si noti che l'input accetta uno o più utenti in una singola chiamata.

In questa chiamata specifica l'utente è una persona fisica nota. Tuttavia, le stesse regole si applicano ai gruppi e ai segnaposto. In uno di questi casi il destinatario diventa un gruppo di utenti in cui qualsiasi membro del gruppo può firmare il documento o un segnaposto. Quest'ultimo caso viene utilizzato quando non si conosce l'identità del firmatario previsto.

Nota L'ordine di firma del flusso di lavoro SigningHub inizia da "1". Di conseguenza, l'aggiunta di un utente al flusso di lavoro senza destinatari correnti inizia un nuovo conteggio degli ordini di firma. Il parametro "signing_order" è obbligatorio se il tipo di flusso di lavoro è "custom".

Importante, l'uso di questa chiamata API può influire sul tipo di flusso di lavoro. Se sono presenti destinatari correnti in un flusso di lavoro sequenziale e ne viene aggiunto uno nuovo con lo stesso ordine di firma di un destinatario corrente, tale parte del flusso di lavoro cambia automaticamente da sequenziale a parallela. Di conseguenza, il flusso di lavoro è ora di tipo personalizzato anziché puramente sequenziale. L'aggiunta di un destinatario con lo stesso ordine di firma di due o destinatari paralleli non modifica il flusso di lavoro. Ci sono semplicemente tre o più destinatari in quel particolare punto del flusso di lavoro; tutto in ordine parallelo.

Si noti che, mentre la preparazione del documento di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto SigningHub a cui devono essere aggiunti i destinatari.
user_email	user_email		string	Indirizzo di posta elettronica dell'utente da aggiungere nel flusso di lavoro.
user_name	user_name	True	string	Nome del destinatario da aggiungere nel flusso di lavoro.
user_national_id	user_national_id		string	ID nazionale utente del destinatario
email_notification	email_notification	True	boolean	Se impostato su true, SigningHub invierà notifiche all'utente tramite posta elettronica in base alle impostazioni di notifica utente e proprietario del documento. Il valore false indica che nessuna notifica verrà inviata all'utente in tutto il flusso di lavoro.
ruolo	role	True		Ruolo del destinatario nel flusso di lavoro. I valori possibili sono "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" o "INPERSON_HOST". Tuttavia, mentre la preparazione del documento di tipo XML, solo i tipi di ruolo supportati sono "SIGNER", "REVIEWER" e "CARBON_COPY"
signing_order	signing_order		integer	Ordine del destinatario nel flusso di lavoro. Questo ordine di firma è obbligatorio quando il tipo di flusso di lavoro è "CUSTOM".
delivery_method	delivery_method	True		Metodo di recapito del destinatario nel flusso di lavoro. I valori possibili sono "EMAIL", "SMS" o "EMAIL_AND_SMS". Il valore predefinito sarà EMAIL
mobile_number	mobile_number		string	Numero di cellulare

Valori restituiti

response: array of CollaboratorResponse

Aggiungi campo CheckBox

ID operazione:: V4_Checkbox_AddCheckBox

Le applicazioni aziendali possono usare questa API del servizio per aggiungere una casella di controllo a un documento in un pacchetto.

Almeno un utente deve esistere in un flusso di lavoro prima che i campi (input e firma) possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro.

Per altre informazioni, vedere Aggiungere utenti al flusso di lavoro . Si noti che se è stato applicato un documento con un modello o se ne è stato applicato uno usando le API, il flusso di lavoro conterrà già gli utenti.

Se non vengono specificati parametri di larghezza e altezza, verrà assegnata una dimensione predefinita di 10x10. Se viene specificata una larghezza o un'altezza (o entrambe), il sistema confronta questi valori forniti tra loro. Il valore maggiore tra larghezza e altezza verrà assegnato a entrambe le dimensioni.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
order	order	True	integer	Ordine dell'utente nel flusso di lavoro per il quale viene aggiunto il campo.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
field_name	field_name		string	Nome del campo specificato da aggiungere. Se non specificato, il sistema assegnerà un nome univoco generato automaticamente al campo.
valore	value		string	Valore del campo. I valori possibili sono "true" o "false"
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
validation_rule	validation_rule		string	Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".

Valori restituiti

Corpo: AddFieldResponse

Aggiungi campo firma digitale

ID operazione:: V4_Signature_AddSignature

Le applicazioni aziendali possono usare questa API di servizio per aggiungere un campo di firma digitale a un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per il quale è necessario aggiornare i dettagli del flusso di lavoro.
ID documento	documentId	True	integer	ID documento in cui aggiungere il campo.
order	order	True	integer	Ordine del destinatario per il quale viene creato il campo.
page_no	page_no	True	integer	Numero di pagina in corrispondenza del quale il campo sta per essere creato.
field_name	field_name		string	Nome del campo da aggiungere. Se non specificato, il sistema assegnerà un nome univoco generato automaticamente al campo.
level_of_assurance	level_of_assurance		array of string	Livello di garanzia da aggiungere. I valori possibili sono "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
schermo	display		string	Visibilità del campo da aggiungere, i valori possibili sono "VISIBLE" e "INVISIBLE"
authentication_signing	authentication_signing			Autenticazione sul campo

Valori restituiti

Corpo: SignatureFieldResponse

Aggiungi campo iniziale

ID operazione:: V4_Initials_AddInitial

Le applicazioni aziendali possono usare questa API di servizio per aggiungere un campo iniziale a un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
order	order	True	integer	Ordine dell'utente nel flusso di lavoro per il quale viene aggiunto il campo.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
field_name	field_name		string	Nome del campo da aggiungere. Se non specificato, il sistema assegnerà un nome univoco generato automaticamente al campo.
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.

Valori restituiti

Corpo: AddFieldResponse

Aggiungi campo RadioBox

ID operazione:: V4_Radio_AddRadioBox

Le applicazioni aziendali possono usare questa API del servizio per aggiungere una casella di controllo a un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
order	order	True	integer	Ordine dell'utente nel flusso di lavoro per il quale viene aggiunto il campo.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
field_name	field_name		string	Nome del campo specificato da aggiungere. Se non specificato, il sistema assegnerà un nome univoco generato automaticamente al campo.
valore	value		string	Valore del campo. I valori possibili sono "true" o "false"
validation_rule	validation_rule	True		Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
radio_group_name	radio_group_name	True	string
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.

Valori restituiti

Corpo: AddFieldResponse

Aggiungi campo TextBox

ID operazione:: V4_TextBox_AddTextBox

Le applicazioni aziendali possono usare questa API di servizio per aggiungere un campo di input di testo a un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
order	order	True	integer	Ordine dell'utente nel flusso di lavoro per il quale viene aggiunto il campo.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
type	type	True		Il tipo di campo, i valori possibili sono "TEXT", "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Tutti i campi di testo altri quindi TEXT vengono compilati automaticamente in modalità in sospeso con gli attributi o i dati del destinatario.
valore	value		string	Valore del campo. Per type = DATE, il valore deve seguire il formato ISO 8601. Dopo il formato AAAA-MM-DD hh:mm:ss +00. Poiché i valori sono per i campi data le applicazioni client possono inviare YYYY-MM-DD e ignorare hh:mm:ss +00. Se il valore non è nel formato corretto, verrà restituito un errore.
segnaposto	placeholder		string	Testo segnaposto per il campo di testo. Per nome, posta elettronica, società, posizione e data, il valore segnaposto può essere "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Gli sviluppatori possono inviare segnaposto personalizzati per sovrascrivere i valori predefiniti. Per gli sviluppatori "TEXT" possono fornire un proprio testo segnaposto. Questi segnaposto vengono visualizzati nei campi di testo durante la visualizzazione del documento nel visualizzatore.
lunghezza_massima	max_length	True	integer	Lunghezza massima del valore consentito nel campo. Deve essere compreso tra 1 e 9999
format	format		string	Formato testo del campo. Utilizzato solo per il campo tipo di data. I valori possibili sono m/d m/d/yy m/d/aaaaa mm/gg/yy mm/gg/aaaa mm/yy mm/aaaaa d-mmm d-mmm-yy gg-mmm-aaa gg-mmm-yy gg-mmm-yyyy yy-mm-dd aaaa-mm-gg mmm-yy mmm-yyyy mmmm-yy mmmm-aaa mmmm d, aaaaa gg/mm/yy ddmmmyyy
field_name	field_name		string	Nome del campo da aggiungere. Se non specificato, il sistema assegnerà un nome univoco generato automaticamente al campo.
field_locale	field_locale		string	Campo locale. I valori possibili sono ar-AE \| en-US. Facoltativo e predefinito sarà en-US. Questo valore è importante per il tipo "DATE".
field_type	field_type	True		Il tipo di campo rispetto all'accettazione del tipo di valori, i valori possibili sono "NUMBER" o "TEXT".
validation_rule	validation_rule	True		Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
convalida	validation			Validations
font	font	True		Tipo di carattere del testo dei campi
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
multilinea	multiline	True	boolean	Se impostato su true, verrà creato il campo dell'area di testo

Valori restituiti

Corpo: AddFieldResponse

Aggiungi pacchetto

ID operazione:: V4_Package_AddPackage

Questa API del servizio viene usata per aggiungere/creare un pacchetto di documento per contenere uno o più documenti. Questo pacchetto può quindi essere usato per aggiungere documenti e destinatari per avviare un nuovo flusso di lavoro.

Come indicato in precedenza, questa chiamata è obbligatoria se si desidera lavorare con i documenti. Un pacchetto deve esistere prima di poter caricare o aggiungere documenti a SigningHub..

Anche un singolo documento fa parte di un pacchetto: un pacchetto contenente un documento.

Nota: un pacchetto può essere rinominato se necessario dopo la creazione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
package_name	package_name		string	Nome del pacchetto. Il nome predefinito del pacchetto è sempre "Senza titolo" se il package_name non viene specificato.
workflow_mode	workflow_mode	True		La modalità del flusso di lavoro include tre tipi di modalità del flusso di lavoro supportate nell'applicazione. I valori possibili sono "ONLY_ME", "ME_AND_OTHERS" e "ONLY_OTHERS"
folder_name	folder_name		string	Nome della cartella. Verrà usato per caricare il pacchetto in qualsiasi cartella dell'utente, ovvero una cartella personalizzata o una cartella condivisa.

Valori restituiti

Corpo: AddPackageResponse

Applica modello flusso di lavoro

ID operazione:: V4_Workflow_ApplyTemplate

Le applicazioni aziendali possono usare questa API di servizio per applicare un modello di flusso di lavoro a un documento. L'ID documento sul quale deve essere applicato il modello viene fornito nell'URL della risorsa. Quando l'ID documento è impostato su 0, il modello verrà applicato a tutti i doucments in un pacakge.

Durante l'applicazione del modello è importante ricordare questi due punti importanti:

Punto 1: se il modello applicato viene creato utilizzando un PDF che contiene già campi modulo, assicurarsi che il documento in cui questo modello sia applicato deve contenere in anticipo questi campi modulo e SigningHub non creerà tali campi modulo tramite il modello, ma applica solo i dati del modulo e assegna ai rispettivi utenti.

Punto 2: se il modello applicato viene creato in cui i campi modulo vengono aggiunti manualmente (quindi non presenti in origine nel PDF) tramite SigningHub, ad esempio il campo della firma iniziale, la firma di persona, le caselle di opzione, i pulsanti di opzione, i campi di testo e così via, quando si applica tale modello, questi campi modulo verranno creati nel documento di destinazione anche se questi campi modulo erano già presenti nel documento di destinazione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui deve essere applicato il modello.
ID documento	documentId	True	integer	ID documento in cui deve essere applicato il modello. Se il valore è impostato su 0, se il modello deve essere applicato a tutti i documenti del pacchetto.
template_name	template_name	True	string	Nome del modello da applicare al documento.
apply_to_all	apply_to_all	True	boolean	True, se il modello deve essere applicato a tutti i documenti nel pacchetto.

Valori restituiti

Corpo: DocumentDetailsResponse

Approvare il documento

ID operazione:: V4_Package_Approve

Le applicazioni aziendali possono usare questa API di servizio per approvare un documento da parte di un utente specificato nell'ordine.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da approvare.
reason	reason		string	Motivo dell'approvazione di un pacchetto.
Password di accesso ai documenti	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
Document One-Time Password	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Assegnare un campo documento

ID operazione:: V4_Fields_AutoAssignField

Le applicazioni aziendali possono usare questa API del servizio per assegnare gli utenti ai campi di input, ad esempio campi di firma e quindi definire l'ordine di firma. I campi devono essere già presenti nel documento e gli utenti devono essere presenti nel flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa, insieme all'identificatore del pacchetto.

Quando i destinatari si trovano in un flusso di lavoro, vengono numerati, a partire da uno e contando per ognuno di essi aggiuntivi. Pertanto, se sono presenti tre utenti in un flusso di lavoro, sono numerati "1", "2" e "3" rispettosamente. Questa chiamata API consente di assegnare un utente in base al numero di ordine del flusso di lavoro, a un campo di input nel documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale l'utente del flusso di lavoro deve essere aggiornato.
field_name	field_name	True	string	Nome del campo della firma da assegnare.
radio_group_name	radio_group_name		string	specificare il nome del gruppo per la casella di opzione
order	order	True	integer	Ordine dell'utente nel flusso di lavoro a cui viene assegnato il campo.
level_of_assurance	level_of_assurance		array of string	Livello di garanzia da aggiungere. I valori possibili sono "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

Valori restituiti

response: object

Campi di autosostituimento

ID operazione:: V4_Fields_AutoPlace

Le applicazioni aziendali possono chiamare questa API per aggiungere campi di modulo definiti dall'utente o firma a un documento in base al criterio di ricerca fornito. Le opzioni di posizionamento sono: a sinistra, a destra, in alto e in basso. Il documento viene cercato e vengono elaborate tutte le istanze dei criteri di ricerca soddisfatti. In questo modo è possibile aggiungere più campi con una sola chiamata. Ad esempio, caricare un documento e inserire automaticamente un campo di firma a destra di tutte le istanze della parola "Sign here:". Ciò consente di risparmiare tempo e garantisce che non vengano perse firme dal flusso di lavoro.

La chiamata API supporta tutti i tipi di campi; ovvero elettronica, digitale, in persona, iniziali, campo di testo e così via.

Inoltre, la chiamata API supporta la variabile "order". Ciò significa che è possibile assegnare automaticamente un set di campi di firma a un singolo utente. Di conseguenza, la chiamata può essere ripetuta per inserire e assegnare campi di firma a più utenti nel flusso di lavoro.

Almeno un utente deve esistere in un flusso di lavoro prima che i campi della firma possano essere aggiunti al documento in questo modo. Il numero di ordine corrisponde al destinatario nel flusso di lavoro. Pertanto, questo numero deve essere uguale o minore del numero totale di utenti nel flusso di lavoro. Nell'esempio seguente questo nuovo campo della firma viene assegnato alla prima persona nel flusso di lavoro.

Questa chiamata API può essere usata più volte nello stesso documento. Il motivo di questa operazione è quello di soddisfare più firmatari su un documento. Il destinatario o il firmatario è identificato dalla variabile "order" passata nella chiamata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento per il quale vengono richiesti i campi.
search_text	search_text		string	Word che deve essere eseguita la ricerca nel documento.
order	order	True	integer	Ordine dell'utente a cui verranno assegnati automaticamente i campi. Flusso di lavoro in SigningHub ordini destinatari. Questo elenco inizia con "1" per il primo firmatario designato.
collocamento	placement		string	Se il testo viene trovato, i campi devono essere inseriti nel documento. La posizione del campo può essere menzionata in questo attributo. I valori possibili di posizionamento di un campo sono LEFT, RIGHT, TOP, BOTTOM. Se non viene specificato alcun valore, il valore predefinito sarà LEFT.
field_type	field_type		string	Tipo di campo da creare nel documento. I valori possibili sono "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"
level_of_assurance	level_of_assurance		array of string	Livello di garanzia da aggiornare. I valori possibili sono "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
dimensions	dimensions			Dimensioni di un campo da creare nel documento. La posizione X e Y vengono calcolate automaticamente. L'API può configurare solo la larghezza e l'altezza per il campo. Se le dimensioni non sono specificate, verranno seguite le dimensioni predefinite. che è 200 x 80 in pixel.
segnaposto	placeholder		string	Specificare la nota nel caso di allegato obbligatorio
radio_group_name	radio_group_name		string	Il nome del gruppo è obbligatorio solo quando si aggiunge un campo Tipo casella di opzione per raggruppare più caselle radio.
format	format		string	Formato testo del campo. Utilizzato solo per il campo tipo di data. I valori possibili sono m/d m/d/yy m/d/aaaaa mm/gg/yy mm/gg/aaaa mm/yy mm/aaaaa d-mmm d-mmm-yy gg-mmm-aaa gg-mmm-yy gg-mmm-yyyy yy-mm-dd aaaa-mm-gg mmm-yy mmm-yyyy mmmm-yy mmmm-aaa mmmm d, aaaaa gg/mm/yy ddmmmyyy
valore	value		string	Valore che l'utente desidera visualizzare nel campo.
lunghezza_massima	max_length	True	integer	Lunghezza massima del valore consentito nel campo. Deve essere compreso tra 1 e 9999
validation_rule	validation_rule		string	Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
convalida	validation			Validations
font	font			Tipo di carattere del testo dei campi
multilinea	multiline	True	boolean	Appartiene al tipo di campo Area di testo e se impostato su true, il campo dell'area di testo verrà creato con l'opzione multilinea.

Valori restituiti

response: array of AutoPlaceFieldsResponse

Campi modulo di riempimento

ID operazione:: V4_Fields_FillFormFields

Le applicazioni aziendali possono usare questa API di servizio per compilare uno o più campi modulo in un documento da parte di un utente specificato nell'ordine.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento.
auto_save	auto_save	True	boolean	Il valore predefinito è false. True, se i campi modulo vengono salvati senza l'intervento dell'utente, ad esempio quando si chiude il documento o si preme indietro. Per Firma, Iniziali, Utenti, Revisione, Invio azioni il valore è false.
field_name	field_name	True	string	Identificatore univoco del campo nel documento.
valore	value		string	Valore del campo da salvare nel documento.
field_name	field_name	True	string	Identificatore univoco del campo nel documento.
radio_group_name	radio_group_name		string	Nome del gruppo a cui appartiene il pulsante di opzione.
valore	value	True	boolean	Valore del campo da salvare nel documento.
field_name	field_name	True	string	Identificatore univoco del campo nel documento.
valore	value	True	boolean	Valore del campo da salvare nel documento.
field_name	field_name	True	string	Identificatore univoco del campo nel documento.
valore	value		string	Valore del campo da salvare nel documento.
field_name	field_name	True	string	Identificatore univoco del campo nel documento.
valore	value		string	Valore del campo da salvare nel documento.
Password documento	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
One-Time password (OTP)	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Campo Componente aggiuntivo persona

ID operazione:: V4_InPerson_AddInPerson

Le applicazioni aziendali possono usare questa API del servizio per un campo di firma di persona aggiunto a un documento in un pacchetto.

Per ospitare una riunione di persona, un utente di SigningHub deve far parte del flusso di lavoro. Devono essere aggiunti con role "INPERSON_HOST" o "SIGNER". Per l'opzione host che non richiedono una firma o un campo di input nel documento e il campo della firma di persona può essere firmato dall'utente registrato non SigningHub.

Si noti che si tratta di uno scenario speciale del flusso di lavoro in cui si prevede che l'utente e il destinatario di SigningHub si troverebbero nella stessa posizione. Questo tipo di firma non è destinato all'uso in base al quale un documento viene condiviso con i destinatari tramite collegamento di posta elettronica nel normale metodo di integrazione libero.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
order	order	True	integer	Ordine dell'utente nel flusso di lavoro per il quale viene aggiunto il campo.
page_no	page_no	True	integer	Numero di pagina in cui creare il campo.
field_name	field_name		string	Nome del campo da aggiungere. Se non specificato, il sistema assegnerà un nome univoco generato automaticamente al campo.
segnaposto	placeholder	True	string	Identificatore stringa per il campo di rappresentazione, può essere Cliente, Jack, CEO e così via.
x	x	True	double	Posizione sinistra del campo in pixel.
y	y	True	double	Posizione superiore del campo in pixel.
larghezza	width	True	double	Larghezza del campo in pixel.
altezza	height	True	double	Altezza del campo in pixel.
schermo	display		string	Visibilità del campo da aggiungere, i valori possibili sono "VISIBLE" e "INVISIBLE"
level_of_assurance	level_of_assurance		array of string	Livello di garanzia da aggiornare. I valori possibili sono "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
authentication_signing	authentication_signing			Autenticazione sul campo

Valori restituiti

Corpo: AddFieldResponse

Carica allegato

ID operazione:: V4_Attachment_UploadAttachment

Le applicazioni aziendali possono usare questa API di servizio per caricare un allegato in un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento a cui deve essere aggiunto l'allegato.
File allegato	file (binary Stream)		binary	Questo è il documento in formato binario non elaborato.
Nome campo	x-field-name		string	Nome campo, se necessario. Questo campo è facoltativo e con il campo allegato nome campo viene elaborato. Inoltre, il valore consigliato per il parametro nome campo è in formato con codifica Base64.
Nome del file	x-file-name	True	string	È il nome del file con estensione.
Password documento	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
One-Time Password	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

Corpo: AddAttachmentResponse

Carica documento

ID operazione:: V4_Documents_UploadStream

Le applicazioni aziendali possono usare questa API di servizio per aggiungere un documento a un pacchetto di documenti collegato all'account di un utente aziendale. Le informazioni sul documento vengono inviate nell'intestazione della richiesta HTTP e i byte dei documenti vengono inviati nel corpo della richiesta HTTP. Nota SigningHub convertirà i formati di documento supportati in PDF se l'intestazione "x-convert-document" è impostata su "true". L'unico caso supportato in cui questo valore è impostato su "false" consiste nel conservare Word formato e documenti XML.

SigningHub supporta un'ampia gamma di formati di documento, ognuno dei quali può essere convertito in formato PDF al caricamento. Fare clic qui per l'elenco completo.

Nota I documenti PDF non vengono modificati al caricamento nel sistema.

Si noti che un pacchetto deve esistere già prima di poter aggiungere un documento usando questa chiamata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
Documento (flusso binario)	file (binary Stream)		binary	Questo è il documento in formato binario non elaborato.
Nome del file	x-file-name		string	È il nome del file con estensione.
Converti documento	x-convert-document		string	Indica se convertire il documento in un PDF o se deve essere conservato nel formato originale. Tieni presente che l'unico formato originale supportato è attualmente Word e XML. Tutti gli altri tipi di documento genereranno un errore se il valore dell'intestazione è impostato su "false". Se si carica un documento PDF, è possibile omettere l'intestazione.
Source	x-source		string	Si tratta dell'identificazione dell'origine del documento da cui viene caricato il documento, ad esempio "App personale".

Valori restituiti

Corpo: UploadDocument

Compilare le iniziali

ID operazione:: V4_Initials_Fill

Le applicazioni aziendali possono usare questa API di servizio per compilare un campo iniziale in un documento da parte di un utente specificato nell'ordine.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento.
field_name	field_name	True	string	Identificatore univoco del campo nel documento.
image	image	True	string	Immagine Base64 usata per il riempimento delle iniziali.
method	method			Nome del metodo di firma manuale da parte dell'utente per la firma. Se non viene specificato alcun metodo di firma manuale, il valore predefinito sarà DRAW. valori possibili DRAW,TEXT,UPLOAD,SIGNATURE_PAD
apply_to_all	apply_to_all	True	boolean	True se devono essere compilate tutte le iniziali.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Completare l'elaborazione

ID operazione:: V4_Package_Finish

Le applicazioni aziendali possono usare questa API di servizio per completare l'elaborazione dei documenti dopo la firma di tutti i campi della firma. Questo metodo viene usato principalmente dalle app native SigningHub per dispositivi mobili per iOS e Android e dai casi d'uso Web per dispositivi mobili. Le applicazioni aziendali generali che usano una stretta integrazione nel rispettivo portale non devono chiamare questo metodo. Tuttavia, quando si usa l'API Firma documento (e quindi l'utente non viene presentato con una rappresentazione visiva del documento richiesto per firmare) la chiamata a questa API è necessaria per garantire che il rispettivo flusso di lavoro continui o venga completato. Ad esempio, dopo che tutte le firme sono state applicate usando l'API del documento di firma "blind" chiamano il documento, il documento non verrà visualizzato come stato "Completato" al proprietario fino a quando non viene richiamata questa API. Il proprietario del documento visualizzerà lo stato "In corso" fino a quando questa API non viene chiamata.

All'interno di app native SigningHub per dispositivi mobili e casi d'uso Web per dispositivi mobili, questa chiamata è necessaria per garantire che ogni utente completi le rispettive azioni rispetto a SigningHub.Ad esempio, dopo che un firmatario ha firmato un documento nell'app SigningHub, questo metodo viene richiamato dall'applicazione per garantire che il flusso di lavoro continui a essere elaborato e il successivo firmatario riceve una notifica, e lo stato del documento è disponibile tramite l'URL di callback configurato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da completare.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Condividi pacchetto documento

ID operazione:: V4_Workflow_StartWorkflow

Le applicazioni aziendali possono usare questa API del servizio per condividere un pacchetto di documenti con i firmatari e avviare un nuovo flusso di lavoro. Il documento dovrebbe essere già stato preparato applicando un modello e, facoltativamente, aggiornando gli utenti e le azioni definiti nel modello. L'ID del pacchetto da condividere viene fornito nell'URL della risorsa.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	Pacchetto del documento da condividere.

Valori restituiti

response: array of StartWorkflowResponse

Documento di approvazione di Gatekeeper

ID operazione:: V4_Package_GatekeeperApprove

Le applicazioni aziendali possono usare questa API del servizio per approvare un documento da parte di un utente specificato nell'ordine.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da approvare.
reason	reason		string	Motivo dell'approvazione di un pacchetto.
Password di accesso ai documenti	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
Document One-Time Password	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.

Valori restituiti

response: object

Documento di rifiuto di Gatekeeper

ID operazione:: V4_Package_GatekeeperDecline

Le applicazioni aziendali possono usare questa API del servizio per rifiutare un documento da parte di un utente specificato nell'ordine.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da rifiutare.
reason	reason		string	Motivo fornito dall'utente per rifiutare.

Valori restituiti

response: object

Documento richiamo

ID operazione:: V4_Workflow_RecallWorkflow

Le applicazioni aziendali possono usare questa API del servizio per arrestare un flusso di lavoro in corso. L'ID documento viene fornito nell'URL della risorsa. Dopo aver richiamato lo stato del documento cambia automaticamente in "DRAFT".

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da richiamare.

Valori restituiti

response: object

Elimina allegato

ID operazione:: V4_Attachment_DeleteAttachment

Le applicazioni aziendali possono usare questa API di servizio per eliminare l'allegato di un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento a cui viene aggiunto l'allegato.
ID allegato	attachment_id	True	integer	ID dell'allegato.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Elimina campo documento

ID operazione:: V4_Fields_DeleteDocumentField

Le applicazioni aziendali possono usare questa API di servizio per eliminare un campo di documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale deve essere eseguita l'azione.
field_name	field_name	True	string	Nome del campo da eliminare.

Valori restituiti

response: object

Elimina pacchetto

ID operazione:: V4_Package_DeletePackage

Le applicazioni aziendali possono usare questa API del servizio per eliminare un documento dalla posta in arrivo dell'utente. L'ID pacchetto viene fornito nell'URL della risorsa come "{package_id}". Se lo stato del documento è IN SOSPESO, viene automaticamente rifiutato in seguito all'operazione di eliminazione. Se lo stato del documento è SHARED, il documento viene richiamato automaticamente e il flusso di lavoro viene arrestato prima dell'eliminazione del documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId_bulkAction	True	integer	ID pacchetto del pacchetto che contiene il documento.

Valori restituiti

response: object

Elimina spazio condiviso

ID operazione:: V4_WorkSpace_DeleteSharedSpace

Le applicazioni aziendali possono usare questa API del servizio per eliminare lo spazio condiviso. La disponibilità dell'eliminazione di spazi condivisi è soggetta al ruolo utente dell'organizzazione assegnato. Per consentire questo provisioning Enterprise Admin abiliterà l'opzione "Gestisci spazio condiviso" in Impostazioni documento ruoli>.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID spazio condiviso	id	True	integer	ID dello spazio condiviso da eliminare

Valori restituiti

response: object

Eliminare l'utente del flusso di lavoro

ID operazione:: V4_Workflow_WorkflowDeleteUser

Le applicazioni aziendali possono usare questa API del servizio per eliminare il destinatario del flusso di lavoro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da cui deve essere eliminato il destinatario.
Ordinamento	order	True	integer	Ordine del destinatario nel flusso di lavoro da eliminare.

Valori restituiti

response: object

Eliminare un documento

ID operazione:: V4_Documents_DeleteDocument

Le applicazioni aziendali possono usare questa API di servizio per eliminare un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento da eliminare.

Valori restituiti

Corpo: DocumentResponse

Firma documento

ID operazione:: V4_Signing_SignDocument

Le applicazioni aziendali possono usare questa API del servizio per firmare un documento (sia elettronico che digitale) senza visualizzare il documento all'utente finale usando SigningHub. Ad esempio, un'applicazione aziendale può avere un altro metodo per visualizzare il documento all'utente e solo la funzionalità di firma di SigningHub è necessaria oppure per le operazioni bulk può essere giustificato firmare senza richiedere all'utente di visualizzare e approvare singolarmente ogni documento. Se sono presenti modifiche da salvare nel documento prima della firma, è necessario chiamare l'API Campi modulo di riempimento prima di chiamare l'API Firma documento. Si noti che tutti i campi di input obbligatori in un documento richiedono il completamento prima del completamento dell'API.

Il firmatario è identificato dal token di accesso presentato nella chiamata. Pertanto, l'autenticazione del firmatario è necessaria prima di effettuare questa chiamata. Non è possibile eseguire l'autenticazione come amministratore dell'organizzazione con la variabile di ambito e firmare un documento per conto di un utente. Il token di accesso deve essere rilasciato al firmatario in seguito all'autenticazione diretta.

Quando questa chiamata viene completata, è importante che se il firmatario è l'ultimo firmatario per un documento richiamato dalla chiamata ALL'API Fine documento . Il motivo è dovuto al fatto che senza chiamare tale API il documento rimarrà in stato "In corso" al proprietario del documento. Dopo aver chiamato l'API, lo stato passerà a "Completato" per il proprietario del documento.

Dopo la firma del documento, la risposta di verifica può essere visualizzata dall'API Recupera verifica documento .

Utilizzo OTP primo o secondo fattore per l'autenticazione

Se l'autenticazione OTP è attivata per l'operazione di firma lato server, le applicazioni client dovranno generare un OTP per il numero di cellulare usando l'autenticazione del firmatario tramite chiamata API OTP. Le rispettive applicazioni aziendali devono recuperare il codice OTP dall'uso e inviarlo durante l'esecuzione della chiamata API. Questa operazione viene eseguita usando l'intestazione "x-otp" nella richiesta.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	Identificatore del pacchetto che contiene il documento per la firma.
ID documento	documentId	True	integer	Identificatore del documento da firmare.
field_name	field_name	True	string	Identificatore univoco del campo della firma nel documento.
hand_signature_image	hand_signature_image		string	Immagine stringa con codifica Base64 dell'aspetto della firma visibile, che viene inserita nel documento. Si noti che questa operazione può essere recuperata dalle impostazioni personali dell'utente usando questa chiamata. La risposta è binaria, quindi l'applicazione aziendale deve codificarla in Base64 prima di inviarla in questa chiamata API.
hand_signature_method	hand_signature_method			Nome del metodo di firma manuale da parte dell'utente per la firma. Se non viene specificato alcun metodo di firma manuale, il valore predefinito sarà DRAW.
signing_reason	signing_reason		string	Motivo della firma fornita dal destinatario. Nota: indicazione del tipo di impegno per i documenti XML
signing_location	signing_location		string	Impostazioni locali del firmatario fornito dal destinatario.
contact_information	contact_information		string	Informazioni di contatto del firmatario fornito dal destinatario.
user_name	user_name		string	Nome del firmatario fornito dal destinatario. Si noti che si applica solo alle operazioni di firma di persona.
user_password	user_password		string	Password fornita dall'utente soggetto alle impostazioni di firma dell'utente.
appearance_design	appearance_design		string	Nome dell'aspetto della firma fornito dall'utente per la firma. Se non viene specificato alcun nome di aspetto, verrà usato l'aspetto selezionato predefinito. I valori possibili sono "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE"
signing_capacity	signing_capacity		string	Nome della capacità di firma/profilo di certificazione con cui il documento deve essere firmato. Se non viene specificata la capacità predefinita, verrà usata per firmare. Il nome specificato deve essere esattamente uguale al profilo effettivo a causa della distinzione tra maiuscole e minuscole.
skip_verification	skip_verification	True	boolean	Non viene restituita alcuna verifica della firma nel corpo della risposta quando è impostata su true. Valore predefinito per questo parametro impostato su false.
signing_server	signing_server		string	Nome del server di firma che utilizza il documento da firmare.
autenticazione	authentication			L'oggetto di autenticazione è facoltativo e contiene opzioni di autenticazione rilecate
One-Time password (OTP)	x-otp		string	OTP usato come seconda autenticazione a fattori per l'operazione di firma.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.
Origine mobile	x-mobile		string	Definire l'originator(Web/Mobile) della richiesta/azione

Valori restituiti

Corpo: SignDocumentResponse

Flusso di lavoro completo nel centro (termina flusso di lavoro)

ID operazione:: V4_Workflow_MarkWorkflowCompleted

Le applicazioni aziendali possono contrassegnare il flusso di lavoro completato anche al centro del flusso di lavoro. Usare questa API del servizio per modificare lo stato del flusso di lavoro in modo che sia completato. Se sono presenti destinatari che non hanno ancora firmato il documento. La firma non sarà più necessaria e non sarà più in grado di visualizzare il documento nella posta in arrivo. Il token di connessione deve appartenere al proprietario del documento o all'amministratore dell'organizzazione può usare la variabile di ambito per ottenere il token di accesso per conto del proprietario del documento per eseguire questa azione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da cui deve essere eliminato il destinatario.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Invia documento

ID operazione:: V4_Package_Submit

Uno dei ruoli SigningHub è denominato "Editor". Ciò consente a un destinatario di modificare i campi di input in un documento, ma non richiede una firma. Una volta completato, il destinatario invia le modifiche. Il pulsante usato nell'interfaccia utente grafica è denominato "Submit".

Si tratta dell'operazione equivalente per un editor per inviare le modifiche tramite una chiamata API.

Fare clic su SigningHub Roles (Ruoli di SigningHub ) per una descrizione di tutti i ruoli destinatari del flusso di lavoro disponibili.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto SigningHub che contiene il documento da inviare.
Password di accesso ai documenti	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
Document One-Time Password	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Ottenere contatti

ID operazione:: V4_Contacts_Get

Le applicazioni aziendali possono usare questa API di servizio per ritirare i contatti sia da contatti personali che aziendali per l'utente corrente.

È possibile eseguire ricerche in base al criterio fornito nell'intestazione "x-search-text". Inoltre, è possibile cercare i contatti specifici di un utente o quella dell'azienda a cui appartiene l'utente.

Le informazioni sulla risposta di ricerca contengono l'indirizzo di posta elettronica dell'utente e il rispettivo nome utente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Record per pagina	recordPerPage	True	integer	Numero totale di record da recuperare in una pagina.
Numero pagina	pageNo	True	integer	Numero di pagina da recuperare.
Ordina per	sort-by		string	Ordinare il risultato in base ai valori possibili indicati in precedenza.
Crescente	asc		boolean	Ordinare il set di risultati in ordine crescente o decrescente.
Cerca testo	x-search-text		string	Se necessario, cercare testo. Questo è facoltativo e senza di esso viene restituito l'intero elenco. Inoltre, il valore consigliato per il parametro di testo di ricerca è in formato con codifica Base64.
Solo contatti aziendali	x-enterprise		string	Se impostato come "true" verrà restituito solo l'elenco contatti dell'organizzazione. Nel caso di "false" verrà restituito solo l'elenco contatti dell'utente. Se non si imposta l'intestazione, verranno restituiti gli elenchi di contatti dell'organizzazione e dell'utente.
Totale record	x-total-records		string	Numero totale di record trovati con i criteri di ricerca specificati.

Valori restituiti

response: array of ContactResponse

Ottenere gli utenti del flusso di lavoro

ID operazione:: V4_Workflow_GetWorkflowUsers

Le applicazioni aziendali possono usare questa API del servizio per ottenere i dettagli del flusso di lavoro per il pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da scaricare.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: array of WorkflowRecipient

Ottenere i criteri di certificazione per un documento

ID operazione:: V4_Documents_GetCertifyPolicy

Le applicazioni aziendali possono usare questa API di servizio per certificare le impostazioni di firma di un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento da scaricare.

Valori restituiti

Corpo: CertifyPolicyResponse

Ottenere i dettagli del documento

ID operazione:: V4_Documents_GetDocumentDetails

Le applicazioni aziendali possono usare questa API di servizio per ottenere i dettagli del documento. L'ID documento viene fornito nell'URL come "{document_id}".

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID documento per il quale sono richiesti i dettagli del documento.
Password documento	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
One-Time password (OTP)	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

Corpo: DocumentDetailsResponse

Ottenere i dettagli del flusso di lavoro

ID operazione:: V4_Workflow_GetWorkflowDetail

Le applicazioni aziendali possono usare questa API del servizio per ottenere i dettagli del flusso di lavoro per il pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da scaricare.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

Corpo: WorkflowDetailsResponse

Ottenere i dettagli del pacchetto

ID operazione:: V4_Package_GetPackageDetails

Le applicazioni aziendali possono usare questa API del servizio per ottenere i dettagli di un pacchetto. Questa API può essere usata anche dall'applicazione aziendale per eseguire azioni per conto dell'utente aziendale tramite "Autenticazione ambito".

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto del documento.

Valori restituiti

Corpo: GetPackageDetailsResponse

Ottenere l'autenticazione utente del flusso di lavoro (apertura documento) di Enterprise Package

ID operazione:: V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

Le applicazioni aziendali possono usare questa API del servizio per abilitare le impostazioni di sicurezza di accesso per il pacchetto. I destinatari per i quali la sicurezza è configurata vengono identificati dall'ordine nell'URL. L'ID pacchetto viene identificato anche nell'URL della richiesta. I destinatari non potranno accedere al pacchetto del documento all'esterno dell'ambito di questa durata se la sicurezza di accesso è abilitata. Il proprietario del documento può anche configurare la sicurezza basata sull'autenticazione del pacchetto per un destinatario.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per il quale è necessario aggiornare la sicurezza e l'autenticazione dell'accesso al flusso di lavoro.
Ordine destinatario	order	True	integer	Ordine del destinatario nel flusso di lavoro per cui aggiornare la sicurezza e l'autenticazione dell'accesso.

Valori restituiti

Corpo: EnterpriseAccessResponse

Ottenere la cronologia del flusso di lavoro

ID operazione:: V4_Workflow_GetWorkflowHistory

Le applicazioni aziendali possono usare questa API di servizio per recuperare l'elenco di azioni eseguite in un documento. L'ID pacchetto viene fornito nell'URL della risorsa. Il campo di ricerca (intestazione x-search-text) è destinato a posta elettronica, nome documento, azione, infokey e infovalue.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del documento per il quale è necessario il log.
Numero pagina	pageNo	True	integer	Numero di pagina da recuperare.
Record per pagina	recordsPerPage	True	integer	Numero totale di record da recuperare in una pagina.
Cerca testo	x-search-text		string	Il campo di ricerca (intestazione x-search-text) è destinato a posta elettronica, nome documento, azione, infokey e infovalue.

Valori restituiti

Corpo: WorkflowHistoryResponse

Ottenere le autorizzazioni utente del flusso di lavoro

ID operazione:: V4_WorkflowPermission_GetWorkflowPermissions

Le applicazioni aziendali possono usare questa API di servizio per ottenere le autorizzazioni per i documenti per un destinatario. Il destinatario viene identificato dall'ordine nel flusso di lavoro. L'ID del pacchetto viene fornito nell'URL della risorsa.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID documento per il quale l'utente del flusso di lavoro deve essere aggiornato.
Ordinamento	order	True	integer	Ordine dell'utente nel flusso di lavoro per il quale vengono richieste le autorizzazioni. Specificando il valore 0 nell'ordine, il servizio restituirà le autorizzazioni del collaboratore aggiunto più di recente nel flusso di lavoro.

Valori restituiti

Corpo: WorkflowPermissionResponse

Ottenere lo spazio condiviso

ID operazione:: V4_WorkSpace_GetSharedSpace

Le applicazioni aziendali possono usare questa API di servizio per ottenere uno spazio condiviso specifico. Questa API restituisce informazioni sullo spazio condiviso, sul proprietario e sul collaboratore.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID spazio condiviso	id	True	integer	ID dello spazio condiviso che si vuole ottenere

Valori restituiti

Corpo: WorkSpaceResponse

Ottenere modelli

ID operazione:: V4_Settings_GetTemplates

Le applicazioni aziendali possono usare questa API di servizio per ottenere un elenco di modelli per l'utente corrente.

È possibile eseguire ricerche in base al criterio fornito nell'intestazione "x-search-text". Inoltre, è possibile eseguire ricerche nei modelli personali di un utente o nei modelli aziendali in base al ruolo utente consentito dall'amministratore dell'organizzazione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Numero di record per pagina	recordPerPage	True	integer	Numero totale di record da recuperare in una pagina.
Numero di pagina da recuperare	pageNo	True	integer	Numero di pagina da recuperare.
Ordina per colonna	sort-by		string	Ordina per colonna. I valori possibili sono CREATED_ON e NAME. Il valore predefinito è ordina per CREATED_ON
Asc	asc		boolean	Ordine di elenco risultante. L'elenco risultante predefinito sarà decrescente
Cerca testo	x-search-text		string	Se necessario, cercare testo. Questo è facoltativo e senza di esso viene restituito l'intero elenco. Inoltre, il valore consigliato per il parametro di testo di ricerca è in formato con codifica Base64.
Solo modelli enterprise	x-enterprise		string	Se impostato come "true" verrà restituito solo l'elenco dei modelli enterprise. Nel caso di "false" verrà restituito solo l'elenco dei modelli dell'utente. Se non si imposta l'intestazione, verranno restituiti gli elenchi di modelli dell'organizzazione e dell'utente.
Numero totale di registrazioni	x-total-records		string	Numero totale di record trovati con i criteri di ricerca specificati.

Valori restituiti

response: array of TemplateResponse

Ottenere modelli enterprise

ID operazione:: V4_Template_GetEnterpriseTemplates

Le applicazioni aziendali possono usare questa API di servizio per ottenere l'elenco dei modelli aziendali dell'utente corrente. Ciò significa che l'amministratore dell'organizzazione o l'utente dell'organizzazione se la variabile "ambito" è stata usata nella richiesta di autenticazione.

È possibile eseguire ricerche in base al criterio fornito nell'intestazione "x-search-text".

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Numero di record per pagina	recordPerPage	True	integer	Numero totale di record da recuperare in una pagina.
Numero di pagina da recuperare	pageNo	True	integer	Numero di pagina da recuperare.
Ordina per colonna	sort-by		string	Ordinare il risultato in base ai valori possibili indicati in precedenza.
Ordinare il set di risultati	asc		boolean	Ordinare il set di risultati in ordine crescente o decrescente.
Filtrare in base agli ID modello	id		array	Eseguire la ricerca in base agli ID modello.
Cerca testo	x-search-text		string	Se necessario, cercare testo. Questo è facoltativo e senza di esso viene restituito l'intero elenco. Inoltre, il valore consigliato per il parametro di testo di ricerca è in formato con codifica Base64.
Numero totale di registrazioni	x-total-records		string	Numero totale di record trovati con i criteri di ricerca specificati.

Valori restituiti

response: array of EnterpriseTemplateResponse

Ottenere pacchetti

ID operazione:: V4_Package_GetAllPackages

Le applicazioni aziendali possono usare questa API di servizio per ottenere un elenco di documenti filtrati in base a stati diversi. Gli utenti possono dividere i record in pagine fornendo un numero di record per pagina.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Stato documento	document_status	True	string	Filtrare in base ai valori possibili dello stato del documento sono ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS.
Numero pagina	pageNo	True	integer	Numero di pagina, in base alla divisione dei record per pagina.
Record per pagina	recordPerPage	True	integer	Numero di record necessari per il recupero in una richiesta.
Nome pacchetto	package-name		string	Nome pacchetto
ID del Pacchetto	package-id		integer	ID pacchetto
Da	recipient-from		string	Da
A	recipient-to		string	A
ID documento	document-id		integer	ID documento
Scadenza (giorni)	expiry		integer	Scadenza (giorni)
Da data modifica	modified-from		date-time	Da data modifica
Alla data di modifica	modified-to		date-time	Alla data di modifica
Da dimensioni (KB)	size-from		integer	Da dimensioni (KB)
Dimensioni (KB)	size-to		integer	Dimensioni (KB)
Documenti certificati	certified-documents		boolean	Solo documenti firmati certificati
Campi modulo	form-fields		boolean	Solo i documenti con campi modulo
Allegati	attachments		boolean	Solo i documenti con allegati
Tipo di documento	document-type		string	Tipo di documento come XML, PDF, DOCX e così via
Ordina per	sort-by		string	Ordinare i record risultanti in base alla scelta
Ordine crescente	asc		boolean	Ordinamento dei record risultanti in base all'ordine crescente o decrescente
Stati documento	document-statuses		array	Tipo di documento
Di proprietà di	owned-by		string	I valori possibili del filtro Di proprietà sono ME_OTHERS, ME, OTHERS.
Nome modulo intelligente	smart-form		string	Nome modulo intelligente
Nome cartella	x-folder		string	Nome della cartella da cui recuperare i documenti. I valori possibili sono INBOX e ARCHIVE. Inoltre, il valore consigliato per il parametro x-folder è in formato con codifica Base64.
Cerca testo	x-search-text		string	Cerca testo inviato in intestazioni per ulteriore filtraggio dei documenti. È possibile cercare id pacchetto, nome e proprietario del documento. Inoltre, il valore consigliato per il parametro di testo di ricerca è in formato con codifica Base64.
Totale record	x-total-records		string	Numero totale di record trovati con i criteri di ricerca specificati.
Source	x-source		string	Si tratta dell'identificazione dell'origine del documento da cui viene caricato il documento, ad esempio "App personale".
Dettagli destinatario	x-recipient-details		string	Se "true" viene passato ai dettagli del destinatario relativi alla durata dell'accesso ai documenti, verranno fornite informazioni sul rifiuto

Valori restituiti

response: array of GetPackagesResponse

Ottenere un report di evidenza del processo

ID operazione:: V4_WorkflowEvidenceReport_DownloadBytes

Le applicazioni aziendali possono usare questa API di servizio per scaricare il report delle prove del processo del flusso di lavoro di un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del documento.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Ottieni allegati

ID operazione:: V4_Attachment_GetAttachments

Le applicazioni aziendali possono usare questa API di servizio per ottenere gli allegati di un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento a cui viene aggiunto l'allegato.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: array of GetAttachmentResponse

Pacchetti di firma bulk

ID operazione:: V4_Signing_BulkSignDocuments

Le applicazioni aziendali possono usare questa API per firmare,condividere/firmare e condividere più documenti (sia elettronici che digitali) senza visualizzare i documenti all'utente finale. Questa API richiede informazioni dall'applicazione aziendale sui pacchetti di documenti e i dettagli delle firme, dei campi di persona e iniziali. Al termine della transazione di firma bulk, l'API restituirà gli stati e gli ID transazione dei pacchetti di documento.

A differenza dell'API Firma documento, questa API non solo firma un pacchetto di documento, ma lo contrassegna anche come approvato e esaminato in base al fatto che il destinatario sia un firmatario, un editor o un revisore. Qualsiasi pacchetto di documento per il quale lo stato restituisce come COMPLETED è stato firmato, approvato o esaminato da questa API.

La firma bulk funziona con tutti i metodi di autenticazione in fase di firma.

Se SIGN viene passato come bulk_action e il pacchetto è in stato Bozza, l'esecuzione di Sign and Share verrà eseguita automaticamente.

È necessario chiamare questa API dopo l'API Pre-Bulk Sign Documents .

Se è necessario apportare modifiche in uno dei documenti prima della firma, è necessario chiamare l'API Campi modulo di riempimento prima di chiamare l'API Pre-Bulk Sign Document. Tenere presente che tutti i campi di input obbligatori in un documento richiedono il completamento prima che questa API venga completata correttamente; mentre, i campi popolati automaticamente (ad esempio Nome, Posta elettronica, Data, Titolo processo e così via) verranno compilati automaticamente.

Dopo la firma del documento, la risposta di verifica può essere visualizzata dall'API Stato della firma bulk .

Utilizzo OTP primo o secondo fattore per l'autenticazione

Nel caso in cui l'autenticazione OTP sia attivata per l'operazione di firma lato server, le applicazioni client dovranno generare un OTP per il numero di cellulare usando l'autenticazione con firma bulk tramite chiamata API OTP . Le rispettive applicazioni aziendali devono recuperare il codice OTP dall'uso e inviarlo durante l'esecuzione della chiamata API. Questa operazione viene eseguita usando l'intestazione "x-otp" nella richiesta.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ids	ids		array of integer	Matrice degli ID del pacchetto di documento selezionati per la firma in blocco.
hand_signature_initials_image	hand_signature_initials_image		string	Immagine Base64 usata per il riempimento delle iniziali
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
hand_signature_image	hand_signature_image		string	Immagine stringa con codifica Base64 dell'aspetto della firma visibile
hand_signature_method	hand_signature_method			Nome del metodo di firma manuale da parte dell'utente per la firma. Se non viene specificato alcun metodo di firma manuale, il valore predefinito sarà DRAW. valori possibili DRAW,TEXT,UPLOAD,SIGNATURE_PAD
signing_reason	signing_reason		string	Motivo della firma fornita dal destinatario.
signing_location	signing_location		string	Impostazioni locali del firmatario fornito dal destinatario
contact_information	contact_information		string	Informazioni di contatto del firmatario fornito dal destinatario
appearance_design	appearance_design		string	Nome dell'aspetto della firma fornito dall'utente per la firma. Se non viene specificato alcun nome di aspetto, verrà usato l'aspetto selezionato predefinito. I valori possibili sono "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_server	signing_server		string	Nome del server di firma con cui il documento deve essere firmato
signing_capacity	signing_capacity		string	Nome della capacità di firma/profilo di certificazione con cui il documento deve essere firmato
autenticazione	authentication			L'oggetto di autenticazione è facoltativo e contiene opzioni di autenticazione rilecate
ID di transazione	transaction_id		string	ID transazione del processo di firma avviato di nuovo
ID del Pacchetto	packageId_bulkAction	True	string	Azione bulk da eseguire. I valori possibili sono: SIGN \| CONDIVIDI
Firma OTP	x-otp		string	OTP/TOTP usato come autenticazione di firma del secondo fattore/documento per l'operazione di firma.
Password di accesso ai documenti	x-open-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
Document One-Time Password	x-open-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.
Origine mobile	x-mobile		string	Definire l'originator(Web/Mobile) della richiesta/azione

Valori restituiti

Corpo: BulkSignResponse

Recupera campi documento

ID operazione:: V4_Fields_GetAllDocumentFields

Le applicazioni aziendali possono usare questa API di servizio per ottenere campi documento, ad esempio iniziali, in-persons, campi di firma o campi modulo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento per il quale vengono richiesti i campi.
Pagina No	pageNo	True	integer	Nessuna pagina del documento per cui vengono richiesti i campi. Se i campi dell'intero documento non vengono restituiti.
Mittente	x-mobile		string	Definire l'originator(Web/Mobile) della richiesta/azione

Valori restituiti

Corpo: FieldsResponse

Recupera promemoria flusso di lavoro

ID operazione:: V4_Workflow_GetWorkflowReminder

Le applicazioni aziendali possono usare questa API del servizio per aggiornare i promemoria per i destinatari che sono già stati aggiunti a un flusso di lavoro. In genere questa chiamata è utile dopo l'applicazione di un modello a un documento e alle applicazioni aziendali che desiderano eseguire l'override delle impostazioni dei promemoria all'interno del flusso di lavoro. L'ID del documento del flusso di lavoro viene fornito nell'URL della risorsa e il destinatario del flusso di lavoro viene identificato dall'ordine in cui viene aggiunto al flusso di lavoro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto per il quale aggiornare i promemoria del flusso di lavoro.
Ordinamento	order	True	integer	Ordine dell'utente per cui aggiornare i promemoria del flusso di lavoro.

Valori restituiti

Corpo: ReminderResponse

Rifiuta documento

ID operazione:: V4_Package_Decline

Le applicazioni aziendali possono usare questa API di servizio per rifiutare un documento da parte di un utente specificato nell'ordine.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID del pacchetto da rifiutare.
reason	reason		string	Motivo fornito dall'utente per rifiutare.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Rinomina pacchetto

ID operazione:: V4_Package_RenamePackage

Questa API del servizio viene usata per rinominare un pacchetto di documento.

Il pacchetto del documento è identificato dal relativo identificatore univoco nell'URL della chiamata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId_bulkAction	True	integer	ID pacchetto per modificare il nome di .
package_name	package_name	True	string	Nuovo nome del pacchetto del documento.

Valori restituiti

response: object

Rinominare il documento

ID operazione:: V4_Documents_RenameDocument

Le applicazioni aziendali possono usare questa API di servizio per rinominare un documento in un pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento su cui deve essere eseguita l'azione.
document_name	document_name	True	string	Nuovo nome del documento.

Valori restituiti

Corpo: DocumentResponse

Scarica allegato

ID operazione:: V4_Attachment_DownloadAttachment

Le applicazioni aziendali possono usare questa API di servizio per scaricare l'allegato di un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento a cui viene aggiunto l'allegato.
ID allegato	attachment_id	True	integer	ID dell'allegato.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Scarica documento

ID operazione:: V4_Documents_DownloadDocumentBytes

Le applicazioni aziendali possono usare questa API di servizio per scaricare i byte dei documenti. L'ID pacchetto e l'ID documento vengono forniti nell'URL della risorsa.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto del pacchetto a cui viene aggiunto il documento.
ID documento	documentId	True	integer	ID del documento da scaricare.
Password documento	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
One-Time password (OTP)	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Scaricare il pacchetto

ID operazione:: V4_Package_DownloadPackageBytes

Le applicazioni aziendali possono usare questa API di servizio per scaricare il pacchetto del documento in formato binario.

L'ID pacchetto viene fornito nell'URL della risorsa.

Se il pacchetto contiene un solo documento, il download è il documento PDF binario.

In alternativa, se il pacchetto contiene più documenti, il download è il file ZIP binario di tutti i documenti.

Le intestazioni x-password e x-otp sono facoltative. Sono necessari se il proprietario del documento li imposta durante la fase di creazione del flusso di lavoro.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId_bulkAction	True	integer	ID pacchetto da scaricare.
ID dei documenti	document-ids		array	Il parametro ID documento è facoltativo. Se x-combine-files è impostato su true, i documenti verranno uniti in base ai documenti indicati del pacchetto.
Password di accesso ai documenti	x-password		string	Password impostata dal proprietario del documento per l'accesso al documento, se presente. Se la password non è stata impostata, il valore sarà Null.
Document One-Time Password	x-otp		string	La One-Time Password (OTP) impostata dal proprietario del documento per l'accesso al documento, se presente. Se L'OTP non è stato impostato, il valore sarà Null.
Combinare file	x-combine-files		string	Il valore predefinito è false, impostare su "true" per combinare l'intero pacchetto di documenti in un singolo file PDF.
ID cartella	x-folder-id		string	Specificare l'ID cartella, per recuperare gli elementi della cartella, quando è interessata una cartella dello spazio condiviso.

Valori restituiti

response: object

Spostare il pacchetto nella cartella Spazio personalizzato o condiviso

ID operazione:: V4_Folder_MovePackage

Le applicazioni aziendali possono usare questa API di servizio per spostare il pacchetto del documento in uno spazio condiviso o nella cartella personalizzata dell'utente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del Pacchetto	packageId	True	integer	ID pacchetto che deve essere spostato nella cartella
folder_name	folder_name	True	string	Nome della cartella di destinazione in cui è necessario spostare il pacchetto

Valori restituiti

response: object

Stato firma bulk

ID operazione:: V4_Signing_BulkSignStatus

Le applicazioni aziendali possono usare questa API per ottenere lo stato di una transazione di firma in blocco specifica insieme ai dettagli dei pacchetti di documenti elaborati dall'API Pacchetti di firma bulk .

È necessario chiamare questa API dopo l'API pacchetti di firma bulk.

Per la firma RAS, la proprietà ACTION verrà REMOTE_AUTHORIZATION_REQURIED e la proprietà STATUS sarà IN SOSPESO, a indicare che la richiesta deve essere autorizzata usando il dispositivo mobile. Se il processo di firma non riesce in un documento a causa di diversi livelli di garanzia configurati e l'utente vuole avviare nuovamente il processo di firma per completare il processo di firma nei documenti non riusciti, la proprietà ACTION verrà REINITIATE_SIGNING_PROCESS e la proprietà STATUS sarà IN SOSPESO.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID di transazione	transaction_id		string	Numero di identificazione della transazione di firma bulk
Azione collettiva	bulk_action	True	string	Azione bulk da eseguire. I valori possibili sono: SIGN \| CONDIVIDI

Valori restituiti

Corpo: BulkSignStatusResponse

Definizioni

ElectronicSealRecipient

Nome	Percorso	Tipo	Descrizione
nome	name	string
level_of_assurance	level_of_assurance	string

ReminderResponse

Nome	Percorso	Tipo	Descrizione
enabled	enabled	boolean	True, se i promemoria sono abilitati per il destinatario
frequenza	frequency	string	Frequenza promemoria. I valori possibili sono DAYS \| ORE.
remind_after	remind_after	integer	Numero di giorni dopo i quali il primo promemoria verrebbe inviato all'utente del flusso di lavoro.
ripetere	repeat		Ripetere l'oggetto con i dettagli del promemoria ripetuto o meno.

AddQrCodeResponse

Nome	Percorso	Tipo	Descrizione
data	data	string	Dati generati dal codice a matrice
field_name	field_name	string	Nome del campo creato nel documento.
valore	value	string	Il valore sarà la base64 dell'immagine QrCode

AddFieldResponse

Nome	Percorso	Tipo	Descrizione
field_name	field_name	string	Nome del campo creato nel documento.
created_on	created_on	string	Data e ora di creazione del campo.

SignatureFieldResponse

Nome	Percorso	Tipo	Descrizione
field_name	field_name	string	Nome del campo creato nel documento.
created_on	created_on	string	Data e ora di creazione del campo.

UpdateQrCodeResponse

Nome	Percorso	Tipo	Descrizione
valore	value	string	Il valore sarà la base64 dell'immagine QrCode

CertifyResponse

Nome	Percorso	Tipo	Descrizione
enabled	enabled	boolean	True, se le impostazioni della firma di certificazione sono abilitate per il documento.
allowed_permissions	allowed_permissions	array of string	Certificare il livello di autorizzazione impostato per il documento con le impostazioni di certificazione della firma.
default_permission	default_permission	string

GroupMemberResponse

Nome	Percorso	Tipo	Descrizione
user_email	user_email	string	Indirizzo di posta elettronica del membro del gruppo
user_name	user_name	string	Nome utente del membro del gruppo

CollaboratorResponse

Nome	Percorso	Tipo	Descrizione
user_email	user_email	string	Indirizzo e-mail dell'utente
signing_order	signing_order	integer	Ordine di firma
guest_user	guest_user	boolean	Utente guest
email_language_code	email_language_code	string	Codice della lingua di posta elettronica
autorizzazione	permission		Autorizzazioni per il destinatario nel pacchetto del documento
Promemoria	reminder		Impostazioni di promemoria del destinatario.

WorkflowPermissionResponse

Nome	Percorso	Tipo	Descrizione
print	print	boolean	True, se la stampa è consentita per il destinatario.
scarica	download	boolean	True, se il download è consentito.
add_text	add_text	boolean	True, se è consentita l'aggiunta di annotazioni di testo nel documento.
change_recipients	change_recipients	boolean	True, se il destinatario nell'ordine corrente può modificare altri destinatari nel flusso di lavoro dopo la condivisione del flusso di lavoro.
add_attachment	add_attachment	boolean	True, se sono consentiti allegati e unione di documenti PDF.
legal_notice	legal_notice		Avviso legale impostato dal proprietario per il destinatario.
allegato	attachment		Allegati

EnterpriseTemplateResponse

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID del modello
nome	name	string	Nome del modello.
pubblico	public	boolean	La risposta è "true" se il modello enterprise è contrassegnato come pubblico. In caso contrario, verrà restituito "false"
read_only	read_only	boolean	Risposta di "true" se il modello è di sola lettura e l'utente non può apportare modifiche al flusso di lavoro dopo l'applicazione di questo modello. In caso contrario, "false".
descrizione	description	string	Descrizione del modello
created_on	created_on	string	Data e ora di creazione del modello
roles	roles	array of EnterpriseTemplateRole
Documenti	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

Nome	Percorso	Tipo	Descrizione
nome	name	string	Nome del ruolo aziendale assegnato all'utente.
id	id	integer	ID del ruolo aziendale assegnato all'utente.

TemplateDocumentResponse

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID del documento del modello
nome	name	string	Nome del documento del modello.

Next_signer_email

Nome	Percorso	Tipo	Descrizione
user_email	user_email	string	Indirizzo di posta elettronica del firmatario successivo.
user_name	user_name	string	Nome del firmatario successivo.

WorkflowRecipient

Nome	Percorso	Tipo	Descrizione
order	order	integer	Ordine del destinatario nel flusso di lavoro.
user_email	user_email	string	Indirizzo di posta elettronica del destinatario se l'utente non è un gruppo.
user_name	user_name	string	Nome del destinatario se l'utente non è un gruppo.
mobile_number	mobile_number	string	Numero di cellulare
delivery_method	delivery_method	string	Metodo di recapito del destinatario Valori possibili: EMAIL, SMS o EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Endpoint API per accedere alla risorsa, che verrà fornito solo per i firmatari principali. Ad esempio, sarà null per group/delegator/gatekeeper e così via. Questo URL non garantisce che l'immagine del firmatario esista. Se l'immagine esiste, verrà fornita premendo l'URL definito; in caso contrario, sarà una stringa vuota.
nome_del_gruppo	group_name	string	Nome del gruppo del destinatario se il destinatario è un gruppo.
group_members	group_members	array of GroupMemberResponse	Elenco di indirizzi di posta elettronica dei membri del gruppo se il destinatario è un gruppo.
delegato	delegatee	string	Delegare l'indirizzo di posta elettronica, se il destinatario non è un gruppo.
delegatee_name	delegatee_name	string	Nome dell'utente delegato, se il destinatario non è un gruppo.
ruolo	role	string	Ruolo flusso di lavoro in cui è stato aggiunto il destinatario. Questo ruolo non è il ruolo aziendale. I valori possibili sono "SIGNER", "REVIEWER","CARBON_COPY" e "EDITOR".
reason	reason	string	Motivo fornito dall'utente in caso di rifiuto, approvazione o invio di un documento.
process_status	process_status	string	Stato di elaborazione dei documenti per il destinatario. I valori possibili sono "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" o "INVALID".
processed_on	processed_on	string	Data e ora di elaborazione del documento.
processed_as	processed_as	string	L'utente può elaborare il campo come COLLABORATOR , DELEGATOR, GROUP_MEMBER o OWNER.
processed_by	processed_by	string	Indirizzo di posta elettronica dell'utente che ha elaborato il documento.
segnaposto	placeholder	string	Testo segnaposto se il destinatario è un segnaposto
signing_order	signing_order	integer	Ordine in cui il flusso di lavoro verrà firmato dai destinatari. Questo ordine di firma è importante quando il tipo di flusso di lavoro è impostato su "CUSTOM".
user_national_id	user_national_id	string	Numero di identità nazionale dell'utente. Ciò consente di identificare l'utente nel flusso di lavoro
guest_user	guest_user	boolean	Inserire l'utente
email_language_code	email_language_code	string	codice della lingua di posta elettronica
electronic_seal	electronic_seal	ElectronicSealRecipient
Guardiani	gatekeepers		Guardiani

EnterpriseAccessResponse

Nome	Percorso	Descrizione
autenticazione	authentication	Oggetto di autenticazione con i dettagli dei metodi di autenticazione applicati al documento per il destinatario.
authentication_signing	authentication_signing	Firma di autenticazione per il pacchetto
access_duration	access_duration	Oggetto Durata di accesso con i dettagli dei titoli di accesso per il destinatario.

GetPackageDetailsResponse

Nome	Percorso	Tipo	Descrizione
nome	name	string	Nome del pacchetto del documento.
proprietario	owner	DocumentOwner
read_only	read_only	boolean	True se il modello applicato è di sola lettura. L'utente non sarà in grado di apportare modifiche se viene applicato un modello di sola lettura.
document_status	document_status	string	Stato del documento per l'utente connesso corrente. I valori possibili sono "DRAFT", "INPROGRESS", "PENDING", "DECLINED" o "COMPLETED".
Documenti	documents	array of DocumentDetails

DocumentOwner

Nome	Percorso	Tipo	Descrizione
nome	name	string	Nome del proprietario del pacchetto del documento.
posta elettronica	email	string	Indirizzo di posta elettronica del proprietario del pacchetto del documento.

DocumentDetails

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID del documento appena creato.
nome	name	string	Nome del documento.
uploaded_on	uploaded_on	string	Data e ora di caricamento del documento.
modified_on	modified_on	string	Data e ora dell'ultima modifica del documento.
size	size	integer	Dimensioni del documento in byte.
type	type	string	Tipo di documento, ad esempio "PDF".
source	source	string	Identifica dove è stato caricato il documento, ad esempio "App personale".

TemplateResponse

Nome	Percorso	Tipo	Descrizione
template_id	template_id	integer	L'ID del modello viene restituito qui
template_name	template_name	string	Nome del modello.
template_public	template_public	boolean	La risposta è "true" se il modello enterprise è contrassegnato come pubblico. In caso contrario, verrà restituito "false"
read_only	read_only	boolean	Risposta di "true" se il modello è di sola lettura e l'utente non può apportare modifiche al flusso di lavoro dopo l'applicazione di questo modello. In caso contrario, "false".
created_on	created_on	string	Data e ora di creazione del modello
descrizione	description	string	Descrizione del modello
azienda	enterprise	boolean	True, se l'utente appartiene a un'azienda.
Documenti	documents	array of TemplateDocumentResponse
smart_form	smart_form		Modulo intelligente

StartWorkflowResponse

Nome	Percorso	Tipo	Descrizione
package_id	package_id	integer	ID pacchetto del pacchetto appena condiviso. In caso di condivisione singola, vengono creati più pacchetti e condivisi con i destinatari. L'API restituisce una matrice di pacchetti insieme agli ID dei documenti appena creati.
Documenti	documents	array of integer	Matrice di ID documento che fanno parte del pacchetto prima della condivisione.

WorkflowDetailsResponse

Nome	Percorso	Tipo	Descrizione
package_id	package_id	integer	ID pacchetto del pacchetto del documento.
package_name	package_name	string	Nome del pacchetto del documento.
shared_package	shared_package	boolean	pacchetto condiviso
package_owner	package_owner	string	Indirizzo di posta elettronica del proprietario del pacchetto del documento.
owner_name	owner_name	string	Nome del proprietario del pacchetto del documento.
package_status	package_status	string	Stato del documento per l'utente connesso corrente. I valori possibili sono "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" o "COMPLETED".
folder	folder	string	Nome della cartella che contiene il pacchetto del documento.
folder_id	folder_id	integer	ID della cartella che contiene il pacchetto del documento.
Gatekeeper	gatekeeper	boolean
next_signer	next_signer	string	Nome del firmatario successivo se il documento è in stato condiviso.
next_signer_email	next_signer_email	array of Next_signer_email	Oggetto contenente il nome utente e l'indirizzo di posta elettronica dei firmatari successivi. Nel caso del firmatario del gruppo, avrà un elenco di indirizzi di posta elettronica di tutti i membri del gruppo.
uploaded_on	uploaded_on	string	Data e ora di caricamento del documento.
modified_on	modified_on	string	Data e ora dell'ultima modifica del documento.
flusso di lavoro	workflow		Oggetto flusso di lavoro con i dettagli del flusso di lavoro.
Documenti	documents	array of WorkflowDocumentsResponse	Elenco di documenti caricati nel pacchetto.
users	users	array of WorkflowUserResponse	Elenco dei destinatari per il flusso di lavoro.

WorkflowDocumentsResponse

Nome	Percorso	Tipo	Descrizione
document_id	document_id	integer	ID del documento.
document_name	document_name	string	Nome del documento.
document_type	document_type	string	Estensione del documento originale quando il documento è stato caricato prima della conversione nel PDF.
document_order	document_order	integer	Ordine del documento nel pacchetto del documento.
document_source	document_source	string	Origine del documento da cui è stato caricato il documento.
update_required	update_required	boolean	True se il documento è necessario per l'aggiornamento
document_height	document_height	integer	Altezza del documento PDF.
document_width	document_width	integer	Larghezza del documento PDF.
document_pages	document_pages	integer	Numero totale di pagine nel documento.
created_on	created_on	string	Data e ora in cui è stato caricato il documento.
modified_on	modified_on	string	Data e ora dell'ultima modifica del documento.
form_fields	form_fields	boolean	True, se nel documento sono presenti campi modulo.
modello	template		Oggetto modello applicato al documento insieme ai dettagli del modello.
Certificare	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	True, se il documento è impostato per bloccare i campi modulo con l'ultima firma digitale del documento.
bloccato	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Pdf document meta info: true se il documento PDF ha campi di firma firmati
attachments	attachments	boolean	True, se il documento contiene allegati.
conformance_level	conformance_level	string	Livello di conformità del documento
document_size	document_size	integer	Dimensioni del documento.
formattato	formatted	boolean	Questa proprietà è per il documento XML, formattato o meno

WorkflowUserResponse

Nome	Percorso	Tipo	Descrizione
order	order	integer	Ordine del destinatario nel flusso di lavoro.
user_name	user_name	string	Nome del destinatario se il destinatario non è un gruppo. Se il destinatario è un segnaposto, conterrà il nome del segnaposto.
user_email	user_email	string	Indirizzo di posta elettronica del destinatario se il destinatario non è un gruppo o un segnaposto.
mobile_number	mobile_number	string	Numero di cellulare
delivery_method	delivery_method	string	Metodo di recapito del destinatario Valori possibili: EMAIL, SMS o EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Endpoint API per accedere alla risorsa, che verrà fornito solo per i firmatari principali. Ad esempio, sarà null per group/delegator/gatekeeper e così via. Questo URL non garantisce che l'immagine del firmatario esista. Se l'immagine esiste, verrà fornita premendo l'URL definito; in caso contrario, sarà una stringa vuota.
nome_del_gruppo	group_name	string	Nome del gruppo se il destinatario è un gruppo.
group_members	group_members	array of string	Elenco di tutti gli indirizzi di posta elettronica e i nomi degli utenti.
Delegante	delegator	string	Indirizzo di posta elettronica dell'utente delegato al destinatario.
Gatekeeper	gatekeeper	string	Indirizzo di posta elettronica dell'utente che è gatekeeper a questo destinatario.
Guardiani	gatekeepers		Guardiani
ruolo	role	string	Ruolo del destinatario, ad esempio "SIGNER", "REVIEWER", "EDITOR"," CARBON_COPY" o "INPERSON_HOST".
process_status	process_status	string	Stato di elaborazione dei documenti per il destinatario. I valori possibili sono "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" o "INVALID".
processed_on	processed_on	string	Data e ora di elaborazione del documento.
processed_as	processed_as	string	L'utente può elaborare il campo come COLLABORATORE, DELEGATOR, GROUP_MEMBER o OWNER.
processed_by	processed_by	string	Indirizzo di posta elettronica dell'utente che ha elaborato il documento.
reason	reason	string	Motivo fornito dall'utente in caso di rifiuto, approvazione o invio di un documento.
segnaposto	placeholder	string	Testo segnaposto se il destinatario è un segnaposto.
autorizzazione	permission		Autorizzazioni per il destinatario impostato dal proprietario del pacchetto del documento.
authentications	authentications		Oggetto Autenticazioni con i dettagli di eventuali autenticazioni e titoli di accesso configurati per il destinatario.
Promemoria	reminder		Oggetto Reminder con i dettagli delle impostazioni del promemoria.
signing_order	signing_order	integer	Ordine in cui il flusso di lavoro verrà firmato dai destinatari. Questo ordine di firma è importante quando il tipo di flusso di lavoro è impostato su "CUSTOM".
user_national_id	user_national_id	string	Numero di identità nazionale dell'utente. Ciò consente di identificare l'utente nel flusso di lavoro
guest_user	guest_user	boolean	Inserire l'utente
email_language_code	email_language_code	string	Codice della lingua di posta elettronica
electronic_seal	electronic_seal		tenuta elettronica

DocumentDetailsResponse

Nome	Percorso	Tipo	Descrizione
document_id	document_id	integer	ID del documento appena creato.
document_name	document_name	string	Nome del documento.
document_order	document_order	integer
document_type	document_type	string	Tipo di documento, ad esempio "PDF".
document_width	document_width	integer	Larghezza del documento in formato PDF.
document_height	document_height	integer	Altezza del documento in formato PDF.
document_source	document_source	string	Identifica dove è stato caricato il documento, ad esempio "App personale".
document_pages	document_pages	integer	Totale pagine del documento.
form_fields	form_fields	boolean	True se nel documento sono presenti campi modulo.
lock_form_fields	lock_form_fields	boolean	True se il blocco dei campi modulo con l'ultima firma è abilitato.
uploaded_on	uploaded_on	string	Data e ora di caricamento del documento.
modified_on	modified_on	string	Data e ora dell'ultima modifica del documento.
Certificare	certify		Impostazioni di firma certificate per il documento.
modello	template		Dettagli del modello, se il modello viene applicato al documento.

AddAttachmentResponse

Nome	Percorso	Tipo	Descrizione
attachment_id	attachment_id	integer	ID allegato

GetAttachmentResponse

Nome	Percorso	Tipo	Descrizione
attachment_id	attachment_id	integer	ID allegato
attachment_name	attachment_name	string	Nome allegato

AddPackageResponse

Nome	Percorso	Tipo	Descrizione
package_id	package_id	integer	ID pacchetto da usare in un secondo momento per condividere, scaricare e ottenere lo stato del documento.
workflow_mode	workflow_mode	string	Modalità flusso di lavoro impostata durante l'aggiunta del pacchetto.
workflow_type	workflow_type	string	Tipo del flusso di lavoro. I valori possibili sono "SERIAL", "PARALLEL", "INDIVIDUAL" e "CUSTOM".

GetPackagesResponse

Nome	Percorso	Tipo	Descrizione
package_id	package_id	integer	ID pacchetto del pacchetto del documento.
package_name	package_name	string	Nome del pacchetto del documento.
package_owner	package_owner	string	Indirizzo di posta elettronica del proprietario del pacchetto del documento.
owner_name	owner_name	string	Nome del proprietario del pacchetto del documento.
shared_package	shared_package	boolean	Pacchetto condiviso
gatekeeper_package	gatekeeper_package	boolean	Pacchetto Gatekeeper
package_status	package_status	string	Stato del documento per l'utente connesso corrente. I valori possibili sono "DRAFT", "INPROGRESS", "PENDING", "DECLINED" o "COMPLETED".
extension	extension	string	Estensione del pacchetto di documenti
workflow_mode	workflow_mode	string	Modalità flusso di lavoro
folder	folder	string	Nome della cartella che contiene il pacchetto del documento.
folder_id	folder_id	integer	ID della cartella che contiene il pacchetto del documento.
non letto	unread	boolean	True, se il documento non viene ancora letto dal destinatario.
next_signer	next_signer	string	Nome del firmatario successivo se il documento è in stato condiviso.
next_signer_email	next_signer_email	array of Next_signer_email	Oggetto contenente il nome utente e l'indirizzo di posta elettronica dei firmatari successivi. Nel caso del firmatario del gruppo, avrà un elenco di indirizzi di posta elettronica di tutti i membri del gruppo.
uploaded_on	uploaded_on	string	Data e ora di caricamento del documento.
modified_on	modified_on	string	Data e ora dell'ultima modifica del documento.
access_duration	access_duration		Specificare la data e l'ora di inizio e di fine per consentire a un destinatario di accedere al documento. Il destinatario non sarà in grado di accedere al documento oltre questa durata. Se il documento non viene elaborato entro il tempo specificato, il documento verrà considerato rifiutato. Questo verrà fornito se "x-recipient-details" viene passato come true nell'intestazione
Declino	decline		Dettagli del rifiuto del documento se il relativo rifiuto manuale o automatico tramite Core. Questo verrà fornito se "x-recipient-details" viene passato come true nell'intestazione
size	size	integer	Dimensioni del documento in byte.

DocumentResponse

Nome	Percorso	Tipo	Descrizione
package_name	package_name	string	Nome pacchetto documento

UploadDocument

Nome	Percorso	Tipo	Descrizione
documentId	documentId	integer	Questa proprietà viene mantenuta per la compatibilità con le versioni precedenti e verrà rimossa nelle versioni successive. Usare invece document_id.
documenti	documentid	integer	ID documento da usare in un secondo momento per condividere, scaricare e ottenere lo stato del documento. verrà rimosso in un secondo momento document_id verrà usato
document_id	document_id	integer	ID documento da usare in un secondo momento per condividere, scaricare e ottenere lo stato del documento.
document_name	document_name	string	Nome del documento.
document_order	document_order	integer	Ordine dei documenti nel pacchetto
document_type	document_type	string	Tipo di documento, ad esempio "PDF".
document_source	document_source	string	Identifica dove è stato caricato il documento, ad esempio "App personale".
document_width	document_width	integer	Larghezza del documento in formato PDF.
document_height	document_height	integer	Altezza del documento in formato PDF.
document_pages	document_pages	integer	Totale pagine del documento.
uploaded_on	uploaded_on	date-time	Data e ora di caricamento del documento.
modified_on	modified_on	date-time	Data e ora dell'ultima modifica del documento.
lock_form_fields	lock_form_fields	boolean	True se il blocco dei campi modulo con l'ultima firma è abilitato.
Certificare	certify		Impostazioni di firma certificate per il documento.
document_size	document_size	integer	Dimensioni del documento caricate in byte
metadata	metadata		Metadati pdf caricati
package_name	package_name	string	Nome del pacchetto del documento

CertifyPolicyResponse

Nome	Percorso	Tipo	Descrizione
Certificare	certify		Certificare le impostazioni di firma per il documento.
lock_form_fields	lock_form_fields	boolean	True se i campi modulo devono essere bloccati nel PDF dopo l'ultima firma digitale nel documento corrente.

BulkSignResponse

Nome	Percorso	Tipo	Descrizione
stato	status	string
ID di transazione	transaction_id	string

BulkSignStatusResponse

Nome	Percorso	Tipo	Descrizione
stato	status	string
Pacchetti	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Nome	Percorso	Tipo	Descrizione
id	id	integer
nome	name	string
stato	status	string
action	action	string	Chiave di azione richiesta, se disponibile
error	error	string
percentuale	percentage	integer
Documenti	documents	array of BulkSignActionDocumentModel	Documenti nel pacchetto corrente

BulkSignActionDocumentModel

Nome	Percorso	Tipo	Descrizione
id	id	integer
Campi	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Nome	Percorso	Tipo
nome	name	string
Hash	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Nome	Percorso	Tipo	Descrizione
field_name	field_name	string	Nome del campo per cui è stata richiesta la verifica.
stato	status	string	Restituisce lo stato del campo della firma. I valori sono SIGNED, PENDING. Lo stato aiuta nella firma remota abilitata per eIDAS. Se la richiesta di firma viene inviata al dispositivo mobile, lo stato è in sospeso.
ID di transazione	transaction_id	string	Questo parametro viene usato durante la firma RAS
verifica	verification		Verifica della firma
authentication_access_token	authentication_access_token	string	Conterrà il id_token OIDC quando l'utente viene autenticato tramite OIDC

AutoPlaceFieldsResponse

Nome	Percorso	Tipo	Descrizione
field_name	field_name	string	Nome del campo generato automaticamente dall'API.

ContactResponse

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID del contatto.
user_name	user_name	string	Nome utente del contatto.
user_email	user_email	string	Indirizzo di posta elettronica del contatto.
mobile_number	mobile_number	string	Numero di cellulare del contatto.
azienda	enterprise	boolean	True, se il contatto è enterprise.
user_national_id	user_national_id	string	Numero di identità nazionale del contatto
created_on	created_on	string	DateTime quando viene aggiunto il contatto.

WorkSpaceMembers

Nome	Percorso	Tipo	Descrizione
nome	name	string	Nome del membro dello spazio di lavoro
posta elettronica	email	string	Indirizzo di posta elettronica del membro dello spazio di lavoro

WorkSpaceResponse

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID dello spazio condiviso
nome	name	string	Nome dello spazio condiviso
proprietario	owner		Proprietario dello spazio condiviso
membri	members	array of WorkSpaceMembers	Membri dello spazio condiviso

UploadDocumentLibraryResponse

Nome	Percorso	Tipo	Descrizione
document_id	document_id	integer	ID del documento appena creato.
document_name	document_name	string	Nome del documento.
document_size	document_size	integer	Dimensioni del documento caricate in byte
document_order	document_order	integer	Ordine del documento
document_type	document_type	string	Tipo di documento, ad esempio "PDF".
document_source	document_source	string	Identifica dove è stato caricato il documento, ad esempio "App personale".
document_width	document_width	integer	Larghezza del documento in formato PDF.
document_height	document_height	integer	Altezza del documento in formato PDF.
document_pages	document_pages	integer	Totale pagine del documento.
uploaded_on	uploaded_on	date-time	Data e ora di caricamento del documento.
modified_on	modified_on	date-time	Data e ora dell'ultima modifica del documento.
form_fields	form_fields	boolean	True se nel documento sono presenti campi modulo.
lock_form_fields	lock_form_fields	boolean	True se il blocco dei campi modulo con l'ultima firma è abilitato.
Certificare	certify		Impostazioni di firma certificate per il documento.
modello	template		Dettagli del modello, se il modello viene applicato al documento.
package_name	package_name	string	Nome del pacchetto
metadata	metadata		Metadati pdf caricati

WorkflowHistoryResponse

Nome	Percorso	Tipo	Descrizione
package_id	package_id	integer	ID del pacchetto per il quale viene richiesta la cronologia del flusso di lavoro.
package_name	package_name	string
package_owner	package_owner	string	Indirizzo di posta elettronica del proprietario del pacchetto.
owner_name	owner_name	string	Nome del proprietario del pacchetto.
package_status	package_status	string	Stato del pacchetto o del documento con l'utente connesso corrente. I valori possibili sono "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" o "COMPLETED".
next_signer	next_signer	string	Nome del destinatario successivo.
next_signer_email	next_signer_email	array of Next_signer_email	Oggetto con nome e indirizzo di posta elettronica del destinatario successivo.
Documenti	documents	array of WorkflowDocumentsResponse
Azioni	actions	array of DocumentLogsActions

DocumentLogsActions

Nome	Percorso	Tipo	Descrizione
log_id	log_id	integer	ID di un'azione eseguita nel documento.
date_time	date_time	string	Data e ora di esecuzione dell'azione.
action_type	action_type	string
user_email	user_email	string	Indirizzo di posta elettronica dell'utente che ha eseguito l'azione.
user_name	user_name	string	Nome dell'utente che ha eseguito l'azione.
enterprise_name	enterprise_name	string	Nome dell'organizzazione a cui appartiene l'utente. Se l'utente non appartiene a un'organizzazione, questo elemento non è presente.
Informazioni	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

Nome	Percorso	Tipo	Descrizione
type	type	string	Tipo di informazioni aggiuntive sull'azione, ad esempio "SIGNING_METHOD", che indica il metodo di firma usato dall'utente per firmare il documento.
valore	value	string	Valore delle informazioni aggiuntive sull'azione, ad esempio "LOCAL", che significa che l'utente ha firmato il documento usando credenziali mantenute localmente.

UpdateCollaboratorResponse

Nome	Percorso	Tipo	Descrizione
user_email	user_email	string	Indirizzo e-mail dell'utente
signing_order	signing_order	integer	Ordine di firma
guest_user	guest_user	boolean	Utente guest
email_language_code	email_language_code	string	Codice della lingua di posta elettronica

CollaboratorGroupResponse

Nome	Percorso	Tipo	Descrizione
autorizzazione	permission		Autorizzazioni per il destinatario nel pacchetto del documento
Promemoria	reminder		Impostazioni di promemoria del destinatario.
signing_order	signing_order	integer	Ordine di firma

CollaboratorPlaceholderResponse

Nome	Percorso	Tipo	Descrizione
autorizzazione	permission		Autorizzazioni per il destinatario nel pacchetto del documento
Promemoria	reminder		Impostazioni di promemoria del destinatario.
signing_order	signing_order	integer	Ordine di firma

FieldsResponse

Nome	Percorso	Tipo	Descrizione
firma	signature	array of DigitalSignatureFieldResponse	Elenco di tutte le firme digitali nel documento.
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
iniziali	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
Elementi	in_person_signature	object
text	text	array of TextFieldResponse
radio	radio	array of RadioFieldResponse
casella di controllo	checkbox	array of CheckboxFieldResponse
elenco a discesa	dropdown	array of DropdownFieldResponse
Listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
allegato	attachment	array of AttachmentFieldResponse
commento	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

Nome	Percorso	Tipo	Descrizione
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
type	type	string	Se il campo viene assegnato o meno, i valori possibili sono ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Indica se il campo viene elaborato o meno. I valori possibili sono UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data di elaborazione del documento.
processed_as	processed_as	string	Utente che ha elaborato il campo come COLLABORATORE, DELEGATO, GROUP_MEMBER o PROPRIETARIO.
created_on	created_on	string	Data e ora in cui viene aggiunto il campo
processed_by	processed_by	string	Indirizzo di posta elettronica dell'utente che ha elaborato il campo.
dimensions	dimensions	FieldDimenssionResponse
verifica	verification		Restituisce la risposta di verifica del campo della firma. In caso di mancata verifica, viene restituito null.
nid	nid	string
schermo	display	string	Restituisce il valore di visibilità del campo della firma digitale, i valori possibili sono "VISIBLE" e "INVISIBLE".
level_of_assurance	level_of_assurance	array of string
autenticazione	authentication		Authentication

FieldDimenssionResponse

Nome	Percorso	Tipo	Descrizione
campo	field	FieldResponse
pagina	page	PageResponse

FieldResponse

Nome	Percorso	Tipo	Descrizione
x	x	double	Posizione sinistra del campo in pixel.
y	y	double	Posizione superiore del campo in pixel.
larghezza	width	double	Larghezza del campo in pixel.
altezza	height	double	Altezza del campo in pixel.

PageResponse

Nome	Percorso	Tipo	Descrizione
larghezza	width	float	Larghezza della pagina in cui viene inserito il campo nel PDF.
altezza	height	float	Altezza della pagina in cui viene inserito il campo nel PDF.

HandSignatureFieldResponse

Nome	Percorso	Tipo	Descrizione
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
type	type	string	Se il campo viene assegnato o meno, i valori possibili sono ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Indica se il campo viene elaborato o meno. I valori possibili sono UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data di elaborazione del documento.
processed_as	processed_as	string	Utente che ha elaborato il campo come COLLABORATORE, DELEGATO, GROUP_MEMBER o PROPRIETARIO.
processed_by	processed_by	string	Indirizzo di posta elettronica dell'utente che ha elaborato il campo.
dimensions	dimensions	FieldDimenssionResponse
nid	nid	string

ElectronicSignatureFieldResponse

Nome	Percorso	Tipo	Descrizione
order	order	integer	Indirizzo di posta elettronica dell'utente che ha elaborato il campo.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
type	type	string	Se il campo viene assegnato o meno, i valori possibili sono ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN e PLACEHOLDER.
process_status	process_status	string	Indica se il campo viene elaborato o meno. I valori possibili sono UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data di elaborazione del documento.
processed_as	processed_as	string	Utente che ha elaborato il campo come COLLABORATORE, DELEGATO, GROUP_MEMBER o PROPRIETARIO.
processed_by	processed_by	string	Indirizzo di posta elettronica dell'utente che ha elaborato il campo.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	Il sottotipo di firma può essere una firma WITNESS. Se le firme di controllo sono abilitate nel piano di servizio, i campi E-Signature vengono firmati con un certificato comune condiviso da tutti gli utenti nel piano di servizio. I valori possibili sono WITNESS o NONE.
autenticazione	authentication		Authentication
verifica	verification		Restituisce la risposta di verifica del campo. In caso di mancata verifica, viene restituito null.
nid	nid	string
schermo	display	string	Restituisce il valore di visibilità del campo della firma elettronica, i valori possibili sono "VISIBLE" e "INVISIBLE".

InitialFieldResponse

Nome	Percorso	Tipo	Descrizione
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
process_status	process_status	string	Indica se il campo viene elaborato o meno. I valori possibili sono UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data di elaborazione del documento.
processed_as	processed_as	string	Utente che ha elaborato il campo come COLLABORATORE, DELEGATO, GROUP_MEMBER o PROPRIETARIO.
processed_by	processed_by	string	Indirizzo di posta elettronica dell'utente che ha elaborato il campo.
dimensions	dimensions	FieldDimenssionResponse
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.

TextFieldResponse

Nome	Percorso	Tipo	Descrizione
field_locale	field_locale	string	Campo locale. I valori possibili sono ar-AE \| en-US. Facoltativo e predefinito sarà en-US. Questo valore è importante per il tipo "DATE".
required	required	boolean	True se il campo è obbligatorio in pdf
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
tab_order	tab_order	integer	Ordine di tabulazioni nel documento PDF
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
type	type	string	Il tipo del campo di testo, i valori possibili sono "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".
valore	value	string	Valore del campo. Per type = DATE o format_type = DATE, il valore deve seguire il formato ISO 8601. Dopo il formato AAAA-MM-DD hh:mm:ss +00. Poiché i valori sono per i campi data le applicazioni client possono inviare YYYY-MM-DD e ignorare hh:mm:ss +00. Se il valore non è nel formato corretto, verrà restituito un errore.
read_only	read_only	boolean	True, se il campo è contrassegnato come di sola lettura nel documento PDF.
validation_rule	validation_rule	string	Una o più regole per la convalida dei campi, i valori possibili sono "MANDATORY" o "OPTIONAL".
convalida	validation		Questo oggetto è per il valore obbligatorio da passare
visibile	visible	boolean	True, se il campo non è nascosto nel documento PDF.
multilinea	multiline	boolean	True, se il campo è multilinea nel documento PDF.
font	font	FontResponse
lunghezza_massima	max_length	integer	Lunghezza massima del contenuto consentita per il riempimento nel campo.
format_type	format_type	string	Se il campo è una casella di testo, può seguire tipi di input diversi. I valori possibili sono ALFANUMERIC, NUMBER, TEXT, EMAIL, TIME o DATE.
segnaposto	placeholder	string	Testo segnaposto per il campo della casella di testo.
format	format	string	Formato testo del campo. Utilizzato solo per il campo tipo di data. I valori possibili sono m/d m/d/yy m/d/aaaaa mm/gg/yy mm/gg/aaaa mm/yy mm/aaaaa d-mmm d-mmm-yy gg-mmm-aaa gg-mmm-yy gg-mmm-yyyy yy-mm-dd aaaa-mm-gg mmm-yy mmm-yyyy mmmm-yy mmmm-aaa mmmm d, aaaaa gg/mm/yy ddmmmyyy
color	color	string	Colore del testo nei campi modulo.
border_color	border_color	string	Colore del bordo del campo modulo.
Descrizione comando	tooltip	string	descrizione comando del campo modulo.
field_rotation	field_rotation	integer	Rotazione dei campi
allineare	align	string	Allineamento del testo per il campo modulo. I valori possibili sono "RIGHT", "LEFT", "CENTER" o "JUSTIFY"
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Nome	Percorso	Tipo	Descrizione
required	required	boolean	True se il campo è obbligatorio in pdf
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
tab_order	tab_order	integer	Ordine di tabulazioni nel documento PDF.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
type	type	string
valore	value	boolean	Valore del campo.
read_only	read_only	boolean	True, se il campo è contrassegnato come readonly nel documento PDF.
validation_rule	validation_rule	string	Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
radio_group_name	radio_group_name	string	Nome del gruppo a cui appartiene il campo.
verificato	checked	boolean	True, se il campo è selezionato
visibile	visible	boolean	True se il campo non è nascosto nel documento PDF.
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Colore del testo nei campi modulo.
border_color	border_color	string	Colore del bordo del campo modulo.
Descrizione comando	tooltip	string	descrizione comando del campo modulo.
field_rotation	field_rotation	integer	Rotazione dei campi

CheckboxFieldResponse

Nome	Percorso	Tipo	Descrizione
required	required	boolean	True se il campo è obbligatorio in pdf
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
tab_order	tab_order	integer	Ordine di tabulazioni nel documento PDF
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
type	type	string
valore	value	boolean	Valore del campo.
read_only	read_only	boolean	True, se il campo è contrassegnato come di sola lettura nel documento PDF.
verificato	checked	boolean	True se il campo è selezionato.
visibile	visible	boolean	True se il campo non è nascosto nel documento PDF.
validation_rule	validation_rule	string	Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Colore del testo nei campi modulo.
border_color	border_color	string	Colore del bordo del campo modulo.
Descrizione comando	tooltip	string	descrizione comando del campo modulo.
field_rotation	field_rotation	integer	Rotazione dei campi

DropdownFieldResponse

Nome	Percorso	Tipo	Descrizione
required	required	boolean	True se il campo è obbligatorio in pdf
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
tab_order	tab_order	integer	Ordine di tabulazioni nel documento PDF.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
validation_rule	validation_rule	string	Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
read_only	read_only	boolean	True, se il campo è contrassegnato come di sola lettura nel documento PDF.
valore	value	string	Valore del campo .
choices	choices	array of string	Scelte disponibili per l'elenco a discesa in cui scegliere un valore.
visibile	visible	boolean	True, se il campo non è nascosto nel documento PDF.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Colore del testo nei campi modulo.
border_color	border_color	string	Colore del bordo del campo modulo.
Descrizione comando	tooltip	string	descrizione comando del campo modulo.
field_rotation	field_rotation	integer	Rotazione dei campi

ListBoxFieldResponse

Nome	Percorso	Tipo	Descrizione
order	order	integer	Ordine del destinatario a cui è assegnato questo campo. Se il campo non è assegnato a nessuno, il valore sarà Null.
tab_order	tab_order	integer	Ordine di tabulazioni nel documento PDF.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
Incorporato	embedded	boolean	True, se il campo fa parte del documento PDF.
validation_rule	validation_rule	string	Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
read_only	read_only	boolean	True, se il campo è contrassegnato come di sola lettura nel documento PDF.
valore	value	string	Valore del campo.
choices	choices	array of string	Scelte disponibili per l'elenco a discesa in cui scegliere un valore.
visibile	visible	boolean	True, se il campo non è nascosto nel documento PDF.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Colore del testo nei campi modulo.
border_color	border_color	string	Colore del bordo del campo modulo.
Descrizione comando	tooltip	string	descrizione comando del campo modulo.
field_rotation	field_rotation	integer	Rotazione dei campi

FontResponse

Nome	Percorso	Tipo	Descrizione
nome	name	string	Nome carattere per il campo di testo. Per i campi definiti dall'utente SigningHub supportano solo "COURIER", "HELVETICA". In caso di campi esistenti in un file PDF, il valore del carattere può essere qualsiasi elemento impostato nel PDF.
size	size	integer	Dimensioni del carattere per il campo di testo.
embedded_size	embedded_size	double	Dimensioni del tipo di carattere nel documento PDF originale.

QrCodeResponse

Nome	Percorso	Tipo	Descrizione
field_name	field_name	string	Identificatore univoco del campo.
type	type	string	Tipo di campo PDF_FIELD_TYPE come qr
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
valore	value	string	QrCode generato base64 verrà fornito in modo in modalità bozza
dimensions	dimensions	FieldDimenssionResponse
data	data	string	Dati di testo normale da codificare nel codice a matrice. Il valore predefinito è l'URL generato per accedere al documento correlato. ad esempio {base_url}/document/{document_unique_id}
options	options		Impostazioni relative alle opzioni
color	color		Impostazioni relative al colore
logo	logo		Impostazioni relative al logo

AttachmentFieldResponse

Nome	Percorso	Tipo	Descrizione
order	order	integer	Ordine del destinatario a cui è assegnato questo campo.
display_order	display_order	integer	Visualizza l'ordine in base al visualizzatore SigningHub.
field_name	field_name	string	Identificatore univoco del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
process_status	process_status	string	Indica se il campo viene elaborato o meno. I valori possibili sono UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Data di elaborazione del documento.
processed_as	processed_as	string	Utente che ha elaborato il campo come COLLABORATORE, DELEGATO, GROUP_MEMBER o PROPRIETARIO.
processed_by	processed_by	string	Indirizzo di posta elettronica dell'utente che ha elaborato il campo.
attachmentRefId	attachmentRefId	integer	Attachmet ref id
nota	note	string	Attachmet nota Solo in caso di regola di allegato "OBBLIGATORIO"
validation_rule	validation_rule		Una o più regole per la convalida dei campi possibili valori sono "MANDATORY" o "OPTIONAL".
dimensions	dimensions		Dimensioni

CommentFieldResponse

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID campo commento
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
unread_count	unread_count	integer	Commenti non letti
privato	private	boolean	Privato
Destinatari	recipients	array of CommentFieldRecipientResponse	Destinatari
dimensions	dimensions		Dimensioni

UniqueIdentifierFieldResponse

Nome	Percorso	Tipo	Descrizione
field_name	field_name	string	Identificatore univoco del campo.
valore	value	string	Valore del campo.
page_no	page_no	integer	Numero di pagina del documento in cui è presente il campo.
font	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

Nome	Percorso	Tipo	Descrizione
user_name	user_name	string	Nome utente
user_email	user_email	string	Indirizzo e-mail dell'utente

oggetto

Si tratta del tipo 'object'.