SigningHub (préversion)

SigningHub by Ascertia fournit une suite complète pour les signatures numériques à haut niveau de fiabilité et l’automatisation du flux de travail de document. Ce connecteur permet aux entreprises d’authentifier en toute sécurité les utilisateurs, de lancer des demandes de signature de documents et de gérer des cycles d’approbation de bout en bout. Conçu pour répondre à des normes de sécurité globales rigoureuses, il garantit que vos flux de travail automatisés restent légalement applicables, transparents et hautement sécurisés dans toute votre organisation.

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

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes : - régions Azure Government - régions de chine Azure - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)

Contact
Nom	Support
URL	https://www.signinghub.com/contact-us/
Messagerie électronique	support@ascertia.com

Métadonnées du connecteur
Publisher	Ascertia Limited.
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Site internet	https://signinghub.com
Politique de confidentialité	https://www.signinghub.com/privacy-policy
Categories	Contenu et fichiers ; Productivité

Connecteur SigningHub

SigningHub fournit une API REST complète qui permet aux organisations d’automatiser et de gérer les flux de travail de signature de documents numériques. À l’aide de ce connecteur, vous pouvez intégrer SigningHub à Power Automate pour simplifier les processus d’approbation de document et automatiser les actions de signature dans des flux de travail personnalisés.

Ce connecteur permet l’automatisation de la signature de documents et d’autres actions SigningHub directement dans Power Automate flux, ce qui aide les organisations à créer des flux de travail de documents efficaces et sécurisés.

Publisher : Ascertia

Prerequisites

Pour utiliser ce connecteur, vous devez disposer des informations suivantes :

Un compte SigningHub actif (https://www.signinghub.com).
Intégration valide définie dans SigningHub.

Comment obtenir des informations d’identification

Remplissez les champs formulaire de connexion avec les valeurs suivantes :

E-mail : e-mail du compte SigningHub.
Mot de passe : mot de passe du compte SigningHub.
ID client d’API : Ascertia ou votre administrateur d’entreprise fournit l’ID client de l’API pour utiliser le connecteur.
Clé secrète client API : Ascertia ou votre administrateur d’entreprise fournit le secret client d’API pour utiliser le connecteur.
URL de l’API : URL de l’API SigningHub, par défaut https://api.signinghub.com

Opérations prises en charge

Ce connecteur fournit une couverture de l’API REST SigningHub. Pour obtenir la liste des actions prises en charge et de leurs paramètres, reportez-vous au Guide de l’API SigningHub.

Liens de support et de support

Limitations

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

Actions

Affecter un champ de document	Les applications métier peuvent utiliser cette API de service pour affecter des utilisateurs à des champs d’entrée, par exemple des champs de signature, et donc définir l’ordre de signature. Les champs doivent déjà être présents dans le document et les utilisateurs doivent être présents dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de la ressource, ainsi que l’identificateur du package. Lorsque les destinataires se trouvent dans un flux de travail, ils sont numérotés, en commençant à un et en comptant chacun d’eux supplémentaire. Par conséquent, s’il existe trois utilisateurs dans un flux de travail, ils sont numérotés « 1 », « 2 » et « 3 » respectueux. Cet appel d’API vous permet d’affecter un utilisateur par son numéro de commande de flux de travail à un champ d’entrée sur le document.
Ajouter des groupes au flux de travail	Les applications métier peuvent utiliser cette API de service pour ajouter des groupes en tant que destinataire à un flux de travail. Un groupe SigningHub signifie que n’importe quel membre du groupe peut effectuer l’action, c’est-à-dire signer, au nom de tous les membres du groupe. Notez que le groupe sera ajouté en tant que dernier utilisateur/groupe dans le flux de travail. Par conséquent, un travail supplémentaire peut être nécessaire pour supprimer un utilisateur/groupe actuel, déjà présent dans le flux de travail. Pendant la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
Ajouter des utilisateurs au flux de travail	Les applications métier peuvent utiliser cette API de service pour ajouter des destinataires à un flux de travail. Cet appel ajoute uniquement un destinataire au flux de travail. Autrement dit, aucun champ du document ne sera automatiquement affecté au ou aux nouveaux destinataires, ni ne créera de nouveaux champs. Notez que le ou les destinataires seront ajoutés en tant que dernière personne dans le flux de travail. Par conséquent, un travail supplémentaire peut être nécessaire pour supprimer un ou plusieurs destinataires actuels déjà présents dans le flux de travail. Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document. Notez que l’entrée accepte un ou plusieurs utilisateurs dans un seul appel. Dans cet appel spécifique, l’utilisateur est une personne physique connue. Toutefois, les mêmes règles s’appliquent aux groupes et aux espaces réservés. Dans l’un de ces cas, le destinataire devient un groupe d’utilisateurs dans lequel un membre du groupe peut signer le document ou un espace réservé.Ce dernier cas est utilisé lorsque vous ne connaissez pas l’identité du signataire prévu. Notez que l’ordre de signature du flux de travail SigningHub commence à « 1 ». Par conséquent, l’ajout d’un utilisateur au flux de travail sans destinataire actuel commence un nouveau nombre de commandes de signature. Le paramètre « signing_order » est obligatoire si le type de flux de travail est « personnalisé ». Important, l’utilisation de cet appel d’API peut affecter le type de flux de travail. S’il existe des destinataires actuels dans un flux de travail séquentiel et qu’un nouveau est ajouté avec le même ordre de signature qu’un destinataire actuel, cette partie du flux de travail passe automatiquement de séquentiel à parallèle. Par conséquent, le flux de travail global est désormais de type personnalisé par opposition à purement séquentiel. L’ajout d’un destinataire avec le même ordre de signature que deux ou destinataires parallèles ne modifie pas le flux de travail. Il n’y a que trois destinataires ou plus à ce point particulier du flux de travail ; tous dans l’ordre parallèle. Notez que bien que la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
Ajouter ou mettre à jour un document à partir de la bibliothèque	Les applications métier peuvent utiliser cette API de service pour ajouter un document de la bibliothèque de l’utilisateur à un package. L’ID de package est fourni dans l’URL, l’ID du document doit également être fourni en tant que « document_id » dans l’URL de ressource pour identifier le document de bibliothèque à copier. Notez qu’un package doit déjà exister avant de pouvoir ajouter un document à l’aide de cet appel.
Ajouter un champ CheckBox	Les applications métier peuvent utiliser cette API de service pour ajouter une case à cocher à un document dans un package. Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail. Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs. Si les paramètres de largeur et de hauteur ne sont pas fournis, une taille par défaut de 10x10 est affectée. Si la largeur ou la hauteur (ou les deux) est fournie, le système compare ces valeurs fournies entre elles. La plus grande valeur entre la largeur et la hauteur est affectée aux deux dimensions.
Ajouter un champ en personne	Les applications métier peuvent utiliser cette API de service pour ajouter un champ de signature de personne à un document d’un package. Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail. Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs. Pour héberger une réunion en personne, un utilisateur SigningHub doit faire partie du flux de travail. Ils doivent être ajoutés avec le rôle « INPERSON_HOST » ou « SIGNER ». Pour l’option hôte, elles ne nécessitent pas de signature ou de champ d’entrée sur le document, et le champ de signature en personne peut être signé par l’utilisateur inscrit non-SigningHub. Notez qu’il s’agit d’un scénario de flux de travail spécial dans lequel il est prévu que l’utilisateur et le destinataire SigningHub se trouvent dans le même emplacement. Ce type de signature n’est pas destiné à être utilisé par le biais duquel un document est partagé avec les destinataires via un lien de messagerie dans la méthode d’intégration libre normale.
Ajouter un champ initial	Les applications métier peuvent utiliser cette API de service pour ajouter un champ d’initialisation à un document dans un package. Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail. Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs.
Ajouter un champ RadioBox	Les applications métier peuvent utiliser cette API de service pour ajouter une case à cocher à un document dans un package. Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail. Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs. Si les paramètres de largeur et de hauteur ne sont pas fournis, une taille par défaut de 10x10 est affectée. Si la largeur ou la hauteur (ou les deux) est fournie, le système compare ces valeurs fournies entre elles. La plus grande valeur entre la largeur et la hauteur est affectée aux deux dimensions.
Ajouter un champ signature numérique	Les applications métier peuvent utiliser cette API de service pour ajouter un champ de signature numérique à un document dans un package. Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail. Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs.
Ajouter un champ TextBox	Les applications métier peuvent utiliser cette API de service pour ajouter un champ d’entrée de texte à un document dans un package. Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail. Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs.
Ajouter un code QR	Les applications métier peuvent utiliser cette API de service pour ajouter un code QR à un document dans un package.
Ajouter un espace réservé au flux de travail	Les applications métier peuvent utiliser cette API de service pour ajouter un espace réservé à un flux de travail dans un package. Un espace réservé est requis lorsque vous ne connaissez pas l’identité du destinataire prévu dans un flux de travail. Notez que l’espace réservé est ajouté en tant que dernier utilisateur du flux de travail. Par conséquent, un travail supplémentaire peut être nécessaire pour supprimer un utilisateur/groupe actuel, déjà présent dans le flux de travail. L’ajout d’un espace réservé vous permet de continuer et d’ajouter des champs de signature et/ou d’entrée au document, qui peuvent ensuite être attribués à des utilisateurs individuels à un stade ultérieur. Pendant la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
Ajouter un package	Cette API de service est utilisée pour ajouter/créer un package de documents pour contenir un ou plusieurs documents. Ce package peut ensuite être utilisé pour ajouter des documents et des destinataires afin de démarrer un nouveau flux de travail. Comme indiqué précédemment, cet appel est obligatoire si vous souhaitez travailler avec des documents. Un package doit exister avant de pouvoir charger ou ajouter des documents à SigningHub.. Même un seul document fait partie d’un package : un package contenant un document. Remarque : un package peut être renommé si nécessaire une fois créé.
Appliquer un modèle de flux de travail	Les applications métier peuvent utiliser cette API de service pour appliquer un modèle de flux de travail à un document. L’ID de document sur lequel le modèle doit être appliqué est fourni dans l’URL de la ressource. Lorsque l’ID de document est défini sur 0, le modèle est appliqué à tous les doucments dans un pacakge. Lors de l’application du modèle, il est important de mémoriser ces deux points importants : Point 1 : si le modèle appliqué est créé à l’aide d’un fichier PDF qui contient déjà des champs de formulaire, assurez-vous que le document sur lequel ce modèle est maintenant appliqué doit contenir ces champs de formulaire à l’avance et SigningHub ne crée pas ces champs de formulaire via le modèle, mais appliquez uniquement les données de formulaire et attribuez-les aux utilisateurs respectifs. Point 2 : si le modèle appliqué est créé, où les champs de formulaire sont ajoutés manuellement (par conséquent, non présents au format PDF à l’origine) via SignatureHub, par exemple, champ de signature initiale, signature en personne, cases à cocher, cases d’option, champs de texte, etc. lors de l’application d’un tel modèle, ces champs de formulaire seront créés sur le document cible même si ces champs de formulaire étaient déjà présents dans le document.
Approuver le document	Les applications métier peuvent utiliser cette API de service pour approuver un document par un utilisateur spécifié dans l’ordre.
Champs de l’autoplacement	Les applications métier peuvent appeler cette API pour ajouter des champs de formulaire de signature ou définis par l’utilisateur à un document en fonction du critère de recherche fourni. Les options de placement sont les suivantes : à gauche, à droite, en haut et en bas. Le document est recherché et toutes les instances des critères de recherche remplis sont traitées. Cela vous permet d’ajouter plusieurs champs avec un seul appel. Par exemple, chargez un document et placez automatiquement un champ de signature à droite de toutes les instances du mot « Signer ici : ». Cela permet de gagner du temps et de s’assurer qu’aucune signature n’est manquée à partir du flux de travail. L’appel d’API prend en charge tous les types de champs ; à savoir électronique, numérique, in-person, initiales et champ de texte, etc. En outre, l’appel d’API prend en charge la variable « order ». Cela signifie que vous pouvez affecter automatiquement un ensemble de champs de signature à un seul utilisateur. Par conséquent, l’appel peut être répété pour placer et affecter des champs de signature à plusieurs utilisateurs dans le flux de travail. Au moins un utilisateur doit exister dans un flux de travail avant que les champs de signature puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail. Cet appel d’API peut être utilisé plusieurs fois sur le même document. La raison de cette opération est de répondre à plusieurs signataires d’un document. Le destinataire ou signataire est identifié par la variable « order » passée dans l’appel. Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs.
Charger le document	Les applications métier peuvent utiliser cette API de service pour ajouter un document à un package de documents lié au compte d’un utilisateur d’entreprise. Les informations de document sont envoyées dans l’en-tête de requête HTTP et les octets de document sont envoyées dans le corps de la requête HTTP. Remarque SigningHub convertit les formats de document pris en charge au format PDF si l’en-tête « x-convert-document » est défini sur la valeur « true ». Le seul cas pris en charge lorsque cette valeur est définie sur « false » consiste à conserver Word format et documents XML. SigningHub prend en charge un large éventail de formats de documents, chacun pouvant être converti en format PDF lors du chargement. Cliquez ici pour obtenir la liste complète. Notez que les documents PDF ne sont pas modifiés lors du chargement sur le système. Notez qu’un package doit déjà exister avant de pouvoir ajouter un document à l’aide de cet appel.
Charger une pièce jointe	Les applications métier peuvent utiliser cette API de service pour charger une pièce jointe dans un document.
Document de rappel	Les applications métier peuvent utiliser cette API de service pour arrêter un flux de travail en cours. L’ID de document est fourni dans l’URL de la ressource. Après rappel, l’état du document passe automatiquement à « DRAFT ».
Document de refus gatekeeper	Les applications métier peuvent utiliser cette API de service pour refuser un document par un utilisateur spécifié dans l’ordre.
Document d’approbation gatekeeper	Les applications métier peuvent utiliser cette API de service pour approuver un document par un utilisateur spécifié dans l’ordre.
Déplacer le package vers un dossier d’espace personnalisé ou partagé	Les applications métier peuvent utiliser cette API de service pour déplacer le package de documents vers un espace partagé ou le dossier personnalisé de l’utilisateur.
Envoyer un document	L’un des rôles SigningHub est appelé « Éditeur ». Cela permet à un destinataire de modifier les champs d’entrée d’un document, mais ne nécessite pas de signature. Une fois que le destinataire a terminé, il envoie ses modifications. Le bouton utilisé dans l’interface graphique utilisateur est appelé « Envoyer ». Il s’agit de l’opération équivalente pour qu’un éditeur envoie ses modifications via un appel d’API. Cliquez sur Rôles SigningHub pour obtenir une description de tous les rôles de destinataire de flux de travail disponibles.
Mettre à jour la stratégie de certification pour un document	Les applications métier peuvent utiliser cette API de service pour mettre à jour les paramètres de signature de certification d’un document dans un package.
Mettre à jour le champ CheckBox	Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ de case à cocher d’un document dans un package. Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé. Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur. La largeur et la hauteur ne peuvent pas être mises à jour. Ils resteront les mêmes que lorsqu’ils ont été ajoutés.
Mettre à jour le champ en personne	Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ de signature en personne d’un document dans un package. Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé. Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur.
Mettre à jour le champ initial	Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ initial d’un document dans un package. Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé. Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur.
Mettre à jour le champ RadioBox	Les applications métier peuvent utiliser cette API de service pour mettre à jour une case d’option d’un document dans un package. Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé. Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur. La largeur et la hauteur ne peuvent pas être mises à jour. Ils resteront les mêmes que lorsqu’ils ont été ajoutés.
Mettre à jour le champ signature numérique	Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ de signature numérique d’un document dans un package. Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé. Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur.
Mettre à jour le champ TextBox	Les applications métier peuvent utiliser cette API de service pour mettre à jour une zone de texte d’un document dans un package. Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé. Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur.
Mettre à jour le code QR	Les applications métier peuvent utiliser cette API de service pour mettre à jour un code QR d’un document dans un package.
Mettre à jour le post-traitement	Les applications métier peuvent utiliser cette API de service pour ajouter un espace réservé à un flux de travail d’un document dans un package.
Mettre à jour les autorisations utilisateur du flux de travail	Les applications métier peuvent utiliser cette API de service pour mettre à jour les autorisations de flux de travail d’un utilisateur qui a déjà été ajouté à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et à des applications métier, vous souhaitez remplacer les autorisations dans le flux de travail. L’ID du package de document est fourni dans l’URL de ressource, et l’utilisateur du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail.
Mettre à jour les détails du flux de travail	Les applications métier peuvent utiliser cette API de service pour mettre à jour les détails du flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document, mais les applications métier veulent remplacer les détails de certification ou de post-traitement. L’ID de package est fourni dans l’URL de la ressource.
Mettre à jour les rappels de flux de travail	Les applications métier peuvent utiliser cette API de service pour mettre à jour les rappels de flux de travail pour un destinataire qui a déjà été ajouté à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et à des applications métier, vous souhaitez remplacer les paramètres des rappels dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de ressource et le destinataire du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail.
Mettre à jour l’authentification utilisateur du flux de travail (ouverture de document) du package Entreprise	Les applications métier peuvent utiliser cette API de service pour mettre à jour les authentifications de package et la durée d’accès pour les destinataires. Cette API peut également être utilisée par l’administrateur d’entreprise ou l’utilisateur d’entreprise si la variable « étendue » a été utilisée dans la demande d’authentification
Mettre à jour l’espace partagé	Les applications métier peuvent utiliser cette API de service pour mettre à jour l’espace partagé. La disponibilité de la mise à jour des espaces partagés est soumise au rôle d’utilisateur d’entreprise affecté. Pour autoriser ce provisionnement, l’administrateur d’entreprise active l’option « Gérer l’espace partagé » dans les paramètres du document rôles>.
Mettre à jour l’espace réservé	Les applications métier peuvent utiliser cette API de service pour mettre à jour un espace réservé dans le flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et aux applications métier souhaite remplacer les détails d’un espace réservé spécifique dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de la ressource, et le espace réservé du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail. Pendant la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
Mettre à jour l’ordre des utilisateurs du flux de travail	Les applications métier peuvent utiliser cette API de service pour mettre à jour l’ordre du destinataire dans le flux de travail.
Mettre à jour l’utilisateur du flux de travail	Les applications métier peuvent utiliser cette API de service pour mettre à jour les détails d’un destinataire, d’un groupe ou d’un espace réservé qui a déjà été ajouté à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et aux applications métier souhaite remplacer les détails d’un utilisateur spécifique dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de ressource et le destinataire du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail. Notez que si la préparation du document de type XML prend uniquement en charge les types de rôles « SIGNER », « REVIEWER » et « CARBON_COPY ».
Obtenir des autorisations utilisateur de flux de travail	Les applications métier peuvent utiliser cette API de service pour obtenir des autorisations de document pour un destinataire. Le destinataire est identifié par l’ordre dans le flux de travail. L’ID du package est fourni dans l’URL de la ressource.
Obtenir des champs de document	Les applications métier peuvent utiliser cette API de service pour obtenir des champs de document, c’est-à-dire des initiales, des personnes, des champs de signature ou des champs de formulaire.
Obtenir des contacts	Les applications métier peuvent utiliser cette API de service pour retener les contacts à partir de contacts personnels et d’entreprise pour l’utilisateur actuel. Il est possible de rechercher en fonction du critère fourni sous l’en-tête « x-search-text ». En outre, il est possible de rechercher les contacts spécifiques d’un utilisateur ou celui de l’entreprise auquel appartient l’utilisateur. Les informations de réponse de recherche contiennent l’adresse e-mail de l’utilisateur et le nom d’utilisateur respectif.
Obtenir des modèles	Les applications métier peuvent utiliser cette API de service pour obtenir la liste des modèles pour l’utilisateur actuel. Il est possible de rechercher en fonction du critère fourni sous l’en-tête « x-search-text ». En outre, il est possible de rechercher les modèles personnels d’un utilisateur ou les modèles d’entreprise comme autorisés par son rôle d’utilisateur par son administrateur d’entreprise.
Obtenir des modèles d’entreprise	Les applications métier peuvent utiliser cette API de service pour obtenir la liste des modèles d’entreprise de l’utilisateur actuel. Cela signifie que l’administrateur d’entreprise ou l’utilisateur d’entreprise si la variable « étendue » a été utilisée dans la demande d’authentification. Il est possible de rechercher en fonction du critère fourni sous l’en-tête « x-search-text ».
Obtenir des packages	Les applications métier peuvent utiliser cette API de service pour obtenir la liste des documents filtrés par différents états. Les utilisateurs peuvent diviser les enregistrements en pages en fournissant un certain nombre d’enregistrements par page.
Obtenir des pièces jointes	Les applications métier peuvent utiliser cette API de service pour obtenir les pièces jointes d’un document.
Obtenir des utilisateurs de flux de travail	Les applications métier peuvent utiliser cette API de service pour obtenir les détails du flux de travail pour le package.
Obtenir les détails du document	Les applications métier peuvent utiliser cette API de service pour obtenir les détails du document. L’ID de document est fourni dans l’URL sous la forme « {document_id} ».
Obtenir les détails du flux de travail	Les applications métier peuvent utiliser cette API de service pour obtenir les détails du flux de travail pour le package.
Obtenir les détails du package	Les applications métier peuvent utiliser cette API de service pour obtenir les détails d’un package. Cette API peut également être utilisée par l’application métier pour effectuer une action au nom de l’utilisateur d’entreprise via l’authentification par étendue.
Obtenir l’authentification utilisateur du flux de travail (ouverture de document) du package Entreprise	Les applications métier peuvent utiliser cette API de service pour activer les paramètres de sécurité d’accès pour le package. Les destinataires pour lesquels la sécurité est configurée sont identifiés par l’ordre dans l’URL. L’ID de package est également identifié dans l’URL de la requête. Les destinataires ne pourront pas accéder au package de documents en dehors de l’étendue de cette durée si la sécurité d’accès est activée. Le propriétaire du document peut également configurer la sécurité basée sur l’authentification du package pour un destinataire.
Obtenir l’historique des flux de travail	Les applications métier peuvent utiliser cette API de service pour récupérer la liste des actions effectuées sur un document. L’ID de package est fourni dans l’URL de la ressource. Le champ de recherche (en-tête x-search-text) est destiné à l’e-mail, au nom du document, à l’action, à l’infokey et à la valeur d’infovalue.
Obtenir un espace partagé	Les applications métier peuvent utiliser cette API de service pour obtenir un espace partagé spécifique. Cette API retourne des informations sur l’espace partagé, son propriétaire et son collaborateur.
Obtenir un rappel de flux de travail	Les applications métier peuvent utiliser cette API de service pour mettre à jour les rappels pour les destinataires qui ont déjà été ajoutés à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et à des applications métier, vous souhaitez remplacer les paramètres des rappels dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de ressource et le destinataire du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail.
Obtenir un rapport de preuve de processus	Les applications métier peuvent utiliser cette API de service pour télécharger le rapport de preuve de processus de flux de travail d’un document.
Obtenir une stratégie de certification pour un document	Les applications métier peuvent utiliser cette API de service pour obtenir des paramètres de signature de certification d’un document dans un package.
Packages de signature en bloc	Les applications métier peuvent utiliser cette API pour signer/partager/signer et partager plusieurs documents (électroniques et numériques) sans afficher les documents à l’utilisateur final. Cette API a besoin d’informations de l’application métier sur les packages de documents et les détails des signatures, des champs en personne et initiales. Lors de la réussite de la transaction de signature en bloc, l’API retourne les états et les ID de transaction des packages de documents. Contrairement à l’API Sign Document, cette API signe non seulement un package de documents, mais également la marque comme approuvée et examinée en fonction de la présence d’un signataire, d’un éditeur ou d’un réviseur. Tout package de document pour lequel l’état retourne comme COMPLETED a été signé, approuvé ou révisé par cette API. La signature en bloc fonctionne avec toutes les méthodes d’authentification au moment de la signature. Si SIGN est transmis en tant que bulk_action et que le package est à l’état Brouillon, sign and Share est effectué automatiquement. Vous devez appeler cette API après l’API De signature en bloc . Si vous devez apporter des modifications dans l’un des documents avant la signature, l’API Champs de formulaire de remplissage doit être appelée avant d’appeler l’API de document de signature en bloc. N’oubliez pas que tous les champs d’entrée obligatoires d’un document doivent être terminés avant que cette API se termine correctement ; alors que les champs renseignés automatiquement (par exemple, Nom, E-mail, Date, Titre du travail, etc.) sont automatiquement renseignés. Le signataire est identifié par le jeton d’accès présenté dans l’appel. Par conséquent, l’authentification du signataire est requise avant d’effectuer cet appel. Vous ne pouvez pas vous authentifier en tant qu’administrateur d’entreprise avec la variable d’étendue et signer un document pour le compte d’un utilisateur. Le jeton d’accès doit être émis au signataire à la suite de l’authentification directe. Une fois le document signé, la réponse de vérification est visible à partir de l’API d’état de signature en bloc . Utilisation du protocole OTP premier ou second facteur pour l’authentification Si l’authentification OTP est activée pour l’opération de signature côté serveur, les applications clientes devront générer un otP pour le numéro mobile à l’aide de l’authentification par signature en bloc via l’appel d’API OTP. Les applications métier respectives doivent récupérer le protocole OTP à partir de l’utilisation et les soumettre lors de l’appel d’API. Pour ce faire, utilisez l’en-tête « x-otp » dans la requête.
Partager le package de documents	Les applications métier peuvent utiliser cette API de service pour partager un package de documents avec les signataires et démarrer un nouveau flux de travail. Le document doit déjà avoir été préparé en appliquant un modèle et éventuellement en mettant à jour les utilisateurs et les actions définis dans le modèle. L’ID de package à partager est fourni dans l’URL de la ressource.
Refuser le document	Les applications métier peuvent utiliser cette API de service pour refuser un document par un utilisateur spécifié dans l’ordre.
Remplir les champs de formulaire	Les applications métier peuvent utiliser cette API de service pour remplir un ou plusieurs champs de formulaire dans un document par un utilisateur spécifié dans l’ordre.
Remplissage des initiales	Les applications métier peuvent utiliser cette API de service pour remplir un champ d’initialisation dans un document par un utilisateur spécifié dans l’ordre.
Renommer le document	Les applications métier peuvent utiliser cette API de service pour renommer un document dans un package.
Renommer le package	Cette API de service est utilisée pour renommer un package de documents. Le package de documents est identifié par son identificateur unique dans l’URL de l’appel.
Signer un document	Les applications métier peuvent utiliser cette API de service pour signer un document (électronique et numérique) sans afficher le document à l’utilisateur final à l’aide de SigningHub. Par exemple, une application métier peut avoir une autre méthode pour afficher le document à l’utilisateur, et seule la fonctionnalité de signature de SigningHub est requise, ou pour les opérations en bloc, il peut être justifié de signer sans demander à l’utilisateur d’afficher et d’approuver chaque document individuellement. S’il existe des modifications à enregistrer dans le document avant la signature, l’API Remplir les champs de formulaire doit être appelée avant d’appeler l’API Sign Document. Notez que les champs d’entrée obligatoires d’un document doivent être terminés avant que cette API se termine correctement. Le signataire est identifié par le jeton d’accès présenté dans l’appel. Par conséquent, l’authentification du signataire est requise avant d’effectuer cet appel. Vous ne pouvez pas vous authentifier en tant qu’administrateur d’entreprise avec la variable d’étendue et signer un document pour le compte d’un utilisateur. Le jeton d’accès doit être émis au signataire à la suite de l’authentification directe. Lorsque cet appel se termine, il est important que si le signataire était le dernier signataire d’un document appelé par l’API Terminer le document . La raison est que, sans appeler cette API, le document reste dans l’état « En cours » au propriétaire du document. Une fois l’API appelée, l’état passe à « Terminé » pour le propriétaire du document. Une fois le document signé, la réponse de vérification est visible à partir de l’API Get Document Verification . Utilisation du protocole OTP premier ou second facteur pour l’authentification Si l’authentification OTP est activée pour l’opération de signature côté serveur, les applications clientes doivent générer un otP pour le numéro mobile à l’aide de l’authentification du signataire via l’appel d’API OTP. Les applications métier respectives doivent récupérer le protocole OTP à partir de l’utilisation et les soumettre lors de l’appel d’API. Pour ce faire, utilisez l’en-tête « x-otp » dans la requête.
Supprimer le champ document	Les applications métier peuvent utiliser cette API de service pour supprimer un champ de document dans un package.
Supprimer le document	Les applications métier peuvent utiliser cette API de service pour supprimer un document dans un package.
Supprimer le package	Les applications métier peuvent utiliser cette API de service pour supprimer un document de la boîte de réception utilisateur. L’ID de package est fourni dans l’URL de ressource sous la forme « {package_id} ». Si l’état du document est EN ATTENTE, il est automatiquement refusé suite à l’opération de suppression. Si l’état du document est PARTAGÉ, le document est automatiquement rappelé et le flux de travail est arrêté avant la suppression du document.
Supprimer l’espace partagé	Les applications métier peuvent utiliser cette API de service pour supprimer de l’espace partagé. La disponibilité de la suppression d’espaces partagés est soumise au rôle d’utilisateur d’entreprise attribué. Pour autoriser ce provisionnement, l’administrateur d’entreprise active l’option « Gérer l’espace partagé » dans les paramètres du document rôles>.
Supprimer un utilisateur de flux de travail	Les applications métier peuvent utiliser cette API de service pour supprimer le destinataire du flux de travail.
Supprimer une pièce jointe	Les applications métier peuvent utiliser cette API de service pour supprimer la pièce jointe d’un document.
Terminer le flux de travail au milieu (terminer le flux de travail)	Les applications métier peuvent marquer le flux de travail terminé même au milieu du flux de travail. Utilisez cette API de service pour modifier l’état du flux de travail à terminer. S’il existe des destinataires qui n’ont pas encore signé le document. Leur signature ne sera plus nécessaire et ne pourra plus voir le document dans sa boîte de réception. Le jeton du porteur doit appartenir au propriétaire du document ou à l’administrateur d’entreprise peut utiliser la variable d’étendue pour obtenir le jeton d’accès pour le compte du propriétaire du document pour effectuer cette action.
Terminer le traitement	Les applications métier peuvent utiliser cette API de service pour terminer le traitement du document après avoir signé tous les champs de signature. Cette méthode est principalement utilisée par les applications mobiles SigningHub natives pour iOS et Android et les cas d’usage web mobiles. Les applications métier générales qui utilisent une intégration étroite dans leur portail respectif n’ont pas besoin d’appeler cette méthode. Toutefois, lors de l’utilisation de l’API Sign Document (et par conséquent, l’utilisateur n’est pas présenté avec une représentation visuelle du document qu’il est invité à signer) l’appel de cette API est nécessaire pour garantir que le flux de travail respectif continue ou se termine. Par exemple, une fois que toutes les signatures ont été appliquées à l’aide de l’API « blind » Sign Document, le document ne s’affiche pas comme état « Terminé » au propriétaire tant que cette API n’est pas appelée. Le propriétaire du document voit l’état « En cours » jusqu’à ce que cette API soit appelée. Dans les cas d’usage web mobiles et d’applications mobiles SigningHub natives, cet appel est nécessaire pour s’assurer que chaque utilisateur effectue ses actions respectives en ce qui concerne SigningHub.Par exemple, une fois qu’un signataire a signé un document dans l’application SigningHub, cette méthode est appelée par l’application pour garantir que le flux de travail continue de traiter et que le signataire suivant est averti, et l’état du document est disponible via l’URL de rappel configurée.
Télécharger la pièce jointe	Les applications métier peuvent utiliser cette API de service pour télécharger la pièce jointe d’un document.
Télécharger le document	Les applications métier peuvent utiliser cette API de service pour télécharger les octets de document. L’ID de package et l’ID de document sont fournis dans l’URL de la ressource.
Télécharger le package	Les applications métier peuvent utiliser cette API de service pour télécharger le package de documents au format binaire. L’ID de package est fourni dans l’URL de la ressource. Si le package ne contient qu’un seul document, le téléchargement est le document PDF binaire. Sinon, si le package comporte plusieurs documents, le téléchargement est le fichier zip binaire de tous les documents. Les en-têtes x-password et x-otp sont facultatifs. Elles sont requises si le propriétaire du document les définit pendant la phase de création du flux de travail.
État de signature en bloc	Les applications métier peuvent utiliser cette API pour obtenir l’état d’une transaction de signature en bloc spécifique, ainsi que les détails des packages de documents qui ont été traités par l’API Packages de signature en bloc . Vous devez appeler cette API après l’API Packages de signature en bloc. Le signataire est identifié par le jeton d’accès présenté dans l’appel. Par conséquent, l’authentification du signataire est requise avant d’effectuer cet appel. Vous ne pouvez pas vous authentifier en tant qu’administrateur d’entreprise avec la variable d’étendue et signer un document pour le compte d’un utilisateur. Le jeton d’accès doit être émis au signataire à la suite de l’authentification directe. Pour la signature RAS, la propriété ACTION sera REMOTE_AUTHORIZATION_REQURIED et la propriété STATUS sera EN ATTENTE, indiquant que la demande doit être autorisée à l’aide de l’appareil mobile. Si le processus de signature échoue dans un document en raison de différents niveaux d’assurance configurés et que l’utilisateur souhaite relancer le processus de signature pour terminer le processus de signature sur les documents ayant échoué, la propriété ACTION est REINITIATE_SIGNING_PROCESS et la propriété STATUS est EN ATTENTE.

Affecter un champ de document

ID d’opération :: V4_Fields_AutoAssignField

Les applications métier peuvent utiliser cette API de service pour affecter des utilisateurs à des champs d’entrée, par exemple des champs de signature, et donc définir l’ordre de signature. Les champs doivent déjà être présents dans le document et les utilisateurs doivent être présents dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de la ressource, ainsi que l’identificateur du package.

Lorsque les destinataires se trouvent dans un flux de travail, ils sont numérotés, en commençant à un et en comptant chacun d’eux supplémentaire. Par conséquent, s’il existe trois utilisateurs dans un flux de travail, ils sont numérotés « 1 », « 2 » et « 3 » respectueux. Cet appel d’API vous permet d’affecter un utilisateur par son numéro de commande de flux de travail à un champ d’entrée sur le document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’utilisateur de workflow doit être mis à jour.
field_name	field_name	True	string	Nom du champ de signature à attribuer.
radio_group_name	radio_group_name		string	indiquez le nom du groupe pour la case d’option
order	order	True	integer	Ordre de l’utilisateur dans le flux de travail auquel le champ est affecté.
level_of_assurance	level_of_assurance		array of string	Niveau d’assurance à ajouter. Les valeurs possibles sont « ELECTRONIC_SIGNATURE », « ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SEAL », « QUALIFIED_ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SIGNATURE », « HIGH_TRUST_ADVANCED », « QUALIFIED_ELECTRONIC_SIGNATURE »

Retours

response: object

Ajouter des groupes au flux de travail

ID d’opération :: V4_Workflow_WorkflowAddGroup

Les applications métier peuvent utiliser cette API de service pour ajouter des groupes en tant que destinataire à un flux de travail. Un groupe SigningHub signifie que n’importe quel membre du groupe peut effectuer l’action, c’est-à-dire signer, au nom de tous les membres du groupe.

Notez que le groupe sera ajouté en tant que dernier utilisateur/groupe dans le flux de travail. Par conséquent, un travail supplémentaire peut être nécessaire pour supprimer un utilisateur/groupe actuel, déjà présent dans le flux de travail. Pendant la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package pour lequel le groupe doit être ajouté.
group_name	group_name		string	Nom du nouveau groupe à ajouter dans le flux de travail.
email_notification	email_notification	True	boolean	La définition de sa valeur sur « true » envoie une notification par e-mail à l’utilisateur lorsque son tour arrive dans le flux de travail. La définition de sa valeur sur « false » n’envoie pas la notification par e-mail à l’utilisateur à son tour. Si aucune valeur n’est fournie, la valeur par défaut « true » est définie.
role	role	True		Rôle du groupe en tant que destinataire dans le flux de travail. La valeur possible est « SIGNER », « REVIEWER », « EDITOR », « CARBON_COPY » et « INPERSON_HOST ». Toutefois, alors que la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
signing_order	signing_order		integer	Ordre dans lequel le flux de travail sera signé par les destinataires. Cet ordre de signature est important lorsque le type de flux de travail est défini sur « CUSTOM ».

Retours

response: array of CollaboratorGroupResponse

Ajouter des utilisateurs au flux de travail

ID d’opération :: V4_Workflow_WorkflowAddUser

Les applications métier peuvent utiliser cette API de service pour ajouter des destinataires à un flux de travail. Cet appel ajoute uniquement un destinataire au flux de travail. Autrement dit, aucun champ du document ne sera automatiquement affecté au ou aux nouveaux destinataires, ni ne créera de nouveaux champs.

Notez que le ou les destinataires seront ajoutés en tant que dernière personne dans le flux de travail. Par conséquent, un travail supplémentaire peut être nécessaire pour supprimer un ou plusieurs destinataires actuels déjà présents dans le flux de travail.

Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document.

Notez que l’entrée accepte un ou plusieurs utilisateurs dans un seul appel.

Dans cet appel spécifique, l’utilisateur est une personne physique connue. Toutefois, les mêmes règles s’appliquent aux groupes et aux espaces réservés. Dans l’un de ces cas, le destinataire devient un groupe d’utilisateurs dans lequel un membre du groupe peut signer le document ou un espace réservé.Ce dernier cas est utilisé lorsque vous ne connaissez pas l’identité du signataire prévu.

Notez que l’ordre de signature du flux de travail SigningHub commence à « 1 ». Par conséquent, l’ajout d’un utilisateur au flux de travail sans destinataire actuel commence un nouveau nombre de commandes de signature. Le paramètre « signing_order » est obligatoire si le type de flux de travail est « personnalisé ».

Important, l’utilisation de cet appel d’API peut affecter le type de flux de travail. S’il existe des destinataires actuels dans un flux de travail séquentiel et qu’un nouveau est ajouté avec le même ordre de signature qu’un destinataire actuel, cette partie du flux de travail passe automatiquement de séquentiel à parallèle. Par conséquent, le flux de travail global est désormais de type personnalisé par opposition à purement séquentiel. L’ajout d’un destinataire avec le même ordre de signature que deux ou destinataires parallèles ne modifie pas le flux de travail. Il n’y a que trois destinataires ou plus à ce point particulier du flux de travail ; tous dans l’ordre parallèle.

Notez que bien que la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package SigningHub auquel les destinataires doivent être ajoutés.
user_email	user_email		string	Adresse e-mail de l’utilisateur à ajouter dans le flux de travail.
nom_utilisateur	user_name	True	string	Nom du destinataire à ajouter dans le flux de travail.
user_national_id	user_national_id		string	ID national de l’utilisateur du destinataire
email_notification	email_notification	True	boolean	Si la valeur est true, SigningHub envoie des notifications à l’utilisateur par e-mail en fonction des paramètres de notification utilisateur et propriétaire du document. La valeur false signifie qu’aucune notification n’est envoyée à l’utilisateur tout au long du flux de travail.
role	role	True		Rôle du destinataire dans le flux de travail. Les valeurs possibles sont « SIGNER », « REVIEWER », « EDITOR », « CARBON_COPY » ou « INPERSON_HOST ». Toutefois, alors que la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
signing_order	signing_order		integer	Ordre du destinataire dans le flux de travail. Cet ordre de signature est obligatoire lorsque le type de flux de travail est « CUSTOM ».
delivery_method	delivery_method	True		Méthode de remise du destinataire dans le flux de travail. Les valeurs possibles sont « EMAIL », « SMS » ou « EMAIL_AND_SMS ». La valeur par défaut est EMAIL
mobile_number	mobile_number		string	Numéro de portable

Retours

response: array of CollaboratorResponse

Ajouter ou mettre à jour un document à partir de la bibliothèque

ID d’opération :: V4_Documents_UploadFromLibrary

Les applications métier peuvent utiliser cette API de service pour ajouter un document de la bibliothèque de l’utilisateur à un package. L’ID de package est fourni dans l’URL, l’ID du document doit également être fourni en tant que « document_id » dans l’URL de ressource pour identifier le document de bibliothèque à copier.

Notez qu’un package doit déjà exister avant de pouvoir ajouter un document à l’aide de cet appel.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document de la bibliothèque qui doit être ajouté/mis à jour
ID de document ancien	x-document-id		string	ID de l’ancien document du package actuel qui doit être mis à jour

Retours

Corps: UploadDocumentLibraryResponse

Ajouter un champ CheckBox

ID d’opération :: V4_Checkbox_AddCheckBox

Les applications métier peuvent utiliser cette API de service pour ajouter une case à cocher à un document dans un package.

Au moins un utilisateur doit exister dans un flux de travail avant que les champs (entrée et signature) puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail.

Pour plus d’informations, consultez Ajouter des utilisateurs au flux de travail . Notez que si vous avez un document avec un modèle appliqué ou si vous en avez appliqué un à l’aide des API, le flux de travail contiendra déjà des utilisateurs.

Si les paramètres de largeur et de hauteur ne sont pas fournis, une taille par défaut de 10x10 est affectée. Si la largeur ou la hauteur (ou les deux) est fournie, le système compare ces valeurs fournies entre elles. La plus grande valeur entre la largeur et la hauteur est affectée aux deux dimensions.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
order	order	True	integer	Ordre de l’utilisateur dans le flux de travail pour lequel le champ est ajouté.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
field_name	field_name		string	Nom du champ fourni à ajouter. S’il n’est pas fourni, le système affecte un nom généré automatiquement unique au champ.
valeur	value		string	Valeur du champ. Les valeurs possibles sont « true » ou « false »
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
validation_rule	validation_rule		string	Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».

Retours

Corps: AddFieldResponse

Ajouter un champ en personne

ID d’opération :: V4_InPerson_AddInPerson

Les applications métier peuvent utiliser cette API de service pour ajouter un champ de signature de personne à un document d’un package.

Pour héberger une réunion en personne, un utilisateur SigningHub doit faire partie du flux de travail. Ils doivent être ajoutés avec le rôle « INPERSON_HOST » ou « SIGNER ». Pour l’option hôte, elles ne nécessitent pas de signature ou de champ d’entrée sur le document, et le champ de signature en personne peut être signé par l’utilisateur inscrit non-SigningHub.

Notez qu’il s’agit d’un scénario de flux de travail spécial dans lequel il est prévu que l’utilisateur et le destinataire SigningHub se trouvent dans le même emplacement. Ce type de signature n’est pas destiné à être utilisé par le biais duquel un document est partagé avec les destinataires via un lien de messagerie dans la méthode d’intégration libre normale.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
order	order	True	integer	Ordre de l’utilisateur dans le flux de travail pour lequel le champ est ajouté.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
field_name	field_name		string	Nom du champ à ajouter. S’il n’est pas fourni, le système affecte un nom généré automatiquement unique au champ.
Espace réservé	placeholder	True	string	Identificateur de chaîne pour le champ d’identité, il peut s’agir de Customer, Jack, CEO, etc.
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
Affichage	display		string	Visibilité du champ à ajouter, les valeurs possibles sont « VISIBLE » et « INVISIBLE »
level_of_assurance	level_of_assurance		array of string	Niveau d’assurance à mettre à jour. Les valeurs possibles sont « ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SEAL », « QUALIFIED_ELECTRONIC_SEAL », « ELECTRONIC_SIGNATURE »
authentication_signing	authentication_signing			Authentification par champ

Retours

Corps: AddFieldResponse

Ajouter un champ initial

ID d’opération :: V4_Initials_AddInitial

Les applications métier peuvent utiliser cette API de service pour ajouter un champ d’initialisation à un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
order	order	True	integer	Ordre de l’utilisateur dans le flux de travail pour lequel le champ est ajouté.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
field_name	field_name		string	Nom du champ à ajouter. S’il n’est pas fourni, le système affecte un nom généré automatiquement unique au champ.
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.

Retours

Corps: AddFieldResponse

Ajouter un champ RadioBox

ID d’opération :: V4_Radio_AddRadioBox

Les applications métier peuvent utiliser cette API de service pour ajouter une case à cocher à un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
order	order	True	integer	Ordre de l’utilisateur dans le flux de travail pour lequel le champ est ajouté.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
field_name	field_name		string	Nom du champ fourni à ajouter. S’il n’est pas fourni, le système affecte un nom généré automatiquement unique au champ.
valeur	value		string	Valeur du champ. Les valeurs possibles sont « true » ou « false »
validation_rule	validation_rule	True		Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
radio_group_name	radio_group_name	True	string
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.

Retours

Corps: AddFieldResponse

Ajouter un champ signature numérique

ID d’opération :: V4_Signature_AddSignature

Les applications métier peuvent utiliser cette API de service pour ajouter un champ de signature numérique à un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel les détails du flux de travail doivent être mis à jour.
ID du document	documentId	True	integer	ID du document dans lequel le champ doit être ajouté.
order	order	True	integer	Ordre du destinataire pour lequel le champ est créé.
page_no	page_no	True	integer	Numéro de page auquel le champ est sur le point d’être créé.
field_name	field_name		string	Nom du champ à ajouter. S’il n’est pas fourni, le système affecte un nom généré automatiquement unique au champ.
level_of_assurance	level_of_assurance		array of string	Niveau d’assurance à ajouter. Les valeurs possibles sont « ELECTRONIC_SIGNATURE », « ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SEAL », « QUALIFIED_ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SIGNATURE », « HIGH_TRUST_ADVANCED », « QUALIFIED_ELECTRONIC_SIGNATURE »
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
Affichage	display		string	Visibilité du champ à ajouter, les valeurs possibles sont « VISIBLE » et « INVISIBLE »
authentication_signing	authentication_signing			Authentification par champ

Retours

Corps: SignatureFieldResponse

Ajouter un champ TextBox

ID d’opération :: V4_TextBox_AddTextBox

Les applications métier peuvent utiliser cette API de service pour ajouter un champ d’entrée de texte à un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
order	order	True	integer	Ordre de l’utilisateur dans le flux de travail pour lequel le champ est ajouté.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
type	type	True		Type du champ, les valeurs possibles sont « TEXT », « NAME », « EMAIL », « COMPANY », « JOBTITLE », « DATE ». Tous les champs de texte sont ensuite automatiquement renseignés en mode en attente avec les attributs/données du destinataire.
valeur	value		string	Valeur du champ. Pour type = DATE, la valeur est censée suivre le format ISO 8601. Suivant le format AAAA -MM-DD hh :mm :ss +00. Comme les valeurs concernent les champs de date, les applications clientes peuvent envoyer aaaa-MM-DD et ignorer hh :mm :ss +00. Si la valeur n’est pas au format approprié, une erreur est retournée.
Espace réservé	placeholder		string	Texte d’espace réservé pour le champ de texte. Pour le nom, l’e-mail, l’entreprise, le titre du travail et la date, la valeur de l’espace réservé peut être « NAME », « EMAIL », « COMPANY », « JOBTITLE », « DATE ». Les développeurs peuvent envoyer leurs propres espaces réservés pour remplacer les valeurs par défaut. Pour les développeurs « TEXT » peuvent fournir leurs propres textes d’espace réservé. Ces espaces réservés apparaissent dans les champs de texte lors de l’affichage du document dans la visionneuse.
longueur_maximale	max_length	True	integer	Longueur maximale de la valeur autorisée dans le champ. Doit entre 1 et 9999
format	format		string	Format de texte du champ. Utilisé uniquement pour le champ type de date. Les valeurs possibles sont les suivantes : m/d m/d/yy m/d/aaaa mm/jj/aaaa mm/jj/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-yy d-mmm-aaaa dd-mmm-yy dd-mmm-aaaa yy-mm-dd aaaa-mm-jj mmm-yy mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyyy
field_name	field_name		string	Nom du champ à ajouter. S’il n’est pas fourni, le système affecte un nom généré automatiquement unique au champ.
field_locale	field_locale		string	Champ local. Les valeurs possibles sont ar-AE \| en-US. Facultatif et par défaut sera en-US. Cette valeur est importante pour le type « DATE ».
field_type	field_type	True		Type de champ en ce qui concerne l’acceptation du type de valeurs, les valeurs possibles sont « NUMBER » ou « TEXT ».
validation_rule	validation_rule	True		Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
validation	validation			Validations
police	font	True		Police du texte des champs
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
multiligne	multiline	True	boolean	Si la valeur est true, le champ zone de texte est créé

Retours

Corps: AddFieldResponse

Ajouter un code QR

ID d’opération :: V4_QR_AddQRCode

Les applications métier peuvent utiliser cette API de service pour ajouter un code QR à un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
field_name	field_name		string	Nom du champ fourni à ajouter. S’il n’est pas fourni, le système affecte un nom généré automatiquement unique au champ.
dimensions	dimensions	True		Dimensions de champ
données	data		string	Données de texte brut à encoder dans le code QR. La valeur par défaut est l’URL générée pour accéder au document associé. par exemple {base_url}/document/{document_unique_id}
options	options			Paramètres relatifs aux options
color	color			Paramètres relatifs à la couleur
logo	logo			Paramètres relatifs au logo

Retours

Corps: AddQrCodeResponse

Ajouter un espace réservé au flux de travail

ID d’opération :: V4_Workflow_WorkflowAddPlaceholder

Les applications métier peuvent utiliser cette API de service pour ajouter un espace réservé à un flux de travail dans un package. Un espace réservé est requis lorsque vous ne connaissez pas l’identité du destinataire prévu dans un flux de travail.

Notez que l’espace réservé est ajouté en tant que dernier utilisateur du flux de travail. Par conséquent, un travail supplémentaire peut être nécessaire pour supprimer un utilisateur/groupe actuel, déjà présent dans le flux de travail.

L’ajout d’un espace réservé vous permet de continuer et d’ajouter des champs de signature et/ou d’entrée au document, qui peuvent ensuite être attribués à des utilisateurs individuels à un stade ultérieur. Pendant la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package pour lequel l’espace réservé doit être ajouté.
Espace réservé	placeholder		string	Nom du nouvel espace réservé à ajouter dans le flux de travail.
email_notification	email_notification	True	boolean	La définition de sa valeur sur « true » envoie une notification par e-mail à l’utilisateur lorsque son tour arrive dans le flux de travail. La définition de sa valeur sur « false » n’envoie pas la notification par e-mail à l’utilisateur à son tour.
role	role	True		Rôle du groupe en tant que destinataire dans le flux de travail. La valeur possible est « SIGNER », « REVIEWER », « EDITOR », « CARBON_COPY » et « INPERSON_HOST ». Toutefois, alors que la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
signing_order	signing_order		integer	Ordre dans lequel le flux de travail sera signé par les destinataires. Cet ordre de signature est important lorsque le type de flux de travail est défini sur « CUSTOM ».

Retours

response: array of CollaboratorPlaceholderResponse

Ajouter un package

ID d’opération :: V4_Package_AddPackage

Cette API de service est utilisée pour ajouter/créer un package de documents pour contenir un ou plusieurs documents. Ce package peut ensuite être utilisé pour ajouter des documents et des destinataires afin de démarrer un nouveau flux de travail.

Comme indiqué précédemment, cet appel est obligatoire si vous souhaitez travailler avec des documents. Un package doit exister avant de pouvoir charger ou ajouter des documents à SigningHub..

Même un seul document fait partie d’un package : un package contenant un document.

Remarque : un package peut être renommé si nécessaire une fois créé.

Paramètres

Nom	Clé	Obligatoire	Type	Description
package_name	package_name		string	Nom du package. Le nom du package par défaut est toujours « Sans titre » si la package_name n’est pas fournie.
workflow_mode	workflow_mode	True		Mode du flux de travail, il existe trois types de modes de flux de travail pris en charge dans l’application. Les valeurs possibles sont « ONLY_ME », « ME_AND_OTHERS » et « ONLY_OTHERS »
folder_name	folder_name		string	Nom du dossier. Il sera utilisé pour charger le package dans n’importe quel dossier de l’utilisateur, soit il s’agit d’un dossier personnalisé ou d’un dossier partagé.

Retours

Corps: AddPackageResponse

Appliquer un modèle de flux de travail

ID d’opération :: V4_Workflow_ApplyTemplate

Les applications métier peuvent utiliser cette API de service pour appliquer un modèle de flux de travail à un document. L’ID de document sur lequel le modèle doit être appliqué est fourni dans l’URL de la ressource. Lorsque l’ID de document est défini sur 0, le modèle est appliqué à tous les doucments dans un pacakge.

Lors de l’application du modèle, il est important de mémoriser ces deux points importants :

Point 1 : si le modèle appliqué est créé à l’aide d’un fichier PDF qui contient déjà des champs de formulaire, assurez-vous que le document sur lequel ce modèle est maintenant appliqué doit contenir ces champs de formulaire à l’avance et SigningHub ne crée pas ces champs de formulaire via le modèle, mais appliquez uniquement les données de formulaire et attribuez-les aux utilisateurs respectifs.

Point 2 : si le modèle appliqué est créé, où les champs de formulaire sont ajoutés manuellement (par conséquent, non présents au format PDF à l’origine) via SignatureHub, par exemple, champ de signature initiale, signature en personne, cases à cocher, cases d’option, champs de texte, etc. lors de l’application d’un tel modèle, ces champs de formulaire seront créés sur le document cible même si ces champs de formulaire étaient déjà présents dans le document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le modèle doit être appliqué.
ID du document	documentId	True	integer	ID de document sur lequel le modèle doit être appliqué. Si la valeur est définie sur 0, si le modèle doit être appliqué à tous les documents du package.
template_name	template_name	True	string	Nom du modèle à appliquer sur le document.
apply_to_all	apply_to_all	True	boolean	True, si le modèle doit être appliqué à tous les documents du package.

Retours

Corps: DocumentDetailsResponse

Approuver le document

ID d’opération :: V4_Package_Approve

Les applications métier peuvent utiliser cette API de service pour approuver un document par un utilisateur spécifié dans l’ordre.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à approuver.
raison	reason		string	Motif de l’approbation d’un package.
Mot de passe d’accès au document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
Document One-Time mot de passe	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Champs de l’autoplacement

ID d’opération :: V4_Fields_AutoPlace

Les applications métier peuvent appeler cette API pour ajouter des champs de formulaire de signature ou définis par l’utilisateur à un document en fonction du critère de recherche fourni. Les options de placement sont les suivantes : à gauche, à droite, en haut et en bas. Le document est recherché et toutes les instances des critères de recherche remplis sont traitées. Cela vous permet d’ajouter plusieurs champs avec un seul appel. Par exemple, chargez un document et placez automatiquement un champ de signature à droite de toutes les instances du mot « Signer ici : ». Cela permet de gagner du temps et de s’assurer qu’aucune signature n’est manquée à partir du flux de travail.

L’appel d’API prend en charge tous les types de champs ; à savoir électronique, numérique, in-person, initiales et champ de texte, etc.

En outre, l’appel d’API prend en charge la variable « order ». Cela signifie que vous pouvez affecter automatiquement un ensemble de champs de signature à un seul utilisateur. Par conséquent, l’appel peut être répété pour placer et affecter des champs de signature à plusieurs utilisateurs dans le flux de travail.

Au moins un utilisateur doit exister dans un flux de travail avant que les champs de signature puissent être ajoutés au document de cette façon. Le numéro de commande correspond au destinataire du flux de travail. Par conséquent, ce nombre doit être égal ou inférieur au nombre total d’utilisateurs dans le flux de travail. L’exemple ci-dessous affecte ce nouveau champ de signature à la première personne du flux de travail.

Cet appel d’API peut être utilisé plusieurs fois sur le même document. La raison de cette opération est de répondre à plusieurs signataires d’un document. Le destinataire ou signataire est identifié par la variable « order » passée dans l’appel.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document pour lequel les champs sont demandés.
search_text	search_text		string	Word qui doit être recherché dans le document.
order	order	True	integer	Ordre de l’utilisateur auquel les champs seront attribués automatiquement. Flux de travail dans les destinataires de commandes SigningHub. Cette liste commence par « 1 » pour le premier signataire désigné.
placement	placement		string	Si le texte est trouvé, les champs doivent être placés dans le document. L’emplacement du champ peut être mentionné dans cet attribut. Les valeurs possibles de placement d’un champ sont LEFT, RIGHT, TOP, BOTTOM. Si aucune valeur n’est fournie, la valeur par défaut est LEFT.
field_type	field_type		string	Type de champ à créer dans le document. Les valeurs possibles sont « SIGNATURE », « IN_PERSON_SIGNATURE », « INITIALS », « TEXT », « NUMBER », « NAME », « EMAIL », « COMPANY », « JOBTITLE », « RADIOBOX », « CHECKBOX », « DATE », « ATTACHMENT »
level_of_assurance	level_of_assurance		array of string	Niveau d’assurance à mettre à jour. Les valeurs possibles sont « ELECTRONIC_SIGNATURE », « ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SEAL », « QUALIFIED_ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SIGNATURE », « HIGH_TRUST_ADVANCED », « QUALIFIED_ELECTRONIC_SIGNATURE »
dimensions	dimensions			Dimensions d’un champ à créer dans le document. L’emplacement X et Y est calculé automatiquement. L’API ne peut configurer la largeur et la hauteur que pour le champ. Si les dimensions ne sont pas fournies, les dimensions par défaut sont suivies. soit 200 x 80 pixels.
Espace réservé	placeholder		string	Indiquez la note dans le cas d’une pièce jointe obligatoire
radio_group_name	radio_group_name		string	Nom du groupe requis uniquement lors de l’ajout d’un champ de type Radio Box pour regrouper plusieurs cases d’option.
format	format		string	Format de texte du champ. Utilisé uniquement pour le champ type de date. Les valeurs possibles sont les suivantes : m/d m/d/yy m/d/aaaa mm/jj/aaaa mm/jj/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-yy d-mmm-aaaa dd-mmm-yy dd-mmm-aaaa yy-mm-dd aaaa-mm-jj mmm-yy mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyyy
valeur	value		string	Valeur que l’utilisateur souhaite afficher dans le champ.
longueur_maximale	max_length	True	integer	Longueur maximale de la valeur autorisée dans le champ. Doit entre 1 et 9999
validation_rule	validation_rule		string	Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
validation	validation			Validations
police	font			Police du texte des champs
multiligne	multiline	True	boolean	Cela appartient au type de champ Zone de texte et si la valeur est true, le champ zone de texte est créé avec l’option multiligne.

Retours

response: array of AutoPlaceFieldsResponse

Charger le document

ID d’opération :: V4_Documents_UploadStream

Les applications métier peuvent utiliser cette API de service pour ajouter un document à un package de documents lié au compte d’un utilisateur d’entreprise. Les informations de document sont envoyées dans l’en-tête de requête HTTP et les octets de document sont envoyées dans le corps de la requête HTTP. Remarque SigningHub convertit les formats de document pris en charge au format PDF si l’en-tête « x-convert-document » est défini sur la valeur « true ». Le seul cas pris en charge lorsque cette valeur est définie sur « false » consiste à conserver Word format et documents XML.

SigningHub prend en charge un large éventail de formats de documents, chacun pouvant être converti en format PDF lors du chargement. Cliquez ici pour obtenir la liste complète.

Notez que les documents PDF ne sont pas modifiés lors du chargement sur le système.

Notez qu’un package doit déjà exister avant de pouvoir ajouter un document à l’aide de cet appel.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
Document (flux binaire)	file (binary Stream)		binary	Il s’agit du document au format binaire brut.
Nom du fichier	x-file-name		string	Il s’agit du nom du fichier avec l’extension.
Convertir un document	x-convert-document		string	Cela indique s’il faut convertir le document au format PDF ou s’il doit être conservé dans son format d’origine. Notez que le seul format d’origine pris en charge est actuellement Word & XML. Tous les autres types de documents entraînent une erreur si cette valeur d’en-tête est définie sur « false ». Si vous chargez un document PDF, cet en-tête peut être omis.
Source	x-source		string	Il s’agit de l’identification de la source du document à partir de laquelle le document est chargé, par exemple « Mon application ».

Retours

Corps: UploadDocument

Charger une pièce jointe

ID d’opération :: V4_Attachment_UploadAttachment

Les applications métier peuvent utiliser cette API de service pour charger une pièce jointe dans un document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document auquel la pièce jointe doit être ajoutée.
Fichier de pièce jointe	file (binary Stream)		binary	Il s’agit du document au format binaire brut.
Nom du champ	x-field-name		string	Nom du champ si nécessaire. Cela est facultatif et avec le champ de pièce jointe du nom de champ est traité. En outre, la valeur recommandée pour le paramètre de nom de champ est au format codé en Base64.
Nom du fichier	x-file-name	True	string	Il s’agit du nom du fichier avec l’extension.
Mot de passe du document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
mot de passe One-Time	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

Corps: AddAttachmentResponse

Document de rappel

ID d’opération :: V4_Workflow_RecallWorkflow

Les applications métier peuvent utiliser cette API de service pour arrêter un flux de travail en cours. L’ID de document est fourni dans l’URL de la ressource. Après rappel, l’état du document passe automatiquement à « DRAFT ».

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à rappeler.

Retours

response: object

Document de refus gatekeeper

ID d’opération :: V4_Package_GatekeeperDecline

Les applications métier peuvent utiliser cette API de service pour refuser un document par un utilisateur spécifié dans l’ordre.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à décliner.
raison	reason		string	Motif fourni par l’utilisateur pour refus.

Retours

response: object

Document d’approbation gatekeeper

ID d’opération :: V4_Package_GatekeeperApprove

Les applications métier peuvent utiliser cette API de service pour approuver un document par un utilisateur spécifié dans l’ordre.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à approuver.
raison	reason		string	Motif de l’approbation d’un package.
Mot de passe d’accès au document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
Document One-Time mot de passe	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.

Retours

response: object

Déplacer le package vers un dossier d’espace personnalisé ou partagé

ID d’opération :: V4_Folder_MovePackage

Les applications métier peuvent utiliser cette API de service pour déplacer le package de documents vers un espace partagé ou le dossier personnalisé de l’utilisateur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package qui doit être déplacé vers le dossier
folder_name	folder_name	True	string	Nom du dossier cible dans lequel le package doit être déplacé

Retours

response: object

Envoyer un document

ID d’opération :: V4_Package_Submit

L’un des rôles SigningHub est appelé « Éditeur ». Cela permet à un destinataire de modifier les champs d’entrée d’un document, mais ne nécessite pas de signature. Une fois que le destinataire a terminé, il envoie ses modifications. Le bouton utilisé dans l’interface graphique utilisateur est appelé « Envoyer ».

Il s’agit de l’opération équivalente pour qu’un éditeur envoie ses modifications via un appel d’API.

Cliquez sur Rôles SigningHub pour obtenir une description de tous les rôles de destinataire de flux de travail disponibles.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package SigningHub qui contient le document à soumettre.
Mot de passe d’accès au document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
Document One-Time mot de passe	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Mettre à jour la stratégie de certification pour un document

ID d’opération :: V4_Documents_UpdateCertifyPolicy

Les applications métier peuvent utiliser cette API de service pour mettre à jour les paramètres de signature de certification d’un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document sur lequel l’action doit être effectuée.
Certifier	certify			Certifier l’objet settings pour le document.
lock_form_fields	lock_form_fields	True	boolean	True si les champs de formulaire doivent être verrouillés après la dernière signature du document actif.

Retours

response: object

Mettre à jour le champ CheckBox

ID d’opération :: V4_Checkbox_UpdateCheckBox

Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ de case à cocher d’un document dans un package.

Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé. Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur.

La largeur et la hauteur ne peuvent pas être mises à jour. Ils resteront les mêmes que lorsqu’ils ont été ajoutés.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom actuel du champ, à mettre à jour.
renamed_as	renamed_as		string	Nom mis à jour du champ si le changement de nom est prévu.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
valeur	value		string	Valeur du champ. Les valeurs possibles sont « true » ou « false »
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
validation_rule	validation_rule		string	Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Mettre à jour le champ en personne

ID d’opération :: V4_InPerson_UpdateInPerson

Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ de signature en personne d’un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom actuel du champ, à mettre à jour.
renamed_as	renamed_as		string	nom mis à jour du champ, si le changement de nom est prévu.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
Espace réservé	placeholder		string	Identificateur de chaîne pour le champ en personne, il peut s’agir de Customer, Jack, CEO, etc.
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
Affichage	display		string	Visibilité du champ à mettre à jour, les valeurs possibles sont « VISIBLE » et « INVISIBLE »
level_of_assurance	level_of_assurance		array of string	Niveau d’assurance à mettre à jour. Les valeurs possibles sont « ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SEAL », « QUALIFIED_ELECTRONIC_SEAL », « ELECTRONIC_SIGNATURE »
authentication_signing	authentication_signing			Authentification par champ
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Mettre à jour le champ initial

ID d’opération :: V4_Initials_UpdateInitial

Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ initial d’un document dans un package.

Notez que tous les paramètres d’entrée peuvent être modifiés. Lorsque vous souhaitez conserver le paramètre actuel, envoyez-le dans l’appel inchangé.

Vous pouvez donc utiliser les mêmes paramètres que lorsque vous avez ajouté le champ d’entrée ou les informations retournées par Obtenir des champs de document. Ce dernier peut être utilisé lorsqu’un modèle a été appliqué ou que le document a été créé à l’aide de l’interface graphique utilisateur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom actuel du champ, à mettre à jour.
renamed_as	renamed_as		string	Nom mis à jour du champ si le changement de nom est prévu.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.

Retours

response: object

Mettre à jour le champ RadioBox

ID d’opération :: V4_Radio_UpdateRadioBox

Les applications métier peuvent utiliser cette API de service pour mettre à jour une case d’option d’un document dans un package.

La largeur et la hauteur ne peuvent pas être mises à jour. Ils resteront les mêmes que lorsqu’ils ont été ajoutés.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom actuel du champ, à mettre à jour.
renamed_as	renamed_as		string	Nom mis à jour du champ si le changement de nom est prévu.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
valeur	value		string	Valeur du champ. Les valeurs possibles sont « true » ou « false »
validation_rule	validation_rule	True		Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
radio_group_name	radio_group_name	True	string	Nom du groupe auquel appartient le champ.
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.

Retours

response: object

Mettre à jour le champ signature numérique

ID d’opération :: V4_Signature_UpdateSignature

Les applications métier peuvent utiliser cette API de service pour mettre à jour un champ de signature numérique d’un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom actuel du champ, à mettre à jour.
level_of_assurance	level_of_assurance		array of string	Niveau d’assurance à mettre à jour. Les valeurs possibles sont « ELECTRONIC_SIGNATURE », « ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SEAL », « QUALIFIED_ELECTRONIC_SEAL », « ADVANCED_ELECTRONIC_SIGNATURE », « HIGH_TRUST_ADVANCED », « QUALIFIED_ELECTRONIC_SIGNATURE »
renamed_as	renamed_as		string	Nom mis à jour du champ si le changement de nom du champ est prévu.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
Affichage	display		string	Visibilité du champ à mettre à jour, les valeurs possibles sont « VISIBLE » et « INVISIBLE »
authentication_signing	authentication_signing			Authentification par champ
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Mettre à jour le champ TextBox

ID d’opération :: V4_TextBox_UpdateTextBox

Les applications métier peuvent utiliser cette API de service pour mettre à jour une zone de texte d’un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom actuel du champ, à mettre à jour.
field_locale	field_locale		string	Champ local. Les valeurs possibles sont ar-AE \| en-US. Facultatif et par défaut sera en-US. Cette valeur est importante pour le type « DATE ».
renamed_as	renamed_as		string	Nom mis à jour du champ si le changement de nom est prévu.
page_no	page_no	True	integer	Numéro de page sur lequel le champ doit être créé.
valeur	value		string	Valeur du champ. Pour type = DATE, la valeur est censée suivre le format ISO 8601. Suivant le format AAAA -MM-DD hh :mm :ss +00. Comme les valeurs concernent les champs de date, les applications clientes peuvent envoyer aaaa-MM-DD et ignorer hh :mm :ss +00. Si la valeur n’est pas au format approprié, une erreur est retournée.
longueur_maximale	max_length	True	integer	Longueur maximale de la valeur autorisée dans le champ. Doit entre 1 et 9999
field_type	field_type	True		Type de champ en ce qui concerne l’acceptation du type de valeurs, les valeurs possibles sont « NUMBER » ou « TEXT ».
validation_rule	validation_rule	True		Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
police	font			Police du texte des champs
x	x	True	double	Emplacement gauche du champ en pixels.
y	y	True	double	Emplacement supérieur du champ en pixels.
width	width	True	double	Largeur du champ en pixels.
height	height	True	double	Hauteur du champ en pixels.
Espace réservé	placeholder		string	Les développeurs peuvent fournir leurs propres textes d’espace réservé. Ces espaces réservés apparaissent dans les champs de texte lors de l’affichage du document dans la visionneuse.
format	format		string	Format de texte du champ. Utilisé uniquement pour le champ type de date. Les valeurs possibles sont les suivantes : m/d m/d/yy m/d/aaaa mm/jj/aaaa mm/jj/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-yy d-mmm-aaaa dd-mmm-yy dd-mmm-aaaa yy-mm-dd aaaa-mm-jj mmm-yy mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyyy
validation	validation			Validations

Retours

response: object

Mettre à jour le code QR

ID d’opération :: V4_QR_UpdateQRCode

Les applications métier peuvent utiliser cette API de service pour mettre à jour un code QR d’un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom actuel du champ, à mettre à jour.
renamed_as	renamed_as		string	Nom mis à jour du champ si le changement de nom est prévu.
page_no	page_no	True	integer	Numéro de page pour lequel le champ doit être mis à jour
dimensions	dimensions	True		Dimensions de champ
données	data		string	Données de texte brut à encoder dans le code QR. La valeur par défaut est l’URL générée pour accéder au document associé. par exemple {base_url}/document/{document_unique_id}
options	options			Paramètres relatifs aux options
color	color			Paramètres relatifs à la couleur
logo	logo			Paramètres relatifs au logo

Retours

Corps: UpdateQrCodeResponse

Mettre à jour le post-traitement

ID d’opération :: V4_Workflow_UpdateWorkflowPostProcess

Les applications métier peuvent utiliser cette API de service pour ajouter un espace réservé à un flux de travail d’un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package de document pour lequel le post-traitement est mis à jour.
enabled	enabled	True	boolean	True, si le post-traitement est activé pour le package.
contacts	contacts		array of string
nom	name	True	string
email	email	True	string
message	message		string	Message de chaîne personnalisé pour tous les contacts. Le message fait partie de l’e-mail envoyé aux contacts.
google_drive	google_drive		boolean	True, si le document doit être chargé sur le compte Google fourni après la fin du flux de travail.
Dropbox	dropbox		boolean	True, si le document doit être chargé sur le compte dropbox fourni après la fin du flux de travail.
onedrive	onedrive		boolean	True, si le document doit être chargé sur le compte oneDrive fourni après la fin du flux de travail.
workflow_recipients	workflow_recipients	True	boolean	True, si le rapport d’achèvement du flux de travail doit être envoyé à tous les destinataires du flux de travail lors de l’exécution du post-traitement. La valeur par défaut est false.
document_processing_report	document_processing_report	True	boolean	True, si l’option Envoyer le rapport de traitement de document (XML) doit être activée pour le flux de travail

Retours

response: object

Mettre à jour les autorisations utilisateur du flux de travail

ID d’opération :: V4_WorkflowPermission_UpdateWorkflowPermissions

Les applications métier peuvent utiliser cette API de service pour mettre à jour les autorisations de flux de travail d’un utilisateur qui a déjà été ajouté à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et à des applications métier, vous souhaitez remplacer les autorisations dans le flux de travail. L’ID du package de document est fourni dans l’URL de ressource, et l’utilisateur du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel les autorisations de flux de travail à mettre à jour.
JSON	order	True	integer	Ordre du destinataire pour lequel les autorisations de flux de travail à mettre à jour.
apply_to_all	apply_to_all	True	boolean	True, si les autorisations doivent être appliquées à tous les destinataires du flux de travail.
permissions	permissions	True		Il dispose de toutes les autorisations à autoriser dans le flux de travail
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Mettre à jour les détails du flux de travail

ID d’opération :: V4_Workflow_UpdateWorkflow

Les applications métier peuvent utiliser cette API de service pour mettre à jour les détails du flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document, mais les applications métier veulent remplacer les détails de certification ou de post-traitement. L’ID de package est fourni dans l’URL de la ressource.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel les détails du flux de travail doivent être mis à jour.
workflow_type	workflow_type			Type de flux de travail pour le package, par exemple (SERIAL,PARALLEL,INDIVIDUAL,CUSTOM). Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
workflow_mode	workflow_mode			Mode flux de travail du package, par exemple (ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). Si le mode flux de travail est défini sur ONLY_ME aucun collaborateur ne peut être ajouté au package d’autres utilisateurs authentifiés lui-même
continue_on_decline	continue_on_decline		boolean	True, si le flux de travail doit continuer même si un destinataire refuse le document. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
message	message		string	Un message de chaîne personnalisé du propriétaire du document à chaque destinataire, ce message s’affiche dans l’e-mail de partage ainsi que sur l’écran. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
comments	comments		boolean	Autoriser les commentaires

Retours

response: object

Mettre à jour les rappels de flux de travail

ID d’opération :: V4_Workflow_UpdateWorkflowReminder

Les applications métier peuvent utiliser cette API de service pour mettre à jour les rappels de flux de travail pour un destinataire qui a déjà été ajouté à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et à des applications métier, vous souhaitez remplacer les paramètres des rappels dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de ressource et le destinataire du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel les rappels de flux de travail à mettre à jour.
JSON	order	True	integer	Ordre de l’utilisateur pour lequel les rappels de flux de travail doivent être mis à jour.
apply_to_all	apply_to_all	True	boolean	True, si les paramètres de rappel doivent être appliqués à tous les destinataires du flux de travail.
enabled	enabled	True	boolean	True, si les paramètres de rappel doivent être activés.
fréquence	frequency		string	Fréquence de rappel. Les valeurs possibles sont DAYS \| HEURES.
remind_after	remind_after	True	integer	Obligatoire, en cas de propriété activée, true. Nombre de jours après lesquels le premier rappel est envoyé à l’utilisateur du flux de travail.
répéter	repeat			Les rappels sont envoyés à l’utilisateur à plusieurs reprises.

Retours

response: object

Mettre à jour l’authentification utilisateur du flux de travail (ouverture de document) du package Entreprise

ID d’opération :: V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

Les applications métier peuvent utiliser cette API de service pour mettre à jour les authentifications de package et la durée d’accès pour les destinataires. Cette API peut également être utilisée par l’administrateur d’entreprise ou l’utilisateur d’entreprise si la variable « étendue » a été utilisée dans la demande d’authentification

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel la sécurité et l’authentification de l’accès au flux de travail doivent être mises à jour.
Ordre des destinataires	order	True	integer	Ordre du destinataire dans le flux de travail pour lequel la sécurité et l’authentification d’accès doivent être mises à jour.
apply_to_all	apply_to_all	True	boolean	True, si la sécurité ou les authentifications d’accès doivent être appliquées à tous les destinataires du flux de travail.
Authentification	authentication	True		Il dispose des données d’accès à une authentification
authentication_signing	authentication_signing			Il contient les données d’authentification de signature
access_duration	access_duration	True		Il a la durée d’accès du flux de travail

Retours

response: object

Mettre à jour l’espace partagé

ID d’opération :: V4_WorkSpace_UpdateSharedSpace

Les applications métier peuvent utiliser cette API de service pour mettre à jour l’espace partagé. La disponibilité de la mise à jour des espaces partagés est soumise au rôle d’utilisateur d’entreprise affecté. Pour autoriser ce provisionnement, l’administrateur d’entreprise active l’option « Gérer l’espace partagé » dans les paramètres du document rôles>.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’espace partagé	id	True	integer	ID de l’espace partagé que vous souhaitez mettre à jour
nom	name		string	Nom de l’espace partagé
nom	name	True	string	Nom du membre de l’espace de travail
email	email	True	string	Adresse e-mail du membre de l’espace de travail

Retours

response: object

Mettre à jour l’espace réservé

ID d’opération :: V4_Workflow_WorkflowUpdatePlaceholder

Les applications métier peuvent utiliser cette API de service pour mettre à jour un espace réservé dans le flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et aux applications métier souhaite remplacer les détails d’un espace réservé spécifique dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de la ressource, et le espace réservé du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail. Pendant la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package pour lequel l’espace réservé doit être ajouté.
JSON	order	True	integer	Ordre du destinataire dans le flux de travail.
Espace réservé	placeholder		string	Nom du nouvel espace réservé à ajouter dans le flux de travail. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
email_notification	email_notification		boolean	La définition de sa valeur sur « true » envoie une notification par e-mail à l’utilisateur lorsque son tour arrive dans le flux de travail. La définition de sa valeur sur « false » n’envoie pas la notification par e-mail à l’utilisateur à son tour. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
role	role	True		Rôle du groupe en tant que destinataire dans le flux de travail. La valeur possible est « SIGNER », « REVIEWER », « EDITOR », « CARBON_COPY » et « INPERSON_HOST ». Si aucune valeur n’est fournie, l’ancienne valeur est conservée. Toutefois, alors que la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
signing_order	signing_order		integer	Ordre dans lequel le flux de travail sera signé par les destinataires. Cet ordre de signature est important lorsque le type de flux de travail est défini sur « CUSTOM ».

Retours

response: object

Mettre à jour l’ordre des utilisateurs du flux de travail

ID d’opération :: V4_Workflow_WorkflowUserUpdateOrder

Les applications métier peuvent utiliser cette API de service pour mettre à jour l’ordre du destinataire dans le flux de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package auquel les destinataires doivent être ajoutés.
JSON	order	True	integer	Ordre existant du destinataire à mettre à jour.
order	order	True	integer	Ordre du destinataire à mettre à jour.

Retours

response: object

Mettre à jour l’utilisateur du flux de travail

ID d’opération :: V4_Workflow_WorkflowUserUpdate

Les applications métier peuvent utiliser cette API de service pour mettre à jour les détails d’un destinataire, d’un groupe ou d’un espace réservé qui a déjà été ajouté à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et aux applications métier souhaite remplacer les détails d’un utilisateur spécifique dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de ressource et le destinataire du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail. Notez que si la préparation du document de type XML prend uniquement en charge les types de rôles « SIGNER », « REVIEWER » et « CARBON_COPY ».

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel l’utilisateur de workflow doit être mis à jour.
JSON	order	True	integer	Ordre de l’utilisateur dans le flux de travail.
user_email	user_email		string	Adresse e-mail du nouvel utilisateur à mettre à jour dans le flux de travail. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
nom_utilisateur	user_name		string	Nom du destinataire à mettre à jour. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
email_notification	email_notification		boolean	La définition de sa valeur sur « true » envoie une notification par e-mail à l’utilisateur lorsque son tour arrive dans le flux de travail. La définition de sa valeur sur « false » n’envoie pas la notification par e-mail à l’utilisateur à son tour. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
mobile_number	mobile_number		string	Numéro de téléphone mobile. Si aucune valeur n’est fournie, l’ancienne valeur est conservée.
role	role	True		Rôle du destinataire à mettre à jour. Les valeurs possibles sont « SIGNER », « REVIEWER », « EDITOR », « CARBON_COPY » ou « INPERSON_HOST ». Si aucune valeur n’est fournie, l’ancienne valeur est conservée. Toutefois, alors que la préparation du document de type XML, seuls les types de rôles pris en charge sont « SIGNER », « REVIEWER » et « CARBON_COPY »
signing_order	signing_order		integer	Ordre dans lequel le flux de travail sera signé par les destinataires. Cet ordre de signature est important lorsque le type de flux de travail est défini sur « CUSTOM ».
email_language_code	email_language_code		string	code de langue de messagerie
delivery_method	delivery_method	True		Méthode de remise du destinataire dans le flux de travail. Les valeurs possibles sont « EMAIL », « SMS » ou « EMAIL_AND_SMS ». La valeur par défaut est EMAIL
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

Corps: UpdateCollaboratorResponse

Obtenir des autorisations utilisateur de flux de travail

ID d’opération :: V4_WorkflowPermission_GetWorkflowPermissions

Les applications métier peuvent utiliser cette API de service pour obtenir des autorisations de document pour un destinataire. Le destinataire est identifié par l’ordre dans le flux de travail. L’ID du package est fourni dans l’URL de la ressource.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de document pour lequel l’utilisateur de workflow doit être mis à jour.
JSON	order	True	integer	Ordre de l’utilisateur dans le flux de travail pour lequel les autorisations sont demandées. En fournissant la valeur 0 dans l’ordre, le service renverrait les autorisations des derniers collaborateurs ajoutés dans le flux de travail.

Retours

Corps: WorkflowPermissionResponse

Obtenir des champs de document

ID d’opération :: V4_Fields_GetAllDocumentFields

Les applications métier peuvent utiliser cette API de service pour obtenir des champs de document, c’est-à-dire des initiales, des personnes, des champs de signature ou des champs de formulaire.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document pour lequel les champs sont demandés.
Page Non	pageNo	True	integer	Page non du document pour lequel les champs sont demandés. Si le numéro de page n’est pas fourni, les champs du document entier sont retournés.
Auteur	x-mobile		string	Définir l’originator(Web/Mobile) de la requête/action

Retours

Corps: FieldsResponse

Obtenir des contacts

ID d’opération :: V4_Contacts_Get

Les applications métier peuvent utiliser cette API de service pour retener les contacts à partir de contacts personnels et d’entreprise pour l’utilisateur actuel.

Il est possible de rechercher en fonction du critère fourni sous l’en-tête « x-search-text ». En outre, il est possible de rechercher les contacts spécifiques d’un utilisateur ou celui de l’entreprise auquel appartient l’utilisateur.

Les informations de réponse de recherche contiennent l’adresse e-mail de l’utilisateur et le nom d’utilisateur respectif.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Enreg. par page	recordPerPage	True	integer	Nombre total d’enregistrements à récupérer dans une page.
Numéro de page	pageNo	True	integer	Numéro de page à récupérer.
Trier par	sort-by		string	Triez le résultat en fonction des valeurs possibles mentionnées ci-dessus.
Croissant	asc		boolean	Triez le jeu de résultats en croissant ou décroissant.
Texte de recherche	x-search-text		string	Texte de recherche si nécessaire. Il s’agit d’une option facultative et sans que la liste entière soit retournée. En outre, la valeur recommandée pour le paramètre de texte de recherche est au format codé en Base64.
Contacts d’entreprise uniquement	x-enterprise		string	Lorsque la valeur est définie sur « true » uniquement, la liste des contacts d’entreprise est retournée. En cas de « false » seule la liste des contacts de l’utilisateur est retournée. Si vous ne définissez pas l’en-tête, les listes de contacts de l’entreprise et de l’utilisateur sont retournées.
Nombre total d’enregistrements	x-total-records		string	Nombre total d’enregistrements trouvés avec les critères de recherche fournis.

Retours

response: array of ContactResponse

Obtenir des modèles

ID d’opération :: V4_Settings_GetTemplates

Les applications métier peuvent utiliser cette API de service pour obtenir la liste des modèles pour l’utilisateur actuel.

Il est possible de rechercher en fonction du critère fourni sous l’en-tête « x-search-text ». En outre, il est possible de rechercher les modèles personnels d’un utilisateur ou les modèles d’entreprise comme autorisés par son rôle d’utilisateur par son administrateur d’entreprise.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nombre d’enregistrements par page	recordPerPage	True	integer	Nombre total d’enregistrements à récupérer dans une page.
Numéro de page à récupérer	pageNo	True	integer	Numéro de page à récupérer.
Trier par colonne	sort-by		string	Trier par colonne. Les valeurs possibles sont CREATED_ON et NAME. La valeur par défaut est triée par CREATED_ON
Asc	asc		boolean	Ordre de liste résultant. La liste résultante par défaut sera décroissante
Texte de recherche	x-search-text		string	Texte de recherche si nécessaire. Il s’agit d’une option facultative et sans que la liste entière soit retournée. En outre, la valeur recommandée pour le paramètre de texte de recherche est au format codé en Base64.
Modèles d’entreprise uniquement	x-enterprise		string	Lorsque la valeur est définie sur « true », seule la liste des modèles d’entreprise est retournée. En cas de « false » seule la liste des modèles de l’utilisateur est retournée. Si vous ne définissez pas l’en-tête, les listes de modèles d’entreprise et d’utilisateur sont retournées.
Nombre total d'enregistrements	x-total-records		string	Nombre total d’enregistrements trouvés avec les critères de recherche fournis.

Retours

response: array of TemplateResponse

Obtenir des modèles d’entreprise

ID d’opération :: V4_Template_GetEnterpriseTemplates

Les applications métier peuvent utiliser cette API de service pour obtenir la liste des modèles d’entreprise de l’utilisateur actuel. Cela signifie que l’administrateur d’entreprise ou l’utilisateur d’entreprise si la variable « étendue » a été utilisée dans la demande d’authentification.

Il est possible de rechercher en fonction du critère fourni sous l’en-tête « x-search-text ».

Paramètres

Nom	Clé	Obligatoire	Type	Description
Nombre d’enregistrements par page	recordPerPage	True	integer	Nombre total d’enregistrements à récupérer dans une page.
Numéro de page à récupérer	pageNo	True	integer	Numéro de page à récupérer.
Trier par colonne	sort-by		string	Triez le résultat en fonction des valeurs possibles mentionnées ci-dessus.
Commander le jeu de résultats	asc		boolean	Triez le jeu de résultats en croissant ou décroissant.
Filtrer par ID de modèle	id		array	Recherchez par ID de modèle.
Texte de recherche	x-search-text		string	Texte de recherche si nécessaire. Il s’agit d’une option facultative et sans que la liste entière soit retournée. En outre, la valeur recommandée pour le paramètre de texte de recherche est au format codé en Base64.
Nombre total d'enregistrements	x-total-records		string	Nombre total d’enregistrements trouvés avec les critères de recherche fournis.

Retours

response: array of EnterpriseTemplateResponse

Obtenir des packages

ID d’opération :: V4_Package_GetAllPackages

Les applications métier peuvent utiliser cette API de service pour obtenir la liste des documents filtrés par différents états. Les utilisateurs peuvent diviser les enregistrements en pages en fournissant un certain nombre d’enregistrements par page.

Paramètres

Nom	Clé	Obligatoire	Type	Description
État du document	document_status	True	string	Filtrer par état du document les valeurs possibles sont ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS.
Numéro de page	pageNo	True	integer	Numéro de page, selon la division des enregistrements par page.
Enreg. par page	recordPerPage	True	integer	Nombre d’enregistrements qui doivent être récupérés dans une requête.
Nom du package	package-name		string	Nom du package
ID du package	package-id		integer	Package Id
À partir	recipient-from		string	À partir
À	recipient-to		string	À
ID du document	document-id		integer	Document Id
Expiration (jours)	expiry		integer	Expiration (jours)
À partir de la date de modification	modified-from		date-time	À partir de la date de modification
Date de modification	modified-to		date-time	Date de modification
À partir de la taille (Ko)	size-from		integer	À partir de la taille (Ko)
Taille (Ko)	size-to		integer	Taille (Ko)
Documents certifiés	certified-documents		boolean	Seuls les documents signés certifiés
Champs de formulaire	form-fields		boolean	Seuls les documents qui ont des champs de formulaire
Attachments	attachments		boolean	Seuls les documents qui ont des pièces jointes
Type de document	document-type		string	Type de document tel que XML, PDF, DOCX, etc.
Trier par	sort-by		string	Trier les enregistrements résultants en fonction de votre choix
Ordre croissant	asc		boolean	Trié les enregistrements résultants par ordre croissant ou décroissant
État du document	document-statuses		array	Type de document
Propriété par	owned-by		string	Les valeurs possibles de filtre sont ME_OTHERS, ME, OTHERS.
Nom du formulaire intelligent	smart-form		string	Nom du formulaire intelligent
Nom du dossier	x-folder		string	Nom du dossier à partir duquel les documents doivent être récupérés. Les valeurs possibles sont INBOX et ARCHIVE. En outre, la valeur recommandée pour le paramètre x-folder est au format codé en Base64.
Texte de recherche	x-search-text		string	Texte de recherche envoyé dans les en-têtes pour une filtrage supplémentaire des documents. L’ID du package, le nom et le propriétaire du document peuvent être recherchés. En outre, la valeur recommandée pour le paramètre de texte de recherche est au format codé en Base64.
Nombre total d’enregistrements	x-total-records		string	Nombre total d’enregistrements trouvés avec les critères de recherche fournis.
Source	x-source		string	Il s’agit de l’identification de la source du document à partir de laquelle le document est chargé, par exemple « Mon application ».
Détails du destinataire	x-recipient-details		string	Si la valeur « true » est transmise aux détails du destinataire concernant la durée de l’accès aux documents, les informations de refus sont fournies le long des informations de refus.

Retours

response: array of GetPackagesResponse

Obtenir des pièces jointes

ID d’opération :: V4_Attachment_GetAttachments

Les applications métier peuvent utiliser cette API de service pour obtenir les pièces jointes d’un document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document auquel la pièce jointe est ajoutée.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: array of GetAttachmentResponse

Obtenir des utilisateurs de flux de travail

ID d’opération :: V4_Workflow_GetWorkflowUsers

Les applications métier peuvent utiliser cette API de service pour obtenir les détails du flux de travail pour le package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à télécharger.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: array of WorkflowRecipient

Obtenir les détails du document

ID d’opération :: V4_Documents_GetDocumentDetails

Les applications métier peuvent utiliser cette API de service pour obtenir les détails du document. L’ID de document est fourni dans l’URL sous la forme « {document_id} ».

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel les détails du document sont demandés.
Mot de passe du document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
mot de passe One-Time (OTP)	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

Corps: DocumentDetailsResponse

Obtenir les détails du flux de travail

ID d’opération :: V4_Workflow_GetWorkflowDetail

Les applications métier peuvent utiliser cette API de service pour obtenir les détails du flux de travail pour le package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à télécharger.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

Corps: WorkflowDetailsResponse

Obtenir les détails du package

ID d’opération :: V4_Package_GetPackageDetails

Les applications métier peuvent utiliser cette API de service pour obtenir les détails d’un package. Cette API peut également être utilisée par l’application métier pour effectuer une action au nom de l’utilisateur d’entreprise via l’authentification par étendue.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package de document.

Retours

Corps: GetPackageDetailsResponse

Obtenir l’authentification utilisateur du flux de travail (ouverture de document) du package Entreprise

ID d’opération :: V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

Les applications métier peuvent utiliser cette API de service pour activer les paramètres de sécurité d’accès pour le package. Les destinataires pour lesquels la sécurité est configurée sont identifiés par l’ordre dans l’URL. L’ID de package est également identifié dans l’URL de la requête. Les destinataires ne pourront pas accéder au package de documents en dehors de l’étendue de cette durée si la sécurité d’accès est activée. Le propriétaire du document peut également configurer la sécurité basée sur l’authentification du package pour un destinataire.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel la sécurité et l’authentification de l’accès au flux de travail doivent être mises à jour.
Ordre des destinataires	order	True	integer	Ordre du destinataire dans le flux de travail pour lequel la sécurité et l’authentification d’accès doivent être mises à jour.

Retours

Corps: EnterpriseAccessResponse

Obtenir l’historique des flux de travail

ID d’opération :: V4_Workflow_GetWorkflowHistory

Les applications métier peuvent utiliser cette API de service pour récupérer la liste des actions effectuées sur un document. L’ID de package est fourni dans l’URL de la ressource. Le champ de recherche (en-tête x-search-text) est destiné à l’e-mail, au nom du document, à l’action, à l’infokey et à la valeur d’infovalue.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du document pour lequel le journal est requis.
Numéro de page	pageNo	True	integer	Numéro de page à récupérer.
Enreg. par page	recordsPerPage	True	integer	Nombre total d’enregistrements à récupérer dans une page.
Texte de recherche	x-search-text		string	Le champ de recherche (en-tête x-search-text) est destiné à l’e-mail, au nom du document, à l’action, à l’infokey et à la valeur d’infovalue.

Retours

Corps: WorkflowHistoryResponse

Obtenir un espace partagé

ID d’opération :: V4_WorkSpace_GetSharedSpace

Les applications métier peuvent utiliser cette API de service pour obtenir un espace partagé spécifique. Cette API retourne des informations sur l’espace partagé, son propriétaire et son collaborateur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’espace partagé	id	True	integer	ID de l’espace partagé que vous souhaitez obtenir

Retours

Corps: WorkSpaceResponse

Obtenir un rappel de flux de travail

ID d’opération :: V4_Workflow_GetWorkflowReminder

Les applications métier peuvent utiliser cette API de service pour mettre à jour les rappels pour les destinataires qui ont déjà été ajoutés à un flux de travail. Normalement, cet appel est utile une fois qu’un modèle a été appliqué à un document et à des applications métier, vous souhaitez remplacer les paramètres des rappels dans le flux de travail. L’ID du document de flux de travail est fourni dans l’URL de ressource et le destinataire du flux de travail est identifié par l’ordre auquel il est ajouté au flux de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package pour lequel les rappels de flux de travail à mettre à jour.
JSON	order	True	integer	Ordre de l’utilisateur pour lequel les rappels de flux de travail doivent être mis à jour.

Retours

Corps: ReminderResponse

Obtenir un rapport de preuve de processus

ID d’opération :: V4_WorkflowEvidenceReport_DownloadBytes

Les applications métier peuvent utiliser cette API de service pour télécharger le rapport de preuve de processus de flux de travail d’un document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du document.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Obtenir une stratégie de certification pour un document

ID d’opération :: V4_Documents_GetCertifyPolicy

Les applications métier peuvent utiliser cette API de service pour obtenir des paramètres de signature de certification d’un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document à télécharger.

Retours

Corps: CertifyPolicyResponse

Packages de signature en bloc

ID d’opération :: V4_Signing_BulkSignDocuments

Les applications métier peuvent utiliser cette API pour signer/partager/signer et partager plusieurs documents (électroniques et numériques) sans afficher les documents à l’utilisateur final. Cette API a besoin d’informations de l’application métier sur les packages de documents et les détails des signatures, des champs en personne et initiales. Lors de la réussite de la transaction de signature en bloc, l’API retourne les états et les ID de transaction des packages de documents.

Contrairement à l’API Sign Document, cette API signe non seulement un package de documents, mais également la marque comme approuvée et examinée en fonction de la présence d’un signataire, d’un éditeur ou d’un réviseur. Tout package de document pour lequel l’état retourne comme COMPLETED a été signé, approuvé ou révisé par cette API.

La signature en bloc fonctionne avec toutes les méthodes d’authentification au moment de la signature.

Si SIGN est transmis en tant que bulk_action et que le package est à l’état Brouillon, sign and Share est effectué automatiquement.

Vous devez appeler cette API après l’API De signature en bloc .

Si vous devez apporter des modifications dans l’un des documents avant la signature, l’API Champs de formulaire de remplissage doit être appelée avant d’appeler l’API de document de signature en bloc. N’oubliez pas que tous les champs d’entrée obligatoires d’un document doivent être terminés avant que cette API se termine correctement ; alors que les champs renseignés automatiquement (par exemple, Nom, E-mail, Date, Titre du travail, etc.) sont automatiquement renseignés.

Le signataire est identifié par le jeton d’accès présenté dans l’appel. Par conséquent, l’authentification du signataire est requise avant d’effectuer cet appel. Vous ne pouvez pas vous authentifier en tant qu’administrateur d’entreprise avec la variable d’étendue et signer un document pour le compte d’un utilisateur. Le jeton d’accès doit être émis au signataire à la suite de l’authentification directe.

Une fois le document signé, la réponse de vérification est visible à partir de l’API d’état de signature en bloc .

Utilisation du protocole OTP premier ou second facteur pour l’authentification

Si l’authentification OTP est activée pour l’opération de signature côté serveur, les applications clientes devront générer un otP pour le numéro mobile à l’aide de l’authentification par signature en bloc via l’appel d’API OTP. Les applications métier respectives doivent récupérer le protocole OTP à partir de l’utilisation et les soumettre lors de l’appel d’API. Pour ce faire, utilisez l’en-tête « x-otp » dans la requête.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ids	ids		array of integer	Tableau des ID de package de document sélectionnés pour la signature en bloc.
hand_signature_initials_image	hand_signature_initials_image		string	Image Base64 utilisée pour le remplissage des initiales
hand_signature_initials_method	hand_signature_initials_method		integer	0 = DRAW 1 = TEXT 2 = UPLOAD 3 = SIGNATURE_PAD 4 = NONE
hand_signature_image	hand_signature_image		string	Image de chaîne encodée en Base64 de l’apparence de la signature visible
hand_signature_method	hand_signature_method			Nom de la méthode de signature manuelle par l’utilisateur pour la signature. Si aucune méthode de signature de main n’est fournie, la valeur par défaut est DRAW. valeurs possibles DRAW,TEXT,UPLOAD,SIGNATURE_PAD
signing_reason	signing_reason		string	Raison de la signature fournie par le destinataire.
signing_location	signing_location		string	Paramètres régionaux du signataire fourni par le destinataire
contact_information	contact_information		string	Coordonnées du signataire fourni par le destinataire
appearance_design	appearance_design		string	Nom de l’apparence de la signature fournie par l’utilisateur pour la signature. Si aucun nom d’apparence n’est fourni, l’apparence sélectionnée par défaut est utilisée. Les valeurs possibles sont « COMPANY_LOGO », « DETAILED_SIGNATURE », « HAND_SIGNATURE »
signing_server	signing_server		string	Nom du serveur de signature à l’aide duquel le document doit être signé
signing_capacity	signing_capacity		string	Nom du profil de certification/capacité de signature à l’aide duquel le document doit être signé
Authentification	authentication			L’objet d’authentification est facultatif, il contient des options d’authentification reléguées
identifiant_de_transaction	transaction_id		string	ID de transaction du processus de signature re-initié
ID du package	packageId_bulkAction	True	string	Action en bloc à effectuer. Les valeurs possibles sont : SIGN \| PARTAGER
Signature d’un mot de passe par mot de passe	x-otp		string	OTP/TOTP utilisé comme deuxième facteur/authentification de signature de document pour l’opération de signature.
Mot de passe d’accès au document	x-open-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
Document One-Time mot de passe	x-open-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.
Origine mobile	x-mobile		string	Définir l’originator(Web/Mobile) de la requête/action

Retours

Corps: BulkSignResponse

Partager le package de documents

ID d’opération :: V4_Workflow_StartWorkflow

Les applications métier peuvent utiliser cette API de service pour partager un package de documents avec les signataires et démarrer un nouveau flux de travail. Le document doit déjà avoir été préparé en appliquant un modèle et éventuellement en mettant à jour les utilisateurs et les actions définis dans le modèle. L’ID de package à partager est fourni dans l’URL de la ressource.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	Package de document à partager.

Retours

response: array of StartWorkflowResponse

Refuser le document

ID d’opération :: V4_Package_Decline

Les applications métier peuvent utiliser cette API de service pour refuser un document par un utilisateur spécifié dans l’ordre.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à décliner.
raison	reason		string	Motif fourni par l’utilisateur pour refus.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Remplir les champs de formulaire

ID d’opération :: V4_Fields_FillFormFields

Les applications métier peuvent utiliser cette API de service pour remplir un ou plusieurs champs de formulaire dans un document par un utilisateur spécifié dans l’ordre.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document.
auto_save	auto_save	True	boolean	La valeur par défaut est false. True, si les champs de formulaire sont enregistrés sans intervention de l’utilisateur, par exemple en fermant le document ou en appuyant sur retour. Pour la signature, les initiales, les personnes entrantes, l’examen, les actions Envoyer la valeur est false.
field_name	field_name	True	string	Identificateur unique du champ dans le document.
valeur	value		string	Valeur du champ à enregistrer dans le document.
field_name	field_name	True	string	Identificateur unique du champ dans le document.
radio_group_name	radio_group_name		string	Nom du groupe auquel appartient la case d’option.
valeur	value	True	boolean	Valeur du champ à enregistrer dans le document.
field_name	field_name	True	string	Identificateur unique du champ dans le document.
valeur	value	True	boolean	Valeur du champ à enregistrer dans le document.
field_name	field_name	True	string	Identificateur unique du champ dans le document.
valeur	value		string	Valeur du champ à enregistrer dans le document.
field_name	field_name	True	string	Identificateur unique du champ dans le document.
valeur	value		string	Valeur du champ à enregistrer dans le document.
Mot de passe du document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
mot de passe One-Time (OTP)	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Remplissage des initiales

ID d’opération :: V4_Initials_Fill

Les applications métier peuvent utiliser cette API de service pour remplir un champ d’initialisation dans un document par un utilisateur spécifié dans l’ordre.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document.
field_name	field_name	True	string	Identificateur unique du champ dans le document.
image	image	True	string	Image Base64 utilisée pour le remplissage des initiales.
method	method			Nom de la méthode de signature manuelle par l’utilisateur pour la signature. Si aucune méthode de signature de main n’est fournie, la valeur par défaut est DRAW. valeurs possibles DRAW,TEXT,UPLOAD,SIGNATURE_PAD
apply_to_all	apply_to_all	True	boolean	True si toutes les initiales doivent être remplies.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Renommer le document

ID d’opération :: V4_Documents_RenameDocument

Les applications métier peuvent utiliser cette API de service pour renommer un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document sur lequel l’action doit être effectuée.
document_name	document_name	True	string	Nouveau nom du document.

Retours

Corps: DocumentResponse

Renommer le package

ID d’opération :: V4_Package_RenamePackage

Cette API de service est utilisée pour renommer un package de documents.

Le package de documents est identifié par son identificateur unique dans l’URL de l’appel.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId_bulkAction	True	integer	ID de package pour modifier le nom de.
package_name	package_name	True	string	Nouveau nom du package de document.

Retours

response: object

Signer un document

ID d’opération :: V4_Signing_SignDocument

Les applications métier peuvent utiliser cette API de service pour signer un document (électronique et numérique) sans afficher le document à l’utilisateur final à l’aide de SigningHub. Par exemple, une application métier peut avoir une autre méthode pour afficher le document à l’utilisateur, et seule la fonctionnalité de signature de SigningHub est requise, ou pour les opérations en bloc, il peut être justifié de signer sans demander à l’utilisateur d’afficher et d’approuver chaque document individuellement. S’il existe des modifications à enregistrer dans le document avant la signature, l’API Remplir les champs de formulaire doit être appelée avant d’appeler l’API Sign Document. Notez que les champs d’entrée obligatoires d’un document doivent être terminés avant que cette API se termine correctement.

Lorsque cet appel se termine, il est important que si le signataire était le dernier signataire d’un document appelé par l’API Terminer le document . La raison est que, sans appeler cette API, le document reste dans l’état « En cours » au propriétaire du document. Une fois l’API appelée, l’état passe à « Terminé » pour le propriétaire du document.

Une fois le document signé, la réponse de vérification est visible à partir de l’API Get Document Verification .

Utilisation du protocole OTP premier ou second facteur pour l’authentification

Si l’authentification OTP est activée pour l’opération de signature côté serveur, les applications clientes doivent générer un otP pour le numéro mobile à l’aide de l’authentification du signataire via l’appel d’API OTP. Les applications métier respectives doivent récupérer le protocole OTP à partir de l’utilisation et les soumettre lors de l’appel d’API. Pour ce faire, utilisez l’en-tête « x-otp » dans la requête.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	Identificateur du package qui contient le document pour signature.
ID du document	documentId	True	integer	Identificateur du document à signer.
field_name	field_name	True	string	Identificateur unique du champ de signature dans le document.
hand_signature_image	hand_signature_image		string	Image de chaîne encodée en base64 de l’apparence de la signature visible, qui est placée sur le document. Notez que cela peut être récupéré à partir des paramètres personnels de l’utilisateur à l’aide de cet appel. (La réponse est binaire, de sorte que l’application métier doit ensuite l’encoder en Base64 avant de soumettre dans cet appel d’API.)
hand_signature_method	hand_signature_method			Nom de la méthode de signature manuelle par l’utilisateur pour la signature. Si aucune méthode de signature de main n’est fournie, la valeur par défaut est DRAW.
signing_reason	signing_reason		string	Raison de la signature fournie par le destinataire. Remarque : Indication du type d’engagement pour les documents XML
signing_location	signing_location		string	Paramètres régionaux du signataire fourni par le destinataire.
contact_information	contact_information		string	Coordonnées du signataire fourni par le destinataire.
nom_utilisateur	user_name		string	Nom du signataire fourni par le destinataire. Notez que cela s’applique uniquement aux opérations de signature en personne.
user_password	user_password		string	Mot de passe fourni par l’utilisateur soumis aux paramètres de signature de l’utilisateur.
appearance_design	appearance_design		string	Nom de l’apparence de la signature fournie par l’utilisateur pour la signature. Si aucun nom d’apparence n’est fourni, l’apparence sélectionnée par défaut est utilisée. Les valeurs possibles sont « COMPANY_LOGO », « DETAILED_SIGNATURE », « HAND_SIGNATURE »
signing_capacity	signing_capacity		string	Nom du profil de certification/capacité de signature à l’aide duquel le document doit être signé. Si la capacité par défaut n’est pas fournie, elle est utilisée pour signer. Le nom fourni doit être exactement identique au profil réel en raison de la sensibilité de la casse.
skip_verification	skip_verification	True	boolean	Aucune vérification de signature ne retourne dans le corps de la réponse lorsqu’elle est définie sur true. Valeur par défaut pour ce paramètre défini sur false.
signing_server	signing_server		string	Nom du serveur de signature à l’aide duquel le document doit être signé.
Authentification	authentication			L’objet d’authentification est facultatif, il contient des options d’authentification reléguées
mot de passe One-Time (OTP)	x-otp		string	OtP utilisé comme deuxième authentification de facteur pour l’opération de signature.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.
Origine mobile	x-mobile		string	Définir l’originator(Web/Mobile) de la requête/action

Retours

Corps: SignDocumentResponse

Supprimer le champ document

ID d’opération :: V4_Fields_DeleteDocumentField

Les applications métier peuvent utiliser cette API de service pour supprimer un champ de document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package auquel le document est ajouté.
ID du document	documentId	True	integer	ID de document pour lequel l’action doit être effectuée.
field_name	field_name	True	string	Nom du champ à supprimer.

Retours

response: object

Supprimer le document

ID d’opération :: V4_Documents_DeleteDocument

Les applications métier peuvent utiliser cette API de service pour supprimer un document dans un package.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document à supprimer.

Retours

Corps: DocumentResponse

Supprimer le package

ID d’opération :: V4_Package_DeletePackage

Les applications métier peuvent utiliser cette API de service pour supprimer un document de la boîte de réception utilisateur. L’ID de package est fourni dans l’URL de ressource sous la forme « {package_id} ». Si l’état du document est EN ATTENTE, il est automatiquement refusé suite à l’opération de suppression. Si l’état du document est PARTAGÉ, le document est automatiquement rappelé et le flux de travail est arrêté avant la suppression du document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId_bulkAction	True	integer	ID de package du package qui contient le document.

Retours

response: object

Supprimer l’espace partagé

ID d’opération :: V4_WorkSpace_DeleteSharedSpace

Les applications métier peuvent utiliser cette API de service pour supprimer de l’espace partagé. La disponibilité de la suppression d’espaces partagés est soumise au rôle d’utilisateur d’entreprise attribué. Pour autoriser ce provisionnement, l’administrateur d’entreprise active l’option « Gérer l’espace partagé » dans les paramètres du document rôles>.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID d’espace partagé	id	True	integer	ID de l’espace partagé que vous souhaitez supprimer

Retours

response: object

Supprimer un utilisateur de flux de travail

ID d’opération :: V4_Workflow_WorkflowDeleteUser

Les applications métier peuvent utiliser cette API de service pour supprimer le destinataire du flux de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package à partir duquel le destinataire doit être supprimé.
JSON	order	True	integer	Ordre du destinataire dans le flux de travail à supprimer.

Retours

response: object

Supprimer une pièce jointe

ID d’opération :: V4_Attachment_DeleteAttachment

Les applications métier peuvent utiliser cette API de service pour supprimer la pièce jointe d’un document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document auquel la pièce jointe est ajoutée.
ID des pièces jointes	attachment_id	True	integer	ID de la pièce jointe.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Terminer le flux de travail au milieu (terminer le flux de travail)

ID d’opération :: V4_Workflow_MarkWorkflowCompleted

Les applications métier peuvent marquer le flux de travail terminé même au milieu du flux de travail. Utilisez cette API de service pour modifier l’état du flux de travail à terminer. S’il existe des destinataires qui n’ont pas encore signé le document. Leur signature ne sera plus nécessaire et ne pourra plus voir le document dans sa boîte de réception. Le jeton du porteur doit appartenir au propriétaire du document ou à l’administrateur d’entreprise peut utiliser la variable d’étendue pour obtenir le jeton d’accès pour le compte du propriétaire du document pour effectuer cette action.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package à partir duquel le destinataire doit être supprimé.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Terminer le traitement

ID d’opération :: V4_Package_Finish

Les applications métier peuvent utiliser cette API de service pour terminer le traitement du document après avoir signé tous les champs de signature. Cette méthode est principalement utilisée par les applications mobiles SigningHub natives pour iOS et Android et les cas d’usage web mobiles. Les applications métier générales qui utilisent une intégration étroite dans leur portail respectif n’ont pas besoin d’appeler cette méthode. Toutefois, lors de l’utilisation de l’API Sign Document (et par conséquent, l’utilisateur n’est pas présenté avec une représentation visuelle du document qu’il est invité à signer) l’appel de cette API est nécessaire pour garantir que le flux de travail respectif continue ou se termine. Par exemple, une fois que toutes les signatures ont été appliquées à l’aide de l’API « blind » Sign Document, le document ne s’affiche pas comme état « Terminé » au propriétaire tant que cette API n’est pas appelée. Le propriétaire du document voit l’état « En cours » jusqu’à ce que cette API soit appelée.

Dans les cas d’usage web mobiles et d’applications mobiles SigningHub natives, cet appel est nécessaire pour s’assurer que chaque utilisateur effectue ses actions respectives en ce qui concerne SigningHub.Par exemple, une fois qu’un signataire a signé un document dans l’application SigningHub, cette méthode est appelée par l’application pour garantir que le flux de travail continue de traiter et que le signataire suivant est averti, et l’état du document est disponible via l’URL de rappel configurée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID du package à terminer.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Télécharger la pièce jointe

ID d’opération :: V4_Attachment_DownloadAttachment

Les applications métier peuvent utiliser cette API de service pour télécharger la pièce jointe d’un document.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document auquel la pièce jointe est ajoutée.
ID des pièces jointes	attachment_id	True	integer	ID de la pièce jointe.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Télécharger le document

ID d’opération :: V4_Documents_DownloadDocumentBytes

Les applications métier peuvent utiliser cette API de service pour télécharger les octets de document. L’ID de package et l’ID de document sont fournis dans l’URL de la ressource.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId	True	integer	ID de package du package auquel le document est ajouté.
ID du document	documentId	True	integer	ID du document à télécharger.
Mot de passe du document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
mot de passe One-Time (OTP)	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

Télécharger le package

ID d’opération :: V4_Package_DownloadPackageBytes

Les applications métier peuvent utiliser cette API de service pour télécharger le package de documents au format binaire.

L’ID de package est fourni dans l’URL de la ressource.

Si le package ne contient qu’un seul document, le téléchargement est le document PDF binaire.

Sinon, si le package comporte plusieurs documents, le téléchargement est le fichier zip binaire de tous les documents.

Les en-têtes x-password et x-otp sont facultatifs. Elles sont requises si le propriétaire du document les définit pendant la phase de création du flux de travail.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du package	packageId_bulkAction	True	integer	ID de package à télécharger.
ID de document	document-ids		array	Le paramètre Id de document est facultatif. Si x-combine-files a la valeur true, les documents sont fusionnés en fonction des documents mentionnés du package.
Mot de passe d’accès au document	x-password		string	Mot de passe défini par le propriétaire du document pour accéder au document, le cas échéant. Si le mot de passe n’a pas été défini, la valeur doit être null.
Document One-Time mot de passe	x-otp		string	Mot de passe (OTP) One-Time défini par le propriétaire du document pour accéder au document, le cas échéant. Si l’otP n’a pas été défini, la valeur doit être null.
Combiner des fichiers	x-combine-files		string	La valeur par défaut est false, définie sur « true » pour combiner l’ensemble du package de documents dans un fichier PDF unique.
ID du dossier	x-folder-id		string	Spécifiez l’ID de dossier, pour récupérer les éléments de dossier, lorsqu’un dossier d’espace partagé est impliqué.

Retours

response: object

État de signature en bloc

ID d’opération :: V4_Signing_BulkSignStatus

Les applications métier peuvent utiliser cette API pour obtenir l’état d’une transaction de signature en bloc spécifique, ainsi que les détails des packages de documents qui ont été traités par l’API Packages de signature en bloc .

Vous devez appeler cette API après l’API Packages de signature en bloc.

Pour la signature RAS, la propriété ACTION sera REMOTE_AUTHORIZATION_REQURIED et la propriété STATUS sera EN ATTENTE, indiquant que la demande doit être autorisée à l’aide de l’appareil mobile. Si le processus de signature échoue dans un document en raison de différents niveaux d’assurance configurés et que l’utilisateur souhaite relancer le processus de signature pour terminer le processus de signature sur les documents ayant échoué, la propriété ACTION est REINITIATE_SIGNING_PROCESS et la propriété STATUS est EN ATTENTE.

Paramètres

Nom	Clé	Obligatoire	Type	Description
identifiant_de_transaction	transaction_id		string	Numéro d’identification de la transaction de signature en bloc
Action en bloc	bulk_action	True	string	Action en bloc à effectuer. Les valeurs possibles sont : SIGN \| PARTAGER

Retours

Corps: BulkSignStatusResponse

Définitions

ElectronicSealRecipient

Nom	Chemin d’accès	Type	Description
nom	name	string
level_of_assurance	level_of_assurance	string

ReminderResponse

Nom	Chemin d’accès	Type	Description
enabled	enabled	boolean	True, si les rappels sont activés pour le destinataire
fréquence	frequency	string	Fréquence de rappel. Les valeurs possibles sont DAYS \| HEURES.
remind_after	remind_after	integer	Nombre de jours après lesquels le premier rappel est envoyé à l’utilisateur du flux de travail.
répéter	repeat		Répétez l’objet avec les détails du rappel répétés ou non.

AddQrCodeResponse

Nom	Chemin d’accès	Type	Description
données	data	string	Données générées par le code QR
field_name	field_name	string	Nom du champ créé dans le document.
valeur	value	string	La valeur sera l’image QrCode en base64

AddFieldResponse

Nom	Chemin d’accès	Type	Description
field_name	field_name	string	Nom du champ créé dans le document.
created_on	created_on	string	Date et heure de la création du champ.

SignatureFieldResponse

Nom	Chemin d’accès	Type	Description
field_name	field_name	string	Nom du champ créé dans le document.
created_on	created_on	string	Date et heure de la création du champ.

UpdateQrCodeResponse

Nom	Chemin d’accès	Type	Description
valeur	value	string	La valeur sera l’image QrCode en base64

CertifyResponse

Nom	Chemin d’accès	Type	Description
enabled	enabled	boolean	True, si les paramètres de signature de certification sont activés pour le document.
allowed_permissions	allowed_permissions	array of string	Certifier un jeu de niveau d’autorisation pour le document avec des paramètres de signature de certification.
default_permission	default_permission	string

GroupMemberResponse

Nom	Chemin d’accès	Type	Description
user_email	user_email	string	Adresse e-mail du membre du groupe
nom_utilisateur	user_name	string	Nom d’utilisateur du membre du groupe

CollaborateurResponse

Nom	Chemin d’accès	Type	Description
user_email	user_email	string	Adresse e-mail de l’utilisateur
signing_order	signing_order	integer	Ordre de signature
guest_user	guest_user	boolean	Utilisateur invité
email_language_code	email_language_code	string	Code de langue de messagerie
autorisation	permission		Autorisations pour le destinataire dans le package de documents
Rappel	reminder		Paramètres de rappel du destinataire.

WorkflowPermissionResponse

Nom	Chemin d’accès	Type	Description
print	print	boolean	True, si l’impression est autorisée pour ce destinataire.
télécharger	download	boolean	True, si le téléchargement est autorisé.
add_text	add_text	boolean	True, si l’ajout d’annotation de texte sur le document est autorisé.
change_recipients	change_recipients	boolean	True, si le destinataire de l’ordre actuel peut modifier d’autres destinataires dans le flux de travail après le partage du flux de travail.
add_attachment	add_attachment	boolean	True, si les pièces jointes et la fusion de documents PDF sont autorisées.
legal_notice	legal_notice		Avis juridique défini par le propriétaire du destinataire.
attachement	attachment		Attachments

EnterpriseTemplateResponse

Nom	Chemin d’accès	Type	Description
id	id	integer	ID du modèle
nom	name	string	Nom du modèle.
public	public	boolean	La réponse est « true » si le modèle d’entreprise est marqué comme public. Sinon, « false » est retourné
read_only	read_only	boolean	Réponse « true » si le modèle est en lecture seule et que l’utilisateur ne peut apporter aucune modification au flux de travail après l’application de ce modèle. Sinon, « false ».
descriptif	description	string	Description du modèle
created_on	created_on	string	Date et heure de création du modèle
roles	roles	array of EnterpriseTemplateRole
documents	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom du rôle d’entreprise attribué à l’utilisateur.
id	id	integer	ID du rôle d’entreprise attribué à l’utilisateur.

TemplateDocumentResponse

Nom	Chemin d’accès	Type	Description
id	id	integer	ID du document de modèle
nom	name	string	Nom du document de modèle.

Next_signer_email

Nom	Chemin d’accès	Type	Description
user_email	user_email	string	Adresse e-mail du signataire suivant.
nom_utilisateur	user_name	string	Nom du signataire suivant.

WorkflowRecipient

Nom	Chemin d’accès	Type	Description
order	order	integer	Ordre du destinataire dans le flux de travail.
user_email	user_email	string	Adresse e-mail du destinataire si l’utilisateur n’est pas un groupe.
nom_utilisateur	user_name	string	Nom du destinataire si l’utilisateur n’est pas un groupe.
mobile_number	mobile_number	string	Numéro de portable
delivery_method	delivery_method	string	Méthode de remise des valeurs possibles du destinataire : E-MAIL, SMS ou EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Point de terminaison d’API permettant d’accéder à la ressource, celui-ci est fourni uniquement pour les signataires principaux. Par exemple, il sera null pour le groupe/delegator/gatekeeper, etc. Cette URL ne garantit pas que l’image du signataire existe. Si l’image existe, elle est fournie en appuyant sur l’URL définie sinon, il s’agit d’une chaîne vide.
group_name	group_name	string	Nom du groupe du destinataire si le destinataire est un groupe.
group_members	group_members	array of GroupMemberResponse	Liste des adresses e-mail des membres du groupe si le destinataire est un groupe.
Délégataire	delegatee	string	Adresse e-mail déléguée, si le destinataire n’est pas un groupe.
delegatee_name	delegatee_name	string	Nom de l’utilisateur délégué, si le destinataire n’est pas un groupe.
role	role	string	Rôle de flux de travail dans lequel le destinataire a été ajouté. Ce rôle n’est pas le rôle d’entreprise. Les valeurs possibles sont « SIGNER », « REVIEWER », « CARBON_COPY » et « EDITOR ».
raison	reason	string	Motif fourni par l’utilisateur lors de la baisse, de l’approbation ou de l’envoi d’un document.
process_status	process_status	string	État du traitement des documents pour le destinataire. Les valeurs possibles sont « UN_PROCESSED », « IN_PROGRESS », « SIGNED », « REVIEWED », « DECLINED », « EDITED » ou « INVALID ».
processed_on	processed_on	string	Date et heure sur lesquelles le document a été traité.
processed_as	processed_as	string	L’utilisateur peut traiter le champ en tant que COLLABORATEUR, DELEGATOR, GROUP_MEMBER ou OWNER.
processed_by	processed_by	string	Adresse e-mail de l’utilisateur qui a traité le document.
Espace réservé	placeholder	string	Texte d’espace réservé si le destinataire est un espace réservé
signing_order	signing_order	integer	Ordre dans lequel le flux de travail sera signé par les destinataires. Cet ordre de signature est important lorsque le type de flux de travail est défini sur « CUSTOM ».
user_national_id	user_national_id	string	Numéro d’identité national de l’utilisateur. Cela permet d’identifier l’utilisateur dans le flux de travail
guest_user	guest_user	boolean	Utilisateur Gest
email_language_code	email_language_code	string	code de langue de messagerie
electronic_seal	electronic_seal	ElectronicSealRecipient
Gardiens	gatekeepers		Gardiens

EnterpriseAccessResponse

Nom	Chemin d’accès	Description
Authentification	authentication	Objet d’authentification avec les détails des méthodes d’authentification appliquées au document pour le destinataire.
authentication_signing	authentication_signing	Signature d’authentification pour le package
access_duration	access_duration	Objet de durée d’accès avec les détails des titres d’accès pour le destinataire.

GetPackageDetailsResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom du package de document.
propriétaire	owner	DocumentOwner
read_only	read_only	boolean	True si le modèle appliqué est en lecture seule. L’utilisateur ne pourra apporter aucune modification si un modèle en lecture seule est appliqué.
document_status	document_status	string	État du document de l’utilisateur connecté actuel. Les valeurs possibles sont « DRAFT », « INPROGRESS », « PENDING », « DECLINED » ou « COMPLETED ».
documents	documents	array of DocumentDetails

DocumentOwner

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom du propriétaire du package de document.
email	email	string	E-mail du propriétaire du package de document.

DocumentDetails

Nom	Chemin d’accès	Type	Description
id	id	integer	ID du document nouvellement créé.
nom	name	string	Nom du document.
uploaded_on	uploaded_on	string	Date et heure du chargement du document.
modified_on	modified_on	string	Date et heure de la dernière modification du document.
size	size	integer	Taille du document en octets.
type	type	string	Type du document, par exemple « PDF ».
source	source	string	Identifie l’emplacement où le document a été chargé, par exemple « Mon application ».

TemplateResponse

Nom	Chemin d’accès	Type	Description
template_id	template_id	integer	L’ID du modèle est retourné ici
template_name	template_name	string	Nom du modèle.
template_public	template_public	boolean	La réponse est « true » si le modèle d’entreprise est marqué comme public. Sinon, « false » est retourné
read_only	read_only	boolean	Réponse « true » si le modèle est en lecture seule et que l’utilisateur ne peut apporter aucune modification au flux de travail après l’application de ce modèle. Sinon, « false ».
created_on	created_on	string	Date et heure de création du modèle
descriptif	description	string	Description du modèle
entreprise	enterprise	boolean	True, si l’utilisateur appartient à une entreprise.
documents	documents	array of TemplateDocumentResponse
smart_form	smart_form		Formulaire intelligent

StartWorkflowResponse

Nom	Chemin d’accès	Type	Description
package_id	package_id	integer	ID de package du package juste partagé. En cas de partage individuel, plusieurs packages sont créés et partagés avec les destinataires. L’API retourne un tableau de packages ainsi que des ID de documents nouvellement créés.
documents	documents	array of integer	Tableau d’ID de document qui faisaient partie du package avant le partage.

WorkflowDetailsResponse

Nom	Chemin d’accès	Type	Description
package_id	package_id	integer	ID de package du package de document.
package_name	package_name	string	Nom du package de document.
shared_package	shared_package	boolean	package partagé
package_owner	package_owner	string	Adresse e-mail du propriétaire du package de document.
owner_name	owner_name	string	Nom du propriétaire du package de document.
package_status	package_status	string	État du document de l’utilisateur connecté actuel. Les valeurs possibles sont « DRAFT », « INPROGRESS », « PENDING », « DECLINED », « APPROVED », « UPDATED » ou « COMPLETED ».
folder	folder	string	Nom du dossier qui contient le package de document.
folder_id	folder_id	integer	ID du dossier qui contient le package de document.
Gardien	gatekeeper	boolean
next_signer	next_signer	string	Nom du signataire suivant si le document est dans un état partagé.
next_signer_email	next_signer_email	array of Next_signer_email	Objet contenant le nom d’utilisateur et l’adresse e-mail des signataires suivants. En cas de signataire du groupe, il aura une liste d’adresses e-mail de tous les membres du groupe.
uploaded_on	uploaded_on	string	Date et heure du chargement du document.
modified_on	modified_on	string	Date et heure de la dernière modification du document.
flux de travail	workflow		Objet de flux de travail avec les détails du flux de travail.
documents	documents	array of WorkflowDocumentsResponse	Liste des documents chargés dans le package.
users	users	array of WorkflowUserResponse	Liste des destinataires du flux de travail.

WorkflowDocumentsResponse

Nom	Chemin d’accès	Type	Description
document_id	document_id	integer	ID du document.
document_name	document_name	string	Nom du document.
document_type	document_type	string	Extension de document d’origine lorsque le document a été chargé avant la conversion au format PDF.
document_order	document_order	integer	Ordre du document dans le package de document.
document_source	document_source	string	Source du document à partir duquel le document a été chargé.
update_required	update_required	boolean	True si le document est requis pour mettre à jour
document_height	document_height	integer	Hauteur du document PDF.
document_width	document_width	integer	Largeur du document PDF.
document_pages	document_pages	integer	Nombre total de pages dans le document.
created_on	created_on	string	Date et heure à laquelle le document a été chargé.
modified_on	modified_on	string	Date et heure de la dernière modification du document.
form_fields	form_fields	boolean	True, si le document comporte des champs de formulaire.
modèle	template		Objet de modèle appliqué au document, ainsi que les détails du modèle.
Certifier	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	True, si le document est défini pour verrouiller les champs de formulaire avec la dernière signature numérique du document.
verrouillé	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Métadonnées de document pdf : true si le document pdf a des champs de signature signés
attachments	attachments	boolean	True, si le document contient des pièces jointes.
conformance_level	conformance_level	string	Niveau de conformité du document
document_size	document_size	integer	Taille du document.
Formaté	formatted	boolean	Cette propriété est destinée au document XML, que sa mise en forme ou non

WorkflowUserResponse

Nom	Chemin d’accès	Type	Description
order	order	integer	Ordre du destinataire dans le flux de travail.
nom_utilisateur	user_name	string	Nom du destinataire si le destinataire n’est pas un groupe. Si le destinataire est un espace réservé, il contient le nom de l’espace réservé.
user_email	user_email	string	Adresse e-mail du destinataire si le destinataire n’est pas un groupe ou un espace réservé.
mobile_number	mobile_number	string	Numéro de portable
delivery_method	delivery_method	string	Méthode de remise des valeurs possibles du destinataire : E-MAIL, SMS ou EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Point de terminaison d’API permettant d’accéder à la ressource, celui-ci est fourni uniquement pour les signataires principaux. Par exemple, il sera null pour le groupe/delegator/gatekeeper, etc. Cette URL ne garantit pas que l’image du signataire existe. Si l’image existe, elle est fournie en appuyant sur l’URL définie sinon, il s’agit d’une chaîne vide.
group_name	group_name	string	Nom du groupe si le destinataire est un groupe.
group_members	group_members	array of string	Liste de toutes les adresses e-mail et noms des utilisateurs.
delegator	delegator	string	Adresse e-mail de l’utilisateur qui est délegator à ce destinataire.
Gardien	gatekeeper	string	Adresse e-mail de l’utilisateur qui est gatekeeper à ce destinataire.
Gardiens	gatekeepers		Gardiens
role	role	string	Rôle du destinataire, c’est-à-dire « SIGNER », « RÉVISEUR », « ÉDITEUR », « CARBON_COPY » ou « INPERSON_HOST ».
process_status	process_status	string	État du traitement des documents pour le destinataire. Les valeurs possibles sont « UN_PROCESSED », « IN_PROGRESS », « SIGNED », « REVIEWED », « DECLINED », « EDITED » ou « INVALID ».
processed_on	processed_on	string	Date et heure sur lesquelles le document a été traité.
processed_as	processed_as	string	L’utilisateur peut traiter le champ en tant que COLLABORATEUR, DELEGATOR, GROUP_MEMBER ou OWNER.
processed_by	processed_by	string	Adresse e-mail de l’utilisateur qui a traité le document.
raison	reason	string	Motif fourni par l’utilisateur lors de la baisse, de l’approbation ou de l’envoi d’un document.
Espace réservé	placeholder	string	Texte d’espace réservé si le destinataire est un espace réservé.
autorisation	permission		Autorisations pour le destinataire défini par le propriétaire du package de document.
authentications	authentications		Objet d’authentification avec les détails des authentifications et des titres d’accès configurés pour le destinataire.
Rappel	reminder		Objet Rappel avec les détails des paramètres de rappel.
signing_order	signing_order	integer	Ordre dans lequel le flux de travail sera signé par les destinataires. Cet ordre de signature est important lorsque le type de flux de travail est défini sur « CUSTOM ».
user_national_id	user_national_id	string	Numéro d’identité national de l’utilisateur. Cela permet d’identifier l’utilisateur dans le flux de travail
guest_user	guest_user	boolean	Utilisateur Gest
email_language_code	email_language_code	string	Code de langue de messagerie
electronic_seal	electronic_seal		sceau électronique

DocumentDetailsResponse

Nom	Chemin d’accès	Type	Description
document_id	document_id	integer	ID du document nouvellement créé.
document_name	document_name	string	Nom du document.
document_order	document_order	integer
document_type	document_type	string	Type du document, par exemple « PDF ».
document_width	document_width	integer	Largeur du document au format PDF.
document_height	document_height	integer	Hauteur du document au format PDF.
document_source	document_source	string	Identifie l’emplacement où le document a été chargé, par exemple « Mon application ».
document_pages	document_pages	integer	Nombre total de pages du document.
form_fields	form_fields	boolean	True si le document comporte des champs de formulaire.
lock_form_fields	lock_form_fields	boolean	True si le verrouillage des champs de formulaire avec la dernière signature est activé.
uploaded_on	uploaded_on	string	Date et heure du chargement du document.
modified_on	modified_on	string	Date et heure de la dernière modification du document.
Certifier	certify		Paramètres de signature certifiés pour le document.
modèle	template		Détails du modèle, si le modèle est appliqué sur le document.

AddAttachmentResponse

Nom	Chemin d’accès	Type	Description
attachment_id	attachment_id	integer	ID de pièce jointe

GetAttachmentResponse

Nom	Chemin d’accès	Type	Description
attachment_id	attachment_id	integer	ID de pièce jointe
attachment_name	attachment_name	string	Nom de la pièce jointe

AddPackageResponse

Nom	Chemin d’accès	Type	Description
package_id	package_id	integer	ID de package à utiliser ultérieurement pour partager, télécharger et obtenir l’état du document.
workflow_mode	workflow_mode	string	Mode de flux de travail défini lors de l’ajout d’un package.
workflow_type	workflow_type	string	Type du flux de travail. Les valeurs possibles sont « SERIAL », « PARALLEL », « INDIVIDUAL » et « CUSTOM ».

GetPackagesResponse

Nom	Chemin d’accès	Type	Description
package_id	package_id	integer	ID de package du package de document.
package_name	package_name	string	Nom du package de document.
package_owner	package_owner	string	Adresse e-mail du propriétaire du package de document.
owner_name	owner_name	string	Nom du propriétaire du package de document.
shared_package	shared_package	boolean	Package partagé
gatekeeper_package	gatekeeper_package	boolean	Gatekeeper Package
package_status	package_status	string	État du document de l’utilisateur connecté actuel. Les valeurs possibles sont « DRAFT », « INPROGRESS », « PENDING », « DECLINED » ou « COMPLETED ».
extension	extension	string	Extension de package de documents
workflow_mode	workflow_mode	string	Mode flux de travail
folder	folder	string	Nom du dossier qui contient le package de document.
folder_id	folder_id	integer	ID du dossier qui contient le package de document.
non lu	unread	boolean	True, si le document n’est pas encore lu par le destinataire.
next_signer	next_signer	string	Nom du signataire suivant si le document est dans un état partagé.
next_signer_email	next_signer_email	array of Next_signer_email	Objet contenant le nom d’utilisateur et l’adresse e-mail des signataires suivants. En cas de signataire du groupe, il aura une liste d’adresses e-mail de tous les membres du groupe.
uploaded_on	uploaded_on	string	Date et heure du chargement du document.
modified_on	modified_on	string	Date et heure de la dernière modification du document.
access_duration	access_duration		Spécifiez la date/heure de début et de fin d’un destinataire pour accéder au document. Le destinataire ne pourra pas accéder au document au-delà de cette durée. Si le document n’est pas traité dans le délai spécifié, le document est considéré comme refusé.. Cela est fourni si « x-recipient-details » est passé comme true dans l’en-tête
Déclin	decline		Détails du refus du document si son contenu a été refusé manuellement ou automatiquement via Core. Cela est fourni si « x-recipient-details » est passé comme true dans l’en-tête
size	size	integer	Taille du document en octets.

DocumentResponse

Nom	Chemin d’accès	Type	Description
package_name	package_name	string	Nom du package de document

UploadDocument

Nom	Chemin d’accès	Type	Description
documentId	documentId	integer	Cette propriété est conservée pour la compatibilité descendante et sera supprimée dans les versions ultérieures. Utilisez document_id à la place.
documentid	documentid	integer	ID de document à utiliser ultérieurement pour partager, télécharger et obtenir l’état du document. sera supprimé ultérieurement document_id sera utilisé
document_id	document_id	integer	ID de document à utiliser ultérieurement pour partager, télécharger et obtenir l’état du document.
document_name	document_name	string	Nom du document.
document_order	document_order	integer	Ordre de document dans le package
document_type	document_type	string	Type du document, par exemple « PDF ».
document_source	document_source	string	Identifie l’emplacement où le document a été chargé, par exemple « Mon application ».
document_width	document_width	integer	Largeur du document au format PDF.
document_height	document_height	integer	Hauteur du document au format PDF.
document_pages	document_pages	integer	Nombre total de pages du document.
uploaded_on	uploaded_on	date-time	Date et heure du chargement du document.
modified_on	modified_on	date-time	Date et heure de la dernière modification du document.
lock_form_fields	lock_form_fields	boolean	True si le verrouillage des champs de formulaire avec la dernière signature est activé.
Certifier	certify		Paramètres de signature certifiés pour le document.
document_size	document_size	integer	Taille de document chargée en octets
metadata	metadata		Informations meta de document téléchargées au format PDF
package_name	package_name	string	Nom du package de document

CertifyPolicyResponse

Nom	Chemin d’accès	Type	Description
Certifier	certify		Certifier les paramètres de signature du document.
lock_form_fields	lock_form_fields	boolean	True si les champs de formulaires doivent être verrouillés au format PDF après la dernière signature numérique sur le document actif.

BulkSignResponse

Nom	Chemin d’accès	Type	Description
status	status	string
identifiant_de_transaction	transaction_id	string

BulkSignStatusResponse

Nom	Chemin d’accès	Type	Description
status	status	string
Paquets	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Nom	Chemin d’accès	Type	Description
id	id	integer
nom	name	string
status	status	string
action	action	string	Clé d’action requise le cas échéant
error	error	string
pourcentage	percentage	integer
documents	documents	array of BulkSignActionDocumentModel	Documents dans le package actuel

BulkSignActionDocumentModel

Nom	Chemin d’accès	Type	Description
id	id	integer
champs	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Nom	Chemin d’accès	Type
nom	name	string
hachis	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Nom	Chemin d’accès	Type	Description
field_name	field_name	string	Nom du champ pour lequel la vérification a été demandée.
status	status	string	Retourne l’état du champ de signature. Les valeurs sont SIGNED, PENDING. L’état aide eIDAS à activer la signature autorisée à distance. Si la demande de signature est envoyée au mobile, l’état est en attente.
identifiant_de_transaction	transaction_id	string	Ce paramètre est utilisé lors de la signature RAS
vérification	verification		Vérification de signature
authentication_access_token	authentication_access_token	string	Il contiendra le id_token OIDC lorsque l’utilisateur est authentifié via OIDC

AutoPlaceFieldsResponse

Nom	Chemin d’accès	Type	Description
field_name	field_name	string	Nom du champ généré automatiquement par l’API.

ContactResponse

Nom	Chemin d’accès	Type	Description
id	id	integer	ID du contact.
nom_utilisateur	user_name	string	Nom d’utilisateur du contact.
user_email	user_email	string	Adresse e-mail du contact.
mobile_number	mobile_number	string	Numéro de téléphone mobile du contact.
entreprise	enterprise	boolean	True, si le contact est d’entreprise.
user_national_id	user_national_id	string	Numéro d’identité national du contact
created_on	created_on	string	DateTime lorsque le contact est ajouté.

WorkSpaceMembers

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom du membre de l’espace de travail
email	email	string	Adresse e-mail du membre de l’espace de travail

WorkSpaceResponse

Nom	Chemin d’accès	Type	Description
id	id	integer	ID de l’espace partagé
nom	name	string	Nom de l’espace partagé
propriétaire	owner		Propriétaire de l’espace partagé
membres	members	array of WorkSpaceMembers	Membres de l’espace partagé

UploadDocumentLibraryResponse

Nom	Chemin d’accès	Type	Description
document_id	document_id	integer	ID du document nouvellement créé.
document_name	document_name	string	Nom du document.
document_size	document_size	integer	Taille de document chargée en octets
document_order	document_order	integer	Ordre du document
document_type	document_type	string	Type du document, par exemple « PDF ».
document_source	document_source	string	Identifie l’emplacement où le document a été chargé, par exemple « Mon application ».
document_width	document_width	integer	Largeur du document au format PDF.
document_height	document_height	integer	Hauteur du document au format PDF.
document_pages	document_pages	integer	Nombre total de pages du document.
uploaded_on	uploaded_on	date-time	Date et heure du chargement du document.
modified_on	modified_on	date-time	Date et heure de la dernière modification du document.
form_fields	form_fields	boolean	True si le document comporte des champs de formulaire.
lock_form_fields	lock_form_fields	boolean	True si le verrouillage des champs de formulaire avec la dernière signature est activé.
Certifier	certify		Paramètres de signature certifiés pour le document.
modèle	template		Détails du modèle, si le modèle est appliqué sur le document.
package_name	package_name	string	Nom du package
metadata	metadata		Informations meta de document téléchargées au format PDF

WorkflowHistoryResponse

Nom	Chemin d’accès	Type	Description
package_id	package_id	integer	ID du package pour lequel l’historique du flux de travail est demandé.
package_name	package_name	string
package_owner	package_owner	string	Adresse e-mail du propriétaire du package.
owner_name	owner_name	string	Nom du propriétaire du package.
package_status	package_status	string	État du package/document avec l’utilisateur connecté actuel. Les valeurs possibles sont « DRAFT », « INPROGRESS », « PENDING », « DECLINED », « APPROVED », « UPDATED » ou « COMPLETED ».
next_signer	next_signer	string	Nom du destinataire suivant.
next_signer_email	next_signer_email	array of Next_signer_email	Objet ayant le nom et l’adresse e-mail du destinataire suivant.
documents	documents	array of WorkflowDocumentsResponse
Actions	actions	array of DocumentLogsActions

DocumentLogsActions

Nom	Chemin d’accès	Type	Description
log_id	log_id	integer	ID d’une action effectuée sur le document.
date_time	date_time	string	Date et heure de l’exécution de l’action.
action_type	action_type	string
user_email	user_email	string	E-mail de l’utilisateur qui a effectué l’action.
nom_utilisateur	user_name	string	Nom de l’utilisateur qui a effectué l’action.
enterprise_name	enterprise_name	string	Nom d’Entreprise auquel appartient l’utilisateur. Si l’utilisateur n’appartient pas à une entreprise, cet élément n’est pas présent.
information	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

Nom	Chemin d’accès	Type	Description
type	type	string	Type d’informations supplémentaires sur l’action, par exemple « SIGNING_METHOD », ce qui signifie que l’utilisateur de méthode de signature utilisé pour signer le document.
valeur	value	string	Valeur des informations supplémentaires sur l’action, par exemple « LOCAL », ce qui signifie que l’utilisateur a signé le document à l’aide d’informations d’identification détenues localement.

UpdateCollaboratorResponse

Nom	Chemin d’accès	Type	Description
user_email	user_email	string	Adresse e-mail de l’utilisateur
signing_order	signing_order	integer	Ordre de signature
guest_user	guest_user	boolean	Utilisateur invité
email_language_code	email_language_code	string	Code de langue de messagerie

CollaborateurGroupResponse

Nom	Chemin d’accès	Type	Description
autorisation	permission		Autorisations pour le destinataire dans le package de documents
Rappel	reminder		Paramètres de rappel du destinataire.
signing_order	signing_order	integer	Ordre de signature

CollaborateurPlaceholderResponse

Nom	Chemin d’accès	Type	Description
autorisation	permission		Autorisations pour le destinataire dans le package de documents
Rappel	reminder		Paramètres de rappel du destinataire.
signing_order	signing_order	integer	Ordre de signature

FieldsResponse

Nom	Chemin d’accès	Type	Description
signature	signature	array of DigitalSignatureFieldResponse	Liste de toutes les signatures numériques dans le document.
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
initiales	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
items	in_person_signature	object
texte	text	array of TextFieldResponse
radio	radio	array of RadioFieldResponse
case à cocher	checkbox	array of CheckboxFieldResponse
liste déroulante	dropdown	array of DropdownFieldResponse
Listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
attachement	attachment	array of AttachmentFieldResponse
commentaire	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

Nom	Chemin d’accès	Type	Description
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
type	type	string	Si le champ est attribué ou non, les valeurs possibles sont ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN et PLACEHOLDER.
process_status	process_status	string	Indique si le champ est traité ou non. Les valeurs possibles sont UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Heure de date sur laquelle le document est traité.
processed_as	processed_as	string	Utilisateur qui a traité le champ en tant que COLLABORATEUR, DELEGATEE, GROUP_MEMBER ou OWNER.
created_on	created_on	string	Heure de date à laquelle le champ est ajouté
processed_by	processed_by	string	Adresse e-mail de l’utilisateur qui a traité le champ.
dimensions	dimensions	FieldDimenssionResponse
vérification	verification		Retourne la réponse de vérification du champ de signature. En cas de non vérification, la valeur Null est retournée.
nid	nid	string
Affichage	display	string	Retourne la valeur de visibilité du champ de signature numérique, les valeurs possibles sont « VISIBLE » et « INVISIBLE ».
level_of_assurance	level_of_assurance	array of string
Authentification	authentication		Authentication

FieldDimenssionResponse

Nom	Chemin d’accès	Type	Description
champ	field	FieldResponse
page	page	PageResponse

FieldResponse

Nom	Chemin d’accès	Type	Description
x	x	double	Emplacement gauche du champ en pixels.
y	y	double	Emplacement supérieur du champ en pixels.
width	width	double	Largeur du champ en pixels.
height	height	double	Hauteur du champ en pixels.

PageResponse

Nom	Chemin d’accès	Type	Description
width	width	float	Largeur de la page où le champ est placé dans le fichier PDF.
height	height	float	Hauteur de la page où le champ est placé dans le fichier PDF.

HandSignatureFieldResponse

Nom	Chemin d’accès	Type	Description
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
type	type	string	Si le champ est attribué ou non, les valeurs possibles sont ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN et PLACEHOLDER.
process_status	process_status	string	Indique si le champ est traité ou non. Les valeurs possibles sont UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Heure de date sur laquelle le document est traité.
processed_as	processed_as	string	Utilisateur qui a traité le champ en tant que COLLABORATEUR, DÉLÉGUÉE, GROUP_MEMBER ou OWNER.
processed_by	processed_by	string	Adresse e-mail de l’utilisateur qui a traité le champ.
dimensions	dimensions	FieldDimenssionResponse
nid	nid	string

ElectronicSignatureFieldResponse

Nom	Chemin d’accès	Type	Description
order	order	integer	Adresse e-mail de l’utilisateur qui a traité le champ.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
type	type	string	Si le champ est attribué ou non, les valeurs possibles sont ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN et PLACEHOLDER.
process_status	process_status	string	Indique si le champ est traité ou non. Les valeurs possibles sont UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Heure de date sur laquelle le document est traité.
processed_as	processed_as	string	Utilisateur qui a traité le champ en tant que COLLABORATEUR, DÉLÉGUÉE, GROUP_MEMBER ou OWNER.
processed_by	processed_by	string	Adresse e-mail de l’utilisateur qui a traité le champ.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	Le sous-type de signature peut être une signature WITNESS. Si les signatures de témoin sont activées dans le plan de service, les champs E-Signature sont signés avec un certificat commun partagé par tous les utilisateurs du plan de service. Les valeurs possibles sont WITNESS ou NONE.
Authentification	authentication		Authentication
vérification	verification		Retourne la réponse de vérification du champ. En cas de non vérification, la valeur Null est retournée.
nid	nid	string
Affichage	display	string	Retourne la valeur de visibilité du champ de signature électronique, les valeurs possibles sont « VISIBLE » et « INVISIBLE ».

InitialFieldResponse

Nom	Chemin d’accès	Type	Description
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
process_status	process_status	string	Indique si le champ est traité ou non. Les valeurs possibles sont UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Heure de date sur laquelle le document est traité.
processed_as	processed_as	string	Utilisateur qui a traité le champ en tant que COLLABORATEUR, DÉLÉGUÉE, GROUP_MEMBER ou OWNER.
processed_by	processed_by	string	Adresse e-mail de l’utilisateur qui a traité le champ.
dimensions	dimensions	FieldDimenssionResponse
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.

TextFieldResponse

Nom	Chemin d’accès	Type	Description
field_locale	field_locale	string	Champ local. Les valeurs possibles sont ar-AE \| en-US. Facultatif et par défaut sera en-US. Cette valeur est importante pour le type « DATE ».
obligatoire	required	boolean	True si le champ est requis au format pdf
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
tab_order	tab_order	integer	Ordre de tabulation dans le document PDF
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
type	type	string	Type du champ de texte, les valeurs possibles sont « TEXT », « NAME », « COMPANY », « JOBTITLE », « EMAIL », « DATE ».
valeur	value	string	Valeur du champ. Pour type = DATE ou format_type = DATE, la valeur est censée suivre le format ISO 8601. Suivant le format AAAA -MM-DD hh :mm :ss +00. Comme les valeurs concernent les champs de date, les applications clientes peuvent envoyer aaaa-MM-DD et ignorer hh :mm :ss +00. Si la valeur n’est pas au format approprié, une erreur est retournée.
read_only	read_only	boolean	True, si le champ est marqué en lecture seule dans le document PDF.
validation_rule	validation_rule	string	Une ou plusieurs règles pour la validation des champs, les valeurs possibles sont « MANDATORY » ou « OPTIONAL ».
validation	validation		Cet objet est destiné à la valeur requise à passer
visible	visible	boolean	True, si le champ n’est pas masqué dans le document PDF.
multiligne	multiline	boolean	True, si le champ est multiligne dans le document PDF.
police	font	FontResponse
longueur_maximale	max_length	integer	Longueur maximale du contenu autorisée à être renseignée dans le champ.
format_type	format_type	string	Si le champ est une zone de texte, il peut suivre différents types d’entrée. Les valeurs possibles sont ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME ou DATE.
Espace réservé	placeholder	string	Texte d’espace réservé pour le champ de zone de texte.
format	format	string	Format de texte du champ. Utilisé uniquement pour le champ type de date. Les valeurs possibles sont les suivantes : m/d m/d/yy m/d/aaaa mm/jj/aaaa mm/jj/aaaa mm/aaaa mm/aaaa d-mmm d-mmm-yy d-mmm-aaaa dd-mmm-yy dd-mmm-aaaa yy-mm-dd aaaa-mm-jj mmm-yy mmm-aaaa mmmm-aaaa mmmm-aaaa mmmm d, aaaa dd/mm/aaaa ddmmmyyyy
color	color	string	Couleur du texte dans les champs de formulaire.
Couleur_de_la_bordure	border_color	string	Couleur de bordure du champ de formulaire.
info-bulle	tooltip	string	info-bulle du champ de formulaire.
field_rotation	field_rotation	integer	Rotation des champs
aligner	align	string	Alignement du texte pour le champ de formulaire. Les valeurs possibles sont « RIGHT », « LEFT », « CENTER » ou « JUSTIFIE ».
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Nom	Chemin d’accès	Type	Description
obligatoire	required	boolean	True si le champ est requis au format pdf
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
tab_order	tab_order	integer	Ordre de tabulation dans le document PDF.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
type	type	string
valeur	value	boolean	Valeur du champ.
read_only	read_only	boolean	True, si le champ est marqué en lecture seule dans le document PDF.
validation_rule	validation_rule	string	Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
radio_group_name	radio_group_name	string	Nom du groupe auquel appartient le champ.
vérifié	checked	boolean	True, si le champ est sélectionné
visible	visible	boolean	True si le champ n’est pas masqué dans le document PDF.
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Couleur du texte dans les champs de formulaire.
Couleur_de_la_bordure	border_color	string	Couleur de bordure du champ de formulaire.
info-bulle	tooltip	string	info-bulle du champ de formulaire.
field_rotation	field_rotation	integer	Rotation des champs

CheckboxFieldResponse

Nom	Chemin d’accès	Type	Description
obligatoire	required	boolean	True si le champ est requis au format pdf
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
tab_order	tab_order	integer	Ordre de tabulation dans le document PDF
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
type	type	string
valeur	value	boolean	Valeur du champ.
read_only	read_only	boolean	True, si le champ est marqué en lecture seule dans le document PDF.
vérifié	checked	boolean	True si le champ est sélectionné.
visible	visible	boolean	True si le champ n’est pas masqué dans le document PDF.
validation_rule	validation_rule	string	Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Couleur du texte dans les champs de formulaire.
Couleur_de_la_bordure	border_color	string	Couleur de bordure du champ de formulaire.
info-bulle	tooltip	string	info-bulle du champ de formulaire.
field_rotation	field_rotation	integer	Rotation des champs

DropdownFieldResponse

Nom	Chemin d’accès	Type	Description
obligatoire	required	boolean	True si le champ est requis au format pdf
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
tab_order	tab_order	integer	Ordre de tabulation dans le document PDF.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
validation_rule	validation_rule	string	Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
read_only	read_only	boolean	True, si le champ est marqué en lecture seule dans le document PDF.
valeur	value	string	Valeur du champ .
choix	choices	array of string	Choix disponibles pour la liste déroulante à partir duquel choisir une valeur.
visible	visible	boolean	True, si le champ n’est pas masqué dans le document PDF.
dimensions	dimensions	FieldDimenssionResponse
police	font	FontResponse
color	color	string	Couleur du texte dans les champs de formulaire.
Couleur_de_la_bordure	border_color	string	Couleur de bordure du champ de formulaire.
info-bulle	tooltip	string	info-bulle du champ de formulaire.
field_rotation	field_rotation	integer	Rotation des champs

ListBoxFieldResponse

Nom	Chemin d’accès	Type	Description
order	order	integer	Ordre du destinataire auquel ce champ est affecté. Si le champ n’est attribué à personne, la valeur est null.
tab_order	tab_order	integer	Ordre de tabulation dans le document PDF.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
Intégré	embedded	boolean	True, si le champ fait partie du document PDF.
validation_rule	validation_rule	string	Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
read_only	read_only	boolean	True, si le champ est marqué en lecture seule dans le document PDF.
valeur	value	string	Valeur du champ.
choix	choices	array of string	Choix disponibles pour la liste déroulante à partir duquel choisir une valeur.
visible	visible	boolean	True, si le champ n’est pas masqué dans le document PDF.
dimensions	dimensions	FieldDimenssionResponse
police	font	FontResponse
color	color	string	Couleur du texte dans les champs de formulaire.
Couleur_de_la_bordure	border_color	string	Couleur de bordure du champ de formulaire.
info-bulle	tooltip	string	info-bulle du champ de formulaire.
field_rotation	field_rotation	integer	Rotation des champs

FontResponse

Nom	Chemin d’accès	Type	Description
nom	name	string	Nom de police pour le champ de texte. Pour les champs définis par l’utilisateur, SigningHub prend uniquement en charge « COURIER », « HELVETICA ». En cas de champs existants dans un fichier PDF, la valeur de police peut être tout ce qui est défini dans le fichier PDF.
size	size	integer	Taille de police pour le champ de texte.
embedded_size	embedded_size	double	Taille de la police dans le document PDF d’origine.

QrCodeResponse

Nom	Chemin d’accès	Type	Description
field_name	field_name	string	Identificateur unique du champ.
type	type	string	Type de champ PDF_FIELD_TYPE comme QR
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
valeur	value	string	QrCode généré en base64 sera fourni en mode brouillon
dimensions	dimensions	FieldDimenssionResponse
données	data	string	Données de texte brut à encoder dans le code QR. La valeur par défaut est l’URL générée pour accéder au document associé. par exemple {base_url}/document/{document_unique_id}
options	options		Paramètres relatifs aux options
color	color		Paramètres relatifs à la couleur
logo	logo		Paramètres relatifs au logo

AttachmentFieldResponse

Nom	Chemin d’accès	Type	Description
order	order	integer	Ordre du destinataire auquel ce champ est affecté.
display_order	display_order	integer	Ordre d’affichage en fonction de la visionneuse SigningHub.
field_name	field_name	string	Identificateur unique du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
process_status	process_status	string	Indique si le champ est traité ou non. Les valeurs possibles sont UN_PROCESSED, PROCESSED.
processed_on	processed_on	string	Heure de date sur laquelle le document est traité.
processed_as	processed_as	string	Utilisateur qui a traité le champ en tant que COLLABORATEUR, DÉLÉGUÉE, GROUP_MEMBER ou OWNER.
processed_by	processed_by	string	Adresse e-mail de l’utilisateur qui a traité le champ.
attachmentRefId	attachmentRefId	integer	Id ref attachmet
note	note	string	Remarque Attachmet uniquement dans le cas de la règle de pièce jointe « MANDATORY »
validation_rule	validation_rule		Une ou plusieurs règles de validation des champs possibles sont « MANDATORY » ou « OPTIONAL ».
dimensions	dimensions		Dimentions

CommentFieldResponse

Nom	Chemin d’accès	Type	Description
id	id	integer	ID de champ de commentaire
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
unread_count	unread_count	integer	Commentaires non lus
privé	private	boolean	Privé
destinataires	recipients	array of CommentFieldRecipientResponse	Destinataires
dimensions	dimensions		Dimensions

UniqueIdentifierFieldResponse

Nom	Chemin d’accès	Type	Description
field_name	field_name	string	Identificateur unique du champ.
valeur	value	string	Valeur du champ.
page_no	page_no	integer	Numéro de page du document sur lequel le champ existe.
police	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

Nom	Chemin d’accès	Type	Description
nom_utilisateur	user_name	string	Nom d'utilisateur
user_email	user_email	string	Adresse e-mail de l’utilisateur

object

Il s’agit du type 'object'.