PKIsigning (Vorschau)
Automatisieren Sie Ihre Dokumentsignaturanforderungen mit dem PKIsigning-Plattformconnector. Senden von Dokumenten an die PKIsigning-Plattform; Einladungen senden und die signierten Dokumente abrufen.
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 | PKIsigning-Unterstützung |
| URL | https://pkisigning.nl/support |
| support@pkisigning.nl |
| Connectormetadaten | |
|---|---|
| Herausgeber | SBRS B.V. |
| Webseite | https://pkisigning.nl |
| Datenschutzrichtlinie | https://pkisigning.nl/privacy |
| Kategorien | Zusammenarbeit; Produktivität |
PKIsigning ermöglicht Es Organisationen, den Prozess der Genehmigung, Signierung und Übermittlung von Dokumenten an Kunden und Dritte zu automatisieren, zu vereinfachen und zu sichern. Die Plattform unterstützt alle eIDAS persönlichen Signaturzertifikate von niederländischen qualifizierten vertrauenswürdigen Dienstanbietern und ist ISO27001 zertifiziert. Dies macht PKIsigning zu einem idealen Partner für juristische, finanz- und gesundheitsrechtliche Organisationen und Regierungen. Verbinden Sie sich mit PKisigning, um Ihren Dokumentsignierungsprozess zu automatisieren, zu vereinfachen und zu sichern.
Voraussetzungen
Um den PKIsigning-Connector zu verwenden, ist innerhalb eines "professionellen" Abonnements ein Konto für die PKIsigning-Plattform erforderlich. Wenden Sie sich an PKIsigning , um sich für ein kostenpflichtiges Abonnement zu registrieren.
So erhalten Sie Anmeldeinformationen
Nach der Registrierung für ein Abonnement erhalten Benutzer eine E-Mail mit einer Einladung zum Einrichten ihres Kontos. Nach der Registrierung kann dieses Konto direkt mit diesem Connector verwendet werden.
Erste Schritte mit Ihrem Connector
Der Standardfluss zum Starten der Signatur von Dokumenten lautet wie folgt:
- Dossier erstellen
- Hinzufügen von Dokumenten
- Hinzufügen von Actor(n)
- Workflow starten
- Verwenden eines Triggers zum Benachrichtigen von Statusänderungen
- Dossier herunterladen
Dossiers
PKIsigning erwartet, dass Sie immer zuerst ein Dossier erstellen. Ein Dossier fungiert als Container für Dokumente und Akteure. Mit der Dossiers_Create Aktion kann ein Dossier erstellt werden. Nachdem ein Dossier erstellt wurde, verwenden Sie bitte die zurückgegebene PkisId als Referenz für zukünftige Aktionen.
Dokumente
Nachdem ein Dossier erstellt wurde, können Sie Dokumente mit der Documents_Add Aktion mithilfe der richtigen DossierId hinzufügen. Die Aktion benötigt keine anderen Parameter, da sie von den Dokumentdateien selbst abgelenkt werden. Es gibt keine Beschränkung für die Anzahl der Dokumente in einem Dossier. Alle Dokumente können für alle hinzugefügten Akteure angezeigt und heruntergeladen werden.
Wichtig: Das Dokument benötigt je nach Anzahl der Signaturen einen oder mehrere eindeutige Textplatzhalter, um anzugeben, wo eine Signatur platziert werden muss und welcher Akteur. Dies kann beliebiger Text an beliebiger Stelle im Dokument sein. Beim Hinzufügen von Schauspielern können Sie den Platzhalter mit dem Platzhalterparameter definieren. Beispiel: Signatur1, Signatur2 usw.
Actors
Der dritte Schritt besteht darin, den Dokumenten Akteure hinzuzufügen. Dies erfolgt mit der Actor_Create Aktion mithilfe der richtigen DossierId und documentId.
Workflow starten
Verwenden Sie die Dossiers_StartWorkflow Aktion mit der richtigen DossierId, um einen Workflow zu starten und alle Akteure effektiv einzuladen, um Dokumente in der angegebenen Reihenfolge zu signieren oder herunterzuladen.
Verwenden eines Triggers zum Benachrichtigen von Statusänderungen
Um das Dokument abzurufen, nachdem es signiert wurde, abonnieren Sie Benachrichtigungen mithilfe eines Triggers. Geben Sie 'Status' im Feld "Ereignisse" an, um die Statusbenachrichtigung zu erhalten.
Dossier herunterladen
Wenn der Trigger über eine Statusaktualisierung benachrichtigt wird, überprüfen Sie, ob der Status des Dokuments "Abgeschlossen" ist. Ab diesem Zeitpunkt ist es möglich, alle Dokumente im Dossier in einer einzigen Zipfile herunterzuladen. Wenn es in den Einstellungen innerhalb der PKIsigning-Plattform angegeben ist, dass ein Audittrail generiert werden soll, wird dies ebenfalls einbezogen.
Bekannte Probleme und Einschränkungen
Im Moment der Veröffentlichung sind keine Probleme bekannt.
Häufige Fehler und Abhilfemaßnahmen
Keine Statusaktualisierungen durch Trigger
Wenn der Trigger nicht auf Statusaktualisierungen reagiert, überprüfen Sie bitte, ob der Wert "Status" im Feld "Ereignisse" angegeben wurde.
HTTP-Fehler 402 Zahlung erforderlich
Die PKIsigning-Plattform erforderte Guthaben zum Ausführen von Aktionen. Wenn Akteure hinzugefügt werden, sind Guthaben reserviert, um sicherzustellen, dass die Aktion stattfinden kann, und eingeladene Personen werden nicht mit Problemen in Bezug auf eine unzureichende Anzahl verfügbarer Credits konfrontiert. Wenn viele Einladungen an Akteure gesendet werden, kann es vorkommen, dass das Kreditpaket keine weiteren Guthaben reserviert hat. Zu diesem Zeitpunkt wird ein HTTP 402-Fehler zurückgegeben.
Um das Problem zu beheben, entweder PKIsigning-Unterstützung , um den Kreditsaldo aufzulisten, oder bereinigen Sie alle nicht gesendeten Dossiers mit Akteuren im Recyclingbin auf der Plattform. Nicht verwendete Guthaben werden dann wieder verfügbar.
Häufig gestellte Fragen
Bitte besuchen Sie unsere Knowledgebase oder kontaktieren Sie uns unter support@pkisigning.nl
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen von Akteurdaten |
Gibt alle Daten für einen bestimmten Akteur zurück. |
| Abrufen von Akteurdaten nach Anforderung |
Gibt alle Daten aller Akteure für eine bestimmte Anforderung zurück. |
| Abrufen von Akteurdaten nach Dokument |
Gibt alle Daten aller Akteure für ein bestimmtes Dokument zurück. |
| Abrufen von Anforderungsdaten |
Gibt alle (Meta)-Daten für eine bestimmte Anforderung zurück. |
| Abrufen von Arbeitsgruppen für Benutzer |
Gibt eine Liste aller Arbeitsgruppen für einen bestimmten Benutzer einer bestimmten Organisation zurück. |
| Abrufen von Dokumentdaten |
Gibt alle (Meta)-Daten für ein bestimmtes Dokument zurück. |
| Actor löschen |
Löscht dauerhaft einen bestimmten Akteur. |
| Akteur aktualisieren |
Ändert Daten für einen bestimmten Akteur. |
| Akteur erstellen |
Erstellt einen neuen Akteur und fügt ihn einem Dokument hinzu. |
| Anforderung aktualisieren |
Ändert Daten für eine bestimmte Anforderung. |
| Anforderung erstellen |
Erstellen Sie eine neue Anforderung. |
| Anforderung senden |
Startet den Workflow und sendet eine Einladung an den ersten Akteur in zeile für eine bestimmte Anforderung. |
| Arbeitsgruppen für Organisation abrufen |
Gibt eine Liste aller Arbeitsgruppen für eine bestimmte Organisation zurück. |
| Dokument aktualisieren |
Ändert Daten für ein bestimmtes Dokument. |
| Dokument erstellen |
Erstellt ein neues Dokument und fügt es einer bestimmten Anforderung hinzu. |
| Dokument löschen |
Löscht ein bestimmtes Dokument endgültig. |
| Downloadanforderung |
Lädt eine Anforderung und deren Inhalt als .zip Datei herunter. |
| Einladung erneut senden |
Sendet die Einladung für den aktuellen Akteur entsprechend einer bestimmten Anforderung erneut. |
| Einladung zurückziehen |
Widerruft die Einladung für den aktuellen Akteur im Einklang mit einer bestimmten Anfrage. |
| Löschen einer Anforderung |
Löscht eine bestimmte Anforderung endgültig. |
Abrufen von Akteurdaten
Gibt alle Daten für einen bestimmten Akteur zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
|
Akteur-ID
|
actorId | True | guid |
Eindeutige ID eines Akteurs. |
Gibt zurück
- Body
- ExtendedSignerModel
Abrufen von Akteurdaten nach Anforderung
Gibt alle Daten aller Akteure für eine bestimmte Anforderung zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Hat Actor auf die Anforderung reagiert
|
hasActed | boolean |
Read only value to check if an actor has acted on the document already. |
Gibt zurück
- response
- array of ExtendedSignerModel
Abrufen von Akteurdaten nach Dokument
Gibt alle Daten aller Akteure für ein bestimmtes Dokument zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
|
Aktion abgeschlossen
|
hasActed | boolean |
Gibt nur Akteure zurück, die ihre Aktion nicht abgeschlossen haben oder nicht abgeschlossen haben, lassen Sie nichts, um alle Schauspieler zurückzugeben. |
Gibt zurück
- response
- array of ExtendedSignerModel
Abrufen von Anforderungsdaten
Gibt alle (Meta)-Daten für eine bestimmte Anforderung zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Authentifizierungsschlüssel
|
callbackAuthenticationKey | string |
Authentifizierungsschlüssel, wie vom Trigger angegeben. |
Gibt zurück
- Body
- RequestModel
Abrufen von Arbeitsgruppen für Benutzer
Gibt eine Liste aller Arbeitsgruppen für einen bestimmten Benutzer einer bestimmten Organisation zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Organisations-ID
|
organisationId | True | guid |
Eindeutige ID einer Organisation. |
|
Nutzername
|
username | True |
E-Mail-Adresse des Benutzers |
Gibt zurück
- response
- array of OrganisationWorkgroup
Abrufen von Dokumentdaten
Gibt alle (Meta)-Daten für ein bestimmtes Dokument zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
Gibt zurück
Allgemeine Metadaten des Dokuments
Actor löschen
Löscht dauerhaft einen bestimmten Akteur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
|
Akteur-ID
|
actorId | True | guid |
Eindeutige ID eines Akteurs. |
Akteur aktualisieren
Ändert Daten für einen bestimmten Akteur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
|
Akteur-ID
|
actorId | True | guid |
Eindeutige ID eines Akteurs. |
|
Maßnahme
|
action | True | string |
Aktion, die der Akteur ausführen muss. |
|
Vorname
|
firstname | True | string |
Vorname des Akteurs. |
|
Präfix
|
prefix | string |
Präfix des Akteurs. |
|
|
Nachname
|
lastname | True | string |
Nachname des Akteurs. |
|
E-Mail-Adresse
|
True | string |
E-Mail-Adresse des Akteurs. |
|
|
Mobiltelefonnummer
|
mobile | True | string |
Mobiltelefonnummer des Akteurs. |
|
Deadline
|
deadline | True | date-time |
Das Datum und die Uhrzeit, zu dem die Aktion vom Akteur ausgeführt werden muss. |
|
Language
|
language | True | string |
Sprache für die Einladung. |
|
Verwenden einer starken Überprüfung
|
validateRealIdentity | True | boolean |
Verwenden Sie eine stärkere Identifizierungsmethode für diesen Akteur. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string |
Gibt zurück
- Body
- ExtendedSignerModel
Akteur erstellen
Erstellt einen neuen Akteur und fügt ihn einem Dokument hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
|
Maßnahme
|
action | True | string |
Aktion, die der Akteur ausführen muss. |
|
Vorname
|
firstname | True | string |
Vorname des Akteurs. |
|
Präfix
|
prefix | string |
Präfix des Akteurs. |
|
|
Nachname
|
lastname | True | string |
Nachname des Akteurs. |
|
E-Mail-Adresse
|
True | string |
E-Mail-Adresse des Akteurs. |
|
|
Mobiltelefonnummer
|
mobile | True | string |
Mobiltelefonnummer des Akteurs. |
|
Deadline
|
deadline | True | date-time |
Das Datum und die Uhrzeit, zu dem die Aktion vom Akteur ausgeführt werden muss. |
|
Language
|
language | True | string |
Sprache für die Einladung. |
|
Verwenden einer starken Überprüfung
|
validateRealIdentity | True | boolean |
Verwenden Sie eine stärkere Identifizierungsmethode für diesen Akteur. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
message
|
message | string | ||
|
Signaturfeld
|
fieldName | string |
Der Name eines vorhandenen Signaturfelds im Dokument, damit dieser Akteur signieren kann. |
|
|
Platzhalter
|
placeholder | string |
Der Text eines bestimmten Platzhalters im Dokument, in dem der Akteur eine Signatur platzieren muss. |
Gibt zurück
- Body
- ExtendedSignerModel
Anforderung aktualisieren
Ändert Daten für eine bestimmte Anforderung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Anforderungsname
|
name | True | string |
Name für eine bestimmte Anforderung. |
|
Arbeitsgruppen-ID
|
workgroupId | guid |
Eindeutige ID einer Arbeitsgruppe. |
|
|
Sicherheitsfreigabestufe
|
clearancelevel | True | integer |
Sicherheitsfreigabe für eine bestimmte Anforderung. |
|
Besitzer anfordern
|
owner |
Benutzer, der besitzer einer bestimmten Anforderung ist. |
Gibt zurück
- Body
- RequestModel
Anforderung erstellen
Erstellen Sie eine neue Anforderung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anforderungsname
|
name | True | string |
Name für eine bestimmte Anforderung. |
|
Arbeitsgruppen-ID
|
workgroupId | guid |
Eindeutige ID einer Arbeitsgruppe. |
|
|
Sicherheitsfreigabestufe
|
clearancelevel | True | integer |
Sicherheitsfreigabe für eine bestimmte Anforderung. |
|
Besitzer anfordern
|
owner |
Benutzer, der besitzer einer bestimmten Anforderung ist. |
Gibt zurück
- Body
- RequestModel
Anforderung senden
Startet den Workflow und sendet eine Einladung an den ersten Akteur in zeile für eine bestimmte Anforderung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
Arbeitsgruppen für Organisation abrufen
Gibt eine Liste aller Arbeitsgruppen für eine bestimmte Organisation zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Organisations-ID
|
organisationId | True | guid |
Eindeutige ID einer Organisation. |
Gibt zurück
- response
- array of OrganisationWorkgroup
Dokument aktualisieren
Ändert Daten für ein bestimmtes Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
|
Dokumentname
|
name | string |
Name für ein bestimmtes Dokument |
|
|
Dokumentdateiname
|
filename | string |
Dateiname für ein bestimmtes Dokument |
|
|
Dokumenttyp
|
documentType | True | string |
Der Typ für ein bestimmtes Dokument. (Z.B. Reguläre PDF, Geschäftserklärung, Rechnungsprüferbericht usw.). |
Gibt zurück
Allgemeine Metadaten des Dokuments
Dokument erstellen
Erstellt ein neues Dokument und fügt es einer bestimmten Anforderung hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung, zu der dieses Dokument gehört. |
|
Datei
|
file | True | file |
Die zu verarbeitende Datei (nur bestimmte Dateitypen). |
Gibt zurück
Allgemeine Metadaten des Dokuments
Dokument löschen
Löscht ein bestimmtes Dokument endgültig.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
|
Dokument-ID
|
documentId | True | guid |
Eindeutige ID eines Dokuments. |
Downloadanforderung
Lädt eine Anforderung und deren Inhalt als .zip Datei herunter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
Gibt zurück
- response
- file
Einladung erneut senden
Sendet die Einladung für den aktuellen Akteur entsprechend einer bestimmten Anforderung erneut.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
Einladung zurückziehen
Widerruft die Einladung für den aktuellen Akteur im Einklang mit einer bestimmten Anfrage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
Löschen einer Anforderung
Löscht eine bestimmte Anforderung endgültig.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anfrage-ID
|
requestId | True | guid |
Eindeutige ID einer Anforderung. |
Auslöser
| Wenn ein Ereignis auf einer Anforderung auftritt |
Registrieren Sie eine URL für den Rückruf bei einer Statusänderung. Die PKIsigning-Plattform meldet alle Statusupdates von Dossiers innerhalb dieser Organisation an diese URL. |
Wenn ein Ereignis auf einer Anforderung auftritt
Registrieren Sie eine URL für den Rückruf bei einer Statusänderung. Die PKIsigning-Plattform meldet alle Statusupdates von Dossiers innerhalb dieser Organisation an diese URL.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignistypen
|
Events | True | array of string |
Eine Liste der Ereignistypen, die auf einer Anforderung auftreten, von der dieser Auslöser benachrichtigt wird |
|
Organisations-ID
|
organisationId | True | guid |
Eindeutige ID einer Organisation. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anfrage-ID
|
PkisId | guid |
Eindeutige ID einer Anforderung. |
|
Anforderungsstatus
|
DossierStatus | string |
Status des Dossiers. |
|
Ursache
|
Reason | string |
Grund der Änderung. |
|
Authentifizierungsschlüssel
|
AuthenticationKey | string |
Header zum Abrufen von Metadaten für die Anforderung. |
Definitionen
ExtendedSignerModel
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Signaturfeld
|
fieldName | string |
Der Name eines vorhandenen Signaturfelds im Dokument, damit dieser Akteur signieren kann. |
|
Platzhalter
|
placeholder | string |
Der Text eines bestimmten Platzhalters im Dokument, in dem der Akteur eine Signatur platzieren muss. |
|
Maßnahme
|
action | string |
Aktion, die der Akteur ausführen muss. |
|
Vorname
|
firstname | string |
Vorname des Akteurs. |
|
Präfix
|
prefix | string |
Präfix des Akteurs. |
|
Nachname
|
lastname | string |
Nachname des Akteurs. |
|
E-Mail-Adresse
|
string |
E-Mail-Adresse des Akteurs. |
|
|
Mobiltelefonnummer
|
mobile | string |
Mobiltelefonnummer des Akteurs. |
|
Deadline
|
deadline | date-time |
Das Datum und die Uhrzeit, zu dem die Aktion vom Akteur ausgeführt werden muss. |
|
Language
|
language | string |
Sprache für die Einladung. |
|
Verwenden einer starken Überprüfung
|
validateRealIdentity | boolean |
Verwenden Sie eine stärkere Identifizierungsmethode für diesen Akteur. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
Akteur-ID
|
id | guid |
Eindeutige ID eines bestimmten Akteurs. |
|
Datum des Abschlusses
|
signingDate | date-time |
Das Datum und die Uhrzeit, zu dem der Akteur seine Aktion ausgeführt hat. |
|
Aktion abgeschlossen
|
hasSigned | boolean | |
|
Vollständiger Name
|
fullName | string |
Kombinierter Vorname, Präfix und Nachname des Akteurs. |
|
Statusinformationen
|
emailActivity | array of EmailActivity |
Statusinformationen zum Prozess der Ausführung der Aktion durch den Akteur. |
|
documentId
|
documentId | guid |
EmailActivity
Metadaten von E-Mail-Nachrichten, die an einen Akteur gesendet werden
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
E-Mail-Aktivitäten
|
event | string |
E-Mail-Aktivität für eine bestimmte Anforderung und einen Bestimmten Akteur. |
|
SMTP-Informationen
|
reason | string |
SMTP-Informationen für eine E-Mail, die als Teil einer Anforderung an einen bestimmten Akteur gesendet wird. |
|
E-Mail-Datum
|
timestamp | date-time |
Datum für eine E-Mail, die als Teil einer Anforderung an einen bestimmten Akteur gesendet wurde. |
|
E-Mail-Typ
|
pkisMessageType | string |
Geben Sie eine E-Mail ein, die als Teil einer Anforderung an einen bestimmten Akteur gesendet wird (z. B. Einladung, Erinnerung usw.). |
|
E-Mail-Anforderungs-ID
|
pkisInviteId | string |
Eindeutige ID für eine E-Mail, die als Teil einer Anforderung an einen bestimmten Akteur gesendet wurde. |
|
E-Mail-Adresse
|
string |
E-Mail-Adresse für eine E-Mail, die als Teil einer Anforderung an einen bestimmten Akteur gesendet wurde. |
SignerModel
Spezieller Akteurtyp
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Maßnahme
|
action | string |
Aktion, die der Akteur ausführen muss. |
|
Vorname
|
firstname | string |
Vorname des Akteurs. |
|
Präfix
|
prefix | string |
Präfix des Akteurs. |
|
Nachname
|
lastname | string |
Nachname des Akteurs. |
|
E-Mail-Adresse
|
string |
E-Mail-Adresse des Akteurs. |
|
|
Mobiltelefonnummer
|
mobile | string |
Mobiltelefonnummer des Akteurs. |
|
Deadline
|
deadline | date-time |
Das Datum und die Uhrzeit, zu dem die Aktion vom Akteur ausgeführt werden muss. |
|
Language
|
language | string |
Sprache für die Einladung. |
|
Verwenden einer starken Überprüfung
|
validateRealIdentity | boolean |
Verwenden Sie eine stärkere Identifizierungsmethode für diesen Akteur. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
message
|
message | string | |
|
Signaturfeld
|
fieldName | string |
Der Name eines vorhandenen Signaturfelds im Dokument, damit dieser Akteur signieren kann. |
|
Platzhalter
|
placeholder | string |
Der Text eines bestimmten Platzhalters im Dokument, in dem der Akteur eine Signatur platzieren muss. |
DocumentMetaDataModel
Allgemeine Metadaten des Dokuments
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumentname
|
name | string |
Name für ein bestimmtes Dokument. |
|
Letzte Dokumentaktualisierung
|
lastUpdate | date-time |
Datum der letzten Aktualisierung für ein bestimmtes Dokument. |
|
Anzahl der Dokumentseiten
|
pages | integer |
Anzahl der Seiten für ein bestimmtes Dokument. |
|
Erstellungsdatum des Dokuments
|
created | date-time |
Erstellungsdatum für ein bestimmtes Dokument. |
|
Dokument-ID
|
id | guid |
Eindeutige ID eines Dokuments. |
|
Dokumentstatus
|
status | string |
Status für ein bestimmtes Dokument. (z.B. neu, abgeschlossen usw.). |
|
Dokument enthält Signatur
|
signed | boolean |
Gibt an, ob ein bestimmtes Dokument bereits eine oder mehrere Signaturen enthält. |
|
Dokumentsignaturen
|
signatures | array of SignatureData |
Liste aller Signaturen für ein bestimmtes Dokument. |
|
Leere Dokumentsignaturfelder
|
emptySignatureFields | array of SignatureField |
Liste aller leeren Signaturfelder für ein bestimmtes Dokument. |
|
Leere Signaturfelder
|
containsBlankSignatureFields | boolean |
Gibt an, ob ein bestimmtes Dokument leere Signaturfelder enthält. |
|
Dokumentakteure
|
actors | array of ExtendedSignerModel |
Liste aller Akteure für ein bestimmtes Dokument. |
|
Anfrage-ID
|
requestId | guid |
Eindeutige ID einer Anforderung. |
|
Anforderungsindex
|
dossierIndex | integer |
Der Index aller Dokumente, die zu einer bestimmten Anforderung gehören. |
|
documentSize
|
documentSize | integer |
Die Größe eines Dokuments, das zu einer bestimmten Anforderung gehört. |
|
documentType
|
documentType | string |
Der Typ eines Dokuments, das zu einer bestimmten Anforderung gehört. |
SignatureData
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Felder des Zertifikatsbetreffs
|
subject | array of KeyValuePairOfStringAndString |
Felder aus der Betreffzeile des Zertifikats, das für eine bestimmte Signatur verwendet wird. |
|
Felder für Zertifikataussteller
|
issuer | array of KeyValuePairOfStringAndString |
Felder aus der Ausstellerzeile des Zertifikats, das für eine bestimmte Signatur verwendet wird. |
|
Signaturdatum
|
date | date-time |
Datum und Uhrzeit der Platzierung einer bestimmten Signatur. |
|
Signaturspeicherort
|
location | string |
Der geografische Standort eines bestimmten Akteurs zum Zeitpunkt der Unterzeichnung. |
|
Signaturgrund
|
reason | string |
Der Grund für die Unterzeichnung, wie von einem bestimmten Akteur zum Zeitpunkt der Unterzeichnung angegeben. |
|
Qualifizierte elektronische Signatur
|
euQualified | boolean |
Gibt an, ob eine bestimmte Signatur qualifiziert ist (QeS) die eIDAS-Vorschriften erfüllt. |
|
Erweiterte elektronische Signatur
|
advanced | boolean |
Gibt an, ob eine bestimmte Signatur erweitert (AeS) eIDAS-Vorschriften erfüllt. |
|
Qualifiziertes eSeal
|
eSeal | boolean |
Gibt an, ob ein bestimmtes Zertifikat, das zum Signieren oder Versiegeln verwendet wird, ein qualifiziertes eSeal-konformes eIDAS-Gesetz ist. |
|
Actor-IP-Adresse
|
ipAddress | string |
Die IP-Adresse für einen bestimmten Akteur |
|
Signaturfeld
|
signatureField | string |
Das Feld, das signiert wurde |
|
Signaturbild
|
signatureImage | string |
Die Bilddatei, die für eine bestimmte Signatur verwendet wurde, wie sie von einem Akteur ausgewählt wurde. |
KeyValuePairOfStringAndString
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | string |
SignatureField
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Signaturfeldname
|
name | string |
Name für ein bestimmtes Signaturfeld |
|
Signaturfeldseite
|
page | integer |
Seite, auf der ein bestimmtes Signaturfeld für ein bestimmtes Dokument platziert wird. |
|
Koordinaten der Signaturfeldbreite
|
x | double |
Der Breiteswert der Position für ein bestimmtes Signaturfeld relativ zur Seite, auf der es in einem bestimmten Dokument platziert wird. |
|
Signaturfeld-Hight-Koordinate
|
y | double |
Hight value of the position for a specific signature field relative to the page it is placed in a specific document. |
|
Signaturfeld hight
|
height | double |
Hight-Wert für ein bestimmtes Signaturfeld. |
|
Signaturfeldbreite
|
width | double |
Width-Wert für ein bestimmtes Signaturfeld. |
OrganisationWorkgroup
Eine Arbeitsgruppe, die in einem Dossier verwendet wird
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Arbeitsgruppen-ID
|
id | guid |
Eindeutige ID einer Arbeitsgruppe |
|
Arbeitsgruppenname
|
name | string |
Name für eine bestimmte Arbeitsgruppe |
RequestModel
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anfrage-ID
|
id | guid |
Eindeutige ID einer Anforderung |
|
Anforderungsname
|
dossierName | string |
Name für eine bestimmte Anforderung. |
|
Dokumente anfordern
|
documents | array of DocumentModel |
Liste der Dokumente, die in dieser Anforderung enthalten sind. |
|
Anforderungsstatus
|
status | string |
Status für eine bestimmte Anforderung. (z.B. neu, abgeschlossen usw.). |
|
Anfordern von Akteuren
|
actors | array of ExtendedSignerModel |
Liste aller Akteure für eine bestimmte Anforderung. |
|
Dokumentsignaturen
|
signatures | array of SignatureData |
Liste aller Signaturen für eine bestimmte Anforderung. |
|
Anforderungstyp
|
dossierType | string |
Der Typ für eine bestimmte Anforderung. (E.g. PDF, SBR Assurance usw.). |
|
Grund für den Abbruch
|
reasons | string |
Grund für die Kündigung einer bestimmten Anforderung durch einen Benutzer oder Akteur. |
|
Signierernotiz
|
signerNote | string |
Beachten Sie für einen oder mehrere Akteur(en), die keine andere Aktion als das Vorzeichen aufweisen. |
|
Empfängernotiz
|
recipientNote | string |
Hinweis für einen oder mehrere Akteur(en), die keine andere Aktion als downloaden. |
|
Genehmigende Notiz
|
accorderNote | string |
Beachten Sie für einen oder mehrere Akteur(en), die keine andere Aktion als die Genehmigungsanforderung haben. |
|
Ablaufdatum der Anforderung
|
expires | date-time |
Datum und Uhrzeit des Ablaufs für eine bestimmte Anforderung. |
|
Statusinformationen
|
emailActivity | array of EmailActivity |
Statusinformationen zum Prozess der Ausführung der Aktion durch den Akteur. |
|
Meine Anfrage
|
myDossier | boolean |
Gibt an, ob Sie der Besitzer einer bestimmten Anforderung sind. |
|
Arbeitsgruppen-ID
|
workgroup | guid |
Eindeutige ID einer Arbeitsgruppe. |
|
Sicherheitsfreigabestufe
|
clearancelevel | integer |
Sicherheitsfreigabe für eine bestimmte Anforderung. |
DocumentModel
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokument-ID
|
id | guid |
Eindeutige ID eines Dokuments |
|
Dokumentname
|
name | string |
Name eines bestimmten Dokuments |
|
Dokumenttyp
|
documentType | string |
Geben Sie einen Bestimmten Dokumenttyp ein. |
|
Anforderungsindex
|
dossierIndex | integer |
Der Index aller Dokumente, die zu einer bestimmten Anforderung gehören. |
|
Dokumentstatus
|
documentstatus | string |
Status für ein bestimmtes Dokument. (z.B. neu, abgeschlossen usw.). |
|
Dokumentakteure
|
actors | array of SignerModel |
Liste aller Akteure für ein bestimmtes Dokument. |
file
Dies ist der grundlegende Datentyp "Datei".