Partager via

API universelle Dokobit

L’API universelle Dokobit est un outil polyvalent qui permet de signer des documents en interne, au sein de votre système et de collecter des signatures provenant de tiers, en dehors de votre système, en Europe. La signature de document se produit dans une signature Dokobit sans compte (où les participants invités peuvent signer des documents sans s’inscrire sur l’interface du portail Dokobit) avec la marque de votre organisation.

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 Dokobit
URL https://support.dokobit.com
Messagerie électronique developers@dokobit.com
Métadonnées du connecteur
Éditeur Dokobit
Site internet https://www.dokobit.com/solutions
Politique de confidentialité https://www.dokobit.com/compliance/privacy-policy
Catégories Productivité

L’API universelle Dokobit est un outil polyvalent qui permet de signer des documents en interne, au sein de votre système et de collecter des signatures provenant de tiers, en dehors de votre système, en Europe. La signature de document se produit dans une signature Dokobit sans compte (où les participants invités peuvent signer des documents sans s’inscrire sur l’interface du portail Dokobit) avec la marque de votre organisation.

Prerequisites

Pour utiliser l’API universelle Dokobit, contactez-nous sales@dokobit.com pour obtenir le jeton d’accès à l’API.

Comment obtenir des informations d’identification

Contactez nos ventes pour obtenir le jeton d’accès à l’API

Bien démarrer avec votre connecteur

  • La signature de document peut être lancée à l’aide des actions « DokobitUniversalAPICreateExternalSigning » ou « DokobitUniversalAPICreateInternalSigning ». L’utilisation de « DokobitUniversalAPICreateExternalSigning » envoie une invitation de signature aux participants. « DokobitUniversalAPICreateInternalSigning » génère une URL de signature où les utilisateurs peuvent être redirigés.
  • La signature peut ensuite être gérée avec les actions correspondantes vous permettant d’ajouter/supprimer des participants, d’envoyer des rappels ou de vérifier l’état de signature du document.
  • Une fois que les participants signent le document, il peut être téléchargé avec les actions « DokobitUniversalAPIDownloadDocumentExternal » ou « DokobitUniversalAPIDownloadDocumentInternal ».

Problèmes connus et limitations

L’implémentation actuelle prend en charge la collecte de signatures sur les fichiers PDF et prise en charge par les conteneurs ASiCe, ADoc, BDoc ou EDoc.

Erreurs courantes et solutions

  • Le fichier doit être fourni en tant que contenu de fichier encodé en Base64.
  • Si la signature de document « Type » est définie sur « pdf », un seul document PDF est accepté lors de la signature du document. Pour plusieurs fichiers, définissez la signature « Type » sur « asice » ou un autre format de conteneur.

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

Limitations

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

Actions

Ajouter un signataire externe

Les participants indiqués pourront accéder au document avec le rôle sélectionné.
Ajouter un signataire interne

Les participants indiqués pourront accéder au document avec le rôle sélectionné.
Créer une signature externe

La signature externe lance une demande de signature asynchrone à partir de votre système. Dans ce cas, l’utilisateur reçoit un e-mail pour la signature et vous recevrez un rappel une fois qu’il signe le document.
Créer une signature interne

La signature interne lance la demande de signature de votre système. Dans ce cas, l’URL de signature est générée où le participant doit être redirigé.
e-Delivery

La livraison électronique de document est utilisée pour partager des documents en toute sécurité avec l’API universelle Dokobit.
Envoyer un rappel

Permet d’envoyer un e-mail de rappel pour le participant, uniquement si la personne n’a pas encore signé de document. Fonctionne uniquement avec le flux de signature externe.
Mettre à jour la signature externe

Permet de mettre à jour les attributs d’une signature de document existante.
Mettre à jour la signature interne

Permet de mettre à jour les attributs d’une signature de document existante.
Signature du sceau

Le document sera scellé avec le sceau électronique de votre organisation. Veuillez contacter notre support pour developers@dokobit.com obtenir un certificat qualifié pour l’e-sealing.
Supprimer la signature externe

Le document sera supprimé du compte du propriétaire. Il restera accessible à d’autres participants.
Supprimer la signature interne

Le document sera supprimé du compte du propriétaire. Il restera accessible à d’autres participants.
Supprimer le signataire interne

L’accès au document sera révoqué pour le participant indiqué.
Supprimer un signataire externe

L’accès au document sera révoqué pour le participant indiqué.
Télécharger le document externe

Télécharge le document signé.
Télécharger le document interne

Télécharge le document signé.
Validation

Dokobit est un fournisseur de services certifié eIDAS pour les validations de signature électronique et e-seal qualifiées. Utilisez cette action pour charger un fichier signé à des fins de validation. Types de fichiers pris en charge : asice, , asics, p7sedocpdfscebdoc, , . xml
Validation - Données de diagnostic XML

Téléchargez les données de diagnostic en XML.
Validation - Rapport PDF

Téléchargez le rapport de validation au format PDF.
Validation - Rapport PDF détaillé

Téléchargez le rapport de validation détaillé au format PDF.
Validation - Rapport XML

Téléchargez le rapport de validation en XML.
Vérifier l’état de signature externe

Retourne les informations du document avec l’état de signature.
Vérifier l’état de signature interne

Retourne les informations du document avec l’état de signature.

Ajouter un signataire externe

ID d’opération :
DokobitUniversalAPIAddExternalSigner

Les participants indiqués pourront accéder au document avec le rôle sélectionné.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
External ID
 external_id True string

Identificateur aléatoire unique du participant à partir de votre système. Vous pouvez générer des identificateurs aléatoires uniques si vous n’en avez pas.
Nom
 name string

Nom du participant.
Surname
 surname string

Nom de famille du participant.
Courriel
 email string

Courrier électronique du participant.
Code
 code string

Code du participant.
Code du pays
 country_code string

Code du pays du participant. Obligatoire si le code personnel est fourni. Valeurs disponibles : LT, , EELV, ISNOFIBESE.
Role
 role string

Rôle du participant. Valeurs disponibles : signer, viewer. Par défaut : signer.
Entreprise
 company string

Société du participant.
Poste
 position string

Position du participant.
Téléphone
 phone string

Téléphone du participant.
Motif personnalisé
 custom_reason string

Raison de signature personnalisée.
Langue des notifications
 notifications_language string

Définit la langue des notifications. Valeurs disponibles : en, , , etltdklvisfinofrsede. nl
Page
 page string

Index de page pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position à partir du haut
 top string

Position (en points) en haut pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position de gauche
 left string

Position (en points) de gauche pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Language
 language string

Langue de l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Valeurs disponibles : en, , lvlt, et,is
Commentaire
 comment string

Message pour les participants.

Retours

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

État.
Signataires
 signers array of object

Informations du participant.
External ID
 signers.external_id string

Identificateur aléatoire unique du participant à partir de votre système.
Jeton
 signers.token string

Jeton du participant.
Nom
 signers.name string

Nom du participant.
Surname
 signers.surname string

Nom de famille du participant.
Courriel
 signers.email string

Courrier électronique du participant.
Code
 signers.code string

Code personnel du participant (numéro d’id national).
Code pays
 signers.country_code string

Pays du participant.
Role
 signers.role string

Rôle du participant.
Entreprise
 signers.company string

Société du participant.
Poste
 signers.position string

Position du participant.
Langue des notifications
 signers.notifications_language string

Définit la langue des notifications. Valeurs disponibles : en, ltislvet, no« fr », « se », « de ».
Téléphone
 signers.phone string

Téléphone du participant.

Ajouter un signataire interne

ID d’opération :
DokobitUniversalAPIAddInternalSigner

Les participants indiqués pourront accéder au document avec le rôle sélectionné.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
External ID
 external_id True string

Identificateur aléatoire unique du participant à partir de votre système. Vous pouvez générer des identificateurs aléatoires uniques si vous n’en avez pas.
Role
 role string

Rôle du participant. Valeurs disponibles : signer, viewer. Par défaut : signer.
Code
 code string

Code du participant.
Code du pays
 country_code string

