Freigeben über

Überprüft

Connector für die überprüfte API, um die Erstellung benutzerdefinierter Dokumentsignaturprozesse zu ermöglichen.

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 Überprüft
URL https://verified.eu/en/#about-us
Email support@verified.eu
Connectormetadaten
Herausgeber Crm - Konsulterna i Sverige AB
Webseite https://verified.eu/
Datenschutzrichtlinie https://verified.eu/trust-center
Kategorien Inhalt und Dateien; Produktivität

Verified ist ein Software as a Service Provider für elektronische Identifikation und digitale Signatur. Dieser Connector ermöglicht die Integration in die API von Verified und das Erstellen einfacher und intuitiver Signierprozesse in Ihrer Anwendung.

Voraussetzungen

Sie benötigen Folgendes, um fortzufahren:

So erhalten Sie Anmeldeinformationen

Dieser Connector verwendet die Standardauthentifizierung. Der Benutzer muss beim Erstellen einer Verbindung Benutzername, Kennwort und Firmen-ID angeben. Benutzername und Kennwort sind identisch, mit denen Sie sich beim überprüften Portal anmelden. Um die Firmen-ID abzurufen, die Sie beim Überprüften Portal anmelden müssen, wählen Sie das richtige Unternehmen aus, wenn Sie mehrere haben und die Firmen-ID aus der URL kopieren.

Get started

Ein gängiger Anwendungsfall besteht darin, einen Signierungsprozess zu starten und zu verwalten, d. h. die Einrichtung der Automatisierung zum Senden von Dokumenten, die bei "Überprüft" signiert werden sollen und die signierten Dokumente regelmäßig wiederzuerlangen. Allgemeine Aktionen, die verwendet werden, um einen überprüften Signaturvorgang zu starten, sind "Umschlag erstellen" – "Deskriptor" oder "Umschlag erstellen" – "Standard", "Dokument zu Umschlag hinzufügen", "Dokument zum Dokument hinzufügen", "Empfänger zum Umschlag hinzufügen" und "Veröffentlichungsstatus aktualisieren" für umschlag. Allgemeine Aktionen, die verwendet werden, um den Status "Überprüft" für Dokumente zu überprüfen, umfassen "Umschlag nach ID abrufen", "Alle Dokumente nach Umschlag-ID abrufen", "Dateien nach Dokument-ID abrufen", "Datei-URL nach ID abrufen". Beachten Sie, dass die Aktion "Sicherheitstoken generieren" immer als erster Schritt verwendet wird, um ein Sicherheitstoken abzurufen, das in den folgenden Schritten verwendet werden soll.

Bekannte Probleme und Einschränkungen

Die folgenden Einschränkungen sind derzeit bekannt.

  • Am Anfang jedes Flusses muss ein Authentifizierungstoken erstellt werden, das in jedem folgenden Schritt wiederverwendet werden soll.
  • Zum Hinzufügen eines Dokuments muss eine HTTP-Anforderung an eine bestimmte URL gesendet werden.
  • Um den neuen Suchendpunkt zu verwenden, muss er für das Konto über das überprüfte Suppoert aktiviert werden.

Häufig gestellte Fragen

Wie kann ich ein Dokument in "Überprüft" hochladen?

Um ein tatsächliches Dokument hochzuladen, müssen Sie eine Datei in der überprüften API erstellen und den Dokumenthash in die BLOB-URL hochladen, die von der überprüften API beantwortet wurde.

Wie erhalte ich den Umschlag, nachdem ich die Aktion "Umschlag-ID abrufen" verwendet habe?

Die Schritte zum Erstellen eines Umschlags reagieren mit einer UID, bei der es sich um einen vollständigen Pfad zum Umschlag handelt (Beispiel: "/envelopes/ABCDE"). Für andere Schritte benötigt man nur den letzten Teil der Uid (dies ist die tatsächliche Umschlag-ID, in unserem Beispiel "ABCDE").

