Foxit eSign (préversion)

Foxit eSign est une solution de signature électronique qui vous permet d’envoyer, de signer et de gérer des documents en ligne, ce qui élimine le besoin d’impression, d’analyse ou de publipostage. Chargez votre document, définissez des champs de signature et envoyez-le à des destinataires pour des signatures électroniques rapides et légalement contraignantes.

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	Standard	Toutes les régions Logic Apps , à l’exception des suivantes :      - régions Azure Government      - régions de chine Azure      - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps à l’exception des éléments suivants :      - 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 de Foxit eSign
URL	https://www.foxit.com
Courrier électronique	api@foxit.com

Métadonnées du connecteur
Éditeur	Foxit Software Inc.
Website	https://www.foxit.com/esign-pdf/
Politique de confidentialité	https://www.foxit.com/company/privacy-policy.html
Categories	Productivité; Contenu et fichiers

Foxit eSign

Foxit eSign est une solution de signature électronique de qualité entreprise qui permet aux entreprises d’envoyer, de signer et de gérer des documents de liaison juridique entièrement en ligne, ce qui élimine la nécessité d’imprimer, d’analyser ou de publiposter. Chargez votre document, définissez les champs de signature et envoyez-le aux destinataires pour des eSignatures rapides et sécurisées. Foxit eSign est entièrement conforme aux principales lois de signature électronique, notamment ESIGN et UETA, utilise le chiffrement pour protéger les documents en transit et au repos, et prend en charge l’authentification multifacteur pour garantir que seuls les signataires autorisés peuvent accéder à vos documents et les signer.

Le connecteur Foxit eSign pour Microsoft Power Automate vous permet d’automatiser votre flux de travail complet de signature de document , de la création d’enveloppes et de leur envoi pour signature, au suivi de l’état, au téléchargement de documents terminés, à la gestion des modèles et au déclenchement d’actions en aval lorsque des événements d’enveloppe se produisent.

Publisher : Foxit Corporation

Prerequisites

Pour utiliser ce connecteur, vous aurez besoin des éléments suivants :

• Un plan Microsoft Power Apps ou Power Automate avec un connecteur personnalisé ou un accès au connecteur Premium
• Un compte Foxit eSign : créez-en un ici
• Accès à l’API activé sur votre compte Foxit eSign (voir Obtention des informations d’identification ci-dessous)

Obtention des informations d’identification

1. Créez un compte Foxit eSign si vous n’en avez pas déjà un.
2. Contactez l’équipe Foxit Sales pour demander l’accès à l’API à activer sur votre compte. Une fois approuvé, l’accès aux API est activé sur votre compte.
3. Dans Power Automate, recherchez Foxit eSign dans la liste des connecteurs, puis sélectionnez Créer une connexion.
4. Vous êtes redirigé vers la page de connexion Foxit eSign. Connectez-vous avec vos informations d’identification Foxit eSign pour autoriser la connexion.
5. Une fois autorisée, la connexion est prête à être utilisée dans vos flux.

Getting Started

Après avoir créé une connexion, vous pouvez commencer à créer des flux à l’aide du connecteur Foxit eSign :

• Utilisez des déclencheurs pour démarrer automatiquement un flux lorsqu’un événement d’enveloppe se produit (par exemple, lorsque toutes les parties ont signé).
• Utilisez des actions pour créer des enveloppes, envoyer des rappels de signature, télécharger des documents terminés, gérer des modèles, etc.
• Chaînez plusieurs actions ensemble : par exemple, créez une enveloppe à partir d’un modèle, attendez le déclencheur entièrement exécuté, puis téléchargez le document signé et stockez-le dans SharePoint.

Déclencheurs pris en charge

Trigger	Description
Lorsqu’une enveloppe est envoyée	Se déclenche lorsqu’une enveloppe est envoyée aux destinataires. Nécessite le niveau webhook défini sur Compte.
Lorsqu’une enveloppe est consultée	Se déclenche lorsqu’un destinataire s’ouvre et affiche l’enveloppe.
Lorsqu’une enveloppe est signée	Se déclenche lorsqu’un destinataire signe l’enveloppe.
Lorsqu’une enveloppe est annulée	Se déclenche lorsqu’une enveloppe est annulée par un destinataire ou l’expéditeur.
Lorsqu’une enveloppe est entièrement exécutée	Se déclenche lorsque tous les destinataires ont signé et que l’enveloppe est entièrement terminée.
Lorsqu’une enveloppe est supprimée	Se déclenche lorsqu’une enveloppe est supprimée.

Actions prises en charge

Enveloppes

Action	Description
Créer une enveloppe à partir de l’URL	Crée et envoie une enveloppe à l’aide d’une URL PDF accessible publiquement.
Créer une enveloppe à partir de Base64	Crée et envoie une enveloppe à l’aide d’un document PDF encodé en Base64.
Créer une enveloppe à partir d’un modèle	Crée et envoie une enveloppe à partir d’un modèle foxit eSign existant.
Obtenir les détails de l’enveloppe	Récupère les détails complets et l’état actuel d’une enveloppe.
Obtenir des ID d’enveloppe	Récupère une liste d’ID d’enveloppe en fonction des critères de filtre.
Envoyer un rappel de signature	Envoie une notification de rappel aux signataires en attente d’une enveloppe.
Télécharger des fichiers d’enveloppe	Télécharge tous les documents signés dans une enveloppe sous forme de fichier zip.
Télécharger le fichier PDF d’un document unique	Télécharge un document unique à partir d’une enveloppe au format PDF.
Déplacer des enveloppes vers la Corbeille	Déplace une ou plusieurs enveloppes vers la corbeille.
Annuler l’enveloppe	Annule une enveloppe et avertit les destinataires.
Supprimer des enveloppes	Supprime définitivement une ou plusieurs enveloppes.
Obtenir l’historique des activités de l’enveloppe	Récupère le journal d’activité complet d’une enveloppe.
Obtenir l’historique des enveloppes supprimées	Récupère l’historique des enveloppes supprimées dans le compte.

Templates

Action	Description
Créer un modèle à partir d’une URL	Crée un modèle de signature réutilisable à l’aide d’une URL PDF accessible publiquement.
Créer un modèle à partir de Base64	Crée un modèle de signature réutilisable à l’aide d’un document PDF encodé en Base64.
Obtenir les détails du modèle	Récupère les détails complets d’un modèle spécifique, y compris les définitions de champs.
Obtenir des modèles par ID de modèle	Récupère les détails d’un ou de plusieurs modèles par leurs ID.
Obtenir la liste de tous les modèles	Récupère tous les modèles disponibles dans le compte.

Webhooks

Action	Description
Répertorier tous les canaux webhook	Retourne la liste de tous les canaux webhook configurés dans le compte.
Obtenir les détails du canal Webhook	Récupère les détails d’un canal webhook spécifique.

Groupes de messagerie

Action	Description
Créer un groupe de courriers électroniques	Crée un nouveau groupe de courriers électroniques à utiliser en tant que destinataires dans des enveloppes.
Obtenir les détails du groupe d’e-mails	Récupère les détails et les membres d’un groupe de messagerie.

Rapports

Action	Description
Télécharger le rapport	Télécharge un rapport d’activité de compte au format Microsoft Excel.

Problèmes connus et limitations

• Limite de débit : l’API Foxit eSign autorise jusqu’à 4 000 requêtes par 5 minutes par compte. Les demandes qui dépassent cette limite reçoivent une 429 Too Many Requests réponse. Il est recommandé d’implémenter une logique de nouvelle tentative avec une interruption exponentielle dans vos flux pour gérer cela correctement.

• Limite de taille de fichier : la taille maximale du fichier par document est de 25 Mo. Cette limite s’applique aux fichiers individuels, et non à la taille totale de l’enveloppe.

• Annulation automatique du webhook : en raison d’une limitation dans l’API de suppression de webhook Foxit eSign (qui utilise une méthode POST plutôt que DELETE), Power Automate ne peut pas nettoyer automatiquement les abonnements de canal webhook lorsqu’un flux basé sur un déclencheur est supprimé ou modifié. Utilisez l’action Répertorier tous les canaux Webhook pour identifier les canaux actifs et le portail Foxit eSign pour supprimer les abonnements lors de la désaffectation d’un flux.

• Lorsqu’une enveloppe est envoyée — Niveau du compte uniquement : le déclencheur « Lorsqu’une enveloppe est envoyée » se déclenche uniquement lorsque le niveau webhook est défini sur Compte. Il ne se déclenche pas pour les enveloppes créées au niveau de l’application API . Veillez à sélectionner le niveau compte lors de la configuration de ce déclencheur.

• Disponibilité régionale : le connecteur est disponible pour les comptes de région Amérique du Nord (NA1) et UE. Sélectionnez la région de serveur appropriée lors de la configuration de votre connexion. La connexion à une région incorrecte entraîne des échecs d’authentification.

• Taille du document Base64 : lorsque vous utilisez l’enveloppe de création à partir de Base64 ou créez un modèle à partir d’actions Base64, la chaîne encodée en Base64 doit correspondre à un fichier source de plus de 25 Mo.

Support

Pour obtenir du support pour les développeurs, contactez l’équipe Foxit eSign à l’adresse devsupport@foxitsoftware.com.

Pour soumettre un cas de support, visitez https://kb.foxit.com/s/submit-a-case.

Limitations

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

Actions

Annuler l’enveloppe	Annule une enveloppe envoyée. Les destinataires ne pourront plus signer les documents.
Créer un groupe de courriers électroniques	Crée un nouveau groupe de courriers électroniques qui peut être utilisé pour envoyer des enveloppes à plusieurs destinataires à la fois.
Créer un modèle à partir de Base64	Crée un modèle à l’aide d’une chaîne PDF encodée en Base64. Utilisez cette option lorsque votre fichier PDF est déjà disponible sous forme de chaîne Base64 dans votre flux, par exemple à partir d’un fichier SharePoint ou d’un document OneDrive.
Créer un modèle à partir d’une URL	Crée un modèle à l’aide d’une URL PDF accessible publiquement.
Créer une enveloppe à partir de Base64	Crée et envoie une enveloppe à l’aide d’un document PDF encodé en Base64.
Créer une enveloppe à partir de l’URL	Crée et envoie une enveloppe à l’aide d’URL PDF accessibles publiquement. Fournissez les URL de document et les détails du destinataire pour lancer le processus de signature.
Créer une enveloppe à partir d’un modèle	Crée et envoie une enveloppe à l’aide d’un modèle existant. Les détails du destinataire peuvent être personnalisés.
Déplacer des enveloppes vers la Corbeille	Déplace une ou plusieurs enveloppes vers la corbeille. Les enveloppes de la corbeille ne sont pas supprimées définitivement.
Envoyer un rappel de signature	Envoie une notification de rappel aux destinataires en attente d’une enveloppe, en les invitant à terminer la signature.
Obtenir des modèles par ID de modèle	Récupère les détails d’un ou de plusieurs modèles par leurs ID.
Obtenir la liste de tous les modèles	Retourne la liste de tous les modèles disponibles dans votre compte.
Obtenir les détails de l’enveloppe	Récupère les détails complets d’une enveloppe, y compris son état, ses destinataires et ses documents.
Obtenir les détails du canal Webhook	Récupère les détails d’un canal webhook spécifique.
Obtenir les détails du groupe d’e-mails	Récupère les détails d’un groupe de messagerie existant.
Obtenir les détails du modèle	Récupère les détails complets d’un modèle spécifique, y compris ses champs et ses destinataires.
Obtenir les ID d’enveloppe	Retourne une liste d’ID d’enveloppe filtrés par état. Utilisez cette option pour rechercher des enveloppes dans un état spécifique.
Obtenir l’historique des activités de l’enveloppe	Récupère un journal d’activité complet pour une enveloppe, affichant toutes les actions effectuées par les destinataires et l’expéditeur.
Obtenir l’historique des enveloppes supprimées	Récupère un historique des enveloppes qui ont été supprimées ou déplacées vers la corbeille.
Répertorier tous les canaux webhook	Retourne la liste de tous les canaux webhook configurés dans votre compte.
Se désabonner du déclencheur webhook	Supprime un abonnement de canal webhook actif par son ID de canal. Utilisez cette action pour nettoyer les abonnements webhook qui ne sont plus nécessaires.
Supprimer des enveloppes	Supprime définitivement une ou plusieurs enveloppes.
Télécharger des fichiers d’enveloppe	Télécharge les documents terminés à partir d’une enveloppe sous forme de fichier.
Télécharger le fichier PDF d’un document unique	Télécharge un document unique à partir d’une enveloppe en tant que fichier PDF.
Télécharger le rapport	Télécharge un rapport d’activité d’enveloppe en tant que fichier Microsoft Excel. Utilisez les filtres pour affiner les résultats par état, plage de dates, nom d’enveloppe, auteur ou signataire.

Annuler l’enveloppe

ID d’opération :

CancelEnvelope

Annule une enveloppe envoyée. Les destinataires ne pourront plus signer les documents.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’enveloppe	folderId	True	integer	ID de l’enveloppe à annuler.
Motif de l’annulation	reason_for_cancellation	True	string	Motif de l’annulation de cette enveloppe. Cette opération est enregistrée dans l’historique des activités de l’enveloppe.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
ID d’enveloppe annulés	folders cancelled	array of integer	Liste des ID d’enveloppe qui ont été annulés avec succès.

Créer un groupe de courriers électroniques

ID d’opération :

CreateEmailGroup

Crée un nouveau groupe de courriers électroniques qui peut être utilisé pour envoyer des enveloppes à plusieurs destinataires à la fois.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du groupe	emailGroupName	True	string	Nom du nouveau groupe de messagerie.
Description de groupe	emailGroupDescription		string	Description facultative du groupe de courriers électroniques.
Autoriser la validation avancée des e-mails	allowAdvancedEmailValidation		boolean	Lorsqu’elle est activée, Foxit eSign valide que toutes les adresses e-mail du groupe sont accessibles avant l’envoi.
Prénom	firstName	True	string	Prénom du destinataire.
Nom de famille	lastName	True	string	Nom du destinataire.
Courrier électronique	emailId	True	string	Adresse e-mail du destinataire.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
Message	message	string	Message de confirmation de l’action effectuée.
ID de groupe	emailGroup.groupId	integer	Identificateur unique du groupe de courriers électroniques. Utilisez cet ID lors de l’envoi d’enveloppes au groupe.
Nom du groupe	emailGroup.groupName	string	Nom du groupe d’e-mails.
Description de groupe	emailGroup.groupDesc	string	Description du groupe d’e-mails.
Date de création	emailGroup.dateCreated	integer	Date de création du groupe de courriers électroniques en millisecondes Unix.
ID d’entreprise	emailGroup.companyId	integer	Compte d’entreprise auquel appartient ce groupe de messagerie.
Parties	emailGroup.parties	array of object	Liste des destinataires dans le groupe de messagerie.
Prénom	emailGroup.parties.firstName	string	Prénom du destinataire.
Nom de famille	emailGroup.parties.lastName	string	Nom du destinataire.
Courrier électronique	emailGroup.parties.emailId	string	Adresse e-mail du destinataire.

Créer un modèle à partir de Base64

ID d’opération :

CreateTemplatefromBase64

