Partager via

SignNow

SignNow permet des flux de travail eSignature sécurisés, conformes et prêts à l’audit pour les entreprises, les ressources humaines, les soins de santé et les équipes financières. Envoyez et suivez les demandes de signature dans l’ordre en fonction du rôle, préremplez les champs de document et gérez les groupes de documents à l’aide du connecteur SignNow.

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 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 Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - 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 High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Centre d’aide
URL https://support.signnow.com/
Messagerie électronique integrations@pdffiller.com
Métadonnées du connecteur
Éditeur DaDaDocs
Website https://signnow.com
Politique de confidentialité https://www.signnow.com/privacy_policy
Catégories Productivité; Ressources humaines

Connecteur SignNow

SignNow permet des flux de travail eSignature sécurisés, conformes et prêts à l’audit pour les entreprises, les ressources humaines, les soins de santé et les équipes financières. Envoyez et suivez les demandes de signature dans l’ordre en fonction du rôle, préremplez les champs de document et gérez les groupes de documents à l’aide du connecteur SignNow.

Conditions préalables

Vous aurez besoin d’un compte SignNow et d’un abonnement d’API SignNow pour continuer.

Déploiement de l’exemple

Tout d’abord, mettez à jour la valeur clientId dans le apiProperties.json avec votre propre valeur.

Exécutez les commandes suivantes et suivez les invites :

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Actions et déclencheurs pris en charge

Pour plus d’informations, consultez la documentation .

Limitations

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

Actions

Annuler l’invitation

Annulation de l’invitation de signature
Charger le document

Charger un document dans SignNow
Créer un document à partir d’un modèle

Générer un document à partir d’un modèle sélectionné
Créer un groupe de documents à partir de plusieurs fichiers

Créer un groupe de documents en chargeant plusieurs fichiers en tant que chaînes encodées en base64
Créer un groupe de documents à partir du modèle de groupe

Créer le groupe de documents à partir d’un modèle de groupe sélectionné
Créer un lien de signature

Générer un lien vers le document et le partager pour que le document soit signé
Créer un lien d’envoi incorporé de document

Cette action génère un lien d’envoi incorporé pour un document spécifique, ce qui permet aux utilisateurs tiers de préparer et d’envoyer le document pour la signature
Créer un lien d’envoi incorporé de groupe de documents

Cette action génère un lien d’envoi incorporé pour un groupe de documents spécifique, ce qui permet aux utilisateurs tiers de préparer et d’envoyer le groupe de documents pour signature
Créer une invitation incorporée de document

Cette action crée une invitation de signature incorporée pour un document. Une fois l’invitation créée, générez un lien de signature incorporé
Créer une invitation incorporée de groupe de documents

Cette action crée une invitation de signature incorporée pour un groupe de documents. Une fois l’invitation créée, générez un lien de signature incorporé
Déconseillé - Invite de documents avancés

L’action est déconseillée. Invitez une demande avec un schéma défini manuellement. Il permet de configurer l’invitation à un document qui sera généré à l’avenir
Déconseillé - Inviter à signer

L’action est déconseillée. Inviter d’autres personnes à remplir et signer le document
Déconseillé - Inviter à signer le groupe de documents

L’action est déconseillée. Inviter d’autres personnes à remplir et signer le groupe de documents
Générer un lien d’invitation incorporé de document

Cette action génère un lien pour l’invitation incorporée au document
Générer un lien d’invitation incorporé de groupe de documents

Cette action génère un lien pour l’invitation incorporée du groupe de documents
Inviter à signer un document

Cette action crée et envoie une invitation de champ pour qu’un document soit signé
Inviter à signer un groupe de documents

Cette action crée une invitation à signer un groupe de documents. Vous pouvez configurer un flux de travail multistep, où différents destinataires agissent sur le groupe de documents à différentes étapes
Obtenir des champs de document

Récupérer des valeurs des champs pouvant être renseignés dans le document
Obtenir des champs de document [DÉCONSEILLÉ]

Cette action a été déconseillée. Utilisez plutôt Obtenir des champs de document .

Obtenir des valeurs de champ de document.
Obtenir des groupes de documents

Récupérer une liste des groupes de documents de l’utilisateur
Obtenir des informations sur le document

Obtenez des propriétés de document telles que le nom, l’ID, les dates de création/mise à jour, etc.
Obtenir la liste des documents

Récupérer une liste des documents de l’utilisateur
Obtenir le groupe de documents

Récupérer une liste des groupes de documents de l’utilisateur
Obtenir le schéma de document [DÉCONSEILLÉ]

Cette action a été déconseillée. Utilisez plutôt Obtenir le schéma de document .

Obtenir le schéma de document OpenAPI
Obtenir l’état de l’invitation de document

Cette action récupère des informations sur une invitation de document, y compris l’état de chaque étape et action.
Obtenir l’état de l’invitation de groupe de documents

Cette action récupère des informations sur une invitation de groupe de documents, y compris l’état de chaque étape et action.
Préremplir les valeurs des champs de document

Remplir automatiquement des champs renseignés dans le document avec des valeurs spécifiques
Préremplir les valeurs des champs de document [DÉPRÉCIÉ]

Cette action a été déconseillée. Utilisez à la place les valeurs de champ de document préremplies .

Préremplir les valeurs et les propriétés des champs.
Préremplir les valeurs des champs de groupe de documents

Remplir automatiquement des champs renseignés dans les documents avec des valeurs spécifiques
Remplacer les destinataires dans l’invitation de document

Cette action remplace les destinataires dans l’invitation de document en fonction de leurs rôles. Il autorise également la mise à jour des paramètres d’invitation tels que le type d’authentification, les jours d’expiration et d’autres paramètres avancés pour chaque rôle
Remplacer les destinataires dans l’invitation de groupe de documents

Cette action remplace les destinataires d’un groupe de documents par son ID d’invitation. Vous pouvez également définir une expiration d’invitation, des rappels, réaffecter des autorisations et refuser des options pour chaque document
Supprimer l’invitation incorporée au document

Cette action supprime une invitation incorporée pour un document
Supprimer l’invitation incorporée du groupe de documents

Cette action supprime une invitation incorporée pour un groupe de documents spécifique
Supprimer un document

Supprimer un document de SignNow
Télécharger le document

Télécharger un document à partir de SignNow
Valeurs de champ intelligent du groupe de documents préremplies

Remplir automatiquement les champs intelligents dans les documents avec des valeurs spécifiques
Valeurs de champ intelligent préremplies

Préremplir les valeurs de champ intelligent pour le document spécifié

Annuler l’invitation

ID d’opération :
CancelInvite

Annulation de l’invitation de signature

Paramètres

Nom Clé Obligatoire Type Description
Document Id
 doc_id True string

Spécifier l’ID de document pour l’annulation de l’invitation à la signature

Retours

response
object

Charger le document

ID d’opération :
UploadDocument

Charger un document dans SignNow

Paramètres

Nom Clé Obligatoire Type Description
Fichier
 file True file

Fichier à charger

Retours

Nom Chemin d’accès Type Description
ID document
 id DocumentId

Unique document ID

Créer un document à partir d’un modèle

ID d’opération :
CreateFromTemplate

Générer un document à partir d’un modèle sélectionné

Paramètres

Nom Clé Obligatoire Type Description
Modèle de document
 doc_id True string

Sélectionner un modèle dans la liste
Nom du document
 document_name string

Entrez le nouveau nom de fichier du document

Retours

Nom Chemin d’accès Type Description
ID document
 id DocumentId

Unique document ID

Créer un groupe de documents à partir de plusieurs fichiers

ID d’opération :
CreateDocGroupFromFiles

Créer un groupe de documents en chargeant plusieurs fichiers en tant que chaînes encodées en base64

Paramètres

Nom Clé Obligatoire Type Description
Nom du groupe de documents
 group_name True string

Entrez un nom pour le groupe de documents
Nom du document
 name True string

Nom du document avec extension : Report.pdf, Letter.docx etc.
Contenu du fichier
 content True string

Chaîne encodée en base64 représentant le contenu du document

Retours

Corps
CreateDocumentGroupFromFilesResponse

Créer un groupe de documents à partir du modèle de groupe

ID d’opération :
CreateFromTemplateGroup

Créer le groupe de documents à partir d’un modèle de groupe sélectionné

Paramètres

Nom Clé Obligatoire Type Description
Modèle de groupe
 doc_group_id True string

Sélectionnez le modèle de groupe dans la liste
Nom du groupe de documents
 group_name string

Entrez le nouveau nom du groupe de documents

Retours

Nom Chemin d’accès Type Description
ID de groupe de documents
 id DocumentGroupId

ID de groupe de documents unique

Créer un lien de signature

ID d’opération :
CreateSigningLink

Générer un lien vers le document et le partager pour que le document soit signé

Paramètres

Nom Clé Obligatoire Type Description
ID document
 doc_id True string

Spécifier un ID de document unique ou sélectionner un document dans la liste
fields
 fields dynamic

Retours

Nom Chemin d’accès Type Description
URL
 url_no_signup string

Lien de signature

Créer un lien d’envoi incorporé de document

ID d’opération :
CreateEmbeddedInviteSettingsLink

Cette action génère un lien d’envoi incorporé pour un document spécifique, ce qui permet aux utilisateurs tiers de préparer et d’envoyer le document pour la signature

Paramètres

Nom Clé Obligatoire Type Description
ID document
 id True string

ID document
Type
 type string

Spécifie l’étape d’envoi à laquelle le lien doit s’ouvrir. Valeurs possibles : « Inviter » : ouvre la page Envoyer une invitation pour le document, où l’utilisateur peut ajouter des e-mails de signataire, d’objet, de message, etc. « Document » : ouvre le document dans l’éditeur pour ajouter des champs remplissage, puis ouvre la page Envoyer une invitation.
URI de redirection
 redirect_uri string

Page qui s’ouvre une fois l’envoi incorporé configuré. Obligatoire si la « cible de redirection » est ajoutée
Expiration du lien
 link_expiration integer

Spécifie le nombre de minutes pendant lesquelles le lien reste actif. Plage autorisée : 15 à 45 minutes. Les utilisateurs au niveau de l’administrateur peuvent définir la durée jusqu’à un maximum de 43200 minutes
Cible de redirection
 redirect_target string

Détermine s’il faut ouvrir l’URI de redirection dans un nouvel onglet dans le navigateur ou dans le même onglet après la session de signature. Valeurs possibles : « Dans le nouvel onglet » : ouvre le lien dans un nouvel onglet, « Dans le même onglet » – ouvre le lien dans le même onglet

Retours

Nom Chemin d’accès Type Description
URL
 url string

Lien vers l’envoi de documents incorporés

Créer un lien d’envoi incorporé de groupe de documents

ID d’opération :
CreateDocGroupEmbeddedInviteSettingsLink

Cette action génère un lien d’envoi incorporé pour un groupe de documents spécifique, ce qui permet aux utilisateurs tiers de préparer et d’envoyer le groupe de documents pour signature

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe de documents
 id True string

ID de groupe de documents
Type
 type string

Spécifie l’étape d’envoi à laquelle le lien incorporé doit s’ouvrir : « gérer », ouvre le lien dans la page Ajouter des documents à la page groupe de documents ; ' modifier' : ouvre le lien dans l’éditeur ; « send-invite » : ouvre le lien dans la page Envoyer une invitation
URI de redirection
 redirect_uri string

Page qui s’ouvre une fois l’envoi incorporé configuré. Obligatoire si la « cible de redirection » est ajoutée
Expiration du lien
 link_expiration integer

Spécifie le nombre de minutes pendant lesquelles le lien reste actif. Plage autorisée : 15 à 45 minutes. Les utilisateurs au niveau de l’administrateur peuvent définir la durée jusqu’à un maximum de 43200 minutes
Cible de redirection
 redirect_target string

Détermine s’il faut ouvrir l’URI de redirection dans un nouvel onglet dans le navigateur ou dans le même onglet après la session de signature. Valeurs possibles : « Dans le nouvel onglet » : ouvre le lien dans un nouvel onglet, « Dans le même onglet » – ouvre le lien dans le même onglet

Retours

Nom Chemin d’accès Type Description
URL
 url string

Lien vers l’envoi du groupe de documents incorporé

Créer une invitation incorporée de document

ID d’opération :
CreateEmbeddedInvites

Cette action crée une invitation de signature incorporée pour un document. Une fois l’invitation créée, générez un lien de signature incorporé

Paramètres

Nom Clé Obligatoire Type Description
ID document
 id True string

ID document
E-mail du signataire
 email True email

Adresse e-mail du destinataire
Role
 role True string

Nom du rôle de destinataire, par exemple « Signataire 1 » (les rôles de visionneuse ne sont pas pris en charge)
JSON
 order True integer

Ordre de signature
Formule de nom
 name_formula string

Formule permettant de générer un nom de document terminé à l’aide d’un préfixe (n’importe quel texte) et de données de champ pouvant être renseignées. Exemple : « Contract|signer_name|signed_date », où « Contract » est le préfixe et « signer_name » et « signed_date » sont des noms de champs remplissageables.
Role
 role True string

Nom du rôle de destinataire, par exemple « Signataire 1 » (les rôles de visionneuse ne sont pas pris en charge)
Language
 language string

Spécifie la langue de la session de signature et des e-mails de notification pour le signataire. Valeurs possibles : En pour anglais, Es pour l’espagnol et fr pour le français. Si elle n’est pas définie, la langue est déterminée par la langue de votre compte SignNow.
Prénom
 first_name string

Prénom du destinataire
Nom de famille
 last_name string

Nom du destinataire
Nom de la signature prédéfinie requise
 required_preset_signature_name string

Texte prérempli pour le champ de signature, verrouillé pour modification par le destinataire. Impossible d’utiliser « prefill_signature_name » ou « force_new_signature »
Nom de la signature de remplissage préalable
 prefill_signature_name string

Chaîne avec un nom de signature qui s’affiche lorsqu’un signataire clique sur un champ de signature. Le signataire peut modifier la signature
Exiger une nouvelle signature
 force_new_signature boolean

Définit si le signataire peut utiliser sa signature enregistrée ou non. Si la valeur est « true », le signataire doit ajouter une nouvelle signature. Si la valeur est « false », le signataire peut utiliser la signature enregistrée
URI de redirection
 redirect_uri string

Lien qui s’ouvre une fois la session de signature terminée
Refuser l’URI de redirection
 decline_redirect_uri string

Lien qui s’ouvre après le refus du destinataire de signer le document
Fermer l’URI de redirection
 close_redirect_uri string

Lien qui s’ouvre lorsque le destinataire clique sur Enregistrer la progression et terminer ultérieurement pendant une session de signature ou Fermer en mode affichage
Cible de redirection
 redirect_target string

Détermine s’il faut ouvrir l’URI de redirection dans un nouvel onglet dans le navigateur ou dans le même onglet après la session de signature. Valeurs possibles : « Dans le nouvel onglet » : ouvre le lien dans un nouvel onglet, « Dans le même onglet » – ouvre le lien dans le même onglet
Type d’authentification
 authentication_type string

Type d’authentification utilisé pour l’authentification du destinataire pendant la session de signature. Valeurs autorisées : « Mot de passe », « Appel téléphonique » et « Sms »
Mot de passe d’authentification
 authentication_password string

Mot de passe défini pour l’authentification du signataire. Obligatoire pour le type d’authentification « Mot de passe »
Téléphone d’authentification
 authentication_phone string