Hier ist ein Beispiel für die Vorgehensweise

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

Wie erhalte ich die Dokument-ID, nachdem ich die Aktion "Dokument zu Umschlag hinzufügen" verwendet habe?

Die Schritte zum Erstellen eines Dokuments antworten mit dem Speicherort des neuen Dokuments in der Kopfzeile. Der Speicherort ist der vollständige Pfad zum Dokument (Beispiel: "/api/envelopes/ABCDE/documents/FGHIJ"). Nur die Dokument-ID (in unserem Fall: FGHIJ) ist für die folgenden Schritte erforderlich.

Hier ist ein Beispiel für die Vorgehensweise

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

Wie erhalte ich die Fluss-ID aus einem Umschlag?

Wenn eine Person Informationen zu einem Umschlag lädt, ist der zugehörige Fluss Teil der Antwort (Beispiel: "/flow/default"). In der Antwort wird sie als ID eines Flusses bezeichnet, jedoch benötigt man nur den letzten Teil, wenn ein anderer Schritt (z. B. get flow status) die Ablauf-ID anfragt.

Hier ist ein Beispiel für die Vorgehensweise

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

Wie kann ich die neue Suchaktion verwenden?

Um die neue Suchaktion verwenden zu können, muss der Suchendpunkt für Ihre überprüfte Organisation aktiviert werden. Dazu müssen Sie eine E-Mail an den bestätigten Support schreiben, einschließlich Ihrer Organisations-ID, damit sie den Endpunkt für Sie aktivieren können.

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
username securestring Der Benutzername für diese API Richtig
Kennwort securestring Das Kennwort für diese API Richtig
Unternehmens-ID Schnur Die Firmen-ID wird von Verified bereitgestellt. Kann in der URL gefunden werden, indem sie sich bei app.verified.eu Richtig

Drosselungsgrenzwerte

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

Aktionen

Abfragen aller Umschläge (veraltet)

Fragt alle Umschläge ab, die einem bestimmten Filter entsprechen. (Veraltet)
Abrufen aller Deskriptoren

Ruft eine Liste aller Beschreibungen ab, die im aktuellen Unternehmen vorhanden sind. Die Liste kann gefiltert werden.
Abrufen aller Dokumente nach Umschlag-ID

Ruft alle Dokumente im Zusammenhang mit einem bestimmten Umschlag ab.
Abrufen aller Umschlagempfänger

Ruft alle Empfänger eines bestimmten Umschlags ab.
Abrufen des Flusszustands nach Umschlag-ID

Ruft den aktuellen Flussstatus eines bestimmten Umschlags ab.
Abrufen des Standarddeskriptors

Ruft den Standarddeskriptor für Umschläge ab.
Abrufen eines bestimmten Empfängers für einen Umschlag

Ruft einen bestimmten Empfänger für einen bestimmten Umschlag ab.
Abrufen von Benutzereinstellungen

Ruft die Einstellungen eines bestimmten Benutzers ab.
Abrufen von Benutzerinformationen

Ruft Informationen des aktuell angemeldeten Benutzers ab.
Aktualisieren der Umschlageinstellungen

Aktualisiert die Einstellungen eines bestimmten Umschlags.
Aktualisieren des Veröffentlichungsstatus für umschlag

Aktualisiert den Veröffentlichungsstatus eines bestimmten Umschlags.
Benachrichtigung senden

Sendet eine Benachrichtigung an Recepienten eines bestimmten Umschlags.
Datei nach ID abrufen

Ruft Informationen zu einer bestimmten Datei ab.
Datei-URL nach ID abrufen

Ruft die URL zu einer bestimmten Datei ab.
Datei zum Dokument hinzufügen

Fügt einem vorhandenen Dokument eine Datei hinzu.
Dateien nach Dokument-ID abrufen

Ruft alle Dateien ab, die mit einem bestimmten Dokument verbunden sind.
Deskriptor nach ID abrufen

Ruft Informationen eines bestimmten Deskriptors ab.
Dokument aus Vorlage generieren

Generiert ein Dokument aus einer vorkonfigurierten Vorlage.
Dokument nach ID abrufen

Ruft Informationen eines bestimmten Dokuments ab.
Dokument nach ID löschen

Löscht ein bestimmtes Dokument.
Dokument zu Umschlag hinzufügen

Fügt einem vorhandenen Umschlag ein neues Dokument hinzu.
Dokumentabbruchstatus festlegen

Legt den Status eines bestimmten Dokuments fest, das abgebrochen werden soll.
Durchsuchen aller Umschläge

Durchsuchen Sie alle Umschläge, die einem bestimmten Filter entsprechen.
Empfänger nach ID aktualisieren

Aktualisiert einen Empfänger.
Empfänger zu Umschlag hinzufügen

Fügt einen Empfänger zu einem bestimmten Umschlag hinzu.
Festlegen des Papierkorbstatus von Umschlägen

Legt den Status eines bestimmten Umschlags auf den Papierkorb fest.
Sicherheitstoken generieren

Ruft das Authentifizierungstoken aus der überprüften API ab.
Signaturlink erstellen

Erstellt einen Signaturlink. Die Implementierung ist flowspezifisch und kann für Ihren spezifischen Fluss fehlen.
Umschlag erstellen – Deskriptor

Erstellt einen Umschlag basierend auf einem bestimmten Deskriptor.
Umschlag erstellen – Standard

Erstellt einen neuen Umschlag mit dem Standarddeskriptor.
Umschlag nach ID abrufen

Ruft Details eines bestimmten Umschlags ab.
Umschlag nach ID löschen

Löscht einen bestimmten Umschlag.
Umschlagabbruchstatus festlegen

Legt den Status eines bestimmten Umschlags fest, der abgebrochen werden soll.
Unternehmen nach ID abrufen

Ruft Informationen eines bestimmten Unternehmens ab.

Abfragen aller Umschläge (veraltet)

Vorgangs-ID:
GetQueryEnvelopes

Fragt alle Umschläge ab, die einem bestimmten Filter entsprechen. (Veraltet)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Filter
 filters string

Filterabfrage zum Auswählen des Unteramounts
Von
 from integer

Ab Datum
Limit
 limit integer

Limitbetrag
Sortieren
 sort string

Sortieren nach

Gibt zurück

response
array of EnvelopeDescriptorString

Abrufen aller Deskriptoren

Vorgangs-ID:
GetEnvelopeDescriptors

Ruft eine Liste aller Beschreibungen ab, die im aktuellen Unternehmen vorhanden sind. Die Liste kann gefiltert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Filter
 filters string

Filterabfrage zum Auswählen des Unteramounts

Gibt zurück

response
array of Descriptor

Abrufen aller Dokumente nach Umschlag-ID

Vorgangs-ID:
GetEnvelopesEnvelopeIdDocuments

Ruft alle Dokumente im Zusammenhang mit einem bestimmten Umschlag ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags

Gibt zurück

response
array of Document

Abrufen aller Umschlagempfänger

Vorgangs-ID:
GetEnvelopesEnvelopeIdRecipients

Ruft alle Empfänger eines bestimmten Umschlags ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags

Gibt zurück

response
array of Recipient

Abrufen des Flusszustands nach Umschlag-ID

Vorgangs-ID:
GetFlowsFlowIdJobsEnvelopeId

Ruft den aktuellen Flussstatus eines bestimmten Umschlags ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Ablauf-ID
 flow-id True string

ID des fraglichen Flusses

Gibt zurück

Name Pfad Typ Beschreibung
Token
 token string

Abrufen des Standarddeskriptors

Vorgangs-ID:
GetEnvelopeDescriptorsDefault

Ruft den Standarddeskriptor für Umschläge ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Filter
 filters string

