Legalesign (anteprima)

Progettato per i team legali e operativi incentrati sulla conformità, il connettore Legalesign collega Microsoft Power Platform con legalesign eSignature per attivare flussi di lavoro di documenti e destinatari, inviare promemoria, recuperare PDF e dati del modulo di superficie. Richiede una sottoscrizione legalesign attiva approvata per l'uso dell'API.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

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

Contatto
Nome	Supporto dell'API
URL	https://legalesign.com/contact/
Email	sales@legalesign.com

Metadati del connettore
Editore	Legalesign
Altre informazioni su Legalesign	https://docs.microsoft.com/connectors/legalesign
Sito web	https://legalesign.com
Informativa sulla privacy	https://legalesign.com/opn/privacy/
Categorie	Contenuto e file; Produttività

Legalesign eSignature REST Connector

L'API REST Legalesign supporta i flussi di lavoro eSignature. Questo connettore fornisce l'accesso completo alle API e i trigger in tempo reale, consentendo una perfetta integrazione con Microsoft Power Automate, App per la logica e piattaforme correlate.

Prerequisiti

Per iniziare, è necessario un account Legalesign e una chiave API: 1. Iscriversi per ottenere una versione di valutazione gratuita. 2. Creare un gruppo (un singolo ambiente, ad esempio uno per lo sviluppo e un altro per la produzione). 3. Richiedere una chiave API creando un ticket di supporto. Includere il caso d'uso, la società e il ruolo in modo che il supporto possa verificare l'identità. 4. Dopo la verifica, accedere al dashboard dell'API per recuperare la chiave.

Distribuzione

I nuovi account iniziano in modalità sandbox con le limitazioni seguenti: • I documenti possono essere inviati solo per testare gli indirizzi di posta elettronica configurati nel dashboard dell'API. • Le richieste vengono limitate a 100 minuti.

Quando si è pronti per la pubblicazione, creare un ticket di supporto per passare dall'account sandbox all'ambiente di produzione. A questo punto, le restrizioni verranno revocate. Per informazioni dettagliate, vedere la guida alla distribuzione .

Attivatori

Il connettore supporta due trigger in tempo reale:

• Eventi del documento (ad esempio, creati, rifiutati, firmati, pdf finali creati)
• Eventi del destinatario (ad esempio, completati, rifiutati, aperti tramite posta elettronica, rimbalzi, promemoria inviati)

È possibile ricevere tutti i documenti o i destinatari, di filtrare per gruppo o tipo di evento. Tutti i webhook Legalesign associati possono essere gestiti e monitorati nel dashboard dell'API.

Operations

Sono supportate le operazioni dell'API REST Legalesign. Il più comune include il download di un PDF firmato, la gestione di modelli, documenti, destinatari e posizionamento dei campi. Per la specifica completa, vedere la documentazione completa dell'API .

In Legalesign an upload document is called a 'template'. Quando un modello viene inviato a uno o più destinatari, diventa un "documento". In genere si carica un modello, si recupera l'identificatore, quindi lo si invia a uno o più destinatari.

Le operazioni comuni includono:

Modelli

• Create PDF template - caricare un modello (qualsiasi tipo di file, ad esempio PDF, Word o immagine).
• Get PDF embeddable link - Un collegamento monoutente per mostrare l'editor di modelli a un utente

Documents

• Location to download PDF - restituisce il file binario PDF di un documento firmato
• Create signing document - inviare un documento (selezionare un modello e destinatari)
• Void/archive signing document - interrompere la firma di un documento
• Permanently delete signing document - rimuovere un documento per sempre

Destinatari (firmatari)

• Send signer reminder email - ricordare al destinatario di completare il documento
• Get signer rejection reason - se il documento viene rifiutato, vedere perché

Posizionamento dei campi

Legalesign ha un sistema di modulo avanzato con campi. Se avete sottoscrittori, ogni firmatario deve avere almeno un campo di firma.

Esistono quattro modi per definire i campi nel modello:

1. Caricare un PDF con campi incorporati (convertito automaticamente da Legalesign).
2. Usare i tag di testo Legalesign.
3. Definire le coordinate x/y.
4. Usare l'editor di moduli Legalesign (tramite il collegamento di incorporamento o l'app Web).

Fare clic qui per la guida

Query e supporto

Per ulteriori supporto o query, accedere all'account Legalesign e creare un ticket di supporto.

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

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

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

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

Nome	TIPO	Description	Obbligatorio
chiave_api	securestring	Il api_key per questa API	Vero

