sproof-teken (preview)

Gebruik sproof Sign om veilige werkstromen voor elektronische handtekeningen voor PDF- en DOCX-documenten te automatiseren. Organisaties kunnen handtekeningaanvragen voor één of meerdere documenten maken, ontvangers en ondertekeningsrollen toewijzen, status bijhouden, voltooide PDF-bestanden downloaden en documenten verwijderen. Een sproof sign-account, een plan dat ondersteuning biedt voor de geselecteerde acties en handtekeningtypen en een geldig API-token zijn vereist.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst	Class	Regions
Copilot Studio	Premium	Alle Power Automate regio's behalve:      - Amerikaanse overheid (GCC)      - Amerikaanse overheid (GCC High)      - China Cloud beheerd door 21Vianet      - Us Department of Defense (DoD)
Logic-apps	Standard	Alle Logic Apps-regio's , met uitzondering van het volgende:      - Azure Government-regio's      - Azure China-regio's      - Us Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps regio's behalve:      - Amerikaanse overheid (GCC)      - Amerikaanse overheid (GCC High)      - China Cloud beheerd door 21Vianet      - Us Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate regio's behalve:      - Amerikaanse overheid (GCC)      - Amerikaanse overheid (GCC High)      - China Cloud beheerd door 21Vianet      - Us Department of Defense (DoD)

Contactpersoon
Naam	API-ondersteuning
URL	https://sproof.com
E-mailadres	support@sproof.com

Connectormetagegevens
Publisher	sproof GmbH
Website	https://www.sproof.com/en/sign/
Privacybeleid	https://www.sproof.com/en/privacy-policy-app/
Categorieën	Productiviteit; Inhoud en bestanden

sproof teken

Overview

Met sproof Sign kunnen organisaties elektronische handtekeningwerkstromen voor PDF- en DOCX-documenten automatiseren. De connector kan handtekeningaanvragen met één document of enveloppen met meerdere documenten maken, ontvangers en ondertekeningsrollen toewijzen, de aanvraagstatus ophalen, voltooide documenten downloaden en documenten verwijderen.

Prerequisites

Als u de connector wilt gebruiken, hebt u het volgende nodig:

• Een sproof Sign-account.
• Een sproof Sign-plan met API-toegang en ondersteuning voor de vereiste acties en handtekeningtypen.
• Een geldig sproof Sign API-token.

Authentication

De connector maakt gebruik van API-tokenverificatie. Maak een verbinding door een geldig sproof Sign API-token in te voeren dat is gekoppeld aan uw account. Houd het token veilig en vervang het als het wordt ingetrokken of opnieuw wordt gegenereerd.

Ondersteunde acties

• Een handtekeningaanvraag maken : hiermee maakt u een aanvraag voor één document of een envelop met meerdere documenten. Ontvangers, ondertekeningsrollen, ondertekeningsvolgorde, handtekeningposities en andere uitnodigingsinstellingen kunnen worden geconfigureerd.
• Een handtekeningaanvraag maken met behulp van tijdelijke aanduidingen : hiermee maakt u een aanvraag met behulp van tijdelijke aanduidingen die zijn opgeslagen in een geüpload document. Informatie en handtekeningposities van geadresseerden worden geëxtraheerd uit deze tijdelijke aanduidingen.
• Aanvraagstatus ophalen : haalt de huidige status en ondertekeningsstatus van een handtekeningaanvraag op met behulp van de lid-id.
• Document ophalen : downloadt een document als een binair PDF-bestand of als een met Base64 gecodeerd PDF-bestand.
• Document verwijderen : hiermee verwijdert u een document of verwijdert u de toegang van een lid, afhankelijk van de opgegeven lid-id, de rol van het lid en of het document deel uitmaakt van een envelop.

Bekende beperkingen en vereisten

• Invoerdocumenten moeten worden opgegeven als PDF- of DOCX-inhoud met Base64-codering.
• Een envelop kan maximaal 25 documenten bevatten.
• Er is een envelopnaam vereist wanneer er meer dan één document wordt verzonden.
• Tijdelijke aanvragen op basis van tijdelijke aanduidingen vereisen correct opgemaakte tijdelijke aanduidingen in het geüploade document.
• Voor aanvragen op basis van tijdelijke aanduidingen worden geadresseerden en handtekeningposities verkregen uit het document in plaats van handmatig in te voeren.
• Beschikbare acties, handtekeningtypen en providers zijn afhankelijk van het verbonden sproof Sign-account en -plan.
• Gedrag bij het verwijderen van documenten is afhankelijk van of de opgegeven lid-id deel uitmaakt van de afzender of geadresseerde en of het document deel uitmaakt van een envelop.

Support

