Partager via

Legalesign (préversion)

Conçu pour les équipes juridiques et opérationnelles axées sur la conformité, le connecteur Legalesign lie La plateforme d’alimentation Microsoft avec l’eSignature Legalesign pour déclencher des flux de travail de document et de destinataire, envoyer des rappels, extraire des fichiers PDF et des données de formulaire surface. Nécessite un abonnement Legalesign actif approuvé pour l’utilisation de l’API.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge des API
URL https://legalesign.com/contact/
Messagerie électronique sales@legalesign.com
Métadonnées du connecteur
Éditeur Legalesign
En savoir plus sur Legalesign https://docs.microsoft.com/connectors/legalesign
Site internet https://legalesign.com
Politique de confidentialité https://legalesign.com/opn/privacy/
Catégories Contenu et fichiers ; Productivité

Legalesign eSignature REST Connector

L’API REST Legalesign alimente les flux de travail eSignature. Ce connecteur fournit un accès à l’API complet et des déclencheurs en temps réel, ce qui permet une intégration transparente avec Microsoft Power Automate, Logic Apps et les plateformes associées.

Prerequisites

Pour commencer, vous avez besoin d’un compte Legalesign et d’une clé API : 1. Inscrivez-vous à un essai gratuit. 2. Créez un groupe (un environnement individuel, par exemple, un pour le développement et un autre pour la production). 3. Demandez une clé API en créant un ticket de support. Incluez votre cas d’usage, votre entreprise et votre rôle afin que le support puisse vérifier votre identité. 4. Une fois vérifié, connectez-vous au tableau de bord de l’API pour récupérer votre clé.

Déploiement

Les nouveaux comptes démarrent en mode bac à sable avec les limitations suivantes : • Les documents peuvent uniquement être envoyés pour tester les adresses e-mail que vous configurez dans le tableau de bord de l’API. • Les demandes sont limitées à 100/minute.

Lorsque vous êtes prêt à être en direct, créez un ticket de support pour basculer votre compte du bac à sable vers la production. À ce stade, les restrictions seront levées. Pour plus d’informations, consultez le guide de déploiement .

Triggers

Le connecteur prend en charge deux déclencheurs en temps réel :

  • Événements de document (par exemple, créés, rejetés, signés, PDF finals créés)
  • Événements de destinataire (par exemple, terminé, rejeté, e-mail ouvert, rebond, rappels envoyés)

Vous pouvez recevoir tous les documents ou destinataires, de filtre par groupe ou type d’événement. Tous les webhooks Legalesign associés peuvent être gérés et surveillés dans le tableau de bord de l’API.

Operations

Les opérations de l’API REST Legalesign sont prises en charge. Les plus courants incluent le téléchargement d’un fichier PDF signé, la gestion des modèles, des documents, des destinataires et du placement de champ. Consultez la documentation complète de l’API pour obtenir la spécification complète.

Dans Legalesign, un document chargé est appelé « modèle ». Lorsqu’un modèle est envoyé à un ou plusieurs destinataires, il devient un « document ». Vous chargez généralement un modèle, récupérez son identificateur, puis envoyez-le à un ou plusieurs destinataires.

Les opérations courantes sont les suivantes :

Modèles

  • Create PDF template - chargez un modèle (n’importe quel type de fichier, tel que PDF, Word ou image).
  • Get PDF embeddable link - lien à usage unique pour afficher l’éditeur de modèle à un utilisateur

Documents

  • Location to download PDF - retourne le fichier binaire PDF d’un document signé
  • Create signing document - envoyer un document (sélectionner un modèle et des destinataires)
  • Void/archive signing document - empêcher la signature d’un document
  • Permanently delete signing document - Supprimer un document pour toujours

Destinataires (signataires)

  • Send signer reminder email - rappeler au destinataire de terminer votre document
  • Get signer rejection reason - si le document est rejeté, voir pourquoi

Positionnement de champ

Legalesign a un système de formulaire avancé avec des champs. Si vous avez des signataires, chaque signataire doit avoir au moins un champ de signature.

Il existe quatre façons de définir des champs dans votre modèle :

  1. Chargez un FICHIER PDF avec des champs incorporés (convertis automatiquement par Legalesign).
  2. Utilisez des balises de texte Legalesign.
  3. Définissez les coordonnées x/y.
  4. Utilisez l’éditeur de formulaire Legalesign (via le lien incorporé ou l’application web).

Cliquez ici pour le guide

Requêtes et prise en charge

Pour obtenir un support ou des requêtes supplémentaires, connectez-vous à votre compte Legalesign et créez un ticket de support.

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :
Par défaut Paramètres de création de connexion. Toutes les régions Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.

