Certinal eSign (préversion)
Certinal eSign permet aux entreprises d’envoyer, de signer et de gérer en toute sécurité des documents avec des eSignatures globalement conformes. Conçu pour les secteurs réglementés, Certinal fournit le suivi des flux de travail en temps réel, les pistes d’audit de falsification et l’automatisation transparente. Utilisez Certinal eSign dans vos flux de travail pour numériser les approbations, accélérer les processus et garantir des signatures légalement valides dans 70 pays.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | 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 | Aide et support |
| URL | https://www.certinal.com/department/esignature-for-support |
| Messagerie électronique | tech-support@certinal.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Certinal Inc. |
| Site web | https://www.certinal.com/ |
| Politique de confidentialité | https://www.certinal.com/privacy-policy |
| Catégories | Productivité; Gestion de l’entreprise |
Certinal eSign
Aperçu
Certinal eSign vous fournit un flux de travail eSignature et eConsent sécurisés et conformes pour les entreprises mondiales : envoyer, signer, suivre et gérer des documents directement à partir de Power Automate.
Prerequisites
Vous devez disposer d’un compte d’administrateur Certinal pour utiliser le déclencheur connecteur. Pour utiliser le déclencheur connecteur dans cette intégration, Power Connector doit être activé dans vos paramètres d’administration Certinal.
Comment obtenir des informations d’identification
Certinal utilise la clé API pour authentifier les services. Vous devez générer la clé API à partir du compte d’administrateur Certinal.
Opérations prises en charge
Le connecteur prend en charge les opérations suivantes :
Obtenir les détails de la transaction
Obtenir les détails de la transaction par ID de transaction
Télécharger des documents pour la transaction
Télécharger des documents pour l’ID de transaction donné
Créer une transaction
Créer une transaction
Créer une transaction à l’aide d’un modèle
Créer une transaction à l’aide d’un ID de modèle donné
Répertorier les utilisateurs
Répertorier les utilisateurs
Obtenir les détails de l’utilisateur
Obtenir les détails de l’utilisateur pour l’ID d’utilisateur donné
Créer un utilisateur
Créer un utilisateur
Déclencheurs pris en charge
Le connecteur prend en charge les déclencheurs suivants :
Lorsqu’un état de transaction est modifié
Inscrire un rappel pour un événement de transaction particulier
Documents d’API :
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Aide et support
https://esign.certinal.com/esign/certinal-docs/help-support
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 | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé d’API | securestring | Clé API pour cette API | Vrai |
| Point de terminaison d’API de base | ficelle | URL de base du point de terminaison d’API (par exemple, api.certinal.com) | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer un utilisateur |
Créer un utilisateur |
| Créer une transaction |
Créer une transaction |
| Créer une transaction à l’aide d’un modèle |
Créer une transaction à l’aide d’un ID de modèle donné |
| Obtenir les détails de la transaction |
Obtenir les détails de la transaction par ID de transaction |
| Obtenir les détails de l’utilisateur |
Obtenir les détails de l’utilisateur pour l’ID d’utilisateur donné |
| Répertorier les utilisateurs |
Répertorier les utilisateurs |
| Supprimer l’abonnement |
Supprimer l’abonnement |
| Télécharger des documents pour la transaction |
Télécharger des documents pour l’ID de transaction donné |
Créer un utilisateur
Créer un utilisateur
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Adresse électronique
|
emailAddress | string |
Adresse électronique |
|
|
Prénom
|
firstName | string |
Prénom |
|
|
Nom de famille
|
lastName | string |
Nom de famille |
|
|
Entreprise
|
company | string |
Entreprise |
|
|
Fuseau horaire
|
timezone | string |
Fuseau horaire |
|
|
Language
|
language | string |
Language |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Salutation
|
salutation | string |
Salutation |
|
|
Poste
|
jobTitle | string |
Poste |
|
|
Numéro de téléphone
|
phoneNumber | string |
Numéro de téléphone |
|
|
Code pays
|
phoneCountryCode | string |
Code pays |
|
|
Rôles
|
roles | array of string |
Rôles |
|
|
Le courrier final est-il désactivé ?
|
finalMailDisabled | boolean |
Le courrier final est-il désactivé ? |
|
|
Le courrier de rappel est-il désactivé ?
|
reminderMailDisabled | boolean |
Le courrier de rappel est-il désactivé ? |
|
|
Le courrier de l’expéditeur est-il désactivé ?
|
senderMailDisabled | boolean |
Le courrier de l’expéditeur est-il désactivé ? |
|
|
L’utilisateur d’intégration est-il un utilisateur ?
|
integrationUser | boolean |
L’utilisateur d’intégration est-il un utilisateur ? |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Code de statut
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
|
ID utilisateur
|
data.user_id | string |
ID utilisateur |
Créer une transaction
Créer une transaction
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de la transaction
|
name | True | string |
Nom de la transaction |
|
Message
|
message | string |
Message de tous les participants. |
|
|
URL de rappel
|
url | string |
URL de rappel |
|
|
Événements de transaction
|
transactionEvents | array of string |
Événements de transaction |
|
|
Événements des participants
|
participantEvents | array of string |
Événements des participants |
|
|
État de la transaction
|
status | string |
État de la transaction |
|
|
ID externe
|
externalId | string |
ID externe |
|
|
Expire au moment de l’horodatage
|
expiresAtTimestamp | string |
La transaction expire au moment de l’horodatage |
|
|
Rappeler à partir de l’horodatage
|
remindFromTimestamp | string |
Rappeler à partir de l’horodatage |
|
|
Fréquence de rappel
|
reminderFrequency | integer |
Fréquence de rappel |
|
|
Champs par défaut
|
default | boolean |
Champs de bloc de signature par défaut |
|
|
Séquence de participants
|
sequence | integer |
Sequence |
|
|
Role
|
role | string |
Role |
|
|
Nom
|
name | string |
Nom du candidat |
|
|
Adresse électronique
|
emailAddress | string |
Adresse e-mail du candidat |
|
|
Language
|
language | string |
Language |
|
|
Mode d'authentification
|
authenticationMode | string |
Mode d'authentification |
|
|
Valeur du mode d’authentification
|
authenticationModeValue | string |
Valeur du mode d’authentification |
|
|
Canaux de distribution
|
deliveryChannels | array of string |
Canaux de distribution |
|
|
ID de champ
|
fieldId | string |
ID de champ |
|
|
Feuilles
|
pages | array of string |
Feuilles |
|
|
Document Id
|
documentId | string |
Document Id |
|
|
Largeur du champ
|
width | float |
Largeur du champ |
|
|
Hauteur du champ
|
height | float |
Hauteur du champ |
|
|
Tooltip
|
tooltip | string |
Tooltip |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Nombre de lignes de zone de texte
|
textareaLineCount | string |
Nombre de lignes de zone de texte |
|
|
Nom du champ
|
fieldName | string |
Nom du champ |
|
|
X Position
|
xposition | float |
Position X du champ |
|
|
Y Position
|
yposition | float |
Position Y du champ |
|
|
Est-il obligatoire ?
|
required | boolean |
Est-ce un champ obligatoire ? |
|
|
Est-ce que la lecture est en lecture seule ?
|
readOnly | boolean |
S’agit-il d’un champ Lecture seule ? |
|
|
Zone de texte
|
textarea | boolean |
Zone de texte |
|
|
Haut en bas
|
topBottom | boolean |
Haut en bas |
|
|
Vertical
|
vertical | boolean |
Vertical |
|
|
ID du groupe radio
|
radioGroupId | string |
ID du groupe radio |
|
|
Valeur par défaut
|
defaultValue | string |
Valeur par défaut |
|
|
Valeur
|
value | string |
Valeur |
|
|
Afficher l’étiquette
|
displayLabel | string |
Afficher l’étiquette |
|
|
Nom
|
name | string |
Nom |
|
|
Adresse électronique
|
emailAddress | string |
Adresse électronique |
|
|
Language
|
language | string |
Language |
|
|
Document Id
|
id | string |
Document Id |
|
|
Sequence
|
sequence | integer |
Sequence |
|
|
Deletable ?
|
deletable | boolean |
Deletable ? |
|
|
Est privé
|
private | boolean |
Est privé |
|
|
Valeur de champ
|
value | string |
Valeur de champ |
|
|
Nom du champ
|
fieldName | string |
Nom du champ |
|
|
Code
|
code | string |
Code |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Code de statut
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
|
ID de la transaction
|
data.transactionId | string |
ID de la transaction |
Créer une transaction à l’aide d’un modèle
Créer une transaction à l’aide d’un ID de modèle donné
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de la transaction
|
name | string |
Nom de la transaction |
|
|
État de la transaction
|
status | string |
État de la transaction |
|
|
ID externe
|
externalId | string |
ID externe |
|
|
ID de modèle
|
templateId | string |
ID de modèle |
|
|
ID de modèle secondaire
|
secondaryTemplateIds | array of string |
ID de modèle secondaire |
|
|
Message
|
message | string |
Message de tous les participants. |
|
|
URL de rappel
|
url | string |
URL de rappel |
|
|
Événements de transaction
|
transactionEvents | array of string |
Événements de transaction |
|
|
Événements des participants
|
participantEvents | array of string |
Événements des participants |
|
|
Séquence de participants
|
sequence | integer |
Sequence |
|
|
Role
|
role | string |
Role |
|
|
Est-ce que le processus automatique ?
|
autoProcess | boolean |
Est-ce que le processus automatique ? |
|
|
Nom du champ
|
fieldName | string |
Nom du champ |
|
|
Valeur de champ
|
value | string |
Valeur de champ |
|
|
Nom
|
name | string |
Nom du candidat |
|
|
Adresse électronique
|
emailAddress | string |
Adresse e-mail du candidat |
|
|
Message
|
message | string |
Message |
|
|
Language
|
language | string |
Language |
|
|
Canaux de distribution
|
deliveryChannels | array of string |
Canaux de distribution |
|
|
Corps SMS personnalisé
|
customSMSBody | string |
Corps SMS personnalisé |
|
|
Nom
|
name | string |
Nom |
|
|
Message
|
message | string |
Message |
|
|
Est-il obligatoire ?
|
required | boolean |
Est-il obligatoire ? |
|
|
Nom
|
name | string |
Nom |
|
|
Adresse électronique
|
emailAddress | string |
Adresse électronique |
|
|
Language
|
language | string |
Language |
|
|
Valeur de champ
|
value | string |
Valeur de champ |
|
|
Nom du champ
|
fieldName | string |
Nom du champ |
|
|
Code
|
code | string |
Code |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Code de statut
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
|
ID de la transaction
|
data.transactionId | string |
ID de la transaction |
Obtenir les détails de la transaction
Obtenir les détails de la transaction par ID de transaction
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de la transaction
|
transactionId | True | string |
ID de transaction unique |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Code de statut
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
|
Nom de la transaction
|
data.name | string |
Nom de la transaction |
|
État de la transaction
|
data.status | string |
État de la transaction |
|
ID de la transaction
|
data.transactionId | string |
ID de la transaction |
|
Message
|
data.mail.message | string |
Message de tous les participants. |
|
Date de la dernière mise à jour
|
data.lastUpdatedDate | string |
Date de la dernière mise à jour |
|
Date de création
|
data.createdDate | string |
Date de création |
|
ID utilisateur
|
data.createdBy.id | string |
Créé par l’ID d’utilisateur |
|
Nom d’utilisateur
|
data.createdBy.username | string |
Créé par nom d’utilisateur |
|
Adresse électronique
|
data.createdBy.emailAddress | string |
Créé par adresse e-mail |
|
Date d’envoi
|
data.sentDate | string |
Date d’envoi |
|
ID utilisateur
|
data.lastActionPerformedBy.userId | string |
ID utilisateur |
|
Nom d'utilisateur
|
data.lastActionPerformedBy.userName | string |
Nom d'utilisateur |
|
Adresse électronique
|
data.lastActionPerformedBy.emailAddress | string |
Adresse électronique |
|
ID de candidat
|
data.lastActionPerformedBy.candidateId | string |
ID de candidat |
|
Participant Id
|
data.lastActionPerformedBy.participantId | string |
Participant Id |
|
Expire au moment de l’horodatage
|
data.expiryAndReminders.expiresAtTimestamp | string |
La transaction expire au moment de l’horodatage |
|
Jours d’expiration
|
data.expiryAndReminders.expiryDays | integer |
Jours d’expiration |
|
Rappeler des jours de rappel
|
data.expiryAndReminders.remindFromReminderDays | integer |
Rappeler des jours de rappel |
|
Rappeler à partir de l’heure du rappel
|
data.expiryAndReminders.remindFromReminderTime | string |
Rappeler à partir de l’heure du rappel |
|
Fréquence de rappel
|
data.expiryAndReminders.reminderFrequency | integer |
Fréquence de rappel |
|
Participants
|
data.participants | array of object |
Participants |
|
Participant Id
|
data.participants.id | string |
Participant Id |
|
État du participant
|
data.participants.status | string |
État du participant |
|
Date de la dernière mise à jour
|
data.participants.lastUpdatedDate | string |
Date de la dernière mise à jour |
|
Date de création
|
data.participants.createdDate | string |
Date de création |
|
Séquence de participants
|
data.participants.sequence | integer |
Sequence |
|
Role
|
data.participants.role | string |
Role |
|
Méthode de signature
|
data.participants.signingMethodDTO | array of string |
Détails de la méthode de signature |
|
Soumis par l’utilisateur
|
data.participants.submittedBys | array of object |
Détails soumis par l’utilisateur |
|
ID utilisateur
|
data.participants.submittedBys.userId | string |
Envoyé par l’ID de l’utilisateur |
|
Nom d'utilisateur
|
data.participants.submittedBys.userName | string |
Envoyé par nom d’utilisateur |
|
Adresse électronique
|
data.participants.submittedBys.emailAddress | string |
Adresse e-mail envoyée par l’utilisateur |
|
ID de candidat
|
data.participants.submittedBys.candidateId | string |
ID de candidat |
|
Candidats
|
data.participants.candidates | array of object |
Candidats |
|
ID de candidat
|
data.participants.candidates.id | string |
ID de candidat |
|
Nom
|
data.participants.candidates.name | string |
Nom du candidat |
|
Adresse électronique
|
data.participants.candidates.emailAddress | string |
Adresse e-mail du candidat |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Type
|
data.participants.candidates.type | string |
Type |
|
Action
|
data.participants.candidates.action | string |
Action |
|
Date d’action
|
data.participants.candidates.actionDate | string |
Date d’action |
|
Date de création
|
data.participants.candidates.createdDate | string |
Date de création |
|
Valeur du mode d’authentification
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Valeur du mode d’authentification |
|
détails de la méthode de signature
|
data.participants.candidates.signingMethodDTO | array of string |
détails de la méthode de signature |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Canaux de distribution
|
data.participants.candidates.deliveryChannels | array of string |
Canaux de distribution |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Id
|
data.participants.fields.id | string |
Id |
|
Date de la dernière mise à jour
|
data.participants.fields.lastUpdatedDate | string |
Date de la dernière mise à jour |
|
Date de création
|
data.participants.fields.createdDate | string |
Date de création |
|
ID de champ
|
data.participants.fields.fieldId | string |
ID de champ |
|
Page Non
|
data.participants.fields.pageNo | integer |
Page Non |
|
Document Id
|
data.participants.fields.documentId | string |
Document Id |
|
Largeur du champ
|
data.participants.fields.width | float |
Largeur du champ |
|
Hauteur du champ
|
data.participants.fields.height | float |
Hauteur du champ |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Valeur
|
data.participants.fields.value | string |
Valeur |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Afficher l’étiquette
|
data.participants.fields.displayLabel | string |
Afficher l’étiquette |
|
Type de lien
|
data.participants.fields.linkType | string |
Type de lien |
|
Radio Id
|
data.participants.fields.radioId | integer |
Radio Id |
|
ID du groupe radio
|
data.participants.fields.radioGroupId | string |
ID du groupe radio |
|
ID de case à cocher
|
data.participants.fields.checkboxId | integer |
ID de case à cocher |
|
Nom du champ
|
data.participants.fields.fieldName | string |
Nom du champ |
|
X Position
|
data.participants.fields.xposition | float |
Position X du champ |
|
Y Position
|
data.participants.fields.yposition | float |
Position Y du champ |
|
Est-il obligatoire ?
|
data.participants.fields.required | boolean |
Est-ce un champ obligatoire ? |
|
Est-ce que la lecture est en lecture seule ?
|
data.participants.fields.readOnly | boolean |
S’agit-il d’un champ Lecture seule ? |
|
Zone de texte
|
data.participants.fields.textarea | boolean |
Zone de texte |
|
Vertical
|
data.participants.fields.vertical | boolean |
Vertical |
|
Haut en bas
|
data.participants.fields.topBottom | boolean |
Haut en bas |
|
Valeur par défaut
|
data.participants.fields.defaultValue | string |
Valeur par défaut |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
Est-il obligatoire ?
|
data.participants.signatureBlock.format.required | boolean |
Est-il obligatoire ? |
|
Par défaut
|
data.participants.signatureBlock.default | boolean |
Par défaut |
|
Activer le délégué
|
data.participants.enableDelegate | boolean |
Activer le délégué |
|
Processus automatique
|
data.participants.autoProcess | boolean |
Processus automatique |
|
Utilisateurs CC
|
data.ccUsers | array of object |
Utilisateurs CC |
|
Nom
|
data.ccUsers.name | string |
Nom |
|
Adresse électronique
|
data.ccUsers.emailAddress | string |
Adresse électronique |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documents
|
data.documents | array of object |
Documents |
|
Document Id
|
data.documents.id | string |
Document Id |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Nom de fichier
|
data.documents.fileName | string |
Nom de fichier |
|
Nombre de pages
|
data.documents.pageCount | integer |
Nombre de pages |
|
Deletable ?
|
data.documents.deletable | boolean |
Deletable ? |
|
Est privé
|
data.documents.private | boolean |
Est privé |
|
Champs personnalisés
|
data.customFields | array of object |
Champs personnalisés |
|
ID de champ personnalisé
|
data.customFields.customFieldId | string |
ID de champ personnalisé |
|
Valeur de champ
|
data.customFields.value | string |
Valeur de champ |
|
Nom du champ
|
data.customFields.fieldName | string |
Nom du champ |
|
Type de champ
|
data.customFields.fieldType | string |
Type de champ |
|
Abonnements aux notifications
|
data.notificationSubscriptions | array of |
Abonnements aux notifications |
|
tags
|
data.tags | array of |
tags |
|
Documents supplémentaires
|
data.additionalDocuments | array of object |
Documents supplémentaires |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nom de fichier
|
data.additionalDocuments.fileName | string |
Nom de fichier |
|
Type
|
data.additionalDocuments.type | string |
Type |
|
ID de candidat
|
data.additionalDocuments.candidateId | string |
ID de candidat |
|
Contrats distincts
|
data.separateAgreements | boolean |
Contrats distincts |
Obtenir les détails de l’utilisateur
Obtenir les détails de l’utilisateur pour l’ID d’utilisateur donné
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID utilisateur
|
userId | True | string |
ID d’utilisateur unique |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Code de statut
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
|
Prénom
|
data.firstName | string |
Prénom |
|
Nom de famille
|
data.lastName | string |
Nom de famille |
|
Entreprise
|
data.company | string |
Entreprise |
|
Fuseau horaire
|
data.timezone | string |
Fuseau horaire |
|
Language
|
data.language | string |
Language |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Poste
|
data.jobTitle | string |
Poste |
|
Numéro de téléphone
|
data.phoneNumber | string |
Numéro de téléphone |
|
Code pays
|
data.phoneCountryCode | string |
Code pays |
|
Rôles
|
data.roles | array of string |
Rôles |
|
Le courrier final est-il désactivé ?
|
data.finalMailDisabled | boolean |
Le courrier final est-il désactivé ? |
|
Le courrier de rappel est-il désactivé ?
|
data.reminderMailDisabled | boolean |
Le courrier de rappel est-il désactivé ? |
|
Le courrier de l’expéditeur est-il désactivé ?
|
data.senderMailDisabled | boolean |
Le courrier de l’expéditeur est-il désactivé ? |
|
L’utilisateur d’intégration est-il un utilisateur ?
|
data.integrationUser | boolean |
L’utilisateur d’intégration est-il un utilisateur ? |
|
Salutation
|
data.salutation | string |
Salutation |
|
Est actif
|
data.active | boolean |
Est actif |
|
Id
|
data.id | string |
Id |
|
Adresse électronique
|
data.emailAddress | string |
Adresse électronique |
Répertorier les utilisateurs
Répertorier les utilisateurs
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Numéro de page
|
pageNo | True | integer | |
|
Enreg. par page
|
perPageRecords | True | integer |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Code de statut
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
|
Nombre total d’enregistrements
|
data.totalRecords | integer |
nombre total d’enregistrements |
|
Total Pages
|
data.totalPages | integer |
Total Pages |
|
Enregistrements par page
|
data.perPageRecords | integer |
Enregistrements par page |
|
Numéro de page
|
data.pageNo | integer |
Numéro de page |
|
Enregistrements
|
data.records | array of object |
Enregistrements utilisateur |
|
Prénom
|
data.records.firstName | string |
Prénom |
|
Nom de famille
|
data.records.lastName | string |
Nom de famille |
|
Entreprise
|
data.records.company | string |
Entreprise |
|
Fuseau horaire
|
data.records.timezone | string |
Fuseau horaire |
|
Language
|
data.records.language | string |
Language |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Poste
|
data.records.jobTitle | string |
Poste |
|
Numéro de téléphone
|
data.records.phoneNumber | string |
Numéro de téléphone |
|
Code pays
|
data.records.phoneCountryCode | string |
Code pays |
|
Rôles
|
data.records.roles | array of string |
Rôles |
|
Le courrier final est-il désactivé ?
|
data.records.finalMailDisabled | boolean |
Le courrier final est-il désactivé ? |
|
Le courrier de rappel est-il désactivé ?
|
data.records.reminderMailDisabled | boolean |
Le courrier de rappel est-il désactivé ? |
|
Le courrier de l’expéditeur est-il désactivé ?
|
data.records.senderMailDisabled | boolean |
Le courrier de l’expéditeur est-il désactivé ? |
|
L’utilisateur d’intégration est-il un utilisateur ?
|
data.records.integrationUser | boolean |
L’utilisateur d’intégration est-il un utilisateur ? |
|
Salutation
|
data.records.salutation | string |
Salutation |
|
Est actif
|
data.records.active | boolean |
Est actif |
|
Id
|
data.records.id | string |
Id |
|
Adresse électronique
|
data.records.emailAddress | string |
Adresse électronique |
Supprimer l’abonnement
Supprimer l’abonnement
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Webhook Id
|
webhookId | True | string |
Identificateur unique de l’abonnement webhook à supprimer |
Télécharger des documents pour la transaction
Télécharger des documents pour l’ID de transaction donné
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de la transaction
|
transactionId | True | string |
ID de transaction unique |
|
Type de document
|
documentType | True | string |
Type de document à télécharger |
Retours
- response
- file
Déclencheurs
| Lorsqu’un état de transaction est modifié |
Inscrire un rappel pour un événement de transaction particulier |
Lorsqu’un état de transaction est modifié
Inscrire un rappel pour un événement de transaction particulier
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type d'événement
|
eventType | True | array |
Type d’événement de transaction à inscrire |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Code de statut
|
statusCode | integer |
Code de statut |
|
Message
|
message | string |
Message |
|
Nom de la transaction
|
data.name | string |
Nom de la transaction |
|
État de la transaction
|
data.status | string |
État de la transaction |
|
ID de la transaction
|
data.transactionId | string |
ID de la transaction |
|
Message
|
data.mail.message | string |
Message de tous les participants. |
|
Date de la dernière mise à jour
|
data.lastUpdatedDate | string |
Date de la dernière mise à jour |
|
Date de création
|
data.createdDate | string |
Date de création |
|
ID utilisateur
|
data.createdBy.id | string |
Créé par l’ID d’utilisateur |
|
Nom d’utilisateur
|
data.createdBy.username | string |
Créé par nom d’utilisateur |
|
Adresse électronique
|
data.createdBy.emailAddress | string |
Créé par adresse e-mail |
|
Date d’envoi
|
data.sentDate | string |
Date d’envoi |
|
ID utilisateur
|
data.lastActionPerformedBy.userId | string |
ID utilisateur |
|
Nom d'utilisateur
|
data.lastActionPerformedBy.userName | string |
Nom d'utilisateur |
|
Adresse électronique
|
data.lastActionPerformedBy.emailAddress | string |
Adresse électronique |
|
ID de candidat
|
data.lastActionPerformedBy.candidateId | string |
ID de candidat |
|
Participant Id
|
data.lastActionPerformedBy.participantId | string |
Participant Id |
|
Expire au moment de l’horodatage
|
data.expiryAndReminders.expiresAtTimestamp | string |
La transaction expire au moment de l’horodatage |
|
Jours d’expiration
|
data.expiryAndReminders.expiryDays | integer |
Jours d’expiration |
|
Rappeler des jours de rappel
|
data.expiryAndReminders.remindFromReminderDays | integer |
Rappeler des jours de rappel |
|
Rappeler à partir de l’heure du rappel
|
data.expiryAndReminders.remindFromReminderTime | string |
Rappeler à partir de l’heure du rappel |
|
Fréquence de rappel
|
data.expiryAndReminders.reminderFrequency | integer |
Fréquence de rappel |
|
Participants
|
data.participants | array of object |
Participants |
|
Participant Id
|
data.participants.id | string |
Participant Id |
|
État du participant
|
data.participants.status | string |
État du participant |
|
Date de la dernière mise à jour
|
data.participants.lastUpdatedDate | string |
Date de la dernière mise à jour |
|
Date de création
|
data.participants.createdDate | string |
Date de création |
|
Séquence de participants
|
data.participants.sequence | integer |
Sequence |
|
Role
|
data.participants.role | string |
Role |
|
Méthode de signature
|
data.participants.signingMethodDTO | array of string |
Détails de la méthode de signature |
|
Soumis par l’utilisateur
|
data.participants.submittedBys | array of object |
Détails soumis par l’utilisateur |
|
ID utilisateur
|
data.participants.submittedBys.userId | string |
Envoyé par l’ID de l’utilisateur |
|
Nom d'utilisateur
|
data.participants.submittedBys.userName | string |
Envoyé par nom d’utilisateur |
|
Adresse électronique
|
data.participants.submittedBys.emailAddress | string |
Adresse e-mail envoyée par l’utilisateur |
|
ID de candidat
|
data.participants.submittedBys.candidateId | string |
ID de candidat |
|
Candidats
|
data.participants.candidates | array of object |
Candidats |
|
ID de candidat
|
data.participants.candidates.id | string |
ID de candidat |
|
Nom
|
data.participants.candidates.name | string |
Nom du candidat |
|
Adresse électronique
|
data.participants.candidates.emailAddress | string |
Adresse e-mail du candidat |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Type
|
data.participants.candidates.type | string |
Type |
|
Action
|
data.participants.candidates.action | string |
Action |
|
Date d’action
|
data.participants.candidates.actionDate | string |
Date d’action |
|
Date de création
|
data.participants.candidates.createdDate | string |
Date de création |
|
Valeur du mode d’authentification
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Valeur du mode d’authentification |
|
détails de la méthode de signature
|
data.participants.candidates.signingMethodDTO | array of string |
détails de la méthode de signature |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Canaux de distribution
|
data.participants.candidates.deliveryChannels | array of string |
Canaux de distribution |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Id
|
data.participants.fields.id | string |
Id |
|
Date de la dernière mise à jour
|
data.participants.fields.lastUpdatedDate | string |
Date de la dernière mise à jour |
|
Date de création
|
data.participants.fields.createdDate | string |
Date de création |
|
ID de champ
|
data.participants.fields.fieldId | string |
ID de champ |
|
Page Non
|
data.participants.fields.pageNo | integer |
Page Non |
|
Document Id
|
data.participants.fields.documentId | string |
Document Id |
|
Largeur du champ
|
data.participants.fields.width | float |
Largeur du champ |
|
Hauteur du champ
|
data.participants.fields.height | float |
Hauteur du champ |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Valeur
|
data.participants.fields.value | string |
Valeur |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Afficher l’étiquette
|
data.participants.fields.displayLabel | string |
Afficher l’étiquette |
|
Type de lien
|
data.participants.fields.linkType | string |
Type de lien |
|
Radio Id
|
data.participants.fields.radioId | integer |
Radio Id |
|
ID du groupe radio
|
data.participants.fields.radioGroupId | string |
ID du groupe radio |
|
ID de case à cocher
|
data.participants.fields.checkboxId | integer |
ID de case à cocher |
|
Nom du champ
|
data.participants.fields.fieldName | string |
Nom du champ |
|
X Position
|
data.participants.fields.xposition | float |
Position X du champ |
|
Y Position
|
data.participants.fields.yposition | float |
Position Y du champ |
|
Est-il obligatoire ?
|
data.participants.fields.required | boolean |
Est-ce un champ obligatoire ? |
|
Est-ce que la lecture est en lecture seule ?
|
data.participants.fields.readOnly | boolean |
S’agit-il d’un champ Lecture seule ? |
|
Zone de texte
|
data.participants.fields.textarea | boolean |
Zone de texte |
|
Vertical
|
data.participants.fields.vertical | boolean |
Vertical |
|
Haut en bas
|
data.participants.fields.topBottom | boolean |
Haut en bas |
|
Valeur par défaut
|
data.participants.fields.defaultValue | string |
Valeur par défaut |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
Est-il obligatoire ?
|
data.participants.signatureBlock.format.required | boolean |
Est-il obligatoire ? |
|
Par défaut
|
data.participants.signatureBlock.default | boolean |
Par défaut |
|
Activer le délégué
|
data.participants.enableDelegate | boolean |
Activer le délégué |
|
Processus automatique
|
data.participants.autoProcess | boolean |
Processus automatique |
|
Utilisateurs CC
|
data.ccUsers | array of object |
Utilisateurs CC |
|
Nom
|
data.ccUsers.name | string |
Nom |
|
Adresse électronique
|
data.ccUsers.emailAddress | string |
Adresse électronique |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documents
|
data.documents | array of object |
Documents |
|
Document Id
|
data.documents.id | string |
Document Id |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Nom de fichier
|
data.documents.fileName | string |
Nom de fichier |
|
Nombre de pages
|
data.documents.pageCount | integer |
Nombre de pages |
|
Deletable ?
|
data.documents.deletable | boolean |
Deletable ? |
|
Est privé
|
data.documents.private | boolean |
Est privé |
|
Champs personnalisés
|
data.customFields | array of object |
Champs personnalisés |
|
ID de champ personnalisé
|
data.customFields.customFieldId | string |
ID de champ personnalisé |
|
Valeur de champ
|
data.customFields.value | string |
Valeur de champ |
|
Nom du champ
|
data.customFields.fieldName | string |
Nom du champ |
|
Type de champ
|
data.customFields.fieldType | string |
Type de champ |
|
Abonnements aux notifications
|
data.notificationSubscriptions | array of |
Abonnements aux notifications |
|
tags
|
data.tags | array of |
tags |
|
Documents supplémentaires
|
data.additionalDocuments | array of object |
Documents supplémentaires |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nom de fichier
|
data.additionalDocuments.fileName | string |
Nom de fichier |
|
Type
|
data.additionalDocuments.type | string |
Type |
|
ID de candidat
|
data.additionalDocuments.candidateId | string |
ID de candidat |
|
Contrats distincts
|
data.separateAgreements | boolean |
Contrats distincts |
Définitions
file
Il s’agit du type de données de base « fichier ».