sproof Sign (förhandsversion)

Använd sproof Sign för att automatisera säkra arbetsflöden för elektroniska signaturer för PDF- och DOCX-dokument. Organisationer kan skapa signaturer för enskilda eller flera dokument, tilldela mottagare och signeringsroller, spåra status, ladda ned slutförda PDF-filer och ta bort dokument. Ett sproof Sign-konto, en plan som stöder de valda åtgärderna och signaturtyperna och en giltig API-token krävs.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Service	Class	Regioner
Copilot Studio	Premium	Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Logiska appar	Standard	Alla Logic Apps-regioner utom följande: - Azure Government regioner - Azure kinaregioner - US Department of Defense (DoD)
Power Apps	Premium	Alla Power Apps regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD)

Kontakt
Namn	API-stöd
URL	https://sproof.com
E-postmeddelande	support@sproof.com

Metadata för anslutningsprogram
Publisher	sproof GmbH
Webbplats	https://www.sproof.com/en/sign/
Sekretesspolicy	https://www.sproof.com/en/privacy-policy-app/
Kategorier	Produktivitet; Innehåll och filer

sproof Sign

Översikt

sproof Sign gör det möjligt för organisationer att automatisera arbetsflöden för elektroniska signaturer för PDF- och DOCX-dokument. Anslutningsappen kan skapa signaturer med ett enda dokument eller kuvert med flera dokument, tilldela mottagare och signeringsroller, hämta begärandestatus, ladda ned slutförda dokument och ta bort dokument.

Förutsättningar

Om du vill använda anslutningsappen behöver du:

Ett sproof Sign-konto.
En sproof Sign-plan med API-åtkomst och stöd för nödvändiga åtgärder och signaturtyper.
En giltig api-token för beständigt tecken.

Authentication

Anslutningsappen använder API-tokenautentisering. Skapa en anslutning genom att ange en giltig sproof Sign API-token som är associerad med ditt konto. Skydda token och ersätt den om den återkallas eller återskapas.

Åtgärder som stöds

Skapa signaturbegäran – Skapar en begäran om ett dokument eller ett kuvert som innehåller flera dokument. Mottagare, signeringsroller, signeringsordning, signaturpositioner och andra inbjudningsinställningar kan konfigureras.
Skapa signaturbegäran med platshållare – Skapar en begäran med platshållare som lagras i ett uppladdat dokument. Mottagarinformation och signaturpositioner extraheras från dessa platshållare.
Hämta status för begäran – Hämtar det aktuella tillståndet och signeringsstatusen för en signaturbegäran med dess medlems-ID.
Hämta dokument – Laddar ned ett dokument som en binär PDF eller som en Base64-kodad PDF.
Ta bort dokument – Tar bort ett dokument eller tar bort en medlems åtkomst, beroende på det angivna medlems-ID:t, medlemmens roll och om dokumentet tillhör ett kuvert.

Kända begränsningar och krav

Indatadokument måste anges som Base64-kodat PDF- eller DOCX-innehåll.
Ett kuvert kan innehålla högst 25 dokument.
Ett kuvertnamn krävs när mer än ett dokument skickas.
Platshållarbaserade begäranden kräver korrekt formaterade platshållare i det uppladdade dokumentet.
För platshållarbaserade begäranden hämtas mottagare och signaturpositioner från dokumentet i stället för att anges manuellt.
Tillgängliga åtgärder, signaturtyper och leverantörer beror på det anslutna sproof Sign-kontot och planen.
Beteendet för dokumentborttagning beror på om det angivna medlems-ID:t tillhör avsändaren eller mottagaren och om dokumentet ingår i ett kuvert.

Support

Kontakta om du vill ha stöd för anslutningsappen eller API:et support@sproof.com.

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:


Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Type	Description	Obligatoriskt
token	securestring	"token" für diese API	True

Åtgärder

