sproof Sign (Vorschau)

Verwenden Sie sproof Sign, um sichere elektronische Signaturworkflows für PDF- und DOCX-Dokumente zu automatisieren. Organisationen können Einzel- oder Mehrfachdokumentsignaturanforderungen erstellen oder vorbereiten, Empfänger und Signaturrollen zuweisen, Dokumente auflisten und nachverfolgen, fertige PDF-Dateien herunterladen und Dokumente löschen. Ein sproof Sign-Konto, ein Plan, der die ausgewählten Aktionen und Signaturtypen unterstützt, und ein gültiges API-Token sind erforderlich.

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

Service	Class	Regions
Copilot Studio	Premium	Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Standard	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: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	API-Unterstützung
URL	https://sproof.com
E-Mail	support@sproof.com

Connectormetadaten
Herausgeber	sproof GmbH
Website	https://www.sproof.com/en/sign/
Datenschutzrichtlinie	https://www.sproof.com/en/privacy-policy-app/
Kategorien	Produktivität; Inhalt und Dateien

sproof Sign

Übersicht

Mit sproof Sign können Organisationen elektronische Signaturworkflows für PDF- und DOCX-Dokumente automatisieren. Der Connector kann Einzeldokumentsignaturanforderungen oder Umschläge mit mehreren Dokumenten erstellen oder vorbereiten, Empfänger und Signaturrollen zuweisen, Dokumente auflisten, Anforderungsstatus abrufen, abgeschlossene Dokumente herunterladen und Dokumente löschen.

Updates in dieser Version

Die Signaturanforderung "Vorbereiten" wurde hinzugefügt, um einen Entwurf zu erstellen, ohne Empfänger einzuladen.
Hinzugefügt: Abrufen von Dokumenten zu Listen, Filtern, Sortieren und Durchsuchen von Dokumenten.
Keine unterbrechungsweisen Änderungen an vorhandenen Connectoraktionen.

Prerequisites

Um den Connector zu verwenden, benötigen Sie Folgendes:

Ein sproof Sign-Konto.
Ein sproof Sign-Plan mit API-Zugriff und Unterstützung für die erforderlichen Aktionen und Signaturtypen.
Ein gültiges Sproof Sign-API-Token.

Authentication

Der Connector verwendet die API-Tokenauthentifizierung. Erstellen Sie eine Verbindung, indem Sie ein gültiges Sproof Sign API-Token eingeben, das Ihrem Konto zugeordnet ist. Schützen Sie das Token, und ersetzen Sie es, wenn es widerrufen oder neu generiert wird.

Unterstützte Aktionen

Erstellen einer Signaturanforderung – Erstellt eine Anforderung für ein Dokument oder einen Umschlag, der mehrere Dokumente enthält. Empfänger, Signaturrollen, Signierreihenfolge, Signaturpositionen und andere Einladungseinstellungen können konfiguriert werden.
Erstellen einer Signaturanforderung mithilfe von Platzhaltern – Erstellt eine Anforderung mithilfe von Platzhaltern, die in einem hochgeladenen Dokument gespeichert sind. Empfängerinformationen und Signaturpositionen werden aus diesen Platzhaltern extrahiert.
Vorbereiten der Signaturanforderung – Erstellt eine Entwurfssignaturanforderung ohne Einladung von Empfängern. Die zurückgegebene Member-ID kann verwendet werden, um das Dokument im sproof Sign Editor zu öffnen und vorzubereiten.
Abrufen von Dokumenten – Listet Dokumente auf, die für das verbundene sproof Sign-Konto verfügbar sind. Paginierungs-, Filter-, Sortier- und Suchoptionen können verwendet werden, um das Ergebnis einzuschränken.
Anforderungsstatus abrufen – Ruft den aktuellen Status und den Signaturstatus einer Signaturanforderung mithilfe seiner Mitglieds-ID ab.
Abrufen eines Dokuments – Lädt ein Dokument als binäre PDF-Datei oder als Base64-codierte PDF herunter.
Dokument löschen – Löscht ein Dokument oder entfernt den Zugriff eines Mitglieds, abhängig von der angegebenen Mitglieds-ID, der Rolle des Mitglieds und ob das Dokument zu einem Umschlag gehört.

Bekannte Einschränkungen und Anforderungen

Eingabedokumente müssen als Base64-codierter PDF- oder DOCX-Inhalt bereitgestellt werden.
Ein Umschlag kann maximal 25 Dokumente enthalten.
Ein Umschlagname ist erforderlich, wenn mehrere Dokumente übermittelt werden.
Platzhalterbasierte Anforderungen erfordern ordnungsgemäß formatierte Platzhalter im hochgeladenen Dokument.
Bei platzhalterbasierten Anforderungen werden Empfänger- und Signaturpositionen aus dem Dokument abgerufen, anstatt manuell eingegeben zu werden.
Verfügbare Aktionen, Signaturtypen und Anbieter hängen vom verbundenen sproof Sign-Konto und -Plan ab.
Das Verhalten des Löschens von Dokumenten hängt davon ab, ob die angegebene Mitglieds-ID zum Absender oder empfänger gehört und ob das Dokument Teil eines Umschlags ist.

Support

Wenden Sie sich an support@sproof.comdie Connector- oder API-Unterstützung.

Eine Verbindung wird erstellt

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
token	Securestring	"token" für diese API	True

Aktionen

Abrufen von Dokumenten	Gibt Dokumente zurück, die vom API-Tokeninhaber (authentifizierter Benutzer) erstellt wurden, unabhängig davon, ob diese Dokumente über die Benutzeroberfläche oder über die API erstellt wurden. Dokumente, die von anderen Mitgliedern desselben Plans erstellt wurden, sind nicht enthalten. Wenn die Rollenverwaltung für Ihren Plan aktiviert ist, kann jeder Benutzer über ein eigenes API-Token verfügen.
Anforderungsstatus abrufen	Rufen Sie den Status einer Signaturanforderung ab. Gibt ein JSON-Dokumentobjekt oder einen Fehler zurück. Der Parameter wird von der Postanforderung für das Dokument zurückgegeben und der Absender-E-Mail zugeordnet.
Dokument abrufen	Rufen Sie signiertes Dokument als binäre oder base64-codierte Zeichenfolge ab.
Dokument löschen	Löscht ein Dokument oder entfernt den Zugriff eines Mitglieds darauf, je nachdem, ob die bereitgestellte `memberId` Person dem Absender oder empfänger gehört, und ob das Dokument Teil eines Umschlags ist. Dokumente in einem Umschlag Der Abfrageparameter `all` hat keine Auswirkung für Dokumente in einem Umschlag. Mit dem Absender `memberId`: Ein einzelnes Dokument wird für den Absender und alle Empfänger gelöscht. Das Dokument wird aus dem Umschlag entfernt. Mit dem Empfänger `memberId`: Alle Dokumente im Umschlag werden für den Empfänger entfernt. Der Empfänger wird für `declined` alle Dokumente markiert, die für den Empfänger gelöscht wurden. Die Dokumente bleiben für alle anderen Mitglieder im Dokument verfügbar. Einzelne Dokumente Mit dem Absender `memberId` und `all=true`: Das Dokument wird für den Absender und alle Empfänger gelöscht. Mit dem Absender `memberId` und `all=false`: Das Dokument wird nur für den Absender gelöscht. Das Dokument bleibt für die anderen Empfänger im Dokument verfügbar. Mit dem Empfänger `memberId`: Der Empfänger ist im Dokument als `declined` markiert. Das Dokument bleibt für alle anderen Elemente im Dokument verfügbar.
Erstellen einer Signaturanforderung	Dies ist die neue Anforderung zum Erstellen einer Signatur. Zusätzlich zum Erstellen einer einzelnen Dokumenteinladung unterstützt es jetzt das Erstellen von Umschlägen und das Gleichzeitige Hochladen mehrerer Dokumente beim Senden von Einladungen.
Erstellen einer Signaturanforderung mithilfe von Platzhaltern	Erstellt eine Signaturanforderung mithilfe von Platzhaltern, die im hochgeladenen Dokument gespeichert sind. Empfänger und Signaturpositionen werden aus dem Dokument extrahiert.
Vorbereiten der Signaturanforderung	Erstellt eine Entwurfssignaturanforderung, ohne Empfänger einzuladen. Verwenden Sie die zurückgegebene Member-ID, um das Dokument im sproof Sign Editor zu öffnen.

Abrufen von Dokumenten

Vorgangs-ID:: GetDocumentList

Gibt Dokumente zurück, die vom API-Tokeninhaber (authentifizierter Benutzer) erstellt wurden, unabhängig davon, ob diese Dokumente über die Benutzeroberfläche oder über die API erstellt wurden.

Dokumente, die von anderen Mitgliedern desselben Plans erstellt wurden, sind nicht enthalten. Wenn die Rollenverwaltung für Ihren Plan aktiviert ist, kann jeder Benutzer über ein eigenes API-Token verfügen.

Parameter

Name	Schlüssel	Typ	Beschreibung
Einträge pro Seite	perPage	integer	Geben Sie die Anzahl der Einträge pro Seite an.
Seitennummer	page	integer	Geben Sie die Seitenzahl an.
Dokumentfilter	view	string	Geben Sie den Dokumentfilter an.
Dokumente sortieren	sort	string	Dokumentsortierung. Fügen Sie ":true" für absteigende Sortierung an.
Suchabfrage	query	string	Suchabfrage für verschiedene Informationen. Verhalten: In der Regel wird die Groß-/Kleinschreibung nicht beachtet. Ein einzelnes Wort oder ein zitierter Ausdruck (z. B. "Quartalsbericht") führt Teilzeichenfolgenübereinstimmung durch. Mehrere Wörter, die durch Leerzeichen getrennt sind (z. B. Quartalsbericht Q1), müssen alle als Teilzeichenfolgen übereinstimmen (AND-Bedingung) Durchsuchte Felder: Dokumentname, Mitglieds-E-Mails, Vor-/Nachnamen des Mitglieds, Ordnername Wildcards/regex werden nicht unterstützt Wenn der interne Suchindex noch nicht aktualisiert wird, wird nur der Dokumentname durchsucht.
Bezeichnungsfilter	labels	string	Filtern sie Dokumente nach Bezeichnungsnamen.
Erstellt von	startDate	date-time	Filtert die Ergebnisse ab einem bestimmten createdAt-Datum und einer bestimmten Uhrzeit im UTC-Format ( filtert nicht nach updatedAt). Verwenden Sie diesen Parameter in Kombination mit "endDate", um einen Zeitraum zu definieren.
Erstellt bis	endDate	date-time	Filtert die Ergebnisse, die auf einem bestimmten createdAt-Datum und einer bestimmten Uhrzeit im UTC-Format enden ( filtert nicht nach updatedAt). Verwenden Sie diesen Parameter in Kombination mit "startDate", um einen Zeitraum zu definieren.

Gibt zurück

Antwortobjekt für Dokumentlistenvorgänge

Antwort auf Dokumentlisten: _DocumentListResponse

Anforderungsstatus abrufen

Vorgangs-ID:: GetSignatureStatus

Rufen Sie den Status einer Signaturanforderung ab. Gibt ein JSON-Dokumentobjekt oder einen Fehler zurück. Der Parameter wird von der Postanforderung für das Dokument zurückgegeben und der Absender-E-Mail zugeordnet.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mitglieds-ID	memberId	True	string	Mitglieds-ID

Gibt zurück

Body: DocumentStatusForFlow

Dokument abrufen

Vorgangs-ID:: GetDocument

Rufen Sie signiertes Dokument als binäre oder base64-codierte Zeichenfolge ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mitglieds-ID	memberId	True	string	Mitglieds-ID
Downloadformat	format		string	Gibt das Antwortformat an. Wird `pdf` für binäre PDF-Dateien und `base64` für eine Base64-codierte Antwort verwendet. Beispielantwort `base64` : `json { "base64": "JVBERi0xLjQKJe..." }`

Gibt zurück

Name	Pfad	Typ	Beschreibung
Base64	base64	string	Base64-codierter PDF-Inhalt

Dokument löschen

Vorgangs-ID:: DeleteDocument

Löscht ein Dokument oder entfernt den Zugriff eines Mitglieds darauf, je nachdem, ob die bereitgestellte memberId Person dem Absender oder empfänger gehört, und ob das Dokument Teil eines Umschlags ist.

Dokumente in einem Umschlag

Der Abfrageparameter all hat keine Auswirkung für Dokumente in einem Umschlag.

Mit dem Absender memberId:

Ein einzelnes Dokument wird für den Absender und alle Empfänger gelöscht.
Das Dokument wird aus dem Umschlag entfernt.

Mit dem Empfänger memberId:

Alle Dokumente im Umschlag werden für den Empfänger entfernt.
Der Empfänger wird für declined alle Dokumente markiert, die für den Empfänger gelöscht wurden.
Die Dokumente bleiben für alle anderen Mitglieder im Dokument verfügbar.

Einzelne Dokumente

Mit dem Absender memberId und all=true:

Das Dokument wird für den Absender und alle Empfänger gelöscht.

Mit dem Absender memberId und all=false:

Das Dokument wird nur für den Absender gelöscht.
Das Dokument bleibt für die anderen Empfänger im Dokument verfügbar.

Mit dem Empfänger memberId:

Der Empfänger ist im Dokument als declined markiert.
Das Dokument bleibt für alle anderen Elemente im Dokument verfügbar.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mitglieds-ID	memberId	True	string	Mitglieds-ID
Löschen für alle Empfänger	all		boolean	Nur relevant für einzelne Dokumente, wenn die bereitgestellte `memberId` zu dem Absender gehört. Bei Festlegung auf `true`, wird das Dokument für den Absender und alle Empfänger gelöscht. Bei Festlegung auf `false`, wird das Dokument nur für den Absender gelöscht und bleibt für die anderen Empfänger verfügbar. Dieser Parameter hat keine Auswirkung für Dokumente in einem Umschlag (Standard = `true`) oder wenn der angegebene `memberId` Parameter zu einem Empfänger gehört.

Gibt zurück

response: DeleteDocumentResponse

Erstellen einer Signaturanforderung

Vorgangs-ID:: CreateSignatureRequest