Numéro de téléphone utilisé pour authentifier le signataire. Obligatoire pour le type d’authentification « Appel téléphonique » et « Sms ». Exemple : +1XXXXXXXXX
Sms d’authentification
 authentication_sms_message string

Sms personnalisé envoyé au signataire, contenant l’espace réservé {password}. Utilisé avec le type d’authentification « Sms ». Sans ce paramètre, le signataire reçoit un sms par défaut avec un mot de passe généré automatiquement (code de déverrouillage) - « Code de déverrouillage du document SignNow : 123456 » Exemple : Entrer le mot de passe {password} pour déverrouiller votre document
Type de livraison
 delivery_type string

Définit la façon dont l’invitation est envoyée
Expiration du lien
 link_expiration integer

Pendant combien de minutes l’invitation par e-mail expire. Ne peut être utilisé que si ' Delivery type=email'. Plage valide : 15 à 43200 minutes
Session Expiration
 session_expiration integer

En combien de minutes la session de signature expire. Si un lien est généré pour cette invitation, l’expiration de la session est réinitialisée. Applicable uniquement lorsque « Delivery type=email » et pour les actions « sign ». Plage valide : 15 à 1440 minutes
QES Signature
 signature string

Type de QES. Valeurs possibles : 'Eideasy', 'Nom151'. Utilisé pour demander des signatures QES auprès des signataires. Tous les signataires de l’invitation doivent utiliser le même type de signature. Pour créer une invitation avec QES, l’utilisateur doit appartenir à une organisation avec QES activé

Retours

Nom Chemin d’accès Type Description
données
 data array of object

Data
Id
 data.id string

ID de l’invitation incorporée créée
Messagerie électronique
 data.email string

E-mail du destinataire
ID de rôle
 data.role_id string

ID de rôle du destinataire
JSON
 data.order integer

Ordre de signature du destinataire
Statut
 data.status string

État de l’invitation incorporée

Créer une invitation incorporée de groupe de documents

ID d’opération :
CreateDocGroupEmbeddedInvites

Cette action crée une invitation de signature incorporée pour un groupe de documents. Une fois l’invitation créée, générez un lien de signature incorporé

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe de documents
 id True string

ID de groupe de documents
JSON
 order True integer

Étape de l’ordre de signature. Tous les signataires affectés à une étape spécifique order (par exemple order: 1) reçoivent simultanément l’e-mail d’invitation. Les e-mails de l’étape de commande suivante (par exemple, order: 2) sont envoyés uniquement une fois que toutes les actions de l’étape précédente sont terminées
Messagerie électronique
 email True string

Adresse e-mail du destinataire
Document Id
 id True string

ID du document
Role
 role string

Rôle de destinataire dans le document. Les rôles ne doivent pas être spécifiés pour l’action « affichage »
Action
 action True string

Action requise du destinataire dans le document. Valeurs autorisées : 'sign', 'view'
JSON
 order True string

Étape de l’ordre de signature
Messagerie électronique
 email True string

Adresse e-mail du destinataire
Language
 language string

Spécifie la langue de la session de signature et des e-mails de notification pour le signataire. Valeurs possibles : En pour anglais, Es pour l’espagnol et fr pour le français. Si elle n’est pas définie, la langue est déterminée par la langue de votre compte SignNow.
Prénom
 first_name string

Prénom du destinataire
Nom de famille
 last_name string

Nom du destinataire
Nom de la signature prédéfinie requise
 required_preset_signature_name string

Texte prérempli pour le champ de signature, verrouillé pour modification par le destinataire
URI de redirection
 redirect_uri string

Lien qui s’ouvre une fois la session de signature terminée
Refuser l’URI de redirection
 decline_redirect_uri string

Lien qui s’ouvre après le refus du destinataire de signer le document
Fermer l’URI de redirection
 close_redirect_uri string

Lien qui s’ouvre lorsque le destinataire clique sur Enregistrer la progression et terminer ultérieurement pendant une session de signature ou Fermer en mode affichage
Cible de redirection
 redirect_target string

Détermine s’il faut ouvrir l’URI de redirection dans un nouvel onglet dans le navigateur ou dans le même onglet après la session de signature. Valeurs possibles : « Dans le nouvel onglet » : ouvre le lien dans un nouvel onglet, « Dans le même onglet » – ouvre le lien dans le même onglet
Type de livraison
 delivery_type string

Définit la façon dont l’invitation est envoyée
Expiration du lien
 link_expiration integer

Pendant combien de minutes l’invitation par e-mail expire. Ne peut être utilisé que si ' Delivery type=email'. Plage valide : 15 à 43200 minutes
Session Expiration
 session_expiration integer

En combien de minutes la session de signature expire. Si un lien est généré pour cette invitation, l’expiration de la session est réinitialisée. Applicable uniquement lorsque « Delivery type=email » et pour les actions « sign ». Plage valide : 15 à 1440 minutes
Type d’authentification
 authentication_type string

Type d’authentification utilisé pour l’authentification du destinataire pendant la session de signature. Valeurs autorisées : « Mot de passe », « Appel téléphonique » et « Sms »
Mot de passe d’authentification
 authentication_password string

Mot de passe défini pour l’authentification du signataire. Obligatoire pour le type d’authentification « Mot de passe »
Téléphone d’authentification
 authentication_phone string

Numéro de téléphone utilisé pour authentifier le signataire. Obligatoire pour le type d’authentification « Appel téléphonique » et « Sms ». Exemple : +1XXXXXXXXX
Sms d’authentification
 authentication_sms_message string

Sms personnalisé envoyé au signataire, contenant l’espace réservé {password}. Utilisé avec le type d’authentification « Sms ». Sans ce paramètre, le signataire reçoit un sms par défaut avec un mot de passe généré automatiquement (code de déverrouillage) : « Code de déverrouillage du document SignNow : 123456 ». Exemple : entrez le mot de passe {password} pour déverrouiller votre document
QES Signature
 signature string

Type de QES. Valeurs possibles : 'Eideasy', 'Nom151'. Utilisé pour demander des signatures QES auprès des signataires. Tous les signataires de l’invitation doivent utiliser le même type de signature. Pour créer une invitation avec QES, l’utilisateur doit appartenir à une organisation avec QES activé

Retours

Nom Chemin d’accès Type Description
ID d’invitation
 id string

ID de l’invitation incorporée créée

Déconseillé - Invite de documents avancés

ID d’opération :
SendUserDefinedInvite

L’action est déconseillée. Invitez une demande avec un schéma défini manuellement. Il permet de configurer l’invitation à un document qui sera généré à l’avenir

Paramètres

Nom Clé Obligatoire Type Description
ID document
 doc_id True string

Fournir un ID de document
Nom
 role string

Nom du rôle du signataire
Courriel
 email email

Spécifier un e-mail pour le signataire
Numéro de téléphone (Inviter via SMS)
 phone_invite string

Spécifiez le numéro de téléphone du destinataire +XXXXXXXXXXXX. Obligatoire pour l’invitation via SMS.
JSON
 order integer

Définir l’ordre de signature pour plusieurs signataires
Objet personnalisé
 subject string

Ajouter un objet personnalisé pour signer
Message personnalisé
 message string

Ajouter un message personnalisé pour signer
Type d’authentification
 authentication_type string

Vérifier l’identité de l’utilisateur via un mot de passe, un SMS ou un appel téléphonique
Mot de passe
 password string

Définir le mot de passe pour le type d’authentification Mot de passe
Téléphone
 phone string

Spécifier le numéro de téléphone +XXXXXXXXXXXX pour le type d’authentification Téléphone ou SMS
Jours jusqu’à expiration
 expiration_days integer

Recevoir une notification du signataire au cours du nombre de jours d’expiration de l’invitation
Envoyer un rappel dans
 reminder integer

Nombre de jours après l’envoi de l’invitation pour suivre automatiquement un rappel par e-mail
Envoyer un rappel tous les X Jours
 remind_repeat integer

Le destinataire reçoit un e-mail de rappel tous les jours définis.
Autoriser le transfert
 reassign boolean

Autoriser le signataire à déléguer la signature à une autre personne
Afficher le refus sur la signature
 decline_by_signature boolean

Marquer un champ de signature comme Refuser de signer si le destinataire a refusé de signer le document
CC
 cc string

E-mails séparés par des virgules qui seront copiés dans l’invitation
Sujet
 subject string

Tapez votre sujet
Message
 message string

Tapez votre message
Envoyer un e-mail à toutes les parties à la fin
 on_complete string

Toutes les parties reçoivent un e-mail de notification lorsque le document est signé

Retours

response
object

Déconseillé - Inviter à signer

ID d’opération :
SendInvite

L’action est déconseillée. Inviter d’autres personnes à remplir et signer le document

Paramètres

Nom Clé Obligatoire Type Description
Template
 template True boolean

Spécifier si des documents ou des modèles doivent être récupérés
Document
 template_id True string

Sélectionner un modèle dans la liste
body
 body True dynamic

Retours

response
object

Déconseillé - Inviter à signer le groupe de documents

ID d’opération :
SendGroupInvite

L’action est déconseillée. Inviter d’autres personnes à remplir et signer le groupe de documents

Paramètres

Nom Clé Obligatoire Type Description
Template
 template True boolean

Spécifiez si des groupes de documents ou des modèles de groupe doivent être récupérés
Groupe de documents
 template_group_id True string

Sélectionnez le groupe de documents dans la liste
body
 body True dynamic

Retours

response
object

Générer un lien d’invitation incorporé de document

ID d’opération :
GenerateEmbeddedInviteLink

Cette action génère un lien pour l’invitation incorporée au document

Paramètres

Nom Clé Obligatoire Type Description
ID document
 id True string

ID document
ID d’invitation de champ
 field_invite_id True string

ID d’invitation incorporé à partir de l’action « Créer une invitation incorporée de document »
Expiration du lien
 link_expiration integer

Spécifie le nombre de minutes pendant lesquelles le lien reste actif. Plage valide :15-45 minutes
Session Expiration
 session_expiration integer

Spécifie le nombre de minutes pendant lesquelles la session de signature reste active. Plage valide :15-1440 minutes

Retours

Nom Chemin d’accès Type Description
Lien
 data.link string

Lien d’invitation incorporé généré pour le document

Générer un lien d’invitation incorporé de groupe de documents

ID d’opération :
GenerateDocGroupEmbeddedInviteLink

Cette action génère un lien pour l’invitation incorporée du groupe de documents

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe de documents
 id True string

ID de groupe de documents
ID d’invitation incorporée du groupe de documents
 invite_id True string

ID de l’invitation incorporée du groupe de documents à partir de l’action « Créer une invitation incorporée de groupe de documents »
Messagerie électronique
 email True email

Adresse e-mail du destinataire
Expiration du lien
 link_expiration integer

Spécifie le nombre de minutes pendant lesquelles le lien reste actif. Plage valide :15-45 minutes
Session Expiration
 session_expiration integer

Spécifie le nombre de minutes pendant lesquelles la session de signature reste active. Plage valide :15-1440 minutes

Retours

Nom Chemin d’accès Type Description
Lien d’invitation incorporé
 link string

Lien pour l’invitation incorporée du groupe de documents

Inviter à signer un document

ID d’opération :
InviteToSignAllOptions

Cette action crée et envoie une invitation de champ pour qu’un document soit signé

Paramètres

Nom Clé Obligatoire Type Description
ID document
 id True string

ID document
Messagerie électronique
 email string

Adresse e-mail du destinataire
Groupe d’e-mails
 email_group string

Groupe d’utilisateurs qui doivent recevoir l’invitation. Lorsqu’un des utilisateurs signe le document, il est considéré comme terminé. Doit être utilisé avec le paramètre avancé « groupes d’e-mails ». Obligatoire si ' Email' ou 'Phone Invite' n’est pas ajouté, mais ne peut pas être utilisé en même temps avec l’un de ces paramètres
Invitation par téléphone
 phone_invite string

Numéro de téléphone du destinataire. Obligatoire pour l’invitation via SMS
Role
 role True string

Nom du rôle de destinataire. Par exemple, Signer 1, Signer 2
JSON
 order True integer

Ordre de signature. L’ordre de signature définit la séquence dans laquelle les destinataires doivent signer ou remplir un document. Une fois que tous les destinataires d’une étape de commande ont terminé la signature, le document passe à l’étape de commande suivante (par exemple, 2, 3). Plusieurs destinataires peuvent partager le même ordre de signature
Role
 role True string

Nom du rôle de destinataire, utilisé pour le mappage des paramètres avancés
Nom de la signature de remplissage préalable
 prefill_signature_name string

Texte prérempli dans le champ de signature, disponible pour modification par signataire
Nom de la signature prédéfinie requise
 required_preset_signature_name string

Texte prérempli pour le champ de signature, verrouillé pour modification par le destinataire. Impossible d’utiliser « Nom de la signature de préremplie » ou « Exiger une nouvelle signature »
Exiger une nouvelle signature
 force_new_signature boolean

Définit si le signataire peut utiliser une signature enregistrée. False : le signataire peut utiliser une signature enregistrée ; True : le signataire doit créer une signature
Autoriser le transfert
 reassign boolean

Définit si le destinataire peut transférer l’invitation à une autre adresse e-mail. 'true' : le destinataire peut transférer l’invitation ; 'false' : le destinataire ne peut pas transférer l’invitation
Autoriser le refus par signature
 decline_by_signature boolean

Définit s’il faut afficher l’option Refuser de se connecter aux champs de signature. True : afficher l’option de refus ; false : masquer l’option de refus
Envoyer un rappel en X Jours
 remind_after integer

X jours après l’invitation, un message électronique de rappel est envoyé (de 1 à 179 jours). Doit être inférieur à « Jours jusqu’à expiration »
Envoyer un rappel en X jours avant l’expiration
 remind_before integer

X jours avant l’expiration, un récepteur obtient un e-mail de rappel (de 1 à 179 jours). Doit être inférieur à « Jours jusqu’à expiration »
Envoyer un rappel tous les X jours
 remind_repeat integer

Un notification reçoit un e-mail de rappel chaque x jours après l’envoi de l’invitation (de 1 à 7 jours)
Jours jusqu’à expiration
 expiration_days integer

En X jours, l’invitation expire (de 3 à 180 jours)
Type d’authentification
 authentication_type string

Type d’authentification utilisé pour l’authentification du destinataire pendant la session de signature. Valeurs autorisées : « Mot de passe », « Appel téléphonique » et « Sms »
Mot de passe d’authentification
 password string

Mot de passe défini pour l’authentification du signataire. Obligatoire pour le type d’authentification « Mot de passe »
Téléphone d’authentification
 phone string

Numéro de téléphone utilisé pour authentifier le signataire. Obligatoire pour le type d’authentification « Appel téléphonique » et « Sms ». Exemple : +1XXXXXXXXX
Sms d’authentification
 authentication_sms_message string

Sms personnalisé envoyé au signataire, contenant l’espace réservé {password}. Utilisé avec le type d’authentification « Sms ». Sans ce paramètre, le signataire reçoit un sms par défaut avec un mot de passe généré automatiquement (code de déverrouillage) : « Code de déverrouillage du document SignNow : 123456 ». Exemple : entrez le mot de passe {password} pour déverrouiller votre document
Sujet
 subject string

Objet de messagerie personnalisé pour le destinataire
Message
 message string

Message électronique personnalisé pour le destinataire
URI de redirection
 redirect_uri string

Lorsque tous les champs demandés sont terminés et signés, le signataire est redirigé vers cet URI
Cible de redirection
 redirect_target string

