signe sproof (préversion)

Utilisez sproof Sign pour automatiser des flux de travail de signature électronique sécurisés pour les documents PDF et DOCX. Les organisations peuvent créer des demandes de signature uniques ou à plusieurs documents, attribuer des destinataires et des rôles de signature, suivre l’état, télécharger les fichiers PDF terminés et supprimer des documents. Un compte de signe résistant, un plan qui prend en charge les actions sélectionnées et les types de signature, et un jeton d’API valide est requis.

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

Service Classe Regions
Copilot Studio Premium Toutes les régions Power Automate à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Standard Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Prise en charge des API
URL https://sproof.com
Courrier électronique support@sproof.com
Métadonnées du connecteur
Éditeur sproof GmbH
Website https://www.sproof.com/en/sign/
Politique de confidentialité https://www.sproof.com/en/privacy-policy-app/
Categories Productivité; Contenu et fichiers

signe sproof

Aperçu

sproof Sign permet aux organisations d’automatiser les flux de travail de signature électronique pour les documents PDF et DOCX. Le connecteur peut créer des demandes de signature à document unique ou des enveloppes à plusieurs documents, attribuer des destinataires et des rôles de signature, récupérer l’état de la demande, télécharger des documents terminés et supprimer des documents.

Prerequisites

Pour utiliser le connecteur, vous avez besoin des éléments suivants :

  • Un compte de signe résistant.
  • Plan de signature résistant avec accès à l’API et prise en charge des actions et types de signature requis.
  • Jeton d’API signable valide.

Authentication

Le connecteur utilise l’authentification par jeton d’API. Créez une connexion en entrant un jeton d’API Sign valide associé à votre compte. Conservez le jeton sécurisé et remplacez-le s’il est révoqué ou régénéré.

Actions prises en charge

  • Créer une demande de signature : crée une demande pour un document ou une enveloppe contenant plusieurs documents. Les destinataires, les rôles de signature, l’ordre de signature, les positions de signature et d’autres paramètres d’invitation peuvent être configurés.
  • Créer une demande de signature à l’aide d’espaces réservés : crée une demande à l’aide d’espaces réservés stockés dans un document chargé. Les informations sur les destinataires et les positions de signature sont extraites de ces espaces réservés.
  • Obtenir l’état de la demande : récupère l’état actuel et l’état de signature d’une demande de signature à l’aide de son ID membre.
  • Obtenir un document : télécharge un document au format PDF binaire ou au format PDF codé en base64.
  • Supprimer le document : supprime un document ou supprime l’accès d’un membre, selon l’ID de membre fourni, le rôle du membre et si le document appartient à une enveloppe.

Limitations et exigences connues

  • Les documents d’entrée doivent être fournis en tant que contenu PDF ou DOCX codé en base64.
  • Une enveloppe peut contenir au maximum 25 documents.
  • Un nom d’enveloppe est requis lorsque plusieurs documents sont envoyés.
  • Les requêtes basées sur des espaces réservés nécessitent des espaces réservés correctement mis en forme dans le document chargé.
  • Pour les demandes basées sur des espaces réservés, les destinataires et les positions de signature sont obtenus à partir du document plutôt que entrés manuellement.
  • Les actions disponibles, les types de signature et les fournisseurs dépendent du compte et du plan de signature connectés.
  • Le comportement de suppression de document dépend du fait que l’ID de membre fourni appartient à l’expéditeur ou à un destinataire et si le document fait partie d’une enveloppe.

Support

Pour la prise en charge du connecteur ou de l’API, contactez support@sproof.com.

Création d’une connexion

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

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

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

Nom Catégorie Description Obligatoire
token Securestring « token » für diese API True

Actions

Créer une demande de signature

Il s’agit de la nouvelle demande de signature de création. En plus de créer une invitation à un seul document, il prend désormais en charge la création d’enveloppes et le chargement de plusieurs documents à la fois lors de l’envoi d’invitations.
Créer une demande de signature à l’aide d’espaces réservés

Crée une demande de signature à l’aide d’espaces réservés stockés dans le document chargé. Les destinataires et les positions de signature sont extraits du document.
Obtenir l’état de la demande

Obtenez l’état d’une demande de signature. Retourne un objet JSON de document ou une erreur. Le paramètre est retourné par la demande de publication sur le document et est associé à l’e-mail des expéditeurs.
Obtenir un document

Obtenir un document signé sous forme de chaîne encodée en base64 ou binaire.
Supprimer un document

Supprime un document ou supprime l’accès d’un membre, selon que le document fourni memberId appartient à l’expéditeur ou à un destinataire, et si le document fait partie d’une enveloppe.

Documents dans une enveloppe

Le paramètre all de requête n’a aucun effet pour les documents d’une enveloppe.

Avec l’expéditeur memberId:

  • Un seul document est supprimé pour l’expéditeur et tous les destinataires.
  • Le document est supprimé de l’enveloppe.

Avec le destinataire memberId:

  • Tous les documents de l’enveloppe sont supprimés pour le destinataire.
  • Le destinataire est marqué comme declined sur tous les documents qui ont été supprimés pour le destinataire.
  • Les documents restent disponibles pour tous les autres membres du document.

Documents uniques

Avec l’expéditeur memberId et all=true:

  • Le document est supprimé pour l’expéditeur et tous les destinataires.

Avec l’expéditeur memberId et all=false:

  • Le document est supprimé uniquement pour l’expéditeur.
  • Le document reste disponible pour les autres destinataires du document.

Avec le destinataire memberId:

  • Le destinataire est marqué comme declined sur le document.
  • Le document reste disponible pour tous les autres membres du document.

Créer une demande de signature

ID d’opération :
CreateSignatureRequest

Il s’agit de la nouvelle demande de signature de création. En plus de créer une invitation à un seul document, il prend désormais en charge la création d’enveloppes et le chargement de plusieurs documents à la fois lors de l’envoi d’invitations.

Paramètres

Nom Clé Obligatoire Type Description
email
 email True string

E-mail de l’expéditeur. Il doit appartenir à un membre de votre plan.
firstName
 firstName True string

Prénom de l’expéditeur.
lastName
 lastName string

Nom de l’expéditeur.
role
 role string

Rôle de l’expéditeur sur tous les documents.
email
 email string

E-mail du destinataire.
firstName
 firstName string

Prénom du destinataire.
lastName
 lastName string

Nom du destinataire.
doNotSendEmails
 doNotSendEmails boolean

S’il n’est pas défini sur true aucun e-mail envoyé au destinataire.
customId
 customId string

Pour être utilisé uniquement lorsque l’adresse e-mail du destinataire est inconnue au moment de l’invitation. Cela fonctionne uniquement lorsque vous invitez les destinataires (pas pour préparer des itinéraires) et que vous souhaitez utiliser fastlane. Vous customId pouvez prégéner un lien de signature unique pour un destinataire avant d’envoyer une invitation. Doit être une chaîne alphanumérique unique d’au moins 70 caractères.

Remarque : Le customId ne peut être utilisé que pour générer le lien du destinataire vers un document. Elle ne peut pas être utilisée pour d’autres requêtes au lieu du memberId. Pour plus d’informations sur la construction d’URL, consultez Ouverture d’un document avec un ID personnalisé
useFastlane
 useFastlane boolean

S’il est défini sur true le signataire reçoit un lien Fastlane dans l’e-mail d’invitation.
numéro de téléphone
 phoneNumber string

Numéro de téléphone de ce destinataire. Cela est utilisé pour la vérification SMS. (par exemple : +43 699 1234 1234).
privateMessage
 privateMessage string

Message privé pour ce destinataire spécifique.
inPersonMode
 inPersonMode boolean

Lorsque cette option est activée, le destinataire de la demande de signature doit signer le document en personne et aucun e-mail n’est envoyé. Ce mode est disponible uniquement à l’aide du type de signature SES
signatureTypes
 signatureTypes array of string

Types de signatures autorisées pour ce destinataire. Options : ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag
 tag string

Cette balise détermine le fournisseur d’identité qui sera utilisé pour le processus de signature. Choisissez parmi un ensemble prédéfini de fournisseurs pris en charge.

Remarque1 : Certains fournisseurs ne sont disponibles que pour certains signatureTypes, par exemple onetimeqes nécessiteront "signatureType" : ["qualifiedPlusIdent"]

Remarque2 : Lorsque vous utilisez sproof-qualified en tant que fournisseur par défaut, le destinataire doit disposer d’un compte sproof actif avec une licence User+ active.
canChange
 canChange boolean

Boolean pour indiquer si le destinataire invité doit être en mesure de modifier le fournisseur de signature
country
 country string

Le pays par défaut, s’il est vide, est défini sur tous, une erreur est retournée avec les pays disponibles pour la balise fournisseur choisie
dueDate
 dueDate YYYY-MM-DD

Date jusqu’à laquelle le document peut être signé. Cette date d’échéance s’affiche au destinataire dans l’e-mail d’invitation et est également visible dans la section détails du document du tableau de bord. Il sert d’échéance pour terminer le processus de signature.
reminderInterval
 reminderInterval number

Spécifie le nombre de jours entre les e-mails de rappel.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Date à partir de laquelle les rappels doivent être envoyés
inviteLanguage
 inviteLanguage string

Spécifie la langue des e-mails envoyés aux utilisateurs anonymes qui n’ont pas de compte. Pour les utilisateurs disposant d’un compte, la langue sélectionnée dans leur profil sera utilisée à la place.
message
 message string

Message personnalisé envoyé aux destinataires dans l’e-mail.
subject
 subject string

Ligne d’objet de l’e-mail envoyée aux destinataires.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

Si la valeur est true, le fichier pdf est envoyé sous forme de pièce jointe à tous les destinataires du document (s’il est inférieur à 5 Mo).
focusSigningMode
 focusedSigningMode boolean

Lorsque cette option est activée, le destinataire de la demande de signature sera limité à la signature ou à la baisse du document et ne pourra pas naviguer loin de la page.
allowForwarding
 allowForwarding boolean

Autoriser le transfert de l’invitation.
collabSigningMode
 collabSigningMode object

Objet où chaque clé représente un round de signature et sa valeur correspondante indique si la signature collaborative est activée pour ce tour. Si la valeur est true, une seule signature est requise pour terminer l’arrondi de signature spécifié et passer à la prochaine ronde. Par exemple, { '1' : true } signifie que dans la signature ronde '1', une seule signature est nécessaire.
usePlaceholders
 usePlaceholders boolean

Si la valeur est true, les espaces réservés de texte/formFields stockés dans le document seront utilisés pour inviter des destinataires.
inPersonSigning
 inPersonSigning boolean

Lorsque la valeur est true, le destinataire obtient une fenêtre contextuelle dans laquelle il doit dessiner manuellement une signature
folderName
 folderName string

Si elle est donnée, une enveloppe est créée contenant tous les documents dans documentDataArray. (Obligatoire si plusieurs documents sont envoyés)
callbackUrl
 callbackUrl string

Une requête POST, y compris le document, est envoyée à cette URL lorsqu’une nouvelle signature est créée ou lorsqu’un destinataire refuse le document. En cas de défaillance, un mécanisme de nouvelle tentative est en place pour s’assurer que la demande est retentée.
returnUrl
 returnUrl string

Lien du bouton de retour après la signature d’un document
returnBtnText
 returnBtnText string

Texte du bouton de retour après la signature d’un document
Données
 data True string

Données de document (PDF ou DOCX) au format base64.
mimetype
 mimetype string

Type MIME de données encodées en base64 PDF ou DOCX, obligatoire si le document n’est pas un pdf
fileName
 fileName True string

Nom du fichier
label
 label string

Étiquette personnalisée qui peut être envoyée pour organiser les documents.
page
 page True integer

Numéro de la page sur laquelle se trouve la zone, la première page étant 0.
pageWidth
 pageWidth integer

Toute valeur entière décrivant la largeur de la page. Plus le nombre est élevé, plus la précision est élevée lors du positionnement de la boîte dans l’espace x y. Sur une page A4, nous avons 478 comme valeur par défaut.
pageHeight
 pageHeight integer

Toute valeur entière décrivant la hauteur de la page. Plus le nombre est élevé, plus la précision est élevée lors du positionnement de la boîte dans l’espace x y. Sur une page A4, nous avons 676 comme valeur par défaut.
x
 x True float

Représente la position horizontale de la zone sous la forme d’un pourcentage de la largeur de la page. L’origine (0,0) se trouve en haut à gauche de la page. La valeur 0,1 signifie que la boîte est positionnée à 10% de la largeur de page de gauche.
y
 y True float

Représente la position verticale de la zone sous la forme d’un pourcentage de la hauteur de page. L’origine (0,0) se trouve en haut à gauche de la page. La valeur 0,1 signifie que la boîte est positionnée à 10% de la hauteur de page du haut.
width
 width True float

Largeur de la zone en fonction des dimensions de page, semblable aux coordonnées x et y. Il s’agit d’un float représentant un pourcentage de la pageWidth.
height
 height True float

Hauteur de la zone en fonction des dimensions de page, comme les coordonnées x et y. Il s’agit d’un float représentant un pourcentage de la pageHeight.
id
 id True string

ID unique pour cette zone, généré de n’importe quelle manière.
label
 label string

Texte d’espace réservé, tel que le nom du champ, par exemple « Date de naissance ».
value
 value string

Valeur par défaut de la zone. Peut être null. Si la zone est de type « chooseBox », la valeur peut être null ou l’une des chaînes définies dans les options.
readonly
 readonly boolean

Si la valeur est true, la personne invitée ne peut pas modifier la valeur de cette zone.
obligatoire
 required boolean

Si la valeur est true, la personne invitée ne peut pas signer le document sans remplir cette zone.
type
 type True string
multiligne
 multiline boolean

Indique si plusieurs lignes sont autorisées.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Chaque case d’option peut être affectée à un groupe.
signatureTypes
 signatureTypes array of string

Les types de signatures autorisés pour ce destinataire peuvent être remplacés par des types de signature de destinataire. Options : ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId
 refId string

Le refId est un champ facultatif utilisé pour référencer le document chargé. S’il est fourni, il vous permet d’affecter un identificateur de référence personnalisé au document, qui sera retourné dans le cadre de l’objet document dans les réponses d’API futures. Cela peut être utile pour le suivi ou l’organisation de documents par un système ou un flux de travail externe.
language
 language string

Langue du document.
folderId
 folderId string

ID d’un dossier dans lequel les documents doivent être insérés. Cela n’est possible que lorsque inviteData et folderName ne sont pas définis.
isAttachment
 isAttachment boolean

isAttachment n’est pas nécessaire dans ce cas.
Détails du destinataire
 recipientDetails True object

Détails du destinataire clés par e-mail du destinataire. Exemple : { »mail@test.com :{"role » :"signer »,"signaturePositions » :["page » :0,"x » :0.55,"y » :0.80,"width » :0.25,"height » :0.08}]}}}.
useFastlane
 useFastlane boolean

S’il est défini sur true le signataire reçoit un lien Fastlane dans l’e-mail d’invitation.
fastlaneProfileId
 fastlaneProfileId uuid

Spécifiez le profil Fastlane qui doit être utilisé avec ce document. (useFastlane doit être défini sur true).

Retours

Corps
EnvelopeResponse

Créer une demande de signature à l’aide d’espaces réservés

ID d’opération :
CreateSignatureRequestUsingPlaceholders

Crée une demande de signature à l’aide d’espaces réservés stockés dans le document chargé. Les destinataires et les positions de signature sont extraits du document.

Paramètres

Nom Clé Obligatoire Type Description
email
 email True string

E-mail de l’expéditeur. Il doit appartenir à un membre de votre plan.
firstName
 firstName True string

Prénom de l’expéditeur.
lastName
 lastName string

Nom de l’expéditeur.
role
 role string

Rôle de l’expéditeur sur tous les documents.
email
 email string

E-mail du destinataire.
firstName
 firstName string

Prénom du destinataire.
lastName
 lastName string

Nom du destinataire.
doNotSendEmails
 doNotSendEmails boolean

S’il n’est pas défini sur true aucun e-mail envoyé au destinataire.
customId
 customId string

Pour être utilisé uniquement lorsque l’adresse e-mail du destinataire est inconnue au moment de l’invitation. Cela fonctionne uniquement lorsque vous invitez les destinataires (pas pour préparer des itinéraires) et que vous souhaitez utiliser fastlane. Vous customId pouvez prégéner un lien de signature unique pour un destinataire avant d’envoyer une invitation. Doit être une chaîne alphanumérique unique d’au moins 70 caractères.