Dies ist die neue Anforderung zum Erstellen einer Signatur. Zusätzlich zum Erstellen einer einzelnen Dokumenteinladung unterstützt es jetzt das Erstellen von Umschlägen und das Gleichzeitige Hochladen mehrerer Dokumente beim Senden von Einladungen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
email	email	True	string	E-Mail des Absenders. Er muss zu einem Mitglied Ihres Plans gehören.
firstName	firstName	True	string	Vorname des Absenders.
lastName	lastName		string	Nachname des Absenders.
Rolle	role		string	Die Rolle des Absenders für alle Dokumente.
email	email		string	E-Mail des Empfängers.
firstName	firstName		string	Vorname des Empfängers.
lastName	lastName		string	Nachname des Empfängers.
doNotSendEmails	doNotSendEmails		boolean	Wenn diese Option auf `true` keine E-Mail festgelegt ist, wird an den Empfänger gesendet.
customId	customId		string	Wird nur verwendet, wenn die E-Mail-Adresse des Empfängers zum Zeitpunkt der Einladung unbekannt ist. Dies funktioniert nur, wenn Sie die Empfänger (nicht für die Vorbereitung von Routen) einladen und fastlane verwenden möchten. Auf `customId` diese Weise können Sie einen eindeutigen Signaturlink für einen Empfänger vorab generieren, bevor Sie eine Einladung senden. Muss eine eindeutige alphanumerische Zeichenfolge mit mindestens 70 Zeichen sein. Hinweis: Die customId kann nur verwendet werden, um den Empfängerlink zu einem Dokument zu erstellen. Sie kann nicht für andere Anforderungen anstelle der memberId verwendet werden. Ausführliche Informationen zur URL-Konstruktion finden Sie unter Öffnen eines Dokuments mit einer benutzerdefinierten ID
useFastlane	useFastlane		boolean	Wenn diese Einstellung auf `true` den Signierer festgelegt ist, wird in der Einladungs-E-Mail ein Fastlane-Link angezeigt.
phoneNumber	phoneNumber		string	Die Telefonnummer dieses Empfängers. Dies wird für die SMS-Überprüfung verwendet. (z. B. +43 699 1234 1234).
privateMessage	privateMessage		string	Eine private Nachricht für diesen bestimmten Empfänger.
inPersonMode	inPersonMode		boolean	Wenn diese Option aktiviert ist, muss der Empfänger der Signaturanforderung das Dokument persönlich signieren, und es wird keine E-Mail gesendet. Dieser Modus ist nur mit dem SES-Signaturtyp verfügbar.
signatureTypes	signatureTypes		array of string	Der für diesen Empfänger zulässige Signaturtyp. Es wird höchstens ein Wert unterstützt. Optionen: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag	tag		string	Dieses Tag bestimmt den Identitätsanbieter, der für den Signiervorgang verwendet wird. Wählen Sie aus einer vordefinierten Gruppe unterstützter Anbieter aus. Hinweis 1: Einige Anbieter sind nur für bestimmte signatureTypes verfügbar, z `onetimeqes` . B. erfordert `"signatureType" : ["qualifiedPlusIdent"]` Hinweis 2: Bei Verwendung `sproof-qualified` als Standardanbieter muss der Empfänger über ein aktives sproof-Konto mit einer aktiven User+-Lizenz verfügen.
canChange	canChange		boolean	Boolescher Wert, der angibt, ob der eingeladene Empfänger den Signaturanbieter ändern kann
country	country		string	Wenn das Standardland auf "Leer" festgelegt ist, wird ein Fehler zurückgegeben, der angibt, welche Länder für das ausgewählte Anbietertag verfügbar sind.
fälliges Datum	dueDate		YYYY-MM-DD	Das Datum, bis zu dem das Dokument signiert werden kann. Dieses Fälligkeitsdatum wird dem Empfänger in der Einladungs-E-Mail angezeigt und ist auch im Abschnitt mit den Dokumentdetails des Dashboards sichtbar. Sie dient als Stichtag für den Abschluss des Signierungsprozesses.
reminderInterval	reminderInterval		number	Gibt die Anzahl der Tage zwischen Erinnerungs-E-Mails an.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum, an dem Erinnerungen gesendet werden sollen
inviteLanguage	inviteLanguage		string	Gibt die Sprache der E-Mails an, die an anonyme Benutzer gesendet werden, die kein Konto besitzen. Für Benutzer mit einem Konto wird stattdessen die Sprache verwendet, die sie in ihrem Profil ausgewählt haben.
message	message		string	Eine benutzerdefinierte Nachricht, die an die Empfänger innerhalb der E-Mail gesendet wird.
Betreff	subject		string	Die Betreffzeile der E-Mail, die an die Empfänger gesendet wurde.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird die PDF-Datei als Anlage an alle Empfänger des Dokuments gesendet (wenn sie kleiner als 5 MB ist).
focusedSigningMode	focusedSigningMode		boolean	Wenn diese Option aktiviert ist, ist der Empfänger der Signaturanforderung auf das Signieren oder Ablehnen des Dokuments beschränkt und kann nicht von der Seite navigieren.
allowForwarding	allowForwarding		boolean	Weiterleitung der Einladung zulassen.
collabSigningMode	collabSigningMode		object	Ein Objekt, bei dem jeder Schlüssel eine Signaturrunde darstellt, und der entsprechende Wert gibt an, ob die gemeinsame Signatur für diese Runde aktiviert ist. Wenn der Wert wahr ist, ist nur eine Signatur erforderlich, um die angegebene Signaturrunde abzuschließen und mit der nächsten Runde fortzufahren. {'1': true } bedeutet beispielsweise, dass bei der Signierung der Runde "1" nur eine Signatur erforderlich ist.
usePlaceholders	usePlaceholders		boolean	Wenn wahr, werden textplatzhalter/formFields, die im Dokument gespeichert sind, zum Einladen von Empfängern verwendet.
inPersonSigning	inPersonSigning		boolean	Wenn wahr, erhält der Empfänger ein Popup, in dem er eine Signatur manuell zeichnen muss
folderName	folderName		string	Wenn angegeben, wird ein Umschlag erstellt, der alle Dokumente in documentDataArray enthält. (Erforderlich, wenn mehrere Dokumente gesendet werden)
callbackUrl	callbackUrl		string	Eine POST-Anforderung, einschließlich des Dokuments, wird an diese URL gesendet, wenn eine neue Signatur erstellt wird oder wenn ein Empfänger das Dokument ablehnt. Im Falle eines Fehlers ist ein Wiederholungsmechanismus vorhanden, um sicherzustellen, dass die Anforderung erneut versucht wird.
returnUrl	returnUrl		string	Der Link der Zurück-Schaltfläche nach dem Signieren eines Dokuments
returnBtnText	returnBtnText		string	Der Text der Rückgabeschaltfläche nach dem Signieren eines Dokuments
data	data	True	string	Die Dokumentdaten (PDF oder DOCX) im Base64-Format.
mimetype	mimetype		string	MIME-Typ von base64-codierten Daten PDF oder DOCX, erforderlich, wenn das Dokument keine PDF-Datei ist
Dateiname	fileName	True	string	Name der Datei
label	label		string	Eine benutzerdefinierte Bezeichnung, die an die Organisation von Dokumenten gesendet werden kann.
Seite	page	True	integer	Die Nummer der Seite, auf der sich das Feld befindet, wobei die erste Seite 0 ist.
Pagewidth	pageWidth		number	Ein ganzzahliger Wert, der die Seitenbreite beschreibt. Je größer die Zahl ist, desto besser ist die Genauigkeit beim Positionieren des Felds im x y-Raum. Auf einer A4-Seite haben wir 478 als Standardwert.
Pageheight	pageHeight		number	Ein ganzzahliger Wert, der die Seitenhöhe beschreibt. Je größer die Zahl ist, desto besser ist die Genauigkeit beim Positionieren des Felds im x y-Raum. Auf einer A4-Seite haben wir 676 als Standardwert.
x	x	True	float	Stellt die horizontale Position des Felds als Prozentsatz der Seitenbreite dar. Der Ursprung (0,0) befindet sich oben links auf der Seite. Der Wert 0,1 bedeutet, dass das Feld bei 10% der Seitenbreite von links positioniert wird.
y	y	True	float	Stellt die vertikale Position des Felds als Prozentsatz der Seitenhöhe dar. Der Ursprung (0,0) befindet sich oben links auf der Seite. Ein Wert von 0,1 bedeutet, dass das Feld von oben an 10% der Seitenhöhe positioniert ist.
width	width	True	float	Breite des Felds basierend auf Seitenabmessungen, ähnlich wie die x- und y-Koordinaten. Es ist ein Float-Wert, der einen Prozentsatz des PageWidth-Werts darstellt.
height	height	True	float	Höhe des Felds basierend auf Seitenabmessungen, ähnlich den X- und Y-Koordinaten. Es ist ein Float-Wert, der einen Prozentsatz des PageHeight-Werts darstellt.
id	id	True	string	Eine eindeutige ID für dieses Feld, die auf beliebige Weise generiert wird.
label	label		string	Platzhaltertext, z. B. der Name des Felds, z. B. "Geburtsdatum".
value	value		string	Standardwert für das Feld. Kann NULL sein. Wenn das Feld vom Typ "chooseBox" ist, kann der Wert null oder eine der in den Optionen definierten Zeichenfolgen sein.
fieldId	fieldId		string	Ein stabiler Feldbezeichner, der in der Benutzeroberfläche konfiguriert ist. Wird verwendet, um Workflowformularfelder über API-Anforderungen vorab auszufüllen.
nur lesen	readonly		boolean	Wenn dieser Wert auf "true" festgelegt ist, kann die eingeladene Person den Wert dieses Felds nicht ändern.
required	required		boolean	Wenn "true" festgelegt ist, kann die eingeladene Person das Dokument nicht signieren, ohne dieses Feld auszufüllen.
type	type	True	string
Mehrzeile	multiline		boolean	Gibt an, ob mehrere Zeilen zulässig sind.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Jedem Optionsfeld kann eine Gruppe zugewiesen werden.
signatureTypes	signatureTypes		array of string	Der für dieses Dokument zulässige Signaturtyp kann vom Empfängersignaturtyp überschrieben werden. Es wird höchstens ein Wert unterstützt. Optionen: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId	refId		string	Die RefId ist ein optionales Feld, das zum Querverweis auf das hochgeladene Dokument verwendet wird. Wenn angegeben, können Sie dem Dokument einen benutzerdefinierten Verweisbezeichner zuweisen, der als Teil des Dokumentobjekts in zukünftigen API-Antworten zurückgegeben wird. Dies kann nützlich sein, um Dokumente nach einem externen System oder Workflow zu verfolgen oder zu organisieren.
language	language		string	Die Dokumentsprache.
folderId	folderId		string	Die ID eines Ordners, in den die Dokumente eingefügt werden sollen. Dies ist nur möglich, wenn sowohl inviteData als auch folderName nicht definiert sind.
isAttachment	isAttachment		boolean	isAttachment ist in diesem Fall nicht erforderlich.
Empfängerdetails	recipientDetails	True	object	Empfängerdetails, die von der E-Mail-Adresse des Empfängers schlüsselt. Beispiel: {"mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}}.
useFastlane	useFastlane		boolean	Wenn diese Einstellung auf `true` den Signierer festgelegt ist, wird in der Einladungs-E-Mail ein Fastlane-Link angezeigt.
fastlaneProfileId	fastlaneProfileId		uuid	Geben Sie das Fastlane-Profil an, das mit diesem Dokument verwendet werden soll. (useFastlane muss auf "true" festgelegt werden.

Gibt zurück

Body: EnvelopeResponse

Erstellen einer Signaturanforderung mithilfe von Platzhaltern

Vorgangs-ID:: CreateSignatureRequestUsingPlaceholders

Erstellt eine Signaturanforderung mithilfe von Platzhaltern, die im hochgeladenen Dokument gespeichert sind. Empfänger und Signaturpositionen werden aus dem Dokument extrahiert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
email	email	True	string	E-Mail des Absenders. Er muss zu einem Mitglied Ihres Plans gehören.
firstName	firstName	True	string	Vorname des Absenders.
lastName	lastName		string	Nachname des Absenders.
Rolle	role		string	Die Rolle des Absenders für alle Dokumente.
email	email		string	E-Mail des Empfängers.
firstName	firstName		string	Vorname des Empfängers.
lastName	lastName		string	Nachname des Empfängers.
doNotSendEmails	doNotSendEmails		boolean	Wenn diese Option auf `true` keine E-Mail festgelegt ist, wird an den Empfänger gesendet.
customId	customId		string	Wird nur verwendet, wenn die E-Mail-Adresse des Empfängers zum Zeitpunkt der Einladung unbekannt ist. Dies funktioniert nur, wenn Sie die Empfänger (nicht für die Vorbereitung von Routen) einladen und fastlane verwenden möchten. Auf `customId` diese Weise können Sie einen eindeutigen Signaturlink für einen Empfänger vorab generieren, bevor Sie eine Einladung senden. Muss eine eindeutige alphanumerische Zeichenfolge mit mindestens 70 Zeichen sein. Hinweis: Die customId kann nur verwendet werden, um den Empfängerlink zu einem Dokument zu erstellen. Sie kann nicht für andere Anforderungen anstelle der memberId verwendet werden. Ausführliche Informationen zur URL-Konstruktion finden Sie unter Öffnen eines Dokuments mit einer benutzerdefinierten ID
useFastlane	useFastlane		boolean	Wenn diese Einstellung auf `true` den Signierer festgelegt ist, wird in der Einladungs-E-Mail ein Fastlane-Link angezeigt.
phoneNumber	phoneNumber		string	Die Telefonnummer dieses Empfängers. Dies wird für die SMS-Überprüfung verwendet. (z. B. +43 699 1234 1234).
privateMessage	privateMessage		string	Eine private Nachricht für diesen bestimmten Empfänger.
inPersonMode	inPersonMode		boolean	Wenn diese Option aktiviert ist, muss der Empfänger der Signaturanforderung das Dokument persönlich signieren, und es wird keine E-Mail gesendet. Dieser Modus ist nur mit dem SES-Signaturtyp verfügbar.
signatureTypes	signatureTypes		array of string	Der für diesen Empfänger zulässige Signaturtyp. Es wird höchstens ein Wert unterstützt. Optionen: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag	tag		string	Dieses Tag bestimmt den Identitätsanbieter, der für den Signiervorgang verwendet wird. Wählen Sie aus einer vordefinierten Gruppe unterstützter Anbieter aus. Hinweis 1: Einige Anbieter sind nur für bestimmte signatureTypes verfügbar, z `onetimeqes` . B. erfordert `"signatureType" : ["qualifiedPlusIdent"]` Hinweis 2: Bei Verwendung `sproof-qualified` als Standardanbieter muss der Empfänger über ein aktives sproof-Konto mit einer aktiven User+-Lizenz verfügen.
canChange	canChange		boolean	Boolescher Wert, der angibt, ob der eingeladene Empfänger den Signaturanbieter ändern kann
country	country		string	Wenn das Standardland auf "Leer" festgelegt ist, wird ein Fehler zurückgegeben, der angibt, welche Länder für das ausgewählte Anbietertag verfügbar sind.
fälliges Datum	dueDate		YYYY-MM-DD	Das Datum, bis zu dem das Dokument signiert werden kann. Dieses Fälligkeitsdatum wird dem Empfänger in der Einladungs-E-Mail angezeigt und ist auch im Abschnitt mit den Dokumentdetails des Dashboards sichtbar. Sie dient als Stichtag für den Abschluss des Signierungsprozesses.
reminderInterval	reminderInterval		number	Gibt die Anzahl der Tage zwischen Erinnerungs-E-Mails an.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum, an dem Erinnerungen gesendet werden sollen
inviteLanguage	inviteLanguage		string	Gibt die Sprache der E-Mails an, die an anonyme Benutzer gesendet werden, die kein Konto besitzen. Für Benutzer mit einem Konto wird stattdessen die Sprache verwendet, die sie in ihrem Profil ausgewählt haben.
message	message		string	Eine benutzerdefinierte Nachricht, die an die Empfänger innerhalb der E-Mail gesendet wird.
Betreff	subject		string	Die Betreffzeile der E-Mail, die an die Empfänger gesendet wurde.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird die PDF-Datei als Anlage an alle Empfänger des Dokuments gesendet (wenn sie kleiner als 5 MB ist).
focusedSigningMode	focusedSigningMode		boolean	Wenn diese Option aktiviert ist, ist der Empfänger der Signaturanforderung auf das Signieren oder Ablehnen des Dokuments beschränkt und kann nicht von der Seite navigieren.
allowForwarding	allowForwarding		boolean	Weiterleitung der Einladung zulassen.
collabSigningMode	collabSigningMode		object	Ein Objekt, bei dem jeder Schlüssel eine Signaturrunde darstellt, und der entsprechende Wert gibt an, ob die gemeinsame Signatur für diese Runde aktiviert ist. Wenn der Wert wahr ist, ist nur eine Signatur erforderlich, um die angegebene Signaturrunde abzuschließen und mit der nächsten Runde fortzufahren. {'1': true } bedeutet beispielsweise, dass bei der Signierung der Runde "1" nur eine Signatur erforderlich ist.
inPersonSigning	inPersonSigning		boolean	Wenn wahr, erhält der Empfänger ein Popup, in dem er eine Signatur manuell zeichnen muss
folderName	folderName		string	Wenn angegeben, wird ein Umschlag erstellt, der alle Dokumente in documentDataArray enthält. (Erforderlich, wenn mehrere Dokumente gesendet werden)
callbackUrl	callbackUrl		string	Eine POST-Anforderung, einschließlich des Dokuments, wird an diese URL gesendet, wenn eine neue Signatur erstellt wird oder wenn ein Empfänger das Dokument ablehnt. Im Falle eines Fehlers ist ein Wiederholungsmechanismus vorhanden, um sicherzustellen, dass die Anforderung erneut versucht wird.
returnUrl	returnUrl		string	Der Link der Zurück-Schaltfläche nach dem Signieren eines Dokuments
returnBtnText	returnBtnText		string	Der Text der Rückgabeschaltfläche nach dem Signieren eines Dokuments
data	data	True	string	Die Dokumentdaten (PDF oder DOCX) im Base64-Format.
mimetype	mimetype		string	MIME-Typ von base64-codierten Daten PDF oder DOCX, erforderlich, wenn das Dokument keine PDF-Datei ist
Dateiname	fileName	True	string	Name der Datei
label	label		string	Eine benutzerdefinierte Bezeichnung, die an die Organisation von Dokumenten gesendet werden kann.
Seite	page	True	integer	Die Nummer der Seite, auf der sich das Feld befindet, wobei die erste Seite 0 ist.
Pagewidth	pageWidth		number	Ein ganzzahliger Wert, der die Seitenbreite beschreibt. Je größer die Zahl ist, desto besser ist die Genauigkeit beim Positionieren des Felds im x y-Raum. Auf einer A4-Seite haben wir 478 als Standardwert.
Pageheight	pageHeight		number	Ein ganzzahliger Wert, der die Seitenhöhe beschreibt. Je größer die Zahl ist, desto besser ist die Genauigkeit beim Positionieren des Felds im x y-Raum. Auf einer A4-Seite haben wir 676 als Standardwert.
x	x	True	float	Stellt die horizontale Position des Felds als Prozentsatz der Seitenbreite dar. Der Ursprung (0,0) befindet sich oben links auf der Seite. Der Wert 0,1 bedeutet, dass das Feld bei 10% der Seitenbreite von links positioniert wird.
y	y	True	float	Stellt die vertikale Position des Felds als Prozentsatz der Seitenhöhe dar. Der Ursprung (0,0) befindet sich oben links auf der Seite. Ein Wert von 0,1 bedeutet, dass das Feld von oben an 10% der Seitenhöhe positioniert ist.
width	width	True	float	Breite des Felds basierend auf Seitenabmessungen, ähnlich wie die x- und y-Koordinaten. Es ist ein Float-Wert, der einen Prozentsatz des PageWidth-Werts darstellt.
height	height	True	float	Höhe des Felds basierend auf Seitenabmessungen, ähnlich den X- und Y-Koordinaten. Es ist ein Float-Wert, der einen Prozentsatz des PageHeight-Werts darstellt.
id	id	True	string	Eine eindeutige ID für dieses Feld, die auf beliebige Weise generiert wird.
label	label		string	Platzhaltertext, z. B. der Name des Felds, z. B. "Geburtsdatum".
value	value		string	Standardwert für das Feld. Kann NULL sein. Wenn das Feld vom Typ "chooseBox" ist, kann der Wert null oder eine der in den Optionen definierten Zeichenfolgen sein.
fieldId	fieldId		string	Ein stabiler Feldbezeichner, der in der Benutzeroberfläche konfiguriert ist. Wird verwendet, um Workflowformularfelder über API-Anforderungen vorab auszufüllen.
nur lesen	readonly		boolean	Wenn dieser Wert auf "true" festgelegt ist, kann die eingeladene Person den Wert dieses Felds nicht ändern.
required	required		boolean	Wenn "true" festgelegt ist, kann die eingeladene Person das Dokument nicht signieren, ohne dieses Feld auszufüllen.
type	type	True	string
Mehrzeile	multiline		boolean	Gibt an, ob mehrere Zeilen zulässig sind.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Jedem Optionsfeld kann eine Gruppe zugewiesen werden.
signatureTypes	signatureTypes		array of string	Der für dieses Dokument zulässige Signaturtyp kann vom Empfängersignaturtyp überschrieben werden. Es wird höchstens ein Wert unterstützt. Optionen: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId	refId		string	Die RefId ist ein optionales Feld, das zum Querverweis auf das hochgeladene Dokument verwendet wird. Wenn angegeben, können Sie dem Dokument einen benutzerdefinierten Verweisbezeichner zuweisen, der als Teil des Dokumentobjekts in zukünftigen API-Antworten zurückgegeben wird. Dies kann nützlich sein, um Dokumente nach einem externen System oder Workflow zu verfolgen oder zu organisieren.
language	language		string	Die Dokumentsprache.
folderId	folderId		string	Die ID eines Ordners, in den die Dokumente eingefügt werden sollen. Dies ist nur möglich, wenn sowohl inviteData als auch folderName nicht definiert sind.
isAttachment	isAttachment		boolean	isAttachment ist in diesem Fall nicht erforderlich.
useFastlane	useFastlane		boolean	Wenn diese Einstellung auf `true` den Signierer festgelegt ist, wird in der Einladungs-E-Mail ein Fastlane-Link angezeigt.
fastlaneProfileId	fastlaneProfileId		uuid	Geben Sie das Fastlane-Profil an, das mit diesem Dokument verwendet werden soll. (useFastlane muss auf "true" festgelegt werden.

Gibt zurück

Body: EnvelopeResponse

Vorbereiten der Signaturanforderung

Vorgangs-ID:: PrepareSignatureRequest

Erstellt eine Entwurfssignaturanforderung, ohne Empfänger einzuladen. Verwenden Sie die zurückgegebene Member-ID, um das Dokument im sproof Sign Editor zu öffnen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
email	email	True	string	E-Mail des Absenders. Er muss zu einem Mitglied Ihres Plans gehören.
firstName	firstName	True	string	Vorname des Absenders.
lastName	lastName		string	Nachname des Absenders.
Rolle	role		string	Die Rolle des Absenders für alle Dokumente.
email	email		string	E-Mail des Empfängers.
firstName	firstName		string	Vorname des Empfängers.
lastName	lastName		string	Nachname des Empfängers.
doNotSendEmails	doNotSendEmails		boolean	Wenn diese Option auf `true` keine E-Mail festgelegt ist, wird an den Empfänger gesendet.
customId	customId		string	Wird nur verwendet, wenn die E-Mail-Adresse des Empfängers zum Zeitpunkt der Einladung unbekannt ist. Dies funktioniert nur, wenn Sie die Empfänger (nicht für die Vorbereitung von Routen) einladen und fastlane verwenden möchten. Auf `customId` diese Weise können Sie einen eindeutigen Signaturlink für einen Empfänger vorab generieren, bevor Sie eine Einladung senden. Muss eine eindeutige alphanumerische Zeichenfolge mit mindestens 70 Zeichen sein. Hinweis: Die customId kann nur verwendet werden, um den Empfängerlink zu einem Dokument zu erstellen. Sie kann nicht für andere Anforderungen anstelle der memberId verwendet werden. Ausführliche Informationen zur URL-Konstruktion finden Sie unter Öffnen eines Dokuments mit einer benutzerdefinierten ID
useFastlane	useFastlane		boolean	Wenn diese Einstellung auf `true` den Signierer festgelegt ist, wird in der Einladungs-E-Mail ein Fastlane-Link angezeigt.
phoneNumber	phoneNumber		string	Die Telefonnummer dieses Empfängers. Dies wird für die SMS-Überprüfung verwendet. (z. B. +43 699 1234 1234).
privateMessage	privateMessage		string	Eine private Nachricht für diesen bestimmten Empfänger.
inPersonMode	inPersonMode		boolean	Wenn diese Option aktiviert ist, muss der Empfänger der Signaturanforderung das Dokument persönlich signieren, und es wird keine E-Mail gesendet. Dieser Modus ist nur mit dem SES-Signaturtyp verfügbar.
signatureTypes	signatureTypes		array of string	Der für diesen Empfänger zulässige Signaturtyp. Es wird höchstens ein Wert unterstützt. Optionen: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag	tag		string	Dieses Tag bestimmt den Identitätsanbieter, der für den Signiervorgang verwendet wird. Wählen Sie aus einer vordefinierten Gruppe unterstützter Anbieter aus. Hinweis 1: Einige Anbieter sind nur für bestimmte signatureTypes verfügbar, z `onetimeqes` . B. erfordert `"signatureType" : ["qualifiedPlusIdent"]` Hinweis 2: Bei Verwendung `sproof-qualified` als Standardanbieter muss der Empfänger über ein aktives sproof-Konto mit einer aktiven User+-Lizenz verfügen.
canChange	canChange		boolean	Boolescher Wert, der angibt, ob der eingeladene Empfänger den Signaturanbieter ändern kann
country	country		string	Wenn das Standardland auf "Leer" festgelegt ist, wird ein Fehler zurückgegeben, der angibt, welche Länder für das ausgewählte Anbietertag verfügbar sind.
fälliges Datum	dueDate		YYYY-MM-DD	Das Datum, bis zu dem das Dokument signiert werden kann. Dieses Fälligkeitsdatum wird dem Empfänger in der Einladungs-E-Mail angezeigt und ist auch im Abschnitt mit den Dokumentdetails des Dashboards sichtbar. Sie dient als Stichtag für den Abschluss des Signierungsprozesses.
reminderInterval	reminderInterval		number	Gibt die Anzahl der Tage zwischen Erinnerungs-E-Mails an.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum, an dem Erinnerungen gesendet werden sollen
inviteLanguage	inviteLanguage		string	Gibt die Sprache der E-Mails an, die an anonyme Benutzer gesendet werden, die kein Konto besitzen. Für Benutzer mit einem Konto wird stattdessen die Sprache verwendet, die sie in ihrem Profil ausgewählt haben.
message	message		string	Eine benutzerdefinierte Nachricht, die an die Empfänger innerhalb der E-Mail gesendet wird.
Betreff	subject		string	Die Betreffzeile der E-Mail, die an die Empfänger gesendet wurde.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird die PDF-Datei als Anlage an alle Empfänger des Dokuments gesendet (wenn sie kleiner als 5 MB ist).
focusedSigningMode	focusedSigningMode		boolean	Wenn diese Option aktiviert ist, ist der Empfänger der Signaturanforderung auf das Signieren oder Ablehnen des Dokuments beschränkt und kann nicht von der Seite navigieren.
allowForwarding	allowForwarding		boolean	Weiterleitung der Einladung zulassen.
collabSigningMode	collabSigningMode		object	Ein Objekt, bei dem jeder Schlüssel eine Signaturrunde darstellt, und der entsprechende Wert gibt an, ob die gemeinsame Signatur für diese Runde aktiviert ist. Wenn der Wert wahr ist, ist nur eine Signatur erforderlich, um die angegebene Signaturrunde abzuschließen und mit der nächsten Runde fortzufahren. {'1': true } bedeutet beispielsweise, dass bei der Signierung der Runde "1" nur eine Signatur erforderlich ist.
usePlaceholders	usePlaceholders		boolean	Wenn wahr, werden textplatzhalter/formFields, die im Dokument gespeichert sind, zum Einladen von Empfängern verwendet.
inPersonSigning	inPersonSigning		boolean	Wenn wahr, erhält der Empfänger ein Popup, in dem er eine Signatur manuell zeichnen muss
folderName	folderName		string	Wenn angegeben, wird ein Umschlag erstellt, der alle Dokumente in documentDataArray enthält. (Erforderlich, wenn mehrere Dokumente gesendet werden)
callbackUrl	callbackUrl		string	Eine POST-Anforderung, einschließlich des Dokuments, wird an diese URL gesendet, wenn eine neue Signatur erstellt wird oder wenn ein Empfänger das Dokument ablehnt. Im Falle eines Fehlers ist ein Wiederholungsmechanismus vorhanden, um sicherzustellen, dass die Anforderung erneut versucht wird.
returnUrl	returnUrl		string	Der Link der Zurück-Schaltfläche nach dem Signieren eines Dokuments
returnBtnText	returnBtnText		string	Der Text der Rückgabeschaltfläche nach dem Signieren eines Dokuments
data	data	True	string	Die Dokumentdaten (PDF oder DOCX) im Base64-Format.
mimetype	mimetype		string	MIME-Typ von base64-codierten Daten PDF oder DOCX, erforderlich, wenn das Dokument keine PDF-Datei ist
Dateiname	fileName	True	string	Name der Datei
label	label		string	Eine benutzerdefinierte Bezeichnung, die an die Organisation von Dokumenten gesendet werden kann.
Seite	page	True	integer	Die Nummer der Seite, auf der sich das Feld befindet, wobei die erste Seite 0 ist.
Pagewidth	pageWidth		number	Ein ganzzahliger Wert, der die Seitenbreite beschreibt. Je größer die Zahl ist, desto besser ist die Genauigkeit beim Positionieren des Felds im x y-Raum. Auf einer A4-Seite haben wir 478 als Standardwert.
Pageheight	pageHeight		number	Ein ganzzahliger Wert, der die Seitenhöhe beschreibt. Je größer die Zahl ist, desto besser ist die Genauigkeit beim Positionieren des Felds im x y-Raum. Auf einer A4-Seite haben wir 676 als Standardwert.
x	x	True	float	Stellt die horizontale Position des Felds als Prozentsatz der Seitenbreite dar. Der Ursprung (0,0) befindet sich oben links auf der Seite. Der Wert 0,1 bedeutet, dass das Feld bei 10% der Seitenbreite von links positioniert wird.
y	y	True	float	Stellt die vertikale Position des Felds als Prozentsatz der Seitenhöhe dar. Der Ursprung (0,0) befindet sich oben links auf der Seite. Ein Wert von 0,1 bedeutet, dass das Feld von oben an 10% der Seitenhöhe positioniert ist.
width	width	True	float	Breite des Felds basierend auf Seitenabmessungen, ähnlich wie die x- und y-Koordinaten. Es ist ein Float-Wert, der einen Prozentsatz des PageWidth-Werts darstellt.
height	height	True	float	Höhe des Felds basierend auf Seitenabmessungen, ähnlich den X- und Y-Koordinaten. Es ist ein Float-Wert, der einen Prozentsatz des PageHeight-Werts darstellt.
id	id	True	string	Eine eindeutige ID für dieses Feld, die auf beliebige Weise generiert wird.
label	label		string	Platzhaltertext, z. B. der Name des Felds, z. B. "Geburtsdatum".
value	value		string	Standardwert für das Feld. Kann NULL sein. Wenn das Feld vom Typ "chooseBox" ist, kann der Wert null oder eine der in den Optionen definierten Zeichenfolgen sein.
fieldId	fieldId		string	Ein stabiler Feldbezeichner, der in der Benutzeroberfläche konfiguriert ist. Wird verwendet, um Workflowformularfelder über API-Anforderungen vorab auszufüllen.
nur lesen	readonly		boolean	Wenn dieser Wert auf "true" festgelegt ist, kann die eingeladene Person den Wert dieses Felds nicht ändern.
required	required		boolean	Wenn "true" festgelegt ist, kann die eingeladene Person das Dokument nicht signieren, ohne dieses Feld auszufüllen.
type	type	True	string
Mehrzeile	multiline		boolean	Gibt an, ob mehrere Zeilen zulässig sind.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Jedem Optionsfeld kann eine Gruppe zugewiesen werden.
signatureTypes	signatureTypes		array of string	Der für dieses Dokument zulässige Signaturtyp kann vom Empfängersignaturtyp überschrieben werden. Es wird höchstens ein Wert unterstützt. Optionen: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId	refId		string	Die RefId ist ein optionales Feld, das zum Querverweis auf das hochgeladene Dokument verwendet wird. Wenn angegeben, können Sie dem Dokument einen benutzerdefinierten Verweisbezeichner zuweisen, der als Teil des Dokumentobjekts in zukünftigen API-Antworten zurückgegeben wird. Dies kann nützlich sein, um Dokumente nach einem externen System oder Workflow zu verfolgen oder zu organisieren.
language	language		string	Die Dokumentsprache.
folderId	folderId		string	Die ID eines Ordners, in den die Dokumente eingefügt werden sollen. Dies ist nur möglich, wenn sowohl inviteData als auch folderName nicht definiert sind.
isAttachment	isAttachment		boolean	isAttachment ist in diesem Fall nicht erforderlich.
Empfängerdetails	recipientDetails	True	object	Empfängerdetails, die von der E-Mail-Adresse des Empfängers schlüsselt. Beispiel: {"mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}}.
useFastlane	useFastlane		boolean	Wenn diese Einstellung auf `true` den Signierer festgelegt ist, wird in der Einladungs-E-Mail ein Fastlane-Link angezeigt.
fastlaneProfileId	fastlaneProfileId		uuid	Geben Sie das Fastlane-Profil an, das mit diesem Dokument verwendet werden soll. (useFastlane muss auf "true" festgelegt werden.

Gibt zurück

Body: PrepareSignatureRequestResponse

Definitionen

DeleteDocumentResponse

Dokumentantwort löschen: string

_DocumentListResponse

Antwortobjekt für Dokumentlistenvorgänge

Name	Pfad	Typ	Beschreibung
data	data	array of _Document	Liste der Dokumente
Pagination-Objekt	pagination	_PaginationObject

_PaginationObject

Name	Pfad	Typ	Beschreibung
gesamt	total	integer	Gesamtanzahl der Elemente (z. B. Dokumente) in einer Ansicht (z. B. allDocuments)
lastPage	lastPage	integer	Nummer der letzten Seite
perPage	perPage	integer	Anzahl der Dokumente pro Seite
Currentpage	currentPage	integer	Nummer der aktuellen Seite
zu	to	integer	Index des letzten Dokuments

_Document

Name	Pfad	Typ	Beschreibung
name	name	string	Dokumentname
id	id	string	Dokument-ID
updatedAt	updatedAt	date	Datum der letzten Dokumentaktualisierung
createdAt	createdAt	date	Erstellungsdatum des Dokuments
signaturesTypes	signaturesTypes	array of string	Die Typen von Signaturen, die für diesen Empfänger zulässig sind, können von Empfängersignaturtypen überschrieben werden. Optionen: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
callbackUrl	callbackUrl	string	Eine Postanforderung einschließlich des Dokuments wird an diese URL gesendet, wenn eine neue Signatur erstellt wird.
returnUrl	returnUrl	string	Der Link der Zurück-Schaltfläche nach dem Signieren eines Dokuments
returnBtnText	returnBtnText	string	Der Text der Rückgabeschaltfläche nach dem Signieren eines Dokuments
inPersonSigning	inPersonSigning	boolean
signRound	signingRound	number
state	state	string	Der aktuelle Status des Dokuments. Mögliche Werte sind: Entwurf, ausstehend, abgelehnt, abgeschlossen, Anlage, manuell ausstehend, manuallyCompleted
member	member		In der Regel ist der Besitzer des Dokuments, aber wenn Sie getSignatureStatus verwenden, ist das Mitglied eine Id, die in der Anforderung angegeben wird.
Member	members	array of DocumentListMember	Eine Liste der eingeladenen Kontakte
Boxen	boxes	array of DocumentListResponseBox	Signaturpositionsdaten mit zusätzlichen antwortspezifischen Feldern. Die Felder "cardStyle", "pageWidth" und "pageHeight" sind optional und sind möglicherweise nicht in allen API-Antworten vorhanden.
refId	refId	string
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean

DocumentListResponseBox

Name	Pfad	Typ	Beschreibung
id	id	string
fieldId	fieldId	string	Die konfigurierte Feld-ID, die zum Vorfüllen von Formularfeldern verwendet wird. Gibt NULL zurück, wenn keine Feld-ID konfiguriert ist.
type	type	string
value	value		Der Wert des Feldfelds. Kann je nach Feldtyp eine Zeichenfolge (einschließlich leerer Zeichenfolge), boolescher Wert oder Null sein.
label	label	string
readOnly	readOnly	boolean

DocumentListMember

Name	Pfad	Typ	Beschreibung
id	id	string	Die Member-ID kann verwendet werden, um das Dokument im sproof Sign Editor zu öffnen. Eine ausführlichere Beschreibung finden Sie hier
email	email	string	E-Mail-Adresse des Dokumentbesitzers
firstName	firstName	string	Vorname des Dokumentbesitzers
lastName	lastName	string	Nachname des Dokumentbesitzers
lastActivityAt	lastActivityAt	date-time	Datum und Uhrzeit der letzten Aktivität (ISO 8601 datetime string)
createdAt	createdAt	date-time	Datum und Uhrzeit des Dokumentuploads (ISO 8601 Datetime-Zeichenfolge)
gezeichnet	signed	boolean	Gibt an, ob das Dokument vom Besitzer signiert wurde.
isAdmin	isAdmin	boolean	Gibt an, ob das Mitglied über den Administratorstatus verfügt.
isSigner	isSigner	boolean	Gibt an, ob es sich bei dem Mitglied um einen Signierer handelt.
isApprover	isApprover	boolean	Gibt an, ob das Mitglied ein genehmigende Person ist.
isViewer	isViewer	boolean	Gibt an, ob das Mitglied ein Viewer ist.
approvedAt	approvedAt	date-time	Nur wenn isApprover "true" ist. Datum und Uhrzeit der Genehmigung des Elements (ISO 8601 datetime string)
viewedAt	viewedAt	date-time	Nur wenn isViewer wahr ist. Datum und Uhrzeit der Anzeige des Dokuments durch das Mitglied (ISO 8601 datetime string)
signaturePosition	signaturePosition		Die Signaturposition(n) für dieses Element. Basierend auf dem, was in der Anforderung gesendet wird, können Sie entweder ein einzelnes Positionsobjekt oder ein Array von Positionsobjekten erwarten.
signedAt	signedAt	date-time	Datum und Uhrzeit der Signatur (ISO 8601 datetime string)
signingOrder	signingOrder	number	Die Reihenfolge, in der sich dieses Mitglied signieren soll
declinedAt	declinedAt	date-time	Datum und Uhrzeit, zu dem das Element abgelehnt wurde (ISO 8601-Datetime-Zeichenfolge)
Signaturen	signatures	array of object	Array von Signaturen
signatureType	signatures.signatureType	string	Signaturtyp (z. B. aes_sproof)
signedAt	signatures.signedAt	date-time	Zeitstempel, zu dem die Signatur angewendet wurde (ISO 8601-Datetime-Zeichenfolge)

PrepareSignatureRequestResponse

Name	Pfad	Typ	Beschreibung
folderId	folderId	string
folderName	folderName	string
Dokumente	documents	array of object
id	documents.id	string
name	documents.name	string
language	documents.language	string
Member	documents.members	array of	Da es sich um eine Antwort auf die Signaturanforderung handelt, ist das Memberarray leer. Dies liegt daran, dass die Mitglieder noch nicht eingeladen werden.
member	documents.member	MemberResponseSchema

MemberResponseSchema

Name	Pfad	Typ	Beschreibung
id	id	string
documentId	documentId	string
email	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	Datum und Uhrzeit der Erstellung des Elements (ISO 8601 datetime string)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Datum und Uhrzeit der Benachrichtigung zum Löschen (ISO 8601 datetime string)
manuallyLastEmailSent	manuallyLastEmailSent	date-time	Datum und Uhrzeit, zu dem die letzte manuelle E-Mail gesendet wurde (ISO 8601 datetime string)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Signaturpositionsdaten mit zusätzlichen antwortspezifischen Feldern. Die Felder "cardStyle", "pageWidth" und "pageHeight" sind optional und sind möglicherweise nicht in allen API-Antworten vorhanden.
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	Datum und Uhrzeit, zu dem das Element abgelehnt wurde (ISO 8601-Datetime-Zeichenfolge)
signingOrder	signingOrder	number
Ondemand	onDemand	string
recipientId	recipientId	string
signatureTypes	signatureTypes	array of string
signatureTypesActive	signatureTypesActive	boolean
privateMessage	privateMessage	string
customId	customId	string
useFastlane	useFastlane	boolean
Rolle	role	string
approvedAt	approvedAt	date-time	Datum und Uhrzeit der Genehmigung des Elements (ISO 8601 datetime string)
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
Signaturen	signatures	array of string
Boxen	boxes	array of DocumentResponseBox	Diesem Element zugewiesene Formularfeldfelder.
signedAt	signedAt	date-time	Datum und Uhrzeit, zu dem das Mitglied signiert ist (ISO 8601-Datums-/Uhrzeitzeichenfolge)

DocumentResponseBox

Name	Pfad	Typ	Beschreibung
id	id	string
fieldId	fieldId	string	Die konfigurierte Feld-ID, die zum Vorfüllen von Formularfeldern verwendet wird. Gibt NULL zurück, wenn keine Feld-ID konfiguriert ist.
type	type	string
value	value	string	Der Wert des Feldfelds. Kann je nach Feldtyp eine Zeichenfolge (einschließlich leerer Zeichenfolge), boolescher Wert oder Null sein.
label	label	string
readOnly	readOnly	boolean

MemberSignaturePositionResponse

Signaturpositionsdaten mit zusätzlichen antwortspezifischen Feldern. Die Felder "cardStyle", "pageWidth" und "pageHeight" sind optional und sind möglicherweise nicht in allen API-Antworten vorhanden.

Name	Pfad	Typ	Beschreibung
Gegenstände		SignaturePositionResponse	Signaturpositionsdaten mit zusätzlichen antwortspezifischen Feldern. Die Felder "cardStyle", "pageWidth" und "pageHeight" sind optional und sind möglicherweise nicht in allen API-Antworten vorhanden.

SignaturePositionResponse

Name	Pfad	Typ	Beschreibung
Seite	page	integer	Seitenzahl, beginnend mit 0.
x	x	number	x-Koordinate der oberen linken Position der Signaturen
y	y	number	y-Koordinate der oberen linken Position der Signaturen
width	width	number	Breite der Signatur.
height	height	number	Höhe der Signatur.
cardStyle	cardStyle	string	Die visuelle Formatvorlage der Signaturkarte. Dieses Feld ist optional und kann nicht in allen Antworten zurückgegeben werden.
Pagewidth	pageWidth	number	Die Breite der Seite in Pixeln. Dieses Feld ist optional und kann nicht in allen Antworten zurückgegeben werden.
Pageheight	pageHeight	number	Die Höhe der Seite in Pixel. Dieses Feld ist optional und kann nicht in allen Antworten zurückgegeben werden.

EnvelopeResponse

Name	Pfad	Typ	Beschreibung
folderId	folderId	string
folderName	folderName	string
Dokumente	documents	array of object
id	documents.id	string
name	documents.name	string
language	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Datum und Uhrzeit, zu dem Erinnerungen gesendet werden (ISO 8601 datetime string)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	Datum und Uhrzeit der Erstellung des Dokuments (ISO 8601 datetime string)
callbackUrl	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
signRound	documents.signingRound	number
isTemplate	documents.isTemplate	boolean
templateId	documents.templateId	string
linkId	documents.linkId	string
linkExpiresAt	documents.linkExpiresAt	string
derivedFromLink	documents.derivedFromLink	boolean
state	documents.state	string
complianceLevel	documents.complianceLevel	string
allowForwarding	documents.allowForwarding	boolean
linkExpires	documents.linkExpires	boolean
setDueDate	documents.setDueDate	boolean
fälliges Datum	documents.dueDate	date-time	Fälligkeitsdatum für das Dokument (ISO 8601 datetime string)
focusedSigningMode	documents.focusedSigningMode	boolean
linkMaxSignaturesEnabled	documents.linkMaxSignaturesEnabled	boolean
linkMaxSignatures	documents.linkMaxSignatures	number
fastlaneProfileId	documents.fastlaneProfileId	string
refId	documents.refId	string
sendOutFinishedPdf	documents.sendOutFinishedPdf	boolean
signatureTypes	documents.signatureTypes	array of string
Member	documents.members	array of MemberResponseSchema
member	documents.member	MemberResponseSchema
Boxen	documents.boxes	array of DocumentResponseBox	Allgemeine Formularfeldfelder, die einem bestimmten Empfänger nicht zugewiesen sind, wenn das Dokument Formularfelder enthält. Felder, die Empfängern zugewiesen sind, werden in Membern[n].feldern zurückgegeben.
Überfällig	documents.overdue	boolean

DocumentStatusForFlow

Name	Pfad	Typ	Beschreibung
id	id	string
name	name	string
state	state	string	Der aktuelle Status des Dokuments. Mögliche Werte sind: Entwurf, ausstehend, abgelehnt, abgeschlossen, Anlage, manuell ausstehend, manuallyCompleted
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean