Partager via

Adobe Acrobat Sign Sandbox

Adobe est le service de connexion de document numérique le plus approuvé dans le monde. Avec Adobe Acrobat Sign, vous pouvez transformer des processus manuels en expériences numériques entières. Incorporez la fonctionnalité Adobe Acrobat Sign dans vos applications préférées pour créer, envoyer et surveiller l’état des contrats.

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

Service classe Régions
Copilot Studio Norme Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Norme Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Norme 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 d’Adobe Acrobat Sign
URL https://helpx.adobe.com/contact/enterprise-support.dc.html#sign
Messagerie électronique support@echosign.zendesk.com
Métadonnées du connecteur
Éditeur Adobe Inc.
Site internet https://acrobat.adobe.com/us/en/sign.html
Politique de confidentialité https://www.adobe.com/privacy/policy.html
Catégories Site internet

Adobe Acrobat Sign Sandbox

Adobe Acrobat Sign Sandbox est un compte de niveau Entreprise modifié dans un environnement discret de l’environnement de production. L’objectif du bac à sable est de permettre aux administrateurs de tester les configurations de paramètre, les appels d’API, les modèles de bibliothèque, les flux de travail personnalisés et les nouvelles fonctionnalités qui approchent de la mise en production.

Éditeur : Adobe, Inc.

Prerequisites

Le compte Adobe Acrobat Sign est requis.

Comment obtenir des informations d’identification

N/A

Bien démarrer avec votre connecteur

N/A

Problèmes connus et limitations

N/A

Erreurs courantes et solutions

N/A

Questions fréquentes (FAQ)

Guide de l’utilisateur du connecteur https://helpx.adobe.com/sign/using/adobesign-sandbox.html

Limitations

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

Actions

Annuler un contrat

Annule le contrat identifié par agreementId dans le chemin d’accès.
Charger un document et obtenir un ID de document

Cette opération charge un document dans votre compte Adobe Acrobat Sign et retourne un ID de document pour celui-ci. Ce document est temporairement stocké dans Adobe Acrobat Sign et l’ID de document peut être utilisé pour d’autres opérations telles que la création d’un contrat.
Charger un document et obtenir un ID de document (ancien) [DÉCONSEILLÉ]

Cette opération charge un document dans votre compte Adobe Acrobat Sign et retourne un ID de document pour celui-ci. Ce document est temporairement stocké dans Adobe Acrobat Sign et l’ID de document peut être utilisé pour d’autres opérations telles que la création d’un contrat.
Créer un contrat à partir d’un contenu de fichier et envoyer une signature

Cette opération crée un contrat à partir d’un fichier dans Adobe Acrobat Sign et l’envoie pour signature.
Créer un contrat à partir d’un document chargé et envoyer la signature (Ancienne) [DÉCONSEILLÉE]

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.
Créer un contrat à partir d’un document chargé et envoyer une signature

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.
Créer un contrat à partir d’un flux de travail et envoyer une signature

Cette opération crée un contrat à partir d’un flux de travail dans Adobe Acrobat Sign et l’envoie pour signature.
Créer un contrat à partir d’un modèle de bibliothèque et envoyer la signature (Ancienne) [DÉPRÉCIÉE]

Cette opération crée un contrat à partir d’un modèle stocké dans la bibliothèque Adobe Acrobat Sign de l’utilisateur et l’envoie pour signature.
Créer un contrat à partir d’un modèle de bibliothèque et envoyer une signature

Cette opération crée un contrat à partir d’un modèle stocké dans la bibliothèque Adobe Acrobat Sign de l’utilisateur et l’envoie pour signature.
Créer un contrat à partir d’une URL de document et envoyer la signature (Ancienne) [DÉCONSEILLÉE]

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.
Créer un contrat à partir d’une URL de document et envoyer une signature

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.
Créer un modèle de bibliothèque à partir d’un document chargé

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’un document chargé. Utilisez ce modèle pour l’envoi de contrats.
Créer un modèle de bibliothèque à partir d’un document chargé (ancien) [DÉCONSEILLÉ]

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’un document chargé. Utilisez ce modèle pour l’envoi de contrats.
Créer un modèle de bibliothèque à partir d’une URL de document

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’une URL de document. Utiliser ce modèle pour l’envoi de contrats
Créer un modèle de bibliothèque à partir d’une URL de document (Ancienne) [DÉCONSEILLÉE]

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’une URL de document. Utiliser ce modèle pour l’envoi de contrats
Obtenir la liste de tous les contrats

Cette opération extrait la liste de tous les contrats de l’utilisateur.
Obtenir la liste de tous les contrats (Ancien) [DÉCONSEILLÉ]

Cette opération extrait la liste de tous les contrats de l’utilisateur.
Obtenir la liste de tous les contrats en fonction des critères de recherche

Cette opération recherche les contrats selon des critères tels que l’ID de flux de travail, etc.
Obtenir la liste de tous les flux de travail

Cette opération extrait la liste de tous les flux de travail de l’utilisateur.
Obtenir la liste de tous les formulaires web

Cette opération extrait la liste de tous les formulaires web de l’utilisateur.
Obtenir la liste de tous les groupes auxquels appartient l’utilisateur

Cette opération extrait la liste de tous les groupes auxquels appartient l’utilisateur.
Obtenir la liste de tous les ID de document d’un accord [DÉPRÉCIÉ]

Cette action a été déconseillée. Utilisez plutôt obtenir la liste de tous les ID de document d’un contrat .

Cette opération extrait les ID de tous les documents et documents de prise en charge d’un accord.
Obtenir la liste de tous les ID de document d’un contrat

Cette opération extrait les ID de tous les documents et documents de prise en charge d’un accord.
Obtenir la liste de tous les modèles de bibliothèque

Cette opération extrait la liste de tous les documents stockés en tant que modèles dans la bibliothèque Adobe Acrobat Sign de l’utilisateur.
Obtenir la liste de tous les modèles de bibliothèque (Ancien) [DÉCONSEILLÉ]

Cette opération extrait la liste de tous les documents stockés en tant que modèles dans la bibliothèque Adobe Acrobat Sign de l’utilisateur.
Obtenir les données de champ de formulaire d’accord (Ancienne) [DÉCONSEILLÉE]

Récupère les données entrées dans les champs de formulaire interactifs du contrat.
Obtenir les données de champ de formulaire d’accord au format CSV

Récupère les données entrées dans les champs de formulaire interactifs du contrat.
Obtenir les données de champ de formulaire d’un contrat au format JSON

Récupère les données entrées dans les champs de formulaire interactifs du contrat.
Obtenir les informations détaillées du flux de travail

Cette opération extrait des informations détaillées sur le flux de travail.
Obtenir l’état d’un contrat

Cette opération extrait toutes les informations actuelles d’un contrat, telles que l’état.
Obtenir l’état d’un contrat [DÉCONSEILLÉ]

Cette action a été déconseillée. Utilisez plutôt l’état d’un contrat .

Cette opération extrait toutes les informations actuelles d’un contrat, telles que l’état.
Obtenir un document à partir d’un accord [DÉPRÉCIÉ]

Cette action a été déconseillée. Utilisez plutôt Obtenir un document à partir d’un contrat .

Cette opération extrait le flux de fichiers d’un document spécifique du contrat.
Obtenir un document à partir d’un contrat

Cette opération extrait le flux de fichiers d’un document spécifique du contrat.
Obtenir un PDF de la piste d’audit de l’accord

Cette opération extrait le flux de fichiers PDF de la piste d’audit du contrat. Notez que le flux de fichiers doit être stocké avec un nom de fichier se terminant par .pdf extension de fichier.
Obtenir un PDF d’un contrat signé

Cette opération extrait le flux de fichiers PDF du contrat combiné ou signé. Notez que le flux de fichiers doit être stocké avec un nom de fichier se terminant par .pdf extension de fichier.
Obtenir un PDF d’un contrat signé [DÉPRÉCIÉ]

Cette action a été déconseillée. Utilisez plutôt obtenir un PDF d’un contrat signé .

Cette opération extrait le flux de fichiers PDF du contrat combiné ou signé. Notez que le flux de fichiers doit être stocké avec un nom de fichier se terminant par .pdf extension de fichier.
Récupérer l’URL de signature

Cette opération récupère l’URL de la page de signature électronique pour le ou les signataires actuels d’un contrat.

Annuler un contrat

ID d’opération :
CancelAgreement

Annule le contrat identifié par agreementId dans le chemin d’accès.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID du contrat à annuler.
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
État d’agrégation
 state string

État dans lequel l’accord devrait atterrir.
Commentaire
 comment string

Commentaire facultatif décrivant la raison de l’annulation aux destinataires.
Autres
 notifyOthers boolean

Indique si vous souhaitez que les destinataires soient avertis ou non.

Charger un document et obtenir un ID de document

ID d’opération :
CreateTransientDocument_V2

Cette opération charge un document dans votre compte Adobe Acrobat Sign et retourne un ID de document pour celui-ci. Ce document est temporairement stocké dans Adobe Acrobat Sign et l’ID de document peut être utilisé pour d’autres opérations telles que la création d’un contrat.

Paramètres

Nom Clé Obligatoire Type Description
Nom du fichier
 File-Name True string

Nom du document à charger, avec l’extension
Contenu du fichier
 File True contentOnly

Flux de fichiers du document à charger
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

JSON qui contient l’ID du document chargé

Corps
TransientDocumentResponse

Charger un document et obtenir un ID de document (ancien) [DÉCONSEILLÉ]

ID d’opération :
CreateTransientDocument

Cette opération charge un document dans votre compte Adobe Acrobat Sign et retourne un ID de document pour celui-ci. Ce document est temporairement stocké dans Adobe Acrobat Sign et l’ID de document peut être utilisé pour d’autres opérations telles que la création d’un contrat.

Paramètres

Nom Clé Obligatoire Type Description
Nom du fichier
 File-Name True string

Nom du document à charger, avec l’extension
Contenu du fichier
 File True contentOnly

Flux de fichiers du document à charger

Retours

JSON qui contient l’ID du document chargé

Corps
TransientDocumentResponse

Créer un contrat à partir d’un contenu de fichier et envoyer une signature

ID d’opération :
CreateAgreementByFileStream

Cette opération crée un contrat à partir d’un fichier dans Adobe Acrobat Sign et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom du contrat
 name True string

Nom de l’accord
Nom
 fileName True string

Nom du document à charger, avec l’extension
Content
 formData True byte

Flux de fichiers du document à charger
Signature Type
 signatureType True string

Type de signature que vous souhaitez demander - signature électronique ou écrite
E-mail du participant
 email True string

E-mail du participant
Authentication
 authenticationMethod string

Authentification par défaut : e-mail (Aucun)
Mot de passe
 password string

Mot de passe requis pour le participant
Code pays
 countryCode string

Code de pays du téléphone du destinataire requis pour afficher et signer le document
Téléphone non.
 phone string

Numéro de téléphone du destinataire requis pour afficher et signer le contrat
JSON
 order True integer

Index commençant par 1, indiquant la position à laquelle le groupe de signature doit signer.
Role
 role True string

Rôles actuels du jeu de participants (signataire, approbateur, etc.).
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné
Message
 message string

Message facultatif aux destinataires demandant leur action
Messagerie électronique
 email string

E-mail du CC du contrat
Délai d’expiration
 expirationTime string

Heure après laquelle le contrat expire. Exemple : 2020-12-31T23:59:00Z
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Mot de passe du document
 openPassword string

Mot de passe qui doit être utilisé pour chiffrer le pdf du contrat signé
Nom
 fieldName string

Nom du champ
Valeur
 defaultValue string

Valeur par défaut du champ
Délai de redirection
 redirectDelay string

Délai (en secondes) avant que l’utilisateur ne soit dirigé vers la page de réussite.
URL de redirection
 redirectUrl string

URL de redirection après avoir terminé le processus de signature, par exemple https://adobe.com
E-mails initiaux
 initEmails string

Contrôler les messages de notification pour les événements d’initiation de contrat.

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponseV6

Créer un contrat à partir d’un document chargé et envoyer la signature (Ancienne) [DÉCONSEILLÉE]

ID d’opération :
CreateAgreementById

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Nom du contrat
 name True string

Nom de l’accord
Document ID
 transientDocumentId True string

ID de document reçu en chargeant un document
Signature Type
 signatureType True string

Type de signature que vous souhaitez demander : signature électronique ou écriture
E-mail du destinataire
 email True string

E-mail du destinataire
Ordre de signature du destinataire
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire
 recipientSetRole True string

Spécifier le rôle du destinataire
Message
 message string

Message facultatif aux destinataires demandant leur action
Jours à échéance
 daysUntilSigningDeadline integer

Nombre de jours qui restent avant l’expiration du document
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Mot de passe du document
 openPassword string

Mot de passe qui doit être utilisé pour chiffrer le pdf du contrat signé
ID de document (2)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (3)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (4)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (5)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (6)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (7)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (8)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (9)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (10)
 transientDocumentId string

ID de document reçu en chargeant un document
E-mail du destinataire (2)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (2)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (2)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (3)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (3)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (3)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (4)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (4)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (4)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (5)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (5)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (5)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (6)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (6)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (6)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (7)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (7)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (7)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (8)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (8)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (8)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (9)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (9)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (9)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (10)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (10)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (10)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (11)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (11)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (11)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (12)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (12)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (12)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (13)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (13)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (13)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (14)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (14)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (14)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (15)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (15)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (15)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (16)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (16)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (16)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (17)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (17)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (17)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (18)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (18)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (18)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (19)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (19)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (19)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (20)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (20)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (20)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (21)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (21)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (21)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (22)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (22)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (22)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (23)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (23)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (23)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (24)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (24)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (24)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (25)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (25)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (25)
 recipientSetRole True string

Spécifier le rôle du destinataire
Nom du champ formulaire (1)
 fieldName string

Nom du champ
Valeur du champ formulaire (1)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (2)
 fieldName string

Nom du champ
Valeur du champ formulaire (2)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (3)
 fieldName string

Nom du champ
Valeur du champ formulaire (3)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (4)
 fieldName string

Nom du champ
Valeur du champ formulaire (4)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (5)
 fieldName string

Nom du champ
Valeur du champ formulaire (5)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (6)
 fieldName string

Nom du champ
Valeur du champ formulaire (6)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (7)
 fieldName string

Nom du champ
Valeur du champ formulaire (7)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (8)
 fieldName string

Nom du champ
Valeur du champ formulaire (8)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (9)
 fieldName string

Nom du champ
Valeur du champ formulaire (9)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (10)
 fieldName string

Nom du champ
Valeur du champ formulaire (10)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (11)
 fieldName string

Nom du champ
Valeur du champ formulaire (11)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (12)
 fieldName string

Nom du champ
Valeur du champ formulaire (12)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (13)
 fieldName string

Nom du champ
Valeur du champ formulaire (13)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (14)
 fieldName string

Nom du champ
Valeur du champ formulaire (14)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (15)
 fieldName string

Nom du champ
Valeur du champ formulaire (15)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (16)
 fieldName string

Nom du champ
Valeur du champ formulaire (16)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (17)
 fieldName string

Nom du champ
Valeur du champ formulaire (17)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (18)
 fieldName string

Nom du champ
Valeur du champ formulaire (18)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (19)
 fieldName string

Nom du champ
Valeur du champ formulaire (19)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (20)
 fieldName string

Nom du champ
Valeur du champ formulaire (20)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (21)
 fieldName string

Nom du champ
Valeur du champ formulaire (21)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (22)
 fieldName string

Nom du champ
Valeur du champ formulaire (22)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (23)
 fieldName string

Nom du champ
Valeur du champ formulaire (23)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (24)
 fieldName string

Nom du champ
Valeur du champ formulaire (24)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (25)
 fieldName string

Nom du champ
Valeur du champ formulaire (25)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (26)
 fieldName string

Nom du champ
Valeur du champ formulaire (26)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (27)
 fieldName string

Nom du champ
Valeur du champ formulaire (27)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (28)
 fieldName string

Nom du champ
Valeur du champ formulaire (28)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (29)
 fieldName string

Nom du champ
Valeur du champ formulaire (29)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (30)
 fieldName string

Nom du champ
Valeur du champ formulaire (30)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (31)
 fieldName string

Nom du champ
Valeur du champ formulaire (31)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (32)
 fieldName string

Nom du champ
Valeur du champ formulaire (32)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (33)
 fieldName string

Nom du champ
Valeur du champ formulaire (33)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (34)
 fieldName string

Nom du champ
Valeur du champ formulaire (34)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (35)
 fieldName string

Nom du champ
Valeur du champ formulaire (35)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (36)
 fieldName string

Nom du champ
Valeur du champ formulaire (36)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (37)
 fieldName string

Nom du champ
Valeur du champ formulaire (37)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (38)
 fieldName string

Nom du champ
Valeur du champ formulaire (38)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (39)
 fieldName string

Nom du champ
Valeur du champ formulaire (39)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (40)
 fieldName string

Nom du champ
Valeur du champ formulaire (40)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (41)
 fieldName string

Nom du champ
Valeur du champ formulaire (41)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (42)
 fieldName string

Nom du champ
Valeur du champ formulaire (42)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (43)
 fieldName string

Nom du champ
Valeur du champ formulaire (43)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (44)
 fieldName string

Nom du champ
Valeur du champ formulaire (44)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (45)
 fieldName string

Nom du champ
Valeur du champ formulaire (45)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (46)
 fieldName string

Nom du champ
Valeur du champ formulaire (46)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (47)
 fieldName string

Nom du champ
Valeur du champ formulaire (47)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (48)
 fieldName string

Nom du champ
Valeur du champ formulaire (48)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (49)
 fieldName string

Nom du champ
Valeur du champ formulaire (49)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (50)
 fieldName string

Nom du champ
Valeur du champ formulaire (50)
 defaultValue string

Valeur par défaut du champ

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponse

Créer un contrat à partir d’un document chargé et envoyer une signature

ID d’opération :
CreateAgreementById_V2

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom du contrat
 name True string

Nom de l’accord
ID
 transientDocumentId True string

ID de document reçu en chargeant un document temporaire
Signature Type
 signatureType True string

Type de signature que vous souhaitez demander - signature électronique ou écrite
E-mail du participant
 email True string

E-mail du participant
Authentication
 authenticationMethod string

Authentification par défaut : e-mail (Aucun)
Mot de passe
 password string

Mot de passe requis pour le participant
Code pays
 countryCode string

Code de pays du téléphone du destinataire requis pour afficher et signer le document
Téléphone non.
 phone string

Numéro de téléphone du destinataire requis pour afficher et signer le contrat
JSON
 order True integer

Index commençant par 1, indiquant la position à laquelle le groupe de signature doit signer.
Role
 role True string

Rôles actuels du jeu de participants (signataire, approbateur, etc.).
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné
Message
 message string

Message facultatif aux destinataires demandant leur action
Messagerie électronique
 email string

E-mail du CC du contrat
Délai d’expiration
 expirationTime string

Heure après laquelle le contrat expire. Exemple : 2020-12-31T23:59:00Z
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Mot de passe du document
 openPassword string

Mot de passe qui doit être utilisé pour chiffrer le pdf du contrat signé
Nom
 fieldName string

Nom du champ
Valeur
 defaultValue string

Valeur par défaut du champ
Délai de redirection
 redirectDelay string

Délai (en secondes) avant que l’utilisateur ne soit dirigé vers la page de réussite.
URL de redirection
 redirectUrl string

URL de redirection après avoir terminé le processus de signature, par exemple https://adobe.com
E-mails initiaux
 initEmails string

Contrôler les messages de notification pour les événements d’initiation de contrat.

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponseV6

Créer un contrat à partir d’un flux de travail et envoyer une signature

ID d’opération :
CreateAgreementFromWorkflow

Cette opération crée un contrat à partir d’un flux de travail dans Adobe Acrobat Sign et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user True string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom/ID du groupe
 groupId True string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné
Nom/ID du flux de travail
 workflowIdParam True string

Sélectionnez un flux de travail personnalisé dans la liste ou entrez l’ID de flux de travail personnalisé.
agreementWorkflowSchema
 agreementWorkflowSchema True dynamic

Détails de l’événement sélectionné.

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponseV6

Créer un contrat à partir d’un modèle de bibliothèque et envoyer la signature (Ancienne) [DÉPRÉCIÉE]

ID d’opération :
CreateAgreementByTemplate

Cette opération crée un contrat à partir d’un modèle stocké dans la bibliothèque Adobe Acrobat Sign de l’utilisateur et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Nom du contrat
 name True string

Nom de l’accord
Modèle de bibliothèque de documents
 libraryDocumentId True string

Choisir un document dans les modèles stockés dans votre bibliothèque
Signature Type
 signatureType True string

Type de signature que vous souhaitez demander : signature électronique ou écriture
E-mail du destinataire
 email True string

E-mail du destinataire
Ordre de signature du destinataire
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire
 recipientSetRole True string

Spécifier le rôle du destinataire
Message
 message string

Message facultatif aux destinataires demandant leur action
Jours à échéance
 daysUntilSigningDeadline integer

Nombre de jours qui restent avant l’expiration du document
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Mot de passe du document
 openPassword string

Mot de passe qui doit être utilisé pour chiffrer le pdf du contrat signé
Modèle de bibliothèque de documents (2)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (3)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (4)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (5)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (6)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (7)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (8)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (9)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
Modèle de bibliothèque de documents (10)
 libraryDocumentId string

Choisir un document dans les modèles stockés dans votre bibliothèque
E-mail du destinataire (2)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (2)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (2)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (3)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (3)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (3)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (4)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (4)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (4)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (5)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (5)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (5)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (6)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (6)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (6)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (7)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (7)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (7)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (8)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (8)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (8)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (9)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (9)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (9)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (10)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (10)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (10)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (11)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (11)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (11)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (12)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (12)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (12)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (13)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (13)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (13)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (14)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (14)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (14)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (15)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (15)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (15)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (16)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (16)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (16)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (17)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (17)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (17)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (18)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (18)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (18)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (19)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (19)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (19)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (20)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (20)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (20)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (21)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (21)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (21)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (22)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (22)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (22)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (23)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (23)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (23)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (24)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (24)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (24)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (25)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (25)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (25)
 recipientSetRole True string

Spécifier le rôle du destinataire
Nom du champ formulaire (1)
 fieldName string

Nom du champ
Valeur du champ formulaire (1)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (2)
 fieldName string

Nom du champ
Valeur du champ formulaire (2)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (3)
 fieldName string

Nom du champ
Valeur du champ formulaire (3)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (4)
 fieldName string

Nom du champ
Valeur du champ formulaire (4)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (5)
 fieldName string

Nom du champ
Valeur du champ formulaire (5)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (6)
 fieldName string

Nom du champ
Valeur du champ formulaire (6)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (7)
 fieldName string

Nom du champ
Valeur du champ formulaire (7)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (8)
 fieldName string

Nom du champ
Valeur du champ formulaire (8)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (9)
 fieldName string

Nom du champ
Valeur du champ formulaire (9)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (10)
 fieldName string

Nom du champ
Valeur du champ formulaire (10)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (11)
 fieldName string

Nom du champ
Valeur du champ formulaire (11)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (12)
 fieldName string

Nom du champ
Valeur du champ formulaire (12)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (13)
 fieldName string

Nom du champ
Valeur du champ formulaire (13)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (14)
 fieldName string

Nom du champ
Valeur du champ formulaire (14)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (15)
 fieldName string

Nom du champ
Valeur du champ formulaire (15)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (16)
 fieldName string

Nom du champ
Valeur du champ formulaire (16)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (17)
 fieldName string

Nom du champ
Valeur du champ formulaire (17)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (18)
 fieldName string

Nom du champ
Valeur du champ formulaire (18)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (19)
 fieldName string

Nom du champ
Valeur du champ formulaire (19)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (20)
 fieldName string

Nom du champ
Valeur du champ formulaire (20)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (21)
 fieldName string

Nom du champ
Valeur du champ formulaire (21)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (22)
 fieldName string

Nom du champ
Valeur du champ formulaire (22)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (23)
 fieldName string

Nom du champ
Valeur du champ formulaire (23)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (24)
 fieldName string

Nom du champ
Valeur du champ formulaire (24)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (25)
 fieldName string

Nom du champ
Valeur du champ formulaire (25)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (26)
 fieldName string

Nom du champ
Valeur du champ formulaire (26)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (27)
 fieldName string

Nom du champ
Valeur du champ formulaire (27)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (28)
 fieldName string

Nom du champ
Valeur du champ formulaire (28)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (29)
 fieldName string

Nom du champ
Valeur du champ formulaire (29)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (30)
 fieldName string

Nom du champ
Valeur du champ formulaire (30)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (31)
 fieldName string

Nom du champ
Valeur du champ formulaire (31)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (32)
 fieldName string

Nom du champ
Valeur du champ formulaire (32)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (33)
 fieldName string

Nom du champ
Valeur du champ formulaire (33)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (34)
 fieldName string

Nom du champ
Valeur du champ formulaire (34)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (35)
 fieldName string

Nom du champ
Valeur du champ formulaire (35)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (36)
 fieldName string

Nom du champ
Valeur du champ formulaire (36)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (37)
 fieldName string

Nom du champ
Valeur du champ formulaire (37)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (38)
 fieldName string

Nom du champ
Valeur du champ formulaire (38)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (39)
 fieldName string

Nom du champ
Valeur du champ formulaire (39)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (40)
 fieldName string

Nom du champ
Valeur du champ formulaire (40)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (41)
 fieldName string

Nom du champ
Valeur du champ formulaire (41)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (42)
 fieldName string

Nom du champ
Valeur du champ formulaire (42)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (43)
 fieldName string

Nom du champ
Valeur du champ formulaire (43)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (44)
 fieldName string

Nom du champ
Valeur du champ formulaire (44)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (45)
 fieldName string

Nom du champ
Valeur du champ formulaire (45)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (46)
 fieldName string

Nom du champ
Valeur du champ formulaire (46)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (47)
 fieldName string

Nom du champ
Valeur du champ formulaire (47)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (48)
 fieldName string

Nom du champ
Valeur du champ formulaire (48)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (49)
 fieldName string

Nom du champ
Valeur du champ formulaire (49)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (50)
 fieldName string

Nom du champ
Valeur du champ formulaire (50)
 defaultValue string

Valeur par défaut du champ

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponse

Créer un contrat à partir d’un modèle de bibliothèque et envoyer une signature

ID d’opération :
CreateAgreementByTemplate_V2

Cette opération crée un contrat à partir d’un modèle stocké dans la bibliothèque Adobe Acrobat Sign de l’utilisateur et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom du contrat
 name True string

Nom de l’accord
Template
 libraryDocumentId True string

Choisir un document dans les modèles stockés dans votre bibliothèque
Signature Type
 signatureType True string

Type de signature que vous souhaitez demander - signature électronique ou écrite
E-mail du participant
 email True string

E-mail du participant
Authentication
 authenticationMethod string

Authentification par défaut : e-mail (Aucun)
Mot de passe
 password string

Mot de passe requis pour le participant
Code pays
 countryCode string

Code de pays du téléphone du destinataire requis pour afficher et signer le document
Téléphone non.
 phone string

Numéro de téléphone du destinataire requis pour afficher et signer le contrat
JSON
 order True integer

Index commençant par 1, indiquant la position à laquelle le groupe de signature doit signer.
Role
 role True string

Rôles actuels du jeu de participants (signataire, approbateur, etc.).
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné
Message
 message string

Message facultatif aux destinataires demandant leur action
Messagerie électronique
 email string

E-mail du CC du contrat
Délai d’expiration
 expirationTime string

Heure après laquelle le contrat expire. Exemple : 2020-12-31T23:59:00Z
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Mot de passe du document
 openPassword string

Mot de passe qui doit être utilisé pour chiffrer le pdf du contrat signé
Nom
 fieldName string

Nom du champ
Valeur
 defaultValue string

Valeur par défaut du champ
Délai de redirection
 redirectDelay string

Délai (en secondes) avant que l’utilisateur ne soit dirigé vers la page de réussite.
URL de redirection
 redirectUrl string

URL de redirection après avoir terminé le processus de signature, par exemple https://adobe.com
E-mails initiaux
 initEmails string

Contrôler les messages de notification pour les événements d’initiation de contrat.

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponseV6

Créer un contrat à partir d’une URL de document et envoyer la signature (Ancienne) [DÉCONSEILLÉE]

ID d’opération :
CreateAgreementByUrl

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Nom du contrat
 name True string

Nom de l’accord
URL
 url True string

URL accessible publiquement pour récupérer le document
Nom
 name True string

Nom du document référencé, avec extension
Signature Type
 signatureType True string

Type de signature que vous souhaitez demander : signature électronique ou écriture
E-mail du destinataire
 email True string

E-mail du destinataire
Ordre de signature du destinataire
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire
 recipientSetRole True string

Spécifier le rôle du destinataire
Message
 message string

Message facultatif aux destinataires demandant leur action
Jours à échéance
 daysUntilSigningDeadline integer

Nombre de jours qui restent avant l’expiration du document
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Mot de passe du document
 openPassword string

Mot de passe qui doit être utilisé pour chiffrer le pdf du contrat signé
URL (2)
 url string

URL accessible publiquement pour récupérer le document
Nom (2)
 name string

Nom du document référencé, avec extension
URL (3)
 url string

URL accessible publiquement pour récupérer le document
Nom (3)
 name string

Nom du document référencé, avec extension
URL (4)
 url string

URL accessible publiquement pour récupérer le document
Nom (4)
 name string

Nom du document référencé, avec extension
URL (5)
 url string

URL accessible publiquement pour récupérer le document
Nom (5)
 name string

Nom du document référencé, avec extension
URL (6)
 url string

URL accessible publiquement pour récupérer le document
Nom (6)
 name string

Nom du document référencé, avec extension
URL (7)
 url string

URL accessible publiquement pour récupérer le document
Nom (7)
 name string

Nom du document référencé, avec extension
URL (8)
 url string

URL accessible publiquement pour récupérer le document
Nom (8)
 name string

Nom du document référencé, avec extension
URL (9)
 url string

URL accessible publiquement pour récupérer le document
Nom (9)
 name string

Nom du document référencé, avec extension
URL (10)
 url string

URL accessible publiquement pour récupérer le document
Nom (10)
 name string

Nom du document référencé, avec extension
E-mail du destinataire (2)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (2)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (2)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (3)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (3)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (3)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (4)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (4)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (4)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (5)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (5)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (5)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (6)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (6)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (6)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (7)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (7)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (7)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (8)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (8)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (8)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (9)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (9)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (9)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (10)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (10)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (10)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (11)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (11)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (11)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (12)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (12)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (12)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (13)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (13)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (13)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (14)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (14)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (14)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (15)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (15)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (15)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (16)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (16)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (16)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (17)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (17)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (17)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (18)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (18)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (18)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (19)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (19)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (19)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (20)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (20)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (20)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (21)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (21)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (21)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (22)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (22)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (22)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (23)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (23)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (23)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (24)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (24)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (24)
 recipientSetRole True string

