Vérifié
Connecteur pour l’API vérifiée pour permettre la création de processus de signature de documents personnalisé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 | Vérifié |
| URL | https://verified.eu/en/#about-us |
| Messagerie électronique | support@verified.eu |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Crm - Konsulterna i Sverige AB |
| Site internet | https://verified.eu/ |
| Politique de confidentialité | https://verified.eu/trust-center |
| Catégories | Contenu et fichiers ; Productivité |
Vérifié est un fournisseur de logiciels en tant que service d’identification électronique et de signature numérique. Ce connecteur permet d’intégrer à l’API Vérifié et de créer des processus de signature simples et intuitifs au sein de votre application.
Prerequisites
Vous devez procéder comme suit :
- S’inscrire à un compte vérifié
Comment obtenir des informations d’identification
Ce connecteur utilise l’authentification de base. L’utilisateur doit présenter le nom d’utilisateur, le mot de passe et l’ID d’entreprise lors de la création d’une connexion. Le nom d’utilisateur et le mot de passe sont les mêmes que ceux que vous utilisez pour vous connecter au portail vérifié. Pour obtenir l’ID d’entreprise que vous devez vous connecter au portail vérifié, sélectionnez la société appropriée si vous avez plusieurs et copiez l’ID de l’entreprise à partir de l’URL.
Get started
Un cas d’usage courant consiste à démarrer et à gérer un processus de signature, c’est-à-dire la configuration de l’automatisation de l’envoi de documents à signer auprès de Vérifications et d’obtention de documents signés régulièrement. Les actions courantes utilisées pour démarrer un processus de signature vérifié incluent Créer une enveloppe - descripteur ou Créer une enveloppe - par défaut, Ajouter un document à l’enveloppe, Ajouter un fichier au document, Ajouter un destinataire à l’enveloppe et mettre à jour l’état de publication pour l’enveloppe. Les actions courantes utilisées pour vérifier l’état vérifié des documents incluent Obtenir l’enveloppe par ID, Obtenir tous les documents par ID d’enveloppe, Obtenir des fichiers par ID de document, Obtenir l’URL du fichier par ID. Notez que l’action Générer un jeton de sécurité est toujours utilisée comme première étape pour obtenir un jeton de sécurité à utiliser dans les étapes suivantes.
Problèmes connus et limitations
Les limitations suivantes sont actuellement connues.
- Au début de chaque flux, il faut créer un jeton d’authentification à réutiliser à chaque étape suivante.
- Pour ajouter un document, il faut envoyer une requête HTTP à une url spécifique.
- Pour utiliser le nouveau point de terminaison de recherche, il doit être activé pour le compte via le suppoert vérifié.
Questions fréquentes (FAQ)
Comment charger un document sur Vérifié ?
Pour charger un document réel, vous devez créer un fichier dans l’API Vérifié et charger le hachage de document dans l’URL de l’objet blob a répondu à partir de l’API vérifiée.
Comment obtenir une conservation de l’enveloppe après l’utilisation de l’action Obtenir l’ID d’enveloppe ?
Les étapes qui créent une enveloppe répondent avec un uid, qui est un chemin d’accès complet à l’enveloppe (par exemple : « /envelopes/ABCDE »). Pour les autres étapes, il n’est nécessaire que la dernière partie de l’uid (qui est l’ID d’enveloppe réel, dans notre exemple « ABCDE »).
Voici un exemple sur la façon de procéder
substring(outputs('Create_new_default_envelope')?['body/uid'],11)
Comment obtenir la conservation de l’ID de document après l’utilisation de l’action Ajouter un document à l’enveloppe ?
Les étapes qui créent un document répondent avec l’emplacement du nouveau document dans l’en-tête. L’emplacement est le chemin d’accès complet au document (exemple : « /api/envelopes/ABCDE/documents/FGHIJ »). Seul l’ID de document (dans notre cas : FGHIJ) est nécessaire pour les étapes suivantes.
Voici un exemple sur la façon de procéder
substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))
Comment obtenir la conservation de l’ID de flux à partir d’une enveloppe ?
Lorsque l’on charge des informations sur une enveloppe, le flux associé fait partie de la réponse (par exemple : « /flow/default »). Dans la réponse, elle est appelée l’ID d’un flux, mais il n’en a besoin que la dernière partie quand une autre étape (par exemple, obtenir l’état du flux) demande l’ID de flux.
Voici un exemple sur la façon de procéder
substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)
Comment puis-je utiliser la nouvelle action de recherche ?
Pour pouvoir utiliser la nouvelle action de recherche, le point de terminaison de recherche doit être activé pour votre organisation vérifiée. Pour ce faire, vous devez écrire un e-mail au support vérifié, y compris votre ID d’organisation afin qu’il puisse activer le point de terminaison pour vous.
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 |
|---|---|---|---|
| nom d'utilisateur | securestring | Nom d’utilisateur de cette API | Vrai |
| mot de passe | securestring | Mot de passe de cette API | Vrai |
| ID d’entreprise | ficelle | L’ID d’entreprise est fourni par Vérifié. Se trouve dans l’URL en vous connectant à app.verified.eu | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un destinataire à l’enveloppe |
Ajoute un destinataire à une enveloppe donnée. |
| Ajouter un document à l’enveloppe |
Ajoute un nouveau document à une enveloppe existante. |
| Ajouter un fichier à un document |
Ajoute un fichier à un document existant. |
| Créer un lien de signature |
Crée un lien de signature. L’implémentation est spécifique au flux et peut être manquante pour votre flux spécifique. |
| Créer une enveloppe - descripteur |
Crée une enveloppe basée sur un descripteur spécifique. |
| Créer une enveloppe - valeur par défaut |
Crée une enveloppe à l’aide du descripteur par défaut. |
| Définir l’état de la corbeille d’enveloppe |
Définit l’état d’une enveloppe donnée à corbeille. |
| Définir l’état de l’abandon de l’enveloppe |
Définit l’état d’une enveloppe donnée à abandonnée. |
| Définir l’état de l’abandon du document |
Définit l’état d’un document donné sur abandonné. |
| Envoyer une notification |
Envoie une notification aux destinataires d’une enveloppe donnée. |
| Générer un document à partir d’un modèle |
Génère un document à partir d’un modèle préconfiguré. |
| Générer un jeton de sécurité |
Obtient le jeton d’authentification de l’API vérifiée. |
| Interroger toutes les enveloppes (déconseillées) |
Interroge toutes les enveloppes correspondant à un filtre donné. (Obsolète) |
| Mettre à jour le destinataire par ID |
Met à jour un destinataire. |
| Mettre à jour les paramètres d’enveloppe |
Met à jour les paramètres d’une enveloppe donnée. |
| Mettre à jour l’état de publication pour l’enveloppe |
Met à jour l’état de publication d’une enveloppe donnée. |
| Obtenir des fichiers par ID de document |
Obtient tous les fichiers connectés à un document donné. |
| Obtenir des informations utilisateur |
Obtient des informations de l’utilisateur actuellement connecté. |
| Obtenir le descripteur par défaut |
Obtient le descripteur par défaut pour les enveloppes. |
| Obtenir le descripteur par ID |
Obtient des informations d’un descripteur donné. |
| Obtenir les paramètres utilisateur |
Obtient les paramètres d’un utilisateur donné. |
| Obtenir l’entreprise par ID |
Obtient des informations d’une société donnée. |
| Obtenir l’enveloppe par ID |
Obtient les détails d’une enveloppe donnée. |
| Obtenir l’URL du fichier par ID |
Obtient l’URL d’un fichier donné. |
| Obtenir l’état du flux par ID d’enveloppe |
Obtient l’état actuel du flux d’une enveloppe donnée. |
| Obtenir tous les descripteurs |
Obtient la liste de tous les descripteurs présents dans la société actuelle. La liste peut être filtrée. |
| Obtenir tous les destinataires de l’enveloppe |
Obtient tous les destinataires d’une enveloppe donnée. |
| Obtenir tous les documents par ID d’enveloppe |
Obtient tous les documents liés à une enveloppe donnée. |
| Obtenir un destinataire spécifique pour une enveloppe |
Obtient un destinataire spécifique pour une enveloppe donnée. |
| Obtenir un document par ID |
Obtient des informations d’un document donné. |
| Obtenir un fichier par ID |
Obtient des informations sur un fichier donné. |
| Rechercher toutes les enveloppes |
Recherchez toutes les enveloppes correspondant à un filtre donné. |
| Supprimer le document par ID |
Supprime un document donné. |
| Supprimer l’enveloppe par ID |
Supprime une enveloppe donnée. |
Ajouter un destinataire à l’enveloppe
Ajoute un destinataire à une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Prénom
|
givenName | True | string | |
|
Nom de famille
|
familyName | True | string | |
|
Language
|
language | True | string | |
|
Méthode de signature
|
signingMethod | True | string | |
|
Méthode de notification
|
notificationMethod | string | ||
|
Courriel
|
True | string | ||
|
Téléphone
|
telephone | string |
Le format doit être +<countryCode><telephonenumber> |
|
|
JSON
|
order | integer | ||
|
Action
|
action | True | string |
Le nom de l’action vérifiée qu’un destinataire doit exécuter. |
|
Étiquette
|
label | True | string |
Étiquette pour le rôle/l’action d’un destinataire |
|
Nom
|
name | True | string |
Nom vérifié du rôle d’un destinataire |
|
Secure
|
secure | boolean | ||
|
sms
|
sms | boolean | ||
|
Numéro de sécurité sociale
|
ssn | string | ||
|
Banque
|
bank | string |
Ajouter un document à l’enveloppe
Ajoute un nouveau document à une enveloppe existante.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Hash
|
hash | integer | ||
|
Nom
|
name | True | string | |
|
Origine
|
source | string |
Ajouter un fichier à un document
Ajoute un fichier à un document existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
|
Nom
|
name | True | string | |
|
FileType
|
fileType | True | string | |
|
Hash
|
hash | string |
Retours
- Fichier
- File
Créer un lien de signature
Crée un lien de signature. L’implémentation est spécifique au flux et peut être manquante pour votre flux spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Id
|
id | string | ||
|
Rediriger vers
|
redirectTo | uri |
URL complète pour rediriger l’utilisateur vers une signature après la signature. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
getSignLink.recipient.{recipient-id}.url | string |
Créer une enveloppe - descripteur
Crée une enveloppe basée sur un descripteur spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID du descripteur d’enveloppe
|
envelope-descriptor-id | True | string |
ID du descripteur d’enveloppe |
|
Messagerie électronique
|
string | |||
|
Prénom
|
givenName | string | ||
|
Nom de famille
|
familyName | string | ||
|
Rappels automatiques
|
automaticReminders | number | ||
|
Expiration
|
expiration | string | ||
|
Hash
|
hash | string |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
uid
|
uid | string |
Créer une enveloppe - valeur par défaut
Crée une enveloppe à l’aide du descripteur par défaut.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
Messagerie électronique
|
string | |||
|
Prénom
|
givenName | string | ||
|
Nom de famille
|
familyName | string | ||
|
Rappels automatiques
|
automaticReminders | number | ||
|
Expiration
|
expiration | string | ||
|
Hash
|
hash | string |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
uid
|
uid | string |
Définir l’état de la corbeille d’enveloppe
Définit l’état d’une enveloppe donnée à corbeille.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Commentaire
|
comment | string |
Définir l’état de l’abandon de l’enveloppe
Définit l’état d’une enveloppe donnée à abandonnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
commentaire
|
comment | string |
Définir l’état de l’abandon du document
Définit l’état d’un document donné sur abandonné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
Envoyer une notification
Envoie une notification aux destinataires d’une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Salutation
|
greeting | string | ||
|
ID du destinataire
|
id | True | string |
ID du destinataire auquel la notification doit être envoyée. |
Générer un document à partir d’un modèle
Génère un document à partir d’un modèle préconfiguré.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
|
ID de modèle
|
template-id | True | string |
ID du modèle qui doit être utilisé |
|
|
object |
Générer un jeton de sécurité
Obtient le jeton d’authentification de l’API vérifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Sans verrou IP
|
withoutIpLock | True | integer |
Indique si La vérification active le verrou IP (0, valeur par défaut) ou non (1) |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Jeton
|
token | string |
Access token (Jeton d’accès) |
Interroger toutes les enveloppes (déconseillées)
Interroge toutes les enveloppes correspondant à un filtre donné. (Obsolète)
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
Filtres
|
filters | string |
Filtrer la requête pour sélectionner un sous-montage |
|
|
De
|
from | integer |
À partir de la date |
|
|
Limit
|
limit | integer |
Limite de la quantité |
|
|
Trier
|
sort | string |
Trier par |
Retours
- response
- array of EnvelopeDescriptorString
Mettre à jour le destinataire par ID
Met à jour un destinataire.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
ID du destinataire
|
recipient-id | True | string |
ID des destinataires en question |
|
Prénom
|
givenName | True | string | |
|
Nom de famille
|
familyName | True | string | |
|
Language
|
language | True | string | |
|
Méthode de signature
|
signingMethod | True | string | |
|
Méthode de notification
|
notificationMethod | string | ||
|
Courriel
|
True | string | ||
|
Téléphone
|
telephone | string |
Le format doit être +<countryCode><telephonenumber> |
|
|
JSON
|
order | integer | ||
|
Action
|
action | True | string |
Le nom de l’action vérifiée qu’un destinataire doit exécuter. |
|
Étiquette
|
label | True | string |
Étiquette pour le rôle/l’action d’un destinataire |
|
Nom
|
name | True | string |
Nom vérifié du rôle d’un destinataire |
|
Secure
|
secure | boolean | ||
|
sms
|
sms | boolean | ||
|
Numéro de sécurité sociale
|
ssn | string | ||
|
Banque
|
bank | string |
Mettre à jour les paramètres d’enveloppe
Met à jour les paramètres d’une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Signature séquentielle
|
sequentialSigning | boolean | ||
|
Salutation
|
greeting | string | ||
|
Expiration
|
expiration | date |
Date au format suivant 2017-02-26T21:59:59.999Z |
|
|
Rappels automatiques
|
automaticReminders | number |
X Jours avant l’expiration |
Mettre à jour l’état de publication pour l’enveloppe
Met à jour l’état de publication d’une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Publiée
|
published | True | boolean |
Obtenir des fichiers par ID de document
Obtient tous les fichiers connectés à un document donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
Retours
- response
- array of File
Obtenir des informations utilisateur
Obtient des informations de l’utilisateur actuellement connecté.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
Retours
- Corps
- UserInfo
Obtenir le descripteur par défaut
Obtient le descripteur par défaut pour les enveloppes.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
Filtres
|
filters | string |
Filtrer la requête pour sélectionner un sous-montage |
Retours
- Descripteur
- Descriptor
Obtenir le descripteur par ID
Obtient des informations d’un descripteur donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID du descripteur d’enveloppe
|
envelope-descriptor-id | True | string |
ID du descripteur d’enveloppe |
Retours
- Descripteur
- Descriptor
Obtenir les paramètres utilisateur
Obtient les paramètres d’un utilisateur donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID de l’entreprise
|
company-id | True | string |
ID de l’entreprise en question |
|
Identifiant
|
user-id | True | string |
ID de l’utilisateur en question |
Retours
- Corps
- Setting
Obtenir l’entreprise par ID
Obtient des informations d’une société donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID de l’entreprise
|
company-id | True | string |
ID de l’entreprise en question |
Retours
- Entreprise
- Company
Obtenir l’enveloppe par ID
Obtient les détails d’une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
Retours
- Enveloppe
- Envelope
Obtenir l’URL du fichier par ID
Obtient l’URL d’un fichier donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
|
ID de fichier
|
file-id | True | string |
ID du fichier en question |
|
As, objet
|
asObject | boolean |
Définit si la réponse est un objet |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
URL
|
url | string |
URL du fichier |
Obtenir l’état du flux par ID d’enveloppe
Obtient l’état actuel du flux d’une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
ID de flux
|
flow-id | True | string |
ID du flux en question |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Jeton
|
token | string |
Obtenir tous les descripteurs
Obtient la liste de tous les descripteurs présents dans la société actuelle. La liste peut être filtrée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
Filtres
|
filters | string |
Filtrer la requête pour sélectionner un sous-montage |
Retours
- response
- array of Descriptor
Obtenir tous les destinataires de l’enveloppe
Obtient tous les destinataires d’une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
Retours
- response
- array of Recipient
Obtenir tous les documents par ID d’enveloppe
Obtient tous les documents liés à une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
Retours
- response
- array of Document
Obtenir un destinataire spécifique pour une enveloppe
Obtient un destinataire spécifique pour une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
ID du destinataire
|
recipient-id | True | string |
ID des destinataires en question |
Retours
- Recipient
- Recipient
Obtenir un document par ID
Obtient des informations d’un document donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
Retours
- Document
- Document
Obtenir un fichier par ID
Obtient des informations sur un fichier donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
|
ID de fichier
|
file-id | True | string |
ID du fichier en question |
Retours
- Fichier
- File
Rechercher toutes les enveloppes
Recherchez toutes les enveloppes correspondant à un filtre donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
Filtres
|
filters | string |
Filtrer la requête pour sélectionner un sous-montage |
|
|
De
|
from | integer |
À partir de la date |
|
|
Limit
|
limit | integer |
Limite de la quantité |
|
|
Trier
|
sort | string |
Trier par |
Retours
- response
- array of EnvelopeDescriptorString
Supprimer le document par ID
Supprime un document donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
|
Document Id
|
document-id | True | string |
ID du document en question |
Supprimer l’enveloppe par ID
Supprime une enveloppe donnée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton
|
token | True | string |
Jeton reçu de l’action « Générer un jeton de sécurité » |
|
ID d’entreprise
|
x-namespace | string |
ID d’entreprise qui doit être utilisé pour l’action. Format /companies/<company id>. La valeur par défaut est l’ID d’entreprise de connexion s’il n’est pas défini. |
|
|
ID d’enveloppe
|
envelope-id | True | string |
ID de l’enveloppe en question |
Définitions
Réglage
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Global
|
global | string | |
|
Langue signataire
|
preferences.signatoryLanguage | string | |
|
Salutation
|
preferences.greeting | string | |
|
Méthode de signature
|
preferences.signingMethod | string | |
|
Décalage de rappel
|
preferences.reminderOffset | string |
Infos utilisateur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Prénom
|
givenName | string | |
|
Nom de famille
|
familyName | string | |
|
Messagerie électronique
|
string | ||
|
Language
|
metadata.language | string | |
|
Mot de passe manquant
|
missingPassword | boolean | |
|
Est activé
|
isEnabled | boolean | |
|
Namespace
|
namespace | string | |
|
Enabled
|
enabled | boolean | |
|
Identificateur d’utilisateur
|
uid | string | |
|
Id
|
id | string | |
|
Rôles
|
roles | array of Role | |
|
Validated
|
validated | boolean |
Entreprise
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string | |
|
Reg. Number
|
regNumber | string | |
|
Créé
|
created | string | |
|
Modifié
|
modified | string | |
|
Adresse
|
address | string | |
|
Ville
|
city | string | |
|
Code postal
|
zipCode | string | |
|
Logo
|
logo | string | |
|
Pays
|
country | string | |
|
Uid
|
uid | string | |
|
Id
|
id | string |
Recipient
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Identificateur d’utilisateur
|
uid | string |
UID du destinataire |
|
Namespace
|
namespace | string |
Espace de noms du destinataire |
|
Créé
|
created | string |
Destinataire créé |
|
Role
|
role | RoleActionString | |
|
Nom de famille
|
familyName | string |
Nom du destinataire |
|
Prénom
|
givenName | string |
Nom frist du destinataire |
|
Language
|
language | string |
Langue du destinataire |
|
Messagerie électronique
|
string |
E-mail du destinataire |
|
|
Méthode de signature
|
signingMethod | string |
Signature du destinataire Methid |
|
Méthode de notification
|
notificationMethod | string | |
|
JSON
|
order | integer |
Ordre des destinataires |
|
Id
|
id | string |
ID du destinataire |
|
Modifié
|
modified | string |
Destinataire modifié |
|
Notifié
|
notified | boolean | |
|
Terminé
|
completed | boolean | |
|
demandAttachment
|
demandAttachment | boolean | |
|
Numéro de sécurité sociale
|
ssn | string | |
|
Banque
|
bank | string | |
|
Secure
|
secure | boolean | |
|
sms
|
sms | boolean | |
|
Téléphone
|
telephone | string | |
|
Signatures
|
signatures | object | |
|
Notifications
|
notifications | array of Notification |
Role
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Type
|
action.type | string | |
|
méthodes
|
action.methods | array of string | |
|
Étiquette
|
label | string |
Étiquette |
|
Num. Max
|
numMax | integer |
Num. Max |
|
Num. Min
|
numMin | integer |
Num. Min |
|
Nom du rôle
|
roleName | string |
RoleActionString
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Action
|
action | ActionString |
Action |
|
Étiquette
|
label | string |
Étiquette |
|
Num. Max
|
numMax | integer |
Num. Max |
|
Num. Min
|
numMin | integer |
Num. Min |
|
Nom du rôle
|
roleName | string |
ActionString
Enveloppe
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
ID d’enveloppe |
|
Identificateur d’utilisateur
|
uid | string |
UID d’enveloppe |
|
Namespace
|
namespace | string |
Espace de noms d’enveloppe |
|
Version
|
version | integer |
Version de l’enveloppe |
|
Publiée
|
published | boolean |
Enveloppe publiée |
|
Terminé
|
completed | boolean |
Enveloppe terminée |
|
Avorté
|
aborted | boolean |
Enveloppe avortée |
|
Saccagé
|
trashed | boolean |
Enveloppe corbeille |
|
Signature séquentielle
|
sequentialSigning | boolean | |
|
Rappels autmatiques
|
automaticReminders | integer | |
|
Créé
|
created | string |
Enveloppe créée |
|
Modifié
|
modified | string |
Enveloppe modifiée |
|
Expiré
|
expired | boolean |
Enveloppe expirée |
|
Flux
|
flow | Flow | |
|
Descripteur
|
descriptor | Descriptor | |
|
Personne
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
Destinataires
|
recipients | array of Recipient | |
|
Étiquettes
|
tags | array of object | |
|
Propriétaires
|
owners | array of Person |
EnvelopeDescriptorString
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
ID d’enveloppe |
|
Identificateur d’utilisateur
|
uid | string |
UID d’enveloppe |
|
Namespace
|
namespace | string |
Espace de noms d’enveloppe |
|
Version
|
version | integer |
Version de l’enveloppe |
|
Publiée
|
published | boolean |
Enveloppe publiée |
|
Terminé
|
completed | boolean |
Enveloppe terminée |
|
Avorté
|
aborted | boolean |
Enveloppe avortée |
|
Saccagé
|
trashed | boolean |
Enveloppe corbeille |
|
Signature séquentielle
|
sequentialSigning | boolean | |
|
Rappels autmatiques
|
automaticReminders | integer | |
|
Créé
|
created | string |
Enveloppe créée |
|
Modifié
|
modified | string |
Enveloppe modifiée |
|
Expiré
|
expired | boolean |
Enveloppe expirée |
|
Flux
|
flow | Flow | |
|
Descripteur
|
descriptor | string |
Descripteur d’enveloppe |
|
Personne
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
Destinataires
|
recipients | array of Recipient | |
|
Étiquettes
|
tags | array of object | |
|
Propriétaires
|
owners | array of Person |
Fichier
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
ID de fichier |
|
URL
|
url | string |
URL du fichier |
|
Nom
|
name | string |
Nom du fichier |
|
MimeType
|
mimeType | string | |
|
Type de fichier
|
fileType | string | |
|
Chemin d’accès au stockage
|
storagePath | string | |
|
Chargé à l’adresse
|
uploadedAt | string | |
|
Créé
|
created | string |
Fichier créé |
|
Propriétaires
|
owners | array of object | |
|
Identificateur d’utilisateur
|
owners.uid | string |
UID du propriétaire du fichier |
|
Id
|
owners._id | string |
ID du propriétaire du fichier |
|
Namespace
|
namespace | string | |
|
Identificateur d’utilisateur
|
uid | string |
UID de fichier |
Flux
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
ID de flux |
|
Nom
|
name | string |
Nom du flux |
Descripteur
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom du descripteur |
|
Version
|
version | integer |
Version du descripteur |
|
Identificateur d’utilisateur
|
uid | string |
UID du descripteur |
|
Supprimé
|
deleted | boolean |
Descriptor Deletd |
|
Publique
|
public | boolean |
Public du descripteur |
|
Expiré
|
expired | boolean |
Descripteur expiré |
|
Id
|
id | string |
Id de descripteur |
|
Obligatoire
|
mandatory | boolean |
Descripteur obligatoire |
|
Étiquette
|
label | string |
Étiquette de descripteur |
|
Type
|
type | string |
Type de descripteur |
|
Rôles
|
roles | array of Role | |
|
Propriétaires
|
owners | array of Person | |
|
Flux
|
flow | Flow | |
|
defaultValues
|
defaultValues | DefaultValues |
defaultValues |
|
Instances
|
instances | array of object |
Personne
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Identificateur d’utilisateur
|
uid | string |
UID de personne |
|
Prénom
|
givenName | string |
Prénom de la personne |
|
Nom de famille
|
familyName | string |
Nom de la personne |
|
Messagerie électronique
|
string |
Adresse e-mail de personne |
|
|
Language
|
language | string |
Langue de la personne |
|
JSON
|
order | integer |
Commande de personne |
Document
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Étiquette
|
label | string |
Étiquette de document |
|
Type
|
type | string |
Type du document |
|
Hash
|
hash | integer |
Hachage de document |
|
Num. Max
|
numMax | integer |
Numéro du document. Max |
|
Num. Min
|
numMin | integer |
Numéro du document. Min |
|
Identificateur d’utilisateur
|
uid | string |
Document UID |
|
Namespace
|
namespace | string |
Espace de noms de document |
|
Origine
|
source | string |
Document Source |
|
Créé
|
created | string |
Document créé |
|
Nom
|
name | string |
Nom du document |
|
Id
|
id | string |
Document Id |
|
Modifié
|
modified | string |
Document modifié |
|
Rejected
|
rejected | boolean |
Document rejeté |
|
Signé
|
signed | boolean |
Document signé |
|
Saccagé
|
trashed | boolean |
Document corbeille |
|
Avorté
|
aborted | boolean |
Document abandonné |
|
Version
|
version | integer |
Document Version |
|
attachments
|
attachments | array of Attachment | |
|
Flux
|
flow | Flow | |
|
roles
|
roles | array of Role | |
|
Template
|
template | Template | |
|
Descripteur
|
descriptor | Descriptor | |
|
Signatures
|
signatures | array of Signature |
Attachment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Étiquette
|
label | string |
Étiquette de pièce jointe |
|
Num. Max
|
numMax | integer |
Numéro de pièce jointe. Max |
|
Num. Min
|
numMin | integer |
Num.Min de pièce jointe |
|
Hash
|
hash | integer |
Hachage de pièce jointe |
Template
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Type
|
type | string |
Type de modèle |
|
HTML
|
html | string | |
|
PDFHTML
|
pdfHtml | string | |
|
Id
|
id | string | |
|
Identificateur d’utilisateur
|
uid | string | |
|
Namespace
|
namespace | string | |
|
Version
|
version | integer | |
|
Créé
|
created | string | |
|
Modifié
|
modified | string | |
|
Modifié
|
published | boolean | |
|
Terminé
|
completed | boolean | |
|
Avorté
|
aborted | boolean |
Signature
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string | |
|
Origin
|
origin | string | |
|
Prénom
|
givenName | string |
Prénom |
|
Nom de famille
|
familyName | string |
Nom de famille |
|
Messagerie électronique
|
string |
Messagerie électronique |
|
|
IP
|
ip | string | |
|
Date
|
date | string | |
|
Statut
|
status | string | |
|
Commentaire
|
comment | string |
DefaultValues
defaultValues
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Personne
|
signer | Person | |
|
Personne
|
reviewer | Person |
Notification
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string | |
|
Identificateur d’utilisateur
|
uid | string | |
|
Namespace
|
namespace | string | |
|
Statut
|
status | string | |
|
JSON
|
order | integer | |
|
Détails
|
details | object | |
|
Date
|
date | string |