Limiti per la limitazione delle richieste

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

Azioni

Caricare l'allegato PDF	Salvare un pdf da allegare a un messaggio di posta elettronica del destinatario.
Caricare un modello PDF	Caricare un documento PDF da inviare per la firma.
Documento void e archivio	Imposta un documento con stato 40 -rimosso- e lo archivia.
Eliminare definitivamente il documento	Elimina definitivamente i dati e i file.
Eliminare un allegato	Eliminare un allegato.
Invia documento	Inviare un documento per la firma o l'approvazione.
Invia messaggio di posta elettronica di promemoria del destinatario	Inviare un messaggio di posta elettronica di promemoria a un destinatario.
Membri dei gruppi	Elenchi di tutti i membri dei gruppi.
Membro di un gruppo	Dettagli di un utente specifico all'interno di un gruppo.
Ottenere allegati	Elencare gli allegati.
Ottenere documenti	Elencare i documenti di firma non crittografati.
Ottenere gruppi	Elenca i gruppi a cui appartiene l'utente api.
Ottenere i campi del documento	Campi del documento.
Ottenere i campi modulo destinatario	Restituisce i campi modulo da un destinatario specifico.
Ottenere il collegamento del destinatario	Collegamento mono use per il destinatario per passare alle pagine di firma.
Ottenere il collegamento incorporabile pdf	Restituisce un collegamento monotono per incorporare l'editor PDF.
Ottenere il destinatario	Ottenere lo stato e i dettagli di un singolo destinatario.
Ottenere il motivo del rifiuto del destinatario	Restituisce il firmatario motivo fornito per rifiutare un documento.
Ottenere l'allegato	Ottenere un allegato.
Ottenere l'utente	Ottenere i dettagli dell'utente.
Ottenere modelli PDF	Elencare i modelli PDF
Ottenere un documento	Restituisce un documento specifico.
Ottenere un modello PDF	Dettagli di un modello PDF specifico
Scarica PDF	Ottenere la bozza o il PDF finale per un documento di firma, a seconda del relativo stato. Si noti che è possibile una risposta 200 o 302.
Scaricare il log di controllo del documento	PDF solo del auditlog del documento.

Caricare l'allegato PDF

ID operazione:

PostAttachment

Salvare un pdf da allegare a un messaggio di posta elettronica del destinatario.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
group	group	True	string	URI risorsa gruppo
pdf_file	pdf_file	True	byte	I dati dei file PDF con codifica Base64, la dimensione massima è un'impostazione di gruppo, 5 MB per impostazione predefinita.
filename	filename	True	string	Nome alfanumerico semplice che termina .pdf
utente	user		string	Assegnare a un altro utente.
descrizione	description		string

Caricare un modello PDF

ID operazione:

PostPdfTemplate

Caricare un documento PDF da inviare per la firma.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Archivio al momento dell'invio	archive_upon_send		boolean	Impostare true se questo caricamento sarà solo per un solo utilizzo.
Gruppo	group	True	string	Specificare il gruppo in cui verrà usato.
File PDF	pdf_file	True	byte	Dati di file PDF con codifica Base64.
Tag di processo	process_tags		boolean	Se il file contiene tag di testo, convertirli in campi.
Titolo	title		string	Assegnare al record il nome del file, se non utilizzato.
User	user		string	Assegnare al membro del gruppo se non all'utente api.

Documento void e archivio

ID operazione:

UpdateArchiveDocument

Imposta un documento con stato 40 -rimosso- e lo archivia.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	docId	True	uuid	ID documento
Inviare un messaggio di posta elettronica di notifica al destinatario	email		string	Se impostato su true o 1, i destinatari ricevono una notifica che il documento viene annullato.

Eliminare definitivamente il documento

ID operazione:

DeleteDocument

Elimina definitivamente i dati e i file.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	docId	True	uuid	ID documento

Eliminare un allegato

ID operazione:

DeleteAttachment

Eliminare un allegato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID allegato	attachId	True	uuid	Attach Id

Invia documento

ID operazione:

PostDocument