Filterabfrage zum Auswählen des Unteramounts

Gibt zurück

Deskriptor
Descriptor

Abrufen eines bestimmten Empfängers für einen Umschlag

Vorgangs-ID:
GetEnvelopesEnvelopeIdRecipientsRecipientId

Ruft einen bestimmten Empfänger für einen bestimmten Umschlag ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Empfänger-ID
 recipient-id True string

Die ID der betreffenden Empfänger

Gibt zurück

Recipient
Recipient

Abrufen von Benutzereinstellungen

Vorgangs-ID:
GetCompaniesCompanyIdUsersUserIdSettings

Ruft die Einstellungen eines bestimmten Benutzers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Firmen-ID
 company-id True string

Die ID des betreffenden Unternehmens
Benutzer-ID
 user-id True string

ID des betreffenden Benutzers

Gibt zurück

Body
Setting

Abrufen von Benutzerinformationen

Vorgangs-ID:
GetAuthUserinfo

Ruft Informationen des aktuell angemeldeten Benutzers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde

Gibt zurück

Body
UserInfo

Aktualisieren der Umschlageinstellungen

Vorgangs-ID:
PutEnvelopesEnvelopeId

Aktualisiert die Einstellungen eines bestimmten Umschlags.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Sequenzielles Signieren
 sequentialSigning boolean
Begrüßung
 greeting string
Ablaufdatum
 expiration date

Datum im folgenden Format 2017-02-26T21:59:59.999Z
Automatische Erinnerungen
 automaticReminders number

X Tage vor Ablauf

Aktualisieren des Veröffentlichungsstatus für umschlag

Vorgangs-ID:
PutEnvelopesEnvelopeIdPublishStatus

Aktualisiert den Veröffentlichungsstatus eines bestimmten Umschlags.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Veröffentlicht
 published True boolean

Benachrichtigung senden

Vorgangs-ID:
PostEnvelopesEnvelopIdJobsSendNotification

Sendet eine Benachrichtigung an Recepienten eines bestimmten Umschlags.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Begrüßung
 greeting string
Empfänger-ID
 id True string

Die ID des Empfängers, an den die Benachrichtigung gesendet werden soll.

Datei nach ID abrufen

Vorgangs-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Ruft Informationen zu einer bestimmten Datei ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments
Datei-ID
 file-id True string

Die ID der betreffenden Datei

Gibt zurück

Datei
File

Datei-URL nach ID abrufen

Vorgangs-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Ruft die URL zu einer bestimmten Datei ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments
Datei-ID
 file-id True string

Die ID der betreffenden Datei
As-Objekt
 asObject boolean

Definiert, ob es sich bei der Antwort um ein Objekt handelt.

Gibt zurück

Name Pfad Typ Beschreibung
URL
 url string

Datei-URL

Datei zum Dokument hinzufügen

Vorgangs-ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Fügt einem vorhandenen Dokument eine Datei hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments
Name
 name True string
FileType
 fileType True string
Hash
 hash string

Gibt zurück

Datei
File

Dateien nach Dokument-ID abrufen

Vorgangs-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Ruft alle Dateien ab, die mit einem bestimmten Dokument verbunden sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments

Gibt zurück

response
array of File

Deskriptor nach ID abrufen

Vorgangs-ID:
GetEnvelopeDescriptorsEnvelopeDescriptorId

Ruft Informationen eines bestimmten Deskriptors ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlagdeskriptor-ID
 envelope-descriptor-id True string

ID des Umschlagdeskriptors

Gibt zurück

Deskriptor
Descriptor

Dokument aus Vorlage generieren

Vorgangs-ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Generiert ein Dokument aus einer vorkonfigurierten Vorlage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments
Vorlagen-ID
 template-id True string

Die ID der Vorlage, die verwendet werden soll
object

Dokument nach ID abrufen

Vorgangs-ID:
GetEnvelopesEnvelopeIdDocumentsDocumentId

Ruft Informationen eines bestimmten Dokuments ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments

Gibt zurück

Dokument
Document

Dokument nach ID löschen

Vorgangs-ID:
DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Löscht ein bestimmtes Dokument.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments

Dokument zu Umschlag hinzufügen

Vorgangs-ID:
PostEnvelopesEnvelopeIdDocuments

Fügt einem vorhandenen Umschlag ein neues Dokument hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Hash
 hash integer
Name
 name True string
Quelle
 source string

Dokumentabbruchstatus festlegen

Vorgangs-ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Legt den Status eines bestimmten Dokuments fest, das abgebrochen werden soll.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Dokument-ID
 document-id True string

Die ID des betreffenden Dokuments

Durchsuchen aller Umschläge

Vorgangs-ID:
GetSearchEnvelopes

Durchsuchen Sie alle Umschläge, die einem bestimmten Filter entsprechen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Filter
 filters string

Filterabfrage zum Auswählen des Unteramounts
Von
 from integer

Ab Datum
Limit
 limit integer

Limitbetrag
Sortieren
 sort string

Sortieren nach

Gibt zurück

response
array of EnvelopeDescriptorString

Empfänger nach ID aktualisieren

Vorgangs-ID:
PutEnvelopesEnvelopeIdRecipientsRecipientId

Aktualisiert einen Empfänger.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Empfänger-ID
 recipient-id True string

Die ID der betreffenden Empfänger
Vorname
 givenName True string
Nachname
 familyName True string
Language
 language True string
Signaturmethode
 signingMethod True string
Notification-Methode
 notificationMethod string
E-Mail
 email True string
Telefon
 telephone string

Format sollte +<countryCode-Telefonnummer><sein>
Bestellung
 order integer
Maßnahme
 action True string

Der Name der Aktion, die ein Empfänger ausführen soll, wurde überprüft.
Etikett
 label True string

Bezeichnung für die Rolle/Aktion eines Empfängers
Name
 name True string

Überprüfter Name der Rolle eines Empfängers
Absichern
 secure boolean
sms
 sms boolean
Sozialversicherungsnummer
 ssn string
Bank
 bank string

Empfänger zu Umschlag hinzufügen

Vorgangs-ID:
PostEnvelopesEnvelopeIdRecipients

Fügt einen Empfänger zu einem bestimmten Umschlag hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Vorname
 givenName True string
Nachname
 familyName True string
Language
 language True string
Signaturmethode
 signingMethod True string
Notification-Methode
 notificationMethod string
E-Mail
 email True string
Telefon
 telephone string

Format sollte +<countryCode-Telefonnummer><sein>
Bestellung
 order integer
Maßnahme
 action True string

Der Name der Aktion, die ein Empfänger ausführen soll, wurde überprüft.
Etikett
 label True string

Bezeichnung für die Rolle/Aktion eines Empfängers
Name
 name True string

Überprüfter Name der Rolle eines Empfängers
Absichern
 secure boolean
sms
 sms boolean
Sozialversicherungsnummer
 ssn string
Bank
 bank string

Festlegen des Papierkorbstatus von Umschlägen

Vorgangs-ID:
PutEnvelopesEnvelopeIdTrashStatus

Legt den Status eines bestimmten Umschlags auf den Papierkorb fest.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Kommentar
 comment string

Sicherheitstoken generieren

Vorgangs-ID:
PostAuthenticate

Ruft das Authentifizierungstoken aus der überprüften API ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ohne IP-Sperre
 withoutIpLock True integer

Gibt an, ob überprüfte IP-Sperre (0, Standard) aktiviert oder nicht (1)

Gibt zurück

Name Pfad Typ Beschreibung
Token
 token string

Zugriffstoken
Vorgangs-ID:
PostEnvelopesEnvelopeIdJobsGetSignLink