Hämta dokument	Hämta signerat dokument som binär eller Base64-kodad sträng.
Hämta status för begäran	Hämta status för en signaturbegäran. Returnerar ett JSON-dokumentobjekt eller ett fel. Parametern returneras av postbegäran i dokumentet och är associerad med avsändares e-post.
Skapa signaturbegäran	Det här är den nya begäran om att skapa signatur. Förutom att skapa en enda dokumentinbjudan har den nu stöd för att skapa kuvert och ladda upp flera dokument samtidigt när inbjudningar skickas.
Skapa signaturbegäran med platshållare	Skapar en signaturbegäran med platshållare som lagras i det uppladdade dokumentet. Mottagare och signaturpositioner extraheras från dokumentet.
Ta bort dokument	Tar bort ett dokument eller tar bort en medlems åtkomst till det, beroende på om den angivna `memberId` tillhör avsändaren eller en mottagare och om dokumentet ingår i ett kuvert. Dokument i ett kuvert Frågeparametern `all` har ingen effekt för dokument i ett kuvert. Med avsändaren `memberId`: Ett enda dokument tas bort för avsändaren och alla mottagare. Dokumentet tas bort från kuvertet. Med mottagaren `memberId`: Alla dokument i kuvertet tas bort för mottagaren. Mottagaren markeras som `declined` på alla dokument som har tagits bort för mottagaren. Dokumenten är fortfarande tillgängliga för alla andra medlemmar i dokumentet. Enkla dokument Med avsändaren `memberId` och `all=true`: Dokumentet tas bort för avsändaren och alla mottagare. Med avsändaren `memberId` och `all=false`: Dokumentet tas bara bort för avsändaren. Dokumentet förblir tillgängligt för de andra mottagarna i dokumentet. Med mottagaren `memberId`: Mottagaren markeras som `declined` i dokumentet. Dokumentet är fortfarande tillgängligt för alla andra medlemmar i dokumentet.

Hämta dokument

Åtgärds-ID:: GetDocument

Hämta signerat dokument som binär eller Base64-kodad sträng.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Medlems-ID	memberId	True	string	Medlems-ID
Ladda ned format	format		string	Anger svarsformatet. Använd `pdf` för binär PDF och `base64` för ett Base64-kodat svar. Exempelsvar `base64` : `json { "base64": "JVBERi0xLjQKJe..." }`

Returer

Name	Sökväg	Typ	Description
base64	base64	string	Base64-kodat PDF-innehåll

Hämta status för begäran

Åtgärds-ID:: GetSignatureStatus

Hämta status för en signaturbegäran. Returnerar ett JSON-dokumentobjekt eller ett fel. Parametern returneras av postbegäran i dokumentet och är associerad med avsändares e-post.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Medlems-ID	memberId	True	string	Medlems-ID

Returer

Body: DocumentStatusForFlow

Skapa signaturbegäran

Åtgärds-ID:: CreateSignatureRequest

Det här är den nya begäran om att skapa signatur. Förutom att skapa en enda dokumentinbjudan har den nu stöd för att skapa kuvert och ladda upp flera dokument samtidigt när inbjudningar skickas.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
email	email	True	string	Avsändarens e-post. Den måste tillhöra en medlem av din plan.
firstName	firstName	True	string	Avsändarens förnamn.
lastName	lastName		string	Avsändarens efternamn.
role	role		string	Avsändarens roll i alla dokument.
email	email		string	E-post till mottagaren.
firstName	firstName		string	Mottagarens förnamn.
lastName	lastName		string	Mottagarens efternamn.
doNotSendEmails	doNotSendEmails		boolean	Om inget e-postmeddelande har angetts `true` skickas det till mottagaren.
customId	customId		string	Används endast när mottagarens e-postadress är okänd vid tidpunkten för inbjudan. Detta fungerar bara när du bjuder in mottagarna (inte för att förbereda vägar) och du vill använda fastlane. Med `customId` kan du i förväg generera en unik signeringslänk för en mottagare innan du skickar en inbjudan. Måste vara en unik alfanumerisk sträng på minst 70 tecken. Obs! CustomId kan bara användas för att skapa mottagarlänken till ett dokument. Det kan inte användas för andra begäranden i stället för memberId. Mer information om URL-konstruktion finns i Öppna ett dokument med ett anpassat ID
useFastlane	useFastlane		boolean	Om värdet är `true` inställt på undertecknaren får du en Fastlane-länk i e-postmeddelandet för inbjudan.
phoneNumber	phoneNumber		string	Mottagarens telefonnummer. Detta används för SMS-verifiering. (t.ex. +43 699 1234 1234).
privateMessage	privateMessage		string	Ett privat meddelande för den här specifika mottagaren.
inPersonMode	inPersonMode		boolean	När det här alternativet är aktiverat måste mottagaren av signaturbegäran signera dokumentet personligen och inget e-postmeddelande skickas. Det här läget är endast tillgängligt med hjälp av SES-signaturtypen
signatureTypes	signatureTypes		array of string	De typer av signaturer som tillåts för den här mottagaren. Alternativ: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Den här taggen avgör den identitetsprovider som ska användas för signeringsprocessen. Välj mellan en fördefinierad uppsättning leverantörer som stöds. Obs! 1: Vissa leverantörer är bara tillgängliga för vissa signatureTypes, till exempel `onetimeqes` kräver `"signatureType" : ["qualifiedPlusIdent"]` Obs! 2: När mottagaren använder `sproof-qualified` som standardprovider måste den ha ett aktivt sproof-konto med en aktiv User+-licens.
canChange	canChange		boolean	Booleskt värde för att ange om den inbjudna mottagaren ska kunna ändra signaturprovidern
country	country		string	Standardlandet, om det är tomt som det är inställt på alla, returneras ett fel med vilka länder som är tillgängliga för providertaggen som valts
dueDate (på engelska)	dueDate		YYYY-MM-DD	Datumet då dokumentet kan signeras. Det här förfallodatumet visas för mottagaren i e-postmeddelandet för inbjudan och visas även i avsnittet dokumentinformation på instrumentpanelen. Det fungerar som en tidsfrist för att slutföra signeringsprocessen.
reminderInterval	reminderInterval		number	Anger antalet dagar mellan e-postpåminnelser.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum då påminnelser ska skickas ut
inviteLanguage	inviteLanguage		string	Anger språket för e-postmeddelanden som skickas till anonyma användare som inte har något konto. För användare med ett konto används det språk som de har valt i sin profil i stället.
message	message		string	Ett anpassat meddelande som skickas till mottagarna i e-postmeddelandet.
subject	subject		string	Ämnesraden i e-postmeddelandet som skickas till mottagarna.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Om värdet är true skickas pdf-filen som en bifogad fil till alla mottagare i dokumentet (om den är mindre än 5 MB).
focusedSigningMode	focusedSigningMode		boolean	När det här alternativet är aktiverat begränsas mottagaren av signaturbegäran till att signera eller avböja dokumentet och kommer inte att kunna navigera bort från sidan.
allowForwarding	allowForwarding		boolean	Tillåt vidarebefordran av inbjudan.
collabSigningMode	collabSigningMode		object	Ett objekt där varje nyckel representerar en signeringsrunda och dess motsvarande värde anger om samarbetssignering är aktiverat för den rundan. Om värdet är sant krävs bara en signatur för att slutföra den angivna signeringsrundan och gå vidare till nästa omgång. Till exempel betyder { '1': true } att vid signering av avrunda '1' krävs bara en signatur.
usePlaceholders	usePlaceholders		boolean	Om sant används textplatshållare/formFält som lagras i dokumentet för att bjuda in mottagare.
inPersonSigning	inPersonSigning		boolean	När det är sant får mottagaren ett popup-fönster där han behöver rita en signatur manuellt
folderName	folderName		string	Om detta anges skapas ett kuvert som innehåller alla dokument i documentDataArray. (Krävs om fler än ett dokument skickas)
callbackUrl	callbackUrl		string	En POST-begäran, inklusive dokumentet, skickas till den här URL:en när en ny signatur skapas eller när en mottagare nekar dokumentet. Vid fel finns en mekanism för återförsök för att säkerställa att begäran görs på nytt.
returnUrl	returnUrl		string	Länken till returknappen när du har signerat ett dokument
returnBtnText	returnBtnText		string	Texten på returknappen när du har signerat ett dokument
data	data	True	string	Dokumentdata (PDF eller DOCX) i base64-format.
mimetype	mimetype		string	MIME-typ av base64-kodad data-PDF eller DOCX krävs om dokumentet inte är en pdf-fil
fileName	fileName	True	string	Filens namn
label	label		string	En anpassad etikett som kan skickas för att organisera dokument.
sida	page	True	integer	Numret på sidan som rutan är på, där den första sidan är 0.
pageWidth	pageWidth		integer	Alla heltalsvärden som beskriver sidbredden. Ju större tal, desto bättre precision när du placerar rutan i x y utrymme. På en A4-sida har vi 478 som standardvärde.
pageHeight	pageHeight		integer	Alla heltalsvärden som beskriver sidhöjden. Ju större tal, desto bättre precision när du placerar rutan i x y utrymme. På en A4-sida har vi 676 som standardvärde.
x	x	True	float	Representerar rutans vågräta position i procent av sidbredden. Ursprunget (0,0) finns längst upp till vänster på sidan. Värdet 0,1 innebär att rutan är placerad på 10% av sidbredden från vänster.
y	y	True	float	Representerar rutans lodräta position i procent av sidhöjden. Ursprunget (0,0) finns längst upp till vänster på sidan. Värdet 0,1 innebär att rutan är placerad på 10% av sidhöjden uppifrån.
width	width	True	float	Bredd på rutan baserat på siddimensioner, ungefär som x- och y-koordinaterna. Det är en flyttal som representerar en procentandel av sidanWidth.
height	height	True	float	Höjden på rutan baserat på siddimensioner, ungefär som x- och y-koordinaterna. Det är en flyttal som representerar en procentandel av sidanHeight.
id	id	True	string	Ett unikt ID för den här rutan som genereras på vilket sätt du vill.
label	label		string	Platshållartext, till exempel namnet på fältet, t.ex. "Födelsedatum".
värde	value		string	Standardvärde för rutan. Kan vara null. Om rutan är av typen "chooseBox" kan värdet vara null eller en av de strängar som definierats i alternativen.
readonly	readonly		boolean	Om värdet är true kan den inbjudna personen inte ändra värdet för den här rutan.
required	required		boolean	Om värdet är true kan den inbjudna personen inte signera dokumentet utan att fylla i den här rutan.
type	type	True	string
flera ledningar	multiline		boolean	Om flera rader tillåts.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Varje radioruta kan tilldelas till en grupp.
signatureTypes	signatureTypes		array of string	De typer av signaturer som tillåts för den här mottagaren kan skrivas över av mottagarsignaturtyper. Alternativ: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId är ett valfritt fält som används för att korsreferensera det uppladdade dokumentet. Om det tillhandahålls kan du tilldela en anpassad referensidentifierare till dokumentet, som returneras som en del av dokumentobjektet i framtida API-svar. Detta kan vara användbart för att spåra eller organisera dokument efter ett externt system eller arbetsflöde.
language	language		string	Dokumentspråket.
folderId	folderId		string	ID för en mapp där dokumenten ska infogas. Detta är bara möjligt när både inviteData och folderName är odefinierade.
isAttachment	isAttachment		boolean	isAttachment behövs inte i det här fallet.
Information om mottagare	recipientDetails	True	object	Mottagarinformation som är kopplad till mottagarens e-post. Exempel: {":mail@test.com{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}.
useFastlane	useFastlane		boolean	Om värdet är `true` inställt på undertecknaren får du en Fastlane-länk i e-postmeddelandet för inbjudan.
fastlaneProfileId	fastlaneProfileId		uuid	Ange den Fastlane-profil som ska användas med det här dokumentet. (useFastlane måste vara inställt på true).

Returer

Body: EnvelopeResponse

Skapa signaturbegäran med platshållare

Åtgärds-ID:: CreateSignatureRequestUsingPlaceholders

Skapar en signaturbegäran med platshållare som lagras i det uppladdade dokumentet. Mottagare och signaturpositioner extraheras från dokumentet.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
email	email	True	string	Avsändarens e-post. Den måste tillhöra en medlem av din plan.
firstName	firstName	True	string	Avsändarens förnamn.
lastName	lastName		string	Avsändarens efternamn.
role	role		string	Avsändarens roll i alla dokument.
email	email		string	E-post till mottagaren.
firstName	firstName		string	Mottagarens förnamn.
lastName	lastName		string	Mottagarens efternamn.
doNotSendEmails	doNotSendEmails		boolean	Om inget e-postmeddelande har angetts `true` skickas det till mottagaren.
customId	customId		string	Används endast när mottagarens e-postadress är okänd vid tidpunkten för inbjudan. Detta fungerar bara när du bjuder in mottagarna (inte för att förbereda vägar) och du vill använda fastlane. Med `customId` kan du i förväg generera en unik signeringslänk för en mottagare innan du skickar en inbjudan. Måste vara en unik alfanumerisk sträng på minst 70 tecken. Obs! CustomId kan bara användas för att skapa mottagarlänken till ett dokument. Det kan inte användas för andra begäranden i stället för memberId. Mer information om URL-konstruktion finns i Öppna ett dokument med ett anpassat ID
useFastlane	useFastlane		boolean	Om värdet är `true` inställt på undertecknaren får du en Fastlane-länk i e-postmeddelandet för inbjudan.
phoneNumber	phoneNumber		string	Mottagarens telefonnummer. Detta används för SMS-verifiering. (t.ex. +43 699 1234 1234).
privateMessage	privateMessage		string	Ett privat meddelande för den här specifika mottagaren.
inPersonMode	inPersonMode		boolean	När det här alternativet är aktiverat måste mottagaren av signaturbegäran signera dokumentet personligen och inget e-postmeddelande skickas. Det här läget är endast tillgängligt med hjälp av SES-signaturtypen
signatureTypes	signatureTypes		array of string	De typer av signaturer som tillåts för den här mottagaren. Alternativ: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Den här taggen avgör den identitetsprovider som ska användas för signeringsprocessen. Välj mellan en fördefinierad uppsättning leverantörer som stöds. Obs! 1: Vissa leverantörer är bara tillgängliga för vissa signatureTypes, till exempel `onetimeqes` kräver `"signatureType" : ["qualifiedPlusIdent"]` Obs! 2: När mottagaren använder `sproof-qualified` som standardprovider måste den ha ett aktivt sproof-konto med en aktiv User+-licens.
canChange	canChange		boolean	Booleskt värde för att ange om den inbjudna mottagaren ska kunna ändra signaturprovidern
country	country		string	Standardlandet, om det är tomt som det är inställt på alla, returneras ett fel med vilka länder som är tillgängliga för providertaggen som valts
dueDate (på engelska)	dueDate		YYYY-MM-DD	Datumet då dokumentet kan signeras. Det här förfallodatumet visas för mottagaren i e-postmeddelandet för inbjudan och visas även i avsnittet dokumentinformation på instrumentpanelen. Det fungerar som en tidsfrist för att slutföra signeringsprocessen.
reminderInterval	reminderInterval		number	Anger antalet dagar mellan e-postpåminnelser.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum då påminnelser ska skickas ut
inviteLanguage	inviteLanguage		string	Anger språket för e-postmeddelanden som skickas till anonyma användare som inte har något konto. För användare med ett konto används det språk som de har valt i sin profil i stället.
message	message		string	Ett anpassat meddelande som skickas till mottagarna i e-postmeddelandet.
subject	subject		string	Ämnesraden i e-postmeddelandet som skickas till mottagarna.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Om värdet är true skickas pdf-filen som en bifogad fil till alla mottagare i dokumentet (om den är mindre än 5 MB).
focusedSigningMode	focusedSigningMode		boolean	När det här alternativet är aktiverat begränsas mottagaren av signaturbegäran till att signera eller avböja dokumentet och kommer inte att kunna navigera bort från sidan.
allowForwarding	allowForwarding		boolean	Tillåt vidarebefordran av inbjudan.
collabSigningMode	collabSigningMode		object	Ett objekt där varje nyckel representerar en signeringsrunda och dess motsvarande värde anger om samarbetssignering är aktiverat för den rundan. Om värdet är sant krävs bara en signatur för att slutföra den angivna signeringsrundan och gå vidare till nästa omgång. Till exempel betyder { '1': true } att vid signering av avrunda '1' krävs bara en signatur.
inPersonSigning	inPersonSigning		boolean	När det är sant får mottagaren ett popup-fönster där han behöver rita en signatur manuellt
folderName	folderName		string	Om detta anges skapas ett kuvert som innehåller alla dokument i documentDataArray. (Krävs om fler än ett dokument skickas)
callbackUrl	callbackUrl		string	En POST-begäran, inklusive dokumentet, skickas till den här URL:en när en ny signatur skapas eller när en mottagare nekar dokumentet. Vid fel finns en mekanism för återförsök för att säkerställa att begäran görs på nytt.
returnUrl	returnUrl		string	Länken till returknappen när du har signerat ett dokument
returnBtnText	returnBtnText		string	Texten på returknappen när du har signerat ett dokument
data	data	True	string	Dokumentdata (PDF eller DOCX) i base64-format.
mimetype	mimetype		string	MIME-typ av base64-kodad data-PDF eller DOCX krävs om dokumentet inte är en pdf-fil
fileName	fileName	True	string	Filens namn
label	label		string	En anpassad etikett som kan skickas för att organisera dokument.
sida	page	True	integer	Numret på sidan som rutan är på, där den första sidan är 0.
pageWidth	pageWidth		integer	Alla heltalsvärden som beskriver sidbredden. Ju större tal, desto bättre precision när du placerar rutan i x y utrymme. På en A4-sida har vi 478 som standardvärde.
pageHeight	pageHeight		integer	Alla heltalsvärden som beskriver sidhöjden. Ju större tal, desto bättre precision när du placerar rutan i x y utrymme. På en A4-sida har vi 676 som standardvärde.
x	x	True	float	Representerar rutans vågräta position i procent av sidbredden. Ursprunget (0,0) finns längst upp till vänster på sidan. Värdet 0,1 innebär att rutan är placerad på 10% av sidbredden från vänster.
y	y	True	float	Representerar rutans lodräta position i procent av sidhöjden. Ursprunget (0,0) finns längst upp till vänster på sidan. Värdet 0,1 innebär att rutan är placerad på 10% av sidhöjden uppifrån.
width	width	True	float	Bredd på rutan baserat på siddimensioner, ungefär som x- och y-koordinaterna. Det är en flyttal som representerar en procentandel av sidanWidth.
height	height	True	float	Höjden på rutan baserat på siddimensioner, ungefär som x- och y-koordinaterna. Det är en flyttal som representerar en procentandel av sidanHeight.
id	id	True	string	Ett unikt ID för den här rutan som genereras på vilket sätt du vill.
label	label		string	Platshållartext, till exempel namnet på fältet, t.ex. "Födelsedatum".
värde	value		string	Standardvärde för rutan. Kan vara null. Om rutan är av typen "chooseBox" kan värdet vara null eller en av de strängar som definierats i alternativen.
readonly	readonly		boolean	Om värdet är true kan den inbjudna personen inte ändra värdet för den här rutan.
required	required		boolean	Om värdet är true kan den inbjudna personen inte signera dokumentet utan att fylla i den här rutan.
type	type	True	string
flera ledningar	multiline		boolean	Om flera rader tillåts.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Varje radioruta kan tilldelas till en grupp.
signatureTypes	signatureTypes		array of string	De typer av signaturer som tillåts för den här mottagaren kan skrivas över av mottagarsignaturtyper. Alternativ: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	RefId är ett valfritt fält som används för att korsreferensera det uppladdade dokumentet. Om det tillhandahålls kan du tilldela en anpassad referensidentifierare till dokumentet, som returneras som en del av dokumentobjektet i framtida API-svar. Detta kan vara användbart för att spåra eller organisera dokument efter ett externt system eller arbetsflöde.
language	language		string	Dokumentspråket.
folderId	folderId		string	ID för en mapp där dokumenten ska infogas. Detta är bara möjligt när både inviteData och folderName är odefinierade.
isAttachment	isAttachment		boolean	isAttachment behövs inte i det här fallet.
useFastlane	useFastlane		boolean	Om värdet är `true` inställt på undertecknaren får du en Fastlane-länk i e-postmeddelandet för inbjudan.
fastlaneProfileId	fastlaneProfileId		uuid	Ange den Fastlane-profil som ska användas med det här dokumentet. (useFastlane måste vara inställt på true).

Returer

Body: EnvelopeResponse

Ta bort dokument

Åtgärds-ID:: DeleteDocument

Tar bort ett dokument eller tar bort en medlems åtkomst till det, beroende på om den angivna memberId tillhör avsändaren eller en mottagare och om dokumentet ingår i ett kuvert.

Dokument i ett kuvert

Frågeparametern all har ingen effekt för dokument i ett kuvert.

Med avsändaren memberId:

Ett enda dokument tas bort för avsändaren och alla mottagare.
Dokumentet tas bort från kuvertet.

Med mottagaren memberId:

Alla dokument i kuvertet tas bort för mottagaren.
Mottagaren markeras som declined på alla dokument som har tagits bort för mottagaren.
Dokumenten är fortfarande tillgängliga för alla andra medlemmar i dokumentet.

Enkla dokument

Med avsändaren memberId och all=true:

Dokumentet tas bort för avsändaren och alla mottagare.

Med avsändaren memberId och all=false:

Dokumentet tas bara bort för avsändaren.
Dokumentet förblir tillgängligt för de andra mottagarna i dokumentet.

Med mottagaren memberId:

Mottagaren markeras som declined i dokumentet.
Dokumentet är fortfarande tillgängligt för alla andra medlemmar i dokumentet.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Medlems-ID	memberId	True	string	Medlems-ID
Ta bort för alla mottagare	all		boolean	Endast relevant för enskilda dokument när den angivna `memberId` tillhör avsändaren. Om det är inställt på `true`tas dokumentet bort för avsändaren och alla mottagare. Om det är inställt på `false`tas dokumentet endast bort för avsändaren och förblir tillgängligt för de andra mottagarna. Den här parametern har ingen effekt för dokument i ett kuvert (standard = `true`) eller när den angivna `memberId` tillhör en mottagare.

Returer

response: DeleteDocumentResponse

Definitioner

DeleteDocumentResponse

Ta bort dokumentsvar: string

EnvelopeResponse

Name	Sökväg	Typ	Description
folderId	folderId	string
folderName	folderName	string
Dokument	documents	array of object
id	documents.id	string
name	documents.name	string
language	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Datum och tid när påminnelser börjar skickas (ISO 8601 datetime-sträng)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
createdAt	documents.createdAt	date-time	Datum och tid när dokumentet skapades (ISO 8601 datetime-sträng)
callbackUrl	documents.callbackUrl	string
returnUrl	documents.returnUrl	string
returnBtnText	documents.returnBtnText	string
inPersonSigning	documents.inPersonSigning	boolean
signingRound	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
dueDate (på engelska)	documents.dueDate	date-time	Förfallodatum för dokumentet (ISO 8601 datetime-sträng)
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
members	documents.members	array of MemberResponseSchema
medlem	documents.member	MemberResponseSchema
Lådor	documents.boxes	array of DocumentResponseBox	En formulärfältruta i dokumentsvaret. Detta returneras endast om dokumentet har formulärfält. Om dokumentet är signerat returnerar dokumentet rutor med de värden som har fyllts i.
förfallen	documents.overdue	boolean

DocumentResponseBox

Name	Sökväg	Typ	Description
id	id	string
type	type	string
värde	value	string	Värdet för fältrutan. Kan vara en sträng (inklusive tom sträng), boolesk eller null beroende på lådtyp.
label	label	string

MemberResponseSchema

Name	Sökväg	Typ	Description
id	id	string
documentId	documentId	string
email	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time	Datum och tid då medlemmen skapades (ISO 8601 datetime-sträng)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Datum och tid när borttagningsmeddelandet skickades (ISO 8601 datetime-sträng)
manuallyLastEmailSent	manuallyLastEmailSent	date-time	Datum och tid då det senaste manuella e-postmeddelandet skickades (ISO 8601 datetime-sträng)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Signaturpositionsdata med ytterligare svarsspecifika fält. Fälten cardStyle, pageWidth och pageHeight är valfria och kanske inte finns i alla API-svar.
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	Datum och tid då medlemmen avböjde (ISO 8601 datetime-sträng)
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
role	role	string
approvedAt	approvedAt	date-time	Datum och tid då medlemmen godkändes (ISO 8601 datetime-sträng)
verificationConfig	verificationConfig
phoneNumber	phoneNumber	string
Signaturer	signatures	array of string
signedAt	signedAt	date-time	Datum och tid då medlemmen signerade (ISO 8601 datetime-sträng)

MemberSignaturePositionResponse

Signaturpositionsdata med ytterligare svarsspecifika fält. Fälten cardStyle, pageWidth och pageHeight är valfria och kanske inte finns i alla API-svar.

Name	Sökväg	Typ	Description
Föremål		SignaturePositionResponse	Signaturpositionsdata med ytterligare svarsspecifika fält. Fälten cardStyle, pageWidth och pageHeight är valfria och kanske inte finns i alla API-svar.

SignaturePositionResponse

Signaturpositionsdata med ytterligare svarsspecifika fält. Fälten cardStyle, pageWidth och pageHeight är valfria och kanske inte finns i alla API-svar.

Name	Sökväg	Typ	Description
sida	page	integer	Sidnummer, från och med 0.
x	x	number	x koordinat för signaturernas övre vänstra position
y	y	number	y koordinat för signaturernas övre vänstra position
width	width	number	Signaturens bredd.
height	height	number	Namnteckningens höjd.
cardStyle	cardStyle	string	Det visuella formatet för signaturkortet. Det här fältet är valfritt och kan inte returneras i alla svar.
pageWidth	pageWidth	number	Bredden på sidan i bildpunkter. Det här fältet är valfritt och kan inte returneras i alla svar.
pageHeight	pageHeight	number	Höjden på sidan i bildpunkter. Det här fältet är valfritt och kan inte returneras i alla svar.

DocumentStatusForFlow

Name	Sökväg	Typ	Description
id	id	string
name	name	string
state	state	string	Dokumentets aktuella tillstånd. Möjliga värden är: utkast, väntande, avvisade, slutförda, bifogade filer, manuellt väntande, manuelltCompleted
createdAt	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean