Freigeben über

Universelle Dokobit-API

Dokobit Universal API ist ein vielseitiges Tool, das das interne Signieren von Dokumenten innerhalb Ihres Systems und das Sammeln von Signaturen von Drittanbietern außerhalb Ihres Systems in ganz Europa ermöglicht. Die Dokumentsignierung erfolgt in einer kontolosen Dokobit-Signatur (bei der eingeladene Teilnehmer Dokumente signieren können, ohne sich auf dem Dokobit-Portal zu registrieren) mit dem Branding Ihrer Organisation.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Dokobit
URL https://support.dokobit.com
Email developers@dokobit.com
Connectormetadaten
Herausgeber Dokobit
Webseite https://www.dokobit.com/solutions
Datenschutzrichtlinie https://www.dokobit.com/compliance/privacy-policy
Kategorien Produktivität

Dokobit Universal API ist ein vielseitiges Tool, das das interne Signieren von Dokumenten innerhalb Ihres Systems und das Sammeln von Signaturen von Drittanbietern außerhalb Ihres Systems in ganz Europa ermöglicht. Die Dokumentsignierung erfolgt in einer kontolosen Dokobit-Signatur (bei der eingeladene Teilnehmer Dokumente signieren können, ohne sich auf dem Dokobit-Portal zu registrieren) mit dem Branding Ihrer Organisation.

Voraussetzungen

Um die universelle Dokobit-API zu verwenden, wenden Sie sich an sales@dokobit.com uns, um das API-Zugriffstoken abzurufen.

So erhalten Sie Anmeldeinformationen

Wenden Sie sich an unseren Vertrieb, um das API-Zugriffstoken abzurufen.

Erste Schritte mit Ihrem Connector

  • Die Dokumentsignierung kann mithilfe von Aktionen "DokobitUniversalAPICreateExternalSigning" oder "DokobitUniversalAPICreateInternalSigning" initiiert werden. Die Verwendung von "DokobitUniversalAPICreateExternalSigning" sendet eine Signatureinladung an die Teilnehmer. "DokobitUniversalAPICreateInternalSigning" generiert eine Signatur-URL, über die Benutzer umgeleitet werden können.
  • Das Signieren kann dann mit entsprechenden Aktionen verwaltet werden, sodass Sie Teilnehmer hinzufügen/entfernen, Erinnerungen senden oder den Dokumentsignaturstatus überprüfen können.
  • Nachdem die Teilnehmer das Dokument signiert haben, kann es mit den Aktionen "DokobitUniversalAPIDownloadDocumentExternal" oder "DokobitUniversalAPIDownloadDocumentInternal" heruntergeladen werden.

Bekannte Probleme und Einschränkungen

Die aktuelle Implementierung unterstützt das Sammeln von Signaturen in PDF-Dateien und unterstützt von ASiCe-, ADoc-, BDoc- oder EDoc-Containern.

Häufige Fehler und Abhilfemaßnahmen

  • Die Datei muss als Base64-codierter Dateiinhalt bereitgestellt werden.
  • Wenn die Dokumentsignierung "Type" auf "pdf" festgelegt ist, wird ein einzelnes PDF-Dokument akzeptiert, wenn die Dokumentsignierung initiiert wird. Legen Sie für mehrere Dateien das Signieren von "Type" auf "asice" oder ein anderes Containerformat fest.

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:
Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
API-Schlüssel securestring Der API-Schlüssel für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Dokument intern herunterladen

Lädt das signierte Dokument herunter.
e-Delivery

Dokument-E-Delivery wird für die sichere Freigabe von Dokumenten mit der universellen Dokobit-API verwendet.
Erinnerung senden

Ermöglicht das Senden einer Erinnerungs-E-Mail für teilnehmer, nur wenn die Person das Dokument noch nicht signiert hat. Funktioniert nur mit externem Signaturfluss.
Externe Signatur aktualisieren

Ermöglicht das Aktualisieren von Attributen einer vorhandenen Dokumentsignierung.
Externe Signatur erstellen

Die externe Signatur initiiert eine asynchrone Signaturanforderung von Ihrem System. In diesem Fall erhält der Benutzer eine E-Mail zum Signieren, und Sie erhalten einen Rückruf, sobald er das Dokument signiert hat.
Externe Signatur löschen

Das Dokument wird aus dem Konto des Besitzers entfernt. Sie bleibt für andere Teilnehmer zugänglich.
Externe Signierer hinzufügen

Angegebene Teilnehmer erhalten Zugriff auf das Dokument mit der ausgewählten Rolle.
Externe Signierer löschen

Der Zugriff auf das Dokument wird für den angegebenen Teilnehmer widerrufen.
Externes Dokument herunterladen

Lädt das signierte Dokument herunter.
Interne Signatur aktualisieren

Ermöglicht das Aktualisieren von Attributen einer vorhandenen Dokumentsignierung.
Interne Signatur erstellen

Die interne Signatur initiiert die Signaturanforderung von Ihrem System. In diesem Fall wird die Signatur-URL generiert, an der der Teilnehmer umgeleitet werden soll.
Interne Signatur löschen

Das Dokument wird aus dem Konto des Besitzers entfernt. Sie bleibt für andere Teilnehmer zugänglich.
Interne Signierer löschen

Der Zugriff auf das Dokument wird für den angegebenen Teilnehmer widerrufen.
Internen Signierer hinzufügen

Angegebene Teilnehmer erhalten Zugriff auf das Dokument mit der ausgewählten Rolle.
Siegelsignatur

Das Dokument wird mit dem elektronischen Siegel Ihrer Organisation versiegelt. Bitte wenden Sie sich an unseren Support, developers@dokobit.com um ein qualifiziertes Zertifikat für die E-Dichtung zu erhalten.
Validation

Dokobit ist ein eIDAS-zertifizierter Dienstleister für qualifizierte E-Signature- und E-Seal-Validierungen. Verwenden Sie diese Aktion, um eine signierte Datei zur Überprüfung hochzuladen. Unterstützte Dateitypen: asice, , asics, bdocsce, edoc, pdf, . xmlp7s
Validierung – Detaillierter PDF-Bericht

Laden Sie detaillierten Validierungsbericht in PDF herunter.
Validierung – PDF-Bericht

Laden Sie den Validierungsbericht in PDF herunter.
Validierung – XML-Bericht

Laden Sie den Validierungsbericht in XML herunter.
Validierung – XML-Diagnosedaten

Laden Sie Diagnosedaten in XML herunter.
Überprüfen des internen Signaturstatus

Gibt die Informationen des Dokuments mit dem Signaturstatus zurück.
Überprüfen des Status der externen Signatur

Gibt die Informationen des Dokuments mit dem Signaturstatus zurück.

Dokument intern herunterladen

Vorgangs-ID:
DokobitUniversalAPIDownloadDocumentInternal

Lädt das signierte Dokument herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.

Gibt zurück

response
object

e-Delivery

Vorgangs-ID:
DokobitUniversalAPIeDelivery

Dokument-E-Delivery wird für die sichere Freigabe von Dokumenten mit der universellen Dokobit-API verwendet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Typ
 type True string

Dokumentformat. Verfügbare Werte: pdf.
Name
 name True string

Dokumentname, der für den Benutzer angezeigt wird.
Postback-URL
 postback_url string

DIE URL Ihres Systems zum Behandeln von Webhooks.
Kommentar
 comment string

Nachricht für Empfänger.
Name
 name True string

Dateiname.
Content
 content True string

Base64-codierter Dateiinhalt.
Externe ID
 external_id True string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System. Sie können eindeutige zufällige Bezeichner generieren, wenn Sie keinen haben.
Code
 code True string

Der persönliche Code des Empfängers (Nationale ID-Nummer).
Ländercode
 country_code True string

Ländercode des Empfängers. Erforderlich, wenn persönlicher Code bereitgestellt wird. Verfügbare Werte: lt, lv, ee, . is
E-Mail
 email string

Die E-Mail-Adresse des Empfängers zum Senden eines Dokuments. Erforderlich, wenn das Telefon nicht festgelegt ist.
Telefonnummer
 phone string

Die Telefonnummer des Empfängers zum Senden von Dokument-SMS. Erforderlich, wenn keine E-Mail festgelegt ist. SMS wird nur gesendet, wenn keine E-Mail bereitgestellt wird.
Benachrichtigungssprache
 notifications_language string

Legt die Sprache für Benachrichtigungen fest. Verfügbare Werte: en, , lt, lv, et, is, , no' fr', 'se', 'de'.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:
Dokumenttoken
 token string

Dokumenttoken.
Empfänger
 recipients array of object

Die Informationen des Empfängers.
Externe ID
 recipients.external_id string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System.
Token
 recipients.token string

Empfängertoken.
Code
 recipients.code string

Der persönliche Code des Empfängers (Nationale ID-Nummer).
Country
 recipients.country string

Land des Empfängers.
E-Mail
 recipients.email string

Die E-Mail des Empfängers.

Erinnerung senden

Vorgangs-ID:
DokobitUniversalAPIReminder

Ermöglicht das Senden einer Erinnerungs-E-Mail für teilnehmer, nur wenn die Person das Dokument noch nicht signiert hat. Funktioniert nur mit externem Signaturfluss.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Signiertoken
 signer True string

Teilnehmertoken.
Nachricht
 message string

Erinnerungsnachricht an den Signierer.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Externe Signatur aktualisieren

Vorgangs-ID:
DokobitUniversalAPIUpdateExternalSigning

Ermöglicht das Aktualisieren von Attributen einer vorhandenen Dokumentsignierung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Deadline
 deadline date-time

Signieren des Stichtags mit dem angegebenen Zeitzonenfragment. Beispiel: 2018-11-05T13:15:30Z.
Harte Frist
 hard_deadline boolean

Wenn diese Einstellung auf true Teilnehmer festgelegt ist, kann dieses Dokument nach der Festlegung deadlinenicht signiert oder genehmigt werden. Standardwert: false.
Qualifizierte Signaturen erforderlich
 require_qualified_signatures boolean

Nur mit qualifizierten Signaturen signieren zulassen. Standardwert: false.
Videoidentifikation zulassen
 allow_video_identification boolean

Zulassen, dass sie mithilfe der videobasierten Identifikation signieren. Standardwert: false.
Dokumentspeichern zulassen
 allow_document_saving boolean

Benutzern das Speichern von Dokumenten im Dokobit-Portal gestatten und weitere Aktionen ausführen. Standardwert: true.
Zulässige Signaturmethoden
 allowed_signing_methods array of string

Nur bestimmte Signaturmethoden zulassen. Verfügbare Werte: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_app, mitiditsmeelectronic_ididinftn. . sms_otpswisscom

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Externe Signatur erstellen

Vorgangs-ID:
DokobitUniversalAPICreateExternalSigning

Die externe Signatur initiiert eine asynchrone Signaturanforderung von Ihrem System. In diesem Fall erhält der Benutzer eine E-Mail zum Signieren, und Sie erhalten einen Rückruf, sobald er das Dokument signiert hat.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Typ
 type True string

Dokumentformat. Verfügbare Werte: pdf, , asice, edocbdoc, , adoc. adoc.cedoc
Name
 name True string

Für den Benutzer angezeigter Signaturname.
Postback-URL
 postback_url string

DIE URL Ihres Systems zum Behandeln von Webhooks.
Deadline
 deadline date-time

Signieren des Stichtags mit dem angegebenen Zeitzonenfragment. Beispiel: 2018-11-05T13:15:30Z.
Harte Frist
 hard_deadline boolean

Wenn diese Einstellung auf true Teilnehmer festgelegt ist, kann dieses Dokument nach der Festlegung deadlinenicht signiert werden. Standardwert: false.
Qualifizierte Signaturen erforderlich
 require_qualified_signatures boolean

Nur mit qualifizierten Signaturen signieren zulassen. Standardwert: false.
Anmerkungsposition
 annotation_position string

Sie können die Position von Signaturanmerkungen in einem PDF-Dokument auswählen. Verfügbare Werte: first_top, , last_topfirst_bottom, last_bottom, . none Standardwert: first_top.
Persönlicher Anmerkungscode
 annotation_personal_code boolean

Wenn diese Einstellung auf true persönlichen Code festgelegt ist, wird sie in anmerkungsbemerkung angezeigt. Gilt nur für die PDF-Typsignierung. Standardwert: false.
Kommentar
 comment string

Nachricht für Teilnehmer.
Videoidentifikation zulassen
 allow_video_identification boolean

Zulassen, dass sie mithilfe der videobasierten Identifikation signieren. Standardwert: false.
Dokumentspeichern zulassen
 allow_document_saving boolean

Benutzern das Speichern von Dokumenten im Dokobit-Portal gestatten und weitere Aktionen ausführen. Standardwert: true.
FLACHTE PDF
 flatten_pdf boolean

Wenn dieser Wert auf "true" festgelegt ist, wird das Dokument abgeflacht, sodass die Formularfelder Teil des Dokumentinhalts werden und nach dem Signieren nicht bearbeitet werden können. Gilt nur für die PDF-Typsignierung. Standardwert: false.
Zulässige Signaturmethoden
 allowed_signing_methods array of string

Nur bestimmte Signaturmethoden zulassen. Verfügbare Werte: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_app, mitiditsmeelectronic_ididinftn. . sms_otpswisscom
Name
 name True string

Dateiname.
Content
 content True string

Base64-codierter Dateiinhalt.
Externe ID
 external_id True string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System. Sie können eindeutige zufällige Bezeichner generieren, wenn Sie keinen haben.
Name
 name string

Der Name des Teilnehmers.
Surname
 surname string

Nachname des Teilnehmers.
E-Mail
 email string

Die E-Mail des Teilnehmers.
Code
 code string

Der persönliche Code des Teilnehmers (Nationale ID-Nummer).
Ländercode
 country_code string

Ländervorwahl des Teilnehmers. Erforderlich, wenn persönlicher Code bereitgestellt wird. Verfügbare Werte: LT, , LV, EE, NOIS, FI, , . BESE
Rolle
 role string

Rolle des Teilnehmers. Verfügbare Werte: signer, viewer. Standardwert: signer.
Firma
 company string

Firmenname des Teilnehmers.
Position
 position string

Die Position des Teilnehmers.
Telefonnummer
 phone string

Telefonnummer des Teilnehmers.
Sequence
 sequence integer

Ermöglicht das Einrichten der Sequenzreihenfolge von Dokumentgenehmigungs- und Signaturaktionen.
Benachrichtigungssprache
 notifications_language string

Legt die Sprache für Benachrichtigungen fest. Verfügbare Werte: en, , lt, lv, iset, no, frdesefidk. nl
Benutzerdefinierter Grund
 custom_reason string

Benutzerdefinierter Signaturgrund.
Seite
 page string

Seitenindex für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von oben
 top string

Position (in Punkt) von oben für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von links
 left string

Position (in Punkt) von links für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Language
 language string

Sprache der sichtbaren PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Verfügbare Werte: en, , lvlt, , etis

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:
Signaturtoken
 token string

Signaturtoken.
Unterzeichner
 signers array of object

Die Informationen des Teilnehmers.
Externe ID
 signers.external_id string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System.
Token
 signers.token string

Teilnehmertoken.
Name
 signers.first_name string

Der Name des Teilnehmers.
Surname
 signers.last_name string

Nachname des Teilnehmers.
Code
 signers.code string

Der persönliche Code des Teilnehmers (Nationale ID-Nummer).
Country
 signers.country string

Land des Teilnehmers.
E-Mail
 signers.email string

Die E-Mail des Teilnehmers.

Externe Signatur löschen

Vorgangs-ID:
DokobitUniversalAPIDeleteExternalSigning

Das Dokument wird aus dem Konto des Besitzers entfernt. Sie bleibt für andere Teilnehmer zugänglich.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Externe Signierer hinzufügen

Vorgangs-ID:
DokobitUniversalAPIAddExternalSigner