Détermine s’il faut ouvrir l’URI de redirection dans un nouvel onglet dans le navigateur ou dans le même onglet après la session de signature. Valeurs possibles : « Dans le nouvel onglet » : ouvre le lien dans un nouvel onglet, « Dans le même onglet » – ouvre le lien dans le même onglet
Refuser l’URI de redirection
 decline_redirect_uri string

Lien qui s’ouvre une fois que le document a été refusé par le destinataire
Fermer l’URI de redirection
 close_redirect_uri string

Lien qui s’ouvre lorsque le destinataire clique sur Enregistrer la progression et terminer ultérieurement pendant une session de signature ou Fermer en mode affichage
Redirection terminée annulée
 is_finish_redirect_canceled boolean

Spécifie si le paramètre de redirection de saisie semi-automatique est annulé pour l’organisation. True : la redirection est annulée ; False : la redirection reste active
Fermeture de la redirection annulée
 is_close_redirect_canceled boolean

Spécifie si le paramètre de redirection de progression de l’enregistrement est annulé pour l’organisation. True : la redirection est annulée ; False : la redirection reste active
Refuser la redirection annulée
 is_decline_redirect_canceled boolean

Spécifie si le paramètre de redirection de refus est annulé pour l’organisation. True : la redirection est annulée ; False : la redirection reste active
Language
 language string

Spécifie la langue de la session de signature et des e-mails de notification pour le signataire. Valeurs possibles : En pour anglais, Es pour l’espagnol et fr pour le français. Si elle n’est pas définie, la langue est déterminée par la langue de votre compte SignNow.
Messagerie électronique
 email True string

Adresse e-mail de la visionneuse
Role
 role True string

Nom du rôle visionneuse
JSON
 order True integer

Entier : ordre d’envoi, à partir de 1
Role
 role True string

Nom du rôle de visionneuse. Utilisé pour le mappage des paramètres avancés
Sujet
 subject string

Objet de messagerie personnalisé pour la visionneuse
Message
 message string

Message électronique personnalisé pour la visionneuse
Messagerie électronique
 email True string

Adresse e-mail approbateur
Role
 role True string

Nom du rôle approbateur
JSON
 order True integer

Ordre de réception de la demande d’approbation
Role
 role True string

Nom du rôle approbateur. Utilisé pour le mappage des paramètres avancés
Jours d’expiration
 expiration_days integer

Nombre de jours avant l’expiration de l’invitation
Message
 message string

Message électronique personnalisé pour l’approbateur
Sujet
 subject string

Objet de messagerie personnalisé pour l’approbateur
Type d’authentification
 authentication_type string

Type d’authentification utilisé pour l’authentification du destinataire pendant la session de signature. Valeurs autorisées : « Mot de passe », « Appel téléphonique » et « Sms »
Mot de passe
 password string

Mot de passe défini pour l’authentification du signataire. Obligatoire pour le type d’authentification « Mot de passe »
Téléphone
 phone string

Numéro de téléphone utilisé pour authentifier le signataire. Obligatoire pour le type d’authentification « Appel téléphonique » et « Sms ». Exemple : +1XXXXXXXXX
Sms d’authentification
 authentication_sms_message string

Sms personnalisé envoyé au signataire, contenant l’espace réservé {password}. Utilisé avec le type d’authentification « Sms ». Sans ce paramètre, le signataire reçoit un sms par défaut avec un mot de passe généré automatiquement (code de déverrouillage) : « Code de déverrouillage du document SignNow : 123456 ». Exemple : entrez le mot de passe {password} pour déverrouiller votre document
URI de redirection
 redirect_uri string

URL qui s’ouvre une fois que l’approbateur approuve le document
Cible de redirection
 redirect_target string

Détermine s’il faut ouvrir l’URI de redirection dans un nouvel onglet dans le navigateur ou dans le même onglet après la session de signature. Valeurs possibles : « Dans le nouvel onglet » : ouvre le lien dans un nouvel onglet, « Dans le même onglet » – ouvre le lien dans le même onglet
De
 from string

Adresse e-mail de l’expéditeur. Seul l’e-mail associé à votre compte SignNow (e-mail de connexion) peut être utilisé. Si elle est vide, elle est définie automatiquement
ID
 id string

ID d’un groupe de messagerie. Identificateur unique de 40 caractères qui doit être créé au préalable
Nom
 name string

Nom du groupe. Utilisez-le dans le champ Groupe d’e-mails signataires >
Messagerie électronique
 email string

Adresse e-mail qui doit recevoir une invitation
Messagerie électronique
 email string

Adresse e-mail qui doit recevoir une invitation
Nom
 name string

Nom de l’étape
Messagerie électronique
 email string

Adresse e-mail du destinataire CC
Étape
 step integer

Ordre d’envoi, à partir de 1
Sujet
 subject string

Objet de l’e-mail pour tous les destinataires
Message
 message string

Message électronique pour tous les destinataires
Objet CC
 cc_subject string

Objet de messagerie CC pour tous les destinataires CC
CC Message
 cc_message string

Message électronique CC pour tous les destinataires CC
QES Signature
 signature string

Type de QES. Valeurs possibles : 'Eideasy', 'Nom151'. Utilisé pour demander des signatures QES auprès des signataires. Tous les signataires de l’invitation doivent utiliser le même type de signature. Pour créer une invitation avec QES, l’utilisateur doit appartenir à une organisation avec QES activé

Retours

Nom Chemin d’accès Type Description
Statut
 status string

Statut

Inviter à signer un groupe de documents

ID d’opération :
InviteToSignDocGroupAllOptions

Cette action crée une invitation à signer un groupe de documents. Vous pouvez configurer un flux de travail multistep, où différents destinataires agissent sur le groupe de documents à différentes étapes

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe de documents
 id True string

ID de groupe de documents
JSON
 order True integer

Ordre de signature : 1 - le ou les destinataires signent d’abord le groupe de documents, puis le groupe de documents est envoyé à 2,3, etc. Plusieurs destinataires peuvent contenir le même ordre de signature
Messagerie électronique
 email string

Adresse e-mail du destinataire
Groupe d’e-mails
 email_group string

Un groupe de contacts de destinataires
Nom du rôle
 role_name True string

Nom du rôle de destinataire dans le document (peut être utilisé pour identifier les champs du document affecté à ce destinataire particulier)
Action
 action True string

Action autorisée avec un document. Valeurs possibles : Afficher, Signer, Approuver
ID document
 document_id True string

ID du document sur lequel les actions sont requises à partir de ce destinataire
Nom de la signature prédéfinie requise
 required_preset_signature_name string

Texte prérempli pour le champ de signature, verrouillé pour modification par le destinataire
Autoriser le transfert
 allow_reassign boolean

Définit si le destinataire peut transférer l’invitation à une autre adresse e-mail. 'true' : le destinataire peut transférer l’invitation ; 'false' : le destinataire ne peut pas transférer l’invitation
Autoriser le refus par signature
 decline_by_signature boolean

Définit s’il faut afficher l’option Refuser de se connecter aux champs de signature. True : afficher l’option refuser ; False : masquer l’option de refus
Type d’authentification
 type string

Type d’authentification utilisé pour l’authentification du destinataire pendant la session de signature. Valeurs autorisées : « Mot de passe », « Appel téléphonique » et « Sms »
Mot de passe
 value string

Mot de passe défini pour l’authentification du signataire. Obligatoire pour le type d’authentification « Mot de passe »
Téléphone
 phone string

Numéro de téléphone utilisé pour authentifier le signataire. Obligatoire pour le type d’authentification « Appel téléphonique » et « Sms ». Exemple : +1XXXXXXXXX
Message
 message string

Sms personnalisé envoyé au signataire, contenant l’espace réservé {password}. Utilisé avec le type d’authentification « Sms ». Sans ce paramètre, le signataire reçoit un sms par défaut avec un mot de passe généré automatiquement (code de déverrouillage) : « Code de déverrouillage du document SignNow : 123456 »
MerchantId
 merchant_id string

ID du compte marchand ajouté à votre organisation
Monnaie
 currency string

Devise de paiement demandée
Montant
 amount string

Montant du paiement demandé
Uri
 redirect_uri string

Lorsque tous les champs demandés sont terminés et signés, le signataire est redirigé vers cet URI
Cible de redirection
 redirect_target string

Détermine s’il faut ouvrir l’URI de redirection dans un nouvel onglet dans le navigateur ou dans le même onglet après la session de signature. Valeurs possibles : « Dans le nouvel onglet » : ouvre le lien dans un nouvel onglet, « Dans le même onglet » – ouvre le lien dans le même onglet
Refuser l’URI de redirection
 decline_redirect_uri string

Lien qui s’ouvre une fois que le document a été refusé par le destinataire
Fermer l’URI de redirection
 close_redirect_uri string

Lien qui s’ouvre lorsqu’un signataire clique sur Enregistrer la progression et terminer ultérieurement pendant une session de signature ou Fermer en mode affichage
Redirection terminée annulée
 is_finish_redirect_canceled boolean

Spécifie si le paramètre de redirection de saisie semi-automatique est annulé pour l’organisation. True : la redirection est annulée ; False : la redirection reste active
Fermeture de la redirection annulée
 is_close_redirect_canceled boolean

Spécifie si le paramètre de redirection de progression de l’enregistrement est annulé pour l’organisation. True : la redirection est annulée ; False : la redirection reste active
Refuser la redirection annulée
 is_decline_redirect_canceled boolean

Spécifie si le paramètre de redirection de refus est annulé pour l’organisation. True : la redirection est annulée ; False : la redirection reste active
Language
 language string

Spécifie la langue de la session de signature et des e-mails de notification pour le signataire. Valeurs possibles : En pour anglais, Es pour l’espagnol et fr pour le français. Si elle n’est pas définie, la langue est déterminée par la langue de votre compte SignNow.
JSON
 order True integer

Ordre de signature : 1 - le ou les destinataires signent d’abord le groupe de documents, puis le groupe de documents est envoyé à 2,3, etc. Plusieurs destinataires peuvent contenir le même ordre de signature
Messagerie électronique
 email True string

Adresse e-mail du destinataire
Groupe d’e-mails
 email_group string

Un groupe de contacts de destinataires
Sujet
 subject string

Objet de messagerie personnalisé pour le destinataire
Message
 message string

Message électronique personnalisé pour le destinataire
Jours jusqu’à expiration
 expiration_days integer

En x jours, l’invitation expire (de 3 à 180 jours)
Envoyer un rappel en X Jours
 remind_after integer

X jours après l’invitation, un message électronique de rappel est envoyé (de 1 à 179 jours). Doit être inférieur aux jours d’expiration
Envoyer un rappel en X jours avant l’expiration
 remind_before integer

X jours avant l’expiration, un récepteur obtient un e-mail de rappel (de 1 à 179 jours). Doit être inférieur aux jours d’expiration
Envoyer un rappel tous les X Jours
 remind_repeat integer

Un notification reçoit un e-mail de rappel chaque x jours après l’envoi de l’invitation (de 1 à 7 jours)
Id
 id string

ID d’un groupe de messagerie. Identificateur unique de 40 caractères qui doit être créé au préalable
Nom
 name string

Nom du groupe. Utilisez-le dans le groupe d’e-mails « Inviter des étapes > »
Messagerie électronique
 email string

Adresse e-mail qui doit recevoir une invitation
Messagerie électronique
 email string

Adresse e-mail du destinataire qui recevra l’e-mail d’achèvement
Désactiver la pièce jointe du document
 disable_document_attachment boolean

Indique s’il faut désactiver l’envoi de pièces jointes avec l’e-mail de saisie semi-automatique. Valeurs possibles : False - Activer la pièce jointe du document, True - désactiver la pièce jointe du document
Sujet
 subject string

Objet personnalisé de l’e-mail d’achèvement
Message
 message string

Message personnalisé pour l’e-mail de saisie semi-automatique
Se connecter en tant que fusionné
 sign_as_merged boolean

Si la valeur est true, permet à l’utilisateur d’API d’envoyer une invitation qui s’ouvre en tant que groupe de documents fusionnés dans un seul document
Horodatage du client
 client_timestamp integer

Horodatage de l’invitation du groupe de documents
Messagerie électronique
 email string

Adresse e-mail qui doit recevoir une invitation
QES Signature
 signature string

Type de QES. Valeurs possibles : 'Eideasy', 'Nom151'. Utilisé pour demander des signatures QES auprès des signataires. Tous les signataires de l’invitation doivent utiliser le même type de signature. Pour créer une invitation avec QES, l’utilisateur doit appartenir à une organisation avec QES activé

Retours

Nom Chemin d’accès Type Description
Id
 id string

ID d’invitation de groupe de documents
Lien d’invitation en attente
 pending_invite_link string

Lien d’invitation en attente

Obtenir des champs de document

ID d’opération :
GetDocFields_V2

Récupérer des valeurs des champs pouvant être renseignés dans le document

Paramètres

Nom Clé Obligatoire Type Description
Template
 template_id True string

Spécifier un modèle de document à partir duquel obtenir des champs
ID document
 doc_id True string

Spécifier un ID de document unique

Retours

Les sorties de cette opération sont dynamiques.

Obtenir des champs de document [DÉCONSEILLÉ]

ID d’opération :
GetDocFields

Cette action a été déconseillée. Utilisez plutôt Obtenir des champs de document .

Obtenir des valeurs de champ de document.

Paramètres

Nom Clé Obligatoire Type Description
Template
 template_id True string

Spécifier un modèle de document à partir duquel obtenir des champs
ID document
 doc_id True string

Spécifier un ID de document unique

Retours

Les sorties de cette opération sont dynamiques.

Obtenir des groupes de documents

ID d’opération :
GetListDocGroups

Récupérer une liste des groupes de documents de l’utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Template
 template True boolean

Spécifiez si des groupes de documents ou des modèles de groupe doivent être récupérés
Limit
 limit integer

Nombre total d’éléments retournés (entre 1 et 50)
Décalage
 offset integer

Décalage (de base zéro) du premier élément de la collection à retourner

Retours

Corps
DocumentGroupsResponse

Obtenir des informations sur le document

ID d’opération :
GetDoc

Obtenez des propriétés de document telles que le nom, l’ID, les dates de création/mise à jour, etc.

Paramètres

Nom Clé Obligatoire Type Description
Template
 template True boolean

Spécifier si des documents ou des modèles doivent être récupérés
ID document
 doc_id True string

Spécifier un ID de document unique ou sélectionner un document dans la liste

Retours

Corps
DocumentProperties

Obtenir la liste des documents

ID d’opération :
GetListDoc

Récupérer une liste des documents de l’utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Template
 template boolean

Spécifier si des documents ou des modèles doivent être récupérés
Inclure un modèle par défaut
 includeDefaultTemplate boolean

Spécifier si le modèle par défaut doit être ajouté à la liste des modèles

Retours

response
array of DocumentProperties

Obtenir le groupe de documents

ID d’opération :
GetDocumentGroup

Récupérer une liste des groupes de documents de l’utilisateur

Paramètres

Nom Clé Obligatoire Type Description
Modèle de groupe
 doc_group_id True string

Sélectionnez le modèle de groupe dans la liste
Template
 template True boolean

Spécifiez si un groupe de documents ou un modèle de groupe doit être récupéré

Retours

Corps
DocumentGroupProperties

Obtenir le schéma de document [DÉCONSEILLÉ]

ID d’opération :
GetDocSchema

Cette action a été déconseillée. Utilisez plutôt Obtenir le schéma de document .

Obtenir le schéma de document OpenAPI

Paramètres

Nom Clé Obligatoire Type Description
ID document
 doc_id string

Spécifier un ID de document unique
Filtre de type de champ
 select string

Séparez-vous d’une virgule avec les types de champs que vous souhaitez récupérer

Retours

Nom Chemin d’accès Type Description
Propriétés
 properties object

Obtenir l’état de l’invitation de document

ID d’opération :
GetInviteStatus

Cette action récupère des informations sur une invitation de document, y compris l’état de chaque étape et action.

Paramètres

Nom Clé Obligatoire Type Description
ID document
 id True string

ID document

Retours

Nom Chemin d’accès Type Description
Document refusé
 is_document_declined boolean

True si le document a été refusé par le signataire ou l’approbateur, sinon false
steps
 steps array of object

Étapes
Ordre de signature
 steps.signing_order integer

Ordre de signature
E-mail du destinataire
 steps.signer_email string

Adresse e-mail du destinataire
Nom du rôle
 steps.role_name string

Nom du rôle de destinataire
Type d'action
 steps.action_type string

Action requise du destinataire dans le document. Valeurs possibles : « Sign », « View », « Approve » ou « FreeFormSign »
ID d’invitation
 steps.invite_id string

ID d’invitation
Statut
 steps.status string

État de signature. Valeurs possibles : « créé », « en attente », « rempli », « annulé », « ignoré »
Declined
 steps.declined boolean

Retourne « true » si le destinataire de cette étape a refusé le document
Refuser la raison
 steps.decline_reason string

Message fourni par le destinataire lors du refus du document
Créé
 steps.created integer

Date de création de l’étape
Updated
 steps.updated integer

Date de la dernière mise à jour de l’état de l’étape

Obtenir l’état de l’invitation de groupe de documents

ID d’opération :
GetDocumentGroupInviteStatus

Cette action récupère des informations sur une invitation de groupe de documents, y compris l’état de chaque étape et action.

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe de documents
 id True string

ID de groupe de documents

Retours

Nom Chemin d’accès Type Description
ID d’invitation de groupe de documents
 document_group_invite_id string

ID d’invitation du groupe de documents
État du groupe de documents
 status string

État de signature du groupe de documents. Valeurs possibles : 'created', 'pending', 'fulfilled', 'canceled'
Adresse e-mail du propriétaire
 owner_email string

Adresse e-mail du propriétaire du groupe de documents
Groupe de documents refusé
 is_document_declined boolean

Retourne « true » si un document du groupe est refusé par un signataire ou un approbateur ; sinon, retourne 'false'
steps
 steps array of object

Étapes
ID d’étape
 steps.step_id string

ID d’étape de l’invitation du groupe de documents
Ordre de signature
 steps.signing_order integer

Ordre de signature
Document Id
 steps.document_id string

ID de document
Nom du document
 steps.document_name string

Nom du document
E-mail du signataire
 steps.signer_email string

Adresse e-mail du destinataire
Nom du rôle
 steps.role_name string

Nom du rôle de destinataire
Type d'action
 steps.action_type string

Action requise du destinataire dans le document. Valeurs possibles : « Sign », « View », « Approve » ou « FreeFormSign »
ID d’invite d’étape
 steps.invite_id string

ID de l’étape d’invitation
Statut
 steps.status string

État de signature de l’étape
Declined
 steps.declined boolean

True si le destinataire de cette étape a refusé le document
Refuser la raison
 steps.decline_reason string

Message fourni par le destinataire lors du refus du document
Créé
 steps.created integer

Date de création de l’étape
Updated
 steps.updated integer

Date de la dernière mise à jour de l’état de l’étape

Préremplir les valeurs des champs de document

ID d’opération :
UpdateFieldValues_V2

Remplir automatiquement des champs renseignés dans le document avec des valeurs spécifiques

Paramètres

Nom Clé Obligatoire Type Description
Template
 template_id True string

Spécifier un modèle de document à partir duquel obtenir des champs
ID document
 doc_id True string

Spécifier un ID de document unique
fields
 fields dynamic

Retours

Nom Chemin d’accès Type Description
ID document
 id DocumentId

Unique document ID

Préremplir les valeurs des champs de document [DÉPRÉCIÉ]

ID d’opération :
UpdateFieldValues

Cette action a été déconseillée. Utilisez à la place les valeurs de champ de document préremplies .

Préremplir les valeurs et les propriétés des champs.

Paramètres

Nom Clé Obligatoire Type Description
Template
 template_id True string

Spécifier un modèle de document à partir duquel obtenir des champs
ID document
 doc_id True string

Spécifier un ID de document unique
fields
 fields dynamic

Retours

Nom Chemin d’accès Type Description
ID document
 id DocumentId

Unique document ID

Préremplir les valeurs des champs de groupe de documents

ID d’opération :
UpdateGroupFieldValues

Remplir automatiquement des champs renseignés dans les documents avec des valeurs spécifiques

Paramètres

Nom Clé Obligatoire Type Description
Template
 template_group_id True string

Spécifier un modèle de groupe de documents à partir duquel obtenir des champs
ID de groupe de documents
 doc_group_id True string

Spécifier un ID de groupe de documents unique
fields
 fields dynamic

Retours

Nom Chemin d’accès Type Description
ID de groupe de documents
 id DocumentGroupId

ID de groupe de documents unique

Remplacer les destinataires dans l’invitation de document

ID d’opération :
ReplaceRecipientsInDocumentInvite

Cette action remplace les destinataires dans l’invitation de document en fonction de leurs rôles. Il autorise également la mise à jour des paramètres d’invitation tels que le type d’authentification, les jours d’expiration et d’autres paramètres avancés pour chaque rôle

Paramètres

Nom Clé Obligatoire Type Description
ID document
 id True string

ID document
Role
 role True string

Nom du rôle du destinataire à remplacer
Nouvel e-mail
 email True string

Nouvel e-mail de destinataire
Role
 role True string

Nom du rôle qui nécessite des paramètres d’invitation supplémentaires
Jours d’expiration
 expiration_days integer

Dans le nombre de jours d’expiration de l’invitation. 30 jours maximum
Autoriser le refus par signature
 decline_by_signature boolean

Définit s’il faut afficher l’option Refuser de se connecter aux champs de signature. True : afficher l’option refuser ; False : masquer l’option de refus
Rappel
 reminder integer

En combien de jours envoyer un rappel au destinataire. 30 jours maximum
Type d’authentification
 authentication_type string

Type d’authentification utilisé pour l’authentification du destinataire pendant la session de signature. Valeurs autorisées : « Mot de passe », « Appel téléphonique » et « Sms »
Mot de passe d’authentification
 authentication_password string

Mot de passe défini pour l’authentification du signataire. Obligatoire pour le type d’authentification « Mot de passe »
Téléphone d’authentification
 authentication_phone string

Numéro de téléphone utilisé pour authentifier le signataire. Obligatoire pour le type d’authentification « Appel téléphonique » et « Sms ». Exemple : +1XXXXXXXXX
Sms d’authentification
 authentication_sms_message string

Sms personnalisé envoyé au signataire, contenant l’espace réservé {password}. Utilisé avec le type d’authentification « Sms ». Sans ce paramètre, le signataire reçoit un sms par défaut avec un mot de passe généré automatiquement (code de déverrouillage) : « Code de déverrouillage du document SignNow : 123456 ». Exemple : entrez le mot de passe {password} pour déverrouiller votre document

Retours

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

Détails des nouveaux destinataires
Nouvel ID d’invitation
 replacements.new_invite_id string

NOUVEL ID d’invitation de champ
Role
 replacements.role string

Nom du rôle du destinataire qui a été remplacé
Nouvel e-mail
 replacements.new_email string

Nouvel e-mail de destinataire

Remplacer les destinataires dans l’invitation de groupe de documents