Nom Type Descriptif Obligatoire
Clé API securestring La api_key de cette API Vrai

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Charger un modèle PDF

Chargez un document PDF que vous souhaitez envoyer à signer.
Charger une pièce jointe PDF

Enregistrez un fichier pdf à joindre à un e-mail de destinataire.
Envoyer un document

Envoyez un document à des fins de signature ou d’approbation.
Envoyer un e-mail de rappel de destinataire

Envoyez un e-mail de rappel à un destinataire.
Membre d’un groupe

Détails d’un utilisateur spécifique au sein d’un groupe.
Membres de groupes

Liste de tous les membres de vos groupes.
Obtenir des champs de document

Champs du document.
Obtenir des documents

Répertorier les documents de signature nonarchivés.
Obtenir des groupes

Répertorie les groupes auxquels appartient l’utilisateur d’API.
Obtenir des modèles PDF

Répertorier les modèles PDF
Obtenir la raison du rejet du destinataire

Retourne la raison pour laquelle le signataire a donné pour rejeter un document.
Obtenir le destinataire

Obtenez l’état et les détails d’un destinataire individuel.
Obtenir le lien du destinataire

Lien à usage unique permettant au destinataire d’accéder aux pages de signature.
Obtenir les champs de formulaire du destinataire

Retourne les champs de formulaire d’un destinataire spécifique.
Obtenir un document

Retourne un document spécifique.
Obtenir un lien incorporé PDF

Retournez un lien à usage unique pour incorporer l’éditeur PDF.
Obtenir un modèle PDF

Détails d’un modèle PDF spécifique
Obtenir un utilisateur

Obtenir les détails de l’utilisateur.
Obtenir une pièce jointe

Obtenir une pièce jointe.
Obtention de pièces jointes

Répertorier les pièces jointes.
Supprimer définitivement le document

Supprime définitivement les données et les fichiers.
Supprimer une pièce jointe

Supprimez une pièce jointe.
Télécharger le journal d’audit du document

PDF du journal d’audit du document uniquement.
Télécharger le PDF

Obtenez le pdf brouillon ou final d’un document de signature, en fonction de son état. Notez qu’une réponse 200 ou 302 est possible.
Vider et archiver le document

Définit un document avec l’état 40 -removed- et l’archive.

Charger un modèle PDF

ID d’opération :
PostPdfTemplate

Chargez un document PDF que vous souhaitez envoyer à signer.

Paramètres

Nom Clé Obligatoire Type Description
Archiver lors de l’envoi
 archive_upon_send boolean

Définissez true si ce chargement ne sera utilisé qu’à usage unique.
Groupe
 group True string

Spécifiez le groupe dans lequel cela sera utilisé.
Fichier PDF
 pdf_file True byte

Données de fichier PDF encodées en base64.
Balises de processus
 process_tags boolean

Si le fichier contient des balises de texte, convertissez-les en champs.
Titre
 title string

Nommez cet enregistrement, utilisez le nom de fichier s’il n’est pas utilisé.
Utilisateur
 user string

Affecter au membre du groupe s’il n’est pas utilisateur d’API.

Charger une pièce jointe PDF

ID d’opération :
PostAttachment

Enregistrez un fichier pdf à joindre à un e-mail de destinataire.

Paramètres

Nom Clé Obligatoire Type Description
group
 group True string

URI de ressource de groupe
pdf_file
 pdf_file True byte

Les données de fichier PDF encodées en base64, la taille maximale est un paramètre de groupe, 5 Mo par défaut.
filename
 filename True string

Nom alphanumérique simple terminant .pdf
utilisateur
 user string

Affecter à un autre utilisateur.
descriptif
 description string

Envoyer un document

ID d’opération :
PostDocument

Envoyez un document à des fins de signature ou d’approbation.

Paramètres

Nom Clé Obligatoire Type Description
Groupe
 group True string

URI de ressource de groupe
Nom
 name True string

Spécifier le nom du document
Modèle PDF
 templatepdf True string

Fichier PDF chargé à envoyer.
Messagerie électronique
 email True email

Messagerie électronique
prénom
 firstname True string

Prénom
nom de famille
 lastname True string

Nom
attachments
 attachments array of string

Liste des URI de ressource de pièce jointe.
expire
 expires date-time

ISO8601 datetime formée, définie sur TZ de l’expéditeur ou du fuseau horaire si elle est utilisée
Message
 message string

Votre message personnel pour la partie, entré au centre du modèle d’e-mail de groupe. Utilisez le nom d’un modèle de courrier enregistré précédé d’un symbole de hachage pour utiliser ce modèle. S’il existe plusieurs modèles du même nom, il sélectionne le dernier modèle modifié.
prénom
 firstname string