Neem voor connector- of API-ondersteuning contact op met support@sproof.com.

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:

standaard	Parameters voor het maken van verbinding.	Alle regio's	Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam	Type	Description	Required
token	beveiligde string	"token" für diese-API	True

Acties

Aanvraagstatus ophalen	De status van een handtekeningaanvraag ophalen. Retourneert een JSON-documentobject of een fout. De parameter wordt geretourneerd door de postaanvraag op het document en is gekoppeld aan het e-mailadres van de afzender.
Document ophalen	Ondertekend document ophalen als binaire of Base64-gecodeerde tekenreeks.
Document verwijderen	Hiermee verwijdert u een document of verwijdert u de toegang van een lid tot het document, afhankelijk van of de opgegeven memberId deel uitmaakt van de afzender of geadresseerde en of het document deel uitmaakt van een envelop. Documenten in een envelop De queryparameter all heeft geen effect voor documenten in een envelop. Met de afzender memberId: Eén document wordt verwijderd voor de afzender en alle geadresseerden. Het document wordt verwijderd uit de envelop. Met de ontvanger memberId: Alle documenten in de envelop worden verwijderd voor de geadresseerde. De geadresseerde wordt gemarkeerd als declined voor alle documenten die zijn verwijderd voor de geadresseerde. De documenten blijven beschikbaar voor alle andere leden in het document. Eén document Met de afzender memberId en all=true: Het document wordt verwijderd voor de afzender en alle geadresseerden. Met de afzender memberId en all=false: Het document wordt alleen verwijderd voor de afzender. Het document blijft beschikbaar voor de andere geadresseerden in het document. Met de ontvanger memberId: De geadresseerde wordt gemarkeerd als declined in het document. Het document blijft beschikbaar voor alle andere leden in het document.
Handtekeningaanvraag maken	Dit is de nieuwe aanvraag voor het maken van handtekeningen. Naast het maken van één documentuitnodiging ondersteunt het nu het maken van enveloppen en het uploaden van meerdere documenten tegelijk bij het verzenden van uitnodigingen.
Handtekeningaanvraag maken met behulp van tijdelijke aanduidingen	Hiermee maakt u een handtekeningaanvraag met behulp van tijdelijke aanduidingen die zijn opgeslagen in het geüploade document. Geadresseerden en handtekeningposities worden uit het document geëxtraheerd.

Aanvraagstatus ophalen

Bewerkings-id:

GetSignatureStatus

De status van een handtekeningaanvraag ophalen. Retourneert een JSON-documentobject of een fout. De parameter wordt geretourneerd door de postaanvraag op het document en is gekoppeld aan het e-mailadres van de afzender.

Parameters

Name	Sleutel	Vereist	Type	Description
Lid-id	memberId	True	string	Lid-id

Retouren

Body

DocumentStatusForFlow

Document ophalen

Bewerkings-id:

GetDocument

Ondertekend document ophalen als binaire of Base64-gecodeerde tekenreeks.

Parameters

Name	Sleutel	Vereist	Type	Description
Lid-id	memberId	True	string	Lid-id
Downloadindeling	format		string	Hiermee geeft u de antwoordindeling op. Gebruik pdf dit bestand voor binaire PDF en base64 voor een met Base64 gecodeerd antwoord. Voorbeeldantwoord base64 : json { "base64": "JVBERi0xLjQKJe..." }

Retouren

Name	Pad	Type	Description
base64	base64	string	Met Base64 gecodeerde PDF-inhoud

Document verwijderen

Bewerkings-id:

DeleteDocument

Hiermee verwijdert u een document of verwijdert u de toegang van een lid tot het document, afhankelijk van of de opgegeven memberId deel uitmaakt van de afzender of geadresseerde en of het document deel uitmaakt van een envelop.

Documenten in een envelop

De queryparameter all heeft geen effect voor documenten in een envelop.

Met de afzender memberId:

• Eén document wordt verwijderd voor de afzender en alle geadresseerden.
• Het document wordt verwijderd uit de envelop.

Met de ontvanger memberId:

• Alle documenten in de envelop worden verwijderd voor de geadresseerde.
• De geadresseerde wordt gemarkeerd als declined voor alle documenten die zijn verwijderd voor de geadresseerde.
• De documenten blijven beschikbaar voor alle andere leden in het document.

Eén document

Met de afzender memberId en all=true:

• Het document wordt verwijderd voor de afzender en alle geadresseerden.

Met de afzender memberId en all=false:

• Het document wordt alleen verwijderd voor de afzender.
• Het document blijft beschikbaar voor de andere geadresseerden in het document.

Met de ontvanger memberId:

• De geadresseerde wordt gemarkeerd als declined in het document.
• Het document blijft beschikbaar voor alle andere leden in het document.