ID d’opération :
ReplaceRecipientsInDocumentGroupInvite

Cette action remplace les destinataires d’un groupe de documents par son ID d’invitation. Vous pouvez également définir une expiration d’invitation, des rappels, réaffecter des autorisations et refuser des options pour chaque document

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe de documents
 id True string

ID de groupe de documents
ID d’invitation
 invite_id True string

ID d’invitation de groupe de documents
ID d’étape
 step_id string

ID de l’étape d’invitation à partir de l’invitation du groupe de documents
Destinataire à remplacer
 recipient_to_update string

E-mail du destinataire à remplacer
Nouveau destinataire
 new_recipient string

E-mail du nouveau destinataire
Jours d’expiration
 expiration_days integer

En combien de jours l’invitation expire ; 30 jours maximum
Rappel
 reminder integer

Pendant combien de jours envoyer un rappel au signataire ; 30 jours maximum
ID document
 document_id True string

ID de document à partir du groupe de documents
Autoriser le transfert
 allow_forwarding boolean

Indique s’il faut autoriser ou non les destinataires à réaffecter cette invitation à une autre adresse e-mail. Valeurs possibles : False - non autorisé. True : autorisé.
Autoriser le refus par signature
 decline_by_signature boolean

Définit s’il faut afficher l’option Refuser de se connecter aux champs de signature. True : afficher l’option refuser ; False : masquer l’option de refus

Retours

Nom Chemin d’accès Type Description
Statut
 status string

État du remplacement des destinataires

Supprimer l’invitation incorporée au document

ID d’opération :
DeleteEmbeddedInvites

Cette action supprime une invitation incorporée pour un document

Paramètres

Nom Clé Obligatoire Type Description
ID document
 id True string

ID document

Supprimer l’invitation incorporée du groupe de documents

ID d’opération :
DeleteDocGroupEmbeddedInvites

Cette action supprime une invitation incorporée pour un groupe de documents spécifique

Paramètres

Nom Clé Obligatoire Type Description
ID de groupe de documents
 id True string

ID de groupe de documents

Supprimer un document

ID d’opération :
DeleteDoc

Supprimer un document de SignNow

Paramètres

Nom Clé Obligatoire Type Description
ID document
 doc_id True string

Spécifier un ID de document unique

Retours

Nom Chemin d’accès Type Description
Statut
 status string

État de suppression de document

Télécharger le document

ID d’opération :
DownloadDocument

Télécharger un document à partir de SignNow

Paramètres

Nom Clé Obligatoire Type Description
ID document
 doc_id True string

Spécifier un ID de document unique ou sélectionner un document dans la liste
Format
 mode string

Sélectionner un format de document pour le téléchargement

Retours

response
binary

Valeurs de champ intelligent du groupe de documents préremplies

ID d’opération :
UpdateGroupSmartFieldValues

Remplir automatiquement les champs intelligents dans les documents avec des valeurs spécifiques

Paramètres

Nom Clé Obligatoire Type Description
Template
 template_group_id True string

Spécifier un modèle de groupe de documents à partir duquel obtenir des champs
ID de groupe de documents
 doc_group_id True string

Spécifier un ID de groupe de documents unique
fields
 fields dynamic

Retours

Nom Chemin d’accès Type Description
ID de groupe de documents
 id DocumentGroupId

ID de groupe de documents unique

Valeurs de champ intelligent préremplies

ID d’opération :
PrefillSmartFields

Préremplir les valeurs de champ intelligent pour le document spécifié

Paramètres

Nom Clé Obligatoire Type Description
Template
 template_id True string

Spécifier un modèle de document à partir duquel obtenir des champs
ID document
 doc_id True string

Spécifier un ID de document unique
fields
 fields dynamic

Déclencheurs

Démarrer le flux sur l’événement de document

Sélectionnez l’événement à déclencher : l’invitation de signature nouvelle ou mise à jour ; lorsqu’une personne crée, met à jour, termine ou supprime un document
Flux de démarrage sur l’événement de document [DEPRECATED]

Cette action a été déconseillée. Utilisez plutôt le flux de démarrage sur l’événement de document .

Vous pouvez créer un déclencheur pour l’un de ces événements : création de document, mise à jour de document, suppression de document, fin du document, invitation à créer, invitez la mise à jour

Démarrer le flux sur l’événement de document

ID d’opération :
Triggers_V2

Sélectionnez l’événement à déclencher : l’invitation de signature nouvelle ou mise à jour ; lorsqu’une personne crée, met à jour, termine ou supprime un document

Paramètres

Nom Clé Obligatoire Type Description
Événement
 event True string

Sélectionner l’événement qui doit déclencher le flux

Retours

Nom Chemin d’accès Type Description
Événement
 meta.event string

Événement de document qui a provoqué le déclencheur.
ID document
 content.document_id string

ID unique du document cible qui a provoqué l’événement.
Nom du document
 content.document_name string

Nom du fichier de document cible sans extension

Flux de démarrage sur l’événement de document [DEPRECATED]

ID d’opération :
Triggers

Cette action a été déconseillée. Utilisez plutôt le flux de démarrage sur l’événement de document .

Vous pouvez créer un déclencheur pour l’un de ces événements : création de document, mise à jour de document, suppression de document, fin du document, invitation à créer, invitez la mise à jour

Paramètres

Nom Clé Obligatoire Type Description
Événement
 event True string

Sélectionnez l’événement qui doit déclencher le flux.

Retours

Nom Chemin d’accès Type Description
Timestamp
 meta.timestamp integer

Date et heure à laquelle l’événement s’est produit (format d’horodatage Unix).
Événement
 meta.event string

Événement de document qui a provoqué le déclencheur.
ID document
 content.document_id string

ID unique du document cible qui a provoqué l’événement.
Nom du document
 content.document_name string

Nom du fichier de document cible sans extension

Définitions

DocumentProperties

Nom Chemin d’accès Type Description
ID document
 id DocumentId

Unique document ID
Nom du document
 document_name string

Nom de fichier de document sans extension
Nombre de pages
 page_count integer

Nombre de pages dans le document
Créé
 created integer

Date et heure de création du document au format Timestamp Unix
Updated
 updated integer

Date et heure de mise à jour du document au format Timestamp Unix
Nom du modèle
 original_filename string

Nom de fichier de modèle avec extension (le cas échéant)
ID de modèle
 origin_document_id string

ID de document de modèle (le cas échéant)
Modèle
 template boolean

true si le document est un modèle.
État du document
 status string

État du document

DocumentGroupsResponse

Nom Chemin d’accès Type Description
document_groups
 document_groups array of DocumentGroupProperties
Nombre total de groupes de documents
 document_group_total_count integer

Nombre total de groupes de documents dans le compte SignNow

DocumentGroupProperties

Nom Chemin d’accès Type Description
ID de groupe de documents
 group_id DocumentGroupId

ID de groupe de documents unique
Nom du groupe de documents
 group_name string

Nom du groupe de documents
Documents
 documents array of DocumentGroupDocumentProperties

Documents

DocumentGroupDocumentProperties

Nom Chemin d’accès Type Description
ID document
 id DocumentId

Unique document ID
Nom du document
 document_name string

Nom de fichier de document sans extension
ID de modèle
 origin_document_id string

ID de document de modèle (le cas échéant)

CreateDocumentGroupFromFilesResponse

Nom Chemin d’accès Type Description
Nom du groupe de documents
 group_name string

Nom du groupe de documents
ID du groupe de documents
 group_id string

ID de groupe de documents
documents
 documents array of object
ID document
 documents.id DocumentId

Unique document ID
Nom du document
 documents.name string

Nom du document

DocumentId

Unique document ID

Unique document ID

ID document
string

DocumentGroupId

ID de groupe de documents unique

ID de groupe de documents unique

ID de groupe de documents
string

objet

Il s’agit du type "objet".

binaire

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