Spécifier le rôle du destinataire
E-mail du destinataire (25)
 email True string

E-mail du destinataire
Ordre de signature du destinataire (25)
 signingOrder True integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
Rôle de destinataire (25)
 recipientSetRole True string

Spécifier le rôle du destinataire
Nom du champ formulaire (1)
 fieldName string

Nom du champ
Valeur du champ formulaire (1)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (2)
 fieldName string

Nom du champ
Valeur du champ formulaire (2)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (3)
 fieldName string

Nom du champ
Valeur du champ formulaire (3)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (4)
 fieldName string

Nom du champ
Valeur du champ formulaire (4)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (5)
 fieldName string

Nom du champ
Valeur du champ formulaire (5)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (6)
 fieldName string

Nom du champ
Valeur du champ formulaire (6)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (7)
 fieldName string

Nom du champ
Valeur du champ formulaire (7)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (8)
 fieldName string

Nom du champ
Valeur du champ formulaire (8)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (9)
 fieldName string

Nom du champ
Valeur du champ formulaire (9)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (10)
 fieldName string

Nom du champ
Valeur du champ formulaire (10)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (11)
 fieldName string

Nom du champ
Valeur du champ formulaire (11)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (12)
 fieldName string

Nom du champ
Valeur du champ formulaire (12)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (13)
 fieldName string

Nom du champ
Valeur du champ formulaire (13)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (14)
 fieldName string

Nom du champ
Valeur du champ formulaire (14)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (15)
 fieldName string

Nom du champ
Valeur du champ formulaire (15)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (16)
 fieldName string

Nom du champ
Valeur du champ formulaire (16)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (17)
 fieldName string

Nom du champ
Valeur du champ formulaire (17)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (18)
 fieldName string

Nom du champ
Valeur du champ formulaire (18)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (19)
 fieldName string

Nom du champ
Valeur du champ formulaire (19)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (20)
 fieldName string

Nom du champ
Valeur du champ formulaire (20)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (21)
 fieldName string

Nom du champ
Valeur du champ formulaire (21)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (22)
 fieldName string

Nom du champ
Valeur du champ formulaire (22)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (23)
 fieldName string

Nom du champ
Valeur du champ formulaire (23)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (24)
 fieldName string

Nom du champ
Valeur du champ formulaire (24)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (25)
 fieldName string

Nom du champ
Valeur du champ formulaire (25)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (26)
 fieldName string

Nom du champ
Valeur du champ formulaire (26)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (27)
 fieldName string

Nom du champ
Valeur du champ formulaire (27)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (28)
 fieldName string

Nom du champ
Valeur du champ formulaire (28)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (29)
 fieldName string

Nom du champ
Valeur du champ formulaire (29)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (30)
 fieldName string

Nom du champ
Valeur du champ formulaire (30)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (31)
 fieldName string

Nom du champ
Valeur du champ formulaire (31)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (32)
 fieldName string

Nom du champ
Valeur du champ formulaire (32)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (33)
 fieldName string

Nom du champ
Valeur du champ formulaire (33)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (34)
 fieldName string

Nom du champ
Valeur du champ formulaire (34)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (35)
 fieldName string

Nom du champ
Valeur du champ formulaire (35)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (36)
 fieldName string

Nom du champ
Valeur du champ formulaire (36)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (37)
 fieldName string

Nom du champ
Valeur du champ formulaire (37)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (38)
 fieldName string

Nom du champ
Valeur du champ formulaire (38)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (39)
 fieldName string

Nom du champ
Valeur du champ formulaire (39)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (40)
 fieldName string

Nom du champ
Valeur du champ formulaire (40)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (41)
 fieldName string

Nom du champ
Valeur du champ formulaire (41)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (42)
 fieldName string

Nom du champ
Valeur du champ formulaire (42)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (43)
 fieldName string

Nom du champ
Valeur du champ formulaire (43)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (44)
 fieldName string

Nom du champ
Valeur du champ formulaire (44)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (45)
 fieldName string

Nom du champ
Valeur du champ formulaire (45)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (46)
 fieldName string

Nom du champ
Valeur du champ formulaire (46)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (47)
 fieldName string

Nom du champ
Valeur du champ formulaire (47)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (48)
 fieldName string

Nom du champ
Valeur du champ formulaire (48)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (49)
 fieldName string

Nom du champ
Valeur du champ formulaire (49)
 defaultValue string

Valeur par défaut du champ
Nom du champ formulaire (50)
 fieldName string

Nom du champ
Valeur du champ formulaire (50)
 defaultValue string

Valeur par défaut du champ

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponse

Créer un contrat à partir d’une URL de document et envoyer une signature

ID d’opération :
CreateAgreementByUrl_V2

Cette opération crée un contrat à partir d’un document chargé dans Adobe Acrobat Sign et l’envoie pour signature.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom du contrat
 name True string

Nom de l’accord
URL
 url True string

URL accessible publiquement pour récupérer le contenu du fichier brut
Nom
 name True string

Nom de fichier système d’origine du document en cours d’envoi
Type
 mimeType True string

Type mime du fichier référencé, par exemple application/pdf
Signature Type
 signatureType True string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
E-mail du participant
 email True string

E-mail du participant
Authentication
 authenticationMethod string

Authentification par défaut : e-mail (Aucun)
Mot de passe
 password string

Mot de passe requis pour le participant
Code pays
 countryCode string

Code de pays du téléphone du destinataire requis pour afficher et signer le document
Téléphone non.
 phone string

Numéro de téléphone du destinataire requis pour afficher et signer le contrat
JSON
 order True integer

Index commençant par 1, indiquant la position à laquelle le groupe de signature doit signer.
Role
 role True string

Rôles actuels du jeu de participants (signataire, approbateur, etc.).
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné
Message
 message string

Message facultatif aux destinataires demandant leur action
Messagerie électronique
 email string

E-mail du CC du contrat
Délai d’expiration
 expirationTime string

Heure après laquelle le contrat expire. Exemple : 2020-12-31T23:59:00Z
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Mot de passe du document
 openPassword string

Mot de passe qui doit être utilisé pour chiffrer le pdf du contrat signé
Nom
 fieldName string

Nom du champ
Valeur
 defaultValue string

Valeur par défaut du champ
Délai de redirection
 redirectDelay string

Délai (en secondes) avant que l’utilisateur ne soit dirigé vers la page de réussite.
URL de redirection
 redirectUrl string

URL de redirection après avoir terminé le processus de signature, par exemple https://adobe.com
E-mails initiaux
 initEmails string

Contrôler les messages de notification pour les événements d’initiation de contrat.

Retours

JSON qui contient l’ID du contrat nouvellement créé

Corps
AgreementCreationResponseV6

Créer un modèle de bibliothèque à partir d’un document chargé

ID d’opération :
CreateLibraryDocumentById_V2

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’un document chargé. Utilisez ce modèle pour l’envoi de contrats.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom de modèle
 name True string

Nom du contrat utilisé pour identifier le modèle
Type de modèle
 templateTypes True array of string

Liste d’un ou de plusieurs types de modèles de bibliothèque
Mode de partage
 sharingMode True string

Spécifie qui doit avoir accès à ce document de bibliothèque
ID
 transientDocumentId True string

ID de document reçu en chargeant un document temporaire
État du modèle
 state True string

État du document de bibliothèque.
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné

Retours

Objet JSON décrivant le modèle de bibliothèque

Corps
LibraryDocumentCreationResponseV6

Créer un modèle de bibliothèque à partir d’un document chargé (ancien) [DÉCONSEILLÉ]

ID d’opération :
CreateLibraryDocumentById

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’un document chargé. Utilisez ce modèle pour l’envoi de contrats.

Paramètres

Nom Clé Obligatoire Type Description
Nom de modèle
 name True string

Nom du contrat utilisé pour identifier le modèle
Type de modèle
 libraryTemplateTypes True string

Liste d’un ou de plusieurs types de modèles de bibliothèque
Partager avec
 librarySharingMode True string

Spécifie qui doit avoir accès à ce document de bibliothèque
Document ID
 transientDocumentId True string

ID de document reçu en chargeant un document
ID de document (2)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (3)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (4)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (5)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (6)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (7)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (8)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (9)
 transientDocumentId string

ID de document reçu en chargeant un document
ID de document (10)
 transientDocumentId string

ID de document reçu en chargeant un document

Retours

Objet JSON décrivant le modèle de bibliothèque

Corps
LibraryDocumentCreationResponse

Créer un modèle de bibliothèque à partir d’une URL de document

ID d’opération :
CreateLibraryDocumentByUrl_V2

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’une URL de document. Utiliser ce modèle pour l’envoi de contrats

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom de modèle
 name True string

Nom du contrat utilisé pour identifier le modèle
Type de modèle
 templateTypes True array of string

Liste d’un ou de plusieurs types de modèles de bibliothèque
Mode de partage
 sharingMode True string

Spécifie qui doit avoir accès à ce document de bibliothèque
URL
 url True string

URL accessible publiquement pour récupérer le contenu du fichier brut
Nom
 name True string

Nom de fichier système d’origine du document en cours d’envoi
Type
 mimeType True string

Type mime du fichier référencé, par exemple application/pdf
État du modèle
 state True string

État du document de bibliothèque.
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné

Retours

Objet JSON décrivant le modèle de bibliothèque

Corps
LibraryDocumentCreationResponseV6

Créer un modèle de bibliothèque à partir d’une URL de document (Ancienne) [DÉCONSEILLÉE]

ID d’opération :
CreateLibraryDocumentByUrl

Cette opération crée un modèle dans la bibliothèque Adobe Acrobat Sign à partir d’une URL de document. Utiliser ce modèle pour l’envoi de contrats

Paramètres

Nom Clé Obligatoire Type Description
Nom de modèle
 name True string

Nom du contrat utilisé pour identifier le modèle
Type de modèle
 libraryTemplateTypes True string

Liste d’un ou de plusieurs types de modèles de bibliothèque
Partager avec
 librarySharingMode True string

Spécifie qui doit avoir accès à ce document de bibliothèque
URL
 url True string

URL accessible publiquement pour récupérer le document
Nom
 name True string

Nom du document référencé, avec extension
URL (2)
 url string

URL accessible publiquement pour récupérer le document
Nom (2)
 name string

Nom du document référencé, avec extension
URL (3)
 url string

URL accessible publiquement pour récupérer le document
Nom (3)
 name string

Nom du document référencé, avec extension
URL (4)
 url string

URL accessible publiquement pour récupérer le document
Nom (4)
 name string

Nom du document référencé, avec extension
URL (5)
 url string

URL accessible publiquement pour récupérer le document
Nom (5)
 name string

Nom du document référencé, avec extension
URL (6)
 url string

URL accessible publiquement pour récupérer le document
Nom (6)
 name string

Nom du document référencé, avec extension
URL (7)
 url string

URL accessible publiquement pour récupérer le document
Nom (7)
 name string

Nom du document référencé, avec extension
URL (8)
 url string

URL accessible publiquement pour récupérer le document
Nom (8)
 name string

Nom du document référencé, avec extension
URL (9)
 url string

URL accessible publiquement pour récupérer le document
Nom (9)
 name string

Nom du document référencé, avec extension
URL (10)
 url string

URL accessible publiquement pour récupérer le document
Nom (10)
 name string

Nom du document référencé, avec extension

Retours

Objet JSON décrivant le modèle de bibliothèque

Corps
LibraryDocumentCreationResponse

Obtenir la liste de tous les contrats

ID d’opération :
GetAllAgreements_V2

Cette opération extrait la liste de tous les contrats de l’utilisateur.

Paramètres

Nom Clé Obligatoire Type Description
Cursor
 cursor string

Permet de parcourir les pages. S’il n’est pas fourni, retourne la première page.
Taille de page
 pageSize integer

Nombre d’éléments dans la page de réponse. Par défaut : 100 ; Max : 10000
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné

Retours

JSON qui contient l’objet tableau de contrats utilisateur

Corps
userAgreementListV6

Obtenir la liste de tous les contrats (Ancien) [DÉCONSEILLÉ]

ID d’opération :
GetAllAgreements

Cette opération extrait la liste de tous les contrats de l’utilisateur.

Retours

JSON qui contient l’objet tableau de contrats utilisateur

Corps
UserAgreements

Obtenir la liste de tous les contrats en fonction des critères de recherche

ID d’opération :
SearchAgreements

Cette opération recherche les contrats selon des critères tels que l’ID de flux de travail, etc.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné
Nom/ID du flux de travail
 workflowId string

Sélectionnez un flux de travail personnalisé dans la liste ou entrez l’ID de flux de travail personnalisé.
Créé après
 gt string

Date et heure minimale autorisées. Exemple : 2020-12-31T23:59:00Z
Créé avant
 lt string

Date et heure maximale autorisées. Exemple : 2023-12-31T23:59:00Z
Taille de page
 pageSize integer

Nombre d’éléments dans la page de réponse. Par défaut : 50 ; Max : 500
Index de début
 startIndex integer

Première ligne basée sur 0 (décalage) des résultats de la recherche à retourner.

Retours

JSON qui contient l’objet tableau de contrats utilisateur

Corps
userAgreementListV6

Obtenir la liste de tous les flux de travail

ID d’opération :
GetAllWorkflows

Cette opération extrait la liste de tous les flux de travail de l’utilisateur.

Paramètres

Nom Clé Obligatoire Type Description
Inclure des flux de travail brouillons
 includeDraftWorkflows boolean

Inclure des flux de travail brouillons
Inclure des flux de travail inactifs
 includeInactiveWorkflows boolean

Inclure des flux de travail inactifs
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné

Retours

JSON qui contient l’objet de tableau de flux de travail utilisateur

Corps
userWorkflowListV6

Obtenir la liste de tous les formulaires web

ID d’opération :
GetAllWebForms

Cette opération extrait la liste de tous les formulaires web de l’utilisateur.

Paramètres

Nom Clé Obligatoire Type Description
Cursor
 cursor string

Permet de parcourir les pages. S’il n’est pas fourni, retourne la première page.
Taille de page
 pageSize integer

Nombre d’éléments dans la page de réponse. Par défaut : 100 ; Max : 10000
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné

Retours

JSON qui contient l’objet de tableau de formulaires web utilisateur

Corps
userWidgetListV6

Obtenir la liste de tous les groupes auxquels appartient l’utilisateur

ID d’opération :
GetAllUserGroups

Cette opération extrait la liste de tous les groupes auxquels appartient l’utilisateur.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
ID d’utilisateur
 userId True string

Pour obtenir le résultat de l’utilisateur autorisé, l’ID utilisateur peut être remplacé par « moi » sans guillemets.

Retours

JSON qui contient la liste des groupes pour un utilisateur donné

Corps
UserGroupsInfoV6

Obtenir la liste de tous les ID de document d’un accord [DÉPRÉCIÉ]

ID d’opération :
GetAllDocumentsofAnAgreement

Cette action a été déconseillée. Utilisez plutôt obtenir la liste de tous les ID de document d’un contrat .

Cette opération extrait les ID de tous les documents et documents de prise en charge d’un accord.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les documents sont nécessaires
Documents de prise en charge - Type de contenu
 supportingDocumentContentFormat string

Type de contenu des documents de support de l’accord

Retours

JSON qui contient à la fois les documents et les objets de tableau de documents de prise en charge

Corps
AgreementDocuments

Obtenir la liste de tous les ID de document d’un contrat

ID d’opération :
GetAllDocumentsofAnAgreement_V2

Cette opération extrait les ID de tous les documents et documents de prise en charge d’un accord.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les documents sont nécessaires
Documents de prise en charge - Type de contenu
 supportingDocumentContentFormat string

Type de contenu des documents de support de l’accord
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

JSON qui contient à la fois les documents et les objets de tableau de documents de prise en charge

Corps
AgreementDocumentsV6

Obtenir la liste de tous les modèles de bibliothèque

ID d’opération :
GetLibraryDocuments_V2

Cette opération extrait la liste de tous les documents stockés en tant que modèles dans la bibliothèque Adobe Acrobat Sign de l’utilisateur.

Paramètres

Nom Clé Obligatoire Type Description
Cursor
 cursor string

Permet de parcourir les pages. S’il n’est pas fourni, retourne la première page.
Taille de page
 pageSize integer

Nombre d’éléments dans la page de réponse. Par défaut : 100 ; Max : 10000
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné

Retours

JSON qui contient l’objet de tableau de modèles de bibliothèque

Corps
LibraryDocuments

Obtenir la liste de tous les modèles de bibliothèque (Ancien) [DÉCONSEILLÉ]

ID d’opération :
GetLibraryDocuments

Cette opération extrait la liste de tous les documents stockés en tant que modèles dans la bibliothèque Adobe Acrobat Sign de l’utilisateur.

Retours

JSON qui contient l’objet de tableau de modèles de bibliothèque

Corps
DocumentLibraryItems

Obtenir les données de champ de formulaire d’accord (Ancienne) [DÉCONSEILLÉE]

ID d’opération :
GetAgreementFormFieldData

Récupère les données entrées dans les champs de formulaire interactifs du contrat.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les informations sont nécessaires

Retours

response
file

Obtenir les données de champ de formulaire d’accord au format CSV

ID d’opération :
GetAgreementFormFieldData_V2

Récupère les données entrées dans les champs de formulaire interactifs du contrat.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les informations sont nécessaires
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

Contenu des données de formulaire

Contenu des données de formulaire
binary

Obtenir les données de champ de formulaire d’un contrat au format JSON

ID d’opération :
GetAgreementFormFieldData_V3

Récupère les données entrées dans les champs de formulaire interactifs du contrat.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les informations sont nécessaires
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

Contenu des données de formulaire

Contenu des données de formulaire
object

Obtenir les informations détaillées du flux de travail

ID d’opération :
GetWorkflowInfo

Cette opération extrait des informations détaillées sur le flux de travail.

Paramètres

Nom Clé Obligatoire Type Description
ID de flux de travail
 workflowId True string

ID de flux de travail du flux de travail dont les informations sont nécessaires
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
Nom/ID du groupe
 groupId string

ID du groupe. Pour utiliser ce champ : « In The Name Of » doit être sélectionné

Retours

JSON qui contient des informations détaillées sur le flux de travail

Corps
WorkflowDescriptionV6

Obtenir l’état d’un contrat

ID d’opération :
GetAgreementInfo_V2

Cette opération extrait toutes les informations actuelles d’un contrat, telles que l’état.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les informations sont nécessaires
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

Détails complets de l’accord

Corps
AgreementInfoV6

Obtenir l’état d’un contrat [DÉCONSEILLÉ]

ID d’opération :
GetAgreementInfo

Cette action a été déconseillée. Utilisez plutôt l’état d’un contrat .

Cette opération extrait toutes les informations actuelles d’un contrat, telles que l’état.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les informations sont nécessaires

Retours

Détails complets sur l’accord

Corps
AgreementInfo

Obtenir un document à partir d’un accord [DÉPRÉCIÉ]

ID d’opération :
GetDocument

Cette action a été déconseillée. Utilisez plutôt Obtenir un document à partir d’un contrat .

Cette opération extrait le flux de fichiers d’un document spécifique du contrat.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont le document est nécessaire
Document ID
 documentId True string

ID de document du document spécifique de l’accord

Retours

Flux de fichiers du document

response
DocumentResponse

Obtenir un document à partir d’un contrat

ID d’opération :
GetDocument_V2

Cette opération extrait le flux de fichiers d’un document spécifique du contrat.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID d’accord de l’accord dont le document est nécessaire
Document ID
 documentId True string

ID de document du document spécifique de l’accord
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

Flux de fichiers du document

response
DocumentResponse

Obtenir un PDF de la piste d’audit de l’accord

ID d’opération :
GetAgreementAuditTrail

Cette opération extrait le flux de fichiers PDF de la piste d’audit du contrat. Notez que le flux de fichiers doit être stocké avec un nom de fichier se terminant par .pdf extension de fichier.

Paramètres

Nom Clé Obligatoire Type Description
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com
ID de contrat
 agreementId True string

ID d’accord de l’accord dont les informations sont nécessaires

Retours

Flux de fichiers de la piste d’audit du contrat

response
AgreementAuditTrailResponse

Obtenir un PDF d’un contrat signé

ID d’opération :
GetCombinedDocument_V2

Cette opération extrait le flux de fichiers PDF du contrat combiné ou signé. Notez que le flux de fichiers doit être stocké avec un nom de fichier se terminant par .pdf extension de fichier.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID de contrat fourni par l’action qui crée le contrat
Joindre des documents de prise en charge ?
 attachSupportingDocuments boolean

Si la valeur est true, joignez les documents de support au pdf de l’accord signé
Joindre le rapport d’audit ?
 attachAuditReport boolean

Si la valeur est true, joignez un rapport d’audit au PDF de l’accord signé
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

Flux de fichiers du document

response
CombinedDocumentResponse

Obtenir un PDF d’un contrat signé [DÉPRÉCIÉ]

ID d’opération :
GetCombinedDocument

Cette action a été déconseillée. Utilisez plutôt obtenir un PDF d’un contrat signé .

Cette opération extrait le flux de fichiers PDF du contrat combiné ou signé. Notez que le flux de fichiers doit être stocké avec un nom de fichier se terminant par .pdf extension de fichier.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID de contrat fourni par l’action qui crée le contrat
Joindre des documents de prise en charge ?
 attachSupportingDocuments boolean

Si la valeur est true, joignez les documents de support au pdf de l’accord signé
Joindre le rapport d’audit ?
 auditReport boolean

Si la valeur est true, joignez un rapport d’audit au PDF de l’accord signé

Retours

Flux de fichiers du document

response
CombinedDocumentResponse

Récupérer l’URL de signature

ID d’opération :
GetSigningUrls

Cette opération récupère l’URL de la page de signature électronique pour le ou les signataires actuels d’un contrat.

Paramètres

Nom Clé Obligatoire Type Description
ID de contrat
 agreementId True string

ID de contrat fourni par l’action qui crée le contrat
Dans le nom de
 x-api-user string

E-mail de l’appelant d’API au format : e-mail :adobesignuser@domain.com

Retours

Corps
SigningUrlResponse

Déclencheurs

Lors de la création d’un contrat

Déclenche un nouveau flux lors de la création d’un contrat.
Lorsque l’état d’un accord change

Déclenche un nouveau flux lorsque l’état d’un contrat change. Couvre les événements de contrat les plus courants tels que la création, l’achèvement, etc.
Lorsqu’un accord est envoyé à un participant

Déclenche un nouveau flux lorsqu’un contrat est envoyé à un participant.
Lorsqu’un flux de travail de contrat est terminé avec succès

Déclenche un nouveau flux lorsqu’un flux de travail de contrat est terminé avec succès
Lorsqu’un événement de contrat de formulaire web se produit

Déclenche un nouveau flux lorsque l’événement de contrat de formulaire web se produit. Couvre les événements de contrat les plus courants tels que la création, l’achèvement, etc.
Lorsqu’un événement de groupe se produit

Déclenche un nouveau flux lorsqu’un événement de groupe se produit. Couvre tous les événements Contrat, Mega Sign et Web Form.
Lorsqu’un événement se produit

Déclenche un nouveau flux lorsqu’un événement se produit. Couvre tous les événements Contrat, Mega Sign et Web Form.

Lors de la création d’un contrat

ID d’opération :
CreateWebhookForAgreementCreatedEvent

Déclenche un nouveau flux lors de la création d’un contrat.

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom du déclencheur
Scope
 scope True string

Étendue du déclencheur
Subscription
 webhookSubscriptionEvents True array of string

Événements pour lesquels le flux doit être déclenché
Inclure des informations sur les contrats ?
 includeDetailedInfo boolean

Les informations détaillées sur l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur les participants de l’accord ?
 includeParticipantsInfo boolean

Les informations du participant de l’accord doivent-elles être envoyées dans la notification ?

Retours

Corps
WebhookPayloadWithoutNextParticipantSet

Lorsque l’état d’un accord change

ID d’opération :
CreateWebhookForAgreementStatusUpdated

Déclenche un nouveau flux lorsque l’état d’un contrat change. Couvre les événements de contrat les plus courants tels que la création, l’achèvement, etc.

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom du déclencheur
Scope
 scope True string

Étendue du déclencheur
Nom/ID du contrat
 resourceId string

Spécifiez uniquement quand « Étendue » est « Un accord spécifique ». Sélectionnez un contrat dans la liste ou entrez l’ID du contrat.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Événements pour lesquels le flux doit être déclenché
Inclure des informations sur les contrats ?
 includeDetailedInfo boolean

Les informations détaillées sur l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur les participants de l’accord ?
 includeParticipantsInfo boolean

Les informations du participant de l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur le document contrat ?
 includeDocumentsInfo boolean

Les informations de document d’accord doivent-elles être envoyées dans la notification ?
Inclure les informations de document signées par le contrat ?
 includeSignedDocuments boolean

Une copie finale du document signé doit-elle être envoyée en notification d’achèvement de l’accord ?

Retours

Corps
WebhookPayloadWithSignedDocumentForStatusChange

Lorsqu’un accord est envoyé à un participant

ID d’opération :
CreateWebhookForAgreementSignatureRequestedEvent

Déclenche un nouveau flux lorsqu’un contrat est envoyé à un participant.

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom du déclencheur
Scope
 scope True string

Étendue du déclencheur
Nom/ID du contrat
 resourceId string

Spécifiez uniquement quand « Étendue » est « Un accord spécifique ». Sélectionnez un contrat dans la liste ou entrez l’ID du contrat.
Subscription
 webhookSubscriptionEvents True array of string

Événements pour lesquels le flux doit être déclenché
Inclure des informations sur les contrats ?
 includeDetailedInfo boolean

Les informations détaillées sur l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur les participants de l’accord ?
 includeParticipantsInfo boolean

Les informations du participant de l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur le document contrat ?
 includeDocumentsInfo boolean

Les informations de document d’accord doivent-elles être envoyées dans la notification ?

Retours

Corps
WebhookPayload

Lorsqu’un flux de travail de contrat est terminé avec succès

ID d’opération :
CreateWebhookForAgreementSignedEvent

Déclenche un nouveau flux lorsqu’un flux de travail de contrat est terminé avec succès

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom du déclencheur
Scope
 scope True string

Étendue du déclencheur
Nom/ID du contrat
 resourceId string

Spécifiez uniquement quand « Étendue » est « Un accord spécifique ». Sélectionnez un contrat dans la liste ou entrez l’ID du contrat.
Subscription
 webhookSubscriptionEvents True array of string

Événements pour lesquels le flux doit être déclenché
Inclure des informations sur les contrats ?
 includeDetailedInfo boolean

Les informations détaillées sur l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur les participants de l’accord ?
 includeParticipantsInfo boolean

Les informations du participant de l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur le document contrat ?
 includeDocumentsInfo boolean

Les informations de document d’accord doivent-elles être envoyées dans la notification ?
Inclure les informations de document signées par le contrat ?
 includeSignedDocuments boolean

Une copie finale du document signé à la fin de l’accord doit-elle être envoyée en notification ?

Retours

Corps
WebhookPayloadWithSignedDocument

Lorsqu’un événement de contrat de formulaire web se produit

ID d’opération :
CreateWebhookForWebFormAgreementEvent

Déclenche un nouveau flux lorsque l’événement de contrat de formulaire web se produit. Couvre les événements de contrat les plus courants tels que la création, l’achèvement, etc.

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom du déclencheur
Taille de page Web Forms
 pageSize integer

Sélectionnez le nombre de formulaires web à afficher dans la liste déroulante
Nom/ID du formulaire web
 resourceId True string

Sélectionnez un formulaire web dans la liste ou entrez l’ID de formulaire web.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Événements pour lesquels le flux doit être déclenché
Inclure des informations sur les contrats ?
 includeDetailedInfo boolean

Les informations détaillées sur l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur les participants de l’accord ?
 includeParticipantsInfo boolean

Les informations du participant de l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur le document contrat ?
 includeDocumentsInfo boolean

Les informations de document d’accord doivent-elles être envoyées dans la notification ?
Inclure les informations de document signées par le contrat ?
 includeSignedDocuments boolean

Une copie finale du document signé doit-elle être envoyée en notification d’achèvement de l’accord ?

Retours

Corps
WebFormWebhookAgreementEventPayload

Lorsqu’un événement de groupe se produit

ID d’opération :
CreateWebhookForGroupEvent

Déclenche un nouveau flux lorsqu’un événement de groupe se produit. Couvre tous les événements Contrat, Mega Sign et Web Form.

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom du déclencheur
Nom/ID du groupe
 resourceId string

ID du groupe
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Événements pour lesquels le flux doit être déclenché
Inclure des informations sur les contrats ?
 includeDetailedInfo boolean

Les informations détaillées sur l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur les participants de l’accord ?
 includeParticipantsInfo boolean

Les informations du participant de l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur le document contrat ?
 includeDocumentsInfo boolean

Les informations de document d’accord doivent-elles être envoyées dans la notification ?
Inclure les informations de document signées par le contrat ?
 includeSignedDocuments boolean

Une copie finale du document signé à la fin de l’accord doit-elle être envoyée en notification ?
Inclure les informations MegaSign ?
 includeDetailedInfo boolean

Les informations détaillées sur le méga-signe doivent-elles être envoyées dans la notification ?
Inclure des informations de formulaire web ?
 includeDetailedInfo boolean

Les informations détaillées sur le formulaire web doivent-elles être envoyées dans la notification ?
Inclure les informations de participant au formulaire web ?
 includeParticipantsInfo boolean

Les informations du participant au formulaire web doivent-elles être envoyées dans la notification ?
Inclure des informations sur les documents de formulaire web ?
 includeDocumentsInfo boolean

Les informations de document de formulaire web doivent-elles être envoyées dans la notification ?

Retours

Corps
GroupWebhookEventPayload

Lorsqu’un événement se produit

ID d’opération :
CreateWebhookGeneric

Déclenche un nouveau flux lorsqu’un événement se produit. Couvre tous les événements Contrat, Mega Sign et Web Form.

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom du déclencheur
Scope
 scope True string

Étendue du déclencheur
Type de ressource
 resourceType string

Spécifiez uniquement lorsque « Étendue » est « Ressource spécifique ». Sélectionnez le type de ressource pour lequel le flux doit être déclenché.
ID de ressource
 resourceId string

Spécifiez uniquement lorsque « Étendue » est « Ressource spécifique ». Entrez le contrat ou méga sign ou le formulaire web ou l’ID de groupe pour lequel le flux doit être déclenché.
webhookSubscriptionEvents
 webhookSubscriptionEvents True array of string

Événements pour lesquels le flux doit être déclenché
Inclure des informations sur les contrats ?
 includeDetailedInfo boolean

Les informations détaillées sur l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur les participants de l’accord ?
 includeParticipantsInfo boolean

Les informations du participant de l’accord doivent-elles être envoyées dans la notification ?
Inclure des informations sur le document contrat ?
 includeDocumentsInfo boolean

Les informations de document d’accord doivent-elles être envoyées dans la notification ?
Inclure les informations de document signées par le contrat ?
 includeSignedDocuments boolean

Une copie finale du document signé à la fin de l’accord doit-elle être envoyée en notification ?
Inclure les informations MegaSign ?
 includeDetailedInfo boolean

Les informations détaillées sur le méga-signe doivent-elles être envoyées dans la notification ?
Inclure des informations de formulaire web ?
 includeDetailedInfo boolean

Les informations détaillées sur le formulaire web doivent-elles être envoyées dans la notification ?
Inclure les informations de participant au formulaire web ?
 includeParticipantsInfo boolean

Les informations du participant au formulaire web doivent-elles être envoyées dans la notification ?
Inclure des informations sur les documents de formulaire web ?
 includeDocumentsInfo boolean

Les informations de document de formulaire web doivent-elles être envoyées dans la notification ?

Retours

Corps
WebhookPayloadGeneric

Définitions

AgreementCreationResponse

JSON qui contient l’ID du contrat nouvellement créé

Nom Chemin d’accès Type Description
ID de contrat
 agreementId string

ID unique du contrat qui peut être utilisé pour interroger l’état et télécharger des documents signés

AgreementCreationResponseV6

JSON qui contient l’ID du contrat nouvellement créé

Nom Chemin d’accès Type Description
ID de contrat
 id string

ID unique du contrat qui peut être utilisé pour interroger l’état et télécharger des documents signés

AgreementDocuments

JSON qui contient à la fois les documents et les objets de tableau de documents de prise en charge

Nom Chemin d’accès Type Description
Documents
 documents array of Document

Liste d’objets représentant les documents
Justificatives
 supportingDocuments array of SupportingDocument

Liste des documents de prise en charge. Cela n’est retourné que s’il existe un document de support dans l’accord

AgreementDocumentsV6

JSON qui contient à la fois les documents et les objets de tableau de documents de prise en charge

Nom Chemin d’accès Type Description
Documents
 documents array of DocumentV6

Liste d’objets représentant les documents
Justificatives
 supportingDocuments array of SupportingDocumentV6

Liste des documents de prise en charge. Cela n’est retourné que s’il existe un document de support dans l’accord

AgreementInfo

Détails complets sur l’accord

Nom Chemin d’accès Type Description
ID de contrat
 agreementId string

ID unique qui peut être utilisé pour identifier de manière unique le contrat
Événements
 events array of DocumentHistoryEvent

Liste ordonnée des événements dans la piste d’audit de ce document
Date d’expiration
 expiration date

Date à laquelle l’accord ne peut plus être signé
ID de version le plus récent
 latestVersionId string

ID unique qui identifie de manière unique la version actuelle du contrat
Message
 message string

Message associé au contrat fourni par l’expéditeur
Nom du contrat
 name string

Nom du contrat, spécifié par l’expéditeur
Ensembles de participants suivants
 nextParticipantSetInfos array of NextParticipantSetInfo

Informations sur les personnes qui doivent agir à venir pour cet accord
Jeux de participants
 participantSetInfos array of ParticipantSetInfo

Informations sur tous les ensembles de participants de ce document
Signature Type
 signatureType string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
Protection des documents
 securityOptions string

Informations de sécurité sur le document qui spécifie si un mot de passe est requis pour l’afficher et le signer
Statut
 status string

État actuel de l’accord

AgreementInfoV6

Détails complets de l’accord

Nom Chemin d’accès Type Description
ID de contrat
 id string

ID unique qui peut être utilisé pour identifier de manière unique le contrat
Date de création
 createdDate date

Date de création d’un contrat
Premier délai de rappel
 firstReminderDelay integer

Entier qui spécifie le délai en heures avant d’envoyer le premier rappel.
Fréquence de rappel
 reminderFrequency string

À quelle fréquence voulez-vous envoyer des rappels ?
Date d’expiration
 expiration date

Date à laquelle l’accord ne peut plus être signé
Paramètres régionaux
 locale string

Paramètres régionaux associés à ce contrat , par exemple, en_US ou fr_FR
Message
 message string

Message associé au contrat fourni par l’expéditeur
Nom du contrat
 name string

Nom du contrat, spécifié par l’expéditeur
Visibilité du document ?
 documentVisibilityEnabled boolean

La visibilité du document est-elle activée ?
Jeux de participants
 participantSetsInfo array of ParticipantSetInfoV6

Informations sur tous les ensembles de participants de ce document
Signature Type
 signatureType string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
Options de sécurité
 securityOptions string

Informations de sécurité sur le document qui spécifie si un mot de passe est requis pour l’afficher et le signer
Statut
 status string

État actuel de l’accord
Adresse e-mail de l’expéditeur
 senderEmail string

E-mail de l’expéditeur
ID de flux de travail
 workflowId string

ID du flux de travail personnalisé qui définit le chemin d’accès de routage d’un contrat.
Ccs
 ccs array of CcInfo

Liste d’une ou de plusieurs CCS qui seront copiées dans la transaction de contrat.
ID de groupe
 groupId string

Identificateur unique du groupe auquel appartient le contrat.

CombinedDocumentResponse

Flux de fichiers du document

Flux de fichiers du document

Contenu du fichier
binary

AgreementAuditTrailResponse

Flux de fichiers de la piste d’audit du contrat

Flux de fichiers de la piste d’audit du contrat

Contenu de la piste d’audit du contrat
binary

DisplayUserInfo

Nom Chemin d’accès Type Description
Entreprise
 company string

Affiche le nom de l’entreprise de l’utilisateur, le cas échéant
Messagerie électronique
 email string

Affiche l’e-mail de l’utilisateur
Nom complet
 fullName string

Affiche le nom complet de l’utilisateur, le cas échéant.

DisplayUserSetInfo

Nom Chemin d’accès Type Description
Afficher les informations sur l’ensemble d’utilisateurs
 displayUserSetMemberInfos array of DisplayUserInfo

Affiche les informations sur l’ensemble d’utilisateurs
Afficher le nom de l’ensemble d’utilisateurs
 displayUserSetName string

Document

Informations sur le document

Nom Chemin d’accès Type Description
Document ID
 documentId string

ID unique du document
Mime Type
 mimeType string

Type Mime du document
Nom
 name string

Nom du document
Nombre de pages
 numPages integer

Nombre de pages dans le document

DocumentV6

Informations sur le document

Nom Chemin d’accès Type Description
Document ID
 id string

ID unique du document
Mime Type
 mimeType string

Type Mime du document
Nom
 name string

Nom du document
Nombre de pages
 numPages integer

Nombre de pages dans le document

DocumentHistoryEvent

Nom Chemin d’accès Type Description
Initiateur d’événement
 actingUserEmail string

Adresse e-mail de l’utilisateur qui a lancé l’événement
Date de l’événement
 date date

Date de l’événement d’audit
Description de l'événement
 description string

Description de l’événement d’audit
E-mail du participant
 participantEmail string

Adresse e-mail de l’utilisateur qui a lancé l’événement
Type d'événement
 type string

Type d’événement de contrat

DocumentLibraryItem

Nom Chemin d’accès Type Description
ID du modèle de bibliothèque
 libraryDocumentId string

ID unique du document de bibliothèque utilisé lors de l’envoi du document à signer
Types de modèles de bibliothèque
 libraryTemplateTypes array of string

Liste d’un ou de plusieurs types de modèles de bibliothèque
Date de modification
 modifiedDate date

Jour de la dernière modification du modèle de bibliothèque
Nom du modèle de bibliothèque
 name string

Nom du modèle de bibliothèque
Mode de partage de modèle
 scope string

Étendue de la visibilité du modèle de bibliothèque

DocumentLibraryItems

JSON qui contient l’objet de tableau de modèles de bibliothèque

Nom Chemin d’accès Type Description
Liste des modèles de bibliothèque
 libraryDocumentList array of DocumentLibraryItem

Liste des éléments de modèle de bibliothèque

DocumentResponse

Flux de fichiers du document

Flux de fichiers du document

Contenu du fichier
binary

LibraryDocumentCreationResponse

Objet JSON décrivant le modèle de bibliothèque

Nom Chemin d’accès Type Description
ID du modèle de bibliothèque
 libraryDocumentId string

ID unique qui peut être utilisé pour faire référence au modèle de bibliothèque

NextParticipantInfo

Nom Chemin d’accès Type Description
Messagerie électronique
 email string

Adresse e-mail du participant suivant
Nom
 name string

Nom du participant suivant, le cas échéant
En attente depuis
 waitingSince date

Date depuis laquelle le document attend que le participant prenne des mesures

NextParticipantSetInfo

Nom Chemin d’accès Type Description
Next Participant Set Member Infos
 nextParticipantSetMemberInfos array of NextParticipantInfo

Informations sur les membres du jeu de participants suivant

ParticipantInfo

Nom Chemin d’accès Type Description
Entreprise
 company string

L’entreprise du participant, le cas échéant
Messagerie électronique
 email string

Adresse e-mail du participant
Nom
 name string

Nom du participant, le cas échéant
Identifiant du participant
 participantId string

ID unique du participant
Options de sécurité
 securityOptions array of string

Options de sécurité qui s’appliquent au participant
Titre
 title string

Titre du participant, le cas échéant

ParticipantSetInfo

Nom Chemin d’accès Type Description
ID du jeu de participants
 participantSetId string

ID unique du jeu de participants
Informations de membre définies par le participant
 participantSetMemberInfos array of ParticipantInfo

Informations sur les membres du jeu de destinataires
Message privé
 privateMessage string

Message privé pour les participants dans l’ensemble
Role
 roles array of string

Rôles actuels du jeu de participants. Un ensemble de participants peut avoir un ou plusieurs rôles
securityOptions
 securityOptions array of string

Options de sécurité qui s’appliquent au participant
Ordre de signature
 signingOrder integer

Index commençant par 1, qui indique l’ordre dans lequel ce destinataire signe
État du jeu de participants
 status string

Le participant définit l’état par rapport au document

ParticipantSetInfoV6

Nom Chemin d’accès Type Description
Informations de membre définies par le participant
 memberInfos array of MemberInfosV6

Informations sur les membres du jeu de destinataires
JSON
 order integer

Index indiquant la position à laquelle le groupe de signature doit se signer.
Role
 role string

Rôles actuels du jeu de participants (signataire, approbateur, etc.).
Nom du jeu de participants
 name string

Nom du jeu de participants
Participant Set Private Messsage
 privateMessage string

Message privé pour les participants dans l’ensemble
Définir des pages visibles par le participant
 visiblePages array of string

Pages visibles par le jeu de participants

MemberInfosV6

Nom Chemin d’accès Type Description
E-mail du participant
 email string

E-mail du participant
Authentication
 securityOption.authenticationMethod string

Authentification par défaut : e-mail (Aucun)
Mot de passe
 securityOption.password string

Mot de passe requis pour le participant
Code pays
 securityOption.phoneInfo.countryCode string

Code de pays du téléphone du destinataire requis pour afficher et signer le document
Téléphone non.
 securityOption.phoneInfo.phone string

Numéro de téléphone du destinataire requis pour afficher et signer le contrat

SigningUrl

Nom Chemin d’accès Type Description
Adresse e-mail pour l’URL de signature
 email string

Adresse e-mail du signataire associé à cette URL de signature
URL de signature
 esignUrl string

Adresse URL du signataire associé à cette URL de signature

SigningUrlResponse

Nom Chemin d’accès Type Description
Tableau d’URL pour les jeux de signataires
 signingUrlSetInfos array of SigningUrlSetInfo

Tableau d’URL pour les ensembles de signataires impliqués dans ce contrat

SigningUrlSetInfo

Nom Chemin d’accès Type Description
- Tableau d’URL de signature
 signingUrls array of SigningUrl

Tableau d’URL pour le jeu de signataires actuel
- Nom du jeu d’URL de signe
 signingUrlSetName string

Nom du jeu de signataires actuel

SupportDocument

Informations sur le document de prise en charge

Nom Chemin d’accès Type Description
Nom du document de prise en charge
 displayLabel string

Nom complet du document de prise en charge
Nom du champ document de prise en charge
 fieldName string

Nom du champ de document de prise en charge
Prise en charge du type Mime de document
 mimeType string

Type Mime du document de prise en charge
Pages de documents de prise en charge
 numPages integer

Nombre de pages dans le document de prise en charge
ID de document de prise en charge
 supportingDocumentId string

ID unique représentant le document de prise en charge

SupportDocumentV6

Informations sur le document de prise en charge

Nom Chemin d’accès Type Description
Nom du document de prise en charge
 displayLabel string

Nom complet du document de prise en charge
Nom du champ document de prise en charge
 fieldName string

Nom du champ de document de prise en charge
Prise en charge du type Mime de document
 mimeType string

Type Mime du document de prise en charge
Pages de documents de prise en charge
 numPages integer

Nombre de pages dans le document de prise en charge
ID de document de prise en charge
 id string

ID unique représentant le document de prise en charge

TransientDocumentResponse

JSON qui contient l’ID du document chargé

Nom Chemin d’accès Type Description
Document ID
 transientDocumentId string

ID de document du document chargé

UserAgreement

Nom Chemin d’accès Type Description
ID de contrat
 agreementId string

ID unique qui peut être utilisé pour identifier de manière unique le contrat
Afficher les informations relatives à l’ensemble d’utilisateurs
 displayUserSetInfos array of DisplayUserSetInfo

L’utilisateur actuel le plus pertinent défini pour le contrat. Il s’agit généralement du prochain signataire si le contrat provient de l’utilisateur actuel ou de l’expéditeur s’il est reçu d’un autre utilisateur
Afficher la date
 displayDate date

Date d’affichage du contrat
Signature électronique
 esign boolean

True s’il s’agit d’un document de signature électronique
ID de version le plus récent
 latestVersionId string

ID de version qui identifie de façon unique la version actuelle du contrat
Nom
 name string

Nom de l’accord
Statut
 status string

État actuel de l’accord

UserAgreements

JSON qui contient l’objet tableau de contrats utilisateur

Nom Chemin d’accès Type Description
Liste des contrats
 userAgreementList array of UserAgreement

Tableau d’éléments de contrat

UserAgreementV6

Nom Chemin d’accès Type Description
Afficher les informations relatives à l’ensemble d’utilisateurs
 displayParticipantSetInfos array of DisplayUserSetInfo

L’utilisateur actuel le plus pertinent défini pour le contrat. Il s’agit généralement du prochain signataire si le contrat provient de l’utilisateur actuel ou de l’expéditeur s’il est reçu d’un autre utilisateur
Afficher la date
 displayDate string

Date d’affichage du contrat
Signature électronique
 esign boolean

True s’il s’agit d’un document de signature électronique
Caché
 hidden boolean

True si le contrat est masqué pour l’utilisateur
ID de groupe
 groupId string

Identificateur unique du groupe
ID de version le plus récent
 latestVersionId string

ID de version qui identifie de façon unique la version actuelle du contrat
Nom
 name string

Nom de l’accord
Parent ID
 parentId string

ID parent d’un mégaSign enfant OU id d’origine d’une instance de contrat de formulaire web
ID de contrat
 id string

Identificateur unique du contrat
Statut
 status string

État actuel de l’accord
Type
 type string

Type d’accord

userAgreementListV6

JSON qui contient l’objet tableau de contrats utilisateur

Nom Chemin d’accès Type Description
page
 page page

Informations de pagination pour naviguer dans la réponse
Liste des contrats
 userAgreementList array of UserAgreementV6

Tableau d’éléments de contrat

page

Informations de pagination pour naviguer dans la réponse

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

Utilisé pour accéder à la page suivante. S’il n’est pas retourné, il n’y a pas de pages supplémentaires.

WebhookPayload

Nom Chemin d’accès Type Description
Événement
 event string

Événement qui s’est produit sur la ressource.
Date de l’événement
 eventDate date

Date de l’événement. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Type de ressource d’événement
 eventResourceType string

Ressource sur laquelle l’événement s’est produit.
Type parent du contrat
 eventResourceParentType string

Informations sur la ressource à partir de laquelle le contrat est créé. Valeurs possibles : Formulaire Web ou Mega Sign
ID parent du contrat
 eventResourceParentId string

ID unique de la ressource à partir de laquelle ce contrat est créé
Rôle participant à l’événement
 participantRole string

Rôle du participant pour l’événement.
ID du participant à l’événement
 participantUserId string

ID du participant pour l’événement.
E-mail du participant à l’événement
 participantUserEmail string

E-mail du participant pour l’événement.
ID d’utilisateur agissant sur l’événement
 actingUserId string

ID de l’utilisateur qui a créé l’événement.
E-mail utilisateur d’action d’événement
 actingUserEmail string

E-mail de l’utilisateur qui a créé l’événement.
Adresse IP de l’utilisateur agissant sur l’événement
 actingUserIpAddress string

Adresse IP de l’utilisateur qui a créé l’événement
ID d’utilisateur de lancement d’événement
 initiatingUserId string

ID de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Événement de lancement d’e-mail utilisateur
 initiatingUserEmail string

E-mail de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Notification applicable aux utilisateurs
 webhookNotificationApplicableUsers array of ApplicableUsers

Liste des utilisateurs pour lesquels cette notification s’applique
Contrat
 agreement WebhookAgreementInfo

Informations complètes de l’accord

ApplicableUsers

Informations sur les utilisateurs pour lesquels cette notification s’applique

Nom Chemin d’accès Type Description
ID d’utilisateur applicable à la notification
 id string

ID unique de l’utilisateur pour lequel cette notification s’applique
E-mail utilisateur applicable aux notifications
 email string

E-mail de l’utilisateur pour lequel cette notification s’applique
Rôle d’utilisateur applicable aux notifications
 role string

Rôle de l’utilisateur dans le flux de travail pour lequel cette notification est générée
Est un utilisateur applicable à la charge utile
 payloadApplicable boolean

Indique si les données fournies dans cette notification s’appliquent à cet utilisateur ou non

WebhookPayloadWithoutNextParticipantSet

Nom Chemin d’accès Type Description
Événement
 event string

Événement qui s’est produit sur la ressource.
Date de l’événement
 eventDate date

Date de l’événement. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Type de ressource d’événement
 eventResourceType string

Ressource sur laquelle l’événement s’est produit.
Type parent du contrat
 eventResourceParentType string

Informations sur la ressource à partir de laquelle le contrat est créé. Valeurs possibles : Formulaire Web ou Mega Sign
ID parent du contrat
 eventResourceParentId string

ID unique de la ressource à partir de laquelle ce contrat est créé
ID du participant à l’événement
 participantUserId string

ID du participant pour l’événement.
E-mail du participant à l’événement
 participantUserEmail string

E-mail du participant pour l’événement.
ID d’utilisateur agissant sur l’événement
 actingUserId string

ID de l’utilisateur qui a créé l’événement.
E-mail utilisateur d’action d’événement
 actingUserEmail string

E-mail de l’utilisateur qui a créé l’événement.
Adresse IP de l’utilisateur agissant sur l’événement
 actingUserIpAddress string

Adresse IP de l’utilisateur qui a créé l’événement
ID d’utilisateur de lancement d’événement
 initiatingUserId string

ID de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant
Événement de lancement d’e-mail utilisateur
 initiatingUserEmail string

E-mail de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Notification applicable aux utilisateurs
 webhookNotificationApplicableUsers array of ApplicableUsers

Liste des utilisateurs pour lesquels cette notification s’applique
Contrat
 agreement WebhookAgreementInfoWithoutNextParticipantSet

Informations complètes de l’accord

WebhookPayloadWithSignedDocumentForStatusChange

Nom Chemin d’accès Type Description
Événement
 event string

Événement qui s’est produit sur la ressource.
Date de l’événement
 eventDate date

Date de l’événement. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Sous-événement
 subEvent string

Sous-événement qui s’est produit sur une ressource.
Type parent du contrat
 eventResourceParentType string

Informations sur la ressource à partir de laquelle le contrat est créé. Valeurs possibles : Formulaire Web ou Mega Sign
ID parent du contrat
 eventResourceParentId string

ID unique de la ressource à partir de laquelle ce contrat est créé
ID du participant à l’événement
 participantUserId string

ID du participant pour l’événement.
E-mail du participant à l’événement
 participantUserEmail string

E-mail du participant pour l’événement.
ID d’utilisateur agissant sur l’événement
 actingUserId string

ID de l’utilisateur qui a créé l’événement.
E-mail utilisateur d’action d’événement
 actingUserEmail string

E-mail de l’utilisateur qui a créé l’événement.
Adresse IP de l’utilisateur agissant sur l’événement
 actingUserIpAddress string

Adresse IP de l’utilisateur qui a créé l’événement
Type d'action
 actionType string

Action pour laquelle l’événement s’est produit.
ID d’utilisateur de lancement d’événement
 initiatingUserId string

ID de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant
Événement de lancement d’e-mail utilisateur
 initiatingUserEmail string

E-mail de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Type de ressource d’événement
 eventResourceType string

Ressource sur laquelle l’événement s’est produit.
Rôle participant à l’événement
 participantRole string

Rôle du participant pour l’événement.
Notification applicable aux utilisateurs
 webhookNotificationApplicableUsers array of ApplicableUsers

Liste des utilisateurs pour lesquels cette notification s’applique
Contrat
 agreement WebhookAgreementInfoWithSignedDocument

Informations complètes de l’accord

WebhookPayloadWithSignedDocument

Nom Chemin d’accès Type Description
Événement
 event string

Événement qui s’est produit sur la ressource.
Date de l’événement
 eventDate date

Date de l’événement. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Type parent du contrat
 eventResourceParentType string

Informations sur la ressource à partir de laquelle le contrat est créé. Valeurs possibles : Formulaire Web ou Mega Sign
ID parent du contrat
 eventResourceParentId string

ID unique de la ressource à partir de laquelle ce contrat est créé
Type de ressource d’événement
 eventResourceType string

Ressource sur laquelle l’événement s’est produit.
Rôle participant à l’événement
 participantRole string

Rôle du participant pour l’événement.
ID du participant à l’événement
 participantUserId string

ID du participant pour l’événement.
E-mail du participant à l’événement
 participantUserEmail string

E-mail du participant pour l’événement.
ID d’utilisateur agissant sur l’événement
 actingUserId string

ID de l’utilisateur qui a créé l’événement.
E-mail utilisateur d’action d’événement
 actingUserEmail string

E-mail de l’utilisateur qui a créé l’événement.
Adresse IP de l’utilisateur agissant sur l’événement
 actingUserIpAddress string

Adresse IP de l’utilisateur qui a créé l’événement
ID d’utilisateur de lancement d’événement
 initiatingUserId string

ID de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant
Événement de lancement d’e-mail utilisateur
 initiatingUserEmail string

E-mail de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Notification applicable aux utilisateurs
 webhookNotificationApplicableUsers array of ApplicableUsers

Liste des utilisateurs pour lesquels cette notification s’applique
Contrat
 agreement WebhookAgreementInfoWithSignedDocument

Informations complètes de l’accord

WebhookPayloadGeneric

Nom Chemin d’accès Type Description
Événement
 event string

Événement qui s’est produit sur la ressource.
Date de l’événement
 eventDate date

Date de l’événement. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Sous-événement
 subEvent string

Sous-événement qui s’est produit sur une ressource.
Type parent du contrat
 eventResourceParentType string

Informations sur la ressource à partir de laquelle le contrat est créé. Valeurs possibles : Formulaire Web ou Mega Sign
ID parent du contrat
 eventResourceParentId string

ID unique de la ressource à partir de laquelle ce contrat est créé
Type de ressource d’événement
 eventResourceType string

Ressource sur laquelle l’événement s’est produit.
Rôle participant à l’événement
 participantRole string

Rôle du participant pour l’événement.
ID du participant à l’événement
 participantUserId string

ID du participant pour l’événement.
E-mail du participant à l’événement
 participantUserEmail string

E-mail du participant pour l’événement.
ID d’utilisateur agissant sur l’événement
 actingUserId string

ID de l’utilisateur qui a créé l’événement.
E-mail utilisateur d’action d’événement
 actingUserEmail string

E-mail de l’utilisateur qui a créé l’événement.
ID d’utilisateur de lancement d’événement
 initiatingUserId string

ID de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant
Événement de lancement d’e-mail utilisateur
 initiatingUserEmail string

E-mail de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Type d'action
 actionType string

Action pour laquelle l’événement s’est produit.
Adresse IP de l’utilisateur agissant sur l’événement
 actingUserIpAddress string

Adresse IP de l’utilisateur qui a créé l’événement
Notification applicable aux utilisateurs
 webhookNotificationApplicableUsers array of ApplicableUsers

Liste des utilisateurs pour lesquels cette notification s’applique
Contrat
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Informations complètes de l’accord
Mega Sign
 megaSign WebhookMegaSignInfo

Informations complètes du méga-signe
Formulaire web
 widget WebhookWidgetInfo

Informations complètes du formulaire web

WebFormWebhookAgreementEventPayload

Nom Chemin d’accès Type Description
Événement
 event string

Événement de contrat qui s’est produit sur le formulaire web.
Date de l’événement
 eventDate date

Date de l’événement. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Sous-événement
 subEvent string

Sous-événement qui s’est produit sur un formulaire web.
Type parent d’accord - Formulaire web
 eventResourceParentType string

Valeur qui indique qu’un contrat est créé à partir du formulaire web.
ID de formulaire web
 eventResourceParentId string

ID unique du formulaire web à partir duquel ce contrat est créé
Type de ressource d’événement - Contrat
 eventResourceType string

Ressource sur laquelle l’événement s’est produit.
Rôle participant à l’événement
 participantRole string

Rôle du participant pour l’événement.
ID du participant à l’événement
 participantUserId string

ID du participant pour l’événement.
E-mail du participant à l’événement
 participantUserEmail string

E-mail du participant pour l’événement.
ID d’utilisateur agissant sur l’événement
 actingUserId string

ID de l’utilisateur qui a créé l’événement.
E-mail utilisateur d’action d’événement
 actingUserEmail string

E-mail de l’utilisateur qui a créé l’événement.
ID d’utilisateur de lancement d’événement
 initiatingUserId string

ID de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant
Événement de lancement d’e-mail utilisateur
 initiatingUserEmail string

E-mail de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Type d'action
 actionType string

Action pour laquelle l’événement s’est produit.
Adresse IP de l’utilisateur agissant sur l’événement
 actingUserIpAddress string

Adresse IP de l’utilisateur qui a créé l’événement
Notification applicable aux utilisateurs
 webhookNotificationApplicableUsers array of ApplicableUsers

Liste des utilisateurs pour lesquels cette notification s’applique
Contrat
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Informations complètes de l’accord

GroupWebhookEventPayload

Nom Chemin d’accès Type Description
Événement
 event string

Événement qui s’est produit pour un groupe.
Date de l’événement
 eventDate date

Date de l’événement. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Sous-événement
 subEvent string

Sous-événement qui s’est produit pour un groupe.
Type parent d’accord - Formulaire web
 eventResourceParentType string

Informations sur le groupe à partir duquel le contrat est créé.
ID de formulaire web
 eventResourceParentId string

ID unique du groupe à partir duquel ce contrat est créé
Type de ressource d’événement - Contrat
 eventResourceType string

Groupe pour lequel l’événement s’est produit.
Rôle participant à l’événement
 participantRole string

Rôle du participant pour l’événement.
ID du participant à l’événement
 participantUserId string

ID du participant pour l’événement.
E-mail du participant à l’événement
 participantUserEmail string

E-mail du participant pour l’événement.
ID d’utilisateur agissant sur l’événement
 actingUserId string

ID de l’utilisateur qui a créé l’événement.
E-mail utilisateur d’action d’événement
 actingUserEmail string

E-mail de l’utilisateur qui a créé l’événement.
ID d’utilisateur de lancement d’événement
 initiatingUserId string

ID de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant
Événement de lancement d’e-mail utilisateur
 initiatingUserEmail string

E-mail de l’utilisateur qui a lancé l’événement pour le compte de l’utilisateur agissant.
Type d'action
 actionType string

Action pour laquelle l’événement s’est produit.
Adresse IP de l’utilisateur agissant sur l’événement
 actingUserIpAddress string

Adresse IP de l’utilisateur qui a créé l’événement
Notification applicable aux utilisateurs
 webhookNotificationApplicableUsers array of ApplicableUsers

Liste des utilisateurs pour lesquels cette notification s’applique
Contrat
 agreement WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Informations complètes de l’accord
Mega Sign
 megaSign WebhookMegaSignInfo

Informations complètes du méga-signe
Formulaire web
 widget WebhookWidgetInfo

Informations complètes du formulaire web

WebhookAgreementInfo

Informations complètes de l’accord

Nom Chemin d’accès Type Description
ID
 id string

ID unique du contrat
Nom
 name string

Nom de l’accord
Signature Type
 signatureType string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
Statut
 status string

État actuel de l’accord
Ccs
 ccs array of CcInfo

Liste d’une ou de plusieurs CCS qui seront copiées dans la transaction de contrat.
Date de création
 createdDate date

Date de création d’un contrat
Délai d’expiration
 expirationTime string

Heure après laquelle l’accord expire et doit être signé avant
External ID
 externalId.id string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Groupe externe
 externalId.group string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Premier délai de rappel
 firstReminderDelay integer

Entier qui spécifie le délai en heures avant d’envoyer le premier rappel.
Paramètres régionaux
 locale string

Paramètres régionaux associés à ce contrat
Message
 message string

Message facultatif aux participants, décrivant ce qui est envoyé ou pourquoi leur signature est requise
Fréquence de rappel
 reminderFrequency string

Paramètre facultatif qui définit la fréquence à laquelle vous souhaitez envoyer des rappels aux participants. S’il n’est pas spécifié, la fréquence par défaut définie pour le compte sera utilisée
Adresse e-mail de l’expéditeur
 senderEmail string

E-mail de l’expéditeur du contrat
Coffreing activé ?
 vaultingInfo.enabled boolean

Pour les comptes configurés pour le coffre de documents et l’option d’activation par contrat, cela détermine si le document doit être coffreté
Visibilité du document ?
 documentVisibilityEnabled boolean

La visibilité du document est-elle activée
ID de flux de travail
 workflowId string

ID du flux de travail personnalisé qui définit le chemin d’accès de routage d’un contrat.
Url de redirection de post-signature
 postSignOption.redirectUrl string

URL accessible publiquement à laquelle l’utilisateur sera envoyé après avoir terminé le processus de signature
Jeux de participants
 participantSetsInfo.participantSets array of WebhookParticipantSets

Le participant définit des informations
Ensembles de participants suivants
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

Le participant suivant définit les informations
Documents
 documentsInfo.documents array of WebhookDocument

Liste d’objets représentant les documents
Justificatives
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Liste des documents de prise en charge

WebhookAgreementInfoWithoutNextParticipantSet

Informations complètes de l’accord

Nom Chemin d’accès Type Description
ID
 id string

ID unique du contrat
Nom
 name string

Nom de l’accord
Signature Type
 signatureType string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
Statut
 status string

État actuel de l’accord
Ccs
 ccs array of CcInfo

Liste d’une ou de plusieurs CCS qui seront copiées dans la transaction de contrat.
Date de création
 createdDate date

Date de création d’un contrat
Visibilité du document ?
 documentVisibilityEnabled boolean

La visibilité du document est-elle activée
Délai d’expiration
 expirationTime string

Heure après laquelle l’accord expire et doit être signé avant
External ID
 externalId.id string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Groupe externe
 externalId.group string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Premier délai de rappel
 firstReminderDelay integer

Entier qui spécifie le délai en heures avant d’envoyer le premier rappel.
Paramètres régionaux
 locale string

Paramètres régionaux associés à ce contrat
Message
 message string

Message facultatif aux participants, décrivant ce qui est envoyé ou pourquoi leur signature est requise
Fréquence de rappel
 reminderFrequency string

Paramètre facultatif qui définit la fréquence à laquelle vous souhaitez envoyer des rappels aux participants. S’il n’est pas spécifié, la fréquence par défaut définie pour le compte sera utilisée
Adresse e-mail de l’expéditeur
 senderEmail string

E-mail de l’expéditeur du contrat
Coffreing activé ?
 vaultingInfo.enabled boolean

Pour les comptes configurés pour le coffre de documents et l’option d’activation par contrat, cela détermine si le document doit être coffreté
Url de redirection de post-signature
 postSignOption.redirectUrl string

URL accessible publiquement à laquelle l’utilisateur sera envoyé après avoir terminé le processus de signature
ID de flux de travail
 workflowId string

ID du flux de travail personnalisé qui définit le chemin d’accès de routage d’un contrat.
Jeux de participants
 participantSetsInfo.participantSets array of WebhookParticipantSets

Le participant définit des informations

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

Informations complètes de l’accord

Nom Chemin d’accès Type Description
ID
 id string

ID unique du contrat
Nom
 name string

Nom de l’accord
Signature Type
 signatureType string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
Statut
 status string

État actuel de l’accord
Ccs
 ccs array of CcInfo

Liste d’une ou de plusieurs CCS qui seront copiées dans la transaction de contrat.
Date de création
 createdDate date

Date de création d’un contrat
Délai d’expiration
 expirationTime string

Heure après laquelle l’accord expire et doit être signé avant
External ID
 externalId.id string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Groupe externe
 externalId.group string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Premier délai de rappel
 firstReminderDelay integer

Entier qui spécifie le délai en heures avant d’envoyer le premier rappel.
Paramètres régionaux
 locale string

Paramètres régionaux associés à ce contrat
Message
 message string

Message facultatif aux participants, décrivant ce qui est envoyé ou pourquoi leur signature est requise
Fréquence de rappel
 reminderFrequency string

Paramètre facultatif qui définit la fréquence à laquelle vous souhaitez envoyer des rappels aux participants. S’il n’est pas spécifié, la fréquence par défaut définie pour le compte sera utilisée
Url de redirection de post-signature
 postSignOption.redirectUrl string

URL accessible publiquement à laquelle l’utilisateur sera envoyé après avoir terminé le processus de signature
ID de flux de travail
 workflowId string

ID du flux de travail personnalisé qui définit le chemin d’accès de routage d’un contrat.
Adresse e-mail de l’expéditeur
 senderEmail string

E-mail de l’expéditeur du contrat
Visibilité du document ?
 documentVisibilityEnabled boolean

La visibilité du document est-elle activée
Coffreing activé ?
 vaultingInfo.enabled boolean

Pour les comptes configurés pour le coffre de documents et l’option d’activation par contrat, cela détermine si le document doit être coffreté
Jeux de participants
 participantSetsInfo.participantSets array of WebhookParticipantSets

Le participant définit des informations
Ensembles de participants suivants
 participantSetsInfo.nextParticipantSets array of WebhookParticipantSets

Le participant suivant définit les informations
Documents
 documentsInfo.documents array of WebhookDocument

Liste d’objets représentant les documents
Justificatives
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Liste des documents de prise en charge Cette propriété n’est retournée que s’il existe un document de support dans l’accord
Informations sur le document signé
 signedDocumentInfo.document string

Chaîne encodée en base64 du document signé

WebhookAgreementInfoWithSignedDocument

Informations complètes de l’accord

Nom Chemin d’accès Type Description
ID
 id string

ID unique du contrat
Nom
 name string

Nom de l’accord
Signature Type
 signatureType string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
Statut
 status string

État actuel de l’accord
Ccs
 ccs array of CcInfo

Liste d’une ou de plusieurs CCS qui seront copiées dans la transaction de contrat
Date de création
 createdDate date

Date de création d’un contrat
Visibilité du document ?
 documentVisibilityEnabled boolean

La visibilité du document est-elle activée
Délai d’expiration
 expirationTime string

Heure après laquelle l’accord expire et doit être signé avant
External ID
 externalId.id string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Groupe externe
 externalId.group string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Premier délai de rappel
 firstReminderDelay integer

Entier qui spécifie le délai en heures avant d’envoyer le premier rappel.
Paramètres régionaux
 locale string

Paramètres régionaux associés à ce contrat
Message
 message string

Message facultatif aux participants, décrivant ce qui est envoyé ou pourquoi leur signature est requise
Fréquence de rappel
 reminderFrequency string

Paramètre facultatif qui définit la fréquence à laquelle vous souhaitez envoyer des rappels aux participants. S’il n’est pas spécifié, la fréquence par défaut définie pour le compte sera utilisée
Adresse e-mail de l’expéditeur
 senderEmail string

E-mail de l’expéditeur du contrat
Coffreing activé ?
 vaultingInfo.enabled boolean

Pour les comptes configurés pour le coffre de documents et l’option d’activation par contrat, cela détermine si le document doit être coffreté
Url de redirection de post-signature
 postSignOption.redirectUrl string

URL accessible publiquement à laquelle l’utilisateur sera envoyé après avoir terminé le processus de signature
ID de flux de travail
 workflowId string

ID du flux de travail personnalisé qui définit le chemin d’accès de routage d’un contrat.
Jeux de participants
 participantSetsInfo.participantSets array of WebhookParticipantSets

Le participant définit des informations
Documents
 documentsInfo.documents array of WebhookDocument

Liste d’objets représentant les documents
Justificatives
 documentsInfo.supportingDocuments array of WebhookSupportingDocument

Liste des documents de prise en charge Cette propriété n’est retournée que s’il existe un document de support dans l’accord
Informations sur le document signé
 signedDocumentInfo.document string

Chaîne encodée en base64 du document signé

WebhookMegaSignInfo

Informations complètes du méga-signe

Nom Chemin d’accès Type Description
ID
 id string

ID unique du mégasigne
Nom
 name string

Nom de l’mégasigne
Statut
 status string

État du mégasigne
Ccs
 ccs array of MegaSignCcInfo

Liste d’une ou plusieurs adresses e-mail que vous souhaitez copier sur ce mégasign.
External ID
 externalId.id string

Valeur arbitraire de votre système, qui peut être spécifiée au moment de l’envoi, puis retournée ou interrogée ultérieurement
Premier délai de rappel
 firstReminderDelay integer

Entier qui spécifie le délai en heures avant d’envoyer le premier rappel.
Paramètres régionaux
 locale string

Paramètres régionaux associés à ce contrat
Message
 message string

Message facultatif aux participants, décrivant ce qui est envoyé ou pourquoi leur signature est requise
Url de redirection de post-signature
 postSignOption.redirectUrl string

URL accessible publiquement à laquelle l’utilisateur sera envoyé après avoir terminé le processus de signature
Adresse e-mail de l’expéditeur
 senderEmail string

E-mail du créateur megasign
Signature Type
 signatureType string

Spécifie le type de signature qui a été demandé - Signature électronique ou écrit
Coffreing activé ?
 vaultingInfo.enabled boolean

Pour les comptes configurés pour le coffre de documents et l’option d’activation par contrat, cela détermine si le document doit être coffreté
Informations sur le fichier des contrats enfants
 childAgreementsInfo.fileInfo MegaSignChildAgreementsFileInfo

Informations de fichier contenant les informations relatives aux contrats enfants de megaSign.

WebhookWidgetInfo

Informations complètes du formulaire web

Nom Chemin d’accès Type Description
ID
 id string

ID unique du formulaire web
Nom
 name string

Nom du formulaire web
Statut
 status string

État du formulaire web
Informations sur l’échec d’authentification
 authFailureInfo AuthFailureWidgetRedirectionInfo

URL et propriétés associées pour la page d’erreur que le signataire du formulaire web prend après l’échec de l’authentification
Ccs
 ccs array of WidgetCcInfo

Liste d’une ou de plusieurs adresses e-mail que vous souhaitez copier sur ce formulaire web.
Date de création
 createdDate date

Date de création du formulaire web
Informations d’achèvement
 completionInfo WidgetCompletionRedirectionInfo

URL et propriétés associées pour la page de réussite vers laquelle le signataire du formulaire web sera effectué après avoir effectué l’action souhaitée sur le formulaire web
Adresse e-mail creator
 creatorEmail string

E-mail du créateur du formulaire web
Coffreing activé ?
 vaultingInfo.enabled boolean

Pour les comptes configurés pour le coffre de documents et l’option d’activation par contrat, cela détermine si le document doit être coffreté
Informations supplémentaires sur les jeux de participants
 participantSetsInfo.additionalParticipantSets array of WidgetParticipantSetInfo

Liste de tous les participants au formulaire web, à l’exception du signataire du formulaire web
Premier rôle de jeu de participants
 participantSetsInfo.widgetParticipantSet.role string

Rôle pris par tous les participants dans l’ensemble (signataire, approbateur, etc.)
Première commande de jeu de participants
 participantSetsInfo.widgetParticipantSet.order integer

Index indiquant le groupe de signature séquentiel (spécifié pour le routage hybride)
Documents
 documentsInfo.documents array of WidgetWebhookDocument

Liste d’objets représentant les documents

AuthFailureWidgetRedirectionInfo

URL et propriétés associées pour la page d’erreur que le signataire du formulaire web prend après l’échec de l’authentification

Nom Chemin d’accès Type Description
Délai de redirection des échecs d’authentification
 delay integer

Délai (en secondes) avant que l’utilisateur ne soit dirigé vers la page résultante
Trame de redirection d’échec d’authentification
 deframe boolean

Si la trame est false, la page résultante s’affiche à l’intérieur du cadre de formulaire web
URL de redirection d’échec d’authentification
 url string

URL accessible publiquement à laquelle l’utilisateur sera envoyé après avoir terminé le formulaire web

WidgetCompletionRedirectionInfo

URL et propriétés associées pour la page de réussite vers laquelle le signataire du formulaire web sera effectué après avoir effectué l’action souhaitée sur le formulaire web

Nom Chemin d’accès Type Description
Délai de redirection de saisie semi-automatique
 delay integer

Délai (en secondes) avant que l’utilisateur ne soit dirigé vers la page résultante
Trame de redirection de saisie semi-automatique
 deframe boolean

Si la trame est false, la page résultante s’affiche à l’intérieur du cadre de formulaire web
URL de redirection de saisie semi-automatique
 url string

URL accessible publiquement à laquelle l’utilisateur sera envoyé après avoir terminé le formulaire web

WebhookParticipantSets

Nom Chemin d’accès Type Description
Informations sur les membres
 memberInfos array of MemberInfos

Informations sur les membres du participant
JSON
 order integer

Index indiquant la position à laquelle le groupe de signature doit se signer.
Role
 role string

Rôle pris par tous les participants dans l’ensemble (signataire, approbateur, etc.)
Statut
 status string

État actuel du contrat du point de vue de l’utilisateur
ID
 id string

ID du jeu de participants
Nom
 name string

Nom du jeu de participants
Message privé
 privateMessage string

Message privé pour les participants dans l’ensemble

MegaSignChildAgreementsFileInfo

Informations de fichier contenant les informations relatives aux contrats enfants de megaSign.

Nom Chemin d’accès Type Description
ID de fichier des contrats enfants
 childAgreementsInfoFileId string

ID du fichier contenant des informations sur l’enfantAgreementsInfo existant du megaSign.

WidgetWebhookDocument

Informations sur le document du formulaire web

Nom Chemin d’accès Type Description
ID
 id string

ID unique du document
Nom
 name string

Nom du document

WebhookDocument

Informations sur le document de l’accord

Nom Chemin d’accès Type Description
ID
 id string

ID unique du document
Nom
 name string

Nom du document

WebhookSupportingDocument

Informations sur le document de prise en charge

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

Nom complet du document de prise en charge
Nom du champ
 fieldName string

Nom du champ de document de prise en charge
ID
 id string

ID unique représentant le document de prise en charge

WidgetCcInfo

Informations sur le CC du formulaire web

Nom Chemin d’accès Type Description
Messagerie électronique
 email string

E-mail du participant CC du formulaire web

MegaSignCcInfo

Informations sur le CC du méga sign

Nom Chemin d’accès Type Description
Messagerie électronique
 email string

E-mail du participant CC du mégasign

CcInfo

Informations sur la CC de l’accord

Nom Chemin d’accès Type Description
Messagerie électronique
 email string

E-mail du CC du contrat
Étiquette
 label string

Étiquette de la liste CC retournée dans la description du flux de travail
Pages visibles
 visiblePages array of string

Pages visibles par la cc

WidgetParticipantSetInfo

Nom Chemin d’accès Type Description
Role
 role string

Rôle pris par tous les participants dans l’ensemble (signataire, approbateur, etc.)
ID
 id string

Identificateur unique du jeu de participants
Informations sur les membres
 memberInfos array of MemberInfos

Informations sur les membres du participant
JSON
 order integer

Index indiquant le groupe de signature séquentiel (spécifié pour le routage hybride)

MemberInfos

Nom Chemin d’accès Type Description
ID
 id string

ID unique du participant
Messagerie électronique
 email string

E-mail du participant
Entreprise
 company string

L’entreprise du participant
Nom
 name string

Nom du participant
Message privé
 privateMessage string

Message privé du participant
Statut
 status string

État du participant

LibraryDocumentCreationResponseV6

Objet JSON décrivant le modèle de bibliothèque

Nom Chemin d’accès Type Description
ID du modèle de bibliothèque
 id string

ID unique qui peut être utilisé pour faire référence au modèle de bibliothèque

LibraryDocument

Nom Chemin d’accès Type Description
ID du modèle de bibliothèque
 id string

Identificateur unique utilisé pour faire référence au modèle de bibliothèque
Caché
 hidden boolean

True si le document de bibliothèque est masqué
Type(s) de modèle
 templateTypes array of string

Liste d’un ou de plusieurs types de modèles de bibliothèque
Date de modification
 modifiedDate date

Jour de la dernière modification du modèle de bibliothèque
Nom du modèle de bibliothèque
 name string

Nom du modèle de bibliothèque
Mode de partage de modèle
 sharingMode string

Étendue de la visibilité du modèle de bibliothèque
Adresse e-mail creator
 creatorEmail string

Adresse e-mail du créateur de documents de la bibliothèque.
ID de groupe
 groupId string

Identificateur unique du groupe auquel appartient le modèle de bibliothèque.
Statut
 status string

État du document de bibliothèque

LibraryDocuments

JSON qui contient l’objet de tableau de modèles de bibliothèque

Nom Chemin d’accès Type Description
page
 page page

Informations de pagination pour naviguer dans la réponse
Liste des modèles de bibliothèque
 libraryDocumentList array of LibraryDocument

Liste des éléments de modèle de bibliothèque

UserWidgetV6

Nom Chemin d’accès Type Description
ID de formulaire web
 id string

Identificateur unique d’un formulaire web
Date de modification
 modifiedDate string

Date de dernière modification du formulaire web
Caché
 hidden boolean

True si le contrat est masqué pour l’utilisateur
ID de groupe
 groupId string

Identificateur unique du groupe
Nom
 name string

Nom du formulaire web
Statut
 status string

État du formulaire web
URL
 url string

URL hébergée du formulaire web
Javascript
 javascript string

Code javascript incorporé du formulaire web

userWidgetListV6

JSON qui contient l’objet de tableau de formulaires web utilisateur

Nom Chemin d’accès Type Description
page
 page page

Informations de pagination pour naviguer dans la réponse
Liste de formulaires web
 userWidgetList array of UserWidgetV6

Tableau d’éléments de formulaire web

UserWorkflowV6

Nom Chemin d’accès Type Description
ID de flux de travail
 id string

Identificateur unique d’un flux de travail
Descriptif
 description string

Description fournie pour ce flux de travail au moment de sa création
Date de création
 created string

Date à laquelle le flux de travail a été créé. Le format serait aaaa-MM-dd’T’HH :mm :ssZ
Date de modification
 modified string

Date à laquelle le flux de travail a été modifié. Le format serait aaaa-MM-dd’T’HH :mm :ssZ
Nom
 name string

Nom du flux de travail
Nom d’affichage
 displayName string

Nom complet du flux de travail
Statut
 status string

État du flux de travail
Scope
 scope string

Étendue du flux de travail
ID d’origine
 originatorId string

Origine initiale du flux de travail
ID d’étendue
 scopeId string

Identificateur de l’étendue. Actuellement, il s’applique uniquement à l’étendue GROUP et la valeur sera groupId.

userWorkflowListV6

JSON qui contient l’objet de tableau de flux de travail utilisateur

Nom Chemin d’accès Type Description
Liste de flux de travail
 userWorkflowList array of UserWorkflowV6

Tableau d’éléments de flux de travail

WorkflowDefaultParamsV6

JSON qui contient l’objet params par défaut du flux de travail

Nom Chemin d’accès Type Description
Valeur par défaut
 defaultValue string

Valeur par défaut du champ si l’entrée de ce champ n’est pas fournie et que ce champ est requis
Editable
 editable boolean

Indique si le champ actuel peut être modifié. Si l’attribut modifiable pour ce champ est false, ce champ ne doit pas être fourni dans la demande de création de contrat et la valeur par défaut de ce champ sera utilisée dans la création d’un contrat.
Obligatoire
 required boolean

Indique si ce champ est obligatoire ou facultatif
Visibles
 visible boolean

Indique si le champ actuel est visible ou non. Si l’attribut visible pour ce champ est false, ce champ ne doit pas être visible dans l’interface utilisateur de création du contrat à l’aide de ce flux de travail pour l’utilisateur

CCsListInfoDescriptionV6

JSON qui contient des informations détaillées sur le flux de travail

Nom Chemin d’accès Type Description
Valeurs par défaut
 defaultValues array of string

Tableau d’e-mails par défaut qui seront utilisés si aucune entrée n’est fournie pour cet élément de liste
Editable
 editable boolean

Indique si le champ actuel peut être modifié. Si l’attribut modifiable pour ce champ est false, ce champ ne doit pas être fourni dans la demande de création de contrat et la valeur par défaut de ce champ sera utilisée dans la création d’un contrat.
Étiquette
 label string

Texte d’affichage de l’utilisateur de flux de travail qui peut être utilisé pour la liste CC actuelle
Nombre maximal d’entrées CC
 maxListCount integer

Nombre maximal d’entrées autorisées dans la liste CC actuelle
Min CC entrées
 minListCount integer

Nombre minimal d’entrées autorisées dans la liste CC actuelle
Nom de la liste CC
 name string

Nom de la liste CC actuelle
Obligatoire
 required boolean

Indique si ce champ est obligatoire ou facultatif
Visibles
 visible boolean

Indique si le champ actuel est visible ou non. Si l’attribut visible pour ce champ est false, ce champ ne doit pas être affiché dans la page de création de contrat à l’aide de ce flux de travail

ExpirationFieldInfoDescriptionV6

JSON qui contient des informations sur l’expiration

Nom Chemin d’accès Type Description
Valeur par défaut
 defaultValue string

Valeur par défaut du champ si l’entrée de ce champ n’est pas fournie et que ce champ est requis
Editable
 editable boolean

Indique si le champ actuel peut être modifié. Si l’attribut modifiable pour ce champ est false, ce champ ne doit pas être fourni dans la demande de création de contrat et la valeur par défaut de ce champ sera utilisée dans la création d’un contrat.
Nombre maximal de jours d’expiration du contrat
 maxDays integer

Nombre maximal de jours pour l’expiration du contrat
Obligatoire
 required boolean

Indique si ce champ est obligatoire ou facultatif
Visibles
 visible boolean

Indique si le champ actuel est visible ou non. Si l’attribut visible pour ce champ est false, ce champ ne doit pas être affiché dans la page de création de contrat à l’aide de ce flux de travail

FileInfosDescriptionV6

JSON qui contient des informations sur les fichiers

Nom Chemin d’accès Type Description
Étiquette
 label string

Afficher l’étiquette de ce champ pour les utilisateurs externes
Nom
 name string

Nom de l’élément fileInfo
Obligatoire
 required boolean

Indique si ce champ est obligatoire ou facultatif
Documents de bibliothèque de flux de travail
 workflowLibraryDocumentSelectorList array of WorkflowLibraryDocumentV6

Liste des documents de bibliothèque de flux de travail sur lesquels un document de bibliothèque de flux de travail peut être sélectionné avec cet objet fileInfo

WorkflowLibraryDocumentV6

JSON qui contient des informations sur le document de bibliothèque de flux de travail

Nom Chemin d’accès Type Description
Étiquette
 label string

Texte d’affichage pour ce formulaire pour les utilisateurs de flux de travail
Date de modification
 modifiedDate string

Date de dernière modification du document de la bibliothèque. Le format serait aaaa-MM-dd’T’HH :mm :ssZ. Par exemple, par exemple, 2016-02-25T18:46:19Z représente l’heure UTC
Mode de partage
 sharingMode string

Spécifie qui doit avoir accès à ce document de bibliothèque. Le partage GLOBAL est une opération restreinte
Types de modèles
 templateTypes array of

Liste d’un ou de plusieurs types de modèles de bibliothèque
ID de document de la bibliothèque de flux de travail
 workflowLibDoc string

ID du document de la bibliothèque de flux de travail qui peut être fourni en tant que fichier d’entrée dans la demande de création de contrat de flux de travail personnalisé

LocaleFieldInfoDescriptionV6

JSON qui contient des informations détaillées sur les paramètres régionaux du flux de travail

Nom Chemin d’accès Type Description
Paramètres régionaux disponibles
 availableLocales array of string

Quels paramètres régionaux peuvent être choisis pour ce flux de travail
Valeur par défaut
 defaultValue string

Valeur par défaut du champ si l’entrée de ce champ n’est pas fournie et que ce champ est requis
Editable
 editable boolean

Indique si le champ actuel peut être modifié. Si l’attribut modifiable pour ce champ est false, ce champ ne doit pas être fourni dans la demande de création de contrat et la valeur par défaut de ce champ sera utilisée dans la création d’un contrat.
Obligatoire
 required boolean

Indique si ce champ est obligatoire ou facultatif
Visibles
 visible boolean

Indique si le champ actuel est visible ou non. Si l’attribut visible pour ce champ est false, ce champ ne doit pas être visible dans l’interface utilisateur de création du contrat à l’aide de ce flux de travail pour l’utilisateur

MergeFieldInfoDescriptionV6

JSON qui contient des informations détaillées sur le champ de fusion

Nom Chemin d’accès Type Description
Valeur par défaut
 defaultValue string

Valeur par défaut du champ si l’entrée de ce champ n’est pas fournie et que ce champ est requis
Nom d’affichage
 displayName string

Texte d’affichage pouvant être affiché pour ce champ personnalisé
Editable
 editable boolean

Indique si le champ actuel peut être modifié. Si l’attribut modifiable pour ce champ est false, ce champ ne doit pas être fourni dans la demande de création de contrat et la valeur par défaut de ce champ sera utilisée dans la création d’un contrat.
Nom de champ personnalisé
 fieldName string

Nom du champ personnalisé dans ce flux de travail
Obligatoire
 required boolean

Indique si ce champ est obligatoire ou facultatif
Visibles
 visible boolean

Indique si le champ actif doit être visible sur la page de création de contrat. Si l’attribut visible pour ce champ est false, ce champ ne doit pas être affiché sur la page de création de contrat à l’aide de ce flux de travail

PasswordFieldInfoDescriptionV6

JSON qui contient des informations détaillées sur le mot de passe

Nom Chemin d’accès Type Description
Mot de passe
 defaultValue string

Valeur par défaut du champ d’informations de mot de passe
Editable
 editable boolean

Indique si le champ actuel peut être modifié. Si l’attribut modifiable pour ce champ est false, ce champ ne doit pas être fourni dans la demande de création de contrat et la valeur par défaut de ce champ sera utilisée dans la création d’un contrat.
Étiquette
 label string

Étiquette du champ mot de passe
Nom
 name string

Nom du champ mot de passe
Obligatoire
 required boolean

Indique si ce champ est obligatoire ou facultatif
Visibles
 visible boolean

Indique si le champ d’informations de mot de passe est visible sur la page de création d’un contrat

RecipientsListInfoDescriptionV6

JSON qui contient des informations détaillées sur la liste des destinataires

Nom Chemin d’accès Type Description
Autoriser l’expéditeur
 allowSender boolean

Indique si l’expéditeur est autorisé en tant que destinataire
Autoriser l’expéditeur
 allowfax boolean

Indique si la télécopie est autorisée ou non
Méthode d’authentification
 authenticationMethod string

Méthode d’authentification pour que la liste des destinataires actuelle ait accès à l’affichage et au signe du document,
Valeur e-mail/télécopie par défaut
 defaultValue string

Un e-mail ou un numéro de télécopie par défaut
Editable
 editable boolean

Indique si le champ actuel peut être modifié. Si l’attribut modifiable pour ce champ est false, ce champ ne doit pas être fourni dans la demande de création de contrat et la valeur par défaut de ce champ sera utilisée dans la création d’un contrat.
Étiquette
 label string

Texte d’affichage de l’utilisateur de flux de travail qui peut être utilisé pour la liste des destinataires actuels
Nombre maximal de destinataires
 maxListCount integer

Nombre maximal d’entrées autorisées dans la liste des destinataires actuels
Destinataires minimaux
 minListCount integer

Nombre minimal d’entrées autorisées dans la liste des destinataires actuels
Nom de la liste d’informations du destinataire
 name string

Nom de la liste d’informations du destinataire actuel
Rôle de participant
 role string

Rôle actuel du participant
Visibles
 visible boolean

Indique si le champ actif est visible. Si l’attribut visible pour ce champ est false, ce champ ne doit pas être affiché dans l’interface utilisateur de création de contrat à l’aide de ce flux de travail pour l’utilisateur

WorkflowDescriptionV6

JSON qui contient des informations détaillées sur le flux de travail

Nom Chemin d’accès Type Description
agreementNameInfo
 agreementNameInfo WorkflowDefaultParamsV6

JSON qui contient l’objet params par défaut du flux de travail
authoringInfo
 authoringInfo WorkflowDefaultParamsV6

JSON qui contient l’objet params par défaut du flux de travail
Informations de liste CC
 ccsListInfo array of CCsListInfoDescriptionV6

Informations sur le champ d’entrée de liste CC dans la demande de création de contrat
Date de création du flux de travail
 created string

Jour où le flux de travail a été créé
Description du flux de travail
 description string

Description fournie pour ce flux de travail au moment de sa création
Nom complet du flux de travail
 displayName string

Nom complet du flux de travail
expirationInfo
 expirationInfo ExpirationFieldInfoDescriptionV6

JSON qui contient des informations sur l’expiration
Informations sur les fichiers
 fileInfos array of FileInfosDescriptionV6

Informations sur le champ d’entrée d’informations de fichier dans la demande de création de contrat
localeInfo
 localeInfo LocaleFieldInfoDescriptionV6

JSON qui contient des informations détaillées sur les paramètres régionaux du flux de travail
Informations sur les champs de fusion
 mergeFieldsInfo array of MergeFieldInfoDescriptionV6

Informations sur le champ d’entrée d’informations personnalisées dans la demande de création de contrat
messageInfo
 messageInfo WorkflowDefaultParamsV6

JSON qui contient l’objet params par défaut du flux de travail
Date de modification
 modified string

Jour de la dernière modification du flux de travail
Nom du flux de travail
 name string

Nom du flux de travail
passwordInfo
 passwordInfo PasswordFieldInfoDescriptionV6

JSON qui contient des informations détaillées sur le mot de passe
Informations de liste des destinataires
 recipientsListInfo array of RecipientsListInfoDescriptionV6

Informations sur le champ d’entrée d’informations de l’accord dans la demande de création de contrat
Étendue du flux de travail
 scope string

Étendue du flux de travail
État du flux de travail
 status string

État du flux de travail
ID d’origine du flux de travail
 originatorId string

Origine initiale du flux de travail
ID d’étendue du flux de travail
 scopeId string

Identificateur de l’étendue. Actuellement, il s’applique uniquement à l’étendue GROUP et la valeur sera groupId

BooleanSettingInfoV6

Nom Chemin d’accès Type Description
Valeur
 value boolean

Valeur du paramètre
Hérité
 inherited boolean

True si le paramètre est hérité de sa valeur de groupe ou de compte

SettingsInfoV6

Nom Chemin d’accès Type Description
libaryDocumentCreationVisible
 libaryDocumentCreationVisible BooleanSettingInfoV6
sendRestrictedToWorkflows
 sendRestrictedToWorkflows BooleanSettingInfoV6
userCanSend
 userCanSend BooleanSettingInfoV6
widgetCreationVisible
 widgetCreationVisible BooleanSettingInfoV6

UserGroupInfoV6

Nom Chemin d’accès Type Description
ID de groupe
 id string

Identificateur unique du groupe
Administrateur de groupe
 isGroupAdmin boolean

True si l’utilisateur est administrateur de groupe
Groupe principal
 isPrimaryGroup boolean

True si le groupe est le groupe principal de l’utilisateur
Statut
 status string

État de l’appartenance au groupe
Date de création
 createdDate date

Date de création du groupe
Nom du groupe
 name string

Nom du groupe
settings
 settings SettingsInfoV6

UserGroupsInfoV6

JSON qui contient la liste des groupes pour un utilisateur donné

Nom Chemin d’accès Type Description
Liste des groupes d’utilisateurs
 groupInfoList array of UserGroupInfoV6

Tableau d’éléments d’informations de groupe d’utilisateurs

binaire

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

objet

Il s’agit du type 'object'.

file

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