Erstellt einen Signaturlink. Die Implementierung ist flowspezifisch und kann für Ihren spezifischen Fluss fehlen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Id
 id string
Umleitung an
 redirectTo uri

Vollständige URL, um den Benutzer nach der Anmeldung umzuleiten.

Gibt zurück

Name Pfad Typ Beschreibung
URL
 getSignLink.recipient.{recipient-id}.url string

Umschlag erstellen – Deskriptor

Vorgangs-ID:
PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Erstellt einen Umschlag basierend auf einem bestimmten Deskriptor.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlagdeskriptor-ID
 envelope-descriptor-id True string

ID des Umschlagdeskriptors
Email
 email string
Vorname
 givenName string
Nachname
 familyName string
Automatische Erinnerungen
 automaticReminders number
Ablaufdatum
 expiration string
Hash
 hash string

Gibt zurück

Name Pfad Typ Beschreibung
uid
 uid string

Umschlag erstellen – Standard

Vorgangs-ID:
PostEnvelopeDescriptorsDefaultEnvelopes

Erstellt einen neuen Umschlag mit dem Standarddeskriptor.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Email
 email string
Vorname
 givenName string
Nachname
 familyName string
Automatische Erinnerungen
 automaticReminders number
Ablaufdatum
 expiration string
Hash
 hash string

Gibt zurück

Name Pfad Typ Beschreibung
uid
 uid string

Umschlag nach ID abrufen

Vorgangs-ID:
GetEnvelopesEnvelopeId

Ruft Details eines bestimmten Umschlags ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags

Gibt zurück

Briefumschlag
Envelope

Umschlag nach ID löschen

Vorgangs-ID:
DeleteEnvelopesEnvelopeId

Löscht einen bestimmten Umschlag.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags

Umschlagabbruchstatus festlegen

Vorgangs-ID:
PutEnvelopesEnvelopeIdAbortStatus

Legt den Status eines bestimmten Umschlags fest, der abgebrochen werden soll.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Unternehmens-ID
 x-namespace string

Die Firmen-ID, die für die Aktion verwendet werden soll. Format /companies/<company id>. Standardmäßig werden Verbindungen mit der Firmen-ID festgelegt, wenn sie nicht festgelegt ist.
Umschlag-ID
 envelope-id True string

ID des betreffenden Umschlags
Kommentar
 comment string

Unternehmen nach ID abrufen

Vorgangs-ID:
GetCompaniesCompanyId

Ruft Informationen eines bestimmten Unternehmens ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Token
 token True string

Token, das von der Aktion "Sicherheitstoken generieren" empfangen wurde
Firmen-ID
 company-id True string

Die ID des betreffenden Unternehmens

Gibt zurück

Firma
Company

Definitionen

Setting

Name Pfad Typ Beschreibung
Global
 global string
Signative Sprache
 preferences.signatoryLanguage string
Begrüßung
 preferences.greeting string
Signaturmethode
 preferences.signingMethod string
Erinnerungsversatz
 preferences.reminderOffset string

UserInfo

Name Pfad Typ Beschreibung
Vorname
 givenName string
Nachname
 familyName string
Email
 email string
Language
 metadata.language string
Fehlendes Kennwort
 missingPassword boolean
Ist aktiviert
 isEnabled boolean
Namespace
 namespace string
Enabled
 enabled boolean
UID
 uid string
Id
 id string
Rollen
 roles array of Role
Validated
 validated boolean

Firma

Name Pfad Typ Beschreibung
Name
 name string
Reg. Number
 regNumber string
Erstellt
 created string
Geändert
 modified string
Adresse
 address string
Stadt
 city string
PLZ
 zipCode string
Logo
 logo string
Country
 country string
Uid
 uid string
Id
 id string

Recipient

Name Pfad Typ Beschreibung
UID
 uid string

Empfänger-UID
Namespace
 namespace string

Empfängernamespace
Erstellt
 created string

Empfänger erstellt
Rolle
 role RoleActionString
Nachname
 familyName string

Nachname des Empfängers
Vorname
 givenName string

Name der Empfänger-Frist
Language
 language string

Empfängersprache
Email
 email string

Empfänger-E-Mail
Signaturmethode
 signingMethod string

Empfängersignatur-Methid
Notification-Methode
 notificationMethod string
Bestellung
 order integer

Empfängerauftrag
Id
 id string

Empfänger-ID
Geändert
 modified string

Empfänger geändert
Verständigt
 notified boolean
Abgeschlossen
 completed boolean
demandAttachment
 demandAttachment boolean
Sozialversicherungsnummer
 ssn string
Bank
 bank string
Absichern
 secure boolean
sms
 sms boolean
Telefon
 telephone string
Signaturen
 signatures object
Benachrichtigungen
 notifications array of Notification

Rolle

Name Pfad Typ Beschreibung
Typ
 action.type string
Methodik
 action.methods array of string
Etikett
 label string

Etikett
Num. Max.
 numMax integer

Num. Max.
Num. Min
 numMin integer

Num. Min
Rollenname
 roleName string

RoleActionString

Name Pfad Typ Beschreibung
Maßnahme
 action ActionString

Maßnahme
Etikett
 label string

Etikett
Num. Max.
 numMax integer

Num. Max.
Num. Min
 numMin integer

Num. Min
Rollenname
 roleName string

ActionString

Maßnahme

Maßnahme

Maßnahme
string

Briefumschlag

Name Pfad Typ Beschreibung
Id
 id string

Umschlag-ID
UID
 uid string

Umschlag-UID
Namespace
 namespace string

Envelope-Namespace
Version
 version integer

Umschlagversion
Veröffentlicht
 published boolean

Briefumschlag veröffentlicht
Vollständig
 completed boolean

Umschlag abgeschlossen
Abgebrochen
 aborted boolean

Umschlag Avorted
Papierkorb
 trashed boolean

Umschlag papierkorbiert
Sequenzielles Signieren
 sequentialSigning boolean
Autmatische Erinnerungen
 automaticReminders integer
Erstellt
 created string

Umschlag erstellt
Geändert
 modified string

Umschlag geändert
Abgelaufen
 expired boolean

Umschlag abgelaufen
Flow
 flow Flow
Deskriptor
 descriptor Descriptor
Person
 sender Person
Dokumente
 documents array of Document
Empfänger
 recipients array of Recipient
Stichwörter
 tags array of object
Besitzer
 owners array of Person

EnvelopeDescriptorString

Name Pfad Typ Beschreibung
Id
 id string

Umschlag-ID
UID
 uid string

Umschlag-UID
Namespace
 namespace string

Envelope-Namespace
Version
 version integer

Umschlagversion
Veröffentlicht
 published boolean

Briefumschlag veröffentlicht
Vollständig
 completed boolean

Umschlag abgeschlossen
Abgebrochen
 aborted boolean

Umschlag Avorted
Papierkorb
 trashed boolean

Umschlag papierkorbiert
Sequenzielles Signieren
 sequentialSigning boolean
Autmatische Erinnerungen
 automaticReminders integer
Erstellt
 created string

Umschlag erstellt
Geändert
 modified string

Umschlag geändert
Abgelaufen
 expired boolean

Umschlag abgelaufen
Flow
 flow Flow
Deskriptor
 descriptor string

Umschlagdeskriptor
Person
 sender Person
Dokumente
 documents array of Document
Empfänger
 recipients array of Recipient
Stichwörter
 tags array of object
Besitzer
 owners array of Person

Datei

Name Pfad Typ Beschreibung
Id
 id string

Datei-ID
URL
 url string

Datei-URL
Name
 name string

Dateiname
Mime-Typ
 mimeType string
Dateityp
 fileType string
Speicherpfad
 storagePath string
Hochgeladen unter
 uploadedAt string
Erstellt
 created string