Prénom
nom de famille
 lastname string

Nom
Messagerie électronique
 email True email

Messagerie électronique
include_link
 include_link boolean

Inclure un lien vers les pages de signature permettant à un réviseur de signer
SMS
 sms string

Utilisez le numéro de format international pour ajouter la vérification SMS. Obligatoire si un témoin ou un signataire témoin.
Objet
 subject string

Ligne d’objet pour le courrier sortant
timezone
 timezone string

TZ du signataire doit être TZ valide en fonction du fuseau horaire (voir User for timezoneenum details). Si vide utilise tz de l’expéditeur.
Type de signature
 signature_type integer

Utilisez 4 pour obtenir votre certificat PDF certifié. Recommandé. La valeur par défaut est 1 (utilise un hachage sha256 pour l’intégrité du document).
Ajouter un FICHIER PDF
 append_pdf boolean

Ajoutez les informations de validation Legalesign au pdf final.
auto_archive
 auto_archive boolean

Envoyer à l’archive peu après la signature. Maintient l’encombrement de l’application web gratuitement
Utiliser des e-mails Legalesign
 do_email boolean

Utilisez l’e-mail Legalesign pour envoyer des e-mails de notification. Si false supprime tous les e-mails.
CC à la fin
 cc_emails string

Chaîne délimitée par des virgules d’adresses e-mail qui sont averties de la signature ou du rejet.
Convertir des champs d’expéditeur vides en champs de premier destinataire
 convert_sender_to_signer boolean

Si des champs d’expéditeur sont laissés vides, convertissez-les en champs pour le premier destinataire.
Mot de passe PDF
 pdf_password string

Définissez un mot de passe. Doit être encodé en ascii, vous devez également définir signature_type sur 4 et choisir un pdf_password_type.
Paramètres de mot de passe PDF
 pdf_password_type integer

1 pour stocker le mot de passe, 2 pour supprimer de nos enregistrements lors de la signature finale.
pdftext
 pdftext object

Affectez des valeurs aux champs d’expéditeur PDF, utilisez l’étiquette de champ du modèle ou son uuid comme clés d’objet. Consultez templatepdf/ :id/fields/ et filtrez pour element_type="admin », pour obtenir les champs pertinents avec leur étiquette ou leur uuid. Voir aussi strict_fields.
URL de redirection
 redirect string

URL à laquelle envoyer le signataire après la signature (au lieu de la page de téléchargement). Votre URL inclut des paramètres de requête avec des informations d’ID et d’état comme suit : YOUR-URL ?signer=[signer_uid]&doc=[doc_id]&group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Planification des rappels
 reminders string

Placez « par défaut » si vous souhaitez utiliser la planification de rappel par défaut dans le groupe (accédez à l’application web pour définir la planification par défaut)
Renvoyer les liens du signataire
 return_signer_links boolean

Renvoyer des liens de document pour les signataires dans le corps de la réponse.
séquencement d’envoi
 signers_in_order boolean

Notifier les signataires dans leur séquence d’ordre. Si la valeur est false, toutes sont informées de manière simuleuse.
signertext
 signertext object

Ajoutez des espaces réservés personnalisés aux champs signataires. Utilisez des étiquettes de champ ou uuid comme clés dans l’objet (comme pour pdftext). Consultez templatepdf/ :id/fields/ et filtrez pour element_type = « text » pour obtenir des champs pertinents avec leurs étiquettes ou uuid.
Appliquer la validation de champ
 strict_fields boolean

Pdftext échoue les vérifications de validation en mode silencieux, définissez true pour valider.
Votre référence
 tag string

Tag
Votre référence
 tag1 string

Tag
Votre référence
 tag2 string

Tag
utilisateur
 user string

Attribuez un autre utilisateur au document dans le groupe.

Envoyer un e-mail de rappel de destinataire

ID d’opération :
PostSignerReminder

Envoyez un e-mail de rappel à un destinataire.

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True uuid

ID du destinataire
texte
 text string

Texte du message personnalisé

Membre d’un groupe

ID d’opération :
GetMember

Détails d’un utilisateur spécifique au sein d’un groupe.

Paramètres

Nom Clé Obligatoire Type Description
ID de membre
 memberId True uuid

ID de membre

Retours

Corps
MemberResponse

Membres de groupes

ID d’opération :
GetMembers

Liste de tous les membres de vos groupes.

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe
 group string

Filtrer par un groupe spécifique
Limite de requête
 limit integer

Utiliser avec offset pour itérer dans les résultats.
Décalage de requête
 offset integer

Utilisez avec une limite pour itérer les résultats.

Retours

Corps
MemberListResponse

Obtenir des champs de document

ID d’opération :
GetDocumentFields