Angegebene Teilnehmer erhalten Zugriff auf das Dokument mit der ausgewählten Rolle.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Externe ID
 external_id True string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System. Sie können eindeutige zufällige Bezeichner generieren, wenn Sie keinen haben.
Name
 name string

Der Name des Teilnehmers.
Surname
 surname string

Nachname des Teilnehmers.
E-Mail
 email string

Die E-Mail des Teilnehmers.
Code
 code string

Teilnehmercode.
Landescode
 country_code string

Ländervorwahl des Teilnehmers. Erforderlich, wenn persönlicher Code bereitgestellt wird. Verfügbare Werte: LT, , LV, EE, NOIS, FI, , . BESE
Rolle
 role string

Rolle des Teilnehmers. Verfügbare Werte: signer, viewer. Standardwert: signer.
Firma
 company string

Unternehmen des Teilnehmers.
Position
 position string

Die Position des Teilnehmers.
Telefonnummer
 phone string

Telefon des Teilnehmers.
Benutzerdefinierter Grund
 custom_reason string

Benutzerdefinierter Signaturgrund.
Benachrichtigungssprache
 notifications_language string

Legt die Sprache für Benachrichtigungen fest. Verfügbare Werte: en, , lt, lv, iset, no, frdesefidk. nl
Seite
 page string

Seitenindex für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von oben
 top string

Position (in Punkt) von oben für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von links
 left string

Position (in Punkt) von links für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Language
 language string

Sprache der sichtbaren PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Verfügbare Werte: en, , lvlt, , etis
Kommentar
 comment string

Nachricht für Teilnehmer.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:
Unterzeichner
 signers array of object

Die Informationen des Teilnehmers.
Externe ID
 signers.external_id string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System.
Token
 signers.token string

Teilnehmertoken.
Name
 signers.name string

Der Name des Teilnehmers.
Surname
 signers.surname string

Nachname des Teilnehmers.
E-Mail
 signers.email string

Die E-Mail des Teilnehmers.
Code
 signers.code string

Der persönliche Code des Teilnehmers (Nationale ID-Nummer).
Ländercode
 signers.country_code string

Land des Teilnehmers.
Rolle
 signers.role string

Rolle des Teilnehmers.
Firma
 signers.company string

Unternehmen des Teilnehmers.
Position
 signers.position string

Die Position des Teilnehmers.
Benachrichtigungssprache
 signers.notifications_language string

Legt die Sprache für Benachrichtigungen fest. Verfügbare Werte: en, , lt, lv, et, is, , no' fr', 'se', 'de'.
Telefonnummer
 signers.phone string

Telefon des Teilnehmers.

Externe Signierer löschen

Vorgangs-ID:
DokobitUniversalAPIDeleteExternalSigner

Der Zugriff auf das Dokument wird für den angegebenen Teilnehmer widerrufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Token
 token True string

Teilnehmertoken.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Externes Dokument herunterladen

Vorgangs-ID:
DokobitUniversalAPIDownloadDocumentExternal

Lädt das signierte Dokument herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.

Gibt zurück

response
object

Interne Signatur aktualisieren

Vorgangs-ID:
DokobitUniversalAPIUpdateInternalSigning

Ermöglicht das Aktualisieren von Attributen einer vorhandenen Dokumentsignierung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Qualifizierte Signaturen erforderlich
 require_qualified_signatures boolean

Nur mit qualifizierten Signaturen signieren zulassen. Standardwert: false.
Videoidentifikation zulassen
 allow_video_identification boolean

Zulassen, dass sie mithilfe der videobasierten Identifikation signieren. Standardwert: false.
Zulässige Signaturmethoden
 allowed_signing_methods array of string

Nur bestimmte Signaturmethoden zulassen. Verfügbare Werte: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_app, mitiditsmeelectronic_ididinftn. . sms_otpswisscom

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Interne Signatur erstellen

Vorgangs-ID:
DokobitUniversalAPICreateInternalSigning

Die interne Signatur initiiert die Signaturanforderung von Ihrem System. In diesem Fall wird die Signatur-URL generiert, an der der Teilnehmer umgeleitet werden soll.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Typ
 type True string

Dokumentformat. Verfügbare Werte: pdf, , asice, edocbdoc, , adoc. adoc.cedoc
Name
 name True string

Für den Benutzer angezeigter Signaturname.
Umleitungs-URI
 redirect_uri True string

Umleitungs-URI, der nach Abschluss der Signatur für die Umleitung des Signierers verwendet wird.
Postback-URL
 postback_url string

DIE URL Ihres Systems zum Behandeln von Webhooks.
Qualifizierte Signaturen erforderlich
 require_qualified_signatures boolean

Nur mit qualifizierten Signaturen signieren zulassen. Standardwert: false.
Anmerkungsposition
 annotation_position string

Sie können die Position von Signaturanmerkungen in einem PDF-Dokument auswählen. Verfügbare Werte: first_top, , last_topfirst_bottom, last_bottom, . none Standardwert: first_top.
Persönlicher Anmerkungscode
 annotation_personal_code boolean

Wenn diese Einstellung auf true persönlichen Code festgelegt ist, wird sie in anmerkungsbemerkung angezeigt. Gilt nur für die PDF-Typsignierung. Standardwert: false.
Videoidentifikation zulassen
 allow_video_identification boolean

Zulassen, dass sie mithilfe der videobasierten Identifikation signieren. Standardwert: false.
FLACHTE PDF
 flatten_pdf boolean

Wenn dieser Wert auf "true" festgelegt ist, wird das Dokument abgeflacht, sodass die Formularfelder Teil des Dokumentinhalts werden und nach dem Signieren nicht bearbeitet werden können. Gilt nur für die PDF-Typsignierung. Standardwert: false.
Zulässige Signaturmethoden
 allowed_signing_methods array of string

Nur bestimmte Signaturmethoden zulassen. Verfügbare Werte: mobile, , smartid, smartcard, eparaksts_mobile, bankid_no, bankid_se, audkenni_app, mitiditsmeelectronic_ididinftn. . sms_otpswisscom
Name
 name True string

Dateiname.
Content
 content True string

Base64-codierter Dateiinhalt.
Externe ID
 external_id True string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System. Sie können eindeutige zufällige Bezeichner generieren, wenn Sie keinen haben.
Rolle
 role string

Rolle des Teilnehmers. Verfügbare Werte: signer, viewer. Standardwert: signer.
Code
 code string

Teilnehmercode.
Landescode
 country_code string

Ländervorwahl des Teilnehmers. Erforderlich, wenn persönlicher Code bereitgestellt wird. Verfügbare Werte: LT, , LV, EE, NOIS, PL, FI, , . BESE
Telefonnummer
 phone string

Telefon des Teilnehmers.
Benachrichtigungssprache
 language string

Legt die Sprache der Benutzeroberfläche fest. Verfügbare Werte: en, , lt, lv, iset, no, frdesefidk. nl
Seite
 page string

Seitenindex für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von oben
 top string

Position (in Punkt) von oben für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von links
 left string

Position (in Punkt) von links für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Language
 language string

Sprache der sichtbaren PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Verfügbare Werte: en, , lvlt, , etis
Benutzerdefinierter Grund
 custom_reason string

Benutzerdefinierter Signaturgrund.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:
Signaturtoken
 token string

Signaturtoken.
Unterzeichner
 signers array of object

Die Informationen des Teilnehmers.
Externe ID
 signers.external_id string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System.
Token
 signers.token string

Teilnehmertoken.
Umleitungs-URI
 signers.redirect_uri string

URL zum Signieren.

Interne Signatur löschen

Vorgangs-ID:
DokobitUniversalAPIDeleteInternalSigning

Das Dokument wird aus dem Konto des Besitzers entfernt. Sie bleibt für andere Teilnehmer zugänglich.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Interne Signierer löschen

Vorgangs-ID:
DokobitUniversalAPIDeleteInternalSigner

Der Zugriff auf das Dokument wird für den angegebenen Teilnehmer widerrufen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Token
 token True string

Teilnehmertoken.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Internen Signierer hinzufügen

Vorgangs-ID:
DokobitUniversalAPIAddInternalSigner

Angegebene Teilnehmer erhalten Zugriff auf das Dokument mit der ausgewählten Rolle.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Externe ID
 external_id True string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System. Sie können eindeutige zufällige Bezeichner generieren, wenn Sie keinen haben.
Rolle
 role string

Rolle des Teilnehmers. Verfügbare Werte: signer, viewer. Standardwert: signer.
Code
 code string

Teilnehmercode.
Landescode
 country_code string

Ländervorwahl des Teilnehmers. Erforderlich, wenn persönlicher Code bereitgestellt wird. Verfügbare Werte: LT, , LV, EE, NOIS, PL, FI, , . BESE
Telefonnummer
 phone string

Telefon des Teilnehmers.
Benachrichtigungssprache
 language string

Legt die Sprache der Benutzeroberfläche fest. Verfügbare Werte: en, , lt, lv, iset, no, frdesefidk. nl
Seite
 page string

Seitenindex für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von oben
 top string

Position (in Punkt) von oben für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von links
 left string

Position (in Punkt) von links für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Language
 language string

Sprache der sichtbaren PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Verfügbare Werte: en, , lvlt, , etis
Benutzerdefinierter Grund
 custom_reason string

Benutzerdefinierter Signaturgrund.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:
Unterzeichner
 signers array of object

Die Informationen des Teilnehmers.
Externe ID
 signers.external_id string

Eindeutiger zufälliger Bezeichner des Teilnehmers aus Ihrem System.
Token
 signers.token string

Teilnehmertoken.
Name
 signers.name string

Der Name des Teilnehmers.
Surname
 signers.surname string

Nachname des Teilnehmers.
E-Mail
 signers.email string

Die E-Mail des Teilnehmers.
Code
 signers.code string

Der persönliche Code des Teilnehmers (Nationale ID-Nummer).
Ländercode
 signers.country_code string

Land des Teilnehmers.
Rolle
 signers.role string

Rolle des Teilnehmers.
Firma
 signers.company string

Unternehmen des Teilnehmers.
Position
 signers.position string

Die Position des Teilnehmers.
Telefonnummer
 signers.phone string

Telefon des Teilnehmers.

Siegelsignatur

Vorgangs-ID:
DokobitUniversalAPISealSigning

Das Dokument wird mit dem elektronischen Siegel Ihrer Organisation versiegelt. Bitte wenden Sie sich an unseren Support, developers@dokobit.com um ein qualifiziertes Zertifikat für die E-Dichtung zu erhalten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.
Benutzerdefinierter Grund
 custom_reason string

Benutzerdefinierter Signaturgrund.
Seite
 page string

Seitenindex für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von oben
 top string

Position (in Punkt) von oben für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.
Position von links
 left string

Position (in Punkt) von links für sichtbare PDF-Signaturanmerkung. Gilt nur für die PDF-Typsignierung. Standardwert: 1.

Gibt zurück

Name Pfad Typ Beschreibung
Der Status
 status string

Status:

Validation

Vorgangs-ID:
DokobitUniversalAPIValidation

Dokobit ist ein eIDAS-zertifizierter Dienstleister für qualifizierte E-Signature- und E-Seal-Validierungen. Verwenden Sie diese Aktion, um eine signierte Datei zur Überprüfung hochzuladen. Unterstützte Dateitypen: asice, , asics, bdocsce, edoc, pdf, . xmlp7s

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Name
 name True string

Dateiname.
Content
 content True string

Base64-codierter Dateiinhalt.

Gibt zurück

Name Pfad Typ Beschreibung
Uploadstatus
 status string

Uploadstatus.
Überprüfungstoken
 token string

Überprüfungstoken.

Validierung – Detaillierter PDF-Bericht

Vorgangs-ID:
DokobitUniversalAPIValidationDetailedPDFReport

Laden Sie detaillierten Validierungsbericht in PDF herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Überprüfungstoken
 token True string

Validierungstoken, das von der DokobitUniversalAPIValidation-Aktion empfangen wurde.

Gibt zurück

response
object

Validierung – PDF-Bericht

Vorgangs-ID:
DokobitUniversalAPIValidationPDFReport

Laden Sie den Validierungsbericht in PDF herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Überprüfungstoken
 token True string

Validierungstoken, das von der DokobitUniversalAPIValidation-Aktion empfangen wurde.

Gibt zurück

response
object

Validierung – XML-Bericht

Vorgangs-ID:
DokobitUniversalAPIValidationXMLReport

Laden Sie den Validierungsbericht in XML herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Überprüfungstoken
 token True string

Validierungstoken, das von der DokobitUniversalAPIValidation-Aktion empfangen wurde.

Gibt zurück

response
object

Validierung – XML-Diagnosedaten

Vorgangs-ID:
DokobitUniversalAPIValidationXMLDiagnosticData

Laden Sie Diagnosedaten in XML herunter.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Überprüfungstoken
 token True string

Validierungstoken, das von der DokobitUniversalAPIValidation-Aktion empfangen wurde.

Gibt zurück

response
object

Überprüfen des internen Signaturstatus

Vorgangs-ID:
DokobitUniversalAPICheckInternalSigningStatus

Gibt die Informationen des Dokuments mit dem Signaturstatus zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.

Gibt zurück

Name Pfad Typ Beschreibung
Signaturstatus
 status string

Dokumentsignierungsstatus.
Name
 name string

Für den Benutzer angezeigter Signaturname.
Typ
 type string

Dokumenttyp.
Erstellungsdatum
 date_created string

Datum, an dem die Dokumentsignierung initiiert wurde.
Deadline
 deadline date-time

Signieren des Stichtags mit dem angegebenen Zeitzonenfragment. Beispiel: 2018-11-05T13:15:30Z.
Dateiname
 filename string

Name der Datei.
Dateien
 files array of object
Name
 files.name string

Dateiname.
URL herunterladen
 files.url string

Dateidownload-URL.
MIME-Typ
 files.mime_type string

Datei-MIME-Typ.
Unterzeichner
 signers array of object

Teilnehmerinformationen.
Token
 signers.token string

Teilnehmertoken.
Name
 signers.first_name string

Der Name des Teilnehmers.
Surname
 signers.last_name string

Nachname des Teilnehmers.
Code
 signers.code string

Teilnehmercode.
Country
 signers.country string

Land des Teilnehmers.
E-Mail
 signers.email string

Die E-Mail des Teilnehmers.
Typ
 signers.type string

Typ:
Der Status
 signers.status string

Der Status des Teilnehmers.

Überprüfen des Status der externen Signatur

Vorgangs-ID:
DokobitUniversalAPICheckExternalSigningStatus

Gibt die Informationen des Dokuments mit dem Signaturstatus zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Signaturtoken
 token True string

Signaturtoken.

Gibt zurück

Name Pfad Typ Beschreibung
Signaturstatus
 status string

Dokumentsignierungsstatus.
Name
 name string

Für den Benutzer angezeigter Signaturname.
Typ
 type string

Dokumenttyp.
Erstellungsdatum
 date_created string

Datum, an dem die Dokumentsignierung initiiert wurde.
Deadline
 deadline date-time

Signieren des Stichtags mit dem angegebenen Zeitzonenfragment. Beispiel: 2018-11-05T13:15:30Z.
Dateiname
 filename string

Name der Datei.
Dateien
 files array of object
Name
 files.name string

Dateiname.
URL herunterladen
 files.url string

Dateidownload-URL.
MIME-Typ
 files.mime_type string

Datei-MIME-Typ.
Unterzeichner
 signers array of object

Teilnehmerinformationen.
Token
 signers.token string

Teilnehmertoken.
Name
 signers.first_name string

Der Name des Teilnehmers.
Surname
 signers.last_name string

Nachname des Teilnehmers.
Code
 signers.code string

Teilnehmercode.
Country
 signers.country string

Land des Teilnehmers.
E-Mail
 signers.email string

Die E-Mail des Teilnehmers.
Typ
 signers.type string

Typ:
Der Status
 signers.status string

Der Status des Teilnehmers.

Definitionen

Objekt

Dies ist der Typ „Objekt“.