Inviare un documento per la firma o l'approvazione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Gruppo	group	True	string	URI risorsa gruppo
Nome	name	True	string	Specificare il nome del documento
Modello PDF	templatepdf	True	string	Pdf caricato da inviare.
posta elettronica	email	True	email	Email
nome di battesimo	firstname	True	string	Nome di battesimo
Cognome	lastname	True	string	Cognome
allegati	attachments		array of string	Elenco degli URI delle risorse degli allegati.
expires	expires		date-time	ISO8601 formato datetime, impostato su TZ del mittente o del fuso orario, se usato
message	message		string	Il messaggio personale per la festa, inserito al centro del modello di posta elettronica del gruppo. Usare il nome di un modello di posta elettronica salvato preceduto da un simbolo hash per usare tale modello. Se è presente più di un modello con lo stesso nome, selezionerà l'ultima modifica.
nome di battesimo	firstname		string	Nome di battesimo
Cognome	lastname		string	Cognome
posta elettronica	email	True	email	Email
include_link	include_link		boolean	Includere un collegamento alle pagine di firma che consentono a un revisore di firmare
messaggio di testo	sms		string	Usare il numero di formato internazionale per aggiungere la verifica SMS. Obbligatorio se un server di controllo del mirroring o un firmatario di controllo del mirroring.
Oggetto	subject		string	Riga dell'oggetto per la posta elettronica in uscita
timezone	timezone		string	TZ del firmatario deve essere valido TZ in base al fuso orario(vedere User for timezoneenum details). Se blank usa tz del mittente.
Tipo di firma	signature_type		integer	Usa 4 per ottenere la certificazione PDF eseguita. Consigliato. Il valore predefinito è 1 (usa un hash sha256 per l'integrità del documento).
Aggiungi PDF	append_pdf		boolean	Aggiungere le informazioni di convalida legalesign al PDF finale.
auto_archive	auto_archive		boolean	Invia all'archivio subito dopo la firma. Mantiene senza confusione l'app Web
Usare i messaggi di posta elettronica legalesign	do_email		boolean	Usare l'indirizzo di posta elettronica Legalesign per inviare messaggi di posta elettronica di notifica. Se false elimina tutti i messaggi di posta elettronica.
CC al completamento	cc_emails		string	Stringa delimitata da virgole di indirizzi di posta elettronica che ricevono una notifica di firma o rifiuto.
Convertire i campi mittente vuoti in campi del primo destinatario	convert_sender_to_signer		boolean	Se i campi del mittente vengono lasciati vuoti, convertirli in campi per il primo destinatario.
Password PDF	pdf_password		string	Impostare una password. Deve essere in grado di codificare ascii, è necessario impostare anche signature_type su 4 e scegliere un pdf_password_type.
Impostazioni password PDF	pdf_password_type		integer	1 per archiviare la password, 2 per eliminare dai nostri record al momento della firma finale.
pdftext	pdftext		object	Assegnare valori ai campi del mittente PDF, usare l'etichetta del campo del modello o il relativo uuid come chiavi oggetto. Vedere templatepdf/:id/fields/ e filtrare per element_type="admin", per ottenere campi pertinenti con l'etichetta o l'uuid. Vedere anche strict_fields.
Reindirizza URL	redirect		string	URL a cui inviare il firmatario dopo la firma (anziché la pagina di download). L'URL includerà parametri di query con informazioni sull'ID e sullo stato come indicato di seguito: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Pianificazione promemoria	reminders		string	Inserisci "default" se vuoi usare la pianificazione predefinita del promemoria nel gruppo (vai all'app Web per impostare la pianificazione predefinita)
Collegamenti del firmatario di restituzione	return_signer_links		boolean	Restituisce i collegamenti al documento per gli accessi nel corpo della risposta.
invio sequenziazione	signers_in_order		boolean	Notificare ai firmatari nella sequenza di ordine. Se false tutte ricevono una notifica simulatanea.
signertext	signertext		object	Aggiungere segnaposto personalizzati ai campi del firmatario. Usare etichette di campo o uuid come chiavi nell'oggetto (come per pdftext). Vedere templatepdf/:id/fields/ e filtrare per element_type = "text" per ottenere campi pertinenti con le relative etichette o uuid.
Imponi convalida dei campi	strict_fields		boolean	Pdftext non riesce a eseguire i controlli di convalida in modo invisibile all'utente, impostare true per la convalida.
Riferimento	tag		string	Tag
Riferimento	tag1		string	Tag
Riferimento	tag2		string	Tag
utente	user		string	Assegnare un documento a un altro utente nel gruppo.

Invia messaggio di posta elettronica di promemoria del destinatario

ID operazione:

PostSignerReminder

Inviare un messaggio di posta elettronica di promemoria a un destinatario.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID destinatario	recipientId	True	uuid	ID destinatario
text	text		string	Testo del messaggio personalizzato

Membri dei gruppi

ID operazione:

GetMembers

Elenchi di tutti i membri dei gruppi.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID gruppo	group		string	Filtrare in base a un gruppo specifico
Limite di query	limit		integer	Usare con offset per scorrere i risultati.
Offset di query	offset		integer	Usare con limite per scorrere i risultati.

Restituisce

Corpo

MemberListResponse

Membro di un gruppo

ID operazione:

GetMember

Dettagli di un utente specifico all'interno di un gruppo.

Parametri

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

Restituisce

Corpo

MemberResponse

Ottenere allegati

ID operazione:

GetAttachments

Elencare gli allegati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID gruppo	group		string	Filtrare in base a un gruppo specifico.
Limite di query	limit		integer	Usare con offset per scorrere i risultati.
Offset di query	offset		integer	Usare con limite per scorrere i risultati.

Restituisce

Elenco allegati

Corpo

AttachmentListResponse

Ottenere documenti

ID operazione:

GetDocuments

Elencare i documenti di firma non crittografati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID gruppo	group	True	string	Filtrare in base a un gruppo specifico, obbligatorio.
Includere documenti archiviati	archived		string	Filtrare in base allo stato archiviato, il valore predefinito è non crittografato, usare il valore tutto in questo parametro per eseguire query su tutti i documenti.
Filtrare in base al messaggio di posta elettronica del destinatario	email		string	Filtra in base al messaggio di posta elettronica del destinatario.
Limite di query	limit		integer	Lunghezza del set di dati da restituire. Usare con la query offset per scorrere i risultati.
Offset di query	offset		integer	Offset dall'inizio del set di dati. Usare con la query limite per scorrere il set di dati.
Filtrare in base allo stato del documento	status		integer	Filtrare in base allo stato del documento.
Rimuovere i destinatari dalla risposta	nosigners		string	Aggiungere il valore 1 per rimuovere le informazioni sui destinatari per una query più veloce.
Filtrare per la creazione dopo questa data	created_gt		date-time	Filtrare i documenti creati dopo un determinato periodo di tempo.
Filtro per la modifica dopo questa data	modified_gt		date-time	Filtrare i documenti modificati dopo un determinato periodo di tempo.

Restituisce

Elenchi di documenti

Corpo

DocumentListResponse

Ottenere gruppi

ID operazione:

GetGroups

Elenca i gruppi a cui appartiene l'utente api.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Offset di query	offset		integer	Offset dall'inizio del set di dati. Usare con la query limite per scorrere il set di dati.
Limite di query	limit		integer	Lunghezza del set di dati da restituire. Usare con la query offset per scorrere i risultati.

Restituisce

Elenco dei gruppi

Corpo

GroupListResponse

Ottenere i campi del documento

ID operazione:

GetDocumentFields

Campi del documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	docId	True	uuid	ID documento

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object	Elenco dei campi documento
element_type	element_type	string	Tipo di elemento
fieldorder	fieldorder	integer	Ordine dei campi
label	label	string	Etichetta
label_extra	label_extra	string	Etichetta aggiuntiva
firmatario	signer	integer	Destinatario
state	state	boolean
convalida	validation	integer	Identificatore di convalida
value	value	string	Value

Ottenere i campi modulo destinatario

ID operazione:

GetSignerFields

Restituisce i campi modulo da un destinatario specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID destinatario	recipientId	True	uuid	ID destinatario

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
label	label	string	Etichetta
label_extra	label_extra	string	Etichetta aggiuntiva
state	state	boolean	stato
fieldorder	fieldorder	integer	Ordine dei campi
value	value	string	Se il campo è un file firmatario, questo valore sarà un URL di download di breve durata.

Ottenere il collegamento del destinatario

ID operazione:

GetSignerLink

Collegamento mono use per il destinatario per passare alle pagine di firma.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID destinatario	recipientId	True	uuid	ID destinatario

Ottenere il collegamento incorporabile pdf

ID operazione:

GetPdfTemplateEditLink

Restituisce un collegamento monotono per incorporare l'editor PDF.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pdf Id	pdfId	True	string	Impostare l'ID PDF caricato.
Nascondere l'elenco di campi dalla pagina di cui è stato eseguito il rendering	hide_sender_fields		boolean	Nascondere l'elenco di campi dalla pagina di cui è stato eseguito il rendering.
Codice esadecimale escluso il simbolo hash per il colore di sfondo	css_body_backgroundcolor		string	Usare il codice esadecimale escluso il simbolo hash per modificare il colore di sfondo.

Ottenere il destinatario

ID operazione:

GetRecipient

Ottenere lo stato e i dettagli di un singolo destinatario.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID destinatario	recipientId	True	uuid	ID destinatario

Restituisce

Dettagli destinatario

Corpo

SignerResponse

Ottenere il motivo del rifiuto del destinatario

ID operazione:

GetSignerRejection

Restituisce il firmatario motivo fornito per rifiutare un documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID destinatario	recipientId	True	uuid	ID destinatario

Restituisce

Nome	Percorso	Tipo	Descrizione
status	status	integer	Statue del destinatario.
reason	reason	string	Rifiutare il motivo.

Ottenere l'allegato

ID operazione:

GetAttachment

Ottenere un allegato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID allegato	attachId	True	uuid	ID allegato

Restituisce

Allegare l'elemento.

Corpo

AttachmentResponse

Ottenere l'utente

ID operazione:

GetUser

Ottenere i dettagli dell'utente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID utente	userId	True	uuid	ID utente

Restituisce

Dettagli dell'utente.

Corpo

UserDetailResponse

Ottenere modelli PDF

ID operazione:

GetPdfTemplates

Elencare i modelli PDF

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID gruppo	group		string	Può essere completo resource_uri o solo ID.
Limite di query	limit		integer	Lunghezza del set di dati da restituire. Usare con la query offset per scorrere i risultati.
Offset di query	offset		integer	Offset dall'inizio del set di dati. Usare con la query limite per scorrere il set di dati.

Restituisce

Elenchi di modelli

Corpo

TemplatePdfListResponse

Ottenere un documento

ID operazione:

GetDocument

Restituisce un documento specifico.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	docId	True	uuid	ID documento

Restituisce

Dettagli documento

Corpo

DocumentResponseDetail

Ottenere un modello PDF

ID operazione:

GetPdfTemplate

Dettagli di un modello PDF specifico

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID PDF caricato	pdfId	True	uuid	ID PDF caricato

Restituisce

Dettagli modello

Corpo

TemplatePdfResponse

Scarica PDF

ID operazione:

GetDocumentPdf

Ottenere la bozza o il PDF finale per un documento di firma, a seconda del relativo stato. Si noti che è possibile una risposta 200 o 302.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	docId	True	uuid	ID documento

Restituisce

response

file

Scaricare il log di controllo del documento

ID operazione:

GetDocumentAuditLog

PDF solo del auditlog del documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID documento	docId	True	uuid	ID documento

Restituisce

response

file

Trigger

Evento destinatario	Trigger per quando si verifica un evento del destinatario
Evento document	Si verifica un trigger per un evento di documento

Evento destinatario

ID operazione:

RecipientTrigger

Trigger per quando si verifica un evento del destinatario

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
eventFilter	eventFilter	True	string	Filtro eventi
group	group		string	Filtro di gruppo

Restituisce

Nome	Percorso	Tipo	Descrizione
version	version	string	Versione
oggetto	object	string	Oggetto
tag	data.tag	string	Tag
tag1	data.tag1	string	Tag1
tag2	data.tag2	string	Tag2
UUID (Identificatore Unico Universale)	data.uuid	string	ID destinatario
posta elettronica	data.email	string	Email
group	data.group	string	Gruppo
order	data.order	integer	Ordinamento
status	data.status	integer	stato
documento	data.document	string	Documento
Cognome	data.lastname	string	Cognome
roleText	data.roleText	string	Testo del ruolo
nome di battesimo	data.firstname	string	Nome di battesimo
statoTesto	data.statusText	string	Testo Stato
emailBounce	data.emailBounce	integer	Il messaggio di posta elettronica è stato rimbalzato
resourceUri	data.resourceUri	string	URI risorsa destinatario
Nome documento	data.documentName	string	Nome documento
rejectReason	data.rejectReason	string	Rifiuta motivo
groupResourceUri	data.groupResourceUri	string	URI risorsa gruppo
emailBounceMessage	data.emailBounceMessage	string	Messaggio di mancato recapito della posta elettronica
documentResourceUri	data.documentResourceUri	string	URI risorsa documento
created	created	integer	Created
id	id	string	Documento d'identità
evento	event	string	Event

Evento document

ID operazione:

DocumentTrigger

Si verifica un trigger per un evento di documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
eventFilter	eventFilter	True	string	Filtro eventi
group	group		string	Filtro di gruppo

Restituisce

Nome	Percorso	Tipo	Descrizione
version	version	string	Versione
oggetto	object	string	Oggetto
tag1	data.tag1	string	Tag
recipients	data.recipients	array of object	Destinatari
UUID (Identificatore Unico Universale)	data.recipients.uuid	string	ID destinatario
posta elettronica	data.recipients.email	string	Messaggio di posta elettronica destinatario
order	data.recipients.order	integer	Numero ordine destinatario
status	data.recipients.status	integer	Stato destinatario
Cognome	data.recipients.lastname	string	Cognome destinatario
roleText	data.recipients.roleText	string	Testo del ruolo destinatario
nome di battesimo	data.recipients.firstname	string	Nome destinatario
statoTesto	data.recipients.statusText	string	Stato destinatarioText
resourceUri	data.recipients.resourceUri	string	URI risorsa destinatario
rejectReason	data.recipients.rejectReason	string	rejectReason
groupResourceUri	data.groupResourceUri	string	URI risorsa gruppo
statoTesto	data.statusText	string	Testo dello stato del documento
nome	data.name	string	Nome documento
tag	data.tag	string	Tag
resourceUri	data.resourceUri	string	URI risorsa
UUID (Identificatore Unico Universale)	data.uuid	string	ID documento
tag2	data.tag2	string	Tag2
group	data.group	string	Gruppo
status	data.status	integer	Stato documento
created	created	integer	Created
id	id	string	Fatto
evento	event	string	Event

Definizioni

PermissionsEnum

Opzione autorizzazione

Opzione autorizzazione

integer

ListMeta

Meta informazioni sull'inserzione.

Nome	Percorso	Tipo	Descrizione
limit	limit	integer	Numero massimo di oggetti.
next	next	string	URL per il set successivo di oggetti.
offset	offset	integer	Numero di elementi dall'inizio del set di risultati.
precedente	previous	string	URL per il set di oggetti precedente.
total_count	total_count	integer	Numero totale di oggetti.

GroupListResponse

Elenco dei gruppi

Nome	Percorso	Tipo	Descrizione
meta	meta	ListMeta	Meta informazioni sull'inserzione.
oggetti	objects	array of object
created	objects.created	date-time	Created
is_active	objects.is_active	boolean	Active
Volta	objects.modified	date-time	Modificato
nome	objects.name	string	Nome
public_name	objects.public_name	string	Nome pubblico
resource_uri	objects.resource_uri	string	URI risorsa
Lumaca	objects.slug	string	Nome univoco
utente	objects.user	string	URI risorsa autore
xframe_allow	objects.xframe_allow	boolean	Consenti firma di incorporamento
xframe_allow_pdf_edit	objects.xframe_allow_pdf_edit	boolean	Consenti modifica incorporamento

TemplatePdfListResponse

Elenchi di modelli

Nome	Percorso	Tipo	Descrizione
meta	meta	ListMeta	Meta informazioni sull'inserzione.
oggetti	objects	array of TemplatePdfResponse

TemplatePdfResponse

Dettagli modello

Nome	Percorso	Tipo	Descrizione
created	created	date-time	Created
group	group	string	URI gruppo
Volta	modified	date-time	Modificato
Parti	parties	string	Matrice stringata JSON di parti di documento.
page_count	page_count	integer	Conteggio pagine
resource_uri	resource_uri	string	URI risorsa
signer_count	signer_count	integer	Conteggio dei firmatari
title	title	string	Titolo
utente	user	string	URI risorsa dell'autore
UUID (Identificatore Unico Universale)	uuid	uuid	Pdf Id
valido	valid	boolean	Può essere inviato (se i campi non vengono convalidati).

DocumentListResponse

Elenchi di documenti

Nome	Percorso	Tipo	Descrizione
meta	meta	ListMeta	Meta informazioni sull'inserzione.
oggetti	objects	array of object	Documents
Archiviati	objects.archived	boolean	Archived
auto_archive	objects.auto_archive	boolean	Archivio dopo l'invio.
cc_emails	objects.cc_emails	string	Messaggi di posta elettronica di elenco delimitati da virgole a cc al completamento.
created	objects.created	date-time	Created
do_email	objects.do_email	boolean	Usare i messaggi di posta elettronica Legalesign.
download_final	objects.download_final	boolean	È pronto per il download dopo il completamento.
group	objects.group	string	URI della risorsa del gruppo.
Volta	objects.modified	date-time	Modificato
nome	objects.name	string	Nome documento
pdftext	objects.pdftext	string	Valori dei campi mittente
reindirizzare	objects.redirect	string	URL per reindirizzare il destinatario dopo la firma
resource_uri	objects.resource_uri	string	URI risorsa
return_signer_links	objects.return_signer_links	boolean	Aggiungere collegamenti destinatari alla risposta
Firmatari	objects.signers	array of array	Matrici annidate con i dettagli del firmatario
items	objects.signers	array of	Contiene sempre [URI firmatario, nome, cognome, indirizzo di posta elettronica, numero SMS, has_fields, stato, ordine del firmatario (0 indicizzato)]
signers_in_order	objects.signers_in_order	integer	Destinatari di posta elettronica simulati o sequenziali
status	objects.status	DocumentStatusEnum	Opzioni di stato del documento: 10 - Stato iniziale, controllare lo stato del firmatario per sent/unsent 20 - Campi completati 30 - Firmato 40 - Rimosso (prima della firma) 50 - Rifiutato
tag	objects.tag	string	Documento tag
tag1	objects.tag1	string	Documento tag
tag2	objects.tag2	string	Documento tag
modello	objects.template	string	URI risorsa modello se usato
templatepdf	objects.templatepdf	string	URI risorsa modello PDF
text	objects.text	string	Testo per la firma
utente	objects.user	string	URI creatore
UUID (Identificatore Unico Universale)	objects.uuid	uuid	ID documento

DocumentStatusEnum

Opzioni di stato del documento:

• 10 - Stato iniziale, controllare lo stato del firmatario per sent/unsent
• 20 - Campi completati
• 30 - Firmato
• 40 - Rimosso (prima della firma)
• 50 - Rifiutato

Opzioni di stato del documento:

• 10 - Stato iniziale, controllare lo stato del firmatario per sent/unsent
• 20 - Campi completati
• 30 - Firmato
• 40 - Rimosso (prima della firma)
• 50 - Rifiutato

integer

SignerResponse

Dettagli destinatario

Nome	Percorso	Tipo	Descrizione
documento	document	string	Documento
posta elettronica	email	string	Messaggio di posta elettronica destinatario
first_name	first_name	string	Nome destinatario
last_name	last_name	string	Cognome destinatario
has_fields	has_fields	boolean	Il destinatario ha campi
order	order	integer	Ordine destinatario
resource_uri	resource_uri	string	URI risorsa destinatario
status	status	SignerStatusEnum	Opzioni di stato del firmatario: 4 - non inviato 5 - programmato per l'invio 10 - inviato 15 - Messaggio di posta elettronica aperto 20 - visitato 30 - Campi completati 35 - Campi completi ex firma 39 - In attesa del completamento del mirroring 40 - firmato 50 - scaricato 60 - rifiutato

SignerStatusEnum

Opzioni di stato del firmatario:

• 4 - non inviato
• 5 - programmato per l'invio
• 10 - inviato
• 15 - Messaggio di posta elettronica aperto
• 20 - visitato
• 30 - Campi completati
• 35 - Campi completi ex firma
• 39 - In attesa del completamento del mirroring
• 40 - firmato
• 50 - scaricato
• 60 - rifiutato

Opzioni di stato del firmatario:

• 4 - non inviato
• 5 - programmato per l'invio
• 10 - inviato
• 15 - Messaggio di posta elettronica aperto
• 20 - visitato
• 30 - Campi completati
• 35 - Campi completi ex firma
• 39 - In attesa del completamento del mirroring
• 40 - firmato
• 50 - scaricato
• 60 - rifiutato

integer

DocumentResponseDetail

Dettagli documento

Nome	Percorso	Tipo	Descrizione
Archiviati	archived	boolean	È archiviato
auto_archive	auto_archive	boolean	Invia archivio documenti dopo la firma.
cc_emails	cc_emails	string	Chi sarà cc'd con il mittente alla notifica di posta elettronica quando è firmata
created	created	date-time	Created
do_email	do_email	boolean	Usare i messaggi di posta elettronica legalesign
download_final	download_final	boolean	Il PDF finale è disponibile per il download
piè di pagina	footer	string	Documentazione HTML : testo per il piè di pagina se usato
footer_height	footer_height	integer	Docs HTMl : altezza px del piè di pagina se usata
group	group	string	URI risorsa del gruppo
has_fields	has_fields	boolean	Il documento contiene campi
hash_value	hash_value	string	Checksum SHA256 del documento finale, usarlo per convalidare il download del PDF finale
intestazione	header	string	Documentazione HTML : testo per l'intestazione se usato
header_height	header_height	integer	Docs HTMl : altezza px dell'intestazione se usata
Volta	modified	date-time	Modificato
nome	name	string	Nome documento
pdf_password	pdf_password	string	Password PDF
pdf_password_type	pdf_password_type	string	Se la password pdf viene mantenuta
pdftext	pdftext	string	Ignorare questa impostazione
reindirizzare	redirect	string	URL per il reindirizzamento del destinatario dopo la firma
resource_uri	resource_uri	string	URI risorsa
return_signer_links	return_signer_links	boolean	Ignora
sign_mouse	sign_mouse	boolean	ignorare
sign_time	sign_time	date-time	Ora di firma
sign_type	sign_type	boolean	eredità
sign_upload	sign_upload	boolean	eredità
signature_placement	signature_placement	integer	eredità
signature_type	signature_type	integer	legacy - sempre 4
Firmatari	signers	array of array	Matrici annidate con i dettagli del firmatario
items	signers	array of	Contiene sempre [URI firmatario, nome, cognome, indirizzo di posta elettronica, numero SMS, has_fields, stato, ordine del firmatario (0 indicizzato)]
signer_objects	signer_objects	array of object	Elenco dei destinatari
posta elettronica	signer_objects.email	string	Email
nome di battesimo	signer_objects.firstname	string	Nome di battesimo
Cognome	signer_objects.lastname	string	Cognome
Tel	signer_objects.tel	string	Numero tel
order	signer_objects.order	integer	Ordine di firma
resource_uri	signer_objects.resource_uri	string	URI risorsa
ruolo	signer_objects.role	string	Ruolo
status	signer_objects.status	integer	Codice di stato del destinatario
UUID (Identificatore Unico Universale)	signer_objects.uuid	string	ID destinatario
signers_in_order	signers_in_order	boolean	Destinatari di posta elettronica simulati o sequenziali
status	status	DocumentStatusEnum	Opzioni di stato del documento: 10 - Stato iniziale, controllare lo stato del firmatario per sent/unsent 20 - Campi completati 30 - Firmato 40 - Rimosso (prima della firma) 50 - Rifiutato
tag	tag	string	Riferimento
tag1	tag1	string	Riferimento
tag2	tag2	string	Riferimento
modello	template	string	URI risorsa per il modello di testo se usato
templatepdf	templatepdf	string	URI risorsa per il modello PDF se usato
text	text	string	Testo per il documento se usato
utente	user	string	URI risorsa utente.
UUID (Identificatore Unico Universale)	uuid	uuid	ID documento

MemberListResponse

Nome	Percorso	Tipo	Descrizione
meta	meta	ListMeta	Meta informazioni sull'inserzione.
oggetti	objects	array of MemberResponse

MemberResponse

Nome	Percorso	Tipo	Descrizione
created	created	date-time	Created
group	group	string	URI risorsa gruppo
Volta	modified	date-time	Modificato
autorizzazione	permission	PermissionsEnum	Opzione autorizzazione
resource_uri	resource_uri	string	URI risorsa
utente	user	string	URI risorsa utente.

AttachmentResponse

Allegare l'elemento.

Nome	Percorso	Tipo	Descrizione
created	created	date-time	Created
descrizione	description	string	Description
filename	filename	string	Nome del file
group	group	string	Gruppo
resource_uri	resource_uri	string	Allegare l'URI della risorsa
utente	user	string	URI risorsa utente
UUID (Identificatore Unico Universale)	uuid	uuid	Attach Id

AttachmentListResponse

Elenco allegati

Nome	Percorso	Tipo	Descrizione
meta	meta	ListMeta	Meta informazioni sull'inserzione.
oggetti	objects	array of object	Elencazione
created	objects.created	date-time	Created
descrizione	objects.description	string	Description
filename	objects.filename	string	Nome del file
group	objects.group	string	Gruppo
resource_uri	objects.resource_uri	string	URI risorsa
utente	objects.user	string	URI risorsa utente
UUID (Identificatore Unico Universale)	objects.uuid	uuid	Attach Id

UserDetailResponse

Dettagli dell'utente.

Nome	Percorso	Tipo	Descrizione
date_joined	date_joined	date-time	Data di aggiunta
posta elettronica	email	email	Email
first_name	first_name	string	Nome di battesimo
groups	groups	array of string	Elenco di gruppi a cui è stato aggiunto l'utente.
last_login	last_login	date-time	Ultimo accesso
last_name	last_name	string	Cognome
resource_uri	resource_uri	string	URI risorsa
timezone	timezone	string	Fuso orario
username	username	string	Nome utente

documento

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