Champs du document.

Paramètres

Nom Clé Obligatoire Type Description
Document Id
 docId True uuid

ID de document

Retours

Nom Chemin d’accès Type Description
array of object

Liste des champs de document
element_type
 element_type string

Type d’élément
fieldorder
 fieldorder integer

Ordre des champs
label
 label string

Étiquette
label_extra
 label_extra string

Étiquette supplémentaire
signataire
 signer integer

Recipient
état
 state boolean
validation
 validation integer

Identificateur de validation
value
 value string

Valeur

Obtenir des documents

ID d’opération :
GetDocuments

Répertorier les documents de signature nonarchivés.

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe
 group True string

Filtrez par un groupe spécifique, obligatoire.
Inclure des documents archivés
 archived string

Filtre sur l’état archivé, la valeur par défaut est nonarchivée, utilisez la valeur dans ce paramètre pour interroger tous les documents.
Filtrer par e-mail de destinataire
 email string

Filtrer par e-mail de destinataire.
Limite de requête
 limit integer

Longueur du jeu de données à retourner. Utilisez la requête offset pour effectuer une itération dans les résultats.
Décalage de requête
 offset integer

Décalage du début du jeu de données. Utilisez la requête limite pour effectuer une itération au sein du jeu de données.
Filtrer par état du document
 status integer

Filtrez sur l’état du document.
Supprimer les destinataires de la réponse
 nosigners string

Ajoutez la valeur 1 pour supprimer les informations des destinataires pour une requête plus rapide.
Filtre pour créé après cette date
 created_gt date-time

Filtrez les documents créés après un certain temps.
Filtrer pour la modification après cette date
 modified_gt date-time

Filtrez les documents modifiés après un certain temps.

Retours

Listes de documents

Corps
DocumentListResponse

Obtenir des groupes

ID d’opération :
GetGroups

Répertorie les groupes auxquels appartient l’utilisateur d’API.

Paramètres

Nom Clé Obligatoire Type Description
Décalage de requête
 offset integer

Décalage du début du jeu de données. Utilisez la requête limite pour effectuer une itération au sein du jeu de données.
Limite de requête
 limit integer

Longueur du jeu de données à retourner. Utilisez la requête offset pour effectuer une itération dans les résultats.

Retours

Liste des groupes

Corps
GroupListResponse

Obtenir des modèles PDF

ID d’opération :
GetPdfTemplates

Répertorier les modèles PDF

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe
 group string

Peut être complet resource_uri ou uniquement id.
Limite de requête
 limit integer

Longueur du jeu de données à retourner. Utilisez la requête offset pour effectuer une itération dans les résultats.
Décalage de requête
 offset integer

Décalage du début du jeu de données. Utilisez la requête limite pour effectuer une itération au sein du jeu de données.

Retours

Listes de modèles

Corps
TemplatePdfListResponse

Obtenir la raison du rejet du destinataire

ID d’opération :
GetSignerRejection

Retourne la raison pour laquelle le signataire a donné pour rejeter un document.

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True uuid

ID du destinataire

Retours

Nom Chemin d’accès Type Description
status
 status integer

Statues de destinataires.
reason
 reason string

Rejeter la raison.

Obtenir le destinataire

ID d’opération :
GetRecipient

Obtenez l’état et les détails d’un destinataire individuel.

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True uuid

ID du destinataire

Retours

Détails du destinataire

Corps
SignerResponse

Obtenir le lien du destinataire

ID d’opération :
GetSignerLink

Lien à usage unique permettant au destinataire d’accéder aux pages de signature.

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True uuid

ID du destinataire

Obtenir les champs de formulaire du destinataire

ID d’opération :
GetSignerFields

Retourne les champs de formulaire d’un destinataire spécifique.

Paramètres

Nom Clé Obligatoire Type Description
ID du destinataire
 recipientId True uuid

ID du destinataire

Retours

Nom Chemin d’accès Type Description
array of object
label
 label string

Étiquette
label_extra
 label_extra string

Étiquette supplémentaire
état
 state boolean

État
fieldorder
 fieldorder integer

Ordre des champs
value
 value string

Si le champ est un fichier signataire, cette valeur sera une URL de téléchargement de courte durée.

Obtenir un document

ID d’opération :
GetDocument

Retourne un document spécifique.

Paramètres

Nom Clé Obligatoire Type Description
Document Id
 docId True uuid

ID de document

Retours

Détails du document

Corps
DocumentResponseDetail

Obtenir un lien incorporé PDF

ID d’opération :
GetPdfTemplateEditLink

Retournez un lien à usage unique pour incorporer l’éditeur PDF.

Paramètres

Nom Clé Obligatoire Type Description
Pdf Id
 pdfId True string