Code du pays du participant. Obligatoire si le code personnel est fourni. Valeurs disponibles : LT, , , ISPLLVNOFIEEBE, . SE
Téléphone
 phone string

Téléphone du participant.
Langue des notifications
 language string

Définit la langue de l’interface utilisateur. Valeurs disponibles : en, , , etltdklvisfinofrsede. nl
Page
 page string

Index de page pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position à partir du haut
 top string

Position (en points) en haut pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position de gauche
 left string

Position (en points) de gauche pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Language
 language string

Langue de l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Valeurs disponibles : en, , lvlt, et,is
Motif personnalisé
 custom_reason string

Raison de signature personnalisée.

Retours

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

État.
Signataires
 signers array of object

Informations du participant.
External ID
 signers.external_id string

Identificateur aléatoire unique du participant à partir de votre système.
Jeton
 signers.token string

Jeton du participant.
Nom
 signers.name string

Nom du participant.
Surname
 signers.surname string

Nom de famille du participant.
Courriel
 signers.email string

Courrier électronique du participant.
Code
 signers.code string

Code personnel du participant (numéro d’id national).
Code pays
 signers.country_code string

Pays du participant.
Role
 signers.role string

Rôle du participant.
Entreprise
 signers.company string

Société du participant.
Poste
 signers.position string

Position du participant.
Téléphone
 signers.phone string

Téléphone du participant.

Créer une signature externe

ID d’opération :
DokobitUniversalAPICreateExternalSigning

La signature externe lance une demande de signature asynchrone à partir de votre système. Dans ce cas, l’utilisateur reçoit un e-mail pour la signature et vous recevrez un rappel une fois qu’il signe le document.

Paramètres

Nom Clé Obligatoire Type Description
Type
 type True string

Format du document. Valeurs disponibles : pdf, , bdocasice, edocadoc, . adoc.cedoc
Nom
 name True string

Nom de signature affiché pour l’utilisateur.
URL de publication
 postback_url string

URL de votre système pour gérer les webhooks.
Échéance
 deadline date-time

Date d’échéance de signature avec un fragment de fuseau horaire spécifié. Exemple : 2018-11-05T13:15:30Z.
Échéance difficile
 hard_deadline boolean

Si la valeur est définie sur true les participants, vous ne pourrez pas signer ce document après avoir défini deadline. Par défaut : false.
Exiger des signatures qualifiées
 require_qualified_signatures boolean

Autorisez la signature uniquement avec des signatures qualifiées. Par défaut : false.
Position de l’annotation
 annotation_position string

Vous pouvez choisir la position des annotations de signature sur un document PDF. Valeurs disponibles : first_top, , last_topfirst_bottom, last_bottom, none. Par défaut : first_top.
Code personnel d’annotation
 annotation_personal_code boolean

Si la valeur est définie sur true du code personnel, elle est visible dans l’annotation. Applicable uniquement à la signature de type PDF. Par défaut : false.
Commentaire
 comment string

Message pour les participants.
Autoriser l’identification vidéo
 allow_video_identification boolean

Autorisez la connexion à l’aide de l’identification vidéo. Par défaut : false.
Autoriser l’enregistrement de document
 allow_document_saving boolean

Autoriser l’utilisateur à enregistrer le document dans le portail Dokobit et à effectuer d’autres actions. Par défaut : true.
Aplatir le PDF
 flatten_pdf boolean

Si la valeur est true, le document est aplati afin que les champs de formulaire fassent partie du contenu du document et ne peuvent pas être modifiés après la signature. Applicable uniquement à la signature de type PDF. Par défaut : false.
Méthodes de signature autorisées
 allowed_signing_methods array of string

Autorisez uniquement des méthodes de signature spécifiques. Valeurs disponibles : mobile, smartidsmartcard, bankid_noaudkenni_appftnmitidbankid_seeparaksts_mobileitsmeidinelectronic_idswisscom, . sms_otp
Nom
 name True string

Nom de fichier.
Content
 content True string

Contenu de fichier encodé en base64.
External ID
 external_id True string

Identificateur aléatoire unique du participant à partir de votre système. Vous pouvez générer des identificateurs aléatoires uniques si vous n’en avez pas.
Nom
 name string

Nom du participant.
Surname
 surname string

Nom de famille du participant.
Courriel
 email string

Courrier électronique du participant.
Code
 code string

Code personnel du participant (numéro d’id national).
Code pays
 country_code string

Code du pays du participant. Obligatoire si le code personnel est fourni. Valeurs disponibles : LT, , EELV, ISNOFIBESE.
Role
 role string

Rôle du participant. Valeurs disponibles : signer, viewer. Par défaut : signer.
Entreprise
 company string

Nom de la société du participant.
Poste
 position string

Position du participant.
Téléphone
 phone string

Numéro de téléphone du participant.
Sequence
 sequence integer

Permet de configurer l’ordre de séquence des actions d’approbation et de signature de document.
Langue des notifications
 notifications_language string

Définit la langue des notifications. Valeurs disponibles : en, , , etltdklvisfinofrsede. nl
Motif personnalisé
 custom_reason string

Raison de signature personnalisée.
Page
 page string

Index de page pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position à partir du haut
 top string

Position (en points) en haut pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position de gauche
 left string

Position (en points) de gauche pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Language
 language string

Langue de l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Valeurs disponibles : en, , lvlt, et,is

Retours

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

État.
Jeton de signature
 token string

Jeton de signature.
Signataires
 signers array of object

Informations du participant.
External ID
 signers.external_id string

Identificateur aléatoire unique du participant à partir de votre système.
Jeton
 signers.token string

Jeton du participant.
Nom
 signers.first_name string

Nom du participant.
Surname
 signers.last_name string

Nom de famille du participant.
Code
 signers.code string

Code personnel du participant (numéro d’id national).
Pays
 signers.country string

Pays du participant.
Courriel
 signers.email string

Courrier électronique du participant.

Créer une signature interne

ID d’opération :
DokobitUniversalAPICreateInternalSigning

La signature interne lance la demande de signature de votre système. Dans ce cas, l’URL de signature est générée où le participant doit être redirigé.

Paramètres

Nom Clé Obligatoire Type Description
Type
 type True string

Format du document. Valeurs disponibles : pdf, , bdocasice, edocadoc, . adoc.cedoc
Nom
 name True string

Nom de signature affiché pour l’utilisateur.
URI de redirection
 redirect_uri True string

URI de redirection qui sera utilisé pour rediriger le signataire une fois la signature terminée.
URL de publication
 postback_url string

URL de votre système pour gérer les webhooks.
Exiger des signatures qualifiées
 require_qualified_signatures boolean

Autorisez la signature uniquement avec des signatures qualifiées. Par défaut : false.
Position de l’annotation
 annotation_position string

Vous pouvez choisir la position des annotations de signature sur un document PDF. Valeurs disponibles : first_top, , last_topfirst_bottom, last_bottom, none. Par défaut : first_top.
Code personnel d’annotation
 annotation_personal_code boolean

Si la valeur est définie sur true du code personnel, elle est visible dans l’annotation. Applicable uniquement à la signature de type PDF. Par défaut : false.
Autoriser l’identification vidéo
 allow_video_identification boolean

Autorisez la connexion à l’aide de l’identification vidéo. Par défaut : false.
Aplatir le PDF
 flatten_pdf boolean

Si la valeur est true, le document est aplati afin que les champs de formulaire fassent partie du contenu du document et ne peuvent pas être modifiés après la signature. Applicable uniquement à la signature de type PDF. Par défaut : false.
Méthodes de signature autorisées
 allowed_signing_methods array of string

Autorisez uniquement des méthodes de signature spécifiques. Valeurs disponibles : mobile, smartidsmartcard, bankid_noaudkenni_appftnmitidbankid_seeparaksts_mobileitsmeidinelectronic_idswisscom, . sms_otp
Nom
 name True string

Nom de fichier.
Content
 content True string

Contenu de fichier encodé en base64.
External ID
 external_id True string

Identificateur aléatoire unique du participant à partir de votre système. Vous pouvez générer des identificateurs aléatoires uniques si vous n’en avez pas.
Role
 role string

Rôle du participant. Valeurs disponibles : signer, viewer. Par défaut : signer.
Code
 code string

Code du participant.
Code du pays
 country_code string

Code du pays du participant. Obligatoire si le code personnel est fourni. Valeurs disponibles : LT, , , ISPLLVNOFIEEBE, . SE
Téléphone
 phone string

Téléphone du participant.
Langue des notifications
 language string

Définit la langue de l’interface utilisateur. Valeurs disponibles : en, , , etltdklvisfinofrsede. nl
Page
 page string

Index de page pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position à partir du haut
 top string

Position (en points) en haut pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position de gauche
 left string

Position (en points) de gauche pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Language
 language string

Langue de l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Valeurs disponibles : en, , lvlt, et,is
Motif personnalisé
 custom_reason string

Raison de signature personnalisée.

Retours

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

État.
Jeton de signature
 token string

Jeton de signature.
Signataires
 signers array of object

Informations du participant.
External ID
 signers.external_id string

Identificateur aléatoire unique du participant à partir de votre système.
Jeton
 signers.token string

Jeton du participant.
URI de redirection
 signers.redirect_uri string

URL de signature.

e-Delivery

ID d’opération :
DokobitUniversalAPIeDelivery

La livraison électronique de document est utilisée pour partager des documents en toute sécurité avec l’API universelle Dokobit.

Paramètres

Nom Clé Obligatoire Type Description
Type
 type True string

Format du document. Valeurs disponibles : pdf.
Nom
 name True string

Nom du document affiché pour l’utilisateur.
URL de publication
 postback_url string

URL de votre système pour gérer les webhooks.
Commentaire
 comment string

Message pour les destinataires.
Nom
 name True string

Nom de fichier.
Content
 content True string

Contenu de fichier encodé en base64.
External ID
 external_id True string

Identificateur aléatoire unique du participant à partir de votre système. Vous pouvez générer des identificateurs aléatoires uniques si vous n’en avez pas.
Code
 code True string

Code personnel du destinataire (numéro d’ID national).
Code pays
 country_code True string

Code de pays du destinataire. Obligatoire si le code personnel est fourni. Valeurs disponibles : lt, , eelv, is.
Courriel
 email string

E-mail du destinataire pour l’envoi du document. Obligatoire si le téléphone n’est pas défini.
Téléphone
 phone string

Numéro de téléphone du destinataire pour l’envoi de SMS de document. Obligatoire si l’e-mail n’est pas défini. Sms ne sera envoyé que lorsque l’e-mail n’est pas fourni.
Langue des notifications
 notifications_language string

Définit la langue des notifications. Valeurs disponibles : en, ltislvet, no« fr », « se », « de ».

Retours

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

État.
Jeton de document
 token string

Jeton de document.
Destinataires
 recipients array of object

Informations du destinataire.
External ID
 recipients.external_id string

Identificateur aléatoire unique du participant à partir de votre système.
Jeton
 recipients.token string

Jeton du destinataire.
Code
 recipients.code string

Code personnel du destinataire (numéro d’ID national).
Pays
 recipients.country string

Pays du destinataire.
Courriel
 recipients.email string

Courrier électronique du destinataire.

Envoyer un rappel

ID d’opération :
DokobitUniversalAPIReminder

Permet d’envoyer un e-mail de rappel pour le participant, uniquement si la personne n’a pas encore signé de document. Fonctionne uniquement avec le flux de signature externe.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
Jeton de signataire
 signer True string

Jeton du participant.
Message
 message string

Message de rappel au signataire.

Retours

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

État.

Mettre à jour la signature externe

ID d’opération :
DokobitUniversalAPIUpdateExternalSigning

Permet de mettre à jour les attributs d’une signature de document existante.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
Échéance
 deadline date-time

Date d’échéance de signature avec un fragment de fuseau horaire spécifié. Exemple : 2018-11-05T13:15:30Z.
Échéance difficile
 hard_deadline boolean

Si la valeur est définie sur true les participants, vous ne pourrez pas signer ou approuver ce document après avoir défini deadline. Par défaut : false.
Exiger des signatures qualifiées
 require_qualified_signatures boolean

Autorisez la signature uniquement avec des signatures qualifiées. Par défaut : false.
Autoriser l’identification vidéo
 allow_video_identification boolean

Autorisez la connexion à l’aide de l’identification vidéo. Par défaut : false.
Autoriser l’enregistrement de document
 allow_document_saving boolean

Autoriser l’utilisateur à enregistrer le document dans le portail Dokobit et à effectuer d’autres actions. Par défaut : true.
Méthodes de signature autorisées
 allowed_signing_methods array of string

Autorisez uniquement des méthodes de signature spécifiques. Valeurs disponibles : mobile, smartidsmartcard, bankid_noaudkenni_appftnmitidbankid_seeparaksts_mobileitsmeidinelectronic_idswisscom, . sms_otp

Retours

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

État.

Mettre à jour la signature interne

ID d’opération :
DokobitUniversalAPIUpdateInternalSigning

Permet de mettre à jour les attributs d’une signature de document existante.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
Exiger des signatures qualifiées
 require_qualified_signatures boolean

Autorisez la signature uniquement avec des signatures qualifiées. Par défaut : false.
Autoriser l’identification vidéo
 allow_video_identification boolean

Autorisez la connexion à l’aide de l’identification vidéo. Par défaut : false.
Méthodes de signature autorisées
 allowed_signing_methods array of string

Autorisez uniquement des méthodes de signature spécifiques. Valeurs disponibles : mobile, smartidsmartcard, bankid_noaudkenni_appftnmitidbankid_seeparaksts_mobileitsmeidinelectronic_idswisscom, . sms_otp

Retours

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

État.

Signature du sceau

ID d’opération :
DokobitUniversalAPISealSigning

Le document sera scellé avec le sceau électronique de votre organisation. Veuillez contacter notre support pour developers@dokobit.com obtenir un certificat qualifié pour l’e-sealing.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
Motif personnalisé
 custom_reason string

Raison de signature personnalisée.
Page
 page string

Index de page pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position à partir du haut
 top string

Position (en points) en haut pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.
Position de gauche
 left string

Position (en points) de gauche pour l’annotation de signature PDF visible. Applicable uniquement à la signature de type PDF. Par défaut : 1.

Retours

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

État.

Supprimer la signature externe

ID d’opération :
DokobitUniversalAPIDeleteExternalSigning

Le document sera supprimé du compte du propriétaire. Il restera accessible à d’autres participants.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.

Retours

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

État.

Supprimer la signature interne

ID d’opération :
DokobitUniversalAPIDeleteInternalSigning

Le document sera supprimé du compte du propriétaire. Il restera accessible à d’autres participants.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.

Retours

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

État.

Supprimer le signataire interne

ID d’opération :
DokobitUniversalAPIDeleteInternalSigner

L’accès au document sera révoqué pour le participant indiqué.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
Jeton
 token True string

Jeton du participant.

Retours

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

État.

Supprimer un signataire externe

ID d’opération :
DokobitUniversalAPIDeleteExternalSigner

L’accès au document sera révoqué pour le participant indiqué.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.
Jeton
 token True string

Jeton du participant.

Retours

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

État.

Télécharger le document externe

ID d’opération :
DokobitUniversalAPIDownloadDocumentExternal

Télécharge le document signé.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.

Retours

response
object

Télécharger le document interne

ID d’opération :
DokobitUniversalAPIDownloadDocumentInternal

Télécharge le document signé.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.

Retours

response
object

Validation

ID d’opération :
DokobitUniversalAPIValidation

Dokobit est un fournisseur de services certifié eIDAS pour les validations de signature électronique et e-seal qualifiées. Utilisez cette action pour charger un fichier signé à des fins de validation. Types de fichiers pris en charge : asice, , asics, p7sedocpdfscebdoc, , . xml

Paramètres

Nom Clé Obligatoire Type Description
Nom
 name True string

Nom de fichier.
Content
 content True string

Contenu de fichier encodé en base64.

Retours

Nom Chemin d’accès Type Description
État du chargement
 status string

État du chargement.
Jeton de validation
 token string

Jeton de validation.

Validation - Données de diagnostic XML

ID d’opération :
DokobitUniversalAPIValidationXMLDiagnosticData

Téléchargez les données de diagnostic en XML.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de validation
 token True string

Jeton de validation reçu de l’action DokobitUniversalAPIValidation.

Retours

response
object

Validation - Rapport PDF

ID d’opération :
DokobitUniversalAPIValidationPDFReport

Téléchargez le rapport de validation au format PDF.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de validation
 token True string

Jeton de validation reçu de l’action DokobitUniversalAPIValidation.

Retours

response
object

Validation - Rapport PDF détaillé

ID d’opération :
DokobitUniversalAPIValidationDetailedPDFReport

Téléchargez le rapport de validation détaillé au format PDF.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de validation
 token True string

Jeton de validation reçu de l’action DokobitUniversalAPIValidation.

Retours

response
object

Validation - Rapport XML

ID d’opération :
DokobitUniversalAPIValidationXMLReport

Téléchargez le rapport de validation en XML.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de validation
 token True string

Jeton de validation reçu de l’action DokobitUniversalAPIValidation.

Retours

response
object

Vérifier l’état de signature externe

ID d’opération :
DokobitUniversalAPICheckExternalSigningStatus

Retourne les informations du document avec l’état de signature.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.

Retours

Nom Chemin d’accès Type Description
État de signature
 status string

État de signature de document.
Nom
 name string

Nom de signature affiché pour l’utilisateur.
Type
 type string

Type de document.
Date de création
 date_created string

Date à laquelle la signature de document a été lancée.
Échéance
 deadline date-time

Date d’échéance de signature avec un fragment de fuseau horaire spécifié. Exemple : 2018-11-05T13:15:30Z.
Nom du fichier
 filename string

Nom de fichier.
Fichiers
 files array of object
Nom
 files.name string

Nom du fichier.
URL de téléchargement
 files.url string

URL de téléchargement de fichier.
Type MIME
 files.mime_type string

Type MIME de fichier.
Signataires
 signers array of object

Informations sur les participants.
Jeton
 signers.token string

Jeton du participant.
Nom
 signers.first_name string

Nom du participant.
Surname
 signers.last_name string

Nom de famille du participant.
Code
 signers.code string

Code du participant.
Pays
 signers.country string

Pays du participant.
Courriel
 signers.email string

Courrier électronique du participant.
Type
 signers.type string

Type.
Statut
 signers.status string

Statut du participant.

Vérifier l’état de signature interne

ID d’opération :
DokobitUniversalAPICheckInternalSigningStatus

Retourne les informations du document avec l’état de signature.

Paramètres

Nom Clé Obligatoire Type Description
Jeton de signature
 token True string

Jeton de signature.

Retours

Nom Chemin d’accès Type Description
État de signature
 status string

État de signature de document.
Nom
 name string

Nom de signature affiché pour l’utilisateur.
Type
 type string

Type de document.
Date de création
 date_created string

Date à laquelle la signature de document a été lancée.
Échéance
 deadline date-time

Date d’échéance de signature avec un fragment de fuseau horaire spécifié. Exemple : 2018-11-05T13:15:30Z.
Nom du fichier
 filename string

Nom de fichier.
Fichiers
 files array of object
Nom
 files.name string

Nom du fichier.
URL de téléchargement
 files.url string

URL de téléchargement de fichier.
Type MIME
 files.mime_type string

Type MIME de fichier.
Signataires
 signers array of object

Informations sur les participants.
Jeton
 signers.token string

Jeton du participant.
Nom
 signers.first_name string

Nom du participant.
Surname
 signers.last_name string

Nom de famille du participant.
Code
 signers.code string

Code du participant.
Pays
 signers.country string

Pays du participant.
Courriel
 signers.email string

Courrier électronique du participant.
Type
 signers.type string

Type.
Statut
 signers.status string

Statut du participant.

Définitions

objet

Il s’agit du type 'object'.