Crée un modèle à l’aide d’une chaîne PDF encodée en Base64. Utilisez cette option lorsque votre fichier PDF est déjà disponible sous forme de chaîne Base64 dans votre flux, par exemple à partir d’un fichier SharePoint ou d’un document OneDrive.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du modèle	templateName	True	string	Nom du modèle. Doit se terminer par l’extension .pdf (par exemple, onboarding.pdf).
Chaîne de fichier Base64	base64FileString	True	string	Chaîne BASE64 d’un fichier PDF pour la création du modèle. Il doit être accessible publiquement lorsque vous créez le modèle.
Type d’entrée	inputType	True	string	Méthode d’entrée pour le document. Définissez toujours la valeur « base64 » pour cette action.
Traiter des balises de texte	processTextTags	True	boolean	Lorsque cette option est activée, Foxit eSign analyse le document pour les balises de texte et les convertit automatiquement en champs de signature.
Traiter les champs Acro	processAcroFields	True	boolean	Lorsque cette option est activée, Foxit eSign analyse le document pour AcroFields et les convertit automatiquement en champs de signature.
Partager tout	shareAll	True	boolean	Partagez ce modèle avec tous les utilisateurs de votre compte.
Nombre de parties	numberOfParties	True	integer	Nombre de parties de destinataires pour ce modèle. Doit être inférieur à 20.
Couleur de thème	themeColor		string	Valeur de couleur CSS pour personnaliser le thème de la session de modèle incorporée (par exemple, #42caf4).
Email d’auteur	authorEmail		string	Adresse e-mail d’un autre utilisateur du compte à définir comme auteur de ce modèle.
Créer une session de modèle incorporé	createEmbeddedTemplateSession		boolean	Si la valeur est true, une session de modèle incorporée est créée afin que vous puissiez ouvrir l’éditeur de modèle Foxit eSign directement et faire glisser-déplacer des champs sur le modèle.
URL de redirection	redirectURL		string	Si créer une session de modèle incorporé est vraie, l’URL vers laquelle rediriger l’utilisateur après avoir cliqué sur Enregistrer et fermer dans l’éditeur de modèle incorporé.
Masquer le modèle d’envoi	hideSendTemplate		boolean	Si la valeur est true, le bouton Envoyer est masqué dans l’éditeur de modèle incorporé.
Corriger les parties de destinataires	fixRecipientParties		boolean	Si la valeur est true, les parties destinataires déjà ajoutées ne peuvent pas être modifiées dans l’éditeur de modèle incorporé.
Champs	Fields		object
permissions	permission	True	string
Série	sequence	True	integer	Numéro de séquence unique pour cette partie, à partir de 1. Définit l’ordre de signature lorsque la séquence de connexion est activée.
Rôle de destinataire	partyRole	True	string	Rôle attribué à cette partie dans le modèle.
Masquer plus d’action	hideMoreAction		boolean	Si la valeur est true, le bouton Autres actions est masqué dans la session de modèle incorporée.
Masquer le partage avec tous	hideShareWithAll		boolean	Si la valeur est true, l’option Partager avec tous est masquée dans la session de modèle incorporée.
Masquer l’ajout d’une partie	hideAddParty		boolean	Si la valeur est true, toutes les options d’ajout de partie sont masquées dans la session de modèle incorporée.
Bouton Masquer	hideMeButton		boolean	Si la valeur est true, le bouton Me sur Les parties du destinataire est masqué dans la session de modèle incorporée.
Bouton Masquer d’autres utilisateurs	hideOthersButton		boolean	Si la valeur est true, le bouton Autres parties du destinataire est masqué dans la session de modèle incorporée.
Masquer le nom du champ pour les destinataires	hideFieldNameForRecipients		boolean	Si la valeur est true, les noms de champs sont masqués des destinataires pour l’entrée de données et les champs avancés.
Masquer la bordure de case à cocher	hideCheckboxBorder		boolean	Si la valeur est true, les bordures de case à cocher sont masquées dans les documents exécutés.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si l’opération a réussi (par exemple, « réussite »).
Message	message	string	Description du résultat de l’opération.
ID	template.templateId	integer	ID unique du modèle créé. Utilisez cette option pour créer des enveloppes à partir de ce modèle.
Nom	template.templateName	string	Nom du modèle.
Description	template.templateDesc	string	Description du modèle.
Type	template.templateType	string	Type du modèle.
Date de création	template.templateCreationDate	string	Date de création du modèle.
Date de la dernière mise à jour	template.templateLastUpdateDate	string	Date de la dernière mise à jour du modèle.
Modifiable	template.editable	boolean	Indique si le modèle peut être modifié.
Nombre de parties	template.numberOfParties	integer	Nombre de parties destinataires définies dans le modèle.
Total Pages	template.totalPages	integer	Nombre total de pages dans le document de modèle.
ID d’entreprise	template.companyId	integer	ID de l’entreprise à laquelle appartient ce modèle.
Partagé avec tous	template.shareAll	boolean	Indique si ce modèle est partagé avec tous les utilisateurs du compte.
Autorisations de partie	template.templatePartyPermissions	array of object	Liste des rôles de destinataire et leurs autorisations définies dans ce modèle.
ID de partie	template.templatePartyPermissions.template_party_id	integer	ID unique de cette entrée de partie de modèle.
ID	template.templatePartyPermissions.templateId	integer	ID du modèle auquel appartient cette partie.
Permissions	template.templatePartyPermissions.templatePermissions	string	Autorisations de signature pour cette partie (par exemple, FILL_FIELDS_AND_SIGN).
Ordre de signature	template.templatePartyPermissions.partySequence	integer	Position de l’ordre de signature pour cette partie.
Rôle de partie	template.templatePartyPermissions.templatePartyRole	string	Nom du rôle attribué à cette partie dans le modèle. Utilisez cette option lors de la création d’une enveloppe à partir du modèle.
ID d’utilisateur	template.templateCreatedBy.partyId	integer	ID unique de l’utilisateur.
Prénom	template.templateCreatedBy.firstName	string	Prénom de l’utilisateur.
Nom de famille	template.templateCreatedBy.lastName	string	Nom de famille de l’utilisateur.
Courrier électronique	template.templateCreatedBy.emailId	string	Adresse e-mail de l’utilisateur.
Champs de modèle	allfields	array of object	Liste de tous les champs de signature et de formulaire définis dans le modèle.
ID de champ	allfields.fieldTagId	integer	Identificateur unique du champ.
ID de modèle	allfields.templateId	integer	ID du modèle auquel appartient ce champ.
ID d’entreprise	allfields.companyId	integer	Compte d’entreprise auquel appartient ce champ.
Type de champ	allfields.fieldType	string	Type du champ (par exemple, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numéro de page	allfields.documentPageNumber	integer	Numéro de page du document où ce champ est placé.
Partie responsable	allfields.partyResponsible	integer	Numéro de séquence de partie responsable du remplissage de ce champ.
Séquence de parties	allfields.partyResponsibleSequence	integer	Position de séquence du tiers responsable.
ID de document de champ	allfields.docFieldId	string	Identificateur au niveau du document pour ce champ.
Dépend	allfields.dependent	boolean	Indique si la visibilité de ce champ dépend de la valeur d’un autre champ.
Ordre des tabulations	allfields.tabOrder	integer	Ordre de tabulation pour la navigation entre les champs.
Required	allfields.required	boolean	Indique si ce champ doit être rempli avant que le document puisse être signé.
Nom de champ personnalisé	allfields.customFieldName	string	Nom personnalisé affecté à ce champ.
Partager tout	allfields.shareAll	boolean	Indique si ce champ est partagé avec tous les utilisateurs.
Autoriser la modification	allfields.allowEdit	boolean	Indique si ce champ peut être modifié par le destinataire.
Nom du champ texte	allfields.textfieldName	string	Étiquette du champ de texte (applicable lorsque fieldType est « textfield »).
Valeur	allfields.value	string	Valeur préremplie ou entrée du champ.
Taille de police	allfields.fontSize	integer	Taille de police utilisée pour le texte dans ce champ.
Couleur de police	allfields.fontColor	string	Couleur de police utilisée pour le texte dans ce champ (par exemple, #000000).
Lecture seule	allfields.readOnly	boolean	Indique si le champ est en lecture seule et ne peut pas être modifié par le destinataire.
Plusieurs lignes	allfields.multiLine	boolean	Indique si le champ de texte accepte plusieurs lignes d’entrée (applicable lorsque fieldType est « textfield »).
Limite de caractères	allfields.characterLimit	integer	Nombre maximal de caractères autorisés dans le champ (applicable lorsque fieldType est « textfield »).
Nom du champ Date	allfields.datefieldName	string	Étiquette du champ date (applicable lorsque fieldType est « datefield »).
Format de date	allfields.dateFormat	string	Format de date utilisé par ce champ (par exemple, MM/DD/AAAA) (applicable lorsque fieldType est « datefield »).
Nom de la case à cocher	allfields.cbname	string	Étiquette du champ de case à cocher (applicable lorsque fieldType est « case à cocher »).
Groupe de cases à cocher	allfields.cbgroup	string	Nom du groupe pour cette case à cocher (applicable lorsque fieldType est « case à cocher »).
Vérifié	allfields.checked	boolean	Indique si la case à cocher est cochée par défaut (applicable lorsque fieldType est « case à cocher »).
Nom du champ sécurisé	allfields.securedfieldName	string	Étiquette du champ sécurisé (applicable lorsque fieldType est « champ sécurisé »).
Caractères à afficher	allfields.charToDisplay	integer	Nombre de caractères non masqués à afficher à la fin d’une valeur de champ sécurisée (applicable lorsque fieldType est « champ sécurisé »).
ID de signature	allfields.signatureId	string	ID de la signature appliquée à ce champ de signe (applicable lorsque fieldType est « signfield »).
Image initiale	allfields.initialImage	string	Données d’image pour les initiales appliquées à ce champ (applicable lorsque fieldType est « initialfield »).
Nom du champ Pièce jointe	allfields.attachmentfieldName	string	Nom du champ pièce jointe (applicable lorsque fieldType est « attachmentfield »).
Description de la pièce jointe	allfields.attachmentfieldDescription	string	Description de ce qu’il faut attacher (applicable lorsque fieldType est « attachmentfield »).

Créer un modèle à partir d’une URL

ID d’opération :

CreateTemplatefromURL

Crée un modèle à l’aide d’une URL PDF accessible publiquement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du modèle	templateName	True	string	Nom du modèle. Doit se terminer par l’extension .pdf (par exemple, onboarding.pdf).
URL du modèle	templateUrl	True	string	URL accessible publiquement du document PDF à utiliser comme modèle.
Type d’entrée	inputType	True	string	Méthode d’entrée pour le document. Définissez toujours la valeur « url » pour cette action.
Traiter des balises de texte	processTextTags	True	boolean	Lorsque cette option est activée, Foxit eSign analyse le document pour les balises de texte et les convertit automatiquement en champs de signature.
Traiter les champs Acro	processAcroFields	True	boolean	Lorsque cette option est activée, Foxit eSign analyse le document pour AcroFields et les convertit automatiquement en champs de signature.
Partager tout	shareAll	True	boolean	Partagez ce modèle avec tous les utilisateurs de votre compte.
Nombre de parties	numberOfParties	True	integer	Ajoutez un nombre de parties dans le modèle. Les valeurs de ce paramètre doivent être inférieures à 20.
Couleur de thème	themeColor		string	Entrez une valeur css pour une couleur pour modifier le thème de createEmbeddedTemplateSession .
Email d’auteur	authorEmail		string	Entrez l’e-mail d’un autre utilisateur dans un compte qui sera utilisé comme auteur pour ce modèle.
Créer une session de modèle incorporé	createEmbeddedTemplateSession		boolean	Si la valeur est true, une session de modèle incorporée pour ouvrir directement l’affichage de préparation du modèle Foxit eSign. Le glissement et la suppression de différents champs sur le modèle seront disponibles.
URL de redirection	redirectURL		string	Si createEmbeddedTemplateSession a la valeur true, l’URL absolue peut être entrée pour la page d’accueil sur n’importe quel site web/application vers lequel l’utilisateur sera redirigé après avoir cliqué sur « Enregistrer et fermer » dans l’affichage modèle incorporé.
Masquer le modèle d’envoi	hideSendTemplate		boolean	Si la valeur est true, elle masque le bouton Envoyer dans une vue de modèle incorporée.
Corriger les parties de destinataires	fixRecipientParties		boolean	Si la valeur est true, l’affichage modèle incorporé ne peut pas modifier les parties de l’enveloppe qui sont déjà ajoutées.
Champs	Fields		object
permissions	permission	True	string
Série	sequence	True	integer	Numéro de séquence unique pour cette partie, à partir de 1. Définit l’ordre de signature lorsque la séquence de connexion est activée.
Rôle de destinataire	partyRole	True	string	Rôle attribué à cette partie dans le modèle.
Masquer plus d’action	hideMoreAction		boolean	Si la valeur est true, elle masque le bouton « Autres actions » dans la session de modèle.
Masquer le partage avec tous	hideShareWithAll		boolean	Si la valeur est true, elle masque l’option « Partager avec tout » dans la session de modèle.
Masquer l’ajout d’une partie	hideAddParty		boolean	Si la valeur est true, elle masque toutes les options d’ajout de partie dans une session de modèle incorporée.
Bouton Masquer	hideMeButton		boolean	Si la valeur est true, elle masque le bouton « Moi » sur les parties des destinataires dans une session de modèle incorporée.
Bouton Masquer d’autres utilisateurs	hideOthersButton		boolean	Si la valeur est true, elle masque le bouton « Autres » sur les parties des destinataires dans une session de modèle incorporée.
Masquer l’option Sélectionner un contact existant	hideExistingContactSelectOption		boolean	Si la valeur est true, elle masque la zone d’entrée « Rechercher et ajouter un contact existant » sur les parties des destinataires dans une session de modèle incorporée.
Masquer le nom du champ pour les destinataires	hideFieldNameForRecipients		boolean	Masquer les noms de champs des destinataires pour les champs d’entrée de données et les champs avancés. (À l’exception de la case d’option, case à cocher, image et lien hypertexte).
Masquer la bordure de case à cocher	hideCheckboxBorder		boolean	Les bordures de case à cocher sont masquées dans les documents exécutés.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si l’opération a réussi (par exemple, « réussite »).
Message	message	string	Description du résultat de l’opération.
ID	template.templateId	integer	ID unique du modèle créé. Utilisez cette option pour créer des enveloppes à partir de ce modèle.
Nom	template.templateName	string	Nom du modèle.
Description	template.templateDesc	string	Description du modèle.
Type	template.templateType	string	Type du modèle.
Date de création	template.templateCreationDate	string	Date de création du modèle.
Date de la dernière mise à jour	template.templateLastUpdateDate	string	Date de la dernière mise à jour du modèle.
Modifiable	template.editable	boolean	Indique si le modèle peut être modifié.
Nombre de parties	template.numberOfParties	integer	Nombre de parties destinataires définies dans le modèle.
Total Pages	template.totalPages	integer	Nombre total de pages dans le document de modèle.
ID d’entreprise	template.companyId	integer	ID de l’entreprise à laquelle appartient ce modèle.
Partagé avec tous	template.shareAll	boolean	Indique si ce modèle est partagé avec tous les utilisateurs du compte.
Modèle de nom personnalisé	template.templateCustomName	string	Modèle de nom personnalisé appliqué aux enveloppes créées à partir de ce modèle.
Autorisations de partie	template.templatePartyPermissions	array of object	Liste des rôles de destinataire et leurs autorisations définies dans ce modèle.
ID de partie	template.templatePartyPermissions.template_party_id	integer	ID unique de cette entrée de partie de modèle.
ID	template.templatePartyPermissions.templateId	integer	ID du modèle auquel appartient cette partie.
Permissions	template.templatePartyPermissions.templatePermissions	string	Autorisations de signature pour cette partie (par exemple, FILL_FIELDS_AND_SIGN).
Ordre de signature	template.templatePartyPermissions.partySequence	integer	Position de l’ordre de signature pour cette partie.
Rôle de partie	template.templatePartyPermissions.templatePartyRole	string	Nom du rôle attribué à cette partie dans le modèle. Utilisez cette option lors de la création d’une enveloppe à partir du modèle.
ID de partie	template.templatePartyPermissions.partyId	integer	ID de la partie affectée à ce rôle, s’il est préaffecté.
ID d’utilisateur	template.templateCreatedBy.partyId	integer	ID unique de l’utilisateur.
Prénom	template.templateCreatedBy.firstName	string	Prénom de l’utilisateur.
Nom de famille	template.templateCreatedBy.lastName	string	Nom de famille de l’utilisateur.
Courrier électronique	template.templateCreatedBy.emailId	string	Adresse e-mail de l’utilisateur.
ID d’entreprise	template.templateCreatedBy.companyId	integer	ID de l’entreprise à laquelle appartient l’utilisateur.
Rôle d’utilisateur	template.templateCreatedBy.userRole	string	Rôle de l’utilisateur au sein de son organisation.
Activé	template.templateCreatedBy.active	boolean	Indique si le compte de l’utilisateur est actif.
ID d’utilisateur	template.templateLastUpdatedBy.partyId	integer	ID unique de l’utilisateur.
Prénom	template.templateLastUpdatedBy.firstName	string	Prénom de l’utilisateur.
Nom de famille	template.templateLastUpdatedBy.lastName	string	Nom de famille de l’utilisateur.
Courrier électronique	template.templateLastUpdatedBy.emailId	string	Adresse e-mail de l’utilisateur.
ID d’entreprise	template.templateLastUpdatedBy.companyId	integer	ID de l’entreprise à laquelle appartient l’utilisateur.
Rôle d’utilisateur	template.templateLastUpdatedBy.userRole	string	Rôle de l’utilisateur au sein de son organisation.
Activé	template.templateLastUpdatedBy.active	boolean	Indique si le compte de l’utilisateur est actif.
Champs de modèle	allfields	array of object	Liste de tous les champs de signature et de formulaire définis dans le modèle.
ID de champ	allfields.fieldTagId	integer	Identificateur unique du champ.
ID de modèle	allfields.templateId	integer	ID du modèle auquel appartient ce champ.
ID d’entreprise	allfields.companyId	integer	Compte d’entreprise auquel appartient ce champ.
Type de champ	allfields.fieldType	string	Type du champ (par exemple, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numéro de page	allfields.documentPageNumber	integer	Numéro de page du document où ce champ est placé.
Partie responsable	allfields.partyResponsible	integer	Numéro de séquence de partie responsable du remplissage de ce champ.
Séquence de parties	allfields.partyResponsibleSequence	integer	Position de séquence du tiers responsable.
ID de document de champ	allfields.docFieldId	string	Identificateur au niveau du document pour ce champ.
Dépend	allfields.dependent	boolean	Indique si la visibilité de ce champ dépend de la valeur d’un autre champ.
Ordre des tabulations	allfields.tabOrder	integer	Ordre de tabulation pour la navigation entre les champs.
Required	allfields.required	boolean	Indique si ce champ doit être rempli avant que le document puisse être signé.
Nom de champ personnalisé	allfields.customFieldName	string	Nom personnalisé affecté à ce champ.
Partager tout	allfields.shareAll	boolean	Indique si ce champ est partagé avec tous les utilisateurs.
Autoriser la modification	allfields.allowEdit	boolean	Indique si ce champ peut être modifié par le destinataire.
Nom du champ texte	allfields.textfieldName	string	Étiquette du champ de texte (applicable lorsque fieldType est « textfield »).
Valeur	allfields.value	string	Valeur préremplie ou entrée du champ.
Taille de police	allfields.fontSize	integer	Taille de police utilisée pour le texte dans ce champ.
Couleur de police	allfields.fontColor	string	Couleur de police utilisée pour le texte dans ce champ (par exemple, #000000).
Lecture seule	allfields.readOnly	boolean	Indique si le champ est en lecture seule et ne peut pas être modifié par le destinataire.
Plusieurs lignes	allfields.multiLine	boolean	Indique si le champ de texte accepte plusieurs lignes d’entrée (applicable lorsque fieldType est « textfield »).
Limite de caractères	allfields.characterLimit	integer	Nombre maximal de caractères autorisés dans le champ (applicable lorsque fieldType est « textfield »).
Nom du champ Date	allfields.datefieldName	string	Étiquette du champ date (applicable lorsque fieldType est « datefield »).
Format de date	allfields.dateFormat	string	Format de date utilisé par ce champ (par exemple, MM/DD/AAAA) (applicable lorsque fieldType est « datefield »).
Nom de la case à cocher	allfields.cbname	string	Étiquette du champ de case à cocher (applicable lorsque fieldType est « case à cocher »).
Groupe de cases à cocher	allfields.cbgroup	string	Nom du groupe pour cette case à cocher (applicable lorsque fieldType est « case à cocher »).
Vérifié	allfields.checked	boolean	Indique si la case à cocher est cochée par défaut (applicable lorsque fieldType est « case à cocher »).
Nom du champ sécurisé	allfields.securedfieldName	string	Étiquette du champ sécurisé (applicable lorsque fieldType est « champ sécurisé »).
Caractères à afficher	allfields.charToDisplay	integer	Nombre de caractères non masqués à afficher à la fin d’une valeur de champ sécurisée (applicable lorsque fieldType est « champ sécurisé »).
ID de signature	allfields.signatureId	string	ID de la signature appliquée à ce champ de signe (applicable lorsque fieldType est « signfield »).
Image initiale	allfields.initialImage	string	Données d’image pour les initiales appliquées à ce champ (applicable lorsque fieldType est « initialfield »).
Nom du champ Pièce jointe	allfields.attachmentfieldName	string	Nom du champ pièce jointe (applicable lorsque fieldType est « attachmentfield »).
Description de la pièce jointe	allfields.attachmentfieldDescription	string	Description de ce qu’il faut attacher (applicable lorsque fieldType est « attachmentfield »).

Créer une enveloppe à partir de Base64

ID d’opération :

CreateEnvelopefromBase64

Crée et envoie une enveloppe à l’aide d’un document PDF encodé en Base64.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom de l’enveloppe	folderName	True	string	Nom de cette enveloppe.
Type d’entrée	inputType		string	Type d’entrée pour la source de document. Correction de base64 pour cette action.
Chaînes de fichier Base64	base64FileString	True	array of string	Tableau de documents PDF encodés en Base64 à envoyer.
Noms de fichiers	fileNames	True	array of string	Tableau de noms d’affichage pour chaque document, dans le même ordre que le tableau de chaînes de fichiers Base64.
Prénom	firstName	True	string	Prénom du destinataire.
Nom de famille	lastName	True	string	Nom du destinataire.
adresse Email	emailId	True	string	Adresse e-mail du destinataire.
permissions	permission	True	string
Série	sequence	True	integer	Utilisez ce champ pour affecter un numéro de séquence à un destinataire dans la liste des parties du destinataire. Utilisez des numéros de séquence uniques pour chaque partie commençant par 1 comme 1,2,3,4.... Si une seule personne apparaît plusieurs fois dans le flux de travail de signature, attribuez une séquence différente chaque fois que le destinataire est répété.
signerAuthLevels	signerAuthLevel		string	Niveau d’authentification utilisé par un signataire à des fins de vérification
Espace réservé	isPlaceholder		boolean	Utilisez ce champ pour lancer la partie est un espace réservé. Remarque : 1. firstName, lastName, la valeur du paramètre emailId doit être vide de cette partie. 2. Pour ajouter l’espace réservé, un destinataire doit être réquéré avec l’autorisation « PARTY_ASSIGNER ».
Rôle de destinataire	partyRole		string	Utilisez ce champ pour attribuer un rôle d’espace réservé.
Autoriser la modification du nom	allowNameChange		string	La valeur peut être true ou false Utiliser ce paramètre pour autoriser le signataire à mettre à jour le prénom et le nom avant de terminer le processus de signature.
Séquence de flux de travail	workflowSequence		integer	Affectez un numéro de séquence de flux de travail à ce destinataire. Lorsque la séquence de connexion est activée, les destinataires reçoivent leur invitation de signature dans l’ordre de séquence croissant.
ID d’e-mail de l’hôte	hostEmailId		string	Adresse e-mail de In-Person Administrateur.
Code d'accès	userDefinedAccessCode		string	Le paramètre contient le code d’accès lorsque la valeur « signerAuthLevel » est définie comme « Code d’accès défini par l’utilisateur » pour l’authentification. Remarque : 1. Les codes ne respectent pas la casse. 2. Le système n’envoie pas ce code de sorte que vous devez partager ce code directement avec le signataire. 3. Le code d’accès peut contenir des alphabets, des nombres et les caractères spéciaux suivants : @,& ;{,},%,(,),~,|,!,+,^.
Groupe d’e-mails tiers	partyIsEmailGroup		boolean	Utilisez ce paramètre lors de la création d’une partie en bloc. Note: Si ce paramètre a la valeur true, firstName, lastName et emailId de cette partie sont ignorés.
ID du groupe d’e-mails	emailGroupId		integer	Transmettez l’e-mail à l’ID de groupe que vous souhaitez utiliser pour créer en bloc.
Bloc du signataire unique	allowSingleSignerInBulk		boolean	Utilisez ce paramètre pour autoriser une seule personne à se connecter au groupe de messagerie.
Code de numérotation	dialingCode		string	Utilisez ce champ pour affecter des codes de numérotation de pays sont des préfixes de numéro mobile à un destinataire dans la liste des parties de destinataires.
Numéro de portable	mobileNumber		string	Utilisez ce champ pour affecter un numéro mobile à un destinataire dans la liste des parties de destinataires.
Champs	Fields		object
Envoyer maintenant	sendNow		boolean	Lorsque cette option est activée, Foxit eSign envoie immédiatement un lien de signature unique à l’adresse e-mail de chaque destinataire. Désactivez cette option pour enregistrer l’enveloppe en tant que brouillon à la place.
Créer une session de signature incorporée	createEmbeddedSigningSession	True	boolean	Le jeton de session de signature est généré sans envoyer d’e-mails aux destinataires.
Créer une session de signature incorporée pour toutes les parties	createEmbeddedSigningSessionForAllParties		boolean	Si la valeur est true, une URL de signature incorporée est générée pour chaque destinataire dans l’enveloppe.
Traiter des balises de texte	processTextTags	True	boolean	La valeur peut être true ou false. Ce champ est utilisé pour déterminer si Foxit eSign doit analyser les documents des balises de texte pour les convertir en champs Foxit eSign.
Traiter les champs Acro	processAcroFields	True	boolean	Ce champ est utilisé pour déterminer si Foxit eSign doit analyser les documents d’AcroFields pour les convertir en champs Foxit eSign.
Séquence de connexion	signInSequence		boolean	Ce champ est utilisé pour déterminer si les destinataires signent les documents d’enveloppe dans une séquence. Si la valeur est false, tous les destinataires reçoivent simultanément l’e-mail d’invitation. Lorsque la valeur est true, chaque destinataire reçoit l’e-mail d’invitation successivement une fois que le destinataire précédent a terminé la tâche requise, comme la signature des documents ou le remplissage des champs, etc.
Activer en personne	inPersonEnable		boolean	Ce champ est utilisé pour lancer le processus de signature en personne qui peut être facilement effectué sur n’importe quel appareil en quelques minutes et évite les signatures basées sur les e-mails si nécessaire. Si la valeur est false, tous les destinataires reçoivent simultanément l’e-mail d’invitation. Lorsque la valeur est true, l’administrateur en personne reçoit un e-mail d’invitation pour lancer le processus de signature du signataire.
Corriger les parties de destinataires	fixRecipientParties		boolean	Si la valeur est true, la vue d’envoi incorporée ne peut pas modifier les parties de l’enveloppe qui sont déjà ajoutées dans le cadre de cette demande.
Corriger les documents	fixDocuments		boolean	Si la valeur est true, l’envoi incorporé ne peut pas modifier les documents de l’enveloppe qui sont déjà ajoutés dans le cadre de cette demande.
Url d’envoi de réussite	sendSuccessUrl		string	Entrez l’URL absolue de la page d’accueil vers laquelle le signataire sera redirigé après l’envoi du dossier dans la vue d’envoi incorporée.
URL d’erreur d’envoi	sendErrorUrl		string	Entrez l’URL absolue de la page d’accueil vers laquelle le signataire sera redirigé si l’erreur se produit lors de l’envoi du dossier dans la vue d’envoi incorporée.
Créer une session d’envoi incorporée	createEmbeddedSendingSession		boolean	Si la valeur est true, elle génère un jeton incorporé pour ouvrir la vue de préparation du document de Foxit eSign.
ID de messagerie des signataires incorporés	embeddedSignersEmailIds		array of string	Tableau d’ID d’e-mail des destinataires pour lesquels une session de signature incorporée doit être créée. ID d’e-mail des parties destinataires ajoutées dans la liste des parties.
URL de réussite de signe	signSuccessUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés vers une fois la connexion réussie dans la vue de signature incorporée.
URL de refus de signe	signDeclineUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés si vous refusez de vous connecter à la vue de signature incorporée.
Signer une URL ultérieure	signLaterUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés si vous choisissez de vous connecter ultérieurement en mode de signature incorporé.
URL d’erreur de signe	signErrorUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés vers si une erreur se produit lors de la signature du document en mode de signature incorporé.
Autoriser l’envoi maintenant et la session de signature incorporée	allowSendNowAndEmbeddedSigningSession		boolean	Si la valeur est true, Foxit eSign envoie un lien de signature unique à chaque destinataire. Cela s’applique uniquement lorsque les paramètres sendNow et createEmbeddedSigningSession sont vrais.
Validation avancée des e-mails	allowAdvancedEmailValidation		boolean	Validez l’adresse e-mail des parties lorsqu’elles sont définies sur true.
URL de réussite de signe tous les parties	signSuccessUrlAllParties		boolean	Si la valeur est true, le signataire est redirigé vers l’URL fournie dans le signSuccessUrl après la signature réussie. Cela s’applique uniquement lorsque sendNow a la valeur true.
ID du modèle d’e-mail	emailTemplateId		integer	Transmettez l’ID du modèle d’e-mail pour envoyer les modèles d’e-mail autres que les modèles de messagerie par défaut.
ID d’instruction du signataire	signerInstructionId		integer	Transmettez l’ID d’instruction pour envoyer des instructions de signataire autres que les instructions de signataire par défaut.
ID d’instruction de confirmation	confirmationInstructionId		string	Transmettez l’ID d’instruction de confirmation pour envoyer des instructions de confirmation autres que les instructions de confirmation par défaut.
Couleur de thème	themeColor		string	Entrez la valeur CSS pour définir la couleur du thème.
Expiration de la session	sessionExpire		boolean	Définissez la valeur true pour lancer l’expiration de la session de signature incorporée.
Expiration	expiry		integer	Obligatoire si sessionExpire a la valeur true. Entrez la durée en millisecondes de l’expiration de la session de signature incorporée.
Nom du champ dépendant	dependentFieldName	True	string	Nom du champ dont la visibilité est contrôlée par le champ parent.
Nom du champ parent	parentFieldName	True	string	Nom du champ parent dont la valeur contrôle la visibilité du champ dépendant. Types de champs parents pris en charge : champ de texte, zone de texte, case à cocher, radiobutton, liste déroulante.
Valeur du champ parent	parentFieldValue	True	string	Valeur du champ parent qui déclenche l’affichage du champ dépendant. Pour les champs case à cocher et case d’option, utilisez activé ou décoché.
Options	options	True	string	Options de correspondance supplémentaires pour les champs parent textuels. Valeurs acceptées : isblank, allowNull, contient.
Metadata	metadata		object	Il doit s’agir d’une paire clé-valeur. 1 000 paires de valeurs de clé maximales sont autorisées.
Adresse e-mail de l’expéditeur	senderEmail		string	entrez l’e-mail d’un autre utilisateur dans votre compte qui sera utilisé pour envoyer ce ou ces documents au destinataire.
Bouton Masquer l’ajout de moi	hideAddMeButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter moi » sur les parties du destinataire dans une session d’envoi incorporée.
Masquer le bouton Ajouter un nouveau	hideAddNewButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter nouveau » sur les parties des destinataires dans une session d’envoi incorporée.
Bouton Masquer l’ajout d’un groupe	hideAddGroupButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter un groupe » sur les parties des destinataires dans une session d’envoi incorporée.
Masquer le nom du champ pour les destinataires	hideFieldNameForRecipients		boolean	Masquer les noms de champs des destinataires pour les champs d’entrée de données et les champs avancés. (À l’exception de la case d’option, case à cocher, image et lien hypertexte).
Masquer la bordure de case à cocher	hideCheckboxBorder		boolean	Les bordures de case à cocher sont masquées dans les documents exécutés.
Masquer l’option Sélectionner un signataire	hideSignerSelectOption		boolean	Si la valeur est true, elle masque la zone d’entrée « Nom/e-mail du signataire existant » sur les parties de destinataires dans une session d’envoi incorporée.
Masquer les actions du signataire	hideSignerActions		boolean	Si la valeur est true, le signataire masque les actions « modifier », « modifier » et « supprimer » sur les parties des destinataires dans une session d’envoi incorporée.
Masquer le nom de l’expéditeur	hideSenderName		boolean	Si la valeur est true, elle masque le nom de l’expéditeur sur les parties du destinataire dans une session d’envoi incorporée.
Masquer le nom du dossier	hideFolderName		boolean	Si la valeur est true, elle masque le nom du dossier dans la navigation dans les deux sessions incorporées.
Masquer le nom des documents	hideDocumentsName		boolean	Si la valeur est true, elle masque le nom du document dans les deux sessions incorporées.
Masquer le refus de signer	hideDeclineToSign		boolean	Si la valeur est true, elle masque l’option « Refuser de signer » pour le signataire.
Masquer plus d’action	hideMoreAction		boolean	Si la valeur est true, il masque le bouton « Autres actions » dans l’envoi/la session de signature. En cas de « Envoyer maintenant » : true, il ne masque rien.
Bouton Masquer l’envoi	hideSendButton		boolean	Si la valeur est true, elle masque le bouton Envoyer dans la session d’envoi incorporée.
Masquer le champ requis suivant	hideNextRequiredFieldbtn		boolean	Si la valeur est true, masque le bouton de navigation qui déplace les signataires vers le champ obligatoire suivant.
Obligatoire à la fois session incorporée	requiredBothEmbeddedSession		boolean	Si la valeur est true, elle génère les URL d’envoi et de signature incorporées ensemble.
Mot de passe de l’enveloppe	folderPassword		string	Ce mot de passe est requis par le signataire/auteur pour ouvrir le document signé numériquement. Si le paramètre est conservé vide, aucun mot de passe n’est requis pour ouvrir le document signé numériquement.
Activer pas à pas	enableStepByStep		boolean	Pour activer l’action étape par étape dans la session d’envoi incorporée.
Option Masquer les parties	hideAddPartiesOption		boolean	Si la valeur est true, elle masque l’option permettant d’ajouter des parties en mode Brouillon et Création de modèle.
Auto-signature	selfSign		boolean	Il active l’auto-connexion incorporée via des API. Ce paramètre s’applique uniquement lorsque le paramètre createEmbeddedSendingSession a la valeur true.
URL de réussite de l’auto-signataire	selfSignerSuccessUrl		string	Entrez l’URL absolue de la page d’accueil de votre site web/application, vers laquelle l’utilisateur sera redirigé après avoir correctement envoyé le dossier dans l’affichage d’envoi incorporé.

Retours

Nom	Chemin d’accès	Type	Description
ID	folder.folderId	integer	ID unique de l’enveloppe nouvellement créée. Utilisez-la dans les actions suivantes pour référencer cette enveloppe.
Nom	folder.folderName	string	Nom de l’enveloppe nouvellement créée.
Nom personnalisé	folder.folderCustomName	string	Nom personnalisé de l’enveloppe.
Mot de passe	folder.folderPassword	string	Mot de passe d’accès de l’enveloppe, s’il est défini.
ID du créateur	folder.folderAuthorId	integer	Identificateur unique du créateur d’enveloppe.
Prénom du créateur	folder.folderAuthorFirstName	string	Prénom du créateur de l’enveloppe.
Nom du créateur	folder.folderAuthorLastName	string	Nom du créateur de l’enveloppe.
Adresse e-mail creator	folder.folderAuthorEmail	string	Adresse e-mail du créateur de l’enveloppe.
Rôle créateur	folder.folderAuthorRole	string	Rôle du créateur d’enveloppe.
ID d’entreprise	folder.folderCompanyId	integer	Identificateur unique de l’entreprise propriétaire de l’enveloppe.
Date de création	folder.folderCreationDate	integer	Date de création de l’enveloppe (horodatage Unix en millisecondes).
Date d’envoi	folder.folderSentDate	integer	Date à laquelle l’enveloppe a été envoyée (horodatage Unix en millisecondes).
État	folder.folderStatus	string	État actuel de l’enveloppe.
Champ personnalisé 1	folder.custom_field1	string	Premier champ de métadonnées personnalisé pour l’enveloppe.
Champ personnalisé 2	folder.custom_field2	string	Deuxième champ de métadonnées personnalisé pour l’enveloppe.
Metadata	folder.metadata	string	Métadonnées personnalisées associées à l’enveloppe.
ID de document	folder.folderDocumentIds	array of integer	Liste des ID de document contenus dans l’enveloppe.
Documents	folder.documentsList	array of object	Liste des documents dans l’enveloppe.
ID du document	folder.documentsList.documentId	integer	Identificateur unique du document.
ID de contrat	folder.documentsList.contractId	integer	Identificateur unique du contrat.
ID d’entreprise	folder.documentsList.companyId	integer	Identificateur unique de l’entreprise.
Créée par	folder.documentsList.contractCreatedBy	integer	ID d’utilisateur de la personne qui a créé le contrat.
Date de création	folder.documentsList.contractCreatedOn	string	Date et heure de création du contrat.
Type de contrat	folder.documentsList.contractType	string	Type du contrat.
État du contrat	folder.documentsList.contractStatus	string	État actuel du contrat.
Modifiable	folder.documentsList.editable	boolean	Indique si l’élément est modifiable.
ID de version	folder.documentsList.contractVersionId	integer	Identificateur unique de la version du contrat.
Nom de la version	folder.documentsList.contractVersionName	string	Nom de la version du contrat.
Version Description	folder.documentsList.contractVersionDesc	string	Description de la version du contrat.
Version créée par	folder.documentsList.versionCreatedby	integer	ID utilisateur de la personne qui a créé cette version.
Version créée sur	folder.documentsList.versionCreatedOn	string	Date et heure de création de cette version.
Numéro de version	folder.documentsList.contractVersionNumber	integer	Numéro de version du contrat.
Transaction Source	folder.documentsList.contractTransactionSource	string	Système source qui a lancé la transaction de contrat.
Destinataires	folder.folderRecipientParties	array of object	Liste des parties destinataires pour cette enveloppe.
ID du destinataire	folder.folderRecipientParties.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	folder.folderRecipientParties.partyDetails.partyId	integer	Identificateur unique du destinataire.
Prénom	folder.folderRecipientParties.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	folder.folderRecipientParties.partyDetails.lastName	string	Nom du destinataire.
adresse Email	folder.folderRecipientParties.partyDetails.emailId	string	Adresse e-mail du destinataire.
Texte de remplacement	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indique si cette partie est un destinataire d’espace réservé.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Adresse physique du destinataire.
Date de création	folder.folderRecipientParties.partyDetails.dateCreated	integer	Date de création de l’enregistrement (horodatage Unix en millisecondes).
Désactiver les e-mails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indique si le destinataire a refusé les notifications par e-mail.
ID de destinataire unique	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificateur système unique pour ce destinataire.
Niveau d’authentification	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Méthode d’authentification requise pour ce destinataire.
Date de mise à jour du mot de passe	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Date de la dernière mise à jour du mot de passe.
État mis à jour du mot de passe	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indique si le mot de passe a été mis à jour.
ID d’entreprise	folder.folderRecipientParties.partyDetails.companyId	integer	Identificateur unique de l’entreprise.
Rôle d’utilisateur	folder.folderRecipientParties.partyDetails.userRole	string	Rôle attribué à l’utilisateur.
Département	folder.folderRecipientParties.partyDetails.department	string	Service auquel appartient l’utilisateur.
Titre	folder.folderRecipientParties.partyDetails.title	string	poste occupé par l'utilisateur.
Activé	folder.folderRecipientParties.partyDetails.active	boolean	Indique si l’utilisateur ou l’enregistrement est actif.
Paramètres régionaux	folder.folderRecipientParties.partyDetails.requestLocale	string	Paramètre de paramètres régionaux pour l’utilisateur.
Partager avec Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indique si les enveloppes sont partagées entre le service.
Code de numérotation	folder.folderRecipientParties.partyDetails.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numéro de téléphone mobile.
Filtre d’état	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtre pour l’état du document.
Filtre de date	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtre pour la date du document.
Accès aux champs sécurisés	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indique si l’utilisateur a accès aux champs sécurisés.
Développer la barre latérale	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indique si la barre latérale est développée par défaut.
Adv. Validation par e-mail	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indique si la validation avancée des e-mails est activée.
ID du gestionnaire	folder.folderRecipientParties.partyDetails.managerId	string	Identificateur unique du gestionnaire de l’utilisateur.
Nombre de connexions	folder.folderRecipientParties.partyDetails.loginCount	integer	Nombre de fois où l’utilisateur s’est connecté.
E-mail de réinitialisation de mot de passe	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indique si un e-mail de réinitialisation de mot de passe doit être envoyé.
ID de service	folder.folderRecipientParties.partyDetails.departmentId	string	Identificateur unique du service.
Société principale	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Société principale associée à l’utilisateur.
Type d’appareil	folder.folderRecipientParties.partyDetails.deviceType	string	Type d’appareil utilisé.
Jeton d’appareil	folder.folderRecipientParties.partyDetails.deviceToken	string	Jeton de notification Push pour l’appareil.
Description du sous-traitant	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Description du sous-traitant ou du signataire externe.
Organisation sous-traitante	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nom de l’organisation du sous-traitant ou du signataire externe.
Date d’ajout du sous-traitant	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Date à laquelle le sous-traitant a été ajouté (horodatage Unix en millisecondes).
Source	folder.folderRecipientParties.partyDetails.source	string	Système source à partir duquel le signataire externe a été ajouté.
Code de numérotation	folder.folderRecipientParties.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.folderRecipientParties.mobileNumber	string	Numéro de téléphone mobile.
Type de signature	folder.folderRecipientParties.signerSignatureType	string	Type de signature que le signataire utilisera.
Permissions	folder.folderRecipientParties.contractPermissions	string	Autorisations accordées à cette partie pour le contrat.
Ordre de signature	folder.folderRecipientParties.partySequence	integer	Numéro de séquence de commande de signature pour ce destinataire.
Séquence de flux de travail	folder.folderRecipientParties.workflowSignSequence	integer	Numéro de séquence de signature de flux de travail.
ID d’enveloppe	folder.folderRecipientParties.envelopeId	integer	Identificateur unique de l’enveloppe.
ID d’entreprise du destinataire	folder.folderRecipientParties.partyCompanyId	integer	Identificateur unique de l’entreprise associée à ce destinataire.
Mode de partage	folder.folderRecipientParties.sharingMode	string	Mode de partage pour cette enveloppe.
URL d’accès aux destinataires	folder.folderRecipientParties.folderAccessURL	string	L’URL que le destinataire peut utiliser pour accéder à l’enveloppe et la signer.
Mode de sécurité	folder.folderRecipientParties.securityMode	string	Mode de sécurité appliqué à cette enveloppe.
Commentaires	folder.folderRecipientParties.extraComments	string	Commentaires supplémentaires inclus dans l’enveloppe.
Autoriser la modification du nom	folder.folderRecipientParties.allowNameChange	boolean	Indique si le destinataire est autorisé à mettre à jour son nom.
Nom mis à jour	folder.folderRecipientParties.signerNameUpdated	boolean	Indique si le signataire a mis à jour son nom.
Niveau d’authentification du signataire	folder.folderRecipientParties.signerAuthenticationLevel	string	Niveau d’authentification requis pour le signataire.
Code d'accès	folder.folderRecipientParties.userDefinedAccessCode	string	Code d’accès personnalisé défini pour le signataire.
ID de signature	folder.folderRecipientParties.signatureId	string	Identificateur unique de la signature.
Rôle de destinataire	folder.folderRecipientParties.partyRole	string	Rôle attribué à ce destinataire dans le flux de travail de signature.
Champ d’entreprise	folder.folderRecipientParties.companyFieldValue	string	Valeur du champ nom de la société dans la signature.
Champ Titre	folder.folderRecipientParties.titleFieldValue	string	Valeur du champ de titre dans la signature.
Raison de la signature	folder.folderRecipientParties.reasonSigning	string	Raison pour laquelle le destinataire signe le document.
Champ de paiement ajouté	folder.folderRecipientParties.payFieldAdded	boolean	Indique si un champ de paiement a été ajouté.
Bénéficiaire	folder.folderRecipientParties.payee	boolean	Indique si ce destinataire est le bénéficiaire.
Paiement périodique	folder.folderRecipientParties.recurringFieldExist	boolean	Indique si un champ de paiement périodique existe.
Imprimer et signer terminé	folder.folderRecipientParties.printAndSignCompleted	boolean	Indique si le processus d’impression et de signature est terminé.
Payé	folder.folderRecipientParties.paid	boolean	Indique si le paiement a été effectué.
Signataire facultatif autorisé	folder.folderRecipientParties.allowOptionalSigner	boolean	Indique si ce destinataire est un signataire facultatif.
Signataires facultatifs	folder.folderRecipientParties.optionalSigners	array of integer	Liste des ID de partie de signataire facultatifs pour cette enveloppe.
URL de signature de l’auteur	folder.folderAccessURLForAuthor	string	URL que l’expéditeur peut utiliser pour accéder à l’enveloppe.
URL d’accès brouillon	folder.draftFolderAccessURL	string	URL utilisée pour accéder à la version brouillon de l’enveloppe.
Signature de salle de conseil	folder.boardRoomSign	boolean	Indique si le mode de signature de salle de carte est activé.
Inclure le logo	folder.includeLogo	boolean	Indique si le logo de l’entreprise est inclus dans les e-mails.
Couleur d’arrière-plan du bouton	folder.email_btnBgColor	string	Couleur d’arrière-plan du bouton e-mail.
Couleur de texte du bouton	folder.email_btnTxtColor	string	Couleur de texte du bouton e-mail.
Logo de messagerie	folder.emailTemplateLogo	string	URL du logo utilisée dans le modèle d’e-mail.
ID du modèle d’e-mail	folder.emailTemplateId	integer	Identificateur unique du modèle d’e-mail.
En-tête d’e-mail	folder.emailHeader	string	Texte d’en-tête utilisé dans les e-mails de notification.
Pied de page d’e-mail	folder.emailFooter	string	Texte du pied de page utilisé dans les e-mails de notification.
Purge planifiée	folder.purgeFlag	boolean	Indique si l’enveloppe est planifiée pour purger.
Date de début du vidage	folder.purgeStartDate	string	Date à partir de laquelle la purge est planifiée pour commencer.
Date de fin du vidage	folder.purgeEndDate	string	Date à laquelle la purge est prévue.
ID d’envoi en bloc	folder.bulkId	integer	Identificateur unique de l’opération d’envoi en bloc.
Appliquer l’ordre de signature	folder.enforceSignWorkflow	boolean	Indique si les destinataires doivent se connecter à la séquence définie.
Étape actuelle	folder.currentWorkflowStep	integer	Étape actuelle du flux de travail de signature.
Transaction Source	folder.transactionSource	string	Système source qui a lancé cette transaction.
Modifiable	folder.editable	boolean	Indique si l’élément est modifiable.
signature In-Person	folder.inPersonSignable	boolean	Indique si l’enveloppe peut être connectée à la personne.
Remplacer les rappels	folder.overrideAccountReminders	boolean	Indique si les paramètres de rappel au niveau du compte sont remplacés.
Remplacer la délégation	folder.overrideAccountRecipientDelegation	boolean	Indique si les paramètres de délégation au niveau du compte sont remplacés.
Autoriser la délégation	folder.allowRecipientsToDelegate	boolean	Indique si les destinataires sont autorisés à déléguer la signature.
ID	folder.envelopeId	integer	Identificateur unique de l’enveloppe.
Nom	folder.envelopeName	string	Nom de l’enveloppe.
ID d’origine	folder.envelopeOriginatorId	integer	Identificateur unique de l’utilisateur qui a créé l’enveloppe.
ID d’entreprise	folder.envelopeCompanyId	integer	Identificateur unique de l’entreprise propriétaire de l’enveloppe.
Date	folder.envelopeDate	integer	Date de création de l’enveloppe (horodatage Unix en millisecondes).
Date partagée	folder.envelopeSharedDate	integer	Date à laquelle l’enveloppe a été partagée (horodatage Unix en millisecondes).
État	folder.envelopeStatus	string	État actuel de l’enveloppe.
ID de contrat	folder.envelopeContractIds	array of integer	Liste des ID de contrat associés à cette enveloppe.
Autorisations du destinataire	folder.envelopePartyPermissions	array of object	Liste des autorisations de destinataire pour cette enveloppe.
ID du destinataire	folder.envelopePartyPermissions.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	folder.envelopePartyPermissions.partyDetails.partyId	integer	Identificateur unique du destinataire.
Prénom	folder.envelopePartyPermissions.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	folder.envelopePartyPermissions.partyDetails.lastName	string	Nom du destinataire.
adresse Email	folder.envelopePartyPermissions.partyDetails.emailId	string	Adresse e-mail du destinataire.
Texte de remplacement	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indique si cette partie est un destinataire d’espace réservé.
Adresse	folder.envelopePartyPermissions.partyDetails.address	string	Adresse physique du destinataire.
Date de création	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Date de création de l’enregistrement (horodatage Unix en millisecondes).
Désactiver les e-mails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indique si le destinataire a refusé les notifications par e-mail.
ID de destinataire unique	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Identificateur système unique pour ce destinataire.
Niveau d’authentification	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Méthode d’authentification requise pour ce destinataire.
Date de mise à jour du mot de passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Date de la dernière mise à jour du mot de passe.
État mis à jour du mot de passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indique si le mot de passe a été mis à jour.
ID d’entreprise	folder.envelopePartyPermissions.partyDetails.companyId	integer	Identificateur unique de l’entreprise.
Rôle d’utilisateur	folder.envelopePartyPermissions.partyDetails.userRole	string	Rôle attribué à l’utilisateur.
Département	folder.envelopePartyPermissions.partyDetails.department	string	Service auquel appartient l’utilisateur.
Titre	folder.envelopePartyPermissions.partyDetails.title	string	poste occupé par l'utilisateur.
Activé	folder.envelopePartyPermissions.partyDetails.active	boolean	Indique si l’utilisateur ou l’enregistrement est actif.
Paramètres régionaux	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Paramètre de paramètres régionaux pour l’utilisateur.
Partager avec Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indique si les enveloppes sont partagées entre le service.
Code de numérotation	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Numéro de téléphone mobile.
Filtre d’état	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtre pour l’état du document.
Filtre de date	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtre pour la date du document.
Accès aux champs sécurisés	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indique si l’utilisateur a accès aux champs sécurisés.
Développer la barre latérale	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indique si la barre latérale est développée par défaut.
Adv. Validation par e-mail	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indique si la validation avancée des e-mails est activée.
ID du gestionnaire	folder.envelopePartyPermissions.partyDetails.managerId	string	Identificateur unique du gestionnaire de l’utilisateur.
Nombre de connexions	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Nombre de fois où l’utilisateur s’est connecté.
E-mail de réinitialisation de mot de passe	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indique si un e-mail de réinitialisation de mot de passe doit être envoyé.
ID de service	folder.envelopePartyPermissions.partyDetails.departmentId	string	Identificateur unique du service.
Société principale	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Société principale associée à l’utilisateur.
Type d’appareil	folder.envelopePartyPermissions.partyDetails.deviceType	string	Type d’appareil utilisé.
Jeton d’appareil	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Jeton de notification Push pour l’appareil.
Description du sous-traitant	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Description du sous-traitant ou du signataire externe.
Organisation sous-traitante	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Nom de l’organisation du sous-traitant ou du signataire externe.
Date ajoutée par le sous-traitant	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Date à laquelle le sous-traitant a été ajouté (horodatage Unix en millisecondes).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Système source à partir duquel le signataire externe a été ajouté.
Code de numérotation	folder.envelopePartyPermissions.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.envelopePartyPermissions.mobileNumber	string	Numéro de téléphone mobile.
Type de signature	folder.envelopePartyPermissions.signerSignatureType	string	Type de signature que le signataire utilisera.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Autorisations accordées à cette partie pour le contrat.
Ordre de signature	folder.envelopePartyPermissions.partySequence	integer	Numéro de séquence de commande de signature pour ce destinataire.
Séquence de flux de travail	folder.envelopePartyPermissions.workflowSignSequence	integer	Numéro de séquence de signature de flux de travail.
ID d’enveloppe	folder.envelopePartyPermissions.envelopeId	integer	Identificateur unique de l’enveloppe.
ID d’entreprise du destinataire	folder.envelopePartyPermissions.partyCompanyId	integer	Identificateur unique de l’entreprise associée à ce destinataire.
Mode de partage	folder.envelopePartyPermissions.sharingMode	string	Mode de partage pour cette enveloppe.
URL d’accès aux destinataires	folder.envelopePartyPermissions.folderAccessURL	string	L’URL que le destinataire peut utiliser pour accéder à l’enveloppe et la signer.
Mode de sécurité	folder.envelopePartyPermissions.securityMode	string	Mode de sécurité appliqué à cette enveloppe.
Commentaires	folder.envelopePartyPermissions.extraComments	string	Commentaires supplémentaires inclus dans l’enveloppe.
Autoriser la modification du nom	folder.envelopePartyPermissions.allowNameChange	boolean	Indique si le destinataire est autorisé à mettre à jour son nom.
Nom mis à jour	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indique si le signataire a mis à jour son nom.
Niveau d’authentification du signataire	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Niveau d’authentification requis pour le signataire.
Code d'accès	folder.envelopePartyPermissions.userDefinedAccessCode	string	Code d’accès personnalisé défini pour le signataire.
ID de signature	folder.envelopePartyPermissions.signatureId	string	Identificateur unique de la signature.
Rôle de destinataire	folder.envelopePartyPermissions.partyRole	string	Rôle attribué à ce destinataire dans le flux de travail de signature.
Champ d’entreprise	folder.envelopePartyPermissions.companyFieldValue	string	Valeur du champ nom de la société dans la signature.
Champ Titre	folder.envelopePartyPermissions.titleFieldValue	string	Valeur du champ de titre dans la signature.
Raison de la signature	folder.envelopePartyPermissions.reasonSigning	string	Raison pour laquelle le destinataire signe le document.
Champ de paiement ajouté	folder.envelopePartyPermissions.payFieldAdded	boolean	Indique si un champ de paiement a été ajouté.
Bénéficiaire	folder.envelopePartyPermissions.payee	boolean	Indique si ce destinataire est le bénéficiaire.
Paiement périodique	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indique si un champ de paiement périodique existe.
Imprimer et signer terminé	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indique si le processus d’impression et de signature est terminé.
Payé	folder.envelopePartyPermissions.paid	boolean	Indique si le paiement a été effectué.
Niveau d’authentification	folder.envelopeAuthenticationLevel	string	Niveau d’authentification requis pour l’enveloppe.
Bloc du signataire unique	folder.allowSingleSignerInBulk	boolean	Indique si un seul signataire est autorisé en mode d’envoi en bloc.
nommage File-Based	folder.folderNameBasedOnFileNaming	boolean	Indique si le nom du dossier est basé sur le nom du fichier.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Indique si le nom du document est basé sur le nom du fichier.
Cert File-Based Name	folder.certificateNameBasedOnFileNaming	boolean	Indique si le nom du certificat est basé sur le nom de fichier.
Nommage de fichier pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Indique si le nommage de fichier est activé avant l’exécution du document.
Payee ajouté	folder.payeeAddedd	boolean	Indique si un bénéficiaire a été ajouté.
Self-Signing activé	folder.selfSignerEnabled	boolean	Indique si le mode de signature automatique est activé.
Non autorisé	folder.notaryEnabled	boolean	Indique si la signature notarié est activée.
Visibilité limitée	folder.limitedVisibilityFlag	boolean	Indique si une visibilité limitée est activée pour cette enveloppe.
Visibilité post-signature	folder.postSigningVisibility	boolean	Indique si la visibilité post-signature est activée.
Signature humide	folder.wetSignatureEnabled	boolean	Indique si les signatures humides sont activées.
Fusion activée	folder.mergeEnabled	boolean	Indique si la fusion de documents est activée.
Sessions de signature incorporées	embeddedSigningSessions	array of object	Liste des sessions de signature incorporées, une par destinataire. Uniquement présent lorsque createEmbeddedSigningSession a la valeur true.
E-mail du signataire	embeddedSigningSessions.emailIdOfSigner	string	Adresse e-mail du destinataire pour cette session de signature incorporée.
Jeton de signature	embeddedSigningSessions.embeddedToken	string	Jeton unique pour la session de signature incorporée de ce destinataire.
URL de session de signature	embeddedSigningSessions.embeddedSessionURL	string	URL à ouvrir ou incorporer pour ce destinataire pour signer le document.
Jeton d’envoi incorporé	embeddedToken	string	Jeton de la session d’envoi incorporée. Uniquement présent lorsque createEmbeddedSendingSession a la valeur true.
URL de session d’envoi	embeddedSessionURL	string	URL permettant d’ouvrir ou d’incorporer l’auteur de l’enveloppe pour préparer et envoyer l’enveloppe. Uniquement présent lorsque createEmbeddedSendingSession a la valeur true.
Result	result	string	Résultat de l'opération.
Message	message	string	Message décrivant le résultat de l’opération.

Créer une enveloppe à partir de l’URL

ID d’opération :

CreateEnvelopefromURL

Crée et envoie une enveloppe à l’aide d’URL PDF accessibles publiquement. Fournissez les URL de document et les détails du destinataire pour lancer le processus de signature.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom de l’enveloppe	folderName	True	string	Nom de cette enveloppe.
Type d’entrée	inputType		string	Spécifie le format source du document. Définissez sur l’URL pour fournir des URL de fichier, ou base64 pour fournir du contenu de fichier encodé en Base64.
URL de fichier	fileUrls	True	array of string	Tableau d’URL accessibles publiquement pointant vers les documents à ajouter à cette enveloppe.
Noms de fichiers	fileNames	True	array of string	Tableau de noms d’affichage pour chaque document, dans le même ordre que les URL de fichier.
Prénom	firstName	True	string	Prénom du destinataire.
Nom de famille	lastName	True	string	Nom du destinataire.
adresse Email	emailId	True	string	Adresse e-mail du destinataire.
permissions	permission	True	string
Série	sequence	True	integer	Utilisez ce champ pour affecter un numéro de séquence à un destinataire dans la liste des parties du destinataire. Utilisez des numéros de séquence uniques pour chaque partie commençant par 1 comme 1,2,3,4.... Si une seule personne apparaît plusieurs fois dans le flux de travail de signature, attribuez une séquence différente chaque fois que le destinataire est répété.
signerAuthLevels	signerAuthLevel		string	Niveau d’authentification utilisé par un signataire à des fins de vérification
Espace réservé	isPlaceholder		boolean	Utilisez ce champ pour lancer la partie est un espace réservé. Remarque : 1. firstName, lastName, la valeur du paramètre emailId doit être vide de cette partie. 2. Pour ajouter l’espace réservé, un destinataire doit être réquéré avec l’autorisation « PARTY_ASSIGNER ».
Rôle de destinataire	partyRole		string	Utilisez ce champ pour attribuer un rôle d’espace réservé.
Autoriser la modification du nom	allowNameChange		string	La valeur peut être true ou false Utiliser ce paramètre pour autoriser le signataire à mettre à jour le prénom et le nom avant de terminer le processus de signature.
Séquence de flux de travail	workflowSequence		integer	Affectez un numéro de séquence de flux de travail à ce destinataire. Lorsque la séquence de connexion est activée, les destinataires reçoivent leur invitation de signature dans l’ordre de séquence croissant.
ID d’e-mail de l’hôte	hostEmailId		string	Adresse e-mail de In-Person Administrateur.
Code d'accès	userDefinedAccessCode		string	Le paramètre contient le code d’accès lorsque la valeur « signerAuthLevel » est définie comme « Code d’accès défini par l’utilisateur » pour l’authentification. Remarque : 1. Les codes ne respectent pas la casse. 2. Le système n’envoie pas ce code de sorte que vous devez partager ce code directement avec le signataire. 3. Le code d’accès peut contenir des alphabets, des nombres et les caractères spéciaux suivants : @,& ;{,},%,(,),~,|,!,+,^.
Groupe d’e-mails tiers	partyIsEmailGroup		boolean	Utilisez ce paramètre lors de la création d’une partie en bloc. Note: Si ce paramètre a la valeur true, firstName, lastName et emailId de cette partie sont ignorés.
ID du groupe d’e-mails	emailGroupId		integer	Transmettez l’e-mail à l’ID de groupe que vous souhaitez utiliser pour créer en bloc.
Bloc du signataire unique	allowSingleSignerInBulk		boolean	Utilisez ce paramètre pour autoriser une seule personne à se connecter au groupe de messagerie.
Code de numérotation	dialingCode		string	Utilisez ce champ pour affecter des codes de numérotation de pays sont des préfixes de numéro mobile à un destinataire dans la liste des parties de destinataires.
Numéro de portable	mobileNumber		string	Utilisez ce champ pour affecter un numéro mobile à un destinataire dans la liste des parties de destinataires.
Champs	Fields		object
Envoyer maintenant	sendNow		boolean	Lorsque cette option est activée, Foxit eSign envoie immédiatement un lien de signature unique à l’adresse e-mail de chaque destinataire. Désactivez cette option pour enregistrer l’enveloppe en tant que brouillon à la place.
Créer une session de signature incorporée	createEmbeddedSigningSession	True	boolean	Le jeton de session de signature est généré sans envoyer d’e-mails aux destinataires.
Créer une session de signature incorporée pour toutes les parties	createEmbeddedSigningSessionForAllParties		boolean	Si la valeur est true, une URL de signature incorporée est générée pour chaque destinataire dans l’enveloppe.
Traiter des balises de texte	processTextTags	True	boolean	La valeur peut être true ou false. Ce champ est utilisé pour déterminer si Foxit eSign doit analyser les documents des balises de texte pour les convertir en champs Foxit eSign.
Traiter les champs Acro	processAcroFields	True	boolean	Ce champ est utilisé pour déterminer si Foxit eSign doit analyser les documents d’AcroFields pour les convertir en champs Foxit eSign.
Séquence de connexion	signInSequence		boolean	Ce champ est utilisé pour déterminer si les destinataires signent les documents d’enveloppe dans une séquence. Si la valeur est false, tous les destinataires reçoivent simultanément l’e-mail d’invitation. Lorsque la valeur est true, chaque destinataire reçoit l’e-mail d’invitation successivement une fois que le destinataire précédent a terminé la tâche requise, comme la signature des documents ou le remplissage des champs, etc.
Activer en personne	inPersonEnable		boolean	Ce champ est utilisé pour lancer le processus de signature en personne qui peut être facilement effectué sur n’importe quel appareil en quelques minutes et évite les signatures basées sur les e-mails si nécessaire. Si la valeur est false, tous les destinataires reçoivent simultanément l’e-mail d’invitation. Lorsque la valeur est true, l’administrateur en personne reçoit un e-mail d’invitation pour lancer le processus de signature du signataire.
Corriger les parties de destinataires	fixRecipientParties		boolean	Si la valeur est true, la vue d’envoi incorporée ne peut pas modifier les parties de l’enveloppe qui sont déjà ajoutées dans le cadre de cette demande.
Corriger les documents	fixDocuments		boolean	Si la valeur est true, l’envoi incorporé ne peut pas modifier les documents de l’enveloppe qui sont déjà ajoutés dans le cadre de cette demande.
Url d’envoi de réussite	sendSuccessUrl		string	Entrez l’URL absolue de la page d’accueil vers laquelle le signataire sera redirigé après l’envoi du dossier dans la vue d’envoi incorporée.
URL d’erreur d’envoi	sendErrorUrl		string	Entrez l’URL absolue de la page d’accueil vers laquelle le signataire sera redirigé si l’erreur se produit lors de l’envoi du dossier dans la vue d’envoi incorporée.
Créer une session d’envoi incorporée	createEmbeddedSendingSession		boolean	Si la valeur est true, elle génère un jeton incorporé pour ouvrir la vue de préparation du document de Foxit eSign.
ID de messagerie des signataires incorporés	embeddedSignersEmailIds		array of string	Tableau d’ID d’e-mail des destinataires pour lesquels une session de signature incorporée doit être créée. ID d’e-mail des parties destinataires ajoutées dans la liste des parties.
URL de réussite de signe	signSuccessUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés vers une fois la connexion réussie dans la vue de signature incorporée.
URL de refus de signe	signDeclineUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés si vous refusez de vous connecter à la vue de signature incorporée.
Signer une URL ultérieure	signLaterUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés si vous choisissez de vous connecter ultérieurement en mode de signature incorporé.
URL d’erreur de signe	signErrorUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés vers si une erreur se produit lors de la signature du document en mode de signature incorporé.
Autoriser l’envoi maintenant et la session de signature incorporée	allowSendNowAndEmbeddedSigningSession		boolean	Si la valeur est true, Foxit eSign envoie un lien de signature unique à chaque destinataire. Cela s’applique uniquement lorsque les paramètres sendNow et createEmbeddedSigningSession sont vrais.
Validation avancée des e-mails	allowAdvancedEmailValidation		boolean	Validez l’adresse e-mail des parties lorsqu’elles sont définies sur true.
URL de réussite de signe tous les parties	signSuccessUrlAllParties		boolean	Si la valeur est true, le signataire est redirigé vers l’URL fournie dans le signSuccessUrl après la signature réussie. Cela s’applique uniquement lorsque sendNow a la valeur true.
ID du modèle d’e-mail	emailTemplateId		integer	Transmettez l’ID du modèle d’e-mail pour envoyer les modèles d’e-mail autres que les modèles de messagerie par défaut.
ID d’instruction du signataire	signerInstructionId		integer	Transmettez l’ID d’instruction pour envoyer des instructions de signataire autres que les instructions de signataire par défaut.
ID d’instruction de confirmation	confirmationInstructionId		string	Transmettez l’ID d’instruction de confirmation pour envoyer des instructions de confirmation autres que les instructions de confirmation par défaut.
Couleur de thème	themeColor		string	Entrez la valeur CSS pour définir la couleur du thème.
Expiration de la session	sessionExpire		boolean	Définissez la valeur true pour lancer l’expiration de la session de signature incorporée.
Expiration	expiry		integer	Obligatoire si sessionExpire a la valeur true. Entrez la durée en millisecondes de l’expiration de la session de signature incorporée.
Nom du champ dépendant	dependentFieldName	True	string	Nom du champ dont la visibilité est contrôlée par le champ parent.
Nom du champ parent	parentFieldName	True	string	Nom du champ parent dont la valeur contrôle la visibilité du champ dépendant. Types de champs parents pris en charge : champ de texte, zone de texte, case à cocher, radiobutton, liste déroulante.
Valeur du champ parent	parentFieldValue	True	string	Valeur du champ parent qui déclenche l’affichage du champ dépendant. Pour les champs case à cocher et case d’option, utilisez activé ou décoché.
Options	options	True	string	Options de correspondance supplémentaires pour les champs parent textuels. Valeurs acceptées : isblank, allowNull, contient.
Metadata	metadata		object	Il doit s’agir d’une paire clé-valeur. 1 000 paires de valeurs de clé maximales sont autorisées.
Adresse e-mail de l’expéditeur	senderEmail		string	entrez l’e-mail d’un autre utilisateur dans votre compte qui sera utilisé pour envoyer ce ou ces documents au destinataire.
Bouton Masquer l’ajout de moi	hideAddMeButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter moi » sur les parties du destinataire dans une session d’envoi incorporée.
Masquer le bouton Ajouter un nouveau	hideAddNewButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter nouveau » sur les parties des destinataires dans une session d’envoi incorporée.
Bouton Masquer l’ajout d’un groupe	hideAddGroupButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter un groupe » sur les parties des destinataires dans une session d’envoi incorporée.
Masquer le nom du champ pour les destinataires	hideFieldNameForRecipients		boolean	Masquer les noms de champs des destinataires pour les champs d’entrée de données et les champs avancés. (À l’exception de la case d’option, case à cocher, image et lien hypertexte).
Masquer la bordure de case à cocher	hideCheckboxBorder		boolean	Les bordures de case à cocher sont masquées dans les documents exécutés.
Masquer l’option Sélectionner un signataire	hideSignerSelectOption		boolean	Si la valeur est true, elle masque la zone d’entrée « Nom/e-mail du signataire existant » sur les parties de destinataires dans une session d’envoi incorporée.
Masquer les actions du signataire	hideSignerActions		boolean	Si la valeur est true, le signataire masque les actions « modifier », « modifier » et « supprimer » sur les parties des destinataires dans une session d’envoi incorporée.
Masquer le nom de l’expéditeur	hideSenderName		boolean	Si la valeur est true, elle masque le nom de l’expéditeur sur les parties du destinataire dans une session d’envoi incorporée.
Masquer le nom du dossier	hideFolderName		boolean	Si la valeur est true, elle masque le nom du dossier dans la navigation dans les deux sessions incorporées.
Masquer le nom des documents	hideDocumentsName		boolean	Si la valeur est true, elle masque le nom du document dans les deux sessions incorporées.
Masquer le refus de signer	hideDeclineToSign		boolean	Si la valeur est true, elle masque l’option « Refuser de signer » pour le signataire.
Masquer plus d’action	hideMoreAction		boolean	Si la valeur est true, il masque le bouton « Autres actions » dans l’envoi/la session de signature. En cas de « Envoyer maintenant » : true, il ne masque rien.
Bouton Masquer l’envoi	hideSendButton		boolean	Si la valeur est true, elle masque le bouton Envoyer dans la session d’envoi incorporée.
Masquer le champ requis suivant	hideNextRequiredFieldbtn		boolean	Si la valeur est true, masque le bouton de navigation qui déplace les signataires vers le champ obligatoire suivant.
Obligatoire à la fois session incorporée	requiredBothEmbeddedSession		boolean	Si la valeur est true, elle génère les URL d’envoi et de signature incorporées ensemble.
Mot de passe de l’enveloppe	folderPassword		string	Ce mot de passe est requis par le signataire/auteur pour ouvrir le document signé numériquement. Si le paramètre est conservé vide, aucun mot de passe n’est requis pour ouvrir le document signé numériquement.
Activer pas à pas	enableStepByStep		boolean	Pour activer l’action étape par étape dans la session d’envoi incorporée.
Option Masquer les parties	hideAddPartiesOption		boolean	Si la valeur est true, elle masque l’option permettant d’ajouter des parties en mode Brouillon et Création de modèle.
Auto-signature	selfSign		boolean	Il active l’auto-connexion incorporée via des API. Ce paramètre s’applique uniquement lorsque le paramètre createEmbeddedSendingSession a la valeur true.
URL de réussite de l’auto-signataire	selfSignerSuccessUrl		string	Entrez l’URL absolue de la page d’accueil de votre site web/application, vers laquelle l’utilisateur sera redirigé après avoir correctement envoyé le dossier dans l’affichage d’envoi incorporé.

Retours

Nom	Chemin d’accès	Type	Description
ID	folder.folderId	integer	ID unique de l’enveloppe nouvellement créée. Utilisez-la dans les actions suivantes pour référencer cette enveloppe.
Nom	folder.folderName	string	Nom de l’enveloppe nouvellement créée.
Nom personnalisé	folder.folderCustomName	string	Nom personnalisé de l’enveloppe.
Mot de passe	folder.folderPassword	string	Mot de passe d’accès de l’enveloppe, s’il est défini.
ID du créateur	folder.folderAuthorId	integer	Identificateur unique du créateur d’enveloppe.
Prénom du créateur	folder.folderAuthorFirstName	string	Prénom du créateur de l’enveloppe.
Nom du créateur	folder.folderAuthorLastName	string	Nom du créateur de l’enveloppe.
Adresse e-mail creator	folder.folderAuthorEmail	string	Adresse e-mail du créateur de l’enveloppe.
Rôle créateur	folder.folderAuthorRole	string	Rôle du créateur d’enveloppe.
ID d’entreprise	folder.folderCompanyId	integer	Identificateur unique de l’entreprise propriétaire de l’enveloppe.
Date de création	folder.folderCreationDate	integer	Date de création de l’enveloppe (horodatage Unix en millisecondes).
Date d’envoi	folder.folderSentDate	integer	Date à laquelle l’enveloppe a été envoyée (horodatage Unix en millisecondes).
État	folder.folderStatus	string	État actuel de l’enveloppe.
Champ personnalisé 1	folder.custom_field1	string	Premier champ de métadonnées personnalisé pour l’enveloppe.
Champ personnalisé 2	folder.custom_field2	string	Deuxième champ de métadonnées personnalisé pour l’enveloppe.
Metadata	folder.metadata	string	Métadonnées personnalisées associées à l’enveloppe.
ID de document	folder.folderDocumentIds	array of integer	Liste des ID de document contenus dans l’enveloppe.
Documents	folder.documentsList	array of object	Liste des documents dans l’enveloppe.
ID du document	folder.documentsList.documentId	integer	Identificateur unique du document.
ID de contrat	folder.documentsList.contractId	integer	Identificateur unique du contrat.
ID d’entreprise	folder.documentsList.companyId	integer	Identificateur unique de l’entreprise.
Créée par	folder.documentsList.contractCreatedBy	integer	ID d’utilisateur de la personne qui a créé le contrat.
Date de création	folder.documentsList.contractCreatedOn	string	Date et heure de création du contrat.
Type de contrat	folder.documentsList.contractType	string	Type du contrat.
État du contrat	folder.documentsList.contractStatus	string	État actuel du contrat.
Modifiable	folder.documentsList.editable	boolean	Indique si l’élément est modifiable.
ID de version	folder.documentsList.contractVersionId	integer	Identificateur unique de la version du contrat.
Nom de la version	folder.documentsList.contractVersionName	string	Nom de la version du contrat.
Version Description	folder.documentsList.contractVersionDesc	string	Description de la version du contrat.
Version créée par	folder.documentsList.versionCreatedby	integer	ID utilisateur de la personne qui a créé cette version.
Version créée sur	folder.documentsList.versionCreatedOn	string	Date et heure de création de cette version.
Numéro de version	folder.documentsList.contractVersionNumber	integer	Numéro de version du contrat.
Transaction Source	folder.documentsList.contractTransactionSource	string	Système source qui a lancé la transaction de contrat.
Destinataires	folder.folderRecipientParties	array of object	Liste des parties destinataires pour cette enveloppe.
ID du destinataire	folder.folderRecipientParties.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	folder.folderRecipientParties.partyDetails.partyId	integer	Identificateur unique du destinataire.
Prénom	folder.folderRecipientParties.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	folder.folderRecipientParties.partyDetails.lastName	string	Nom du destinataire.
adresse Email	folder.folderRecipientParties.partyDetails.emailId	string	Adresse e-mail du destinataire.
Texte de remplacement	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indique si cette partie est un destinataire d’espace réservé.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Adresse physique du destinataire.
Date de création	folder.folderRecipientParties.partyDetails.dateCreated	integer	Date de création de l’enregistrement (horodatage Unix en millisecondes).
Désactiver les e-mails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indique si le destinataire a refusé les notifications par e-mail.
ID de destinataire unique	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificateur système unique pour ce destinataire.
Niveau d’authentification	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Méthode d’authentification requise pour ce destinataire.
Date de mise à jour du mot de passe	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Date de la dernière mise à jour du mot de passe.
État mis à jour du mot de passe	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indique si le mot de passe a été mis à jour.
ID d’entreprise	folder.folderRecipientParties.partyDetails.companyId	integer	Identificateur unique de l’entreprise.
Rôle d’utilisateur	folder.folderRecipientParties.partyDetails.userRole	string	Rôle attribué à l’utilisateur.
Département	folder.folderRecipientParties.partyDetails.department	string	Service auquel appartient l’utilisateur.
Titre	folder.folderRecipientParties.partyDetails.title	string	poste occupé par l'utilisateur.
Activé	folder.folderRecipientParties.partyDetails.active	boolean	Indique si l’utilisateur ou l’enregistrement est actif.
Paramètres régionaux	folder.folderRecipientParties.partyDetails.requestLocale	string	Paramètre de paramètres régionaux pour l’utilisateur.
Partager avec Dept	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Indique si les enveloppes sont partagées entre le service.
Code de numérotation	folder.folderRecipientParties.partyDetails.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numéro de téléphone mobile.
Filtre d’état	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Filtre pour l’état du document.
Filtre de date	folder.folderRecipientParties.partyDetails.docDateFilter	string	Filtre pour la date du document.
Accès aux champs sécurisés	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Indique si l’utilisateur a accès aux champs sécurisés.
Développer la barre latérale	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Indique si la barre latérale est développée par défaut.
Adv. Validation par e-mail	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Indique si la validation avancée des e-mails est activée.
ID du gestionnaire	folder.folderRecipientParties.partyDetails.managerId	string	Identificateur unique du gestionnaire de l’utilisateur.
Nombre de connexions	folder.folderRecipientParties.partyDetails.loginCount	integer	Nombre de fois où l’utilisateur s’est connecté.
E-mail de réinitialisation de mot de passe	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Indique si un e-mail de réinitialisation de mot de passe doit être envoyé.
ID de service	folder.folderRecipientParties.partyDetails.departmentId	string	Identificateur unique du service.
Société principale	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Société principale associée à l’utilisateur.
Type d’appareil	folder.folderRecipientParties.partyDetails.deviceType	string	Type d’appareil utilisé.
Jeton d’appareil	folder.folderRecipientParties.partyDetails.deviceToken	string	Jeton de notification Push pour l’appareil.
Description du sous-traitant	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Description du sous-traitant ou du signataire externe.
Organisation sous-traitante	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nom de l’organisation du sous-traitant ou du signataire externe.
Date d’ajout du sous-traitant	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Date à laquelle le sous-traitant a été ajouté (horodatage Unix en millisecondes).
Source	folder.folderRecipientParties.partyDetails.source	string	Système source à partir duquel le signataire externe a été ajouté.
Code de numérotation	folder.folderRecipientParties.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.folderRecipientParties.mobileNumber	string	Numéro de téléphone mobile.
Type de signature	folder.folderRecipientParties.signerSignatureType	string	Type de signature que le signataire utilisera.
Permissions	folder.folderRecipientParties.contractPermissions	string	Autorisations accordées à cette partie pour le contrat.
Ordre de signature	folder.folderRecipientParties.partySequence	integer	Numéro de séquence de commande de signature pour ce destinataire.
Séquence de flux de travail	folder.folderRecipientParties.workflowSignSequence	integer	Numéro de séquence de signature de flux de travail.
ID d’enveloppe	folder.folderRecipientParties.envelopeId	integer	Identificateur unique de l’enveloppe.
ID d’entreprise du destinataire	folder.folderRecipientParties.partyCompanyId	integer	Identificateur unique de l’entreprise associée à ce destinataire.
Mode de partage	folder.folderRecipientParties.sharingMode	string	Mode de partage pour cette enveloppe.
URL d’accès aux destinataires	folder.folderRecipientParties.folderAccessURL	string	L’URL que le destinataire peut utiliser pour accéder à l’enveloppe et la signer.
Mode de sécurité	folder.folderRecipientParties.securityMode	string	Mode de sécurité appliqué à cette enveloppe.
Commentaires	folder.folderRecipientParties.extraComments	string	Commentaires supplémentaires inclus dans l’enveloppe.
Autoriser la modification du nom	folder.folderRecipientParties.allowNameChange	boolean	Indique si le destinataire est autorisé à mettre à jour son nom.
Nom mis à jour	folder.folderRecipientParties.signerNameUpdated	boolean	Indique si le signataire a mis à jour son nom.
Niveau d’authentification du signataire	folder.folderRecipientParties.signerAuthenticationLevel	string	Niveau d’authentification requis pour le signataire.
Code d'accès	folder.folderRecipientParties.userDefinedAccessCode	string	Code d’accès personnalisé défini pour le signataire.
ID de signature	folder.folderRecipientParties.signatureId	string	Identificateur unique de la signature.
Rôle de destinataire	folder.folderRecipientParties.partyRole	string	Rôle attribué à ce destinataire dans le flux de travail de signature.
Champ d’entreprise	folder.folderRecipientParties.companyFieldValue	string	Valeur du champ nom de la société dans la signature.
Champ Titre	folder.folderRecipientParties.titleFieldValue	string	Valeur du champ de titre dans la signature.
Raison de la signature	folder.folderRecipientParties.reasonSigning	string	Raison pour laquelle le destinataire signe le document.
Champ de paiement ajouté	folder.folderRecipientParties.payFieldAdded	boolean	Indique si un champ de paiement a été ajouté.
Bénéficiaire	folder.folderRecipientParties.payee	boolean	Indique si ce destinataire est le bénéficiaire.
Paiement périodique	folder.folderRecipientParties.recurringFieldExist	boolean	Indique si un champ de paiement périodique existe.
Imprimer et signer terminé	folder.folderRecipientParties.printAndSignCompleted	boolean	Indique si le processus d’impression et de signature est terminé.
Payé	folder.folderRecipientParties.paid	boolean	Indique si le paiement a été effectué.
Signataire facultatif autorisé	folder.folderRecipientParties.allowOptionalSigner	boolean	Indique si ce destinataire est un signataire facultatif.
Signataires facultatifs	folder.folderRecipientParties.optionalSigners	array of integer	Liste des ID de partie de signataire facultatifs pour cette enveloppe.
URL de signature de l’auteur	folder.folderAccessURLForAuthor	string	URL que l’expéditeur peut utiliser pour accéder à l’enveloppe.
URL d’accès brouillon	folder.draftFolderAccessURL	string	URL utilisée pour accéder à la version brouillon de l’enveloppe.
Signature de salle de conseil	folder.boardRoomSign	boolean	Indique si le mode de signature de salle de carte est activé.
Inclure le logo	folder.includeLogo	boolean	Indique si le logo de l’entreprise est inclus dans les e-mails.
Couleur d’arrière-plan du bouton	folder.email_btnBgColor	string	Couleur d’arrière-plan du bouton e-mail.
Couleur de texte du bouton	folder.email_btnTxtColor	string	Couleur de texte du bouton e-mail.
Logo de messagerie	folder.emailTemplateLogo	string	URL du logo utilisée dans le modèle d’e-mail.
ID du modèle d’e-mail	folder.emailTemplateId	integer	Identificateur unique du modèle d’e-mail.
En-tête d’e-mail	folder.emailHeader	string	Texte d’en-tête utilisé dans les e-mails de notification.
Pied de page d’e-mail	folder.emailFooter	string	Texte du pied de page utilisé dans les e-mails de notification.
Purge planifiée	folder.purgeFlag	boolean	Indique si l’enveloppe est planifiée pour purger.
Date de début du vidage	folder.purgeStartDate	string	Date à partir de laquelle la purge est planifiée pour commencer.
Date de fin du vidage	folder.purgeEndDate	string	Date à laquelle la purge est prévue.
ID d’envoi en bloc	folder.bulkId	integer	Identificateur unique de l’opération d’envoi en bloc.
Appliquer l’ordre de signature	folder.enforceSignWorkflow	boolean	Indique si les destinataires doivent se connecter à la séquence définie.
Étape actuelle	folder.currentWorkflowStep	integer	Étape actuelle du flux de travail de signature.
Transaction Source	folder.transactionSource	string	Système source qui a lancé cette transaction.
Modifiable	folder.editable	boolean	Indique si l’élément est modifiable.
signature In-Person	folder.inPersonSignable	boolean	Indique si l’enveloppe peut être connectée à la personne.
Remplacer les rappels	folder.overrideAccountReminders	boolean	Indique si les paramètres de rappel au niveau du compte sont remplacés.
Remplacer la délégation	folder.overrideAccountRecipientDelegation	boolean	Indique si les paramètres de délégation au niveau du compte sont remplacés.
Autoriser la délégation	folder.allowRecipientsToDelegate	boolean	Indique si les destinataires sont autorisés à déléguer la signature.
ID	folder.envelopeId	integer	Identificateur unique de l’enveloppe.
Nom	folder.envelopeName	string	Nom de l’enveloppe.
ID d’origine	folder.envelopeOriginatorId	integer	Identificateur unique de l’utilisateur qui a créé l’enveloppe.
ID d’entreprise	folder.envelopeCompanyId	integer	Identificateur unique de l’entreprise propriétaire de l’enveloppe.
Date	folder.envelopeDate	integer	Date de création de l’enveloppe (horodatage Unix en millisecondes).
Date partagée	folder.envelopeSharedDate	integer	Date à laquelle l’enveloppe a été partagée (horodatage Unix en millisecondes).
État	folder.envelopeStatus	string	État actuel de l’enveloppe.
ID de contrat	folder.envelopeContractIds	array of integer	Liste des ID de contrat associés à cette enveloppe.
Autorisations du destinataire	folder.envelopePartyPermissions	array of object	Liste des autorisations de destinataire pour cette enveloppe.
ID du destinataire	folder.envelopePartyPermissions.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	folder.envelopePartyPermissions.partyDetails.partyId	integer	Identificateur unique du destinataire.
Prénom	folder.envelopePartyPermissions.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	folder.envelopePartyPermissions.partyDetails.lastName	string	Nom du destinataire.
adresse Email	folder.envelopePartyPermissions.partyDetails.emailId	string	Adresse e-mail du destinataire.
Texte de remplacement	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Indique si cette partie est un destinataire d’espace réservé.
Adresse	folder.envelopePartyPermissions.partyDetails.address	string	Adresse physique du destinataire.
Date de création	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Date de création de l’enregistrement (horodatage Unix en millisecondes).
Désactiver les e-mails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Indique si le destinataire a refusé les notifications par e-mail.
ID de destinataire unique	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Identificateur système unique pour ce destinataire.
Niveau d’authentification	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Méthode d’authentification requise pour ce destinataire.
Date de mise à jour du mot de passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Date de la dernière mise à jour du mot de passe.
État mis à jour du mot de passe	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Indique si le mot de passe a été mis à jour.
ID d’entreprise	folder.envelopePartyPermissions.partyDetails.companyId	integer	Identificateur unique de l’entreprise.
Rôle d’utilisateur	folder.envelopePartyPermissions.partyDetails.userRole	string	Rôle attribué à l’utilisateur.
Département	folder.envelopePartyPermissions.partyDetails.department	string	Service auquel appartient l’utilisateur.
Titre	folder.envelopePartyPermissions.partyDetails.title	string	poste occupé par l'utilisateur.
Activé	folder.envelopePartyPermissions.partyDetails.active	boolean	Indique si l’utilisateur ou l’enregistrement est actif.
Paramètres régionaux	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Paramètre de paramètres régionaux pour l’utilisateur.
Partager avec Dept	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Indique si les enveloppes sont partagées entre le service.
Code de numérotation	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Numéro de téléphone mobile.
Filtre d’état	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Filtre pour l’état du document.
Filtre de date	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Filtre pour la date du document.
Accès aux champs sécurisés	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Indique si l’utilisateur a accès aux champs sécurisés.
Développer la barre latérale	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Indique si la barre latérale est développée par défaut.
Adv. Validation par e-mail	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Indique si la validation avancée des e-mails est activée.
ID du gestionnaire	folder.envelopePartyPermissions.partyDetails.managerId	string	Identificateur unique du gestionnaire de l’utilisateur.
Nombre de connexions	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Nombre de fois où l’utilisateur s’est connecté.
E-mail de réinitialisation de mot de passe	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Indique si un e-mail de réinitialisation de mot de passe doit être envoyé.
ID de service	folder.envelopePartyPermissions.partyDetails.departmentId	string	Identificateur unique du service.
Société principale	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Société principale associée à l’utilisateur.
Type d’appareil	folder.envelopePartyPermissions.partyDetails.deviceType	string	Type d’appareil utilisé.
Jeton d’appareil	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Jeton de notification Push pour l’appareil.
Description du sous-traitant	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Description du sous-traitant ou du signataire externe.
Organisation sous-traitante	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Nom de l’organisation du sous-traitant ou du signataire externe.
Date d’ajout du sous-traitant	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Date à laquelle le sous-traitant a été ajouté (horodatage Unix en millisecondes).
Source	folder.envelopePartyPermissions.partyDetails.source	string	Système source à partir duquel le signataire externe a été ajouté.
Code de numérotation	folder.envelopePartyPermissions.dialingCode	string	Code de numérotation international pour le numéro de téléphone.
Numéro de portable	folder.envelopePartyPermissions.mobileNumber	string	Numéro de téléphone mobile.
Type de signature	folder.envelopePartyPermissions.signerSignatureType	string	Type de signature que le signataire utilisera.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Autorisations accordées à cette partie pour le contrat.
Ordre de signature	folder.envelopePartyPermissions.partySequence	integer	Numéro de séquence de commande de signature pour ce destinataire.
Séquence de flux de travail	folder.envelopePartyPermissions.workflowSignSequence	integer	Numéro de séquence de signature de flux de travail.
ID d’enveloppe	folder.envelopePartyPermissions.envelopeId	integer	Identificateur unique de l’enveloppe.
ID d’entreprise du destinataire	folder.envelopePartyPermissions.partyCompanyId	integer	Identificateur unique de l’entreprise associée à ce destinataire.
Mode de partage	folder.envelopePartyPermissions.sharingMode	string	Mode de partage pour cette enveloppe.
URL d’accès aux destinataires	folder.envelopePartyPermissions.folderAccessURL	string	L’URL que le destinataire peut utiliser pour accéder à l’enveloppe et la signer.
Mode de sécurité	folder.envelopePartyPermissions.securityMode	string	Mode de sécurité appliqué à cette enveloppe.
Commentaires	folder.envelopePartyPermissions.extraComments	string	Commentaires supplémentaires inclus dans l’enveloppe.
Autoriser la modification du nom	folder.envelopePartyPermissions.allowNameChange	boolean	Indique si le destinataire est autorisé à mettre à jour son nom.
Nom mis à jour	folder.envelopePartyPermissions.signerNameUpdated	boolean	Indique si le signataire a mis à jour son nom.
Niveau d’authentification du signataire	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Niveau d’authentification requis pour le signataire.
Code d'accès	folder.envelopePartyPermissions.userDefinedAccessCode	string	Code d’accès personnalisé défini pour le signataire.
ID de signature	folder.envelopePartyPermissions.signatureId	string	Identificateur unique de la signature.
Rôle de destinataire	folder.envelopePartyPermissions.partyRole	string	Rôle attribué à ce destinataire dans le flux de travail de signature.
Champ d’entreprise	folder.envelopePartyPermissions.companyFieldValue	string	Valeur du champ nom de la société dans la signature.
Champ Titre	folder.envelopePartyPermissions.titleFieldValue	string	Valeur du champ de titre dans la signature.
Raison de la signature	folder.envelopePartyPermissions.reasonSigning	string	Raison pour laquelle le destinataire signe le document.
Champ de paiement ajouté	folder.envelopePartyPermissions.payFieldAdded	boolean	Indique si un champ de paiement a été ajouté.
Bénéficiaire	folder.envelopePartyPermissions.payee	boolean	Indique si ce destinataire est le bénéficiaire.
Paiement périodique	folder.envelopePartyPermissions.recurringFieldExist	boolean	Indique si un champ de paiement périodique existe.
Imprimer et signer terminé	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Indique si le processus d’impression et de signature est terminé.
Payé	folder.envelopePartyPermissions.paid	boolean	Indique si le paiement a été effectué.
Niveau d’authentification	folder.envelopeAuthenticationLevel	string	Niveau d’authentification requis pour l’enveloppe.
Bloc du signataire unique	folder.allowSingleSignerInBulk	boolean	Indique si un seul signataire est autorisé en mode d’envoi en bloc.
nommage File-Based	folder.folderNameBasedOnFileNaming	boolean	Indique si le nom du dossier est basé sur le nom du fichier.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Indique si le nom du document est basé sur le nom du fichier.
Cert File-Based Name	folder.certificateNameBasedOnFileNaming	boolean	Indique si le nom du certificat est basé sur le nom de fichier.
Nommage de fichier pre-Exec	folder.enableFileNamingBeforeExecution	boolean	Indique si le nommage de fichier est activé avant l’exécution du document.
Payee ajouté	folder.payeeAddedd	boolean	Indique si un bénéficiaire a été ajouté.
Self-Signing activé	folder.selfSignerEnabled	boolean	Indique si le mode de signature automatique est activé.
Non autorisé	folder.notaryEnabled	boolean	Indique si la signature notarié est activée.
Visibilité limitée	folder.limitedVisibilityFlag	boolean	Indique si une visibilité limitée est activée pour cette enveloppe.
Visibilité post-signature	folder.postSigningVisibility	boolean	Indique si la visibilité post-signature est activée.
Signature humide	folder.wetSignatureEnabled	boolean	Indique si les signatures humides sont activées.
Fusion activée	folder.mergeEnabled	boolean	Indique si la fusion de documents est activée.
Sessions de signature incorporées	embeddedSigningSessions	array of object	Liste des sessions de signature incorporées, une par destinataire. Uniquement présent lorsque createEmbeddedSigningSession a la valeur true.
E-mail du signataire	embeddedSigningSessions.emailIdOfSigner	string	Adresse e-mail du destinataire pour cette session de signature incorporée.
Jeton de signature	embeddedSigningSessions.embeddedToken	string	Jeton unique pour la session de signature incorporée de ce destinataire.
URL de session de signature	embeddedSigningSessions.embeddedSessionURL	string	URL à ouvrir ou incorporer pour ce destinataire pour signer le document.
Jeton d’envoi incorporé	embeddedToken	string	Jeton de la session d’envoi incorporée. Uniquement présent lorsque createEmbeddedSendingSession a la valeur true.
URL de session d’envoi	embeddedSessionURL	string	URL permettant d’ouvrir ou d’incorporer l’auteur de l’enveloppe pour préparer et envoyer l’enveloppe. Uniquement présent lorsque createEmbeddedSendingSession a la valeur true.
Result	result	string	Résultat de l'opération.
Message	message	string	Message décrivant le résultat de l’opération.

Créer une enveloppe à partir d’un modèle

ID d’opération :

CreateEnvelopefromTemplate

Crée et envoie une enveloppe à l’aide d’un modèle existant. Les détails du destinataire peuvent être personnalisés.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom de l’enveloppe	folderName		string	Nom du ou des documents. Si cette valeur n’est pas fournie, le ou les noms de dossier du ou des documents sont conservés de la même façon que le ou les noms du ou des modèles.
ID de modèle	templateIds	True	array of integer	Tableau d’ID de modèle que vous souhaitez utiliser pour créer les documents de ce dossier.
Champs	fields		object	Vous pouvez transmettre les valeurs de champ utilisées dans les modèles pour les remplir dans les documents créés à partir du modèle. FIELD_NAME est le nom du champ utilisé dans le modèle. FIELD_VALUE est la valeur du champ de document.
Validation avancée des e-mails	allowAdvancedEmailValidation		boolean	Validez les adresses e-mail des parties lorsqu’elles sont définies sur true.
Prénom	firstName	True	string	Prénom du destinataire.
Nom de famille	lastName	True	string	Nom du destinataire.
adresse Email	emailId	True	string	Adresse e-mail du destinataire.
permissions	permission	True	string
Série	sequence	True	integer	Utilisez ce champ pour affecter un numéro de séquence à un destinataire dans la liste des parties du destinataire. Utilisez des numéros de séquence uniques pour chaque partie commençant par 1 comme 1,2,3,4.... Si une seule personne apparaît plusieurs fois dans le flux de travail de signature, attribuez une séquence différente chaque fois que le destinataire est répété.
signerAuthLevels	signerAuthLevel		string	Niveau d’authentification utilisé par un signataire à des fins de vérification
Espace réservé	isPlaceholder		boolean	Utilisez ce champ pour lancer la partie est un espace réservé. Remarque : 1. firstName, lastName, la valeur du paramètre emailId doit être vide de cette partie. 2. Pour ajouter l’espace réservé, un destinataire doit être réquéré avec l’autorisation « PARTY_ASSIGNER ».
Rôle de destinataire	partyRole		string	Utilisez ce champ pour attribuer un rôle d’espace réservé.
Autoriser la modification du nom	allowNameChange		string	La valeur peut être true ou false Utiliser ce paramètre pour autoriser le signataire à mettre à jour le prénom et le nom avant de terminer le processus de signature.
Séquence de flux de travail	workflowSequence		integer	Affectez un numéro de séquence de flux de travail à ce destinataire. Lorsque la séquence de connexion est activée, les destinataires reçoivent leur invitation de signature dans l’ordre de séquence croissant.
ID d’e-mail de l’hôte	hostEmailId		string	Adresse e-mail de In-Person Administrateur.
Code d'accès	userDefinedAccessCode		string	Le paramètre contient le code d’accès lorsque la valeur « signerAuthLevel » est définie comme « Code d’accès défini par l’utilisateur » pour l’authentification. Remarque : 1. Les codes ne respectent pas la casse. 2. Le système n’envoie pas ce code de sorte que vous devez partager ce code directement avec le signataire. 3. Le code d’accès peut contenir des alphabets, des nombres et les caractères spéciaux suivants : @,& ;{,},%,(,),~,|,!,+,^.
Groupe d’e-mails tiers	partyIsEmailGroup		boolean	Utilisez ce paramètre lors de la création d’une partie en bloc. Note: Si ce paramètre a la valeur true, firstName, lastName et emailId de cette partie sont ignorés.
ID du groupe d’e-mails	emailGroupId		integer	Transmettez l’e-mail à l’ID de groupe que vous souhaitez utiliser pour créer en bloc.
Bloc du signataire unique	allowSingleSignerInBulk		boolean	Utilisez ce paramètre pour autoriser une seule personne à se connecter au groupe de messagerie.
Code de numérotation	dialingCode		string	Utilisez ce champ pour affecter des codes de numérotation de pays sont des préfixes de numéro mobile à un destinataire dans la liste des parties de destinataires.
Numéro de portable	mobileNumber		string	Utilisez ce champ pour affecter un numéro mobile à un destinataire dans la liste des parties de destinataires.
Mot de passe de l’enveloppe	folderPassword		string	Ce mot de passe est requis par le signataire/auteur pour ouvrir le document signé numériquement. Si le paramètre est conservé vide, aucun mot de passe n’est requis pour ouvrir le document signé numériquement.
Séquence de connexion	signInSequence		boolean	Ce champ est utilisé pour déterminer si les destinataires signent les documents d’enveloppe dans une séquence. Si la valeur est false, tous les destinataires reçoivent simultanément l’e-mail d’invitation. Lorsque la valeur est true, chaque destinataire reçoit l’e-mail d’invitation successivement une fois que le destinataire précédent a terminé la tâche requise, comme la signature des documents ou le remplissage des champs, etc.
Activer en personne	inPersonEnable		boolean	Ce champ est utilisé pour lancer le processus de signature en personne qui peut être facilement effectué sur n’importe quel appareil en quelques minutes et évite les signatures basées sur les e-mails si nécessaire. Si la valeur est false, tous les destinataires reçoivent simultanément l’e-mail d’invitation. Lorsque la valeur est true, l’administrateur en personne reçoit un e-mail d’invitation pour lancer le processus de signature du signataire.
Envoyer maintenant	sendNow		boolean	Lorsque cette option est activée, Foxit eSign envoie immédiatement un lien de signature unique à l’adresse e-mail de chaque destinataire. Désactivez cette option pour enregistrer l’enveloppe en tant que brouillon à la place.
URL de réussite de signe tous les parties	signSuccessUrlAllParties		boolean	Si la valeur est true, le signataire est redirigé vers l’URL fournie dans le signSuccessUrl après la signature réussie. Cela s’applique uniquement lorsque sendNow a la valeur true.
Créer une session d’envoi incorporée	createEmbeddedSendingSession		boolean	Si la valeur est true, elle génère une URL incorporée pour ouvrir la vue de préparation du document de Foxit eSign.
Corriger les parties de destinataires	fixRecipientParties		boolean	Si la valeur est true, la vue d’envoi incorporée ne peut pas modifier les parties de l’enveloppe qui sont déjà ajoutées dans le cadre de cette demande.
Corriger les documents	fixDocuments		boolean	Si la valeur est true, l’envoi incorporé ne peut pas modifier les documents de l’enveloppe qui sont déjà ajoutés dans le cadre de cette demande.
Url d’envoi de réussite	sendSuccessUrl		string	Entrez l’URL absolue de la page d’accueil vers laquelle le signataire sera redirigé après l’envoi du dossier dans la vue d’envoi incorporée.
URL d’erreur d’envoi	sendErrorUrl		string	Entrez l’URL absolue de la page d’accueil vers laquelle le signataire sera redirigé si l’erreur se produit lors de l’envoi du dossier dans la vue d’envoi incorporée.
Masquer l’option Sélectionner un signataire	hideSignerSelectOption		boolean	Si la valeur est true, elle masque la zone d’entrée « Nom/e-mail du signataire existant » sur les parties de destinataires dans une session d’envoi incorporée.
Masquer les actions du signataire	hideSignerActions		boolean	Si la valeur est true, le signataire masque les actions « modifier », « modifier » et « supprimer » sur les parties des destinataires dans une session d’envoi incorporée.
Masquer le nom de l’expéditeur	hideSenderName		boolean	Si la valeur est true, elle masque le nom de l’expéditeur sur les parties du destinataire dans une session d’envoi incorporée.
Bouton Masquer l’envoi	hideSendButton		boolean	Si la valeur est true, elle masque le bouton Envoyer dans la session d’envoi incorporée.
Masquer le nom du dossier	hideFolderName		boolean	Si la valeur est true, elle masque le nom du dossier dans la navigation dans les deux sessions incorporées.
Masquer le nom des documents	hideDocumentsName		boolean	Si la valeur est true, elle masque le nom du document dans les deux sessions incorporées.
Bouton Masquer l’ajout de moi	hideAddMeButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter moi » sur les parties du destinataire dans une session d’envoi incorporée.
Masquer le bouton Ajouter un nouveau	hideAddNewButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter nouveau » sur les parties des destinataires dans une session d’envoi incorporée.
Bouton Masquer l’ajout d’un groupe	hideAddGroupButton		boolean	Si la valeur est true, elle masque le bouton « Ajouter un groupe » sur les parties des destinataires dans une session d’envoi incorporée.
Créer une session de signature incorporée	createEmbeddedSigningSession		boolean	Le jeton de session de signature est généré sans envoyer d’e-mails aux destinataires.
Créer une session de signature incorporée pour toutes les parties	createEmbeddedSigningSessionForAllParties		boolean	Si la valeur est true, une URL de signature incorporée est générée pour chaque destinataire de l’enveloppe. Si la valeur est false, seuls les destinataires répertoriés dans les ID d’e-mail des signataires incorporés reçoivent une session incorporée.
ID de messagerie des signataires incorporés	embeddedSignersEmailIds		array of string	Tableau d’ID d’e-mail des destinataires pour lesquels une session de signature incorporée doit être créée. ID d’e-mail des parties destinataires ajoutées dans la liste des parties.
URL de réussite de signe	signSuccessUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés vers une fois la connexion réussie dans la vue de signature incorporée.
URL de refus de signe	signDeclineUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés si vous refusez de vous connecter à la vue de signature incorporée.
Signer une URL ultérieure	signLaterUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés si vous choisissez de vous connecter ultérieurement en mode de signature incorporé.
URL d’erreur de signe	signErrorUrl		string	Entrez l’URL absolue pour les signataires qui seront redirigés vers si une erreur se produit lors de la signature du document en mode de signature incorporé.
Masquer le btn de champ obligatoire suivant	hideNextRequiredFieldBtn		boolean	Si la valeur est true, masque le bouton de navigation qui déplace les signataires vers le champ obligatoire suivant.
Couleur de thème	themeColor		string	Entrez la valeur CSS pour définir la couleur du thème.
Masquer le refus de signer	hideDeclineToSign		boolean	Si la valeur est true, masque l’option Refuser de se connecter sur l’écran de signature.
Masquer plus d’action	hideMoreAction		boolean	Si la valeur est true, masque le bouton Autres actions dans la session d’envoi et de signature. N’a aucun effet lorsque Send Now est vrai.
Option Masquer les parties	hideAddPartiesOption		boolean	Si la valeur est true, masque l’option permettant d’ajouter des parties en mode Brouillon et Création de modèle.
Expiration de la session	sessionExpire		boolean	Définissez la valeur true pour lancer l’expiration de la session de signature incorporée.
Expiration	expiry		integer	Obligatoire si sessionExpire a la valeur true. Entrez la durée en millisecondes de l’expiration de la session de signature incorporée.
Adresse e-mail de l’expéditeur	senderEmail		string	entrez l’e-mail d’un autre utilisateur dans votre compte qui sera utilisé pour envoyer ce ou ces documents au destinataire.
Autoriser l’envoi maintenant et la session de signature incorporée	allowSendNowAndEmbeddedSigningSession		boolean	Si la valeur est true, Foxit eSign envoie un e-mail d’invitation de signature à chaque destinataire et génère également un lien de signature incorporé pour les destinataires dont l’e-mail est inclus dans l’e-mail du signataire incorporé. L’e-mail et le lien incorporé sont actifs simultanément.
Activer pas à pas	enableStepByStep		boolean	Pour activer l’action étape par étape dans la session d’envoi incorporée.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si l’opération a réussi (par exemple, « réussite »).
Message	message	string	Description du résultat de l’opération.
Sessions de signature incorporées	embeddedSigningSessions	array of object	Liste des sessions de signature incorporées, une par destinataire. Uniquement présent lorsque createEmbeddedSigningSession a la valeur true.
E-mail du signataire	embeddedSigningSessions.emailIdOfSigner	string	Adresse e-mail du destinataire pour cette session de signature incorporée.
Jeton de signature	embeddedSigningSessions.embeddedToken	string	Jeton unique pour la session de signature incorporée de ce destinataire.
URL de session de signature	embeddedSigningSessions.embeddedSessionURL	string	URL à ouvrir ou incorporer pour ce destinataire pour signer le document.
Jeton d’envoi incorporé	embeddedToken	string	Jeton de la session d’envoi incorporée. Uniquement présent lorsque createEmbeddedSendingSession a la valeur true.
URL de session d’envoi	embeddedSessionURL	string	URL permettant d’ouvrir ou d’incorporer l’auteur de l’enveloppe pour préparer et envoyer l’enveloppe. Uniquement présent lorsque createEmbeddedSendingSession a la valeur true.
ID	folder.folderId	integer	ID unique de l’enveloppe créée. Utilisez-la pour référencer l’enveloppe dans les actions suivantes.
Nom	folder.folderName	string	Nom de l’enveloppe.
Nom personnalisé	folder.folderCustomName	string	Nom personnalisé affecté à l’enveloppe.
Mot de passe	folder.folderPassword	string	Mot de passe défini pour l’enveloppe, le cas échéant.
ID d’auteur	folder.folderAuthorId	integer	ID unique de l’utilisateur qui a créé l’enveloppe.
Prénom de l’auteur	folder.folderAuthorFirstName	string	Prénom du créateur de l’enveloppe.
Nom de l’auteur	folder.folderAuthorLastName	string	Nom du créateur de l’enveloppe.
Email d’auteur	folder.folderAuthorEmail	string	Adresse e-mail du créateur de l’enveloppe.
Rôle d’auteur	folder.folderAuthorRole	string	Rôle de compte du créateur d’enveloppe.
ID d’entreprise	folder.folderCompanyId	integer	ID unique de l’entreprise auquel appartient l’enveloppe.
Date de création	folder.folderCreationDate	integer	Date et heure de création de l’enveloppe, en millisecondes Unix.
Date d’envoi	folder.folderSentDate	integer	Date et heure auxquelles l’enveloppe a été envoyée aux destinataires, en millisecondes Unix.
État	folder.folderStatus	string	État actuel de l’enveloppe (par exemple, SHARED, EXECUTED, DRAFT, CANCELLED).
Champ personnalisé 1	folder.custom_field1	string	Valeur du champ personnalisé 1 défini sur l’enveloppe.
Champ personnalisé 2	folder.custom_field2	string	Valeur du champ personnalisé 2 défini sur l’enveloppe.
Metadata	folder.metadata	string	Toutes les métadonnées supplémentaires associées à l’enveloppe.
ID de document	folder.folderDocumentIds	array of integer	Liste des ID de document inclus dans cette enveloppe.
Documents	folder.documentsList	array of object	Détails de chaque document inclus dans l’enveloppe.
ID du document	folder.documentsList.documentId	integer	Identificateur unique du document.
ID de contrat	folder.documentsList.contractId	integer	Identificateur unique du contrat associé à ce document.
ID d’entreprise	folder.documentsList.companyId	integer	ID unique de l’entreprise à laquelle appartient ce document.
Créée par	folder.documentsList.contractCreatedBy	integer	ID d’utilisateur de la personne qui a créé le contrat.
Date de création	folder.documentsList.contractCreatedOn	string	Date de création du contrat.
Type de contrat	folder.documentsList.contractType	string	Type du contrat.
État du document	folder.documentsList.contractStatus	string	État de signature actuel du document (par exemple, WAITING_FOR_SIGNATURE, EXECUTED).
Modifiable	folder.documentsList.editable	boolean	Indique si le document peut être modifié.
ID de version	folder.documentsList.contractVersionId	integer	ID unique de la version actuelle du document.
Nom de la version	folder.documentsList.contractVersionName	string	Nom de la version actuelle du document.
Version Description	folder.documentsList.contractVersionDesc	string	Description de la version actuelle du document.
Version créée par	folder.documentsList.versionCreatedby	integer	ID utilisateur de la personne qui a créé cette version de document.
Version créée sur	folder.documentsList.versionCreatedOn	string	Date de création de cette version de document.
Numéro de version	folder.documentsList.contractVersionNumber	integer	Numéro de version du document.
Transaction Source	folder.documentsList.contractTransactionSource	string	Source de la transaction de contrat.
Destinataires	folder.folderRecipientParties	array of object	Liste des destinataires de cette enveloppe, y compris leurs liens de signature individuels.
ID du destinataire	folder.folderRecipientParties.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	folder.folderRecipientParties.partyDetails.partyId	integer	Identificateur unique du destinataire.
Prénom	folder.folderRecipientParties.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	folder.folderRecipientParties.partyDetails.lastName	string	Nom du destinataire.
Courrier électronique	folder.folderRecipientParties.partyDetails.emailId	string	Adresse e-mail du destinataire.
Espace réservé	folder.folderRecipientParties.partyDetails.placeholder	boolean	Indique si ce destinataire est un espace réservé.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Adresse du destinataire.
Date de création du compte	folder.folderRecipientParties.partyDetails.dateCreated	integer	Date de création du compte du destinataire, en millisecondes Unix.
Désactiver les e-mails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indique si le destinataire a refusé les notifications par e-mail.
ID de partie unique	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificateur de chaîne unique pour le destinataire.
Niveau d’authentification	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Niveau d’authentification requis pour ce destinataire.
ID d’entreprise	folder.folderRecipientParties.partyDetails.companyId	integer	ID de l’entreprise à laquelle appartient le destinataire.
Rôle d’utilisateur	folder.folderRecipientParties.partyDetails.userRole	string	Rôle du destinataire au sein de son organisation.
Département	folder.folderRecipientParties.partyDetails.department	string	Service du destinataire.
Titre	folder.folderRecipientParties.partyDetails.title	string	Titre du travail du destinataire.
Activé	folder.folderRecipientParties.partyDetails.active	boolean	Indique si le compte du destinataire est actif.
Code de numérotation	folder.folderRecipientParties.partyDetails.dialingCode	string	Code de numérotation du pays pour le numéro de téléphone du destinataire.
Numéro de portable	folder.folderRecipientParties.partyDetails.mobileNumber	string	Numéro de téléphone mobile du destinataire.
Description du sous-traitant	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Description du sous-traitant, le cas échéant.
Organisation sous-traitante	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Nom de l’organisation du sous-traitant, le cas échéant.
Date d’ajout du sous-traitant	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Date à laquelle le sous-traitant a été ajouté, en millisecondes Unix.
Source	folder.folderRecipientParties.partyDetails.source	string	Source par laquelle le destinataire a été ajouté.
Code de numérotation	folder.folderRecipientParties.dialingCode	string	Code de numérotation du pays pour le numéro mobile du destinataire.
Numéro de portable	folder.folderRecipientParties.mobileNumber	string	Numéro de téléphone mobile du destinataire.
Type de signature	folder.folderRecipientParties.signerSignatureType	string	Type de signature autorisé pour ce destinataire.
Permissions	folder.folderRecipientParties.contractPermissions	string	Autorisations de signature accordées à ce destinataire (par exemple, FILL_FIELDS_AND_SIGN).
Ordre de signature	folder.folderRecipientParties.partySequence	integer	Position de ce destinataire dans l’ordre de signature.
Séquence de flux de travail	folder.folderRecipientParties.workflowSignSequence	integer	Numéro de séquence de signature de flux de travail pour ce destinataire.
ID d’enveloppe	folder.folderRecipientParties.envelopeId	integer	ID de l’enveloppe à laquelle appartient ce destinataire.
ID d’entreprise de partie	folder.folderRecipientParties.partyCompanyId	integer	ID de l’entreprise à laquelle appartient ce destinataire.
Mode de partage	folder.folderRecipientParties.sharingMode	string	Méthode utilisée pour partager le document avec ce destinataire (par exemple, e-mail).
URL de signature	folder.folderRecipientParties.folderAccessURL	string	URL de signature unique pour ce destinataire. Utilisez-le pour partager directement le lien de signature.
Mode de sécurité	folder.folderRecipientParties.securityMode	string	Mode de sécurité appliqué à l’accès de ce destinataire.
Commentaires supplémentaires	folder.folderRecipientParties.extraComments	string	Tous les commentaires supplémentaires inclus dans l’invitation de signature pour ce destinataire.
Autoriser la modification du nom	folder.folderRecipientParties.allowNameChange	boolean	Indique si le destinataire est autorisé à modifier son nom avant la signature.
Nom mis à jour	folder.folderRecipientParties.signerNameUpdated	boolean	Indique si le destinataire a mis à jour son nom complet.
Niveau d’authentification	folder.folderRecipientParties.signerAuthenticationLevel	string	Méthode d’authentification requise pour que ce destinataire accède au document.
Code d'accès	folder.folderRecipientParties.userDefinedAccessCode	string	Code d’accès personnalisé requis pour que ce destinataire ouvre le document.
ID de signature	folder.folderRecipientParties.signatureId	string	ID de la signature enregistrée utilisée par ce destinataire.
Rôle de destinataire	folder.folderRecipientParties.partyRole	string	Rôle attribué à ce destinataire dans l’enveloppe.
Valeur du champ d’entreprise	folder.folderRecipientParties.companyFieldValue	string	Valeur du champ d’entreprise préremplie pour ce destinataire.
Valeur du champ Titre	folder.folderRecipientParties.titleFieldValue	string	Valeur de champ de titre préremplie pour ce destinataire.
Raison de la signature	folder.folderRecipientParties.reasonSigning	string	Raison de la signature fournie par ce destinataire.
Champ de paiement ajouté	folder.folderRecipientParties.payFieldAdded	boolean	Indique si un champ de paiement a été ajouté pour ce destinataire.
Is Payee	folder.folderRecipientParties.payee	boolean	Indique si ce destinataire est un bénéficiaire.
Champ périodique existe	folder.folderRecipientParties.recurringFieldExist	boolean	Indique si les champs de paiement récurrents existent pour ce destinataire.
Imprimer et signer terminé	folder.folderRecipientParties.printAndSignCompleted	boolean	Indique si le destinataire a terminé une action d’impression et de signature.
Autoriser le signataire facultatif	folder.folderRecipientParties.allowOptionalSigner	boolean	Indique si ce destinataire peut être ignoré en tant que signataire facultatif.
Signataires facultatifs	folder.folderRecipientParties.optionalSigners	string	Liste des signataires facultatifs associés à ce destinataire, le cas échéant.
Payé	folder.folderRecipientParties.paid	boolean	Indique si ce destinataire a terminé le paiement.
URL d’accès à l’auteur	folder.folderAccessURLForAuthor	string	URL de l’auteur de l’enveloppe pour accéder au document.
URL d’accès brouillon	folder.draftFolderAccessURL	string	URL permettant d’accéder à l’enveloppe pendant qu’elle est en état brouillon.
Signe de salle de bord	folder.boardRoomSign	boolean	Indique si la signature de salle de carte est activée pour cette enveloppe.
Inclure le logo	folder.includeLogo	boolean	Indique si le logo de l’entreprise est inclus dans les notifications par e-mail.
Couleur du bouton e-mail	folder.email_btnBgColor	string	Couleur d’arrière-plan du bouton d’action dans l’e-mail de signature.
Couleur de texte du bouton e-mail	folder.email_btnTxtColor	string	Couleur de texte du bouton d’action dans l’e-mail de signature.
Logo de messagerie	folder.emailTemplateLogo	string	Image de logo utilisée dans le modèle d’e-mail.
ID du modèle d’e-mail	folder.emailTemplateId	integer	ID du modèle d’e-mail utilisé pour les notifications de signature.
En-tête d’e-mail	folder.emailHeader	string	Texte d’en-tête personnalisé dans les e-mails de notification de signature.
Pied de page d’e-mail	folder.emailFooter	string	Texte du pied de page personnalisé dans les e-mails de notification de signature.
Purge planifiée	folder.purgeFlag	boolean	Indique si cette enveloppe est planifiée pour le purge automatique.
Date de début du vidage	folder.purgeStartDate	string	Date à partir de laquelle commence la période de vidage.
Date de fin du vidage	folder.purgeEndDate	string	Date à laquelle l’enveloppe sera vidée.
ID en bloc	folder.bulkId	integer	L’ID du lot d’envoi en bloc auquel appartient cette enveloppe, le cas échéant.
Appliquer l’ordre de signature	folder.enforceSignWorkflow	boolean	Indique si les destinataires doivent se connecter à l’ordre spécifié.
Étape actuelle du flux de travail	folder.currentWorkflowStep	integer	Étape actuelle du flux de travail de signature.
Transaction Source	folder.transactionSource	string	Source qui a lancé cette transaction d’enveloppe.
Modifiable	folder.editable	boolean	Indique si l’enveloppe peut toujours être modifiée.
signature In-Person	folder.inPersonSignable	boolean	Indique si l’enveloppe peut être connectée à la personne.
Remplacer les rappels	folder.overrideAccountReminders	boolean	Indique si les paramètres de rappel au niveau du compte sont remplacés pour cette enveloppe.
Remplacer la délégation	folder.overrideAccountRecipientDelegation	boolean	Indique si les paramètres de délégation au niveau du compte sont remplacés pour cette enveloppe.
Autoriser la délégation	folder.allowRecipientsToDelegate	boolean	Indique si les destinataires sont autorisés à déléguer leur signature à une autre personne.
ID	folder.envelopeId	integer	ID unique de l’enveloppe. Même valeur que l’ID d’enveloppe (folderId).
Nom	folder.envelopeName	string	Nom de l’enveloppe. Même valeur que le nom de l’enveloppe (folderName).
ID d’origine	folder.envelopeOriginatorId	integer	ID utilisateur de la personne qui a créé l’enveloppe.
ID d’entreprise	folder.envelopeCompanyId	integer	ID de l’entreprise à laquelle appartient l’enveloppe.
Date	folder.envelopeDate	integer	Date et heure de création de l’enveloppe, en millisecondes Unix.
Date partagée	folder.envelopeSharedDate	integer	Date et heure de partage de l’enveloppe avec les destinataires, en millisecondes Unix.
État	folder.envelopeStatus	string	État actuel de l’enveloppe. Même valeur que l’état de l’enveloppe (folderStatus).
ID de contrat	folder.envelopeContractIds	array of integer	Liste des ID de contrat associés à cette enveloppe.
Autorisations de partie	folder.envelopePartyPermissions	array of object	Liste des destinataires et de leurs autorisations de signature. Même structure que Recipients.
ID du destinataire	folder.envelopePartyPermissions.partyId	integer	Identificateur unique du destinataire.
URL de signature	folder.envelopePartyPermissions.folderAccessURL	string	URL de signature unique pour ce destinataire.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Autorisations de signature pour ce destinataire.
Ordre de signature	folder.envelopePartyPermissions.partySequence	integer	Position de ce destinataire dans l’ordre de signature.
Niveau d’authentification	folder.envelopeAuthenticationLevel	string	Niveau d’authentification appliqué à l’enveloppe entière.
Autoriser le seul signataire en bloc	folder.allowSingleSignerInBulk	boolean	Indique si un seul signataire est autorisé en mode d’envoi en bloc.
Nom basé sur un fichier	folder.folderNameBasedOnFileNaming	boolean	Indique si le nom de l’enveloppe est dérivé du nom de fichier.
Nom du document basé sur un fichier	folder.documentNameBasedOnFileNaming	boolean	Indique si le nom du document est dérivé du nom de fichier.
Nom du certificat basé sur le fichier	folder.certificateNameBasedOnFileNaming	boolean	Indique si le nom du certificat est dérivé du nom de fichier.
Activer le nommage de fichier	folder.enableFileNamingBeforeExecution	boolean	Indique si le nommage de fichier est invité avant l’envoi de l’enveloppe.
Payee ajouté	folder.payeeAddedd	boolean	Indique si un bénéficiaire a été ajouté à l’enveloppe.
Auto-signataire	folder.selfSignerEnabled	boolean	Indique si l’expéditeur est également un signataire sur cette enveloppe.
Non autorisé	folder.notaryEnabled	boolean	Indique si la notarisation est activée pour cette enveloppe.
Visibilité limitée	folder.limitedVisibilityFlag	boolean	Indique si la visibilité limitée du document est activée.
Visibilité post-signature	folder.postSigningVisibility	boolean	Indique si les destinataires peuvent afficher le document signé après l’achèvement.
Signature humide activée	folder.wetSignatureEnabled	boolean	Indique si les signatures humides (manuscrites) sont activées pour cette enveloppe.
Fusion activée	folder.mergeEnabled	boolean	Indique si la fusion de documents est activée pour cette enveloppe.

Déplacer des enveloppes vers la Corbeille

ID d’opération :

MoveEnvelopestoRecycleBin

Déplace une ou plusieurs enveloppes vers la corbeille. Les enveloppes de la corbeille ne sont pas supprimées définitivement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de dossier	folderIds	True	array of integer	Tableau d’ID d’enveloppe à agir.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si l’opération a réussi.

Envoyer un rappel de signature

ID d’opération :

SendSignatureReminder

Envoie une notification de rappel aux destinataires en attente d’une enveloppe, en les invitant à terminer la signature.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’enveloppe	folderId	True	integer	ID de l’enveloppe.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
ID d’enveloppe	reminder sent	integer	ID de l’enveloppe pour laquelle le rappel a été envoyé.

Obtenir des modèles par ID de modèle

ID d’opération :

GetTemplatesbyTemplateIds

Récupère les détails d’un ou de plusieurs modèles par leurs ID.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de modèle	templateIds	True	array of integer	Tableau d’ID de modèle à récupérer.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
Nombre total de modèles	total_templates	integer	Nombre total de modèles retournés.
Liste de modèles	templateIdList	object	Carte des données de modèle clé par ID de modèle. Chaque entrée contient les détails du modèle et ses champs.

Obtenir la liste de tous les modèles

ID d’opération :

GetalistofallTemplates

Retourne la liste de tous les modèles disponibles dans votre compte.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
Nombre total de modèles	total_templates	integer	Nombre total de modèles dans votre compte.
Liste des modèles	templatesList	array of object	Liste de tous les modèles disponibles dans le compte.
ID de modèle	templatesList.templateId	integer	Identificateur unique du modèle. Utilisez cet ID avec Créer une enveloppe à partir d’un modèle pour envoyer le modèle pour la signature.
Nom du modèle	templatesList.templateName	string	Nom du modèle.
Description du modèle	templatesList.templateDesc	string	Description du modèle.
Type de modèle	templatesList.templateType	string	Type ou catégorie du modèle.
Date de création	templatesList.templateCreationDate	integer	Date de création du modèle, en millisecondes Unix.
Date de la dernière mise à jour	templatesList.templateLastUpdateDate	integer	Date de la dernière mise à jour du modèle, en millisecondes Unix.
Modifiable	templatesList.editable	boolean	Indique si le modèle peut être modifié.
Nombre de parties	templatesList.numberOfParties	integer	Nombre de parties de signature définies dans le modèle.
ID d’entreprise	templatesList.companyId	integer	Compte d’entreprise auquel appartient le modèle.
Partager avec tous	templatesList.shareAll	boolean	Indique si le modèle est partagé avec tous les utilisateurs du compte.
ID de partie	templatesList.templateCreatedBy.partyId	integer	Identificateur unique de l’utilisateur.
Prénom	templatesList.templateCreatedBy.firstName	string	Prénom de l’utilisateur.
Nom de famille	templatesList.templateCreatedBy.lastName	string	Nom de l’utilisateur.
Courrier électronique	templatesList.templateCreatedBy.emailId	string	Adresse e-mail de l’utilisateur.
ID de partie	templatesList.templateLastUpdatedBy.partyId	integer	Identificateur unique de l’utilisateur.
Prénom	templatesList.templateLastUpdatedBy.firstName	string	Prénom de l’utilisateur.
Nom de famille	templatesList.templateLastUpdatedBy.lastName	string	Nom de l’utilisateur.
Courrier électronique	templatesList.templateLastUpdatedBy.emailId	string	Adresse e-mail de l’utilisateur.

Obtenir les détails de l’enveloppe

ID d’opération :

GetEnvelopeDetails

Récupère les détails complets d’une enveloppe, y compris son état, ses destinataires et ses documents.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’enveloppe	folderId	True	integer	Identificateur unique de l’enveloppe à récupérer.
Jeton d'accès	access_token		string	Jeton d’accès OAuth 2.0 pour l’authentification.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si l’opération a réussi (par exemple, « réussite »).
ID	folder.folderId	integer	ID unique de l’enveloppe.
Nom	folder.folderName	string	Nom de l’enveloppe.
ID d’auteur	folder.folderAuthorId	integer	ID unique de l’utilisateur qui a créé l’enveloppe.
Prénom de l’auteur	folder.folderAuthorFirstName	string	Prénom du créateur de l’enveloppe.
Nom de l’auteur	folder.folderAuthorLastName	string	Nom du créateur de l’enveloppe.
Email d’auteur	folder.folderAuthorEmail	string	Adresse e-mail du créateur de l’enveloppe.
Rôle d’auteur	folder.folderAuthorRole	string	Rôle de compte du créateur d’enveloppe.
ID d’entreprise	folder.folderCompanyId	integer	ID unique de l’entreprise auquel appartient l’enveloppe.
Date de création	folder.folderCreationDate	integer	Date et heure de création de l’enveloppe, en millisecondes Unix.
Date d’envoi	folder.folderSentDate	integer	Date et heure auxquelles l’enveloppe a été envoyée aux destinataires, en millisecondes Unix. Null s’il n’est pas encore envoyé.
État	folder.folderStatus	string	État actuel de l’enveloppe (par exemple, SHARED, EXECUTED, DRAFT, CANCELLED).
ID de document	folder.folderDocumentIds	array of integer	Liste des ID de document inclus dans cette enveloppe.
Documents	folder.documentsList	array of object	Détails de chaque document inclus dans l’enveloppe.
ID du document	folder.documentsList.documentId	integer	Identificateur unique du document.
ID de contrat	folder.documentsList.contractId	integer	Identificateur unique du contrat associé à ce document.
ID d’entreprise	folder.documentsList.companyId	integer	ID unique de l’entreprise à laquelle appartient ce document.
Créée par	folder.documentsList.contractCreatedBy	integer	ID d’utilisateur de la personne qui a créé le contrat.
Date de création	folder.documentsList.contractCreatedOn	integer	Date de création du contrat, en millisecondes Unix.
Type de contrat	folder.documentsList.contractType	string	Type ou catégorie du contrat.
État du document	folder.documentsList.contractStatus	string	État de signature actuel du document (par exemple, WAITING_FOR_SIGNATURE, EXECUTED).
Modifiable	folder.documentsList.editable	boolean	Indique si le document peut être modifié.
ID de version	folder.documentsList.contractVersionId	integer	ID unique de la version actuelle du document.
Nom de la version	folder.documentsList.contractVersionName	string	Nom de la version actuelle du document.
Version Description	folder.documentsList.contractVersionDesc	string	Description de la version actuelle du document.
Version créée par	folder.documentsList.versionCreatedby	integer	ID utilisateur de la personne qui a créé cette version de document.
Version créée sur	folder.documentsList.versionCreatedOn	integer	Date de création de cette version de document, en millisecondes Unix.
Numéro de version	folder.documentsList.contractVersionNumber	integer	Numéro de version du document.
Destinataires	folder.folderRecipientParties	array of object	Liste des destinataires de cette enveloppe, y compris leur état de signature et leurs liens d’accès.
ID du destinataire	folder.folderRecipientParties.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	folder.folderRecipientParties.partyDetails.partyId	integer	Identificateur unique du destinataire.
Prénom	folder.folderRecipientParties.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	folder.folderRecipientParties.partyDetails.lastName	string	Nom du destinataire.
Courrier électronique	folder.folderRecipientParties.partyDetails.emailId	string	Adresse e-mail du destinataire.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Adresse du destinataire.
Date de création du compte	folder.folderRecipientParties.partyDetails.dateCreated	integer	Date de création du compte du destinataire, en millisecondes Unix.
Permissions	folder.folderRecipientParties.contractPermissions	string	Autorisations de signature accordées à ce destinataire (par exemple, FILL_FIELDS_AND_SIGN).
Ordre de signature	folder.folderRecipientParties.partySequence	integer	Position de ce destinataire dans l’ordre de signature.
Séquence de flux de travail	folder.folderRecipientParties.workflowSignSequence	integer	Numéro de séquence de signature de flux de travail pour ce destinataire.
ID d’enveloppe	folder.folderRecipientParties.envelopeId	integer	ID de l’enveloppe à laquelle appartient ce destinataire.
Mode de partage	folder.folderRecipientParties.sharingMode	string	Méthode utilisée pour partager le document avec ce destinataire (par exemple, e-mail).
URL de signature	folder.folderRecipientParties.folderAccessURL	string	URL de signature unique pour ce destinataire. Null si l’enveloppe a déjà été terminée ou annulée.
Mode de sécurité	folder.folderRecipientParties.securityMode	string	Mode de sécurité appliqué à l’accès de ce destinataire.
Commentaires supplémentaires	folder.folderRecipientParties.extraComments	string	Tous les commentaires supplémentaires inclus dans l’invitation de signature pour ce destinataire.
URL d’accès à l’auteur	folder.folderAccessURLForAuthor	string	URL de l’auteur de l’enveloppe pour accéder au document. Null s’il n’est pas applicable.
ID en bloc	folder.bulkId	integer	L’ID du lot d’envoi en bloc auquel appartient cette enveloppe, le cas échéant.
Appliquer l’ordre de signature	folder.enforceSignWorkflow	boolean	Indique si les destinataires doivent se connecter à l’ordre spécifié.
Étape actuelle du flux de travail	folder.currentWorkflowStep	integer	Étape actuelle du flux de travail de signature.
Transaction Source	folder.transactionSource	string	Source qui a lancé cette transaction d’enveloppe.
Modifiable	folder.editable	boolean	Indique si l’enveloppe peut toujours être modifiée.
signature In-Person	folder.inPersonSignable	boolean	Indique si l’enveloppe peut être connectée à la personne.
Remplacer les rappels	folder.overrideAccountReminders	boolean	Indique si les paramètres de rappel au niveau du compte sont remplacés pour cette enveloppe.
ID	folder.envelopeId	integer	ID unique de l’enveloppe. Même valeur que l’ID d’enveloppe (folderId).
Nom	folder.envelopeName	string	Nom de l’enveloppe. Même valeur que le nom de l’enveloppe (folderName).
ID d’origine	folder.envelopeOriginatorId	integer	ID utilisateur de la personne qui a créé l’enveloppe.
ID d’entreprise	folder.envelopeCompanyId	integer	ID de l’entreprise à laquelle appartient l’enveloppe.
Date	folder.envelopeDate	integer	Date et heure de création de l’enveloppe, en millisecondes Unix.
Date partagée	folder.envelopeSharedDate	integer	Date et heure de partage de l’enveloppe avec les destinataires, en millisecondes Unix. Null s’il n’est pas encore partagé.
État	folder.envelopeStatus	string	État actuel de l’enveloppe. Même valeur que l’état de l’enveloppe (folderStatus).
ID de contrat	folder.envelopeContractIds	array of integer	Liste des ID de contrat associés à cette enveloppe.
Autorisations de partie	folder.envelopePartyPermissions	array of object	Liste des destinataires et de leurs autorisations de signature. Même structure que Recipients.
ID du destinataire	folder.envelopePartyPermissions.partyId	integer	Identificateur unique du destinataire.
Prénom	folder.envelopePartyPermissions.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	folder.envelopePartyPermissions.partyDetails.lastName	string	Nom du destinataire.
Courrier électronique	folder.envelopePartyPermissions.partyDetails.emailId	string	Adresse e-mail du destinataire.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	Autorisations de signature pour ce destinataire.
Ordre de signature	folder.envelopePartyPermissions.partySequence	integer	Position de ce destinataire dans l’ordre de signature.
URL de signature	folder.envelopePartyPermissions.folderAccessURL	string	URL de signature unique pour ce destinataire.
Tous les champs	allFields	array of object	Liste de tous les champs de signature et de formulaire placés dans les documents de l’enveloppe.
ID de champ	allFields.fieldTagId	integer	Identificateur unique du champ.
ID du document	allFields.contractId	integer	ID du document auquel appartient ce champ.
ID de version	allFields.versionId	integer	L’ID de version du document auquel appartient ce champ.
Type de champ	allFields.fieldType	string	Type du champ (par exemple, signfield, textfield, datefield, case à cocher, dropdownfield, initialfield).
Numéro de page	allFields.documentPageNumber	integer	Numéro de page où ce champ est placé.
ID de document de champ	allFields.docFieldId	string	Identificateur au niveau du document pour ce champ.
Partie responsable	allFields.partyResponsible	integer	ID de partie responsable du remplissage de ce champ.
Dépend	allFields.dependent	boolean	Indique si la visibilité de ce champ dépend de la valeur d’un autre champ.
Required	allFields.required	boolean	Indique si ce champ doit être rempli avant que le document puisse être envoyé.
Valeur de champ	allFields.value	string	Valeur actuelle du champ, si elle est remplie.
Valeurs de champ	allFieldsNameValue	array of object	Liste simplifiée de tous les noms de champs et de leurs valeurs actuelles. Utilisez cette option pour lire les données de champ renseignées à partir d’une enveloppe signée.
ID de champ	allFieldsNameValue.fieldId	integer	Identificateur unique du champ.
ID du document	allFieldsNameValue.documentId	integer	ID du document auquel appartient ce champ.
ID de version	allFieldsNameValue.documentVersionId	integer	L’ID de version du document auquel appartient ce champ.
Type de champ	allFieldsNameValue.fieldType	string	Type du champ (par exemple, textfield, signfield, datefield, checkboxfield, dropdownfield).
Nom du champ	allFieldsNameValue.name	string	Étiquette ou nom du champ tel que défini dans le modèle.
Valeur de champ	allFieldsNameValue.value	string	Valeur entrée ou sélectionnée pour ce champ.
Historique de l’enveloppe	Folder History	array of object	Piste d’audit de toutes les actions effectuées sur cette enveloppe, dans l’ordre chronologique.
Prénom	Folder History.firstName	string	Prénom de la personne qui a effectué l’action.
Nom de famille	Folder History.lastName	string	Nom de la personne qui a effectué l’action.
Courrier électronique	Folder History.email	string	Adresse e-mail de la personne qui a effectué l’action.
ID d’enveloppe	Folder History.envelopeId	integer	ID de l’enveloppe sur laquelle l’action a été effectuée.
Date	Folder History.dateChanged	integer	Date et heure auxquelles l’action s’est produite, en millisecondes Unix.
ID de partie	Folder History.changeDoneByParty	integer	ID de partie de la personne qui a effectué l’action.
Action	Folder History.action	string	Action effectuée sur l’enveloppe (par exemple, Created, InviteSentTo, InviteAccepted, Signed, Executed).

Obtenir les détails du canal Webhook

ID d’opération :

GetWebhookChannelDetails

Récupère les détails d’un canal webhook spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de canal	channelId	True	string	Identificateur unique du canal webhook à récupérer.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
ID	channel.channelId	integer	Identificateur unique du canal webhook.
ID d’entreprise	channel.companyId	integer	Compte d’entreprise auquel appartient ce canal.
Nom	channel.channelName	string	Nom du canal webhook.
URL de webhook	channel.webhookUrl	string	URL que Foxit eSign appelle lorsqu’un événement abonné se produit.
Webhook Secret	channel.webhookSecret	string	Clé secrète utilisée pour vérifier les charges utiles du webhook.
Date de création	channel.dateCreated	integer	Date de création du canal, en millisecondes Unix.
Date de mise à jour	channel.dateUpdated	integer	Date de la dernière mise à jour du canal, en millisecondes Unix.
Niveau webhook	channel.webhookLevel	string	Étendue du canal webhook. « Account » (déclencheurs pour toutes les enveloppes) ou « API App » (déclencheurs uniquement pour les enveloppes créées via l’API).
État	channel.status	string	État actuel du canal. 'active' ou 'deactive'.
Enveloppe envoyée	channel.eventsSubscribedMap.folder_sent	boolean	Se déclenche lorsqu’une enveloppe est envoyée aux destinataires.
Enveloppe vue	channel.eventsSubscribedMap.folder_viewed	boolean	Se déclenche lorsqu’une enveloppe est ouverte par un destinataire.
Enveloppe signée	channel.eventsSubscribedMap.folder_signed	boolean	Se déclenche lorsqu’une enveloppe est signée par un destinataire.
Enveloppe annulée	channel.eventsSubscribedMap.folder_cancelled	boolean	Se déclenche lorsqu’une enveloppe est annulée.
Enveloppe exécutée	channel.eventsSubscribedMap.folder_executed	boolean	Se déclenche lorsque toutes les parties ont signé et que l’enveloppe est entièrement exécutée.
Enveloppe supprimée	channel.eventsSubscribedMap.folder_deleted	boolean	Se déclenche lorsqu’une enveloppe est supprimée.

Obtenir les détails du groupe d’e-mails

ID d’opération :

GetEmailGroupDetails

Récupère les détails d’un groupe de messagerie existant.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Noms des groupes d’e-mails	emailGroupNames	True	array of string	Tableau de noms de groupes de messagerie utilisés pour identifier les groupes.

Retours

Nom	Chemin d’accès	Type	Description
Groupes de messagerie	allEmailGroups	array of object	Liste des groupes de messagerie correspondant aux noms de groupes demandés.
ID de groupe	allEmailGroups.groupId	integer	Identificateur unique du groupe de courriers électroniques.
Nom du groupe	allEmailGroups.groupName	string	Nom du groupe d’e-mails.
Description de groupe	allEmailGroups.groupDesc	string	Description du groupe d’e-mails.
Date de création	allEmailGroups.dateCreated	integer	Date de création du groupe de courriers électroniques en millisecondes Unix.
ID d’entreprise	allEmailGroups.companyId	integer	Compte d’entreprise auquel appartient ce groupe de messagerie.
Parties	allEmailGroups.parties	array of object	Liste des destinataires de ce groupe de messagerie.
Prénom	allEmailGroups.parties.firstName	string	Prénom du destinataire.
Nom de famille	allEmailGroups.parties.lastName	string	Nom du destinataire.
Courrier électronique	allEmailGroups.parties.emailId	string	Adresse e-mail du destinataire.

Obtenir les détails du modèle

ID d’opération :

GetTemplateDetails

Récupère les détails complets d’un modèle spécifique, y compris ses champs et ses destinataires.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de modèle	templateId	True	string	Identificateur unique du modèle à récupérer.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
ID	template.templateId	integer	Identificateur unique du modèle.
Nom	template.templateName	string	Nom du modèle.
Description	template.templateDesc	string	Description du modèle.
Type	template.templateType	string	Type du modèle.
Date de création	template.templateCreationDate	integer	Date de création du modèle, en millisecondes Unix.
Date de la dernière mise à jour	template.templateLastUpdateDate	integer	Date de la dernière mise à jour du modèle, en millisecondes Unix.
Modifiable	template.editable	boolean	Indique si le modèle peut être modifié.
Nombre de parties	template.numberOfParties	integer	Nombre de parties de signature définies dans le modèle.
Total Pages	template.totalPages	integer	Nombre total de pages dans le document de modèle.
ID d’entreprise	template.companyId	integer	Compte d’entreprise auquel appartient le modèle.
Partager avec tous	template.shareAll	boolean	Indique si le modèle est partagé avec tous les utilisateurs du compte.
Modèle de nom personnalisé	template.templateCustomName	string	Modèle de nom personnalisé appliqué aux enveloppes créées à partir de ce modèle.
Autorisations de partie	template.templatePartyPermissions	array of object	Liste des rôles de destinataire et de leurs autorisations de signature définies dans ce modèle.
ID de partie	template.templatePartyPermissions.template_party_id	integer	ID unique de cette entrée de partie de modèle.
ID	template.templatePartyPermissions.templateId	integer	ID du modèle auquel appartient cette partie.
Permissions	template.templatePartyPermissions.templatePermissions	string	Autorisations de signature pour cette partie (par exemple, FILL_FIELDS_AND_SIGN).
Ordre de signature	template.templatePartyPermissions.partySequence	integer	Position de l’ordre de signature pour cette partie.
Rôle de partie	template.templatePartyPermissions.templatePartyRole	string	Nom du rôle attribué à cette partie. Utilisez cette valeur lors de la création d’une enveloppe à partir de ce modèle.
ID de partie	template.templatePartyPermissions.partyId	integer	ID de la partie affectée à ce rôle, s’il est préaffecté.
ID de partie	template.templateCreatedBy.partyId	integer	Identificateur unique de l’utilisateur.
Prénom	template.templateCreatedBy.firstName	string	Prénom de l’utilisateur.
Nom de famille	template.templateCreatedBy.lastName	string	Nom de l’utilisateur.
Courrier électronique	template.templateCreatedBy.emailId	string	Adresse e-mail de l’utilisateur.
Département	template.templateCreatedBy.department	string	Département de l’utilisateur.
Titre	template.templateCreatedBy.title	string	poste occupé par l'utilisateur.
Activé	template.templateCreatedBy.active	boolean	Indique si le compte d’utilisateur est actif.
ID de partie	template.templateLastUpdatedBy.partyId	integer	Identificateur unique de l’utilisateur.
Prénom	template.templateLastUpdatedBy.firstName	string	Prénom de l’utilisateur.
Nom de famille	template.templateLastUpdatedBy.lastName	string	Nom de l’utilisateur.
Courrier électronique	template.templateLastUpdatedBy.emailId	string	Adresse e-mail de l’utilisateur.
Département	template.templateLastUpdatedBy.department	string	Département de l’utilisateur.
Titre	template.templateLastUpdatedBy.title	string	poste occupé par l'utilisateur.
Activé	template.templateLastUpdatedBy.active	boolean	Indique si le compte d’utilisateur est actif.
Tous les champs	allfields	array of object	Liste de tous les champs définis dans ce modèle.
ID de balise de champ	allfields.fieldTagId	integer	Identificateur unique du champ.
ID de modèle	allfields.templateId	integer	ID du modèle auquel appartient ce champ.
ID d’entreprise	allfields.companyId	integer	Compte d’entreprise auquel appartient ce champ.
Type de champ	allfields.fieldType	string	Type du champ (par exemple, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Numéro de page	allfields.documentPageNumber	integer	Numéro de page du document où ce champ est placé.
Partie responsable	allfields.partyResponsible	integer	Numéro de séquence de partie responsable de la fin de ce champ.
Séquence de parties	allfields.partyResponsibleSequence	integer	Position de séquence du tiers responsable.
ID de champ Doc	allfields.docFieldId	string	Identificateur de ce champ dans le document.
Dépendant	allfields.dependent	boolean	Indique si la visibilité de ce champ dépend de la valeur d’un autre champ.
Ordre des tabulations	allfields.tabOrder	integer	Ordre de tabulation pour la navigation entre les champs.
Required	allfields.required	boolean	Indique si ce champ doit être terminé avant que le document puisse être signé.
Nom de champ personnalisé	allfields.customFieldName	string	Nom personnalisé affecté à ce champ.
Partager tout	allfields.shareAll	boolean	Indique si ce champ est partagé avec tous les utilisateurs.
Autoriser la modification	allfields.allowEdit	boolean	Indique si ce champ peut être modifié par le destinataire.
Nom du champ texte	allfields.textfieldName	string	Étiquette du champ de texte (applicable lorsque fieldType est « textfield »).
Valeur	allfields.value	string	Valeur préremplie ou entrée du champ.
Taille de police	allfields.fontSize	integer	Taille de police utilisée pour le texte dans ce champ.
Couleur de police	allfields.fontColor	string	Couleur de police utilisée pour le texte dans ce champ (par exemple, #000000).
Lecture seule	allfields.readOnly	boolean	Indique si le champ est en lecture seule et ne peut pas être modifié par le destinataire.
Plusieurs lignes	allfields.multiLine	boolean	Indique si le champ de texte accepte plusieurs lignes d’entrée (applicable lorsque fieldType est « textfield »).
Limite de caractères	allfields.characterLimit	integer	Nombre maximal de caractères autorisés dans le champ (applicable lorsque fieldType est « textfield »).
Nom du champ Date	allfields.datefieldName	string	Étiquette du champ date (applicable lorsque fieldType est « datefield »).
Format de date	allfields.dateFormat	string	Format de date utilisé par ce champ (par exemple, MM/DD/AAAA) (applicable lorsque fieldType est « datefield »).
Nom de la case à cocher	allfields.cbname	string	Étiquette du champ de case à cocher (applicable lorsque fieldType est « case à cocher »).
Groupe de cases à cocher	allfields.cbgroup	string	Nom du groupe de cette case à cocher, utilisé lorsque plusieurs cases à cocher sont liées (applicable lorsque fieldType est « case à cocher »).
Vérifié	allfields.checked	boolean	Indique si la case à cocher est cochée par défaut (applicable lorsque fieldType est « case à cocher »).
Nom du champ sécurisé	allfields.securedfieldName	string	Étiquette du champ sécurisé (applicable lorsque fieldType est « champ sécurisé »).
Caractères à afficher	allfields.charToDisplay	integer	Nombre de caractères non masqués à afficher à la fin d’une valeur de champ sécurisée (applicable lorsque fieldType est « champ sécurisé »).
ID de signature	allfields.signatureId	string	ID de la signature appliquée à ce champ de signe (applicable lorsque fieldType est « signfield »).
Image initiale	allfields.initialImage	string	Données d’image pour les initiales appliquées à ce champ (applicable lorsque fieldType est « initialfield »).
Nom du champ Pièce jointe	allfields.attachmentfieldName	string	Nom du champ pièce jointe (applicable lorsque fieldType est « attachmentfield »).
Description de la pièce jointe	allfields.attachmentfieldDescription	string	Description de ce qu’il faut attacher (applicable lorsque fieldType est « attachmentfield »).

Obtenir les ID d’enveloppe

ID d’opération :

GetEnvelopeIds

Retourne une liste d’ID d’enveloppe filtrés par état. Utilisez cette option pour rechercher des enveloppes dans un état spécifique.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Date à partir de	dateFrom	True	string	Début de la plage de dates de création d’enveloppe. Format accepté : AAAA-MM-DD.
Date à	dateTo	True	string	Fin de la plage de dates de création d’enveloppe. Format accepté : AAAA-MM-DD. La valeur dateTo doit être comprise dans les 6 mois de la valeur dateFrom.
État	status		string	Filtrer les enveloppes par état. Valeurs acceptées : EXECUTED, SHARED, DRAFT, PARTIELLEMENT SIGNÉ, ANNULÉ, EXPIRÉ, SUPPRIMÉ. En cas d’omission, les enveloppes avec un état sont retournées.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
Message	message	string	Message récapitulative indiquant le nombre d’ID d’enveloppe retournés.
ID d’enveloppe	allFolderIds	array of integer	Liste des ID d’enveloppe correspondant aux critères de filtre. Utilisez ces ID avec Obtenir les détails de l’enveloppe pour récupérer des informations complètes sur l’enveloppe.

Obtenir l’historique des activités de l’enveloppe

ID d’opération :

GetEnvelopeActivityHistory

Récupère un journal d’activité complet pour une enveloppe, affichant toutes les actions effectuées par les destinataires et l’expéditeur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’enveloppe	folderId	True	integer	Identificateur unique de l’enveloppe dont vous souhaitez récupérer l’historique d’activité.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
ID d’enveloppe	details.folderId	integer	Identificateur unique de l’enveloppe.
Documents entourés	details.enclosedDocuments	string	Nom du ou des documents placés dans l’enveloppe.
Destinataires	details.envelopeRecipients	string	Noms de tous les destinataires de l’enveloppe.
Auteur	details.author	string	Nom de l’utilisateur qui a créé l’enveloppe.
État	details.status	string	État actuel de l’enveloppe (par exemple, SHARED, EXECUTED, CANCELLED).
Date de l’activité la plus récente	details.latestActivityDate	string	Date et heure de l’activité la plus récente sur l’enveloppe.
Date de création	details.dateCreated	string	Date et heure de création de l’enveloppe.
Date d’envoi	details.dateSent	string	Date et heure auxquelles l’enveloppe a été envoyée aux destinataires.
Activités	details.activities	array of object	Liste chronologique de toutes les actions effectuées sur cette enveloppe.
Activity	details.activities.activity	string	Description lisible par l’homme de l’action qui s’est produite.
Action	details.activities.action	string	Type d’action effectué (par exemple, Created, Invitation Sent, Opened, Viewed, Signed).
Utilisateur	details.activities.user	string	Nom de l’utilisateur qui a effectué l’action.
État de l’enveloppe	details.activities.folderStatus	string	État de l’enveloppe au moment où cette action s’est produite.
Heure	details.activities.time	string	Date et heure auxquelles l’action s’est produite.
Source	details.activities.source	string	Source à partir de laquelle l’action a été effectuée (par exemple, Web).
Adresse IP	details.activities.ipAddress	string	Adresse IP à partir de laquelle l’action a été effectuée, le cas échéant.

Obtenir l’historique des enveloppes supprimées

ID d’opération :

GetDeletedEnvelopeHistory

Récupère un historique des enveloppes qui ont été supprimées ou déplacées vers la corbeille.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’enveloppe	folderId	True	string	Identificateur unique de l’enveloppe dont vous souhaitez récupérer l’historique de suppression.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
Informations sur l’enveloppe supprimée	Deleted Folder Log Info	array of object	Informations récapitulatives sur l’enveloppe supprimée.
ID d’enveloppe	Deleted Folder Log Info.folderId	integer	Identificateur unique de l’enveloppe supprimée.
Nom de l’enveloppe	Deleted Folder Log Info.folderName	string	Nom de l’enveloppe supprimée.
Nom du document	Deleted Folder Log Info.documentName	string	Nom du document dans l’enveloppe supprimée.
ID du document	Deleted Folder Log Info.documentId	string	Identificateur unique du document dans l’enveloppe supprimée.
Date de suppression	Deleted Folder Log Info.deletionDate	integer	Date et heure de suppression de l’enveloppe, en millisecondes Unix.
Supprimé par	Deleted Folder Log Info.deletedBy	string	Nom de l’utilisateur qui a supprimé l’enveloppe.
Historique des journaux de suppression	Deleted Folder Log History	array of object	Journal pas à pas de toutes les actions de suppression effectuées sur l’enveloppe.
Effectué par	Deleted Folder Log History.partiesName	string	Nom de l’utilisateur qui a effectué l’étape de suppression.
Source	Deleted Folder Log History.source	string	Source à partir de laquelle la suppression a été lancée (par exemple, Web, API).
Événement	Deleted Folder Log History.event	string	Action de suppression spécifique effectuée (par exemple, Supprimer le dossier, Supprimer tous les parties du dossier).

Répertorier tous les canaux webhook

ID d’opération :

ListallWebhookChannels

Retourne la liste de tous les canaux webhook configurés dans votre compte.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si la demande a réussi.
Nombre total de canaux	total_channel	integer	Nombre total de canaux webhook configurés dans le compte.
Canaux webhook	templatesList	array of object	Liste de tous les canaux webhook dans le compte.
ID de canal	templatesList.channelId	integer	Identificateur unique du canal webhook.
ID d’entreprise	templatesList.companyId	integer	Compte d’entreprise auquel appartient ce canal.
Nom du canal	templatesList.channelName	string	Nom du canal webhook.
URL de webhook	templatesList.webhookUrl	string	URL que Foxit eSign appelle lorsqu’un événement abonné se produit.
Webhook Secret	templatesList.webhookSecret	string	Clé secrète utilisée pour vérifier les charges utiles du webhook.
Date de création	templatesList.dateCreated	integer	Date de création du canal, en millisecondes Unix.
Date de mise à jour	templatesList.dateUpdated	integer	Date de la dernière mise à jour du canal, en millisecondes Unix.
Niveau webhook	templatesList.webhookLevel	string	Étendue du canal webhook. « Account » (déclencheurs pour toutes les enveloppes) ou « API App » (déclencheurs uniquement pour les enveloppes créées via l’API).
État	templatesList.status	string	État actuel du canal. 'active' ou 'deactive'.
Enveloppe envoyée	templatesList.eventsSubscribedMap.folder_sent	boolean	Se déclenche lorsqu’une enveloppe est envoyée aux destinataires.
Enveloppe vue	templatesList.eventsSubscribedMap.folder_viewed	boolean	Se déclenche lorsqu’une enveloppe est ouverte par un destinataire.
Enveloppe signée	templatesList.eventsSubscribedMap.folder_signed	boolean	Se déclenche lorsqu’une enveloppe est signée par un destinataire.
Enveloppe annulée	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Se déclenche lorsqu’une enveloppe est annulée.
Enveloppe exécutée	templatesList.eventsSubscribedMap.folder_executed	boolean	Se déclenche lorsque toutes les parties ont signé et que l’enveloppe est entièrement exécutée.
Enveloppe supprimée	templatesList.eventsSubscribedMap.folder_deleted	boolean	Se déclenche lorsqu’une enveloppe est supprimée.

Se désabonner du déclencheur webhook

ID d’opération :

DeleteTriggerWebhookChannel

Supprime un abonnement de canal webhook actif par son ID de canal. Utilisez cette action pour nettoyer les abonnements webhook qui ne sont plus nécessaires.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de canal	channelId	True	integer	ID du canal webhook à supprimer.

Supprimer des enveloppes

ID d’opération :

DeleteEnvelopes

Supprime définitivement une ou plusieurs enveloppes.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID de dossier	folderIds	True	array of integer	Tableau d’ID d’enveloppe à agir.

Retours

Nom	Chemin d’accès	Type	Description
Result	result	string	Indique si l’opération a réussi.

Télécharger des fichiers d’enveloppe

ID d’opération :

DownloadEnvelopeFiles

Télécharge les documents terminés à partir d’une enveloppe sous forme de fichier.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’enveloppe	folderId	True	string	Identificateur unique de l’enveloppe dont vous souhaitez télécharger les documents.

Retours

response

binary

Télécharger le fichier PDF d’un document unique

ID d’opération :

DownloadSingleDocumentPDF

Télécharge un document unique à partir d’une enveloppe en tant que fichier PDF.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’enveloppe	folderId	True	string	Identificateur unique de l’enveloppe contenant le document à télécharger.
Numéro de document	docNumber	True	string	Index du document à télécharger, à partir de 1.

Retours

response

binary

Télécharger le rapport

ID d’opération :

DownloadReport

Télécharge un rapport d’activité d’enveloppe en tant que fichier Microsoft Excel. Utilisez les filtres pour affiner les résultats par état, plage de dates, nom d’enveloppe, auteur ou signataire.

Paramètres

Nom	Clé	Obligatoire	Type	Description
envelopeStatus	status		string	État du dossier par lequel nous allons filtrer un rapport
Date de création à partir de	creationDateFrom		string	Début de la plage de dates de création. Format accepté : AAAA-MM-DD.
Date de création à	creationDateTo		string	Fin de la plage de dates de création. Format accepté : AAAA-MM-DD.
Nom de l’enveloppe	folderName		string	Tout dossier qui contient cette chaîne.
Inclure des champs	includeFields		string	Définissez la valeur « true » pour inclure les valeurs de champ d’enveloppe dans le rapport. La valeur par défaut est « false ».
Email d’auteur	authorEmail		string	Filtrez le rapport pour inclure uniquement les enveloppes créées par cette adresse e-mail d’auteur.
E-mail du signataire	signerEmail		string	Filtrez le rapport pour inclure uniquement les enveloppes où cette adresse e-mail est un signataire.

Retours

Fichier de rapport

binary

Déclencheurs

Lorsqu’une enveloppe est annulée	Se déclenche lorsqu’une enveloppe est annulée par un destinataire ou l’expéditeur.
Lorsqu’une enveloppe est consultée	Se déclenche lorsqu’un destinataire s’ouvre et affiche l’enveloppe.
Lorsqu’une enveloppe est entièrement exécutée	Se déclenche lorsque tous les destinataires ont signé et que l’enveloppe est entièrement exécutée.
Lorsqu’une enveloppe est envoyée	Se déclenche lorsqu’une enveloppe est envoyée aux destinataires. Cet événement se déclenche uniquement lorsque le niveau webhook est défini sur « Compte ».
Lorsqu’une enveloppe est signée	Se déclenche lorsqu’un destinataire signe l’enveloppe.
Lorsqu’une enveloppe est supprimée	Se déclenche lorsqu’une enveloppe est supprimée.

Lorsqu’une enveloppe est annulée

ID d’opération :

TriggerEnvelopeCancelled

Se déclenche lorsqu’une enveloppe est annulée par un destinataire ou l’expéditeur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du canal	channelName	True	string	Nom permettant d’identifier cet abonnement webhook dans votre compte.
Niveau webhook	webhookLevel	True	string	Compte : se déclenche pour toutes les enveloppes (web et API). Application API : se déclenche uniquement pour les enveloppes créées via l’API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signe chaque charge utile de webhook avec HMAC-SHA-256 à l’aide de ce secret pour la vérification.

Retours

Données d’événement reçues de Foxit eSign lorsqu’un événement webhook se déclenche.

WebhookEventPayload

WebhookEventPayload

Lorsqu’une enveloppe est consultée

ID d’opération :

TriggerEnvelopeViewed

Se déclenche lorsqu’un destinataire s’ouvre et affiche l’enveloppe.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du canal	channelName	True	string	Nom permettant d’identifier cet abonnement webhook dans votre compte.
Niveau webhook	webhookLevel	True	string	Compte : se déclenche pour toutes les enveloppes (web et API). Application API : se déclenche uniquement pour les enveloppes créées via l’API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signe chaque charge utile de webhook avec HMAC-SHA-256 à l’aide de ce secret pour la vérification.

Retours

Données d’événement reçues de Foxit eSign lorsqu’un événement webhook se déclenche.

WebhookEventPayload

WebhookEventPayload

Lorsqu’une enveloppe est entièrement exécutée

ID d’opération :

TriggerEnvelopeExecuted

Se déclenche lorsque tous les destinataires ont signé et que l’enveloppe est entièrement exécutée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du canal	channelName	True	string	Nom permettant d’identifier cet abonnement webhook dans votre compte.
Niveau webhook	webhookLevel	True	string	Compte : se déclenche pour toutes les enveloppes (web et API). Application API : se déclenche uniquement pour les enveloppes créées via l’API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signe chaque charge utile de webhook avec HMAC-SHA-256 à l’aide de ce secret pour la vérification.

Retours

Données d’événement reçues de Foxit eSign lorsqu’un événement webhook se déclenche.

WebhookEventPayload

WebhookEventPayload

Lorsqu’une enveloppe est envoyée

ID d’opération :

TriggerEnvelopeSent

Se déclenche lorsqu’une enveloppe est envoyée aux destinataires. Cet événement se déclenche uniquement lorsque le niveau webhook est défini sur « Compte ».

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du canal	channelName	True	string	Nom permettant d’identifier cet abonnement webhook dans votre compte.
Niveau webhook	webhookLevel	True	string	Compte : se déclenche pour les enveloppes envoyées via le web ou l’API. Application API : se déclenche uniquement pour les enveloppes créées via l’API. L’événement folder_sent se déclenche uniquement au niveau du compte.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signe chaque charge utile de webhook avec HMAC-SHA-256 à l’aide de ce secret pour la vérification.

Retours

Données d’événement reçues de Foxit eSign lorsqu’un événement webhook se déclenche.

WebhookEventPayload

WebhookEventPayload

Lorsqu’une enveloppe est signée

ID d’opération :

TriggerEnvelopeSigned

Se déclenche lorsqu’un destinataire signe l’enveloppe.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du canal	channelName	True	string	Nom permettant d’identifier cet abonnement webhook dans votre compte.
Niveau webhook	webhookLevel	True	string	Compte : se déclenche pour toutes les enveloppes (web et API). Application API : se déclenche uniquement pour les enveloppes créées via l’API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signe chaque charge utile de webhook avec HMAC-SHA-256 à l’aide de ce secret pour la vérification.

Retours

Données d’événement reçues de Foxit eSign lorsqu’un événement webhook se déclenche.

WebhookEventPayload

WebhookEventPayload

Lorsqu’une enveloppe est supprimée

ID d’opération :

TriggerEnvelopeDeleted

Se déclenche lorsqu’une enveloppe est supprimée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nom du canal	channelName	True	string	Nom permettant d’identifier cet abonnement webhook dans votre compte.
Niveau webhook	webhookLevel	True	string	Compte : se déclenche pour toutes les enveloppes (web et API). Application API : se déclenche uniquement pour les enveloppes créées via l’API.
Webhook Secret	webhookSecret		string	Optional. Foxit eSign signe chaque charge utile de webhook avec HMAC-SHA-256 à l’aide de ce secret pour la vérification.

Retours

Données d’événement reçues de Foxit eSign lorsqu’un événement webhook se déclenche.

WebhookEventPayload

WebhookEventPayload

Définitions

WebhookEventPayload

Données d’événement reçues de Foxit eSign lorsqu’un événement webhook se déclenche.

Nom	Chemin d’accès	Type	Description
Nom de l'événement	event_name	string	Nom de l’événement qui a déclenché (par exemple, folder_sent, folder_signed, folder_executed).
Date de l’événement	event_date	integer	Date et heure de l’événement (horodatage Unix en millisecondes).
ID	data.folder.folderId	integer	ID unique de l’enveloppe.
Nom	data.folder.folderName	string	Nom de l’enveloppe.
Nom personnalisé	data.folder.folderCustomName	string	Nom personnalisé affecté à l’enveloppe.
Mot de passe	data.folder.folderPassword	string	Mot de passe d’accès de l’enveloppe, s’il est défini.
ID du créateur	data.folder.folderAuthorId	integer	ID utilisateur du créateur de l’enveloppe.
Prénom du créateur	data.folder.folderAuthorFirstName	string	Prénom du créateur de l’enveloppe.
Nom du créateur	data.folder.folderAuthorLastName	string	Nom du créateur de l’enveloppe.
Adresse e-mail creator	data.folder.folderAuthorEmail	string	Adresse e-mail du créateur de l’enveloppe.
Rôle créateur	data.folder.folderAuthorRole	string	Rôle de compte du créateur d’enveloppe.
ID d’entreprise	data.folder.folderCompanyId	integer	ID d’entreprise propriétaire de l’enveloppe.
Date de création	data.folder.folderCreationDate	integer	Date de création de l’enveloppe (horodatage Unix en millisecondes).
Date d’envoi	data.folder.folderSentDate	integer	Date à laquelle l’enveloppe a été envoyée (horodatage Unix en millisecondes).
État	data.folder.folderStatus	string	État actuel de l’enveloppe.
Champ personnalisé 1	data.folder.custom_field1	string	Premier champ de métadonnées personnalisé.
Champ personnalisé 2	data.folder.custom_field2	string	Deuxième champ de métadonnées personnalisé.
Metadata	data.folder.metadata	string	Métadonnées personnalisées associées à l’enveloppe.
ID de document	data.folder.folderDocumentIds	array of integer	Liste des ID de document dans l’enveloppe.
Documents	data.folder.documentsList	array of object	Liste des documents dans l’enveloppe.
ID du document	data.folder.documentsList.documentId	integer	Identificateur unique du document.
ID de contrat	data.folder.documentsList.contractId	integer	ID de contrat pour ce document.
ID d’entreprise	data.folder.documentsList.companyId	integer	ID d’entreprise de ce document.
Créée par	data.folder.documentsList.contractCreatedBy	integer	ID d’utilisateur de la personne qui a créé le contrat.
Date de création	data.folder.documentsList.contractCreatedOn	integer	Date de création du contrat (horodatage Unix en millisecondes).
Type de contrat	data.folder.documentsList.contractType	string	Type du contrat.
État du contrat	data.folder.documentsList.contractStatus	string	État actuel du contrat.
Modifiable	data.folder.documentsList.editable	boolean	Indique si le document est modifiable.
ID de version	data.folder.documentsList.contractVersionId	integer	ID de version du contrat.
Nom de la version	data.folder.documentsList.contractVersionName	string	Nom de la version du contrat.
Version Description	data.folder.documentsList.contractVersionDesc	string	Description de la version du contrat.
Version créée par	data.folder.documentsList.versionCreatedby	integer	ID utilisateur de la personne qui a créé cette version.
Version créée sur	data.folder.documentsList.versionCreatedOn	integer	Date de création de cette version (horodatage Unix en millisecondes).
Numéro de version	data.folder.documentsList.contractVersionNumber	integer	Numéro de version du contrat.
Transaction Source	data.folder.documentsList.contractTransactionSource	string	Système source qui a lancé le contrat.
Destinataires	data.folder.folderRecipientParties	array of object	Liste des destinataires de cette enveloppe.
ID du destinataire	data.folder.folderRecipientParties.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	data.folder.folderRecipientParties.partyDetails.partyId	integer	ID unique du destinataire.
Prénom	data.folder.folderRecipientParties.partyDetails.firstName	string	Prénom du destinataire.
Nom de famille	data.folder.folderRecipientParties.partyDetails.lastName	string	Nom du destinataire.
Courrier électronique	data.folder.folderRecipientParties.partyDetails.emailId	string	Adresse e-mail du destinataire.
Texte de remplacement	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Indique s’il s’agit d’un destinataire d’espace réservé.
Adresse	data.folder.folderRecipientParties.partyDetails.address	string	Adresse du destinataire.
Date de création	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	Date de création de l’enregistrement du destinataire (horodatage Unix en millisecondes).
Désactiver les e-mails	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Indique si le destinataire a refusé les e-mails.
ID unique	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Identificateur système unique pour ce destinataire.
Niveau d’authentification	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	Méthode d’authentification pour ce destinataire.
Date de mise à jour du mot de passe	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Date de la dernière mise à jour du mot de passe.
État du mot de passe	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Indique si le mot de passe a été mis à jour.
Code de numérotation	data.folder.folderRecipientParties.dialingCode	string	Code de numérotation international.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	Numéro de téléphone mobile du destinataire.
Type de signature	data.folder.folderRecipientParties.signerSignatureType	string	Type de signature que le signataire utilisera.
Permissions	data.folder.folderRecipientParties.contractPermissions	string	Autorisations accordées à ce destinataire.
Ordre de signature	data.folder.folderRecipientParties.partySequence	integer	Ordre de signature pour ce destinataire.
Séquence de flux de travail	data.folder.folderRecipientParties.workflowSignSequence	integer	Numéro de séquence de signature de flux de travail.
ID d’enveloppe	data.folder.folderRecipientParties.envelopeId	integer	ID d’enveloppe associé à ce destinataire.
ID d’entreprise du destinataire	data.folder.folderRecipientParties.partyCompanyId	integer	ID d’entreprise de ce destinataire.
Mode de partage	data.folder.folderRecipientParties.sharingMode	string	Mode de partage pour ce destinataire.
URL de signature du destinataire	data.folder.folderRecipientParties.folderAccessURL	string	URL de ce destinataire pour accéder à l’enveloppe et la signer.
Mode de sécurité	data.folder.folderRecipientParties.securityMode	string	Mode de sécurité pour ce destinataire.
Commentaires	data.folder.folderRecipientParties.extraComments	string	Commentaires supplémentaires pour le destinataire.
Autoriser la modification du nom	data.folder.folderRecipientParties.allowNameChange	boolean	Indique si le destinataire peut mettre à jour son nom.
Nom mis à jour	data.folder.folderRecipientParties.signerNameUpdated	boolean	Indique si le signataire a mis à jour son nom.
Niveau d’authentification du signataire	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Niveau d’authentification requis pour le signataire.
Code d'accès	data.folder.folderRecipientParties.userDefinedAccessCode	string	Code d’accès personnalisé pour le signataire.
ID de signature	data.folder.folderRecipientParties.signatureId	string	ID de la signature appliquée.
Rôle	data.folder.folderRecipientParties.partyRole	string	Rôle de ce destinataire dans le flux de travail de signature.
Champ d’entreprise	data.folder.folderRecipientParties.companyFieldValue	string	Valeur du champ Nom de la société.
Champ Titre	data.folder.folderRecipientParties.titleFieldValue	string	Valeur du champ de titre.
Raison de la signature	data.folder.folderRecipientParties.reasonSigning	string	Raison donnée de la signature.
Champ de paiement ajouté	data.folder.folderRecipientParties.payFieldAdded	boolean	Indique si un champ de paiement a été ajouté.
Bénéficiaire	data.folder.folderRecipientParties.payee	boolean	Indique si ce destinataire est le bénéficiaire.
Paiement périodique	data.folder.folderRecipientParties.recurringFieldExist	boolean	Indique si un champ de paiement périodique existe.
Imprimer et signer terminé	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Indique si l’impression et le signe sont terminés.
Signataire facultatif	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Indique si ce destinataire est un signataire facultatif.
Signataires facultatifs	data.folder.folderRecipientParties.optionalSigners	array of integer	ID de partie signataire facultative.
Payé	data.folder.folderRecipientParties.paid	boolean	Indique si le paiement a été effectué.
URL d’accès à l’auteur	data.folder.folderAccessURLForAuthor	string	URL de l’auteur de l’enveloppe pour accéder à l’enveloppe.
URL d’accès brouillon	data.folder.draftFolderAccessURL	string	URL permettant d’accéder à l’enveloppe en état brouillon.
Signature de salle de conseil	data.folder.boardRoomSign	boolean	Indique si le mode de signature de salle de conseil est activé.
Inclure le logo	data.folder.includeLogo	boolean	Indique si le logo de l’entreprise est inclus dans les e-mails.
Couleur d’arrière-plan du bouton	data.folder.email_btnBgColor	string	Couleur d’arrière-plan du bouton d’action d’e-mail.
Couleur de texte du bouton	data.folder.email_btnTxtColor	string	Couleur de texte du bouton d’action d’e-mail.
Logo de messagerie	data.folder.emailTemplateLogo	string	URL du logo utilisée dans le modèle d’e-mail.
ID du modèle d’e-mail	data.folder.emailTemplateId	integer	ID du modèle d’e-mail utilisé.
En-tête d’e-mail	data.folder.emailHeader	string	Texte d’en-tête dans les e-mails de notification.
Pied de page d’e-mail	data.folder.emailFooter	string	Texte du pied de page dans les e-mails de notification.
Purge planifiée	data.folder.purgeFlag	boolean	Indique si l’enveloppe est planifiée pour purger.
Date de début du vidage	data.folder.purgeStartDate	string	Date de début de la planification de vidage.
Date de fin du vidage	data.folder.purgeEndDate	string	Date de fin de la planification de vidage.
ID en bloc	data.folder.bulkId	integer	ID d’opération d’envoi en bloc, le cas échéant.
Appliquer l’ordre de signature	data.folder.enforceSignWorkflow	boolean	Indique si les destinataires doivent se connecter à l’ordre défini.
Étape actuelle du flux de travail	data.folder.currentWorkflowStep	integer	Étape actuelle du flux de travail de signature.
Transaction Source	data.folder.transactionSource	string	Système source qui a lancé cette transaction.
Modifiable	data.folder.editable	boolean	Indique si l’enveloppe est modifiable.
signature In-Person	data.folder.inPersonSignable	boolean	Indique si l’enveloppe prend en charge la signature en personne.
Remplacer les rappels	data.folder.overrideAccountReminders	boolean	Indique si les paramètres de rappel au niveau du compte sont remplacés.
Remplacer la délégation	data.folder.overrideAccountRecipientDelegation	boolean	Indique si les paramètres de délégation au niveau du compte sont remplacés.
Autoriser la délégation	data.folder.allowRecipientsToDelegate	boolean	Indique si les destinataires peuvent déléguer la signature.
ID	data.folder.envelopeId	integer	ID d’enveloppe unique (alias de folderId).
Nom	data.folder.envelopeName	string	Nom de l’enveloppe (alias de folderName).
ID d’origine	data.folder.envelopeOriginatorId	integer	ID d’utilisateur qui provient de l’enveloppe.
ID d’entreprise	data.folder.envelopeCompanyId	integer	ID d’entreprise propriétaire de l’enveloppe.
Date	data.folder.envelopeDate	integer	Date de création de l’enveloppe (horodatage Unix en millisecondes).
Date partagée	data.folder.envelopeSharedDate	integer	Date à laquelle l’enveloppe a été partagée (horodatage Unix en millisecondes).
État	data.folder.envelopeStatus	string	État actuel de l’enveloppe.
ID de contrat	data.folder.envelopeContractIds	array of integer	ID de contrat associés à cette enveloppe.
Autorisations de partie	data.folder.envelopePartyPermissions	array of object	Liste des autorisations du destinataire (même structure que les destinataires).
ID du destinataire	data.folder.envelopePartyPermissions.partyId	integer	Identificateur unique du destinataire.
ID du destinataire	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Prénom	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Nom de famille	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Courrier électronique	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Texte de remplacement	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Adresse	data.folder.envelopePartyPermissions.partyDetails.address	string
Date de création	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Désactiver les e-mails	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
ID unique	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Niveau d’authentification	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Date de mise à jour du mot de passe	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
État du mot de passe	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Code de numérotation	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Type de signature	data.folder.envelopePartyPermissions.signerSignatureType	string
Permissions	data.folder.envelopePartyPermissions.contractPermissions	string
Ordre de signature	data.folder.envelopePartyPermissions.partySequence	integer
Séquence de flux de travail	data.folder.envelopePartyPermissions.workflowSignSequence	integer
ID d’enveloppe	data.folder.envelopePartyPermissions.envelopeId	integer
ID d’entreprise du destinataire	data.folder.envelopePartyPermissions.partyCompanyId	integer
Mode de partage	data.folder.envelopePartyPermissions.sharingMode	string
URL de signature du destinataire	data.folder.envelopePartyPermissions.folderAccessURL	string
Mode de sécurité	data.folder.envelopePartyPermissions.securityMode	string
Commentaires	data.folder.envelopePartyPermissions.extraComments	string
Autoriser la modification du nom	data.folder.envelopePartyPermissions.allowNameChange	boolean
Nom mis à jour	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Niveau d’authentification du signataire	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Code d'accès	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
ID de signature	data.folder.envelopePartyPermissions.signatureId	string
Rôle	data.folder.envelopePartyPermissions.partyRole	string
Champ d’entreprise	data.folder.envelopePartyPermissions.companyFieldValue	string
Champ Titre	data.folder.envelopePartyPermissions.titleFieldValue	string
Raison de la signature	data.folder.envelopePartyPermissions.reasonSigning	string
Champ de paiement ajouté	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Bénéficiaire	data.folder.envelopePartyPermissions.payee	boolean
Paiement périodique	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Imprimer et signer terminé	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Signataire facultatif	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Signataires facultatifs	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Payé	data.folder.envelopePartyPermissions.paid	boolean
Niveau d’authentification	data.folder.envelopeAuthenticationLevel	string	Niveau d’authentification requis pour l’enveloppe.
Bloc du signataire unique	data.folder.allowSingleSignerInBulk	boolean	Indique si un seul signataire est autorisé en mode en bloc.
nom du dossier File-Based	data.folder.folderNameBasedOnFileNaming	boolean
nom du document File-Based	data.folder.documentNameBasedOnFileNaming	boolean
nom du certificat File-Based	data.folder.certificateNameBasedOnFileNaming	boolean
Nommage de fichier pre-Exec	data.folder.enableFileNamingBeforeExecution	boolean
Payee ajouté	data.folder.payeeAddedd	boolean
Self-Signing activé	data.folder.selfSignerEnabled	boolean
Non autorisé	data.folder.notaryEnabled	boolean
Visibilité limitée	data.folder.limitedVisibilityFlag	boolean
Visibilité post-signature	data.folder.postSigningVisibility	boolean
Signature humide	data.folder.wetSignatureEnabled	boolean
Fusion activée	data.folder.mergeEnabled	boolean

binary

Il s’agit du type de données de base "binaire".