Définissez l’ID PDF chargé.
Masquer la liste des champs de la page rendue
 hide_sender_fields boolean

Masquer la liste des champs de la page rendue.
Code hexadécimal à l’exclusion du symbole de hachage pour la couleur d’arrière-plan
 css_body_backgroundcolor string

Utilisez du code hexadécimal à l’exclusion du symbole de hachage pour modifier la couleur d’arrière-plan.

Obtenir un modèle PDF

ID d’opération :
GetPdfTemplate

Détails d’un modèle PDF spécifique

Paramètres

Nom Clé Obligatoire Type Description
ID PDF chargé
 pdfId True uuid

ID PDF chargé

Retours

Détails du modèle

Corps
TemplatePdfResponse

Obtenir un utilisateur

ID d’opération :
GetUser

Obtenir les détails de l’utilisateur.

Paramètres

Nom Clé Obligatoire Type Description
ID utilisateur
 userId True uuid

ID utilisateur

Retours

Détails de l’utilisateur.

Corps
UserDetailResponse

Obtenir une pièce jointe

ID d’opération :
GetAttachment

Obtenir une pièce jointe.

Paramètres

Nom Clé Obligatoire Type Description
ID de pièce jointe
 attachId True uuid

ID de pièce jointe

Retours

Attacher un élément.

Corps
AttachmentResponse

Obtention de pièces jointes

ID d’opération :
GetAttachments

Répertorier les pièces jointes.

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe
 group string

Filtrez par un groupe spécifique.
Limite de requête
 limit integer

Utiliser avec offset pour itérer dans les résultats.
Décalage de requête
 offset integer

Utilisez avec une limite pour itérer les résultats.

Retours

Liste des pièces jointes

Corps
AttachmentListResponse

Supprimer définitivement le document

ID d’opération :
DeleteDocument

Supprime définitivement les données et les fichiers.

Paramètres

Nom Clé Obligatoire Type Description
Document Id
 docId True uuid

Document Id

Supprimer une pièce jointe

ID d’opération :
DeleteAttachment

Supprimez une pièce jointe.

Paramètres

Nom Clé Obligatoire Type Description
ID de pièce jointe
 attachId True uuid

ID d’attachement

Télécharger le journal d’audit du document

ID d’opération :
GetDocumentAuditLog

PDF du journal d’audit du document uniquement.

Paramètres

Nom Clé Obligatoire Type Description
Document Id
 docId True uuid

Document Id

Retours

response
file

Télécharger le PDF

ID d’opération :
GetDocumentPdf

Obtenez le pdf brouillon ou final d’un document de signature, en fonction de son état. Notez qu’une réponse 200 ou 302 est possible.

Paramètres

Nom Clé Obligatoire Type Description
Document Id
 docId True uuid

Document Id

Retours

response
file

Vider et archiver le document

ID d’opération :
UpdateArchiveDocument

Définit un document avec l’état 40 -removed- et l’archive.

Paramètres

Nom Clé Obligatoire Type Description
Document Id
 docId True uuid

Document Id
Envoyer un e-mail de notification au destinataire
 email string

Si la valeur est true ou 1, les destinataires sont avertis que le document est annulé.

Déclencheurs

Événement de destinataire

Déclencheur pour le moment où un événement de destinataire se produit
Événement document

Le déclencheur d’un événement de document se produit

Événement de destinataire

ID d’opération :
RecipientTrigger

Déclencheur pour le moment où un événement de destinataire se produit

Paramètres

Nom Clé Obligatoire Type Description
eventFilter
 eventFilter True string

Filtre d’événements
group
 group string

Filtre de groupe

Retours

Nom Chemin d’accès Type Description
version
 version string

Version
objet
 object string

Objet
tag
 data.tag string

Tag
tag1
 data.tag1 string

Balise 1
tag2
 data.tag2 string

Balise2
Identifiant unique universel (UUID)
 data.uuid string

ID du destinataire
Messagerie électronique
 data.email string

Messagerie électronique
group
 data.group string

Groupe
order
 data.order integer

JSON
status
 data.status integer

Statut
document
 data.document string

Document
nom de famille
 data.lastname string

Nom
roleText
 data.roleText string

Texte du rôle
prénom
 data.firstname string

Prénom
statusText
 data.statusText string

Texte d'état
emailBounce
 data.emailBounce integer

L’e-mail a rebondit
resourceUri
 data.resourceUri string

URI de ressource du destinataire
nom_document
 data.documentName string

Nom du document
rejectReason
 data.rejectReason string

Rejeter la raison
groupResourceUri
 data.groupResourceUri string

URI de ressource de groupe
emailBounceMessage
 data.emailBounceMessage string