Datei erstellt
Besitzer
 owners array of object
UID
 owners.uid string

Uid des Dateibesitzers
Id
 owners._id string

Dateibesitzer-ID
Namespace
 namespace string
UID
 uid string

Datei-UID

Flow

Name Pfad Typ Beschreibung
Id
 id string

Ablauf-ID
Name
 name string

Flussname

Deskriptor

Name Pfad Typ Beschreibung
Name
 name string

Name des Deskriptors
Version
 version integer

Deskriptorversion
UID
 uid string

Deskriptor-UID
Gelöscht
 deleted boolean

Deskriptordeletd
Öffentlichkeit
 public boolean

Deskriptor Öffentlich
Abgelaufen
 expired boolean

Deskriptor abgelaufen
Id
 id string

Deskriptor-ID
Obligatorisch.
 mandatory boolean

Obligatorischer Deskriptor
Etikett
 label string

Beschreibungsbezeichnung
Typ
 type string

Deskriptortyp
Rollen
 roles array of Role
Besitzer
 owners array of Person
Flow
 flow Flow
defaultValues
 defaultValues DefaultValues

defaultValues
Instanzen
 instances array of object

Person

Name Pfad Typ Beschreibung
UID
 uid string

Personen-UID
Vorname
 givenName string

Vorname der Person
Nachname
 familyName string

Nachname der Person
Email
 email string

Personen-E-Mail
Language
 language string

Person Language
Bestellung
 order integer

Personenbestellung

Dokument

Name Pfad Typ Beschreibung
Etikett
 label string

Dokumentbezeichnung
Typ
 type string

Dokumenttyp
Hash
 hash integer

Dokumenthash
Num. Max.
 numMax integer

Dokumentnummer. Max.
Num. Min
 numMin integer

Dokumentnummer. Min
UID
 uid string

Dokument-UID
Namespace
 namespace string

Dokumentnamespace
Quelle
 source string

Dokumentquelle
Erstellt
 created string

Dokument erstellt
Name
 name string

Dokumentname
Id
 id string

Dokument-ID
Geändert
 modified string

Geändertes Dokument
Rejected
 rejected boolean

Dokument abgelehnt
Signed
 signed boolean

Signiertes Dokument
Papierkorb
 trashed boolean

Dokumentkorb
Abgebrochen
 aborted boolean

Dokument abgebrochen
Version
 version integer

Dokumentversion
attachments
 attachments array of Attachment
Flow
 flow Flow
roles
 roles array of Role
Template
 template Template
Deskriptor
 descriptor Descriptor
Signaturen
 signatures array of Signature

Attachment

Name Pfad Typ Beschreibung
Etikett
 label string

Anlagenbezeichnung
Num. Max.
 numMax integer

Anlagenummer. Max.
Num. Min
 numMin integer

Anlagennummer.Min
Hash
 hash integer

Anlagenhash

Template

Name Pfad Typ Beschreibung
Typ
 type string

Vorlagentyp
HTML
 html string
PDFHTML
 pdfHtml string
Id
 id string
UID
 uid string
Namespace
 namespace string
Version
 version integer
Erstellt
 created string
Geändert
 modified string
Geändert
 published boolean
Abgeschlossen
 completed boolean
Abgebrochen
 aborted boolean

Signature

Name Pfad Typ Beschreibung
ID
 id string
Ursprung
 origin string
Vorname
 givenName string

Vorname
Nachname
 familyName string

Nachname
Email
 email string

Email
IP
 ip string
Datum
 date string
Der Status
 status string
Kommentar
 comment string

Standardwerte

defaultValues

Name Pfad Typ Beschreibung
Person
 signer Person
Person
 reviewer Person

Notification

Name Pfad Typ Beschreibung
ID
 id string
UID
 uid string
Namespace
 namespace string
Der Status
 status string
Bestellung
 order integer
Einzelheiten
 details object
Datum
 date string