Remarque : Le customId ne peut être utilisé que pour générer le lien du destinataire vers un document. Elle ne peut pas être utilisée pour d’autres requêtes au lieu du memberId. Pour plus d’informations sur la construction d’URL, consultez Ouverture d’un document avec un ID personnalisé
useFastlane
 useFastlane boolean

S’il est défini sur true le signataire reçoit un lien Fastlane dans l’e-mail d’invitation.
numéro de téléphone
 phoneNumber string

Numéro de téléphone de ce destinataire. Cela est utilisé pour la vérification SMS. (par exemple : +43 699 1234 1234).
privateMessage
 privateMessage string

Message privé pour ce destinataire spécifique.
inPersonMode
 inPersonMode boolean

Lorsque cette option est activée, le destinataire de la demande de signature doit signer le document en personne et aucun e-mail n’est envoyé. Ce mode est disponible uniquement à l’aide du type de signature SES
signatureTypes
 signatureTypes array of string

Types de signatures autorisées pour ce destinataire. Options : ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag
 tag string

Cette balise détermine le fournisseur d’identité qui sera utilisé pour le processus de signature. Choisissez parmi un ensemble prédéfini de fournisseurs pris en charge.

Remarque1 : Certains fournisseurs ne sont disponibles que pour certains signatureTypes, par exemple onetimeqes nécessiteront "signatureType" : ["qualifiedPlusIdent"]

Remarque2 : Lorsque vous utilisez sproof-qualified en tant que fournisseur par défaut, le destinataire doit disposer d’un compte sproof actif avec une licence User+ active.
canChange
 canChange boolean

Boolean pour indiquer si le destinataire invité doit être en mesure de modifier le fournisseur de signature
country
 country string

Le pays par défaut, s’il est vide, est défini sur tous, une erreur est retournée avec les pays disponibles pour la balise fournisseur choisie
dueDate
 dueDate YYYY-MM-DD

Date jusqu’à laquelle le document peut être signé. Cette date d’échéance s’affiche au destinataire dans l’e-mail d’invitation et est également visible dans la section détails du document du tableau de bord. Il sert d’échéance pour terminer le processus de signature.
reminderInterval
 reminderInterval number

Spécifie le nombre de jours entre les e-mails de rappel.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Date à partir de laquelle les rappels doivent être envoyés
inviteLanguage
 inviteLanguage string

Spécifie la langue des e-mails envoyés aux utilisateurs anonymes qui n’ont pas de compte. Pour les utilisateurs disposant d’un compte, la langue sélectionnée dans leur profil sera utilisée à la place.
message
 message string

Message personnalisé envoyé aux destinataires dans l’e-mail.
subject
 subject string

Ligne d’objet de l’e-mail envoyée aux destinataires.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

Si la valeur est true, le fichier pdf est envoyé sous forme de pièce jointe à tous les destinataires du document (s’il est inférieur à 5 Mo).
focusSigningMode
 focusedSigningMode boolean

Lorsque cette option est activée, le destinataire de la demande de signature sera limité à la signature ou à la baisse du document et ne pourra pas naviguer loin de la page.
allowForwarding
 allowForwarding boolean

Autoriser le transfert de l’invitation.
collabSigningMode
 collabSigningMode object

Objet où chaque clé représente un round de signature et sa valeur correspondante indique si la signature collaborative est activée pour ce tour. Si la valeur est true, une seule signature est requise pour terminer le cycle de signature spécifié et passer à la prochaine ronde. Par exemple, { '1' : true } signifie que dans la signature ronde '1', une seule signature est nécessaire.
inPersonSigning
 inPersonSigning boolean

Lorsque la valeur est true, le destinataire obtient une fenêtre contextuelle dans laquelle il doit dessiner manuellement une signature
folderName
 folderName string

Si elle est donnée, une enveloppe est créée contenant tous les documents dans documentDataArray. (Obligatoire si plusieurs documents sont envoyés)
callbackUrl
 callbackUrl string

Une requête POST, y compris le document, est envoyée à cette URL lorsqu’une nouvelle signature est créée ou lorsqu’un destinataire refuse le document. En cas de défaillance, un mécanisme de nouvelle tentative est en place pour s’assurer que la demande est retentée.
returnUrl
 returnUrl string

Lien du bouton de retour après la signature d’un document
returnBtnText
 returnBtnText string

Texte du bouton de retour après la signature d’un document
Données
 data True string

Données de document (PDF ou DOCX) au format base64.
mimetype
 mimetype string

Type MIME de données encodées en base64 PDF ou DOCX, obligatoire si le document n’est pas un pdf
fileName
 fileName True string

Nom du fichier
label
 label string

Étiquette personnalisée qui peut être envoyée pour organiser les documents.
page
 page True integer

Numéro de la page sur laquelle se trouve la zone, la première page étant 0.
pageWidth
 pageWidth integer

Toute valeur entière décrivant la largeur de la page. Plus le nombre est élevé, plus la précision est élevée lors du positionnement de la boîte dans l’espace x y. Sur une page A4, nous avons 478 comme valeur par défaut.
pageHeight
 pageHeight integer

Toute valeur entière décrivant la hauteur de la page. Plus le nombre est élevé, plus la précision est élevée lors du positionnement de la boîte dans l’espace x y. Sur une page A4, nous avons 676 comme valeur par défaut.
x
 x True float

Représente la position horizontale de la zone sous la forme d’un pourcentage de la largeur de la page. L’origine (0,0) se trouve en haut à gauche de la page. La valeur 0,1 signifie que la boîte est positionnée à 10% de la largeur de page de gauche.
y
 y True float

Représente la position verticale de la zone sous la forme d’un pourcentage de la hauteur de page. L’origine (0,0) se trouve en haut à gauche de la page. La valeur 0,1 signifie que la boîte est positionnée à 10% de la hauteur de page du haut.
width
 width True float

Largeur de la zone en fonction des dimensions de page, semblable aux coordonnées x et y. Il s’agit d’un float représentant un pourcentage de la pageWidth.
height
 height True float

Hauteur de la zone en fonction des dimensions de page, comme les coordonnées x et y. Il s’agit d’un float représentant un pourcentage de la pageHeight.
id
 id True string

ID unique pour cette zone, généré de n’importe quelle manière.
label
 label string

Texte d’espace réservé, tel que le nom du champ, par exemple « Date de naissance ».
value
 value string

Valeur par défaut de la zone. Peut être null. Si la zone est de type « chooseBox », la valeur peut être null ou l’une des chaînes définies dans les options.
readonly
 readonly boolean

Si la valeur est true, la personne invitée ne peut pas modifier la valeur de cette zone.
obligatoire
 required boolean

Si la valeur est true, la personne invitée ne peut pas signer le document sans remplir cette zone.
type
 type True string
multiligne
 multiline boolean

Indique si plusieurs lignes sont autorisées.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Chaque case d’option peut être affectée à un groupe.
signatureTypes
 signatureTypes array of string

Les types de signatures autorisés pour ce destinataire peuvent être remplacés par des types de signature de destinataire. Options : ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId
 refId string

Le refId est un champ facultatif utilisé pour référencer le document chargé. S’il est fourni, il vous permet d’affecter un identificateur de référence personnalisé au document, qui sera retourné dans le cadre de l’objet document dans les réponses d’API futures. Cela peut être utile pour le suivi ou l’organisation de documents par un système ou un flux de travail externe.
language
 language string

Langue du document.
folderId
 folderId string

ID d’un dossier dans lequel les documents doivent être insérés. Cela n’est possible que lorsque inviteData et folderName ne sont pas définis.
isAttachment
 isAttachment boolean

isAttachment n’est pas nécessaire dans ce cas.
useFastlane
 useFastlane boolean

S’il est défini sur true le signataire reçoit un lien Fastlane dans l’e-mail d’invitation.
fastlaneProfileId
 fastlaneProfileId uuid

Spécifiez le profil Fastlane qui doit être utilisé avec ce document. (useFastlane doit être défini sur true).

Retours

Corps
EnvelopeResponse

Obtenir l’état de la demande

ID d’opération :
GetSignatureStatus

Obtenez l’état d’une demande de signature. Retourne un objet JSON de document ou une erreur. Le paramètre est retourné par la demande de publication sur le document et est associé à l’e-mail des expéditeurs.

Paramètres

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

ID de membre

Retours

Corps
DocumentStatusForFlow

Obtenir un document

ID d’opération :
GetDocument

Obtenir un document signé sous forme de chaîne encodée en base64 ou binaire.

Paramètres

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

ID de membre
Format de téléchargement
 format string

Spécifie le format de réponse. Utiliser pdf pour le fichier PDF binaire et base64 pour une réponse encodée en Base64. Exemple de base64 réponse : json { "base64": "JVBERi0xLjQKJe..." }

Retours

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

Contenu PDF encodé en base64

Supprimer un document

ID d’opération :
DeleteDocument

Supprime un document ou supprime l’accès d’un membre, selon que le document fourni memberId appartient à l’expéditeur ou à un destinataire, et si le document fait partie d’une enveloppe.

Documents dans une enveloppe

Le paramètre all de requête n’a aucun effet pour les documents d’une enveloppe.

Avec l’expéditeur memberId:

  • Un seul document est supprimé pour l’expéditeur et tous les destinataires.
  • Le document est supprimé de l’enveloppe.

Avec le destinataire memberId:

  • Tous les documents de l’enveloppe sont supprimés pour le destinataire.
  • Le destinataire est marqué comme declined sur tous les documents qui ont été supprimés pour le destinataire.
  • Les documents restent disponibles pour tous les autres membres du document.

Documents uniques

Avec l’expéditeur memberId et all=true:

  • Le document est supprimé pour l’expéditeur et tous les destinataires.

Avec l’expéditeur memberId et all=false:

  • Le document est supprimé uniquement pour l’expéditeur.
  • Le document reste disponible pour les autres destinataires du document.

Avec le destinataire memberId:

  • Le destinataire est marqué comme declined sur le document.
  • Le document reste disponible pour tous les autres membres du document.

Paramètres

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

ID de membre
Supprimer pour tous les destinataires
 all boolean

Uniquement pertinent pour les documents uniques lorsque le document fourni memberId appartient à l’expéditeur. Si la valeur est définie true, le document est supprimé pour l’expéditeur et tous les destinataires. Si la valeur est définie false, le document est supprimé uniquement pour l’expéditeur et reste disponible pour les autres destinataires. Ce paramètre n’a aucun effet pour les documents d’une enveloppe (valeur par défaut = true) ou lorsque le destinataire fourni memberId appartient.

Retours

response
DeleteDocumentResponse

Définitions

DeleteDocumentResponse

Supprimer la réponse du document
string

EnvelopeResponse

Nom Chemin d’accès Type Description
folderId
 folderId string
folderName
 folderName string
documents
 documents array of object
id
 documents.id string
nom
 documents.name string
language
 documents.language string
startSendingReminders
 documents.startSendingReminders date-time

Date et heure à laquelle les rappels commencent à être envoyés (chaîne datetime ISO 8601)
sendReminder
 documents.sendReminder boolean
reminderSent
 documents.reminderSent boolean
reminderInterval
 documents.reminderInterval number
createdAt
 documents.createdAt date-time

Date et heure de création du document (chaîne datetime ISO 8601)
callbackUrl
 documents.callbackUrl string
returnUrl
 documents.returnUrl string
returnBtnText
 documents.returnBtnText string
inPersonSigning
 documents.inPersonSigning boolean
signingRound
 documents.signingRound number
isTemplate
 documents.isTemplate boolean
templateId
 documents.templateId string
linkId
 documents.linkId string
linkExpiresAt
 documents.linkExpiresAt string
derivedFromLink
 documents.derivedFromLink boolean
state
 documents.state string
complianceLevel
 documents.complianceLevel string
allowForwarding
 documents.allowForwarding boolean
linkExpires
 documents.linkExpires boolean
setDueDate
 documents.setDueDate boolean
dueDate
 documents.dueDate date-time

Date d’échéance du document (chaîne datetime ISO 8601)
focusSigningMode
 documents.focusedSigningMode boolean
linkMaxSignaturesEnabled
 documents.linkMaxSignaturesEnabled boolean
linkMaxSignatures
 documents.linkMaxSignatures number
fastlaneProfileId
 documents.fastlaneProfileId string
refId
 documents.refId string
sendOutFinishedPdf
 documents.sendOutFinishedPdf boolean
signatureTypes
 documents.signatureTypes array of string
members
 documents.members array of MemberResponseSchema
member
 documents.member MemberResponseSchema
Boîtes
 documents.boxes array of DocumentResponseBox

Zone de champ de formulaire dans la réponse du document. Cela n’est retourné que si le document comporte des champs de formulaire. Si le document est signé, le document retourne des zones avec les valeurs qui ont été remplies.
Retard
 documents.overdue boolean

DocumentResponseBox

Nom Chemin d’accès Type Description
id
 id string
type
 type string
value
 value string

Valeur du champ de zone. Peut être une chaîne (y compris une chaîne vide), une valeur booléenne ou null en fonction du type de zone.
label
 label string

MemberResponseSchema

Nom Chemin d’accès Type Description
id
 id string
documentId
 documentId string
email
 email string
firstName
 firstName string
lastName
 lastName string
isAdmin
 isAdmin boolean
createdAt
 createdAt date-time

Date et heure de création du membre (chaîne datetime ISO 8601)
sentDeleteNotificationAt
 sentDeleteNotificationAt date-time

Date et heure de l’envoi de la notification de suppression (chaîne datetime ISO 8601)
manuellementLastEmailSent
 manuallyLastEmailSent date-time

Date et heure à laquelle le dernier e-mail manuel a été envoyé (chaîne datetime ISO 8601)
signaturePosition
 signaturePosition MemberSignaturePositionResponse

Données de position de signature avec des champs spécifiques à la réponse supplémentaires. Les champs cardStyle, pageWidth et pageHeight sont facultatifs et peuvent ne pas être présents dans toutes les réponses d’API.
doNotSendEmails
 doNotSendEmails boolean
refuséAt
 declinedAt date-time

Date et heure auxquelles le membre a refusé (chaîne datetime ISO 8601)
signingOrder
 signingOrder number
Ondemand
 onDemand string
recipientId
 recipientId string
signatureTypes
 signatureTypes array of string
signatureTypesActive
 signatureTypesActive boolean
privateMessage
 privateMessage string
customId
 customId string
useFastlane
 useFastlane boolean
role
 role string
approvedAt
 approvedAt date-time

Date et heure auxquelles le membre a été approuvé (chaîne datetime ISO 8601)
vérificationConfig
 verificationConfig
numéro de téléphone
 phoneNumber string
Signatures
 signatures array of string
signedAt
 signedAt date-time

Date et heure de signature du membre (chaîne datetime ISO 8601)

MemberSignaturePositionResponse

Données de position de signature avec des champs spécifiques à la réponse supplémentaires. Les champs cardStyle, pageWidth et pageHeight sont facultatifs et peuvent ne pas être présents dans toutes les réponses d’API.

Nom Chemin d’accès Type Description
Objets
 SignaturePositionResponse

Données de position de signature avec des champs spécifiques à la réponse supplémentaires. Les champs cardStyle, pageWidth et pageHeight sont facultatifs et peuvent ne pas être présents dans toutes les réponses d’API.

SignaturePositionResponse

Données de position de signature avec des champs spécifiques à la réponse supplémentaires. Les champs cardStyle, pageWidth et pageHeight sont facultatifs et peuvent ne pas être présents dans toutes les réponses d’API.

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

Numéro de page, à compter de 0.
x
 x number

coordonnée x de la position supérieure gauche des signatures
y
 y number

coordonnée y de la position supérieure gauche des signatures
width
 width number

Largeur de la signature.
height
 height number

Hauteur de la signature.
cardStyle
 cardStyle string

Style visuel de la carte de signature. Ce champ est facultatif et peut ne pas être retourné dans toutes les réponses.
pageWidth
 pageWidth number

Largeur de la page en pixels. Ce champ est facultatif et peut ne pas être retourné dans toutes les réponses.
pageHeight
 pageHeight number

Hauteur de la page en pixels. Ce champ est facultatif et peut ne pas être retourné dans toutes les réponses.

DocumentStatusForFlow

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

État actuel du document. Les valeurs possibles sont : brouillon, en attente, refusé, terminé, pièce jointe, manuelleMent, manuellementCompleted
createdAt
 createdAt date
updatedAt
 updatedAt date
allSignersSigned
 allSignersSigned boolean
allMembersSigned
 allMembersSigned boolean
focusSigningMode
 focusedSigningMode boolean