Message de rebond par e-mail
documentResourceUri
 data.documentResourceUri string

URI de ressource de document
créé
 created integer

Créé
pièce d'identité
 id string

ID
événement
 event string

Événement

Événement document

ID d’opération :
DocumentTrigger

Le déclencheur d’un événement de document se produit

Paramètres

Nom Clé Obligatoire Type Description
eventFilter
 eventFilter True string

Filtre d’événements
group
 group string

Filtre de groupe

Retours

Nom Chemin d’accès Type Description
version
 version string

Version
objet
 object string

Objet
tag1
 data.tag1 string

Tag
recipients
 data.recipients array of object

Destinataires
Identifiant unique universel (UUID)
 data.recipients.uuid string

ID du destinataire
Messagerie électronique
 data.recipients.email string

E-mail du destinataire
order
 data.recipients.order integer

Numéro de commande du destinataire
status
 data.recipients.status integer

État du destinataire
nom de famille
 data.recipients.lastname string

Nom du destinataire
roleText
 data.recipients.roleText string

Texte du rôle de destinataire
prénom
 data.recipients.firstname string

Prénom du destinataire
statusText
 data.recipients.statusText string

StatusText du destinataire
resourceUri
 data.recipients.resourceUri string

URI de ressource du destinataire
rejectReason
 data.recipients.rejectReason string

rejectReason
groupResourceUri
 data.groupResourceUri string

URI de ressource de groupe
statusText
 data.statusText string

Texte d’état du document
nom
 data.name string

Nom du document
tag
 data.tag string

Tag
resourceUri
 data.resourceUri string

URI de ressource
Identifiant unique universel (UUID)
 data.uuid string

Document Id
tag2
 data.tag2 string

Balise2
group
 data.group string

Groupe
status
 data.status integer

Statut du document
créé
 created integer

Créé
pièce d'identité
 id string

Did
événement
 event string

Événement

Définitions

PermissionsEnum

Options d’autorisation

Options d’autorisation

integer

ListMeta

Méta-informations sur la description.

Nom Chemin d’accès Type Description
limit
 limit integer

Nombre maximal d’objets.
prochain
 next string

URL de l’ensemble d’objets suivant.
offset
 offset integer

Nombre d’éléments à partir du début du jeu de résultats.
précédent
 previous string

URL de l’ensemble précédent d’objets.
total_count
 total_count integer

Nombre total d’objets.

GroupListResponse

Liste des groupes

Nom Chemin d’accès Type Description
méta
 meta ListMeta

Méta-informations sur la description.
Objets
 objects array of object
créé
 objects.created date-time

Créé
is_active
 objects.is_active boolean

Active
modifié
 objects.modified date-time

Modifié
nom
 objects.name string

Nom
public_name
 objects.public_name string

Nom public
resource_uri
 objects.resource_uri string

URI de ressource
limace
 objects.slug string

Nom unique
utilisateur
 objects.user string

URI de ressource Creator
xframe_allow
 objects.xframe_allow boolean

Autoriser la signature incorporée
xframe_allow_pdf_edit
 objects.xframe_allow_pdf_edit boolean

Autoriser la modification incorporée

TemplatePdfListResponse

Listes de modèles

Nom Chemin d’accès Type Description
méta
 meta ListMeta

Méta-informations sur la description.
Objets
 objects array of TemplatePdfResponse

TemplatePdfResponse

Détails du modèle

Nom Chemin d’accès Type Description
créé
 created date-time

Créé
group
 group string

URI de groupe
modifié
 modified date-time

Modifié
Parties
 parties string

Tableau de parties de document sous forme de chaîne JSON.
page_count
 page_count integer

Nombre de pages
resource_uri
 resource_uri string

URI de ressource
signer_count
 signer_count integer

Nombre de signataires
title
 title string

Titre
utilisateur
 user string

URI de ressource du créateur
Identifiant unique universel (UUID)
 uuid uuid

Pdf Id
valable
 valid boolean

Est en mesure d’être envoyé (si les champs ne sont pas validés).

DocumentListResponse

Listes de documents

Nom Chemin d’accès Type Description
méta
 meta ListMeta

Méta-informations sur la description.
Objets
 objects array of object

Documents
Archivés
 objects.archived boolean

Archivés
auto_archive
 objects.auto_archive boolean

Archive après l’envoi.
cc_emails
 objects.cc_emails string

E-mails de liste délimitées par des virgules à cc à la fin.
créé
 objects.created date-time

Créé
do_email
 objects.do_email boolean

Utilisez les e-mails Legalesign.
download_final
 objects.download_final boolean

Est prêt à être téléchargé après l’achèvement.
group
 objects.group string

URI de ressource de groupe.
modifié
 objects.modified date-time