Parameters

Name	Sleutel	Vereist	Type	Description
Lid-id	memberId	True	string	Lid-id
Verwijderen voor alle geadresseerden	all		boolean	Alleen relevant voor één document wanneer de opgegeven memberId afzender behoort. Als dit is ingesteld true, wordt het document verwijderd voor de afzender en alle geadresseerden. Als dit is ingesteld false, wordt het document alleen verwijderd voor de afzender en blijft het beschikbaar voor de andere geadresseerden. Deze parameter heeft geen effect voor documenten in een envelop (standaard = true) of wanneer de opgegeven memberId waarde deel uitmaakt van een geadresseerde.

Retouren

response

DeleteDocumentResponse

Handtekeningaanvraag maken

Bewerkings-id:

CreateSignatureRequest

Dit is de nieuwe aanvraag voor het maken van handtekeningen. Naast het maken van één documentuitnodiging ondersteunt het nu het maken van enveloppen en het uploaden van meerdere documenten tegelijk bij het verzenden van uitnodigingen.

Parameters

Name	Sleutel	Vereist	Type	Description
e-mailadres	email	True	string	E-mail van de afzender. Het moet deel uitmaken van een lid van uw plan.
firstName	firstName	True	string	Voornaam van de afzender.
lastName	lastName		string	Achternaam van de afzender.
role	role		string	De rol van de afzender voor alle documenten.
e-mailadres	email		string	E-mail van de geadresseerde.
firstName	firstName		string	Voornaam van de ontvanger.
lastName	lastName		string	Achternaam van de geadresseerde.
doNotSendEmails	doNotSendEmails		boolean	Als dit is ingesteld op true geen e-mail, wordt er naar de geadresseerde verzonden.
customId	customId		string	Dit kan alleen worden gebruikt wanneer het e-mailadres van de geadresseerde onbekend is op het moment van uitnodigen. Dit werkt alleen wanneer u de geadresseerden uitnodigt (niet voor het voorbereiden van routes) en u fastlane wilt gebruiken. Hiermee customId kunt u vooraf een unieke ondertekeningskoppeling voor een geadresseerde genereren voordat u een uitnodiging verzendt. Moet een unieke alfanumerieke tekenreeks van ten minste 70 tekens zijn. Opmerking: de customId kan alleen worden gebruikt om de koppeling van de geadresseerde naar een document te maken. Het kan niet worden gebruikt voor andere aanvragen in plaats van de memberId. Zie Een document openen met een aangepaste id voor meer informatie over url-constructie
useFastlane	useFastlane		boolean	Als deze optie is ingesteld op true de ondertekenaar, ontvangt u een Fastlane-koppeling in de uitnodigingsmail.
phoneNumber	phoneNumber		string	Het telefoonnummer van deze geadresseerde. Dit wordt gebruikt voor sms-verificatie. (bijvoorbeeld: +43 699 1234 1234).
privateMessage	privateMessage		string	Een privébericht voor deze specifieke geadresseerde.
inPersonMode	inPersonMode		boolean	Wanneer deze optie is ingeschakeld, moet de ontvanger van de handtekeningaanvraag het document persoonlijk ondertekenen en wordt er geen e-mail verzonden. Deze modus is alleen beschikbaar met het SES-handtekeningtype
signatureTypes	signatureTypes		array of string	De typen handtekeningen die zijn toegestaan voor deze geadresseerde. Opties: ['geavanceerd', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Deze tag bepaalt de id-provider die wordt gebruikt voor het ondertekeningsproces. Kies uit een vooraf gedefinieerde set ondersteunde providers. Opmerking1: Sommige providers zijn alleen beschikbaar voor bepaalde signatureTypes, bijvoorbeeld onetimeqes vereist "signatureType" : ["qualifiedPlusIdent"] Opmerking2: Bij gebruik sproof-qualified als standaardprovider moet de ontvanger een actief sproof-account hebben met een actieve User+-licentie.
canChange	canChange		boolean	Booleaanse waarde die aangeeft of de uitgenodigde ontvanger de handtekeningprovider moet kunnen wijzigen
country	country		string	Als het standaardland leeg is ingesteld op alles, wordt er een fout geretourneerd met de landen die beschikbaar zijn voor de providertag die is gekozen
vervaldatum	dueDate		YYYY-MM-DD	De datum totdat het document kan worden ondertekend. Deze einddatum wordt weergegeven aan de geadresseerde in de uitnodigings-e-mail en is ook zichtbaar in de sectie met documentdetails van het dashboard. Het dient als deadline voor het voltooien van het ondertekeningsproces.
reminderInterval	reminderInterval		number	Hiermee geeft u het aantal dagen tussen herinnerings-e-mailberichten.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum van waaruit herinneringen moeten worden verzonden
inviteLanguage	inviteLanguage		string	Hiermee geeft u de taal op van de e-mailberichten die worden verzonden naar anonieme gebruikers die geen account hebben. Voor gebruikers met een account wordt in plaats daarvan de taal gebruikt die ze in hun profiel hebben geselecteerd.
message	message		string	Een aangepast bericht dat naar de geadresseerden in het e-mailbericht wordt verzonden.
subject	subject		string	De onderwerpregel van het e-mailbericht dat naar de geadresseerden is verzonden.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Als dit is ingesteld op true, wordt het PDF-bestand als bijlage verzonden naar alle geadresseerden in het document (als het kleiner is dan 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Wanneer deze optie is ingeschakeld, is de ontvanger van de handtekeningaanvraag beperkt tot het ondertekenen of weigeren van het document en kan de ontvanger niet van de pagina navigeren.
allowForwarding	allowForwarding		boolean	Doorsturen van de uitnodiging toestaan.
collabSigningMode	collabSigningMode		object	Een object waarin elke sleutel een ondertekeningsronde vertegenwoordigt en de bijbehorende waarde geeft aan of gezamenlijke ondertekening is ingeschakeld voor die ronde. Als de waarde waar is, is slechts één handtekening vereist om de opgegeven ondertekeningsronde te voltooien en door te gaan naar de volgende ronde. { '1': true } betekent bijvoorbeeld dat bij ondertekeningsronde '1' slechts één handtekening nodig is.
usePlaceholders	usePlaceholders		boolean	Indien waar, worden tijdelijke aanduidingen/formFields die zijn opgeslagen in het document, gebruikt voor het uitnodigen van geadresseerden.
inPersonSigning	inPersonSigning		boolean	Wanneer waar, krijgt de geadresseerde een pop-up waarin hij handmatig een handtekening moet tekenen
folderName	folderName		string	Indien gegeven, wordt er een envelop gemaakt met alle documenten in documentDataArray. (Vereist als er meer dan één document wordt verzonden)
callbackUrl	callbackUrl		string	Een POST-aanvraag, inclusief het document, wordt naar deze URL verzonden wanneer er een nieuwe handtekening wordt gemaakt of wanneer een geadresseerde het document weigert. In het geval van een fout is er een mechanisme voor opnieuw proberen om ervoor te zorgen dat de aanvraag opnieuw wordt geprobeerd.
returnUrl	returnUrl		string	De koppeling van de retourknop na ondertekening van een document
returnBtnText	returnBtnText		string	De tekst van de knop Return na ondertekening van een document
Gegevens	data	True	string	De documentgegevens (PDF of DOCX) in base64-indeling.
mimetype	mimetype		string	MIME-type base64 gecodeerde gegevens PDF of DOCX, vereist als het document geen PDF is
bestandsnaam	fileName	True	string	Naam van het bestand
label	label		string	Een aangepast label dat kan worden verzonden om documenten te ordenen.
bladzijde	page	True	integer	Het nummer van de pagina waarop het vak staat, waarbij de eerste pagina 0 is.
Pagewidth	pageWidth		integer	Een geheel getal dat de paginabreedte beschrijft. Hoe groter het getal, hoe beter de precisie bij het plaatsen van het vak in x y-ruimte. Op een A4-pagina hebben we 478 als standaardwaarde.
Pageheight	pageHeight		integer	Een geheel getal dat de paginahoogte beschrijft. Hoe groter het getal, hoe beter de precisie bij het plaatsen van het vak in x y-ruimte. Op een A4-pagina hebben we 676 als standaardwaarde.
x	x	True	float	Vertegenwoordigt de horizontale positie van het vak als een percentage van de paginabreedte. De oorsprong (0,0) bevindt zich linksboven op de pagina. Een waarde van 0,1 betekent dat het vak is geplaatst op 10% van de paginabreedte van links.
y	y	True	float	Vertegenwoordigt de verticale positie van het vak als een percentage van de paginahoogte. De oorsprong (0,0) bevindt zich linksboven op de pagina. Een waarde van 0,1 betekent dat het vak is geplaatst op 10% van de paginahoogte vanaf de bovenkant.
width	width	True	float	Breedte van het vak op basis van paginadimensies, vergelijkbaar met de x- en y-coördinaten. Het is een float die een percentage van de pageWidth vertegenwoordigt.
height	height	True	float	Hoogte van het vak op basis van paginadimensies, vergelijkbaar met de x- en y-coördinaten. Het is een float die een percentage van de pageHeight vertegenwoordigt.
id	id	True	string	Een unieke id voor dit vak, gegenereerd op elke gewenste manier.
label	label		string	Tijdelijke tekst, zoals de naam van het veld, bijvoorbeeld 'Geboortedatum'.
value	value		string	Standaardwaarde voor het vak. Kan null zijn. Als het vak van het type ChooseBox is, kan de waarde null zijn of een van de tekenreeksen die in de opties zijn gedefinieerd.
alleen lezen	readonly		boolean	Als deze optie is ingesteld op true, kan de uitgenodigde persoon de waarde van dit vak niet wijzigen.
required	required		boolean	Als dit is ingesteld op true, kan de uitgenodigde persoon het document niet ondertekenen zonder dit vak in te vullen.
type	type	True	string
meerdere regels	multiline		boolean	Of meerdere regels zijn toegestaan.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Elk keuzerondje kan aan een groep worden toegewezen.
signatureTypes	signatureTypes		array of string	De typen handtekeningen die zijn toegestaan voor deze geadresseerde, kunnen worden overschreven door handtekeningtypen van geadresseerden. Opties: ['geavanceerd', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	De refId is een optioneel veld dat wordt gebruikt om kruisverwijzingen te maken naar het geüploade document. Indien opgegeven, kunt u een aangepaste verwijzings-id toewijzen aan het document, dat wordt geretourneerd als onderdeel van het documentobject in toekomstige API-antwoorden. Dit kan handig zijn voor het bijhouden of ordenen van documenten door een extern systeem of een externe werkstroom.
language	language		string	De documenttaal.
folderId	folderId		string	De id van een map waarin de documenten moeten worden ingevoegd. Dit is alleen mogelijk wanneer zowel inviteData als folderName niet zijn gedefinieerd.
isAttachment	isAttachment		boolean	isAttachment niet nodig in dit geval.
Details van geadresseerde	recipientDetails	True	object	Details van geadresseerden die zijn sleutel voor e-mail van geadresseerde. Voorbeeld: {"mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}}.
useFastlane	useFastlane		boolean	Als deze optie is ingesteld op true de ondertekenaar, ontvangt u een Fastlane-koppeling in de uitnodigingsmail.
fastlaneProfileId	fastlaneProfileId		uuid	Geef het Fastlane-profiel op dat met dit document moet worden gebruikt. (useFastlane moet zijn ingesteld op true).

Retouren

Body

EnvelopeResponse

Handtekeningaanvraag maken met behulp van tijdelijke aanduidingen

Bewerkings-id:

CreateSignatureRequestUsingPlaceholders

Hiermee maakt u een handtekeningaanvraag met behulp van tijdelijke aanduidingen die zijn opgeslagen in het geüploade document. Geadresseerden en handtekeningposities worden uit het document geëxtraheerd.

Parameters

Name	Sleutel	Vereist	Type	Description
e-mailadres	email	True	string	E-mail van de afzender. Het moet deel uitmaken van een lid van uw plan.
firstName	firstName	True	string	Voornaam van de afzender.
lastName	lastName		string	Achternaam van de afzender.
role	role		string	De rol van de afzender voor alle documenten.
e-mailadres	email		string	E-mail van de geadresseerde.
firstName	firstName		string	Voornaam van de ontvanger.
lastName	lastName		string	Achternaam van de geadresseerde.
doNotSendEmails	doNotSendEmails		boolean	Als dit is ingesteld op true geen e-mail, wordt er naar de geadresseerde verzonden.
customId	customId		string	Dit kan alleen worden gebruikt wanneer het e-mailadres van de geadresseerde onbekend is op het moment van uitnodigen. Dit werkt alleen wanneer u de geadresseerden uitnodigt (niet voor het voorbereiden van routes) en u fastlane wilt gebruiken. Hiermee customId kunt u vooraf een unieke ondertekeningskoppeling voor een geadresseerde genereren voordat u een uitnodiging verzendt. Moet een unieke alfanumerieke tekenreeks van ten minste 70 tekens zijn. Opmerking: de customId kan alleen worden gebruikt om de koppeling van de geadresseerde naar een document te maken. Het kan niet worden gebruikt voor andere aanvragen in plaats van de memberId. Zie Een document openen met een aangepaste id voor meer informatie over url-constructie
useFastlane	useFastlane		boolean	Als deze optie is ingesteld op true de ondertekenaar, ontvangt u een Fastlane-koppeling in de uitnodigingsmail.
phoneNumber	phoneNumber		string	Het telefoonnummer van deze geadresseerde. Dit wordt gebruikt voor sms-verificatie. (bijvoorbeeld: +43 699 1234 1234).
privateMessage	privateMessage		string	Een privébericht voor deze specifieke geadresseerde.
inPersonMode	inPersonMode		boolean	Wanneer deze optie is ingeschakeld, moet de ontvanger van de handtekeningaanvraag het document persoonlijk ondertekenen en wordt er geen e-mail verzonden. Deze modus is alleen beschikbaar met het SES-handtekeningtype
signatureTypes	signatureTypes		array of string	De typen handtekeningen die zijn toegestaan voor deze geadresseerde. Opties: ['geavanceerd', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple']
tag	tag		string	Deze tag bepaalt de id-provider die wordt gebruikt voor het ondertekeningsproces. Kies uit een vooraf gedefinieerde set ondersteunde providers. Opmerking1: Sommige providers zijn alleen beschikbaar voor bepaalde signatureTypes, bijvoorbeeld onetimeqes vereist "signatureType" : ["qualifiedPlusIdent"] Opmerking2: Bij gebruik sproof-qualified als standaardprovider moet de ontvanger een actief sproof-account hebben met een actieve User+-licentie.
canChange	canChange		boolean	Booleaanse waarde die aangeeft of de uitgenodigde ontvanger de handtekeningprovider moet kunnen wijzigen
country	country		string	Als het standaardland leeg is ingesteld op alles, wordt er een fout geretourneerd met de landen die beschikbaar zijn voor de providertag die is gekozen
vervaldatum	dueDate		YYYY-MM-DD	De datum totdat het document kan worden ondertekend. Deze einddatum wordt weergegeven aan de geadresseerde in de uitnodigings-e-mail en is ook zichtbaar in de sectie met documentdetails van het dashboard. Het dient als deadline voor het voltooien van het ondertekeningsproces.
reminderInterval	reminderInterval		number	Hiermee geeft u het aantal dagen tussen herinnerings-e-mailberichten.
startSendingReminders	startSendingReminders		YYYY-MM-DD HH:MM	Datum van waaruit herinneringen moeten worden verzonden
inviteLanguage	inviteLanguage		string	Hiermee geeft u de taal op van de e-mailberichten die worden verzonden naar anonieme gebruikers die geen account hebben. Voor gebruikers met een account wordt in plaats daarvan de taal gebruikt die ze in hun profiel hebben geselecteerd.
message	message		string	Een aangepast bericht dat naar de geadresseerden in het e-mailbericht wordt verzonden.
subject	subject		string	De onderwerpregel van het e-mailbericht dat naar de geadresseerden is verzonden.
sendOutFinishedPdf	sendOutFinishedPdf		boolean	Als dit is ingesteld op true, wordt het PDF-bestand als bijlage verzonden naar alle geadresseerden in het document (als het kleiner is dan 5 MB).
focusedSigningMode	focusedSigningMode		boolean	Wanneer deze optie is ingeschakeld, is de ontvanger van de handtekeningaanvraag beperkt tot het ondertekenen of weigeren van het document en kan de ontvanger niet van de pagina navigeren.
allowForwarding	allowForwarding		boolean	Doorsturen van de uitnodiging toestaan.
collabSigningMode	collabSigningMode		object	Een object waarin elke sleutel een ondertekeningsronde vertegenwoordigt en de bijbehorende waarde geeft aan of gezamenlijke ondertekening is ingeschakeld voor die ronde. Als de waarde waar is, is slechts één handtekening vereist om de opgegeven ondertekeningsronde te voltooien en door te gaan naar de volgende ronde. { '1': true } betekent bijvoorbeeld dat bij ondertekeningsronde '1' slechts één handtekening nodig is.
inPersonSigning	inPersonSigning		boolean	Wanneer waar, krijgt de geadresseerde een pop-up waarin hij handmatig een handtekening moet tekenen
folderName	folderName		string	Indien gegeven, wordt er een envelop gemaakt met alle documenten in documentDataArray. (Vereist als er meer dan één document wordt verzonden)
callbackUrl	callbackUrl		string	Een POST-aanvraag, inclusief het document, wordt naar deze URL verzonden wanneer er een nieuwe handtekening wordt gemaakt of wanneer een geadresseerde het document weigert. In het geval van een fout is er een mechanisme voor opnieuw proberen om ervoor te zorgen dat de aanvraag opnieuw wordt geprobeerd.
returnUrl	returnUrl		string	De koppeling van de retourknop na ondertekening van een document
returnBtnText	returnBtnText		string	De tekst van de knop Return na ondertekening van een document
Gegevens	data	True	string	De documentgegevens (PDF of DOCX) in base64-indeling.
mimetype	mimetype		string	MIME-type base64 gecodeerde gegevens PDF of DOCX, vereist als het document geen PDF is
bestandsnaam	fileName	True	string	Naam van het bestand
label	label		string	Een aangepast label dat kan worden verzonden om documenten te ordenen.
bladzijde	page	True	integer	Het nummer van de pagina waarop het vak staat, waarbij de eerste pagina 0 is.
Pagewidth	pageWidth		integer	Een geheel getal dat de paginabreedte beschrijft. Hoe groter het getal, hoe beter de precisie bij het plaatsen van het vak in x y-ruimte. Op een A4-pagina hebben we 478 als standaardwaarde.
Pageheight	pageHeight		integer	Een geheel getal dat de paginahoogte beschrijft. Hoe groter het getal, hoe beter de precisie bij het plaatsen van het vak in x y-ruimte. Op een A4-pagina hebben we 676 als standaardwaarde.
x	x	True	float	Vertegenwoordigt de horizontale positie van het vak als een percentage van de paginabreedte. De oorsprong (0,0) bevindt zich linksboven op de pagina. Een waarde van 0,1 betekent dat het vak is geplaatst op 10% van de paginabreedte van links.
y	y	True	float	Vertegenwoordigt de verticale positie van het vak als een percentage van de paginahoogte. De oorsprong (0,0) bevindt zich linksboven op de pagina. Een waarde van 0,1 betekent dat het vak is geplaatst op 10% van de paginahoogte vanaf de bovenkant.
width	width	True	float	Breedte van het vak op basis van paginadimensies, vergelijkbaar met de x- en y-coördinaten. Het is een float die een percentage van de pageWidth vertegenwoordigt.
height	height	True	float	Hoogte van het vak op basis van paginadimensies, vergelijkbaar met de x- en y-coördinaten. Het is een float die een percentage van de pageHeight vertegenwoordigt.
id	id	True	string	Een unieke id voor dit vak, gegenereerd op elke gewenste manier.
label	label		string	Tijdelijke tekst, zoals de naam van het veld, bijvoorbeeld 'Geboortedatum'.
value	value		string	Standaardwaarde voor het vak. Kan null zijn. Als het vak van het type ChooseBox is, kan de waarde null zijn of een van de tekenreeksen die in de opties zijn gedefinieerd.
alleen lezen	readonly		boolean	Als deze optie is ingesteld op true, kan de uitgenodigde persoon de waarde van dit vak niet wijzigen.
required	required		boolean	Als dit is ingesteld op waar, kan de uitgenodigde persoon het document niet ondertekenen zonder dit vak in te vullen.
type	type	True	string
meerdere regels	multiline		boolean	Of meerdere regels zijn toegestaan.
displayValue	displayValue	True	string
exportValue	exportValue	True	string
group	group		number	Elk keuzerondje kan aan een groep worden toegewezen.
signatureTypes	signatureTypes		array of string	De typen handtekeningen die zijn toegestaan voor deze geadresseerde, kunnen worden overschreven door handtekeningtypen van geadresseerden. Opties: ['geavanceerd', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
refId	refId		string	De refId is een optioneel veld dat wordt gebruikt om kruisverwijzingen te maken naar het geüploade document. Indien opgegeven, kunt u een aangepaste verwijzings-id toewijzen aan het document, dat wordt geretourneerd als onderdeel van het documentobject in toekomstige API-antwoorden. Dit kan handig zijn voor het bijhouden of ordenen van documenten door een extern systeem of een externe werkstroom.
language	language		string	De documenttaal.
folderId	folderId		string	De id van een map waarin de documenten moeten worden ingevoegd. Dit is alleen mogelijk wanneer zowel inviteData als folderName niet zijn gedefinieerd.
isAttachment	isAttachment		boolean	isAttachment niet nodig in dit geval.
useFastlane	useFastlane		boolean	Als deze optie is ingesteld op true de ondertekenaar, ontvangt u een Fastlane-koppeling in de uitnodigingsmail.
fastlaneProfileId	fastlaneProfileId		uuid	Geef het Fastlane-profiel op dat met dit document moet worden gebruikt. (useFastlane moet zijn ingesteld op true).

Retouren

Body

EnvelopeResponse

Definities

DeleteDocumentResponse

Documentantwoord verwijderen

string

EnvelopResponse

Name	Pad	Type	Description
folderId	folderId	string
folderName	folderName	string
Documenten	documents	array of object
id	documents.id	string
naam	documents.name	string
language	documents.language	string
startSendingReminders	documents.startSendingReminders	date-time	Datum en tijd waarop herinneringen worden verzonden (ISO 8601-tekenreeks voor datum/tijd)
sendReminder	documents.sendReminder	boolean
reminderSent	documents.reminderSent	boolean
reminderInterval	documents.reminderInterval	number
gemaaktOp	documents.createdAt	date-time	Datum en tijd waarop het document is gemaakt (ISO 8601-tekenreeks voor datum/tijd)
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
vervaldatum	documents.dueDate	date-time	Einddatum voor het document (ISO 8601-tekenreeks voor datum/tijd)
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
lid	documents.member	MemberResponseSchema
Vakken	documents.boxes	array of DocumentResponseBox	Een formulierveldvak in het antwoord op het document. Dit wordt alleen geretourneerd als het document formuliervelden bevat. Als het document is ondertekend, retourneert het document vakken met de waarden die zijn ingevuld.
achterstallig	documents.overdue	boolean

DocumentResponseBox

Name	Pad	Type	Description
id	id	string
type	type	string
value	value	string	De waarde van het vakveld. Kan een tekenreeks (inclusief lege tekenreeks), booleaanse waarde of null zijn, afhankelijk van het vaktype.
label	label	string

MemberResponseSchema

Name	Pad	Type	Description
id	id	string
documentId	documentId	string
e-mailadres	email	string
firstName	firstName	string
lastName	lastName	string
isAdmin	isAdmin	boolean
gemaaktOp	createdAt	date-time	Datum en tijd waarop het lid is gemaakt (ISO 8601-tekenreeks voor datum/tijd)
sentDeleteNotificationAt	sentDeleteNotificationAt	date-time	Datum en tijd waarop de melding voor verwijderen is verzonden (ISO 8601-tekenreeks voor datum/tijd)
handmatigLastEmailSent	manuallyLastEmailSent	date-time	Datum en tijd waarop de laatste handmatige e-mail is verzonden (ISO 8601-tekenreeks voor datum/tijd)
signaturePosition	signaturePosition	MemberSignaturePositionResponse	Positiegegevens voor handtekeningen met aanvullende antwoordspecifieke velden. De velden cardStyle, pageWidth en pageHeight zijn optioneel en zijn mogelijk niet aanwezig in alle API-antwoorden.
doNotSendEmails	doNotSendEmails	boolean
declinedAt	declinedAt	date-time	Datum en tijd waarop het lid heeft geweigerd (ISO 8601-tekenreeks voor datum/tijd)
ondertekeningsorder	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 en tijd waarop het lid is goedgekeurd (ISO 8601-tekenreeks voor datum/tijd)
verificatieConfig	verificationConfig
phoneNumber	phoneNumber	string
Handtekeningen	signatures	array of string
signedAt	signedAt	date-time	Datum en tijd waarop het lid is ondertekend (ISO 8601-tekenreeks voor datum/tijd)

MemberSignaturePositionResponse

Positiegegevens voor handtekeningen met aanvullende antwoordspecifieke velden. De velden cardStyle, pageWidth en pageHeight zijn optioneel en zijn mogelijk niet aanwezig in alle API-antwoorden.

Name	Pad	Type	Description
Artikelen		SignaturePositionResponse	Positiegegevens voor handtekeningen met aanvullende antwoordspecifieke velden. De velden cardStyle, pageWidth en pageHeight zijn optioneel en zijn mogelijk niet aanwezig in alle API-antwoorden.

SignaturePositionResponse

Positiegegevens voor handtekeningen met aanvullende antwoordspecifieke velden. De velden cardStyle, pageWidth en pageHeight zijn optioneel en zijn mogelijk niet aanwezig in alle API-antwoorden.

Name	Pad	Type	Description
bladzijde	page	integer	Paginanummer, beginnend met 0.
x	x	number	x coördinaat van de positie linksboven van de handtekeningen
y	y	number	y-coördinaat van de positie linksboven van de handtekeningen
width	width	number	Breedte van de handtekening.
height	height	number	Hoogte van de handtekening.
cardStyle	cardStyle	string	De visuele stijl van de handtekeningkaart. Dit veld is optioneel en wordt mogelijk niet geretourneerd in alle antwoorden.
Pagewidth	pageWidth	number	De breedte van de pagina in pixels. Dit veld is optioneel en wordt mogelijk niet geretourneerd in alle antwoorden.
Pageheight	pageHeight	number	De hoogte van de pagina in pixels. Dit veld is optioneel en wordt mogelijk niet geretourneerd in alle antwoorden.

DocumentStatusForFlow

Name	Pad	Type	Description
id	id	string
naam	name	string
state	state	string	De huidige status van het document. Mogelijke waarden zijn: concept, in behandeling, geweigerd, voltooid, bijlage, handmatigpending, handmatig aanvullen
gemaaktOp	createdAt	date
updatedAt	updatedAt	date
allSignersSigned	allSignersSigned	boolean
allMembersSigned	allMembersSigned	boolean
focusedSigningMode	focusedSigningMode	boolean