PKIsigning (préversion)
Automatisez vos besoins de signature de document avec le connecteur de plateforme PKIsigning. Envoyer des documents à la plateforme PKIsigning ; envoyer des invitations et récupérer les documents signés.
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 | Prise en charge de PKIsigning |
| URL | https://pkisigning.nl/support |
| Messagerie électronique | support@pkisigning.nl |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | SBRS B.V. |
| Site internet | https://pkisigning.nl |
| Politique de confidentialité | https://pkisigning.nl/privacy |
| Catégories | Collaboration; Productivité |
PKIsigning permet aux organisations d’automatiser, de simplifier et de sécuriser le processus d’approbation, de signature et d’envoi de documents aux clients et aux tiers. La plateforme prend en charge tous les certificats de signature personnelle eIDAS provenant de fournisseurs de services approuvés qualifiés néerlandais et est certifié ISO27001. Cela rend PKIsigning un partenaire idéal pour les organisations juridiques, financières et médicales et les gouvernements. Connectez-vous avec PKisigning pour automatiser, simplifier et sécuriser votre processus de signature de document.
Prerequisites
Pour utiliser le connecteur PKIsigning, un compte à la plateforme PKIsigning est requis dans un abonnement « professionnel ». Veuillez contacter PKIsigning pour vous inscrire à un abonnement payant.
Comment obtenir des informations d’identification
Après l’inscription à un abonnement, les utilisateurs recevront un e-mail avec une invitation à configurer leur compte. Après l’inscription, ce compte peut être utilisé directement avec ce connecteur.
Bien démarrer avec votre connecteur
Le flux par défaut pour démarrer la signature de documents est le suivant :
- Créer un dossier
- Ajouter un ou plusieurs documents
- Ajouter un ou plusieurs acteurs
- Démarrer le flux de travail
- Utiliser un déclencheur pour recevoir une notification des modifications d’état
- Télécharger le dossier
Dossiers
PKIsigning vous attend à toujours créer un dossier en premier. Un dossier agit comme un conteneur pour les documents et les acteurs. Un dossier peut être créé avec l’action Dossiers_Create. Une fois un dossier créé, utilisez le PkisId retourné comme référence pour les actions futures.
Documents
Une fois qu’un dossier a été créé, vous pouvez ajouter des documents avec l’action de Documents_Add à l’aide du dossierId correct. L’action n’a pas besoin d’autres paramètres, car ils sont distraire des fichiers de document eux-mêmes. Il n’existe aucune limite pour le nombre de documents d’un dossier. Tous les documents seront visibles et téléchargeables pour tous les acteurs ajoutés.
Important : Le document a besoin d’un ou plusieurs espaces réservés textuels uniques, en fonction du nombre de signatures, pour indiquer où une signature doit être placée et par quel acteur. Il peut s’agir de n’importe quel texte dans n’importe quel emplacement dans le document. Lors de l’ajout d’acteurs, vous pouvez définir l’espace réservé avec le paramètre d’espace réservé. Par exemple : signature1, signature2, etc...
Acteurs
La troisième étape consiste à ajouter des acteurs aux documents. Cette opération est effectuée avec l’action de Actor_Create à l’aide de l’ID de dossier et du documentId corrects.
Démarrer le flux de travail
Pour démarrer un flux de travail et envoyer efficacement des invitations à tous les acteurs à signer ou télécharger des documents dans l’ordre fourni, utilisez l’action Dossiers_StartWorkflow avec le dossierId correct.
Utiliser un déclencheur pour recevoir une notification des modifications d’état
Pour obtenir le document une fois qu’il a été signé, abonnez-vous aux notifications à l’aide d’un déclencheur. Pour recevoir la notification d’état, spécifiez « status » dans le champ Événements.
Télécharger le dossier
Lorsque le déclencheur est averti d’une mise à jour d’état, vérifiez si l’état du document est « Terminé ». À ce stade, il est possible de télécharger tous les documents du dossier dans un seul fichier zipfile. S’il est spécifié dans les paramètres de la plateforme PKIsigning qu’un audittrail doit être généré, cela sera également inclus.
Problèmes connus et limitations
Aucun problème n’est connu au moment de la publication.
Erreurs courantes et solutions
Aucune mise à jour d’état par le biais du déclencheur
Si le déclencheur ne répond pas aux mises à jour d’état, vérifiez si la valeur « status » a été fournie dans le champ Événements.
Erreur HTTP 402 Paiement requis
La plateforme PKIsigning a requis des crédits pour effectuer des actions. Lorsque des acteurs sont ajoutés, les crédits sont réservés pour s’assurer que l’action peut se produire et que les invités ne sont pas confrontés à des problèmes concernant un nombre insuffisant de crédits disponibles. Si beaucoup d’invitations sont envoyées aux acteurs, cela peut se produire que l’offre groupée de crédit n’a plus de crédits laissés pour être réservés. À ce stade, une erreur HTTP 402 est retournée.
Pour résoudre le problème, la prise en charge de PKIsigning pour top-up du solde de crédit ou nettoyer tous les dossiers non envoyés avec des acteurs de la corbeille sur la plateforme. Les crédits inutilisés seront ensuite à nouveau disponibles.
Questions fréquentes (FAQ)
Consultez notre base de connaissances ou contactez-nous à l’adresse support@pkisigning.nl
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer un acteur |
Crée un acteur et l’ajoute à un document. |
| Créer un document |
Crée un document et l’ajoute à une requête spécifique. |
| Créer une demande |
Créez une demande. |
| Demande de téléchargement |
Télécharge une demande et son contenu en tant que fichier .zip. |
| Envoyer une demande |
Démarre le flux de travail et envoie une invitation au premier acteur en ligne pour une demande spécifique. |
| Mettre à jour la demande |
Modifie les données d’une requête spécifique. |
| Mettre à jour le document |
Modifie les données d’un document spécifique. |
| Mettre à jour l’acteur |
Modifie les données d’un acteur spécifique. |
| Obtenir des données de document |
Retourne toutes les (méta)données d’un document spécifique. |
| Obtenir des données de requête |
Retourne toutes les données (meta)pour une requête spécifique. |
| Obtenir des données d’acteur |
Retourne toutes les données d’un acteur spécifique. |
| Obtenir des données d’acteur par demande |
Retourne toutes les données de tous les acteurs pour une requête spécifique. |
| Obtenir des données d’acteur par document |
Retourne toutes les données de tous les acteurs d’un document spécifique. |
| Obtenir des groupes de travail pour l’organisation |
Retourne la liste de tous les groupes de travail d’une organisation spécifique. |
| Obtenir des groupes de travail pour l’utilisateur |
Retourne la liste de tous les groupes de travail pour un utilisateur spécifique d’une organisation spécifique. |
| Renvoyer une invitation |
Renvoie l’invitation de l’acteur actuel en ligne pour une demande spécifique. |
| Retirer l’invitation |
Retire l’invitation de l’acteur actuel en ligne pour une demande spécifique. |
| Supprimer l’acteur |
Supprime définitivement un acteur spécifique. |
| Supprimer un document |
Supprime définitivement un document spécifique. |
| Supprimer une demande |
Supprime définitivement une requête spécifique. |
Créer un acteur
Crée un acteur et l’ajoute à un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
|
Action
|
action | True | string |
Action que l’acteur doit effectuer. |
|
Prénom
|
firstname | True | string |
Prénom de l’acteur. |
|
Préfixe
|
prefix | string |
Préfixe de l’acteur. |
|
|
Nom
|
lastname | True | string |
Nom de l’acteur. |
|
Adresse de messagerie
|
True | string |
Adresse e-mail de l’acteur. |
|
|
Numéro de téléphone mobile
|
mobile | True | string |
Numéro de téléphone mobile de l’acteur. |
|
Échéance
|
deadline | True | date-time |
Date et heure de l’exécution de l’action par l’acteur. |
|
Language
|
language | True | string |
Langue de l’invitation. |
|
Utiliser une vérification forte
|
validateRealIdentity | True | boolean |
Utilisez une méthode d’identification plus forte pour cet acteur. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
Message
|
message | string | ||
|
Champ de signature
|
fieldName | string |
Nom d’un champ de signature existant dans le document pour que cet acteur se connecte. |
|
|
Placeholder
|
placeholder | string |
Texte d’un espace réservé spécifique dans le document où l’acteur doit placer une signature. |
Retours
- Corps
- ExtendedSignerModel
Créer un document
Crée un document et l’ajoute à une requête spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête à laquelle ce document appartiendra. |
|
Fichier
|
file | True | file |
Fichier à traiter (uniquement des types de fichiers spécifiques). |
Retours
Métadonnées générales du document
- Corps
- DocumentMetaDataModel
Créer une demande
Créez une demande.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de la requête
|
name | True | string |
Nom d’une demande spécifique. |
|
ID du groupe de travail
|
workgroupId | guid |
ID unique d’un groupe de travail. |
|
|
Niveau d’autorisation de sécurité
|
clearancelevel | True | integer |
Niveau d’autorisation de sécurité pour une demande spécifique. |
|
Propriétaire de la demande
|
owner |
Utilisateur qui est le propriétaire d’une demande spécifique. |
Retours
- Corps
- RequestModel
Demande de téléchargement
Télécharge une demande et son contenu en tant que fichier .zip.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
Retours
- response
- file
Envoyer une demande
Démarre le flux de travail et envoie une invitation au premier acteur en ligne pour une demande spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
Mettre à jour la demande
Modifie les données d’une requête spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Nom de la requête
|
name | True | string |
Nom d’une demande spécifique. |
|
ID du groupe de travail
|
workgroupId | guid |
ID unique d’un groupe de travail. |
|
|
Niveau d’autorisation de sécurité
|
clearancelevel | True | integer |
Niveau d’autorisation de sécurité pour une demande spécifique. |
|
Propriétaire de la demande
|
owner |
Utilisateur qui est le propriétaire d’une demande spécifique. |
Retours
- Corps
- RequestModel
Mettre à jour le document
Modifie les données d’un document spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
|
Nom du document
|
name | string |
Nom d’un document spécifique |
|
|
Nom du fichier de document
|
filename | string |
Nom de fichier pour un document spécifique |
|
|
Type de document
|
documentType | True | string |
Type d’un document spécifique. (Par exemple, PDF standard, relevé fiscal, rapport des vérificateurs, etc.). |
Retours
Métadonnées générales du document
- Corps
- DocumentMetaDataModel
Mettre à jour l’acteur
Modifie les données d’un acteur spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
|
ID d’acteur
|
actorId | True | guid |
ID unique d’un acteur. |
|
Action
|
action | True | string |
Action que l’acteur doit effectuer. |
|
Prénom
|
firstname | True | string |
Prénom de l’acteur. |
|
Préfixe
|
prefix | string |
Préfixe de l’acteur. |
|
|
Nom
|
lastname | True | string |
Nom de l’acteur. |
|
Adresse de messagerie
|
True | string |
Adresse e-mail de l’acteur. |
|
|
Numéro de téléphone mobile
|
mobile | True | string |
Numéro de téléphone mobile de l’acteur. |
|
Échéance
|
deadline | True | date-time |
Date et heure de l’exécution de l’action par l’acteur. |
|
Language
|
language | True | string |
Langue de l’invitation. |
|
Utiliser une vérification forte
|
validateRealIdentity | True | boolean |
Utilisez une méthode d’identification plus forte pour cet acteur. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
Message
|
message | string |
Retours
- Corps
- ExtendedSignerModel
Obtenir des données de document
Retourne toutes les (méta)données d’un document spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
Retours
Métadonnées générales du document
- Corps
- DocumentMetaDataModel
Obtenir des données de requête
Retourne toutes les données (meta)pour une requête spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Clé d’authentification
|
callbackAuthenticationKey | string |
Clé d’authentification fournie par le déclencheur. |
Retours
- Corps
- RequestModel
Obtenir des données d’acteur
Retourne toutes les données d’un acteur spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
|
ID d’acteur
|
actorId | True | guid |
ID unique d’un acteur. |
Retours
- Corps
- ExtendedSignerModel
Obtenir des données d’acteur par demande
Retourne toutes les données de tous les acteurs pour une requête spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
L’acteur a agi sur la demande
|
hasActed | boolean |
Lisez uniquement la valeur pour vérifier si un acteur a déjà agi sur le document. |
Retours
- response
- array of ExtendedSignerModel
Obtenir des données d’acteur par document
Retourne toutes les données de tous les acteurs d’un document spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
|
Action terminée
|
hasActed | boolean |
Retourne uniquement les acteurs qui ont ou n’ont pas terminé leur action, laissez vide pour renvoyer tous les acteurs. |
Retours
- response
- array of ExtendedSignerModel
Obtenir des groupes de travail pour l’organisation
Retourne la liste de tous les groupes de travail d’une organisation spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation
|
organisationId | True | guid |
ID unique d’une organisation. |
Retours
- response
- array of OrganisationWorkgroup
Obtenir des groupes de travail pour l’utilisateur
Retourne la liste de tous les groupes de travail pour un utilisateur spécifique d’une organisation spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’organisation
|
organisationId | True | guid |
ID unique d’une organisation. |
|
Nom d’utilisateur
|
username | True |
Adresse e-mail de l’utilisateur |
Retours
- response
- array of OrganisationWorkgroup
Renvoyer une invitation
Renvoie l’invitation de l’acteur actuel en ligne pour une demande spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
Retirer l’invitation
Retire l’invitation de l’acteur actuel en ligne pour une demande spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
Supprimer l’acteur
Supprime définitivement un acteur spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
|
ID d’acteur
|
actorId | True | guid |
ID unique d’un acteur. |
Supprimer un document
Supprime définitivement un document spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
|
Document ID
|
documentId | True | guid |
ID unique d’un document. |
Supprimer une demande
Supprime définitivement une requête spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
requestId | True | guid |
ID unique d’une requête. |
Déclencheurs
| Lorsqu’un événement se produit sur une demande |
Inscrivez une URL pour le rappel lors d’une modification d’état. La plateforme PKIsigning signale toutes les mises à jour d’état des dossiers au sein de cette organisation à cette URL. |
Lorsqu’un événement se produit sur une demande
Inscrivez une URL pour le rappel lors d’une modification d’état. La plateforme PKIsigning signale toutes les mises à jour d’état des dossiers au sein de cette organisation à cette URL.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Types d’événements
|
Events | True | array of string |
Liste des types d’événements qui se produisent sur une demande dont ce déclencheur sera averti |
|
ID d’organisation
|
organisationId | True | guid |
ID unique d’une organisation. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Demande d'ID
|
PkisId | guid |
ID unique d’une requête. |
|
État de la demande
|
DossierStatus | string |
État du dossier. |
|
Reason
|
Reason | string |
Raison du changement. |
|
Clé d’authentification
|
AuthenticationKey | string |
En-tête pour obtenir des métadonnées sur la demande. |
Définitions
ExtendedSignerModel
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champ de signature
|
fieldName | string |
Nom d’un champ de signature existant dans le document pour que cet acteur se connecte. |
|
Placeholder
|
placeholder | string |
Texte d’un espace réservé spécifique dans le document où l’acteur doit placer une signature. |
|
Action
|
action | string |
Action que l’acteur doit effectuer. |
|
Prénom
|
firstname | string |
Prénom de l’acteur. |
|
Préfixe
|
prefix | string |
Préfixe de l’acteur. |
|
Nom
|
lastname | string |
Nom de l’acteur. |
|
Adresse de messagerie
|
string |
Adresse e-mail de l’acteur. |
|
|
Numéro de téléphone mobile
|
mobile | string |
Numéro de téléphone mobile de l’acteur. |
|
Échéance
|
deadline | date-time |
Date et heure de l’exécution de l’action par l’acteur. |
|
Language
|
language | string |
Langue de l’invitation. |
|
Utiliser une vérification forte
|
validateRealIdentity | boolean |
Utilisez une méthode d’identification plus forte pour cet acteur. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
Message
|
message | string | |
|
ID d’acteur
|
id | guid |
ID unique d’un acteur spécifique. |
|
Date de fin
|
signingDate | date-time |
Date et heure auxquelles l’acteur a effectué son action. |
|
Action terminée
|
hasSigned | boolean | |
|
Nom complet
|
fullName | string |
Prénom, préfixe et nom combinés de l’acteur. |
|
Informations d’état
|
emailActivity | array of EmailActivity |
Informations d’état sur le processus d’exécution de l’action par l’acteur. |
|
documentId
|
documentId | guid |
EmailActivity
Métadonnées de l’envoi d’e-mail à un acteur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Activité de courrier électronique
|
event | string |
Activité de messagerie pour une demande et un acteur spécifiques. |
|
Informations SMTP
|
reason | string |
Informations SMTP pour un e-mail envoyé à un acteur spécifique dans le cadre d’une demande. |
|
Date de messagerie
|
timestamp | date-time |
Date d’un e-mail envoyé à un acteur spécifique dans le cadre d’une demande. |
|
Type d’e-mail
|
pkisMessageType | string |
Tapez un e-mail envoyé à un acteur spécifique dans le cadre d’une demande (par exemple, Inviter, Rappeler, etc.). |
|
ID de demande d’e-mail
|
pkisInviteId | string |
ID unique d’un e-mail envoyé à un acteur spécifique dans le cadre d’une demande. |
|
Adresse de messagerie
|
string |
Adresse e-mail d’un e-mail envoyé à un acteur spécifique dans le cadre d’une demande. |
SignerModel
Type spécial d’acteur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Action
|
action | string |
Action que l’acteur doit effectuer. |
|
Prénom
|
firstname | string |
Prénom de l’acteur. |
|
Préfixe
|
prefix | string |
Préfixe de l’acteur. |
|
Nom
|
lastname | string |
Nom de l’acteur. |
|
Adresse de messagerie
|
string |
Adresse e-mail de l’acteur. |
|
|
Numéro de téléphone mobile
|
mobile | string |
Numéro de téléphone mobile de l’acteur. |
|
Échéance
|
deadline | date-time |
Date et heure de l’exécution de l’action par l’acteur. |
|
Language
|
language | string |
Langue de l’invitation. |
|
Utiliser une vérification forte
|
validateRealIdentity | boolean |
Utilisez une méthode d’identification plus forte pour cet acteur. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
Message
|
message | string | |
|
Champ de signature
|
fieldName | string |
Nom d’un champ de signature existant dans le document pour que cet acteur se connecte. |
|
Placeholder
|
placeholder | string |
Texte d’un espace réservé spécifique dans le document où l’acteur doit placer une signature. |
DocumentMetaDataModel
Métadonnées générales du document
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom du document
|
name | string |
Nom d’un document spécifique. |
|
Dernière mise à jour du document
|
lastUpdate | date-time |
Date de la dernière mise à jour d’un document spécifique. |
|
Nombre de pages de document
|
pages | integer |
Nombre de pages pour un document spécifique. |
|
Date de création de document
|
created | date-time |
Date de création d’un document spécifique. |
|
Document ID
|
id | guid |
ID unique d’un document. |
|
État du document
|
status | string |
État d’un document spécifique. (par exemple, nouveau, terminé, etc.). |
|
Le document contient la signature
|
signed | boolean |
Indique si un document spécifique contient déjà une ou plusieurs signatures. |
|
Signatures de document
|
signatures | array of SignatureData |
Liste de toutes les signatures d’un document spécifique. |
|
Champs de signature vides du document
|
emptySignatureFields | array of SignatureField |
Liste de tous les champs de signature vides d’un document spécifique. |
|
Champs de signature vides
|
containsBlankSignatureFields | boolean |
Indique si un document spécifique contient des champs de signature vides. |
|
Acteurs de document
|
actors | array of ExtendedSignerModel |
Liste de tous les acteurs d’un document spécifique. |
|
Demande d'ID
|
requestId | guid |
ID unique d’une requête. |
|
Index de requête
|
dossierIndex | integer |
Index de tous les documents appartenant à une requête spécifique. |
|
documentSize
|
documentSize | integer |
Taille d’un document appartenant à une requête spécifique. |
|
documentType
|
documentType | string |
Type d’un document appartenant à une demande spécifique. |
SignatureData
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Champs de l’objet du certificat
|
subject | array of KeyValuePairOfStringAndString |
Champs de la ligne d’objet du certificat utilisé pour une signature spécifique. |
|
Champs de l’émetteur de certificat
|
issuer | array of KeyValuePairOfStringAndString |
Champs de la ligne émetteur du certificat utilisé pour une signature spécifique. |
|
Date de signature
|
date | date-time |
Date et heure à laquelle une signature spécifique a été placée. |
|
Emplacement de signature
|
location | string |
Emplacement géographique d’un acteur spécifique au moment de la signature. |
|
Raison de signature
|
reason | string |
Raison de la signature fournie par un acteur spécifique au moment de la signature. |
|
Signature électronique qualifiée
|
euQualified | boolean |
Indique si une signature spécifique est qualifiée (QeS) conforme aux réglementations eIDAS. |
|
Signature électronique avancée
|
advanced | boolean |
Indique si une signature spécifique est avancée (AeS) conforme aux réglementations eIDAS. |
|
ESeal qualifié
|
eSeal | boolean |
Indique si un certificat spécifique utilisé pour la signature ou le scellement est une réglementation eSeal conforme eIDAS qualifiée. |
|
Adresse IP de l’acteur
|
ipAddress | string |
Adresse IP d’un acteur spécifique |
|
Champ signature
|
signatureField | string |
Champ signé |
|
Image de signature
|
signatureImage | string |
Fichier image utilisé pour une signature spécifique choisie par un acteur. |
KeyValuePairOfStringAndString
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | string |
SignatureField
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom du champ signature
|
name | string |
Nom d’un champ de signature spécifique |
|
Page du champ Signature
|
page | integer |
Page où un champ de signature spécifique est placé pour un document spécifique. |
|
Coordonnée de largeur de champ de signature
|
x | double |
Valeur de largeur de la position d’un champ de signature spécifique par rapport à la page qu’elle est placée dans un document spécifique. |
|
Coordonnée élevée du champ de signature
|
y | double |
Valeur élevée de la position d’un champ de signature spécifique par rapport à la page qu’elle est placée dans un document spécifique. |
|
Champ de signature élevé
|
height | double |
Valeur élevée pour un champ de signature spécifique. |
|
Largeur du champ signature
|
width | double |
Valeur de largeur pour un champ de signature spécifique. |
OrganisationWorkgroup
Groupe de travail utilisé dans un dossier
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID du groupe de travail
|
id | guid |
ID unique d’un groupe de travail |
|
Nom du groupe de travail
|
name | string |
Nom d’un groupe de travail spécifique |
RequestModel
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Demande d'ID
|
id | guid |
ID unique d’une requête |
|
Nom de la requête
|
dossierName | string |
Nom d’une demande spécifique. |
|
Demander des documents
|
documents | array of DocumentModel |
Liste des documents inclus dans cette demande. |
|
État de la demande
|
status | string |
État d’une demande spécifique. (par exemple, nouveau, terminé, etc.). |
|
Acteurs de demande
|
actors | array of ExtendedSignerModel |
Liste de tous les acteurs pour une requête spécifique. |
|
Signatures de document
|
signatures | array of SignatureData |
Liste de toutes les signatures pour une demande spécifique. |
|
Type de requête
|
dossierType | string |
Type d’une requête spécifique. (E.g. PDF, SBR Assurance, etc.). |
|
Raison de l’annulation
|
reasons | string |
Raison de l’annulation d’une demande spécifique par un utilisateur ou un acteur. |
|
Note du signataire
|
signerNote | string |
Notez qu’un ou plusieurs acteurs n’ont aucune autre action que le signe. |
|
Note du destinataire
|
recipientNote | string |
Notez qu’un ou plusieurs acteurs n’ont aucune autre action que le téléchargement. |
|
Note d’approbateur
|
accorderNote | string |
Notez qu’un ou plusieurs acteurs n’ont aucune autre action que la demande d’approbation. |
|
Date d’expiration de la demande
|
expires | date-time |
Date et heure d’expiration d’une requête spécifique. |
|
Informations d’état
|
emailActivity | array of EmailActivity |
Informations d’état sur le processus d’exécution de l’action par l’acteur. |
|
Ma demande
|
myDossier | boolean |
Indique si vous êtes le propriétaire d’une demande spécifique. |
|
ID du groupe de travail
|
workgroup | guid |
ID unique d’un groupe de travail. |
|
Niveau d’autorisation de sécurité
|
clearancelevel | integer |
Niveau d’autorisation de sécurité pour une demande spécifique. |
DocumentModel
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Document ID
|
id | guid |
ID unique d’un document |
|
Nom du document
|
name | string |
Nom d’un document spécifique |
|
Type de document
|
documentType | string |
Tapez un document spécifique. |
|
Index de requête
|
dossierIndex | integer |
Index de tous les documents appartenant à une requête spécifique. |
|
État du document
|
documentstatus | string |
État d’un document spécifique. (par exemple, nouveau, terminé, etc.). |
|
Acteurs de document
|
actors | array of SignerModel |
Liste de tous les acteurs d’un document spécifique. |
file
Il s’agit du type de données de base « fichier ».