Certinal eSign (Vorschau)
Certinal eSign ermöglicht Unternehmen das sichere Senden, Signieren und Verwalten von Dokumenten mit global konformen eSignaturen. Certinal wurde für regulierte Branchen entwickelt und bietet Echtzeit-Workflowverfolgung, manipulationssichere Überwachungspfade und nahtlose Automatisierung. Verwenden Sie Certinal eSign in Ihren Workflows, um Genehmigungen zu digitalisieren, Prozesse zu beschleunigen und rechtlich gültige Signaturen in 70 Ländern zu gewährleisten.
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 | Hilfe und Support |
| URL | https://www.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Certinal Inc. |
| Webseite | https://www.certinal.com/ |
| Datenschutzrichtlinie | https://www.certinal.com/privacy-policy |
| Kategorien | Produktivität; Unternehmensführung |
Certinal eSign
Überblick
Certinal eSign bietet Ihnen eine sichere, kompatible eSignature- und eConsent-Workflows für globale Unternehmen – Senden, Signieren, Nachverfolgen und Verwalten von Dokumenten direkt aus Power Automate.
Voraussetzungen
Sie müssen über das Certinal Admin-Konto verfügen, um den Connector-Trigger zu verwenden. Um den Connectortrigger in dieser Integration zu verwenden, muss Power Connector in Ihren Zertifikatadministratoreinstellungen aktiviert sein.
So erhalten Sie Anmeldeinformationen
Certinal verwendet DEN API-Schlüssel, um die Dienste zu authentifizieren. Sie müssen den API-Schlüssel aus dem Certinal Admin-Konto generieren.
Unterstützte Vorgänge
Der Connector unterstützt die folgenden Vorgänge:
Transaktionsdetails abrufen
Transaktionsdetails nach Transaktions-ID abrufen
Dokumente für Transaktion herunterladen
Herunterladen von Dokumenten für die angegebene Transaktions-ID
Transaktion erstellen
Transaktion erstellen
Transaktion mithilfe einer Vorlage erstellen
Erstellen einer Transaktion mit einer bestimmten Vorlagen-ID
Benutzer auflisten
Benutzer auflisten
Abrufen von Benutzerdetails
Abrufen von Benutzerdetails für bestimmte Benutzer-ID
Benutzer erstellen
Benutzer erstellen
Unterstützte Trigger
Der Connector unterstützt die folgenden Trigger:
Wenn ein Transaktionsstatus geändert wird
Registrieren eines Rückrufs für ein bestimmtes Transaktionsereignis
API-Dokumente:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Hilfe und Support
https://esign.certinal.com/esign/certinal-docs/help-support
Eine Verbindung herstellen
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 |
| Basis-API-Endpunkt | Schnur | Die Basis-URL für den API-Endpunkt (z. B. api.certinal.com) | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abonnement löschen |
Abonnement löschen |
| Abrufen von Benutzerdetails |
Abrufen von Benutzerdetails für bestimmte Benutzer-ID |
| Benutzer auflisten |
Benutzer auflisten |
| Benutzer erstellen |
Benutzer erstellen |
| Dokumente für Transaktion herunterladen |
Herunterladen von Dokumenten für die angegebene Transaktions-ID |
| Transaktion erstellen |
Transaktion erstellen |
| Transaktion mithilfe einer Vorlage erstellen |
Erstellen einer Transaktion mit einer bestimmten Vorlagen-ID |
| Transaktionsdetails abrufen |
Transaktionsdetails nach Transaktions-ID abrufen |
Abonnement löschen
Abonnement löschen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Webhook-ID
|
webhookId | True | string |
Der eindeutige Bezeichner des zu löschenden Webhook-Abonnements |
Abrufen von Benutzerdetails
Abrufen von Benutzerdetails für bestimmte Benutzer-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
Die eindeutige Benutzer-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Nachricht
|
message | string |
Nachricht |
|
Vorname
|
data.firstName | string |
Vorname |
|
Nachname
|
data.lastName | string |
Nachname |
|
Firma
|
data.company | string |
Firma |
|
Zeitzone
|
data.timezone | string |
Zeitzone |
|
Language
|
data.language | string |
Language |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Position
|
data.jobTitle | string |
Position |
|
Rufnummer
|
data.phoneNumber | string |
Rufnummer |
|
Ländercode
|
data.phoneCountryCode | string |
Ländercode |
|
Rollen
|
data.roles | array of string |
Rollen |
|
Ist die endgültige E-Mail deaktiviert?
|
data.finalMailDisabled | boolean |
Ist die endgültige E-Mail deaktiviert? |
|
Ist Erinnerungs-E-Mail deaktiviert?
|
data.reminderMailDisabled | boolean |
Ist Erinnerungs-E-Mail deaktiviert? |
|
Ist Absender-E-Mail deaktiviert?
|
data.senderMailDisabled | boolean |
Ist Absender-E-Mail deaktiviert? |
|
Ist integrationsbenutzer?
|
data.integrationUser | boolean |
Ist integrationsbenutzer? |
|
Salutation
|
data.salutation | string |
Salutation |
|
Ist aktiv
|
data.active | boolean |
Ist aktiv |
|
Id
|
data.id | string |
Id |
|
E-Mail-Adresse
|
data.emailAddress | string |
E-Mail-Adresse |
Benutzer auflisten
Benutzer auflisten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seitennummer
|
pageNo | True | integer | |
|
Datensätze pro Seite
|
perPageRecords | True | integer |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Nachricht
|
message | string |
Nachricht |
|
Datensätze insgesamt
|
data.totalRecords | integer |
Datensätze insgesamt |
|
Seiten insgesamt
|
data.totalPages | integer |
Seiten insgesamt |
|
Pro Seitendatensätze
|
data.perPageRecords | integer |
Pro Seitendatensätze |
|
Seitennummer
|
data.pageNo | integer |
Seitennummer |
|
Datensätze
|
data.records | array of object |
Benutzerdatensätze |
|
Vorname
|
data.records.firstName | string |
Vorname |
|
Nachname
|
data.records.lastName | string |
Nachname |
|
Firma
|
data.records.company | string |
Firma |
|
Zeitzone
|
data.records.timezone | string |
Zeitzone |
|
Language
|
data.records.language | string |
Language |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Position
|
data.records.jobTitle | string |
Position |
|
Rufnummer
|
data.records.phoneNumber | string |
Rufnummer |
|
Ländercode
|
data.records.phoneCountryCode | string |
Ländercode |
|
Rollen
|
data.records.roles | array of string |
Rollen |
|
Ist die endgültige E-Mail deaktiviert?
|
data.records.finalMailDisabled | boolean |
Ist die endgültige E-Mail deaktiviert? |
|
Ist Erinnerungs-E-Mail deaktiviert?
|
data.records.reminderMailDisabled | boolean |
Ist Erinnerungs-E-Mail deaktiviert? |
|
Ist Absender-E-Mail deaktiviert?
|
data.records.senderMailDisabled | boolean |
Ist Absender-E-Mail deaktiviert? |
|
Ist integrationsbenutzer?
|
data.records.integrationUser | boolean |
Ist integrationsbenutzer? |
|
Salutation
|
data.records.salutation | string |
Salutation |
|
Ist aktiv
|
data.records.active | boolean |
Ist aktiv |
|
Id
|
data.records.id | string |
Id |
|
E-Mail-Adresse
|
data.records.emailAddress | string |
E-Mail-Adresse |
Benutzer erstellen
Benutzer erstellen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E-Mail-Adresse
|
emailAddress | string |
E-Mail-Adresse |
|
|
Vorname
|
firstName | string |
Vorname |
|
|
Nachname
|
lastName | string |
Nachname |
|
|
Firma
|
company | string |
Firma |
|
|
Zeitzone
|
timezone | string |
Zeitzone |
|
|
Language
|
language | string |
Language |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Salutation
|
salutation | string |
Salutation |
|
|
Position
|
jobTitle | string |
Position |
|
|
Rufnummer
|
phoneNumber | string |
Rufnummer |
|
|
Ländercode
|
phoneCountryCode | string |
Ländercode |
|
|
Rollen
|
roles | array of string |
Rollen |
|
|
Ist die endgültige E-Mail deaktiviert?
|
finalMailDisabled | boolean |
Ist die endgültige E-Mail deaktiviert? |
|
|
Ist Erinnerungs-E-Mail deaktiviert?
|
reminderMailDisabled | boolean |
Ist Erinnerungs-E-Mail deaktiviert? |
|
|
Ist Absender-E-Mail deaktiviert?
|
senderMailDisabled | boolean |
Ist Absender-E-Mail deaktiviert? |
|
|
Ist integrationsbenutzer?
|
integrationUser | boolean |
Ist integrationsbenutzer? |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Nachricht
|
message | string |
Nachricht |
|
Benutzer-ID
|
data.user_id | string |
Benutzer-ID |
Dokumente für Transaktion herunterladen
Herunterladen von Dokumenten für die angegebene Transaktions-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Transaktions-ID
|
transactionId | True | string |
Die eindeutige Transaktions-ID |
|
Belegtyp
|
documentType | True | string |
Typ des herunterzuladenden Dokuments |
Gibt zurück
- response
- file
Transaktion erstellen
Transaktion erstellen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Transaktionsname
|
name | True | string |
Transaktionsname |
|
Nachricht
|
message | string |
Nachricht für alle Teilnehmer-E-Mails. |
|
|
Rückruf-URL
|
url | string |
Rückruf-URL |
|
|
Transaktionsereignisse
|
transactionEvents | array of string |
Transaktionsereignisse |
|
|
Teilnehmerereignisse
|
participantEvents | array of string |
Teilnehmerereignisse |
|
|
Transaktionsstatus
|
status | string |
Transaktionsstatus |
|
|
Externe ID
|
externalId | string |
Externe ID |
|
|
Läuft zum Zeitstempel ab
|
expiresAtTimestamp | string |
Transaktion läuft zum Zeitstempel ab |
|
|
Von Zeitstempel erinnern
|
remindFromTimestamp | string |
Von Zeitstempel erinnern |
|
|
Erinnerungshäufigkeit
|
reminderFrequency | integer |
Häufigkeit der Erinnerung |
|
|
Standardfelder
|
default | boolean |
Standardsignaturblockfelder |
|
|
Abfolge des Teilnehmers
|
sequence | integer |
Sequence |
|
|
Rolle
|
role | string |
Rolle |
|
|
Name
|
name | string |
Name des Kandidaten |
|
|
E-Mail-Adresse
|
emailAddress | string |
E-Mail-Adresse des Kandidaten |
|
|
Language
|
language | string |
Language |
|
|
Authentifizierungsmodus
|
authenticationMode | string |
Authentifizierungsmodus |
|
|
Authentifizierungsmoduswert
|
authenticationModeValue | string |
Authentifizierungsmoduswert |
|
|
Übermittlungskanäle
|
deliveryChannels | array of string |
Übermittlungskanäle |
|
|
Feld-ID
|
fieldId | string |
Feld-ID |
|
|
Seiten
|
pages | array of string |
Seiten |
|
|
Dokument-ID
|
documentId | string |
Dokument-ID |
|
|
Feldbreite
|
width | float |
Feldbreite |
|
|
Feldhöhe
|
height | float |
Feldhöhe |
|
|
Tooltip
|
tooltip | string |
Tooltip |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Anzahl der Textbereichszeilen
|
textareaLineCount | string |
Anzahl der Textbereichszeilen |
|
|
Feldname
|
fieldName | string |
Feldname |
|
|
X-Position
|
xposition | float |
X-Position des Felds |
|
|
Y-Position
|
yposition | float |
Y-Position des Felds |
|
|
Ist erforderlich?
|
required | boolean |
Ist dies ein Pflichtfeld? |
|
|
Ist schreibgeschützt?
|
readOnly | boolean |
Ist dies ein Schreibgeschütztes Feld? |
|
|
Textfeld
|
textarea | boolean |
Textfeld |
|
|
Oben unten
|
topBottom | boolean |
Oben unten |
|
|
Vertikal
|
vertical | boolean |
Vertikal |
|
|
Funkgruppen-ID
|
radioGroupId | string |
Funkgruppen-ID |
|
|
Standardwert
|
defaultValue | string |
Standardwert |
|
|
Wert
|
value | string |
Wert |
|
|
Beschriftung anzeigen
|
displayLabel | string |
Beschriftung anzeigen |
|
|
Name
|
name | string |
Name |
|
|
E-Mail-Adresse
|
emailAddress | string |
E-Mail-Adresse |
|
|
Language
|
language | string |
Language |
|
|
Dokument-ID
|
id | string |
Dokument-ID |
|
|
Sequence
|
sequence | integer |
Sequence |
|
|
Ist Deletable?
|
deletable | boolean |
Ist Deletable? |
|
|
Ist privat
|
private | boolean |
Ist privat |
|
|
Feldwert
|
value | string |
Feldwert |
|
|
Feldname
|
fieldName | string |
Feldname |
|
|
Code
|
code | string |
Code |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Nachricht
|
message | string |
Nachricht |
|
Transaktions-ID
|
data.transactionId | string |
Transaktions-ID |
Transaktion mithilfe einer Vorlage erstellen
Erstellen einer Transaktion mit einer bestimmten Vorlagen-ID
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Transaktionsname
|
name | string |
Transaktionsname |
|
|
Transaktionsstatus
|
status | string |
Transaktionsstatus |
|
|
Externe ID
|
externalId | string |
Externe ID |
|
|
Vorlagen-ID
|
templateId | string |
Vorlagen-ID |
|
|
Id der sekundären Vorlage
|
secondaryTemplateIds | array of string |
Id der sekundären Vorlage |
|
|
Nachricht
|
message | string |
Nachricht für alle Teilnehmer-E-Mails. |
|
|
Rückruf-URL
|
url | string |
Rückruf-URL |
|
|
Transaktionsereignisse
|
transactionEvents | array of string |
Transaktionsereignisse |
|
|
Teilnehmerereignisse
|
participantEvents | array of string |
Teilnehmerereignisse |
|
|
Abfolge des Teilnehmers
|
sequence | integer |
Sequence |
|
|
Rolle
|
role | string |
Rolle |
|
|
Ist der automatische Prozess?
|
autoProcess | boolean |
Ist der automatische Prozess? |
|
|
Feldname
|
fieldName | string |
Feldname |
|
|
Feldwert
|
value | string |
Feldwert |
|
|
Name
|
name | string |
Name des Kandidaten |
|
|
E-Mail-Adresse
|
emailAddress | string |
E-Mail-Adresse des Kandidaten |
|
|
Nachricht
|
message | string |
Nachricht |
|
|
Language
|
language | string |
Language |
|
|
Übermittlungskanäle
|
deliveryChannels | array of string |
Übermittlungskanäle |
|
|
Benutzerdefinierter SMS-Textkörper
|
customSMSBody | string |
Benutzerdefinierter SMS-Textkörper |
|
|
Name
|
name | string |
Name |
|
|
Nachricht
|
message | string |
Nachricht |
|
|
Ist erforderlich?
|
required | boolean |
Ist erforderlich? |
|
|
Name
|
name | string |
Name |
|
|
E-Mail-Adresse
|
emailAddress | string |
E-Mail-Adresse |
|
|
Language
|
language | string |
Language |
|
|
Feldwert
|
value | string |
Feldwert |
|
|
Feldname
|
fieldName | string |
Feldname |
|
|
Code
|
code | string |
Code |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Nachricht
|
message | string |
Nachricht |
|
Transaktions-ID
|
data.transactionId | string |
Transaktions-ID |
Transaktionsdetails abrufen
Transaktionsdetails nach Transaktions-ID abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Transaktions-ID
|
transactionId | True | string |
Die eindeutige Transaktions-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Nachricht
|
message | string |
Nachricht |
|
Transaktionsname
|
data.name | string |
Transaktionsname |
|
Transaktionsstatus
|
data.status | string |
Transaktionsstatus |
|
Transaktions-ID
|
data.transactionId | string |
Transaktions-ID |
|
Nachricht
|
data.mail.message | string |
Nachricht für alle Teilnehmer-E-Mails. |
|
Datum der letzten Aktualisierung
|
data.lastUpdatedDate | string |
Datum der letzten Aktualisierung |
|
Erstellt am
|
data.createdDate | string |
Erstellt am |
|
Benutzer-ID
|
data.createdBy.id | string |
Erstellt von Benutzer-ID |
|
Nutzername
|
data.createdBy.username | string |
Erstellt mit Benutzername |
|
E-Mail-Adresse
|
data.createdBy.emailAddress | string |
Erstellt durch E-Mail-Adresse |
|
Sendedatum
|
data.sentDate | string |
Sendedatum |
|
Benutzer-ID
|
data.lastActionPerformedBy.userId | string |
Benutzer-ID |
|
Benutzername
|
data.lastActionPerformedBy.userName | string |
Benutzername |
|
E-Mail-Adresse
|
data.lastActionPerformedBy.emailAddress | string |
E-Mail-Adresse |
|
Kandidaten-ID
|
data.lastActionPerformedBy.candidateId | string |
Kandidaten-ID |
|
Teilnehmer-ID
|
data.lastActionPerformedBy.participantId | string |
Teilnehmer-ID |
|
Läuft zum Zeitstempel ab
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transaktion läuft zum Zeitstempel ab |
|
Ablauftage
|
data.expiryAndReminders.expiryDays | integer |
Ablauftage |
|
Erinnerungstage erinnern
|
data.expiryAndReminders.remindFromReminderDays | integer |
Erinnerungstage erinnern |
|
Erinnerungszeit erinnern
|
data.expiryAndReminders.remindFromReminderTime | string |
Erinnerungszeit erinnern |
|
Erinnerungshäufigkeit
|
data.expiryAndReminders.reminderFrequency | integer |
Häufigkeit der Erinnerung |
|
Teilnehmer
|
data.participants | array of object |
Teilnehmer |
|
Teilnehmer-ID
|
data.participants.id | string |
Teilnehmer-ID |
|
Teilnehmerstatus
|
data.participants.status | string |
Teilnehmerstatus |
|
Datum der letzten Aktualisierung
|
data.participants.lastUpdatedDate | string |
Datum der letzten Aktualisierung |
|
Erstellt am
|
data.participants.createdDate | string |
Erstellt am |
|
Abfolge des Teilnehmers
|
data.participants.sequence | integer |
Sequence |
|
Rolle
|
data.participants.role | string |
Rolle |
|
Signaturmethode
|
data.participants.signingMethodDTO | array of string |
Signaturmethodendetails |
|
Vom Benutzer übermittelt
|
data.participants.submittedBys | array of object |
Vom Benutzer übermittelte Details |
|
Benutzer-ID
|
data.participants.submittedBys.userId | string |
Von der Benutzer-ID übermittelt |
|
Benutzername
|
data.participants.submittedBys.userName | string |
Übermittelt nach Benutzername |
|
E-Mail-Adresse
|
data.participants.submittedBys.emailAddress | string |
Von der E-Mail-Adresse des Benutzers übermittelt |
|
Kandidaten-ID
|
data.participants.submittedBys.candidateId | string |
Kandidaten-ID |
|
Kandidaten
|
data.participants.candidates | array of object |
Kandidaten |
|
Kandidaten-ID
|
data.participants.candidates.id | string |
Kandidaten-ID |
|
Name
|
data.participants.candidates.name | string |
Name des Kandidaten |
|
E-Mail-Adresse
|
data.participants.candidates.emailAddress | string |
E-Mail-Adresse des Kandidaten |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Typ
|
data.participants.candidates.type | string |
Typ |
|
Maßnahme
|
data.participants.candidates.action | string |
Maßnahme |
|
Aktionsdatum
|
data.participants.candidates.actionDate | string |
Aktionsdatum |
|
Erstellt am
|
data.participants.candidates.createdDate | string |
Erstellt am |
|
Authentifizierungsmoduswert
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Authentifizierungsmoduswert |
|
Signaturmethodendetails
|
data.participants.candidates.signingMethodDTO | array of string |
Signaturmethodendetails |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Übermittlungskanäle
|
data.participants.candidates.deliveryChannels | array of string |
Übermittlungskanäle |
|
Felder
|
data.participants.fields | array of object |
Felder |
|
Id
|
data.participants.fields.id | string |
Id |
|
Datum der letzten Aktualisierung
|
data.participants.fields.lastUpdatedDate | string |
Datum der letzten Aktualisierung |
|
Erstellt am
|
data.participants.fields.createdDate | string |
Erstellt am |
|
Feld-ID
|
data.participants.fields.fieldId | string |
Feld-ID |
|
Seite Nein
|
data.participants.fields.pageNo | integer |
Seite Nein |
|
Dokument-ID
|
data.participants.fields.documentId | string |
Dokument-ID |
|
Feldbreite
|
data.participants.fields.width | float |
Feldbreite |
|
Feldhöhe
|
data.participants.fields.height | float |
Feldhöhe |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Wert
|
data.participants.fields.value | string |
Wert |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Beschriftung anzeigen
|
data.participants.fields.displayLabel | string |
Beschriftung anzeigen |
|
Verknüpfungstyp
|
data.participants.fields.linkType | string |
Verknüpfungstyp |
|
Funk-ID
|
data.participants.fields.radioId | integer |
Funk-ID |
|
Funkgruppen-ID
|
data.participants.fields.radioGroupId | string |
Funkgruppen-ID |
|
Kontrollkästchen-ID
|
data.participants.fields.checkboxId | integer |
Kontrollkästchen-ID |
|
Feldname
|
data.participants.fields.fieldName | string |
Feldname |
|
X-Position
|
data.participants.fields.xposition | float |
X-Position des Felds |
|
Y-Position
|
data.participants.fields.yposition | float |
Y-Position des Felds |
|
Ist erforderlich?
|
data.participants.fields.required | boolean |
Ist dies ein Pflichtfeld? |
|
Ist schreibgeschützt?
|
data.participants.fields.readOnly | boolean |
Ist dies ein Schreibgeschütztes Feld? |
|
Textfeld
|
data.participants.fields.textarea | boolean |
Textfeld |
|
Vertikal
|
data.participants.fields.vertical | boolean |
Vertikal |
|
Oben unten
|
data.participants.fields.topBottom | boolean |
Oben unten |
|
Standardwert
|
data.participants.fields.defaultValue | string |
Standardwert |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
Ist erforderlich?
|
data.participants.signatureBlock.format.required | boolean |
Ist erforderlich? |
|
Standard
|
data.participants.signatureBlock.default | boolean |
Standard |
|
Stellvertretung aktivieren
|
data.participants.enableDelegate | boolean |
Stellvertretung aktivieren |
|
Automatischer Prozess
|
data.participants.autoProcess | boolean |
Automatischer Prozess |
|
CC-Benutzer
|
data.ccUsers | array of object |
CC-Benutzer |
|
Name
|
data.ccUsers.name | string |
Name |
|
E-Mail-Adresse
|
data.ccUsers.emailAddress | string |
E-Mail-Adresse |
|
Language
|
data.ccUsers.language | string |
Language |
|
Dokumente
|
data.documents | array of object |
Dokumente |
|
Dokument-ID
|
data.documents.id | string |
Dokument-ID |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Dateiname
|
data.documents.fileName | string |
Dateiname |
|
Seitenanzahl
|
data.documents.pageCount | integer |
Seitenanzahl |
|
Ist Deletable?
|
data.documents.deletable | boolean |
Ist Deletable? |
|
Ist privat
|
data.documents.private | boolean |
Ist privat |
|
Benutzerdefinierte Felder
|
data.customFields | array of object |
Benutzerdefinierte Felder |
|
Id des benutzerdefinierten Felds
|
data.customFields.customFieldId | string |
Id des benutzerdefinierten Felds |
|
Feldwert
|
data.customFields.value | string |
Feldwert |
|
Feldname
|
data.customFields.fieldName | string |
Feldname |
|
Feldtyp
|
data.customFields.fieldType | string |
Feldtyp |
|
Benachrichtigungsabonnements
|
data.notificationSubscriptions | array of |
Benachrichtigungsabonnements |
|
tags
|
data.tags | array of |
tags |
|
Weitere Dokumente
|
data.additionalDocuments | array of object |
Weitere Dokumente |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Dateiname
|
data.additionalDocuments.fileName | string |
Dateiname |
|
Typ
|
data.additionalDocuments.type | string |
Typ |
|
Kandidaten-ID
|
data.additionalDocuments.candidateId | string |
Kandidaten-ID |
|
Separate Vereinbarungen
|
data.separateAgreements | boolean |
Separate Vereinbarungen |
Trigger
| Wenn ein Transaktionsstatus geändert wird |
Registrieren eines Rückrufs für ein bestimmtes Transaktionsereignis |
Wenn ein Transaktionsstatus geändert wird
Registrieren eines Rückrufs für ein bestimmtes Transaktionsereignis
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignistyp
|
eventType | True | array |
Der zu registrierende Transaktionsereignistyp für |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zeitstempel
|
timestamp | integer |
Zeitstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Nachricht
|
message | string |
Nachricht |
|
Transaktionsname
|
data.name | string |
Transaktionsname |
|
Transaktionsstatus
|
data.status | string |
Transaktionsstatus |
|
Transaktions-ID
|
data.transactionId | string |
Transaktions-ID |
|
Nachricht
|
data.mail.message | string |
Nachricht für alle Teilnehmer-E-Mails. |
|
Datum der letzten Aktualisierung
|
data.lastUpdatedDate | string |
Datum der letzten Aktualisierung |
|
Erstellt am
|
data.createdDate | string |
Erstellt am |
|
Benutzer-ID
|
data.createdBy.id | string |
Erstellt von Benutzer-ID |
|
Nutzername
|
data.createdBy.username | string |
Erstellt mit Benutzername |
|
E-Mail-Adresse
|
data.createdBy.emailAddress | string |
Erstellt durch E-Mail-Adresse |
|
Sendedatum
|
data.sentDate | string |
Sendedatum |
|
Benutzer-ID
|
data.lastActionPerformedBy.userId | string |
Benutzer-ID |
|
Benutzername
|
data.lastActionPerformedBy.userName | string |
Benutzername |
|
E-Mail-Adresse
|
data.lastActionPerformedBy.emailAddress | string |
E-Mail-Adresse |
|
Kandidaten-ID
|
data.lastActionPerformedBy.candidateId | string |
Kandidaten-ID |
|
Teilnehmer-ID
|
data.lastActionPerformedBy.participantId | string |
Teilnehmer-ID |
|
Läuft zum Zeitstempel ab
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transaktion läuft zum Zeitstempel ab |
|
Ablauftage
|
data.expiryAndReminders.expiryDays | integer |
Ablauftage |
|
Erinnerungstage erinnern
|
data.expiryAndReminders.remindFromReminderDays | integer |
Erinnerungstage erinnern |
|
Erinnerungszeit erinnern
|
data.expiryAndReminders.remindFromReminderTime | string |
Erinnerungszeit erinnern |
|
Erinnerungshäufigkeit
|
data.expiryAndReminders.reminderFrequency | integer |
Häufigkeit der Erinnerung |
|
Teilnehmer
|
data.participants | array of object |
Teilnehmer |
|
Teilnehmer-ID
|
data.participants.id | string |
Teilnehmer-ID |
|
Teilnehmerstatus
|
data.participants.status | string |
Teilnehmerstatus |
|
Datum der letzten Aktualisierung
|
data.participants.lastUpdatedDate | string |
Datum der letzten Aktualisierung |
|
Erstellt am
|
data.participants.createdDate | string |
Erstellt am |
|
Abfolge des Teilnehmers
|
data.participants.sequence | integer |
Sequence |
|
Rolle
|
data.participants.role | string |
Rolle |
|
Signaturmethode
|
data.participants.signingMethodDTO | array of string |
Signaturmethodendetails |
|
Vom Benutzer übermittelt
|
data.participants.submittedBys | array of object |
Vom Benutzer übermittelte Details |
|
Benutzer-ID
|
data.participants.submittedBys.userId | string |
Von der Benutzer-ID übermittelt |
|
Benutzername
|
data.participants.submittedBys.userName | string |
Übermittelt nach Benutzername |
|
E-Mail-Adresse
|
data.participants.submittedBys.emailAddress | string |
Von der E-Mail-Adresse des Benutzers übermittelt |
|
Kandidaten-ID
|
data.participants.submittedBys.candidateId | string |
Kandidaten-ID |
|
Kandidaten
|
data.participants.candidates | array of object |
Kandidaten |
|
Kandidaten-ID
|
data.participants.candidates.id | string |
Kandidaten-ID |
|
Name
|
data.participants.candidates.name | string |
Name des Kandidaten |
|
E-Mail-Adresse
|
data.participants.candidates.emailAddress | string |
E-Mail-Adresse des Kandidaten |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Typ
|
data.participants.candidates.type | string |
Typ |
|
Maßnahme
|
data.participants.candidates.action | string |
Maßnahme |
|
Aktionsdatum
|
data.participants.candidates.actionDate | string |
Aktionsdatum |
|
Erstellt am
|
data.participants.candidates.createdDate | string |
Erstellt am |
|
Authentifizierungsmoduswert
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Authentifizierungsmoduswert |
|
Signaturmethodendetails
|
data.participants.candidates.signingMethodDTO | array of string |
Signaturmethodendetails |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Übermittlungskanäle
|
data.participants.candidates.deliveryChannels | array of string |
Übermittlungskanäle |
|
Felder
|
data.participants.fields | array of object |
Felder |
|
Id
|
data.participants.fields.id | string |
Id |
|
Datum der letzten Aktualisierung
|
data.participants.fields.lastUpdatedDate | string |
Datum der letzten Aktualisierung |
|
Erstellt am
|
data.participants.fields.createdDate | string |
Erstellt am |
|
Feld-ID
|
data.participants.fields.fieldId | string |
Feld-ID |
|
Seite Nein
|
data.participants.fields.pageNo | integer |
Seite Nein |
|
Dokument-ID
|
data.participants.fields.documentId | string |
Dokument-ID |
|
Feldbreite
|
data.participants.fields.width | float |
Feldbreite |
|
Feldhöhe
|
data.participants.fields.height | float |
Feldhöhe |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Wert
|
data.participants.fields.value | string |
Wert |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Beschriftung anzeigen
|
data.participants.fields.displayLabel | string |
Beschriftung anzeigen |
|
Verknüpfungstyp
|
data.participants.fields.linkType | string |
Verknüpfungstyp |
|
Funk-ID
|
data.participants.fields.radioId | integer |
Funk-ID |
|
Funkgruppen-ID
|
data.participants.fields.radioGroupId | string |
Funkgruppen-ID |
|
Kontrollkästchen-ID
|
data.participants.fields.checkboxId | integer |
Kontrollkästchen-ID |
|
Feldname
|
data.participants.fields.fieldName | string |
Feldname |
|
X-Position
|
data.participants.fields.xposition | float |
X-Position des Felds |
|
Y-Position
|
data.participants.fields.yposition | float |
Y-Position des Felds |
|
Ist erforderlich?
|
data.participants.fields.required | boolean |
Ist dies ein Pflichtfeld? |
|
Ist schreibgeschützt?
|
data.participants.fields.readOnly | boolean |
Ist dies ein Schreibgeschütztes Feld? |
|
Textfeld
|
data.participants.fields.textarea | boolean |
Textfeld |
|
Vertikal
|
data.participants.fields.vertical | boolean |
Vertikal |
|
Oben unten
|
data.participants.fields.topBottom | boolean |
Oben unten |
|
Standardwert
|
data.participants.fields.defaultValue | string |
Standardwert |
|
Format
|
data.participants.signatureBlock.format | array of object |
Format |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
Ist erforderlich?
|
data.participants.signatureBlock.format.required | boolean |
Ist erforderlich? |
|
Standard
|
data.participants.signatureBlock.default | boolean |
Standard |
|
Stellvertretung aktivieren
|
data.participants.enableDelegate | boolean |
Stellvertretung aktivieren |
|
Automatischer Prozess
|
data.participants.autoProcess | boolean |
Automatischer Prozess |
|
CC-Benutzer
|
data.ccUsers | array of object |
CC-Benutzer |
|
Name
|
data.ccUsers.name | string |
Name |
|
E-Mail-Adresse
|
data.ccUsers.emailAddress | string |
E-Mail-Adresse |
|
Language
|
data.ccUsers.language | string |
Language |
|
Dokumente
|
data.documents | array of object |
Dokumente |
|
Dokument-ID
|
data.documents.id | string |
Dokument-ID |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Dateiname
|
data.documents.fileName | string |
Dateiname |
|
Seitenanzahl
|
data.documents.pageCount | integer |
Seitenanzahl |
|
Ist Deletable?
|
data.documents.deletable | boolean |
Ist Deletable? |
|
Ist privat
|
data.documents.private | boolean |
Ist privat |
|
Benutzerdefinierte Felder
|
data.customFields | array of object |
Benutzerdefinierte Felder |
|
Id des benutzerdefinierten Felds
|
data.customFields.customFieldId | string |
Id des benutzerdefinierten Felds |
|
Feldwert
|
data.customFields.value | string |
Feldwert |
|
Feldname
|
data.customFields.fieldName | string |
Feldname |
|
Feldtyp
|
data.customFields.fieldType | string |
Feldtyp |
|
Benachrichtigungsabonnements
|
data.notificationSubscriptions | array of |
Benachrichtigungsabonnements |
|
tags
|
data.tags | array of |
tags |
|
Weitere Dokumente
|
data.additionalDocuments | array of object |
Weitere Dokumente |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Dateiname
|
data.additionalDocuments.fileName | string |
Dateiname |
|
Typ
|
data.additionalDocuments.type | string |
Typ |
|
Kandidaten-ID
|
data.additionalDocuments.candidateId | string |
Kandidaten-ID |
|
Separate Vereinbarungen
|
data.separateAgreements | boolean |
Separate Vereinbarungen |
Definitionen
file
Dies ist der grundlegende Datentyp "Datei".