Modifié
nom
 objects.name string

Nom du document
pdftext
 objects.pdftext string

Valeurs des champs expéditeur
rediriger
 objects.redirect string

URL permettant de rediriger le destinataire après la signature
resource_uri
 objects.resource_uri string

URI de ressource
return_signer_links
 objects.return_signer_links boolean

Ajouter des liens de destinataire à la réponse
Signataires
 objects.signers array of array

Tableaux imbriqués avec les détails du signataire
items
 objects.signers array of

Contient toujours [uri du signataire, prénom, nom, e-mail, numéro sms, has_fields, état, ordre du signataire (0 indexé)]
signers_in_order
 objects.signers_in_order integer

Destinataires d’e-mail simulés ou séquentiellement
status
 objects.status DocumentStatusEnum

Options d’état du document :

  • 10 - État initial, vérifier l’état du signataire pour l’envoi/unsent
  • 20 - Champs terminés
  • 30 - Signé
  • 40 - Supprimé (avant la signature)
  • 50 - Rejeté
tag
 objects.tag string

Document de balise
tag1
 objects.tag1 string

Document de balise
tag2
 objects.tag2 string

Document de balise
modèle
 objects.template string

URI de ressource de modèle s’il est utilisé
templatepdf
 objects.templatepdf string

URI de ressource de modèle PDF
texte
 objects.text string

Texte de signature
utilisateur
 objects.user string

Uri du créateur
Identifiant unique universel (UUID)
 objects.uuid uuid

Document Id

DocumentStatusEnum

Options d’état du document :

  • 10 - État initial, vérifier l’état du signataire pour l’envoi/unsent
  • 20 - Champs terminés
  • 30 - Signé
  • 40 - Supprimé (avant la signature)
  • 50 - Rejeté

Options d’état du document :

  • 10 - État initial, vérifier l’état du signataire pour l’envoi/unsent
  • 20 - Champs terminés
  • 30 - Signé
  • 40 - Supprimé (avant la signature)
  • 50 - Rejeté
integer

SignerResponse

Détails du destinataire

Nom Chemin d’accès Type Description
document
 document string

Document
Messagerie électronique
 email string

E-mail du destinataire
prénom
 first_name string

Prénom du destinataire
last_name
 last_name string

Nom du destinataire
has_fields
 has_fields boolean

Le destinataire a des champs
order
 order integer

Ordre des destinataires
resource_uri
 resource_uri string

URI de ressource du destinataire
status
 status SignerStatusEnum

Options d’état du signataire :

  • 4 - non entré
  • 5 - planifié à envoyer
  • 10 - envoyé
  • 15 - e-mail ouvert
  • 20 - visité
  • 30 - Champs terminés
  • 35 - Champs complets ex signature
  • 39 - attente de la fin du témoin
  • 40 - signé
  • 50 - téléchargé
  • 60 - rejeté

SignerStatusEnum

Options d’état du signataire :

  • 4 - non entré
  • 5 - planifié à envoyer
  • 10 - envoyé
  • 15 - e-mail ouvert
  • 20 - visité
  • 30 - Champs terminés
  • 35 - Champs complets ex signature
  • 39 - attente de la fin du témoin
  • 40 - signé
  • 50 - téléchargé
  • 60 - rejeté

Options d’état du signataire :

  • 4 - non entré
  • 5 - planifié à envoyer
  • 10 - envoyé
  • 15 - e-mail ouvert
  • 20 - visité
  • 30 - Champs terminés
  • 35 - Champs complets ex signature
  • 39 - attente de la fin du témoin
  • 40 - signé
  • 50 - téléchargé
  • 60 - rejeté
integer

DocumentResponseDetail

Détails du document

Nom Chemin d’accès Type Description
Archivés
 archived boolean

Est archivé
auto_archive
 auto_archive boolean

Envoyez l’archive de documents après la signature.
cc_emails
 cc_emails string

Qui sera cc’d avec l’expéditeur lors de la notification par e-mail lors de la signature
créé
 created date-time

Créé
do_email
 do_email boolean

Utiliser des e-mails Legalesign
download_final
 download_final boolean

Le fichier PDF final est disponible en téléchargement
pied de page
 footer string

Documents HTML : texte du pied de page si utilisé
footer_height
 footer_height integer

Documentation HTMl - hauteur px du pied de page si utilisé
group
 group string

URI de ressource du groupe
has_fields
 has_fields boolean

Le document comporte des champs
hash_value
 hash_value string

Somme de contrôle SHA256 de la documentation finale, utilisez-la pour valider votre téléchargement PDF final
en-tête
 header string

Documents HTML : texte pour l’en-tête s’il est utilisé
header_height
 header_height integer

Documentation HTMl - hauteur px de l’en-tête si elle est utilisée
modifié
 modified date-time

Modifié
nom
 name string

Nom du document
pdf_password
 pdf_password string

Mot de passe PDF
pdf_password_type
 pdf_password_type string

Si le mot de passe pdf est conservé
pdftext
 pdftext string

Ignorer ce problème
rediriger
 redirect string

URL de redirection du destinataire après la signature
resource_uri
 resource_uri string

URI de ressource
return_signer_links
 return_signer_links boolean

Ignorer
sign_mouse
 sign_mouse boolean

ignorer
sign_time
 sign_time date-time

Heure de connexion
sign_type
 sign_type boolean

hérités
sign_upload
 sign_upload boolean

hérités
signature_placement
 signature_placement integer

hérités
signature_type
 signature_type integer

hérité - toujours 4
Signataires
 signers array of array

Tableaux imbriqués avec les détails du signataire
items
 signers array of

Contient toujours [uri du signataire, prénom, nom, e-mail, numéro sms, has_fields, état, ordre du signataire (0 indexé)]
signer_objects
 signer_objects array of object

Liste des destinataires
Messagerie électronique
 signer_objects.email string

Messagerie électronique
prénom
 signer_objects.firstname string

Prénom
nom de famille
 signer_objects.lastname string

Nom
Tél
 signer_objects.tel string

Numéro de téléphone
order
 signer_objects.order integer

Ordre de signature
resource_uri
 signer_objects.resource_uri string

URI de ressource
role
 signer_objects.role string

Role
status
 signer_objects.status integer

Code d’état du destinataire
Identifiant unique universel (UUID)
 signer_objects.uuid string

ID du destinataire
signers_in_order
 signers_in_order boolean

Destinataires d’e-mail simulés ou séquentiellement
status
 status DocumentStatusEnum

Options d’état du document :

  • 10 - État initial, vérifier l’état du signataire pour l’envoi/unsent
  • 20 - Champs terminés
  • 30 - Signé
  • 40 - Supprimé (avant la signature)
  • 50 - Rejeté
tag
 tag string

Votre référence
tag1
 tag1 string

Votre référence
tag2
 tag2 string

Votre référence
modèle
 template string

URI de ressource pour le modèle de texte s’il est utilisé
templatepdf
 templatepdf string

URI de ressource pour le modèle pdf s’il est utilisé
texte
 text string

Texte du document s’il est utilisé
utilisateur
 user string

URI de ressource utilisateur.
Identifiant unique universel (UUID)
 uuid uuid

Document Id

MemberListResponse

Nom Chemin d’accès Type Description
méta
 meta ListMeta

Méta-informations sur la description.
Objets
 objects array of MemberResponse

MemberResponse

Nom Chemin d’accès Type Description
créé
 created date-time

Créé
group
 group string

URI de ressource de groupe
modifié
 modified date-time

Modifié
autorisation
 permission PermissionsEnum

Options d’autorisation
resource_uri
 resource_uri string

URI de ressource
utilisateur
 user string

URI de ressource utilisateur.

AttachmentResponse

Attacher un élément.

Nom Chemin d’accès Type Description
créé
 created date-time

Créé
descriptif
 description string

Descriptif
filename
 filename string

Nom de fichier
group
 group string

Groupe
resource_uri
 resource_uri string

Attacher l’URI de ressource
utilisateur
 user string

URI de ressource utilisateur
Identifiant unique universel (UUID)
 uuid uuid

ID d’attachement

AttachmentListResponse

Liste des pièces jointes

Nom Chemin d’accès Type Description
méta
 meta ListMeta

Méta-informations sur la description.
Objets
 objects array of object

Listing
créé
 objects.created date-time

Créé
descriptif
 objects.description string

Descriptif
filename
 objects.filename string

Nom de fichier
group
 objects.group string

Groupe
resource_uri
 objects.resource_uri string

URI de ressource
utilisateur
 objects.user string

URI de ressource utilisateur
Identifiant unique universel (UUID)
 objects.uuid uuid

ID d’attachement

UserDetailResponse

Détails de l’utilisateur.

Nom Chemin d’accès Type Description
date_joined
 date_joined date-time

Date jointe
Messagerie électronique
 email email

Messagerie électronique
prénom
 first_name string

Prénom
groups
 groups array of string

Liste des groupes auxquels cet utilisateur est joint.
last_login
 last_login date-time

Dernière connexion
last_name
 last_name string

Nom
resource_uri
 resource_uri string

URI de ressource
timezone
 timezone string

Fuseau horaire
nom d'utilisateur
 username string

Nom d’utilisateur

file

Il s’agit du type de données de base « fichier ».