Foxit eSign (preview)

Foxit eSign is een elektronische handtekeningoplossing waarmee u documenten online kunt verzenden, ondertekenen en beheren, waardoor afdrukken, scannen of mailings niet meer nodig zijn. Upload uw document, definieer handtekeningvelden en verzend het naar geadresseerden voor snelle, juridisch bindende eSignatures.

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)

Contact
Naam	Foxit eSign-ondersteuning
URL	https://www.foxit.com
E-mailen	api@foxit.com

Connectormetagegevens
Publisher	Foxit Software Inc.
Website	https://www.foxit.com/esign-pdf/
Privacybeleid	https://www.foxit.com/company/privacy-policy.html
Categorieën	Productiviteit; Inhoud en bestanden

Foxit eSign

Foxit eSign is een zakelijke elektronische handtekeningoplossing waarmee bedrijven wettelijk bindende documenten volledig online kunnen verzenden, ondertekenen en beheren, waardoor afdrukken, scannen of mailings niet meer nodig zijn. Upload uw document, definieer handtekeningvelden en verzend het naar geadresseerden voor snelle, veilige eSignatures. Foxit eSign voldoet volledig aan de belangrijke wetgeving voor elektronische handtekeningen, waaronder ESIGN en UETA, gebruikt versleuteling om documenten in transit en at-rest te beveiligen en ondersteunt meervoudige verificatie om ervoor te zorgen dat alleen geautoriseerde ondertekenaars uw documenten kunnen openen en ondertekenen.

Met de Foxit eSign-connector voor Microsoft Power Automate kunt u uw volledige werkstroom voor documentondertekening automatiseren, van het maken van enveloppen en het verzenden van enveloppen, het bijhouden van de status, het downloaden van voltooide documenten, het beheren van sjablonen en het activeren van downstreamacties wanneer envelopgebeurtenissen plaatsvinden.

Publisher: Foxit Corporation

Prerequisites

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

Een Microsoft Power Apps- of Power Automate-abonnement met aangepaste connector- of Premium-connectortoegang
Een Foxit eSign-account - maak hier een account
API-toegang ingeschakeld voor uw Foxit eSign-account (zie Hieronder referenties verkrijgen)

Referenties verkrijgen

Maak een Foxit eSign-account als u er nog geen hebt.
Neem contact op met het Foxit Sales-team om API-toegang aan te vragen die voor uw account moet worden ingeschakeld. Zodra deze is goedgekeurd, wordt API-toegang geactiveerd voor uw account.
Zoek in Power Automate naar Foxit eSign in de lijst met connectors en selecteer Verbinding maken.
U wordt omgeleid naar de aanmeldingspagina van Foxit eSign. Meld u aan met uw Foxit eSign-referenties om de verbinding te autoriseren.
Zodra deze is geautoriseerd, is de verbinding gereed voor gebruik in uw stromen.

Getting Started

Nadat u een verbinding hebt gemaakt, kunt u stromen gaan bouwen met behulp van de Foxit eSign-connector:

Gebruik triggers om een stroom automatisch te starten wanneer een envelopgebeurtenis plaatsvindt (bijvoorbeeld wanneer alle partijen zijn ondertekend).
Gebruik acties om enveloppen te maken, handtekeningherinneringen te verzenden, voltooide documenten te downloaden, sjablonen te beheren en meer.
Koppel meerdere acties aan elkaar, maak bijvoorbeeld een envelop op basis van een sjabloon, wacht op de volledig uitgevoerde trigger, download het ondertekende document en sla het op in SharePoint.

Ondersteunde triggers

Trigger	Description
Wanneer een envelop wordt verzonden	Wordt geactiveerd wanneer een envelop naar geadresseerden wordt verzonden. Vereist dat webhookniveau is ingesteld op Account.
Wanneer een envelop wordt bekeken	Wordt geactiveerd wanneer een geadresseerde wordt geopend en de envelop weer geeft.
Wanneer een envelop is ondertekend	Wordt geactiveerd wanneer een geadresseerde de envelop ondertekent.
Wanneer een envelop wordt geannuleerd	Wordt geactiveerd wanneer een envelop wordt geannuleerd door een geadresseerde of de afzender.
Wanneer een envelop volledig wordt uitgevoerd	Wordt geactiveerd wanneer alle geadresseerden zijn ondertekend en de envelop volledig is voltooid.
Wanneer een envelop wordt verwijderd	Wordt geactiveerd wanneer een envelop wordt verwijderd.

Ondersteunde acties

Enveloppen

Action	Description
Envelop maken op url	Hiermee maakt en verzendt u een envelop met een openbaar toegankelijke PDF-URL.
Envelop maken op basis van Base64	Hiermee maakt en verzendt u een envelop met een PDF-document met Base64-codering.
Envelop maken op sjabloon	Hiermee maakt en verzendt u een envelop van een bestaande Foxit eSign-sjabloon.
Envelopdetails ophalen	Haalt de volledige details en de huidige status van een envelop op.
Envelop-id's ophalen	Hiermee wordt een lijst met envelop-id's opgehaald op basis van filtercriteria.
Herinnering voor handtekening verzenden	Hiermee wordt een herinneringsmelding verzonden naar in behandeling zijnde ondertekenaars van een envelop.
Envelopbestanden downloaden	Downloadt alle ondertekende documenten in een envelop als zip-bestand.
PDF met één document downloaden	Hiermee downloadt u één document van een envelop als PDF- bestand.
Enveloppen verplaatsen naar Prullenbak	Hiermee verplaatst u een of meer enveloppen naar de Prullenbak.
Envelop annuleren	Hiermee annuleert u een envelop en ontvangt u een bericht van geadresseerden.
Enveloppen verwijderen	Hiermee verwijdert u een of meer enveloppen definitief.
Geschiedenis van envelopactiviteit ophalen	Hiermee haalt u het volledige activiteitenlogboek voor een envelop op.
Verwijderde envelopgeschiedenis ophalen	Hiermee haalt u de geschiedenis van verwijderde enveloppen in het account op.

Sjablonen

Action	Description
Sjabloon maken op url	Hiermee maakt u een herbruikbare handtekeningsjabloon met een openbaar toegankelijke PDF-URL.
Sjabloon maken op basis van Base64	Hiermee maakt u een herbruikbare handtekeningsjabloon met behulp van een Pdf-document met Base64-codering.
Sjabloondetails ophalen	Hiermee haalt u de volledige details van een specifieke sjabloon op, inclusief velddefinities.
Sjablonen ophalen op sjabloon-id's	Hiermee worden details voor een of meer sjablonen opgehaald op basis van hun id's.
Een lijst met alle sjablonen ophalen	Hiermee haalt u alle sjablonen op die beschikbaar zijn in het account.

Webhooks

Action	Description
Alle webhookkanalen weergeven	Retourneert een lijst met alle webhookkanalen die zijn geconfigureerd in het account.
Details van webhookkanaal ophalen	Hiermee worden de details van een specifiek webhookkanaal opgehaald.

E-mailgroepen

Action	Description
E-mailgroep maken	Hiermee maakt u een nieuwe e-mailgroep voor gebruik als geadresseerden in enveloppen.
Details van e-mailgroep ophalen	Hiermee worden de details en leden van een e-mailgroep opgehaald.

Rapporten

Action	Description
Rapport downloaden	Hiermee downloadt u een accountactiviteitsrapport in Microsoft Excel indeling.

Bekende problemen en beperkingen

Frequentielimiet: Met de Foxit eSign-API kunnen maximaal 4.000 aanvragen per 5 minuten per account worden toegestaan. Aanvragen die deze limiet overschrijden, ontvangen een 429 Too Many Requests antwoord. Het wordt aanbevolen om logica voor opnieuw proberen te implementeren met exponentieel uitstel in uw stromen om dit probleemloos te verwerken.
Maximale bestandsgrootte: de maximale bestandsgrootte per document is 25 MB. Deze limiet is van toepassing op afzonderlijke bestanden, niet op het totale envelopformaat.
Webhook automatisch afmelden: vanwege een beperking in de Foxit eSign-webhookverwijderings-API (die gebruikmaakt van een POST-methode in plaats van DELETE), kunnen Power Automate geen webhookkanaalabonnementen automatisch opschonen wanneer een stroom op basis van triggers wordt verwijderd of gewijzigd. Gebruik de actie Alle webhookkanalen weergeven om actieve kanalen en de Foxit eSign-portal te identificeren om abonnementen te verwijderen bij het buiten gebruik stellen van een stroom.
Wanneer een envelop wordt verzonden - Alleen accountniveau: de trigger 'Wanneer een envelop wordt verzonden' wordt alleen geactiveerd wanneer het webhookniveau is ingesteld op Account. Het wordt niet geactiveerd voor enveloppen die zijn gemaakt op API-app-niveau . Zorg ervoor dat u accountniveau selecteert bij het configureren van deze trigger.
Regionale beschikbaarheid: de connector is beschikbaar voor zowel Noord-Amerika (NA1) als EU-regioaccounts. Selecteer de juiste serverregio bij het configureren van de verbinding. Als u verbinding maakt met de verkeerde regio, worden verificatiefouten veroorzaakt.
Base64-documentgrootte: wanneer u de envelop maken van Base64 of Sjabloon maken op basis van Base64-acties gebruikt, moet de met Base64 gecodeerde tekenreeks overeenkomen met een bronbestand dat niet groter is dan 25 MB.

Support

Neem voor ondersteuning voor ontwikkelaars contact op met het Foxit eSign-team op devsupport@foxitsoftware.com.

Als u een ondersteuningsaanvraag wilt indienen, gaat u naar https://kb.foxit.com/s/submit-a-case.

Beperkingslimieten

Name	Aanroepen	Verlengingsperiode
API-aanroepen per verbinding	100	60 seconden

Acties

Alle webhookkanalen weergeven	Retourneert een lijst met alle webhookkanalen die zijn geconfigureerd in uw account.
Details van e-mailgroep ophalen	Hiermee worden details van een bestaande e-mailgroep opgehaald.
Details van webhookkanaal ophalen	Hiermee worden de details van een specifiek webhookkanaal opgehaald.
E-mailgroep maken	Hiermee maakt u een nieuwe e-mailgroep die kan worden gebruikt om enveloppen tegelijk naar meerdere geadresseerden te verzenden.
Een lijst met alle sjablonen ophalen	Retourneert een lijst met alle sjablonen die beschikbaar zijn in uw account.
Envelop annuleren	Hiermee wordt een verzonden envelop geannuleerd. Geadresseerden kunnen de documenten niet meer ondertekenen.
Envelop-id's ophalen	Retourneert een lijst met envelop-id's die zijn gefilterd op status. Gebruik deze optie om enveloppen in een specifieke status te zoeken.
Envelop maken op basis van Base64	Hiermee maakt en verzendt u een envelop met een PDF-document met Base64-codering.
Envelop maken op sjabloon	Hiermee maakt en verzendt u een envelop met behulp van een bestaande sjabloon. Details van geadresseerden kunnen worden aangepast.
Envelop maken op url	Hiermee maakt en verzendt u een envelop met openbaar toegankelijke PDF-URL's. Geef de document-URL's en de details van de geadresseerde op om het ondertekeningsproces te initiëren.
Envelopbestanden downloaden	Hiermee downloadt u de voltooide documenten van een envelop als een bestand.
Envelopdetails ophalen	Haalt de volledige details van een envelop op, inclusief de status, geadresseerden en documenten.
Enveloppen verplaatsen naar Prullenbak	Hiermee verplaatst u een of meer enveloppen naar de prullenbak. Enveloppen in de Prullenbak worden niet definitief verwijderd.
Enveloppen verwijderen	Hiermee verwijdert u een of meer enveloppen definitief.
Geschiedenis van envelopactiviteit ophalen	Hiermee haalt u een volledig activiteitenlogboek voor een envelop op, met alle acties die zijn uitgevoerd door geadresseerden en de afzender.
Herinnering voor handtekening verzenden	Hiermee wordt een herinneringsmelding verzonden naar geadresseerden van een envelop in behandeling en wordt hen gevraagd om de ondertekening te voltooien.
PDF met één document downloaden	Hiermee downloadt u één document van een envelop als PDF-bestand.
Rapport downloaden	Hiermee downloadt u een envelopactiviteitsrapport als een Microsoft Excel-bestand. Gebruik de filters om de resultaten te beperken op status, datumbereik, envelopnaam, auteur of ondertekenaar.
Sjablonen ophalen op sjabloon-id's	Hiermee worden details voor een of meer sjablonen opgehaald op basis van hun id's.
Sjabloon maken op basis van Base64	Hiermee maakt u een nieuwe sjabloon met een met Base64 gecodeerde PDF-tekenreeks. Gebruik dit wanneer uw PDF-bestand al beschikbaar is als een Base64-tekenreeks in uw stroom, bijvoorbeeld vanuit een SharePoint-bestand of OneDrive document.
Sjabloon maken op url	Hiermee maakt u een nieuwe sjabloon met een openbaar toegankelijke PDF-URL.
Sjabloondetails ophalen	Hiermee haalt u de volledige details van een specifieke sjabloon op, inclusief de velden en geadresseerden.
Verwijderde envelopgeschiedenis ophalen	Hiermee wordt een geschiedenis opgehaald van enveloppen die zijn verwijderd of verplaatst naar de Prullenbak.
Webhooktrigger afmelden	Hiermee verwijdert u een actief webhookkanaalabonnement op basis van de kanaal-id. Gebruik deze actie om webhookabonnementen op te schonen die niet meer nodig zijn.

Alle webhookkanalen weergeven

Bewerkings-id:: ListallWebhookChannels

Retourneert een lijst met alle webhookkanalen die zijn geconfigureerd in uw account.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Totaal aantal kanalen	total_channel	integer	Het totale aantal webhookkanalen dat in het account is geconfigureerd.
Webhookkanalen	templatesList	array of object	De lijst met alle webhookkanalen in het account.
Kanaal-ID	templatesList.channelId	integer	De unieke id van het webhookkanaal.
Bedrijfs-id	templatesList.companyId	integer	Het bedrijfsaccount waartoe dit kanaal behoort.
Kanaalnaam	templatesList.channelName	string	De naam van het webhookkanaal.
Webhook-URL	templatesList.webhookUrl	string	De URL die Foxit eSign aanroept wanneer een geabonneerde gebeurtenis plaatsvindt.
Webhookgeheim	templatesList.webhookSecret	string	De geheime sleutel die wordt gebruikt om nettoladingen van de webhook te verifiëren.
Aanmaakdatum	templatesList.dateCreated	integer	De datum waarop het kanaal is gemaakt, in Unix milliseconden.
Datum bijgewerkt	templatesList.dateUpdated	integer	De datum waarop het kanaal voor het laatst is bijgewerkt, in Unix milliseconden.
Webhookniveau	templatesList.webhookLevel	string	Het bereik van het webhookkanaal. Account (triggers voor alle enveloppen) of API-app (alleen voor enveloppen die zijn gemaakt via de API).
Status	templatesList.status	string	De huidige status van het kanaal. 'actief' of 'deactive'.
Envelop verzonden	templatesList.eventsSubscribedMap.folder_sent	boolean	Triggers wanneer een envelop naar geadresseerden wordt verzonden.
Envelop bekeken	templatesList.eventsSubscribedMap.folder_viewed	boolean	Wordt geactiveerd wanneer een envelop wordt geopend door een geadresseerde.
Envelop ondertekend	templatesList.eventsSubscribedMap.folder_signed	boolean	Wordt geactiveerd wanneer een envelop wordt ondertekend door een geadresseerde.
Envelop geannuleerd	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Triggers wanneer een envelop wordt geannuleerd.
Envelop uitgevoerd	templatesList.eventsSubscribedMap.folder_executed	boolean	Triggers wanneer alle partijen zijn ondertekend en de envelop volledig wordt uitgevoerd.
Envelop verwijderd	templatesList.eventsSubscribedMap.folder_deleted	boolean	Triggers wanneer een envelop wordt verwijderd.

Details van e-mailgroep ophalen

Bewerkings-id:: GetEmailGroupDetails

Hiermee worden details van een bestaande e-mailgroep opgehaald.

Parameters

Name	Sleutel	Vereist	Type	Description
E-mailgroepnamen	emailGroupNames	True	array of string	Een matrix met e-mailgroepnamen die worden gebruikt om de groepen te identificeren.

Retouren

Name	Pad	Type	Description
E-mailgroepen	allEmailGroups	array of object	De lijst met e-mailgroepen die overeenkomen met de aangevraagde groepsnamen.
Groeps-id	allEmailGroups.groupId	integer	De unieke id van de e-mailgroep.
Groepsnaam	allEmailGroups.groupName	string	De naam van de e-mailgroep.
Groepsbeschrijving	allEmailGroups.groupDesc	string	De beschrijving van de e-mailgroep.
Aanmaakdatum	allEmailGroups.dateCreated	integer	De datum waarop de e-mailgroep is gemaakt, in Unix milliseconden.
Bedrijfs-id	allEmailGroups.companyId	integer	Het bedrijfsaccount waartoe deze e-mailgroep behoort.
Parties	allEmailGroups.parties	array of object	De lijst met geadresseerden in deze e-mailgroep.
Voornaam	allEmailGroups.parties.firstName	string	De voornaam van de geadresseerde.
Achternaam	allEmailGroups.parties.lastName	string	De achternaam van de geadresseerde.
E-mailen	allEmailGroups.parties.emailId	string	Het e-mailadres van de geadresseerde.

Details van webhookkanaal ophalen

Bewerkings-id:: GetWebhookChannelDetails

Hiermee worden de details van een specifiek webhookkanaal opgehaald.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaal-ID	channelId	True	string	De unieke id van het webhookkanaal dat moet worden opgehaald.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Id	channel.channelId	integer	De unieke id van het webhookkanaal.
Bedrijfs-id	channel.companyId	integer	Het bedrijfsaccount waartoe dit kanaal behoort.
Naam	channel.channelName	string	De naam van het webhookkanaal.
Webhook-URL	channel.webhookUrl	string	De URL die Foxit eSign aanroept wanneer een geabonneerde gebeurtenis plaatsvindt.
Webhookgeheim	channel.webhookSecret	string	De geheime sleutel die wordt gebruikt om nettoladingen van de webhook te verifiëren.
Aanmaakdatum	channel.dateCreated	integer	De datum waarop het kanaal is gemaakt, in Unix milliseconden.
Datum bijgewerkt	channel.dateUpdated	integer	De datum waarop het kanaal voor het laatst is bijgewerkt, in Unix milliseconden.
Webhookniveau	channel.webhookLevel	string	Het bereik van het webhookkanaal. Account (triggers voor alle enveloppen) of API-app (alleen voor enveloppen die zijn gemaakt via de API).
Status	channel.status	string	De huidige status van het kanaal. 'actief' of 'deactive'.
Envelop verzonden	channel.eventsSubscribedMap.folder_sent	boolean	Triggers wanneer een envelop naar geadresseerden wordt verzonden.
Envelop bekeken	channel.eventsSubscribedMap.folder_viewed	boolean	Wordt geactiveerd wanneer een envelop wordt geopend door een geadresseerde.
Envelop ondertekend	channel.eventsSubscribedMap.folder_signed	boolean	Wordt geactiveerd wanneer een envelop wordt ondertekend door een geadresseerde.
Envelop geannuleerd	channel.eventsSubscribedMap.folder_cancelled	boolean	Triggers wanneer een envelop wordt geannuleerd.
Envelop uitgevoerd	channel.eventsSubscribedMap.folder_executed	boolean	Triggers wanneer alle partijen zijn ondertekend en de envelop volledig wordt uitgevoerd.
Envelop verwijderd	channel.eventsSubscribedMap.folder_deleted	boolean	Triggers wanneer een envelop wordt verwijderd.

E-mailgroep maken

Bewerkings-id:: CreateEmailGroup

Hiermee maakt u een nieuwe e-mailgroep die kan worden gebruikt om enveloppen tegelijk naar meerdere geadresseerden te verzenden.

Parameters

Name	Sleutel	Vereist	Type	Description
Groepsnaam	emailGroupName	True	string	De naam voor de nieuwe e-mailgroep.
Groepsbeschrijving	emailGroupDescription		string	Een optionele beschrijving voor de e-mailgroep.
Geavanceerde e-mailvalidatie toestaan	allowAdvancedEmailValidation		boolean	Wanneer deze optie is ingeschakeld, valideert Foxit eSign dat alle e-mailadressen in de groep bereikbaar zijn voordat ze worden verzonden.
Voornaam	firstName	True	string	De voornaam van de geadresseerde.
Achternaam	lastName	True	string	De achternaam van de geadresseerde.
E-mailen	emailId	True	string	Het e-mailadres van de geadresseerde.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Message	message	string	Een bevestigingsbericht voor de uitgevoerde actie.
Groeps-id	emailGroup.groupId	integer	De unieke id van de e-mailgroep. Gebruik deze id bij het verzenden van enveloppen naar de groep.
Groepsnaam	emailGroup.groupName	string	De naam van de e-mailgroep.
Groepsbeschrijving	emailGroup.groupDesc	string	De beschrijving van de e-mailgroep.
Aanmaakdatum	emailGroup.dateCreated	integer	De datum waarop de e-mailgroep is gemaakt, in Unix milliseconden.
Bedrijfs-id	emailGroup.companyId	integer	Het bedrijfsaccount waartoe deze e-mailgroep behoort.
Parties	emailGroup.parties	array of object	De lijst met geadresseerden in de e-mailgroep.
Voornaam	emailGroup.parties.firstName	string	De voornaam van de geadresseerde.
Achternaam	emailGroup.parties.lastName	string	De achternaam van de geadresseerde.
E-mailen	emailGroup.parties.emailId	string	Het e-mailadres van de geadresseerde.

Een lijst met alle sjablonen ophalen

Bewerkings-id:: GetalistofallTemplates

Retourneert een lijst met alle sjablonen die beschikbaar zijn in uw account.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Totaal aantal sjablonen	total_templates	integer	Het totale aantal sjablonen in uw account.
Lijst met sjablonen	templatesList	array of object	De lijst met alle sjablonen die beschikbaar zijn in het account.
Sjabloon-ID	templatesList.templateId	integer	De unieke id van de sjabloon. Gebruik deze id met Envelop maken van sjabloon om de sjabloon te verzenden voor ondertekening.
Sjabloonnaam	templatesList.templateName	string	De naam van de sjabloon.
Beschrijving van sjabloon	templatesList.templateDesc	string	Een beschrijving van de sjabloon.
Sjabloontype	templatesList.templateType	string	Het type of de categorie van de sjabloon.
Aanmaakdatum	templatesList.templateCreationDate	integer	De datum waarop de sjabloon is gemaakt, in Unix milliseconden.
Laatst bijgewerkt	templatesList.templateLastUpdateDate	integer	De datum waarop de sjabloon voor het laatst is bijgewerkt, in Unix milliseconden.
Aanpasbaar	templatesList.editable	boolean	Geeft aan of de sjabloon kan worden bewerkt.
Aantal partijen	templatesList.numberOfParties	integer	Het aantal ondertekeningspartijen dat in de sjabloon is gedefinieerd.
Bedrijfs-id	templatesList.companyId	integer	Het bedrijfsaccount waartoe de sjabloon behoort.
Delen met iedereen	templatesList.shareAll	boolean	Geeft aan of de sjabloon wordt gedeeld met alle gebruikers in het account.
Partij-id	templatesList.templateCreatedBy.partyId	integer	De unieke id van de gebruiker.
Voornaam	templatesList.templateCreatedBy.firstName	string	De voornaam van de gebruiker.
Achternaam	templatesList.templateCreatedBy.lastName	string	De achternaam van de gebruiker.
E-mailen	templatesList.templateCreatedBy.emailId	string	Het e-mailadres van de gebruiker.
Partij-id	templatesList.templateLastUpdatedBy.partyId	integer	De unieke id van de gebruiker.
Voornaam	templatesList.templateLastUpdatedBy.firstName	string	De voornaam van de gebruiker.
Achternaam	templatesList.templateLastUpdatedBy.lastName	string	De achternaam van de gebruiker.
E-mailen	templatesList.templateLastUpdatedBy.emailId	string	Het e-mailadres van de gebruiker.

Envelop annuleren

Bewerkings-id:: CancelEnvelope

Hiermee wordt een verzonden envelop geannuleerd. Geadresseerden kunnen de documenten niet meer ondertekenen.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelop-id	folderId	True	integer	De id van de envelop die moet worden geannuleerd.
Reden voor annulering	reason_for_cancellation	True	string	De reden voor het annuleren van deze envelop. Dit wordt vastgelegd in de geschiedenis van de envelopactiviteit.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Geannuleerde envelop-id's	folders cancelled	array of integer	De lijst met envelop-id's die zijn geannuleerd.

Envelop-id's ophalen

Bewerkings-id:: GetEnvelopeIds

Retourneert een lijst met envelop-id's die zijn gefilterd op status. Gebruik deze optie om enveloppen in een specifieke status te zoeken.

Parameters

Name	Sleutel	Vereist	Type	Description
Datum vanaf	dateFrom	True	string	Begin van het datumbereik voor het maken van enveloppen. Geaccepteerde indeling: JJJJ-MM-DD.
Datum tot	dateTo	True	string	Einde van het datumbereik voor het maken van enveloppen. Geaccepteerde indeling: JJJJ-MM-DD. De waarde dateTo moet binnen 6 maanden na de waarde dateFrom zijn.
Status	status		string	Enveloppen filteren op status. Geaccepteerde waarden: UITGEVOERD, GEDEELD, CONCEPT, GEDEELTELIJK ONDERTEKEND, GEANNULEERD, VERLOPEN, VERWIJDERD. Als u dit weglaat, worden enveloppen met een status geretourneerd.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Message	message	string	Een samenvattingsbericht dat aangeeft hoeveel envelop-id's zijn geretourneerd.
Envelop-id's	allFolderIds	array of integer	De lijst met envelop-id's die overeenkomen met de filtercriteria. Gebruik deze id's met Envelopdetails ophalen om volledige envelopgegevens op te halen.

Envelop maken op basis van Base64

Bewerkings-id:: CreateEnvelopefromBase64

Hiermee maakt en verzendt u een envelop met een PDF-document met Base64-codering.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelopnaam	folderName	True	string	De naam van deze envelop.
Invoertype	inputType		string	Invoertype voor documentbron. Vastgezet op base64 voor deze actie.
Base64-bestandsreeksen	base64FileString	True	array of string	Een matrix met met Base64 gecodeerde PDF-documenten die moeten worden verzonden.
Bestandsnamen	fileNames	True	array of string	Een matrix met weergavenamen voor elk document, in dezelfde volgorde als de matrix Base64-bestandsreeks.
Voornaam	firstName	True	string	De voornaam van de geadresseerde.
Achternaam	lastName	True	string	De achternaam van de geadresseerde.
E-mailadres	emailId	True	string	Het e-mailadres van de geadresseerde.
permissions	permission	True	string
Volgorde	sequence	True	integer	Gebruik dit veld om een volgnummer toe te wijzen aan een geadresseerde in de lijst met geadresseerden. Gebruik unieke volgnummers voor elke partij die begint met 1, zoals 1,2,3,4.... Als één persoon meerdere keren wordt weergegeven in de werkstroom voor ondertekening, wijst u telkens wanneer de geadresseerde wordt herhaald een andere volgorde toe.
signerAuthLevels	signerAuthLevel		string	Het verificatieniveau dat een ondertekenaar zal gebruiken voor verificatiedoeleinden
Is tijdelijke aanduiding	isPlaceholder		boolean	Gebruik dit veld om de partij te initiëren, is een tijdelijke aanduiding. Opmerking: 1. de waarde van de parameter firstName, lastName, emailId moet leeg zijn van deze partij. 2. Als u de tijdelijke aanduiding wilt toevoegen, moet één geadresseerde worden gevraagd met de machtiging 'PARTY_ASSIGNER'.
Rol van geadresseerde	partyRole		string	Gebruik dit veld om een rol van tijdelijke aanduiding toe te wijzen.
Naamwijziging toestaan	allowNameChange		string	Waarde kan waar of onwaar zijn. Gebruik deze parameter zodat ondertekenaar voor- en achternaam kan bijwerken voordat het ondertekeningsproces wordt voltooid.
Werkstroomvolgorde	workflowSequence		integer	Wijs een werkstroomreeksnummer toe aan deze geadresseerde. Wanneer aanmeldingsreeks is ingeschakeld, ontvangen geadresseerden hun uitnodiging voor ondertekening in oplopende volgorde.
E-mail-id host	hostEmailId		string	E-mailadres van In-Person beheerder.
Toegangscode	userDefinedAccessCode		string	De parameter bevat de toegangscode wanneer de waarde 'signerAuthLevel' is ingesteld als 'Door de gebruiker gedefinieerde toegangscode' voor verificatie. Opmerking: 1. Codes zijn niet hoofdlettergevoelig. 2. Het systeem verzendt deze code niet, dus u moet deze code rechtstreeks met de ondertekenaar delen. 3. De toegangscode kan alfabetten, cijfers en de volgende speciale tekens bevatten: @,&,{,}%,(,),~,\|,!,+,^.
Partij is e-mailgroep	partyIsEmailGroup		boolean	Gebruik deze parameter bij het maken van een partij als bulk. Opmerking: Als deze parameter waar is, worden firstName, lastName en emailId van deze partij genegeerd.
E-mailgroep-id	emailGroupId		integer	Geef de e-mail door met de groeps-id die u wilt gebruiken om bulksgewijs te maken.
Bulk voor eenmalige aanmelding	allowSingleSignerInBulk		boolean	Gebruik deze parameter om slechts één persoon toe te staan zich aan te melden bij een e-mailgroep.
Kiescode	dialingCode		string	Gebruik dit veld om een land inbelcodes toe te wijzen, zijn voorvoegsels voor mobiele nummers aan een geadresseerde in de lijst met geadresseerden.
Mobiel nummer	mobileNumber		string	Gebruik dit veld om een mobiel nummer toe te wijzen aan een geadresseerde in de lijst met geadresseerden.
Velden	Fields		object
Nu verzenden	sendNow		boolean	Wanneer deze optie is ingeschakeld, verzendt Foxit eSign onmiddellijk een unieke ondertekeningskoppeling naar het e-mailadres van elke geadresseerde. Schakel dit uit om de envelop op te slaan als concept.
Ingesloten ondertekeningssessie maken	createEmbeddedSigningSession	True	boolean	Het ondertekeningssessietoken wordt gegenereerd zonder e-mailberichten naar de geadresseerden te verzenden.
Ingesloten ondertekeningssessie maken voor alle partijen	createEmbeddedSigningSessionForAllParties		boolean	Als deze optie is ingesteld op true, wordt er een ingesloten ondertekenings-URL gegenereerd voor elke geadresseerde in de envelop.
Teksttags verwerken	processTextTags	True	boolean	De waarde kan waar of onwaar zijn. Dit veld wordt gebruikt om te bepalen of Foxit eSign de documenten voor tekstlabels moet parseren om ze te converteren naar Foxit eSign-velden.
Acrovelden verwerken	processAcroFields	True	boolean	Dit veld wordt gebruikt om te bepalen of Foxit eSign de documenten voor AcroFields moet parseren om ze te converteren naar Foxit eSign-velden.
Aanmeldingsvolgorde	signInSequence		boolean	Dit veld wordt gebruikt om te bepalen of geadresseerden de envelopdocumenten in een reeks ondertekenen. Als dit onwaar is, ontvangen alle geadresseerden tegelijk uitnodigingsmail. Wanneer waar, ontvangt elke geadresseerde achtereenvolgens een uitnodigingsmail nadat de vorige geadresseerde de vereiste taak heeft voltooid, zoals het ondertekenen van de documenten of het invullen van velden, enzovoort.
Persoonlijk inschakelen	inPersonEnable		boolean	Dit veld wordt gebruikt voor het initiëren van het ondertekeningsproces van personen, dat in enkele minuten eenvoudig kan worden voltooid op elk apparaat en voorkomt waar nodig e-mailhandtekeningen. Als dit onwaar is, ontvangen alle geadresseerden tegelijkertijd de uitnodigingsmail. Wanneer waar, ontvangt de beheerder van de persoon een uitnodiging per e-mail om het ondertekeningsproces voor de ondertekenaar te initiëren.
Geadresseerden herstellen	fixRecipientParties		boolean	Indien waar, dan kunnen in de ingesloten verzendweergave de partijen voor de envelop die al zijn toegevoegd als onderdeel van deze aanvraag, niet wijzigen.
Documenten herstellen	fixDocuments		boolean	Indien waar, kan in het ingesloten verzenden de documenten voor de envelop die al zijn toegevoegd als onderdeel van deze aanvraag, niet wijzigen.
Geslaagde URL verzenden	sendSuccessUrl		string	Voer de absolute URL in voor de landingspagina, waarnaar de ondertekenaar wordt omgeleid nadat de map is verzonden in de ingesloten verzendweergave.
Fout-URL verzenden	sendErrorUrl		string	Voer de absolute URL in voor de landingspagina, waarnaar de ondertekenaar wordt omgeleid als er een fout optreedt tijdens het verzenden van de map in de ingesloten verzendweergave.
Ingesloten verzendsessie maken	createEmbeddedSendingSession		boolean	Als deze optie is ingesteld op true, wordt er een ingesloten token gegenereerd om de documentvoorbereidingsweergave van Foxit eSign te openen.
E-mail-id's voor ingesloten ondertekenaars	embeddedSignersEmailIds		array of string	Een matrix met e-mail-id's van geadresseerden waarvoor een ingesloten ondertekeningssessie moet worden gemaakt. De e-mail-id's van de geadresseerden die zijn toegevoegd aan de lijst met partijen.
Url voor geslaagd ondertekenen	signSuccessUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid nadat ze zich hebben aangemeld in de ingesloten ondertekeningsweergave.
Afmeldings-URL	signDeclineUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als de ingesloten ondertekeningsweergave wordt geweigerd.
Aanmeldings-URL	signLaterUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als u ervoor kiest om u later aan te melden in de ingesloten ondertekeningsweergave.
Url voor tekenfout	signErrorUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als er een fout optreedt tijdens het ondertekenen van het document in de ingesloten ondertekeningsweergave.
Nu verzenden en ingesloten ondertekeningssessie toestaan	allowSendNowAndEmbeddedSigningSession		boolean	Als deze optie is ingesteld als waar, verzendt Foxit eSign een unieke ondertekeningskoppeling naar elke geadresseerde. Dit is ALLEEN van toepassing wanneer parameters sendNow en createEmbeddedSigningSession waar zijn.
Geavanceerde e-mailvalidatie	allowAdvancedEmailValidation		boolean	Valideer het e-mailadres van de partijen wanneer deze is ingesteld als waar.
Geslaagde URL ondertekenen alle partijen	signSuccessUrlAllParties		boolean	Als deze optie is ingesteld op true, wordt de ondertekenaar omgeleid naar de URL die is opgegeven in signSuccessUrl na het ondertekenen. Dit is alleen van toepassing wanneer sendNow waar is.
E-mailsjabloon-id	emailTemplateId		integer	Geef de e-mailsjabloon-id door om andere e-mailsjablonen dan standaard-e-mailsjablonen te verzenden.
Instructie-id voor ondertekenaar	signerInstructionId		integer	Geef de instructie-id door om andere instructies voor ondertekenaar te verzenden dan de standaardinstructies voor ondertekenaar.
Bevestigingsinstructie-id	confirmationInstructionId		string	Geef de bevestigingsinstructie-id door om andere bevestigingsinstructies dan de standaardbevestigingsinstructies te verzenden.
Themakleur	themeColor		string	Voer de CSS-waarde in om de themakleur in te stellen.
Sessie verlopen	sessionExpire		boolean	Stel in op true om het verlopen van de ingesloten ondertekeningssessie te initiëren.
Vervaldatum	expiry		integer	Vereist als sessionExpire waar is. Voer de duur in milliseconden van de vervaldatum in voor de ingesloten ondertekeningssessie.
Naam van afhankelijk veld	dependentFieldName	True	string	De naam van het veld waarvan de zichtbaarheid wordt bepaald door het bovenliggende veld.
Naam van bovenliggend veld	parentFieldName	True	string	De naam van het bovenliggende veld waarvan de waarde de zichtbaarheid van het afhankelijke veld bepaalt. Ondersteunde bovenliggende veldtypen: tekstveld, tekstvak, selectievakje, keuzerondje, vervolgkeuzelijst.
Waarde van bovenliggend veld	parentFieldValue	True	string	De waarde van het bovenliggende veld dat het afhankelijke veld activeert om zichtbaar te worden. Gebruik ingeschakeld of uitgeschakeld voor velden met selectievakjes en keuzerondjes.
Opties	options	True	string	Aanvullende overeenkomende opties voor bovenliggende velden op basis van tekst. Geaccepteerde waarden: isblank, allowNull, contains.
Metagegevens	metadata		object	Dit moet een sleutel-waardepaar zijn. Maximaal 1000 sleutelwaardeparen zijn toegestaan.
E-mail van afzender	senderEmail		string	voer een e-mail in van een andere gebruiker in uw account die wordt gebruikt voor het verzenden van deze documentmap naar de geadresseerden.
Knop Mij toevoegen verbergen	hideAddMeButton		boolean	Indien waar, wordt de knop 'Mij toevoegen' verborgen op geadresseerden in een ingesloten verzendsessie.
Knop Nieuwe toevoegen verbergen	hideAddNewButton		boolean	Indien waar, wordt de knop 'Nieuwe toevoegen' verborgen op geadresseerden in een ingesloten verzendsessie.
Knop Groep toevoegen verbergen	hideAddGroupButton		boolean	Indien waar, wordt de knop Groep toevoegen verborgen op geadresseerden in een ingesloten verzendsessie.
Veldnaam voor geadresseerden verbergen	hideFieldNameForRecipients		boolean	Veldnamen verbergen voor ontvangers voor gegevensinvoervelden en geavanceerde velden. (Behalve keuzerondje, selectievakje, afbeelding en hyperlink).
Selectievakjerand verbergen	hideCheckboxBorder		boolean	Randen van selectievakje worden verborgen in de uitgevoerde documenten.
Optie Voor het selecteren van ondertekenaar verbergen	hideSignerSelectOption		boolean	Indien waar, wordt het invoervak 'Bestaande ondertekenaarnaam/e-mail' verborgen voor geadresseerden in een ingesloten verzendsessie.
Ondertekenacties verbergen	hideSignerActions		boolean	Indien waar, wordt de ondertekenaar 'bewerken', 'wijzigen' en 'verwijderen' verborgen voor geadresseerden in een ingesloten verzendsessie.
Naam van afzender verbergen	hideSenderName		boolean	Indien waar, wordt de naam van de afzender verborgen voor geadresseerden in een ingesloten verzendsessie.
Mapnaam verbergen	hideFolderName		boolean	Indien waar, wordt de mapnaam verborgen in de navigatie in beide ingesloten sessies.
Naam van documenten verbergen	hideDocumentsName		boolean	Indien waar, wordt de documentnaam verborgen in beide ingesloten sessies.
Weigeren om te ondertekenen verbergen	hideDeclineToSign		boolean	Indien waar, wordt de optie 'Weigeren om te ondertekenen' voor de ondertekenaar verborgen.
Meer actie verbergen	hideMoreAction		boolean	Indien waar, wordt de knop 'Meer acties' verborgen in het verzenden/ondertekenen van een sessie. In het geval van 'Nu verzenden': waar, wordt er niets verborgen.
Knop Verzenden verbergen	hideSendButton		boolean	Indien waar, wordt de knop Verzenden verborgen in de ingesloten verzendsessie.
Volgende vereiste veldbtn verbergen	hideNextRequiredFieldbtn		boolean	Als deze optie is ingesteld op true, verbergt u de navigatieknop waarmee ondertekenaars naar het volgende vereiste veld worden verplaatst.
Beide ingesloten sessies vereist	requiredBothEmbeddedSession		boolean	Indien waar, worden de ingesloten verzend- en ondertekenings-URL's samen gegenereerd.
Envelopwachtwoord	folderPassword		string	Dit wachtwoord is vereist door de ondertekenaar/auteur om het digitaal ondertekende document te openen. Als de parameter leeg blijft, is er geen wachtwoord vereist om het digitaal ondertekende document te openen.
Stap voor stap inschakelen	enableStepByStep		boolean	Als u stap voor stap actie wilt inschakelen in de ingesloten verzendsessie.
Optie Voor toevoegen van partijen verbergen	hideAddPartiesOption		boolean	Indien waar, wordt de optie voor het toevoegen van partijen verborgen in de modus Concept en Sjabloon maken.
Zelfteken	selfSign		boolean	Het maakt ingesloten self sign via API's mogelijk. Deze parameter is alleen van toepassing wanneer de parameter createEmbeddedSendingSession waar is.
Url voor geslaagde zelfondertekening	selfSignerSuccessUrl		string	Voer de absolute URL in voor de landingspagina op uw website/toepassing, waarnaar de gebruiker wordt omgeleid nadat de map is verzonden in de ingesloten verzendweergave.

Retouren

Name	Pad	Type	Description
Id	folder.folderId	integer	De unieke id van de zojuist gemaakte envelop. Gebruik dit in volgende acties om naar deze envelop te verwijzen.
Naam	folder.folderName	string	De naam van de zojuist gemaakte envelop.
Aangepaste naam	folder.folderCustomName	string	Een aangepaste naam voor de envelop.
Password	folder.folderPassword	string	Het toegangswachtwoord voor de envelop, indien ingesteld.
Creator-id	folder.folderAuthorId	integer	De unieke id van de envelopmaker.
Voornaam maker	folder.folderAuthorFirstName	string	De voornaam van de envelopmaker.
Achternaam van maker	folder.folderAuthorLastName	string	De achternaam van de envelopmaker.
E-mail maker	folder.folderAuthorEmail	string	Het e-mailadres van de maker van de envelop.
Rol maker	folder.folderAuthorRole	string	De rol van de maker van de envelop.
Bedrijfs-id	folder.folderCompanyId	integer	De unieke id van het bedrijf dat eigenaar is van de envelop.
Aanmaakdatum	folder.folderCreationDate	integer	De datum waarop de envelop is gemaakt (Unix-tijdstempel in milliseconden).
Verzonden datum	folder.folderSentDate	integer	De datum waarop de envelop is verzonden (Unix-tijdstempel in milliseconden).
Status	folder.folderStatus	string	De huidige status van de envelop.
Aangepast veld 1	folder.custom_field1	string	Het eerste aangepaste metagegevensveld voor de envelop.
Aangepast veld 2	folder.custom_field2	string	Het tweede aangepaste metagegevensveld voor de envelop.
Metagegevens	folder.metadata	string	Aangepaste metagegevens die zijn gekoppeld aan de envelop.
Document-ID's	folder.folderDocumentIds	array of integer	De lijst met document-id's in de envelop.
Documents	folder.documentsList	array of object	De lijst met documenten in de envelop.
Document-ID	folder.documentsList.documentId	integer	De unieke identificatie van het document.
Contract-id	folder.documentsList.contractId	integer	De unieke id van het contract.
Bedrijfs-id	folder.documentsList.companyId	integer	De unieke id van het bedrijf.
Gemaakt door	folder.documentsList.contractCreatedBy	integer	De gebruikers-id van de persoon die het contract heeft gemaakt.
Gemaakt op	folder.documentsList.contractCreatedOn	string	De datum en tijd waarop het contract is gemaakt.
Contractsoort	folder.documentsList.contractType	string	Het type contract.
Contractstatus	folder.documentsList.contractStatus	string	De huidige status van het contract.
Aanpasbaar	folder.documentsList.editable	boolean	Geeft aan of het item kan worden bewerkt.
Versie-id	folder.documentsList.contractVersionId	integer	De unieke id van de contractversie.
Versienaam	folder.documentsList.contractVersionName	string	De naam van de contractversie.
Versiebeschrijving	folder.documentsList.contractVersionDesc	string	Een beschrijving van de contractversie.
Versie gemaakt door	folder.documentsList.versionCreatedby	integer	De gebruikers-id van de persoon die deze versie heeft gemaakt.
Versie gemaakt op	folder.documentsList.versionCreatedOn	string	De datum en tijd waarop deze versie is gemaakt.
Versienummer	folder.documentsList.contractVersionNumber	integer	Het versienummer van het contract.
Transactiebron	folder.documentsList.contractTransactionSource	string	Het bronsysteem dat de contracttransactie heeft gestart.
Ontvangers	folder.folderRecipientParties	array of object	De lijst met geadresseerden voor deze envelop.
Ontvanger-id	folder.folderRecipientParties.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	folder.folderRecipientParties.partyDetails.partyId	integer	De unieke id van de ontvanger.
Voornaam	folder.folderRecipientParties.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	folder.folderRecipientParties.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailadres	folder.folderRecipientParties.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
Tijdelijke aanduiding	folder.folderRecipientParties.partyDetails.placeholder	boolean	Hiermee wordt aangegeven of deze partij een tijdelijke ontvanger is.
Address	folder.folderRecipientParties.partyDetails.address	string	Het fysieke adres van de ontvanger.
Aanmaakdatum	folder.folderRecipientParties.partyDetails.dateCreated	integer	De datum waarop de record is gemaakt (Unix-tijdstempel in milliseconden).
Afmelden voor e-mailberichten	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Hiermee wordt aangegeven of de geadresseerde zich heeft afgemeld voor e-mailmeldingen.
Unieke ontvanger-id	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Een unieke systeem-id voor deze ontvanger.
Verificatieniveau	folder.folderRecipientParties.partyDetails.authenticationLevel	string	De verificatiemethode die is vereist voor deze ontvanger.
Datum van wachtwoord bijgewerkt	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	De datum waarop het wachtwoord voor het laatst is bijgewerkt.
Status bijgewerkt wachtwoord	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Geeft aan of het wachtwoord is bijgewerkt.
Bedrijfs-id	folder.folderRecipientParties.partyDetails.companyId	integer	De unieke id van het bedrijf.
Gebruikersrol	folder.folderRecipientParties.partyDetails.userRole	string	De rol die is toegewezen aan de gebruiker.
Afdeling	folder.folderRecipientParties.partyDetails.department	string	De afdeling waartoe de gebruiker behoort.
Title	folder.folderRecipientParties.partyDetails.title	string	De functie van de gebruiker.
Actief	folder.folderRecipientParties.partyDetails.active	boolean	Geeft aan of de gebruiker of record actief is.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	De landinstelling voor de gebruiker.
Delen met afdeling	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Geeft aan of enveloppen worden gedeeld over de afdeling.
Kiescode	folder.folderRecipientParties.partyDetails.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.folderRecipientParties.partyDetails.mobileNumber	string	Het mobiele telefoonnummer.
Statusfilter	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Een filter voor documentstatus.
Datumfilter	folder.folderRecipientParties.partyDetails.docDateFilter	string	Een filter voor documentdatum.
Beveiligde veldtoegang	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Hiermee wordt aangegeven of de gebruiker toegang heeft tot beveiligde velden.
Zijbalk uitvouwen	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Geeft aan of de zijbalk standaard is uitgevouwen.
Adv. E-mailvalidatie	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Geeft aan of geavanceerde e-mailvalidatie is ingeschakeld.
Manager-id	folder.folderRecipientParties.partyDetails.managerId	string	De unieke id van de manager van de gebruiker.
Aantal aanmeldingen	folder.folderRecipientParties.partyDetails.loginCount	integer	Het aantal keren dat de gebruiker zich heeft aangemeld.
E-mail opnieuw instellen van wachtwoord	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Hiermee wordt aangegeven of een e-mail voor het opnieuw instellen van een wachtwoord moet worden verzonden.
Afdelings-id	folder.folderRecipientParties.partyDetails.departmentId	string	De unieke id van de afdeling.
Primair bedrijf	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Het primaire bedrijf dat is gekoppeld aan de gebruiker.
Apparaattype	folder.folderRecipientParties.partyDetails.deviceType	string	Het type apparaat dat wordt gebruikt.
Apparaattoken	folder.folderRecipientParties.partyDetails.deviceToken	string	Het pushmeldingstoken voor het apparaat.
Beschrijving van onderaannemer	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Een beschrijving van de onderaannemer of externe ondertekenaar.
Onderaannemerorganisatie	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	De naam van de organisatie van de onderaannemer of externe ondertekenaar.
Datum van onderaannemer toegevoegd	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	De datum waarop de onderaannemer is toegevoegd (Unix-tijdstempel in milliseconden).
Bron	folder.folderRecipientParties.partyDetails.source	string	Het bronsysteem van waaruit de externe ondertekenaar is toegevoegd.
Kiescode	folder.folderRecipientParties.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.folderRecipientParties.mobileNumber	string	Het mobiele telefoonnummer.
Handtekeningtype	folder.folderRecipientParties.signerSignatureType	string	Het type handtekening dat de ondertekenaar gebruikt.
toestemmingen	folder.folderRecipientParties.contractPermissions	string	De machtigingen die aan deze partij zijn verleend voor het contract.
Ondertekeningsorder	folder.folderRecipientParties.partySequence	integer	Het volgnummer voor de ondertekeningsvolgorde voor deze geadresseerde.
Werkstroomvolgorde	folder.folderRecipientParties.workflowSignSequence	integer	Het volgnummer van de werkstroomondertekening.
Envelop-id	folder.folderRecipientParties.envelopeId	integer	De unieke id van de envelop.
Bedrijfs-id van geadresseerde	folder.folderRecipientParties.partyCompanyId	integer	De unieke id van het bedrijf dat aan deze ontvanger is gekoppeld.
Deelmodus	folder.folderRecipientParties.sharingMode	string	De deelmodus voor deze envelop.
URL voor toegang van geadresseerden	folder.folderRecipientParties.folderAccessURL	string	De URL die de ontvanger kan gebruiken om de envelop te openen en te ondertekenen.
Beveiligingsmodus	folder.folderRecipientParties.securityMode	string	De beveiligingsmodus die op deze envelop wordt toegepast.
Comments	folder.folderRecipientParties.extraComments	string	Aanvullende opmerkingen bij de envelop.
Naamwijziging toestaan	folder.folderRecipientParties.allowNameChange	boolean	Hiermee wordt aangegeven of de geadresseerde zijn of haar naam mag bijwerken.
Naam bijgewerkt	folder.folderRecipientParties.signerNameUpdated	boolean	Geeft aan of de ondertekenaar zijn of haar naam heeft bijgewerkt.
Verificatieniveau ondertekenaar	folder.folderRecipientParties.signerAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de ondertekenaar.
Toegangscode	folder.folderRecipientParties.userDefinedAccessCode	string	Een aangepaste toegangscode die is gedefinieerd voor de ondertekenaar.
Handtekening-id	folder.folderRecipientParties.signatureId	string	De unieke id van de handtekening.
Rol van geadresseerde	folder.folderRecipientParties.partyRole	string	De rol die is toegewezen aan deze ontvanger in de werkstroom voor ondertekening.
Bedrijfsveld	folder.folderRecipientParties.companyFieldValue	string	De waarde van het veld bedrijfsnaam in de handtekening.
Titelveld	folder.folderRecipientParties.titleFieldValue	string	De waarde van het titelveld in de handtekening.
Reden voor ondertekening	folder.folderRecipientParties.reasonSigning	string	De reden waarom de ontvanger het document ondertekent.
Betalingsveld toegevoegd	folder.folderRecipientParties.payFieldAdded	boolean	Geeft aan of er een betalingsveld is toegevoegd.
Begunstigde	folder.folderRecipientParties.payee	boolean	Geeft aan of deze ontvanger de begunstigde is.
Terugkerende betaling	folder.folderRecipientParties.recurringFieldExist	boolean	Hiermee wordt aangegeven of er een terugkerend betalingsveld bestaat.
Afdrukken en ondertekenen voltooid	folder.folderRecipientParties.printAndSignCompleted	boolean	Geeft aan of het proces voor afdrukken en ondertekenen is voltooid.
Paid	folder.folderRecipientParties.paid	boolean	Geeft aan of de betaling is voltooid.
Optionele ondertekenaar toegestaan	folder.folderRecipientParties.allowOptionalSigner	boolean	Geeft aan of deze geadresseerde een optionele ondertekenaar is.
Optionele ondertekenaars	folder.folderRecipientParties.optionalSigners	array of integer	De lijst met optionele partij-id's voor deze envelop.
Url voor ondertekening van auteur	folder.folderAccessURLForAuthor	string	De URL die de afzender kan gebruiken voor toegang tot de envelop.
Concepttoegangs-URL	folder.draftFolderAccessURL	string	De URL die wordt gebruikt voor toegang tot de conceptversie van de envelop.
Bordruimteondertekening	folder.boardRoomSign	boolean	Hiermee wordt aangegeven of de ondertekeningsmodus voor vergaderruimten is ingeschakeld.
Logo opnemen	folder.includeLogo	boolean	Geeft aan of het bedrijfslogo is opgenomen in e-mailberichten.
Achtergrondkleur van knop	folder.email_btnBgColor	string	De achtergrondkleur van de e-mailknop.
Tekstkleur van knop	folder.email_btnTxtColor	string	De tekstkleur van de e-mailknop.
E-maillogo	folder.emailTemplateLogo	string	De logo-URL die wordt gebruikt in de e-mailsjabloon.
E-mailsjabloon-id	folder.emailTemplateId	integer	De unieke id van de e-mailsjabloon.
E-mailkoptekst	folder.emailHeader	string	De koptekst die wordt gebruikt in e-mailberichten met meldingen.
E-mailvoettekst	folder.emailFooter	string	De voettekst die wordt gebruikt in e-mailberichten met meldingen.
Geplande opschoning	folder.purgeFlag	boolean	Geeft aan of de envelop is gepland voor opschonen.
Begindatum opschonen	folder.purgeStartDate	string	De datum van waaruit het opschonen is gepland.
Einddatum opschonen	folder.purgeEndDate	string	De datum waarop het opschonen is gepland.
Id bulksgewijs verzenden	folder.bulkId	integer	De unieke id van de bulksgewijze verzendbewerking.
Handtekeningvolgorde afdwingen	folder.enforceSignWorkflow	boolean	Hiermee wordt aangegeven of geadresseerden zich moeten aanmelden bij de gedefinieerde reeks.
Huidige stap	folder.currentWorkflowStep	integer	De huidige stap in de werkstroom voor ondertekening.
Transactiebron	folder.transactionSource	string	Het bronsysteem dat deze transactie heeft gestart.
Aanpasbaar	folder.editable	boolean	Geeft aan of het item kan worden bewerkt.
In-Person ondertekenen	folder.inPersonSignable	boolean	Hiermee wordt aangegeven of de envelop persoonlijk kan worden aangemeld.
Herinneringen overschrijven	folder.overrideAccountReminders	boolean	Hiermee wordt aangegeven of herinneringsinstellingen op accountniveau worden overschreven.
Overdracht overschrijven	folder.overrideAccountRecipientDelegation	boolean	Hiermee wordt aangegeven of de delegatie-instellingen op accountniveau worden overschreven.
Delegatie toestaan	folder.allowRecipientsToDelegate	boolean	Hiermee wordt aangegeven of geadresseerden ondertekening mogen delegeren.
Id	folder.envelopeId	integer	De unieke id van de envelop.
Naam	folder.envelopeName	string	De naam van de envelop.
Originator-id	folder.envelopeOriginatorId	integer	De unieke id van de gebruiker die de envelop heeft gemaakt.
Bedrijfs-id	folder.envelopeCompanyId	integer	De unieke id van het bedrijf dat eigenaar is van de envelop.
Date	folder.envelopeDate	integer	De datum waarop de envelop is gemaakt (Unix-tijdstempel in milliseconden).
Gedeelde datum	folder.envelopeSharedDate	integer	De datum waarop de envelop is gedeeld (Unix-tijdstempel in milliseconden).
Status	folder.envelopeStatus	string	De huidige status van de envelop.
Contract-id's	folder.envelopeContractIds	array of integer	De lijst met contract-id's die aan deze envelop zijn gekoppeld.
Machtigingen voor geadresseerden	folder.envelopePartyPermissions	array of object	De lijst met machtigingen voor geadresseerden voor deze envelop.
Ontvanger-id	folder.envelopePartyPermissions.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	folder.envelopePartyPermissions.partyDetails.partyId	integer	De unieke id van de ontvanger.
Voornaam	folder.envelopePartyPermissions.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	folder.envelopePartyPermissions.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailadres	folder.envelopePartyPermissions.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
Tijdelijke aanduiding	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Hiermee wordt aangegeven of deze partij een tijdelijke ontvanger is.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Het fysieke adres van de ontvanger.
Aanmaakdatum	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	De datum waarop de record is gemaakt (Unix-tijdstempel in milliseconden).
Afmelden voor e-mailberichten	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Hiermee wordt aangegeven of de geadresseerde zich heeft afgemeld voor e-mailmeldingen.
Unieke ontvanger-id	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Een unieke systeem-id voor deze ontvanger.
Verificatieniveau	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	De verificatiemethode die is vereist voor deze ontvanger.
Datum van wachtwoord bijgewerkt	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	De datum waarop het wachtwoord voor het laatst is bijgewerkt.
Status bijgewerkt wachtwoord	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Geeft aan of het wachtwoord is bijgewerkt.
Bedrijfs-id	folder.envelopePartyPermissions.partyDetails.companyId	integer	De unieke id van het bedrijf.
Gebruikersrol	folder.envelopePartyPermissions.partyDetails.userRole	string	De rol die is toegewezen aan de gebruiker.
Afdeling	folder.envelopePartyPermissions.partyDetails.department	string	De afdeling waartoe de gebruiker behoort.
Title	folder.envelopePartyPermissions.partyDetails.title	string	De functie van de gebruiker.
Actief	folder.envelopePartyPermissions.partyDetails.active	boolean	Geeft aan of de gebruiker of record actief is.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	De landinstelling voor de gebruiker.
Delen met afdeling	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Geeft aan of enveloppen worden gedeeld over de afdeling.
Kiescode	folder.envelopePartyPermissions.partyDetails.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Het mobiele telefoonnummer.
Statusfilter	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Een filter voor documentstatus.
Datumfilter	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Een filter voor documentdatum.
Beveiligde veldtoegang	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Hiermee wordt aangegeven of de gebruiker toegang heeft tot beveiligde velden.
Zijbalk uitvouwen	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Geeft aan of de zijbalk standaard is uitgevouwen.
Adv. E-mailvalidatie	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Geeft aan of geavanceerde e-mailvalidatie is ingeschakeld.
Manager-id	folder.envelopePartyPermissions.partyDetails.managerId	string	De unieke id van de manager van de gebruiker.
Aantal aanmeldingen	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Het aantal keren dat de gebruiker zich heeft aangemeld.
E-mail opnieuw instellen van wachtwoord	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Hiermee wordt aangegeven of een e-mail voor het opnieuw instellen van een wachtwoord moet worden verzonden.
Afdelings-id	folder.envelopePartyPermissions.partyDetails.departmentId	string	De unieke id van de afdeling.
Primair bedrijf	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Het primaire bedrijf dat is gekoppeld aan de gebruiker.
Apparaattype	folder.envelopePartyPermissions.partyDetails.deviceType	string	Het type apparaat dat wordt gebruikt.
Apparaattoken	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Het pushmeldingstoken voor het apparaat.
Beschrijving van onderaannemer	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Een beschrijving van de onderaannemer of externe ondertekenaar.
Onderaannemerorganisatie	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	De naam van de organisatie van de onderaannemer of externe ondertekenaar.
Datum van onderaannemer toegevoegd	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	De datum waarop de onderaannemer werd toegevoegd (Unix-tijdstempel in milliseconden).
Bron	folder.envelopePartyPermissions.partyDetails.source	string	Het bronsysteem van waaruit de externe ondertekenaar is toegevoegd.
Kiescode	folder.envelopePartyPermissions.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.envelopePartyPermissions.mobileNumber	string	Het mobiele telefoonnummer.
Handtekeningtype	folder.envelopePartyPermissions.signerSignatureType	string	Het type handtekening dat de ondertekenaar gebruikt.
toestemmingen	folder.envelopePartyPermissions.contractPermissions	string	De machtigingen die aan deze partij zijn verleend voor het contract.
Ondertekeningsorder	folder.envelopePartyPermissions.partySequence	integer	Het volgnummer voor de ondertekeningsvolgorde voor deze geadresseerde.
Werkstroomvolgorde	folder.envelopePartyPermissions.workflowSignSequence	integer	Het volgnummer van de werkstroomondertekening.
Envelop-id	folder.envelopePartyPermissions.envelopeId	integer	De unieke id van de envelop.
Bedrijfs-id van geadresseerde	folder.envelopePartyPermissions.partyCompanyId	integer	De unieke id van het bedrijf dat aan deze ontvanger is gekoppeld.
Deelmodus	folder.envelopePartyPermissions.sharingMode	string	De deelmodus voor deze envelop.
URL voor toegang van geadresseerden	folder.envelopePartyPermissions.folderAccessURL	string	De URL die de ontvanger kan gebruiken om de envelop te openen en te ondertekenen.
Beveiligingsmodus	folder.envelopePartyPermissions.securityMode	string	De beveiligingsmodus die op deze envelop wordt toegepast.
Comments	folder.envelopePartyPermissions.extraComments	string	Aanvullende opmerkingen bij de envelop.
Naamwijziging toestaan	folder.envelopePartyPermissions.allowNameChange	boolean	Hiermee wordt aangegeven of de geadresseerde zijn of haar naam mag bijwerken.
Naam bijgewerkt	folder.envelopePartyPermissions.signerNameUpdated	boolean	Geeft aan of de ondertekenaar zijn of haar naam heeft bijgewerkt.
Verificatieniveau ondertekenaar	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de ondertekenaar.
Toegangscode	folder.envelopePartyPermissions.userDefinedAccessCode	string	Een aangepaste toegangscode die is gedefinieerd voor de ondertekenaar.
Handtekening-id	folder.envelopePartyPermissions.signatureId	string	De unieke id van de handtekening.
Rol van geadresseerde	folder.envelopePartyPermissions.partyRole	string	De rol die is toegewezen aan deze ontvanger in de werkstroom voor ondertekening.
Bedrijfsveld	folder.envelopePartyPermissions.companyFieldValue	string	De waarde van het veld bedrijfsnaam in de handtekening.
Titelveld	folder.envelopePartyPermissions.titleFieldValue	string	De waarde van het titelveld in de handtekening.
Reden voor ondertekening	folder.envelopePartyPermissions.reasonSigning	string	De reden waarom de ontvanger het document ondertekent.
Betalingsveld toegevoegd	folder.envelopePartyPermissions.payFieldAdded	boolean	Geeft aan of er een betalingsveld is toegevoegd.
Begunstigde	folder.envelopePartyPermissions.payee	boolean	Geeft aan of deze ontvanger de begunstigde is.
Terugkerende betaling	folder.envelopePartyPermissions.recurringFieldExist	boolean	Hiermee wordt aangegeven of er een terugkerend betalingsveld bestaat.
Afdrukken en ondertekenen voltooid	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Geeft aan of het proces voor afdrukken en ondertekenen is voltooid.
Paid	folder.envelopePartyPermissions.paid	boolean	Geeft aan of de betaling is voltooid.
Verificatieniveau	folder.envelopeAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de envelop.
Bulk voor eenmalige aanmelding	folder.allowSingleSignerInBulk	boolean	Hiermee wordt aangegeven of een eenmalige ondertekenaar is toegestaan in de modus voor bulksgewijs verzenden.
File-Based naamgeving	folder.folderNameBasedOnFileNaming	boolean	Geeft aan of de mapnaam is gebaseerd op de bestandsnaam.
Naam van document File-Based	folder.documentNameBasedOnFileNaming	boolean	Geeft aan of de documentnaam is gebaseerd op de bestandsnaam.
Certificaatnaam File-Based	folder.certificateNameBasedOnFileNaming	boolean	Geeft aan of de certificaatnaam is gebaseerd op de bestandsnaam.
Naamgeving van pre-exec-bestanden	folder.enableFileNamingBeforeExecution	boolean	Geeft aan of bestandsnaamgeving is ingeschakeld voordat het document wordt uitgevoerd.
Payee Added	folder.payeeAddedd	boolean	Geeft aan of er een beloning is toegevoegd.
Self-Signing ingeschakeld	folder.selfSignerEnabled	boolean	Hiermee wordt aangegeven of de modus voor zelfondertekening is ingeschakeld.
Notaris ingeschakeld	folder.notaryEnabled	boolean	Hiermee wordt aangegeven of notarisondertekening is ingeschakeld.
Beperkte zichtbaarheid	folder.limitedVisibilityFlag	boolean	Hiermee wordt aangegeven of beperkte zichtbaarheid is ingeschakeld voor deze envelop.
Zichtbaarheid na ondertekening	folder.postSigningVisibility	boolean	Geeft aan of zichtbaarheid na ondertekening is ingeschakeld.
Natte handtekening	folder.wetSignatureEnabled	boolean	Hiermee wordt aangegeven of natte handtekeningen zijn ingeschakeld.
Samenvoegen ingeschakeld	folder.mergeEnabled	boolean	Geeft aan of het samenvoegen van documenten is ingeschakeld.
Ingesloten ondertekeningssessies	embeddedSigningSessions	array of object	De lijst met ingesloten ondertekeningssessies, één per ontvanger. Alleen aanwezig wanneer createEmbeddedSigningSession waar is.
E-mailadres van ondertekenaar	embeddedSigningSessions.emailIdOfSigner	string	Het e-mailadres van de geadresseerde voor deze ingesloten ondertekeningssessie.
Token voor ondertekening	embeddedSigningSessions.embeddedToken	string	Het unieke token voor de ingesloten ondertekeningssessie van deze geadresseerde.
URL van ondertekeningssessie	embeddedSigningSessions.embeddedSessionURL	string	De URL voor het openen of insluiten van het document voor deze geadresseerde.
Ingesloten verzendtoken	embeddedToken	string	Het token voor de ingesloten verzendsessie. Alleen aanwezig wanneer createEmbeddedSendingSession waar is.
Sessie-URL verzenden	embeddedSessionURL	string	De URL voor het openen of insluiten van de auteur van de envelop om de envelop voor te bereiden en te verzenden. Alleen aanwezig wanneer createEmbeddedSendingSession waar is.
Result	result	string	Het resultaat van de bewerking.
Message	message	string	Een bericht met een beschrijving van het resultaat van de bewerking.

Envelop maken op sjabloon

Bewerkings-id:: CreateEnvelopefromTemplate

Hiermee maakt en verzendt u een envelop met behulp van een bestaande sjabloon. Details van geadresseerden kunnen worden aangepast.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelopnaam	folderName		string	Naam van de map(en) van het document. Als deze waarde niet is opgegeven, wordt de mapnaam van het document(en) hetzelfde bewaard als de naam(en) van de sjabloon(en).
Sjabloon-id's	templateIds	True	array of integer	Een matrix met sjabloon-id's die u wilt gebruiken om de documenten voor deze map te maken.
Velden	fields		object	U kunt de veldwaarden die in de sjablonen worden gebruikt, doorgeven om ze vooraf in te vullen in de documenten die op basis van de sjabloon zijn gemaakt. FIELD_NAME is de naam van het veld dat in de sjabloon wordt gebruikt. FIELD_VALUE is de waarde van het documentveld.
Geavanceerde e-mailvalidatie	allowAdvancedEmailValidation		boolean	Valideer de e-mailadressen van de partijen wanneer deze zijn ingesteld als waar.
Voornaam	firstName	True	string	De voornaam van de geadresseerde.
Achternaam	lastName	True	string	De achternaam van de geadresseerde.
E-mailadres	emailId	True	string	Het e-mailadres van de geadresseerde.
permissions	permission	True	string
Volgorde	sequence	True	integer	Gebruik dit veld om een volgnummer toe te wijzen aan een geadresseerde in de lijst met geadresseerden. Gebruik unieke volgnummers voor elke partij die begint met 1, zoals 1,2,3,4.... Als één persoon meerdere keren wordt weergegeven in de werkstroom voor ondertekening, wijst u telkens wanneer de geadresseerde wordt herhaald een andere volgorde toe.
signerAuthLevels	signerAuthLevel		string	Het verificatieniveau dat een ondertekenaar zal gebruiken voor verificatiedoeleinden
Is tijdelijke aanduiding	isPlaceholder		boolean	Gebruik dit veld om de partij te initiëren, is een tijdelijke aanduiding. Opmerking: 1. de waarde van de parameter firstName, lastName, emailId moet leeg zijn van deze partij. 2. Als u de tijdelijke aanduiding wilt toevoegen, moet één geadresseerde worden gevraagd met de machtiging 'PARTY_ASSIGNER'.
Rol van geadresseerde	partyRole		string	Gebruik dit veld om een rol van tijdelijke aanduiding toe te wijzen.
Naamwijziging toestaan	allowNameChange		string	Waarde kan waar of onwaar zijn. Gebruik deze parameter zodat ondertekenaar voor- en achternaam kan bijwerken voordat het ondertekeningsproces wordt voltooid.
Werkstroomvolgorde	workflowSequence		integer	Wijs een werkstroomreeksnummer toe aan deze geadresseerde. Wanneer aanmeldingsreeks is ingeschakeld, ontvangen geadresseerden hun uitnodiging voor ondertekening in oplopende volgorde.
E-mail-id host	hostEmailId		string	E-mailadres van In-Person beheerder.
Toegangscode	userDefinedAccessCode		string	De parameter bevat de toegangscode wanneer de waarde 'signerAuthLevel' is ingesteld als 'Door de gebruiker gedefinieerde toegangscode' voor verificatie. Opmerking: 1. Codes zijn niet hoofdlettergevoelig. 2. Het systeem verzendt deze code niet, dus u moet deze code rechtstreeks met de ondertekenaar delen. 3. De toegangscode kan alfabetten, cijfers en de volgende speciale tekens bevatten: @,&,{,}%,(,),~,\|,!,+,^.
Partij is e-mailgroep	partyIsEmailGroup		boolean	Gebruik deze parameter bij het maken van een partij als bulk. Opmerking: Als deze parameter waar is, worden firstName, lastName en emailId van deze partij genegeerd.
E-mailgroep-id	emailGroupId		integer	Geef de e-mail door met de groeps-id die u wilt gebruiken om bulksgewijs te maken.
Bulk voor eenmalige aanmelding	allowSingleSignerInBulk		boolean	Gebruik deze parameter om slechts één persoon toe te staan zich aan te melden bij een e-mailgroep.
Kiescode	dialingCode		string	Gebruik dit veld om een land inbelcodes toe te wijzen, zijn voorvoegsels voor mobiele nummers aan een geadresseerde in de lijst met geadresseerden.
Mobiel nummer	mobileNumber		string	Gebruik dit veld om een mobiel nummer toe te wijzen aan een geadresseerde in de lijst met geadresseerden.
Envelopwachtwoord	folderPassword		string	Dit wachtwoord is vereist door de ondertekenaar/auteur om het digitaal ondertekende document te openen. Als de parameter leeg blijft, is er geen wachtwoord vereist om het digitaal ondertekende document te openen.
Aanmeldingsvolgorde	signInSequence		boolean	Dit veld wordt gebruikt om te bepalen of geadresseerden de envelopdocumenten in een reeks ondertekenen. Als dit onwaar is, ontvangen alle geadresseerden tegelijk uitnodigingsmail. Wanneer waar, ontvangt elke geadresseerde achtereenvolgens een uitnodigingsmail nadat de vorige geadresseerde de vereiste taak heeft voltooid, zoals het ondertekenen van de documenten of het invullen van velden, enzovoort.
Persoonlijk inschakelen	inPersonEnable		boolean	Dit veld wordt gebruikt voor het initiëren van het ondertekeningsproces van personen, dat in enkele minuten eenvoudig kan worden voltooid op elk apparaat en voorkomt waar nodig e-mailhandtekeningen. Als dit onwaar is, ontvangen alle geadresseerden tegelijkertijd de uitnodigingsmail. Wanneer waar, ontvangt de beheerder van de persoon een uitnodiging per e-mail om het ondertekeningsproces voor de ondertekenaar te initiëren.
Nu verzenden	sendNow		boolean	Wanneer deze optie is ingeschakeld, verzendt Foxit eSign onmiddellijk een unieke ondertekeningskoppeling naar het e-mailadres van elke geadresseerde. Schakel dit uit om de envelop op te slaan als concept.
Geslaagde URL ondertekenen alle partijen	signSuccessUrlAllParties		boolean	Als deze optie is ingesteld op true, wordt de ondertekenaar omgeleid naar de URL die is opgegeven in signSuccessUrl na het ondertekenen. Dit is alleen van toepassing wanneer sendNow waar is.
Ingesloten verzendsessie maken	createEmbeddedSendingSession		boolean	Als deze optie is ingesteld op true, wordt er een ingesloten URL gegenereerd om de documentvoorbereidingsweergave van Foxit eSign te openen.
Geadresseerden herstellen	fixRecipientParties		boolean	Indien waar, dan kunnen in de ingesloten verzendweergave de partijen voor de envelop die al zijn toegevoegd als onderdeel van deze aanvraag, niet wijzigen.
Documenten herstellen	fixDocuments		boolean	Indien waar, kan in het ingesloten verzenden de documenten voor de envelop die al zijn toegevoegd als onderdeel van deze aanvraag, niet wijzigen.
Geslaagde URL verzenden	sendSuccessUrl		string	Voer de absolute URL in voor de landingspagina, waarnaar de ondertekenaar wordt omgeleid nadat de map is verzonden in de ingesloten verzendweergave.
Fout-URL verzenden	sendErrorUrl		string	Voer de absolute URL in voor de landingspagina, waarnaar de ondertekenaar wordt omgeleid als er een fout optreedt tijdens het verzenden van de map in de ingesloten verzendweergave.
Optie Voor het selecteren van ondertekenaar verbergen	hideSignerSelectOption		boolean	Indien waar, wordt het invoervak 'Bestaande ondertekenaarnaam/e-mail' verborgen voor geadresseerden in een ingesloten verzendsessie.
Ondertekenacties verbergen	hideSignerActions		boolean	Indien waar, wordt de ondertekenaar 'bewerken', 'wijzigen' en 'verwijderen' verborgen voor geadresseerden in een ingesloten verzendsessie.
Naam van afzender verbergen	hideSenderName		boolean	Indien waar, wordt de naam van de afzender verborgen voor geadresseerden in een ingesloten verzendsessie.
Knop Verzenden verbergen	hideSendButton		boolean	Indien waar, wordt de knop Verzenden verborgen in de ingesloten verzendsessie.
Mapnaam verbergen	hideFolderName		boolean	Indien waar, wordt de mapnaam verborgen in de navigatie in beide ingesloten sessies.
Naam van documenten verbergen	hideDocumentsName		boolean	Indien waar, wordt de documentnaam verborgen in beide ingesloten sessies.
Knop Mij toevoegen verbergen	hideAddMeButton		boolean	Indien waar, wordt de knop 'Mij toevoegen' verborgen op geadresseerden in een ingesloten verzendsessie.
Knop Nieuwe toevoegen verbergen	hideAddNewButton		boolean	Indien waar, wordt de knop 'Nieuwe toevoegen' verborgen op geadresseerden in een ingesloten verzendsessie.
Knop Groep toevoegen verbergen	hideAddGroupButton		boolean	Indien waar, wordt de knop Groep toevoegen verborgen op geadresseerden in een ingesloten verzendsessie.
Ingesloten ondertekeningssessie maken	createEmbeddedSigningSession		boolean	Het ondertekeningssessietoken wordt gegenereerd zonder e-mailberichten naar de geadresseerden te verzenden.
Ingesloten ondertekeningssessie maken voor alle partijen	createEmbeddedSigningSessionForAllParties		boolean	Als deze optie is ingesteld op waar, wordt er een ingesloten ondertekenings-URL gegenereerd voor elke geadresseerde in de envelop. Als dit onwaar is, ontvangen alleen geadresseerden die worden vermeld in ingesloten e-mail-id's een ingesloten sessie.
E-mail-id's voor ingesloten ondertekenaars	embeddedSignersEmailIds		array of string	Een matrix met e-mail-id's van geadresseerden waarvoor een ingesloten ondertekeningssessie moet worden gemaakt. De e-mail-id's van de geadresseerden die zijn toegevoegd aan de lijst met partijen.
Url voor geslaagd ondertekenen	signSuccessUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid nadat ze zich hebben aangemeld in de ingesloten ondertekeningsweergave.
Afmeldings-URL	signDeclineUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als de ingesloten ondertekeningsweergave wordt geweigerd.
Aanmeldings-URL	signLaterUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als u ervoor kiest om u later aan te melden in de ingesloten ondertekeningsweergave.
Url voor tekenfout	signErrorUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als er een fout optreedt tijdens het ondertekenen van het document in de ingesloten ondertekeningsweergave.
Volgende vereist veld verbergen Btn	hideNextRequiredFieldBtn		boolean	Als deze optie is ingesteld op true, verbergt u de navigatieknop waarmee ondertekenaars naar het volgende vereiste veld worden verplaatst.
Themakleur	themeColor		string	Voer de CSS-waarde in om de themakleur in te stellen.
Weigeren om te ondertekenen verbergen	hideDeclineToSign		boolean	Als deze optie is ingesteld op waar, verbergt u de optie Weigeren tot ondertekenen op het ondertekeningsscherm.
Meer actie verbergen	hideMoreAction		boolean	Als deze optie is ingesteld op true, verbergt u de knop Meer acties in de verzendende en ondertekeningssessie. Heeft geen effect wanneer Verzenden nu waar is.
Optie Voor toevoegen van partijen verbergen	hideAddPartiesOption		boolean	Als deze optie is ingesteld op waar, verbergt u de optie om partijen toe te voegen in de modus Concept en Sjabloon maken.
Sessie verlopen	sessionExpire		boolean	Stel in op true om het verlopen van de ingesloten ondertekeningssessie te initiëren.
Vervaldatum	expiry		integer	Vereist als sessionExpire waar is. Voer de duur in milliseconden van de vervaldatum in voor de ingesloten ondertekeningssessie.
E-mail van afzender	senderEmail		string	voer een e-mail in van een andere gebruiker in uw account die wordt gebruikt voor het verzenden van deze documentmap naar de geadresseerden.
Nu verzenden en ingesloten ondertekeningssessie toestaan	allowSendNowAndEmbeddedSigningSession		boolean	Als deze optie is ingesteld op waar, verzendt Foxit eSign een e-mail met een handtekeninguitnodiging naar elke geadresseerde en genereert ook een ingesloten koppeling voor ondertekening voor geadresseerden waarvan de e-mail is opgenomen in Embedded Signer Email. Zowel de e-mail als de ingesloten koppeling zijn gelijktijdig actief.
Stap voor stap inschakelen	enableStepByStep		boolean	Als u stap voor stap actie wilt inschakelen in de ingesloten verzendsessie.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de bewerking is geslaagd (bijvoorbeeld 'geslaagd').
Message	message	string	Een beschrijving van het resultaat van de bewerking.
Ingesloten ondertekeningssessies	embeddedSigningSessions	array of object	De lijst met ingesloten ondertekeningssessies, één per ontvanger. Alleen aanwezig wanneer createEmbeddedSigningSession waar is.
E-mailadres van ondertekenaar	embeddedSigningSessions.emailIdOfSigner	string	Het e-mailadres van de geadresseerde voor deze ingesloten ondertekeningssessie.
Token voor ondertekening	embeddedSigningSessions.embeddedToken	string	Het unieke token voor de ingesloten ondertekeningssessie van deze geadresseerde.
URL van ondertekeningssessie	embeddedSigningSessions.embeddedSessionURL	string	De URL voor het openen of insluiten van het document voor deze geadresseerde.
Ingesloten verzendtoken	embeddedToken	string	Het token voor de ingesloten verzendsessie. Alleen aanwezig wanneer createEmbeddedSendingSession waar is.
Sessie-URL verzenden	embeddedSessionURL	string	De URL voor het openen of insluiten van de auteur van de envelop om de envelop voor te bereiden en te verzenden. Alleen aanwezig wanneer createEmbeddedSendingSession waar is.
Id	folder.folderId	integer	De unieke id van de gemaakte envelop. Gebruik deze om te verwijzen naar de envelop in volgende acties.
Naam	folder.folderName	string	De naam van de envelop.
Aangepaste naam	folder.folderCustomName	string	De aangepaste naam die aan de envelop is toegewezen.
Password	folder.folderPassword	string	Het wachtwoord dat is ingesteld voor de envelop, indien van toepassing.
Auteur-id	folder.folderAuthorId	integer	De unieke id van de gebruiker die de envelop heeft gemaakt.
Voornaam van auteur	folder.folderAuthorFirstName	string	De voornaam van de maker van de envelop.
Achternaam van auteur	folder.folderAuthorLastName	string	De achternaam van de maker van de envelop.
E-mail schrijven	folder.folderAuthorEmail	string	Het e-mailadres van de maker van de envelop.
Auteurrol	folder.folderAuthorRole	string	De accountrol van de maker van de envelop.
Bedrijfs-id	folder.folderCompanyId	integer	De unieke id van het bedrijf waartoe de envelop behoort.
Aanmaakdatum	folder.folderCreationDate	integer	De datum en tijd waarop de envelop is gemaakt, in Unix milliseconden.
Verzonden datum	folder.folderSentDate	integer	De datum en tijd waarop de envelop naar geadresseerden is verzonden, in Unix milliseconden.
Status	folder.folderStatus	string	De huidige status van de envelop (bijvoorbeeld GEDEELD, UITGEVOERD, CONCEPT, GEANNULEERD).
Aangepast veld 1	folder.custom_field1	string	De waarde van aangepast veld 1 ingesteld op de envelop.
Aangepast veld 2	folder.custom_field2	string	De waarde van aangepast veld 2 ingesteld op de envelop.
Metagegevens	folder.metadata	string	Aanvullende metagegevens die aan de envelop zijn gekoppeld.
Document-ID's	folder.folderDocumentIds	array of integer	De lijst met document-id's die zijn opgenomen in deze envelop.
Documents	folder.documentsList	array of object	Details van elk document in de envelop.
Document-ID	folder.documentsList.documentId	integer	De unieke identificatie van het document.
Contract-id	folder.documentsList.contractId	integer	De unieke id van het contract dat aan dit document is gekoppeld.
Bedrijfs-id	folder.documentsList.companyId	integer	De unieke id van het bedrijf waartoe dit document behoort.
Gemaakt door	folder.documentsList.contractCreatedBy	integer	De gebruikers-id van de persoon die het contract heeft gemaakt.
Gemaakt op	folder.documentsList.contractCreatedOn	string	De datum waarop het contract is gemaakt.
Contractsoort	folder.documentsList.contractType	string	Het type contract.
Documentstatus	folder.documentsList.contractStatus	string	De huidige ondertekeningsstatus van het document (bijvoorbeeld WAITING_FOR_SIGNATURE, EXECUTED).
Aanpasbaar	folder.documentsList.editable	boolean	Geeft aan of het document kan worden bewerkt.
Versie-id	folder.documentsList.contractVersionId	integer	De unieke id van de huidige documentversie.
Versienaam	folder.documentsList.contractVersionName	string	De naam van de huidige documentversie.
Versiebeschrijving	folder.documentsList.contractVersionDesc	string	Een beschrijving van de huidige documentversie.
Versie gemaakt door	folder.documentsList.versionCreatedby	integer	De gebruikers-id van de persoon die deze documentversie heeft gemaakt.
Versie gemaakt op	folder.documentsList.versionCreatedOn	string	De datum waarop deze documentversie is gemaakt.
Versienummer	folder.documentsList.contractVersionNumber	integer	Het versienummer van het document.
Transactiebron	folder.documentsList.contractTransactionSource	string	De bron van de contracttransactie.
Ontvangers	folder.folderRecipientParties	array of object	De lijst met geadresseerden voor deze envelop, inclusief hun afzonderlijke ondertekeningskoppelingen.
Ontvanger-id	folder.folderRecipientParties.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	folder.folderRecipientParties.partyDetails.partyId	integer	De unieke id van de ontvanger.
Voornaam	folder.folderRecipientParties.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	folder.folderRecipientParties.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailen	folder.folderRecipientParties.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
Is tijdelijke aanduiding	folder.folderRecipientParties.partyDetails.placeholder	boolean	Hiermee wordt aangegeven of deze geadresseerde een tijdelijke aanduiding is.
Address	folder.folderRecipientParties.partyDetails.address	string	Het adres van de geadresseerde.
Account gemaakt op	folder.folderRecipientParties.partyDetails.dateCreated	integer	De datum waarop het account van de ontvanger is gemaakt, in Unix milliseconden.
Afmelden voor e-mailberichten	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Hiermee wordt aangegeven of de geadresseerde zich heeft afgemeld voor e-mailmeldingen.
Unieke partij-id	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Een unieke tekenreeks-id voor de ontvanger.
Verificatieniveau	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Het verificatieniveau dat is vereist voor deze geadresseerde.
Bedrijfs-id	folder.folderRecipientParties.partyDetails.companyId	integer	De id van het bedrijf waartoe de ontvanger behoort.
Gebruikersrol	folder.folderRecipientParties.partyDetails.userRole	string	De rol van de ontvanger binnen hun organisatie.
Afdeling	folder.folderRecipientParties.partyDetails.department	string	De afdeling van de ontvanger.
Title	folder.folderRecipientParties.partyDetails.title	string	De functie van de ontvanger.
Actief	folder.folderRecipientParties.partyDetails.active	boolean	Geeft aan of het account van de geadresseerde actief is.
Kiescode	folder.folderRecipientParties.partyDetails.dialingCode	string	De landkiescode voor het telefoonnummer van de ontvanger.
Mobiel nummer	folder.folderRecipientParties.partyDetails.mobileNumber	string	Het mobiele telefoonnummer van de ontvanger.
Beschrijving van onderaannemer	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Een beschrijving van de onderaannemer, indien van toepassing.
Onderaannemerorganisatie	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	De naam van de onderaannemer, indien van toepassing.
Datum van onderaannemer toegevoegd	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	De datum waarop de onderaannemer werd toegevoegd, in Unix milliseconden.
Bron	folder.folderRecipientParties.partyDetails.source	string	De bron waarmee de geadresseerde is toegevoegd.
Kiescode	folder.folderRecipientParties.dialingCode	string	De landkiescode voor het mobiele nummer van de ontvanger.
Mobiel nummer	folder.folderRecipientParties.mobileNumber	string	Het mobiele nummer van de ontvanger.
Handtekeningtype	folder.folderRecipientParties.signerSignatureType	string	Het type handtekening dat is toegestaan voor deze geadresseerde.
toestemmingen	folder.folderRecipientParties.contractPermissions	string	De ondertekeningsmachtigingen die aan deze geadresseerde zijn verleend (bijvoorbeeld FILL_FIELDS_AND_SIGN).
Ondertekeningsorder	folder.folderRecipientParties.partySequence	integer	De positie van deze ontvanger in de ondertekeningsorder.
Werkstroomvolgorde	folder.folderRecipientParties.workflowSignSequence	integer	Het volgnummer van de werkstroomondertekening voor deze geadresseerde.
Envelop-id	folder.folderRecipientParties.envelopeId	integer	De id van de envelop waartoe deze geadresseerde behoort.
Bedrijfs-id van partij	folder.folderRecipientParties.partyCompanyId	integer	De id van het bedrijf waartoe deze ontvanger behoort.
Deelmodus	folder.folderRecipientParties.sharingMode	string	De methode die wordt gebruikt om het document te delen met deze geadresseerde (bijvoorbeeld e-mail).
Ondertekenings-URL	folder.folderRecipientParties.folderAccessURL	string	De unieke ondertekenings-URL voor deze geadresseerde. Gebruik deze optie om de koppeling voor ondertekening rechtstreeks te delen.
Beveiligingsmodus	folder.folderRecipientParties.securityMode	string	De beveiligingsmodus die is toegepast op de toegang van deze geadresseerde.
Extra opmerkingen	folder.folderRecipientParties.extraComments	string	Eventuele aanvullende opmerkingen die zijn opgenomen in de ondertekeningsuitnodiging voor deze geadresseerde.
Naamwijziging toestaan	folder.folderRecipientParties.allowNameChange	boolean	Hiermee wordt aangegeven of de geadresseerde zijn of haar naam mag wijzigen voordat deze wordt ondertekend.
Naam bijgewerkt	folder.folderRecipientParties.signerNameUpdated	boolean	Geeft aan of de geadresseerde de weergavenaam heeft bijgewerkt.
Verificatieniveau	folder.folderRecipientParties.signerAuthenticationLevel	string	De verificatiemethode die is vereist voor deze ontvanger voor toegang tot het document.
Toegangscode	folder.folderRecipientParties.userDefinedAccessCode	string	Een aangepaste toegangscode die is vereist voor deze geadresseerde om het document te openen.
Handtekening-id	folder.folderRecipientParties.signatureId	string	De id van de opgeslagen handtekening die door deze geadresseerde wordt gebruikt.
Rol van geadresseerde	folder.folderRecipientParties.partyRole	string	De rol die is toegewezen aan deze ontvanger in de envelop.
Waarde van bedrijfsveld	folder.folderRecipientParties.companyFieldValue	string	De waarde van het bedrijfsveld vooraf ingevuld voor deze geadresseerde.
Waarde van titelveld	folder.folderRecipientParties.titleFieldValue	string	De waarde van het titelveld vooraf ingevuld voor deze geadresseerde.
Reden voor ondertekening	folder.folderRecipientParties.reasonSigning	string	De reden voor ondertekening die door deze geadresseerde is verstrekt.
Betaald veld toegevoegd	folder.folderRecipientParties.payFieldAdded	boolean	Hiermee wordt aangegeven of er een betalingsveld is toegevoegd voor deze geadresseerde.
Is Payee	folder.folderRecipientParties.payee	boolean	Geeft aan of deze ontvanger een begunstigde is.
Terugkerend veld bestaat	folder.folderRecipientParties.recurringFieldExist	boolean	Hiermee wordt aangegeven of er terugkerende betalingsvelden bestaan voor deze geadresseerde.
Afdrukken en ondertekenen voltooid	folder.folderRecipientParties.printAndSignCompleted	boolean	Hiermee wordt aangegeven of de geadresseerde een afdruk- en tekenactie heeft voltooid.
Optionele ondertekenaar toestaan	folder.folderRecipientParties.allowOptionalSigner	boolean	Hiermee wordt aangegeven of deze geadresseerde kan worden overgeslagen als een optionele ondertekenaar.
Optionele ondertekenaars	folder.folderRecipientParties.optionalSigners	string	De lijst met optionele ondertekenaars die aan deze geadresseerde zijn gekoppeld, indien van toepassing.
Paid	folder.folderRecipientParties.paid	boolean	Hiermee wordt aangegeven of deze ontvanger de betaling heeft voltooid.
URL voor auteurtoegang	folder.folderAccessURLForAuthor	string	De URL voor de auteur van de envelop voor toegang tot het document.
Concepttoegangs-URL	folder.draftFolderAccessURL	string	De URL voor toegang tot de envelop terwijl deze de conceptstatus heeft.
Bordkamerbord	folder.boardRoomSign	boolean	Hiermee wordt aangegeven of ondertekening van de vergaderruimte is ingeschakeld voor deze envelop.
Logo opnemen	folder.includeLogo	boolean	Geeft aan of het bedrijfslogo is opgenomen in e-mailmeldingen.
Kleur van e-mailknop	folder.email_btnBgColor	string	De achtergrondkleur van de actieknop in het ondertekeningsbericht.
Tekstkleur van e-mailknop	folder.email_btnTxtColor	string	De tekstkleur van de actieknop in de e-mail voor ondertekening.
E-maillogo	folder.emailTemplateLogo	string	De logoafbeelding die wordt gebruikt in de e-mailsjabloon.
E-mailsjabloon-id	folder.emailTemplateId	integer	De id van de e-mailsjabloon die wordt gebruikt voor ondertekeningsmeldingen.
E-mailkoptekst	folder.emailHeader	string	De aangepaste koptekst in e-mailberichten voor ondertekeningsmeldingen.
E-mailvoettekst	folder.emailFooter	string	De aangepaste voettekst in e-mailberichten voor ondertekeningsmeldingen.
Geplande opschoning	folder.purgeFlag	boolean	Geeft aan of deze envelop is gepland voor automatisch opschonen.
Begindatum opschonen	folder.purgeStartDate	string	De datum van waaruit de opschoonperiode begint.
Einddatum opschonen	folder.purgeEndDate	string	De datum waarop de envelop wordt opgeschoond.
Bulk-id	folder.bulkId	integer	De id van de bulksgewijs verzenden batch waartoe deze envelop behoort, indien van toepassing.
Handtekeningvolgorde afdwingen	folder.enforceSignWorkflow	boolean	Hiermee wordt aangegeven of geadresseerden zich moeten aanmelden bij de opgegeven volgorde.
Huidige werkstroomstap	folder.currentWorkflowStep	integer	De huidige stap in de werkstroom voor ondertekening.
Transactiebron	folder.transactionSource	string	De bron waarmee deze enveloptransactie is gestart.
Aanpasbaar	folder.editable	boolean	Hiermee wordt aangegeven of de envelop nog steeds kan worden bewerkt.
In-Person ondertekenen	folder.inPersonSignable	boolean	Hiermee wordt aangegeven of de envelop persoonlijk kan worden aangemeld.
Herinneringen overschrijven	folder.overrideAccountReminders	boolean	Hiermee wordt aangegeven of herinneringsinstellingen op accountniveau worden overschreven voor deze envelop.
Overdracht overschrijven	folder.overrideAccountRecipientDelegation	boolean	Hiermee wordt aangegeven of de delegatie-instellingen op accountniveau worden overschreven voor deze envelop.
Delegatie toestaan	folder.allowRecipientsToDelegate	boolean	Hiermee wordt aangegeven of geadresseerden hun ondertekening mogen delegeren aan een andere persoon.
Id	folder.envelopeId	integer	De unieke id van de envelop. Dezelfde waarde als Envelop-id (folderId).
Naam	folder.envelopeName	string	De naam van de envelop. Dezelfde waarde als Envelopnaam (folderName).
Originator-id	folder.envelopeOriginatorId	integer	De gebruikers-id van de persoon die de envelop heeft gemaakt.
Bedrijfs-id	folder.envelopeCompanyId	integer	De id van het bedrijf waartoe de envelop behoort.
Date	folder.envelopeDate	integer	De datum en tijd waarop de envelop is gemaakt, in Unix milliseconden.
Gedeelde datum	folder.envelopeSharedDate	integer	De datum en tijd waarop de envelop is gedeeld met geadresseerden, in Unix milliseconden.
Status	folder.envelopeStatus	string	De huidige status van de envelop. Dezelfde waarde als Envelopstatus (folderStatus).
Contract-id's	folder.envelopeContractIds	array of integer	De lijst met contract-id's die aan deze envelop zijn gekoppeld.
Machtigingen van derden	folder.envelopePartyPermissions	array of object	De lijst met geadresseerden en hun ondertekeningsmachtigingen. Dezelfde structuur als ontvangers.
Ontvanger-id	folder.envelopePartyPermissions.partyId	integer	De unieke id van de ontvanger.
Ondertekenings-URL	folder.envelopePartyPermissions.folderAccessURL	string	De unieke ondertekenings-URL voor deze geadresseerde.
toestemmingen	folder.envelopePartyPermissions.contractPermissions	string	De ondertekeningsmachtigingen voor deze geadresseerde.
Ondertekeningsorder	folder.envelopePartyPermissions.partySequence	integer	De positie van deze ontvanger in de ondertekeningsorder.
Verificatieniveau	folder.envelopeAuthenticationLevel	string	Het verificatieniveau dat is toegepast op de hele envelop.
Bulk van eenmalige aanmelding toestaan	folder.allowSingleSignerInBulk	boolean	Hiermee wordt aangegeven of een eenmalige ondertekenaar is toegestaan in de modus voor bulksgewijs verzenden.
Naam op basis van bestand	folder.folderNameBasedOnFileNaming	boolean	Geeft aan of de envelopnaam is afgeleid van de bestandsnaam.
Documentnaam op basis van bestand	folder.documentNameBasedOnFileNaming	boolean	Geeft aan of de documentnaam is afgeleid van de bestandsnaam.
Certificaatnaam op basis van bestand	folder.certificateNameBasedOnFileNaming	boolean	Geeft aan of de certificaatnaam is afgeleid van de bestandsnaam.
Bestandsnaamgeving inschakelen	folder.enableFileNamingBeforeExecution	boolean	Geeft aan of bestandsnaam wordt gevraagd voordat de envelop wordt verzonden.
Payee Added	folder.payeeAddedd	boolean	Hiermee wordt aangegeven of een betaler is toegevoegd aan de envelop.
Zelfondertekening	folder.selfSignerEnabled	boolean	Hiermee wordt aangegeven of de afzender ook een ondertekenaar op deze envelop is.
Notaris ingeschakeld	folder.notaryEnabled	boolean	Geeft aan of notarisatie is ingeschakeld voor deze envelop.
Beperkte zichtbaarheid	folder.limitedVisibilityFlag	boolean	Hiermee wordt aangegeven of beperkte zichtbaarheid van documenten is ingeschakeld.
Zichtbaarheid na ondertekening	folder.postSigningVisibility	boolean	Geeft aan of geadresseerden het ondertekende document na voltooiing kunnen bekijken.
Wet Signature ingeschakeld	folder.wetSignatureEnabled	boolean	Hiermee wordt aangegeven of natte (handgeschreven) handtekeningen zijn ingeschakeld voor deze envelop.
Samenvoegen ingeschakeld	folder.mergeEnabled	boolean	Hiermee wordt aangegeven of het samenvoegen van documenten is ingeschakeld voor deze envelop.

Envelop maken op url

Bewerkings-id:: CreateEnvelopefromURL

Hiermee maakt en verzendt u een envelop met openbaar toegankelijke PDF-URL's. Geef de document-URL's en de details van de geadresseerde op om het ondertekeningsproces te initiëren.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelopnaam	folderName	True	string	De naam van deze envelop.
Invoertype	inputType		string	Hiermee geeft u de documentbronindeling op. Ingesteld op URL voor het opgeven van bestands-URL's of base64 voor het leveren van met Base64 gecodeerde bestandsinhoud.
Bestands-URL's	fileUrls	True	array of string	Een matrix met openbaar toegankelijke URL's die verwijzen naar de documenten die aan deze envelop moeten worden toegevoegd.
Bestandsnamen	fileNames	True	array of string	Een matrix met weergavenamen voor elk document, in dezelfde volgorde als bestands-URL's.
Voornaam	firstName	True	string	De voornaam van de geadresseerde.
Achternaam	lastName	True	string	De achternaam van de geadresseerde.
E-mailadres	emailId	True	string	Het e-mailadres van de geadresseerde.
permissions	permission	True	string
Volgorde	sequence	True	integer	Gebruik dit veld om een volgnummer toe te wijzen aan een geadresseerde in de lijst met geadresseerden. Gebruik unieke volgnummers voor elke partij die begint met 1, zoals 1,2,3,4.... Als één persoon meerdere keren wordt weergegeven in de werkstroom voor ondertekening, wijst u telkens wanneer de geadresseerde wordt herhaald een andere volgorde toe.
signerAuthLevels	signerAuthLevel		string	Het verificatieniveau dat een ondertekenaar zal gebruiken voor verificatiedoeleinden
Is tijdelijke aanduiding	isPlaceholder		boolean	Gebruik dit veld om de partij te initiëren, is een tijdelijke aanduiding. Opmerking: 1. de waarde van de parameter firstName, lastName, emailId moet leeg zijn van deze partij. 2. Als u de tijdelijke aanduiding wilt toevoegen, moet één geadresseerde worden gevraagd met de machtiging 'PARTY_ASSIGNER'.
Rol van geadresseerde	partyRole		string	Gebruik dit veld om een rol van tijdelijke aanduiding toe te wijzen.
Naamwijziging toestaan	allowNameChange		string	Waarde kan waar of onwaar zijn. Gebruik deze parameter zodat ondertekenaar voor- en achternaam kan bijwerken voordat het ondertekeningsproces wordt voltooid.
Werkstroomvolgorde	workflowSequence		integer	Wijs een werkstroomreeksnummer toe aan deze geadresseerde. Wanneer aanmeldingsreeks is ingeschakeld, ontvangen geadresseerden hun uitnodiging voor ondertekening in oplopende volgorde.
E-mail-id host	hostEmailId		string	E-mailadres van In-Person beheerder.
Toegangscode	userDefinedAccessCode		string	De parameter bevat de toegangscode wanneer de waarde 'signerAuthLevel' is ingesteld als 'Door de gebruiker gedefinieerde toegangscode' voor verificatie. Opmerking: 1. Codes zijn niet hoofdlettergevoelig. 2. Het systeem verzendt deze code niet, dus u moet deze code rechtstreeks met de ondertekenaar delen. 3. De toegangscode kan alfabetten, cijfers en de volgende speciale tekens bevatten: @,&,{,}%,(,),~,\|,!,+,^.
Partij is e-mailgroep	partyIsEmailGroup		boolean	Gebruik deze parameter bij het maken van een partij als bulk. Opmerking: Als deze parameter waar is, worden firstName, lastName en emailId van deze partij genegeerd.
E-mailgroep-id	emailGroupId		integer	Geef de e-mail door met de groeps-id die u wilt gebruiken om bulksgewijs te maken.
Bulk voor eenmalige aanmelding	allowSingleSignerInBulk		boolean	Gebruik deze parameter om slechts één persoon toe te staan zich aan te melden bij een e-mailgroep.
Kiescode	dialingCode		string	Gebruik dit veld om een land inbelcodes toe te wijzen, zijn voorvoegsels voor mobiele nummers aan een geadresseerde in de lijst met geadresseerden.
Mobiel nummer	mobileNumber		string	Gebruik dit veld om een mobiel nummer toe te wijzen aan een geadresseerde in de lijst met geadresseerden.
Velden	Fields		object
Nu verzenden	sendNow		boolean	Wanneer deze optie is ingeschakeld, verzendt Foxit eSign onmiddellijk een unieke ondertekeningskoppeling naar het e-mailadres van elke geadresseerde. Schakel dit uit om de envelop op te slaan als concept.
Ingesloten ondertekeningssessie maken	createEmbeddedSigningSession	True	boolean	Het ondertekeningssessietoken wordt gegenereerd zonder e-mailberichten naar de geadresseerden te verzenden.
Ingesloten ondertekeningssessie maken voor alle partijen	createEmbeddedSigningSessionForAllParties		boolean	Als deze optie is ingesteld op true, wordt er een ingesloten ondertekenings-URL gegenereerd voor elke geadresseerde in de envelop.
Teksttags verwerken	processTextTags	True	boolean	De waarde kan waar of onwaar zijn. Dit veld wordt gebruikt om te bepalen of Foxit eSign de documenten voor tekstlabels moet parseren om ze te converteren naar Foxit eSign-velden.
Acrovelden verwerken	processAcroFields	True	boolean	Dit veld wordt gebruikt om te bepalen of Foxit eSign de documenten voor AcroFields moet parseren om ze te converteren naar Foxit eSign-velden.
Aanmeldingsvolgorde	signInSequence		boolean	Dit veld wordt gebruikt om te bepalen of geadresseerden de envelopdocumenten in een reeks ondertekenen. Als dit onwaar is, ontvangen alle geadresseerden tegelijk uitnodigingsmail. Wanneer waar, ontvangt elke geadresseerde achtereenvolgens een uitnodigingsmail nadat de vorige geadresseerde de vereiste taak heeft voltooid, zoals het ondertekenen van de documenten of het invullen van velden, enzovoort.
Persoonlijk inschakelen	inPersonEnable		boolean	Dit veld wordt gebruikt voor het initiëren van het ondertekeningsproces van personen, dat in enkele minuten eenvoudig kan worden voltooid op elk apparaat en voorkomt waar nodig e-mailhandtekeningen. Als dit onwaar is, ontvangen alle geadresseerden tegelijkertijd de uitnodigingsmail. Wanneer waar, ontvangt de beheerder van de persoon een uitnodiging per e-mail om het ondertekeningsproces voor de ondertekenaar te initiëren.
Geadresseerden herstellen	fixRecipientParties		boolean	Indien waar, dan kunnen in de ingesloten verzendweergave de partijen voor de envelop die al zijn toegevoegd als onderdeel van deze aanvraag, niet wijzigen.
Documenten herstellen	fixDocuments		boolean	Indien waar, kan in het ingesloten verzenden de documenten voor de envelop die al zijn toegevoegd als onderdeel van deze aanvraag, niet wijzigen.
Geslaagde URL verzenden	sendSuccessUrl		string	Voer de absolute URL in voor de landingspagina, waarnaar de ondertekenaar wordt omgeleid nadat de map is verzonden in de ingesloten verzendweergave.
Fout-URL verzenden	sendErrorUrl		string	Voer de absolute URL in voor de landingspagina, waarnaar de ondertekenaar wordt omgeleid als er een fout optreedt tijdens het verzenden van de map in de ingesloten verzendweergave.
Ingesloten verzendsessie maken	createEmbeddedSendingSession		boolean	Als deze optie is ingesteld op true, wordt er een ingesloten token gegenereerd om de documentvoorbereidingsweergave van Foxit eSign te openen.
E-mail-id's voor ingesloten ondertekenaars	embeddedSignersEmailIds		array of string	Een matrix met e-mail-id's van geadresseerden waarvoor een ingesloten ondertekeningssessie moet worden gemaakt. De e-mail-id's van de geadresseerden die zijn toegevoegd aan de lijst met partijen.
Url voor geslaagd ondertekenen	signSuccessUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid nadat ze zich hebben aangemeld in de ingesloten ondertekeningsweergave.
Afmeldings-URL	signDeclineUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als de ingesloten ondertekeningsweergave wordt geweigerd.
Aanmeldings-URL	signLaterUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als u ervoor kiest om u later aan te melden in de ingesloten ondertekeningsweergave.
Url voor tekenfout	signErrorUrl		string	Voer de absolute URL in voor de ondertekenaars waarnaar wordt omgeleid als er een fout optreedt tijdens het ondertekenen van het document in de ingesloten ondertekeningsweergave.
Nu verzenden en ingesloten ondertekeningssessie toestaan	allowSendNowAndEmbeddedSigningSession		boolean	Als deze optie is ingesteld als waar, verzendt Foxit eSign een unieke ondertekeningskoppeling naar elke geadresseerde. Dit is ALLEEN van toepassing wanneer parameters sendNow en createEmbeddedSigningSession waar zijn.
Geavanceerde e-mailvalidatie	allowAdvancedEmailValidation		boolean	Valideer het e-mailadres van de partijen wanneer deze is ingesteld als waar.
Geslaagde URL ondertekenen alle partijen	signSuccessUrlAllParties		boolean	Als deze optie is ingesteld op true, wordt de ondertekenaar omgeleid naar de URL die is opgegeven in signSuccessUrl na het ondertekenen. Dit is alleen van toepassing wanneer sendNow waar is.
E-mailsjabloon-id	emailTemplateId		integer	Geef de e-mailsjabloon-id door om andere e-mailsjablonen dan standaard-e-mailsjablonen te verzenden.
Instructie-id voor ondertekenaar	signerInstructionId		integer	Geef de instructie-id door om andere instructies voor ondertekenaar te verzenden dan de standaardinstructies voor ondertekenaar.
Bevestigingsinstructie-id	confirmationInstructionId		string	Geef de bevestigingsinstructie-id door om andere bevestigingsinstructies dan de standaardbevestigingsinstructies te verzenden.
Themakleur	themeColor		string	Voer de CSS-waarde in om de themakleur in te stellen.
Sessie verlopen	sessionExpire		boolean	Stel in op true om het verlopen van de ingesloten ondertekeningssessie te initiëren.
Vervaldatum	expiry		integer	Vereist als sessionExpire waar is. Voer de duur in milliseconden van de vervaldatum in voor de ingesloten ondertekeningssessie.
Naam van afhankelijk veld	dependentFieldName	True	string	De naam van het veld waarvan de zichtbaarheid wordt bepaald door het bovenliggende veld.
Naam van bovenliggend veld	parentFieldName	True	string	De naam van het bovenliggende veld waarvan de waarde de zichtbaarheid van het afhankelijke veld bepaalt. Ondersteunde bovenliggende veldtypen: tekstveld, tekstvak, selectievakje, keuzerondje, vervolgkeuzelijst.
Waarde van bovenliggend veld	parentFieldValue	True	string	De waarde van het bovenliggende veld dat het afhankelijke veld activeert om zichtbaar te worden. Gebruik ingeschakeld of uitgeschakeld voor velden met selectievakjes en keuzerondjes.
Opties	options	True	string	Aanvullende overeenkomende opties voor bovenliggende velden op basis van tekst. Geaccepteerde waarden: isblank, allowNull, contains.
Metagegevens	metadata		object	Dit moet een sleutel-waardepaar zijn. Maximaal 1000 sleutelwaardeparen zijn toegestaan.
E-mail van afzender	senderEmail		string	voer een e-mail in van een andere gebruiker in uw account die wordt gebruikt voor het verzenden van deze documentmap naar de geadresseerden.
Knop Mij toevoegen verbergen	hideAddMeButton		boolean	Indien waar, wordt de knop 'Mij toevoegen' verborgen op geadresseerden in een ingesloten verzendsessie.
Knop Nieuwe toevoegen verbergen	hideAddNewButton		boolean	Indien waar, wordt de knop 'Nieuwe toevoegen' verborgen op geadresseerden in een ingesloten verzendsessie.
Knop Groep toevoegen verbergen	hideAddGroupButton		boolean	Indien waar, wordt de knop Groep toevoegen verborgen op geadresseerden in een ingesloten verzendsessie.
Veldnaam voor geadresseerden verbergen	hideFieldNameForRecipients		boolean	Veldnamen verbergen voor ontvangers voor gegevensinvoervelden en geavanceerde velden. (Behalve keuzerondje, selectievakje, afbeelding en hyperlink).
Selectievakjerand verbergen	hideCheckboxBorder		boolean	Randen van selectievakje worden verborgen in de uitgevoerde documenten.
Optie Voor het selecteren van ondertekenaar verbergen	hideSignerSelectOption		boolean	Indien waar, wordt het invoervak 'Bestaande ondertekenaarnaam/e-mail' verborgen voor geadresseerden in een ingesloten verzendsessie.
Ondertekenacties verbergen	hideSignerActions		boolean	Indien waar, wordt de ondertekenaar 'bewerken', 'wijzigen' en 'verwijderen' verborgen voor geadresseerden in een ingesloten verzendsessie.
Naam van afzender verbergen	hideSenderName		boolean	Indien waar, wordt de naam van de afzender verborgen voor geadresseerden in een ingesloten verzendsessie.
Mapnaam verbergen	hideFolderName		boolean	Indien waar, wordt de mapnaam verborgen in de navigatie in beide ingesloten sessies.
Naam van documenten verbergen	hideDocumentsName		boolean	Indien waar, wordt de documentnaam verborgen in beide ingesloten sessies.
Weigeren om te ondertekenen verbergen	hideDeclineToSign		boolean	Indien waar, wordt de optie 'Weigeren om te ondertekenen' voor de ondertekenaar verborgen.
Meer actie verbergen	hideMoreAction		boolean	Indien waar, wordt de knop 'Meer acties' verborgen in het verzenden/ondertekenen van een sessie. In het geval van 'Nu verzenden': waar, wordt er niets verborgen.
Knop Verzenden verbergen	hideSendButton		boolean	Indien waar, wordt de knop Verzenden verborgen in de ingesloten verzendsessie.
Volgende vereiste veldbtn verbergen	hideNextRequiredFieldbtn		boolean	Als deze optie is ingesteld op true, verbergt u de navigatieknop waarmee ondertekenaars naar het volgende vereiste veld worden verplaatst.
Beide ingesloten sessies vereist	requiredBothEmbeddedSession		boolean	Indien waar, worden de ingesloten verzend- en ondertekenings-URL's samen gegenereerd.
Envelopwachtwoord	folderPassword		string	Dit wachtwoord is vereist door de ondertekenaar/auteur om het digitaal ondertekende document te openen. Als de parameter leeg blijft, is er geen wachtwoord vereist om het digitaal ondertekende document te openen.
Stap voor stap inschakelen	enableStepByStep		boolean	Als u stap voor stap actie wilt inschakelen in de ingesloten verzendsessie.
Optie Voor toevoegen van partijen verbergen	hideAddPartiesOption		boolean	Indien waar, wordt de optie voor het toevoegen van partijen verborgen in de modus Concept en Sjabloon maken.
Zelfteken	selfSign		boolean	Het maakt ingesloten self sign via API's mogelijk. Deze parameter is alleen van toepassing wanneer de parameter createEmbeddedSendingSession waar is.
Url voor geslaagde zelfondertekening	selfSignerSuccessUrl		string	Voer de absolute URL in voor de landingspagina op uw website/toepassing, waarnaar de gebruiker wordt omgeleid nadat de map is verzonden in de ingesloten verzendweergave.

Retouren

Name	Pad	Type	Description
Id	folder.folderId	integer	De unieke id van de zojuist gemaakte envelop. Gebruik dit in volgende acties om naar deze envelop te verwijzen.
Naam	folder.folderName	string	De naam van de zojuist gemaakte envelop.
Aangepaste naam	folder.folderCustomName	string	Een aangepaste naam voor de envelop.
Password	folder.folderPassword	string	Het toegangswachtwoord voor de envelop, indien ingesteld.
Creator-id	folder.folderAuthorId	integer	De unieke id van de envelopmaker.
Voornaam maker	folder.folderAuthorFirstName	string	De voornaam van de envelopmaker.
Achternaam van maker	folder.folderAuthorLastName	string	De achternaam van de envelopmaker.
E-mail maker	folder.folderAuthorEmail	string	Het e-mailadres van de maker van de envelop.
Rol maker	folder.folderAuthorRole	string	De rol van de maker van de envelop.
Bedrijfs-id	folder.folderCompanyId	integer	De unieke id van het bedrijf dat eigenaar is van de envelop.
Aanmaakdatum	folder.folderCreationDate	integer	De datum waarop de envelop is gemaakt (Unix-tijdstempel in milliseconden).
Verzonden datum	folder.folderSentDate	integer	De datum waarop de envelop is verzonden (Unix-tijdstempel in milliseconden).
Status	folder.folderStatus	string	De huidige status van de envelop.
Aangepast veld 1	folder.custom_field1	string	Het eerste aangepaste metagegevensveld voor de envelop.
Aangepast veld 2	folder.custom_field2	string	Het tweede aangepaste metagegevensveld voor de envelop.
Metagegevens	folder.metadata	string	Aangepaste metagegevens die zijn gekoppeld aan de envelop.
Document-ID's	folder.folderDocumentIds	array of integer	De lijst met document-id's in de envelop.
Documents	folder.documentsList	array of object	De lijst met documenten in de envelop.
Document-ID	folder.documentsList.documentId	integer	De unieke identificatie van het document.
Contract-id	folder.documentsList.contractId	integer	De unieke id van het contract.
Bedrijfs-id	folder.documentsList.companyId	integer	De unieke id van het bedrijf.
Gemaakt door	folder.documentsList.contractCreatedBy	integer	De gebruikers-id van de persoon die het contract heeft gemaakt.
Gemaakt op	folder.documentsList.contractCreatedOn	string	De datum en tijd waarop het contract is gemaakt.
Contractsoort	folder.documentsList.contractType	string	Het type contract.
Contractstatus	folder.documentsList.contractStatus	string	De huidige status van het contract.
Aanpasbaar	folder.documentsList.editable	boolean	Geeft aan of het item kan worden bewerkt.
Versie-id	folder.documentsList.contractVersionId	integer	De unieke id van de contractversie.
Versienaam	folder.documentsList.contractVersionName	string	De naam van de contractversie.
Versiebeschrijving	folder.documentsList.contractVersionDesc	string	Een beschrijving van de contractversie.
Versie gemaakt door	folder.documentsList.versionCreatedby	integer	De gebruikers-id van de persoon die deze versie heeft gemaakt.
Versie gemaakt op	folder.documentsList.versionCreatedOn	string	De datum en tijd waarop deze versie is gemaakt.
Versienummer	folder.documentsList.contractVersionNumber	integer	Het versienummer van het contract.
Transactiebron	folder.documentsList.contractTransactionSource	string	Het bronsysteem dat de contracttransactie heeft gestart.
Ontvangers	folder.folderRecipientParties	array of object	De lijst met geadresseerden voor deze envelop.
Ontvanger-id	folder.folderRecipientParties.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	folder.folderRecipientParties.partyDetails.partyId	integer	De unieke id van de ontvanger.
Voornaam	folder.folderRecipientParties.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	folder.folderRecipientParties.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailadres	folder.folderRecipientParties.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
Tijdelijke aanduiding	folder.folderRecipientParties.partyDetails.placeholder	boolean	Hiermee wordt aangegeven of deze partij een tijdelijke ontvanger is.
Address	folder.folderRecipientParties.partyDetails.address	string	Het fysieke adres van de ontvanger.
Aanmaakdatum	folder.folderRecipientParties.partyDetails.dateCreated	integer	De datum waarop de record is gemaakt (Unix-tijdstempel in milliseconden).
Afmelden voor e-mailberichten	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Hiermee wordt aangegeven of de geadresseerde zich heeft afgemeld voor e-mailmeldingen.
Unieke ontvanger-id	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Een unieke systeem-id voor deze ontvanger.
Verificatieniveau	folder.folderRecipientParties.partyDetails.authenticationLevel	string	De verificatiemethode die is vereist voor deze ontvanger.
Datum van wachtwoord bijgewerkt	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	De datum waarop het wachtwoord voor het laatst is bijgewerkt.
Status bijgewerkt wachtwoord	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Geeft aan of het wachtwoord is bijgewerkt.
Bedrijfs-id	folder.folderRecipientParties.partyDetails.companyId	integer	De unieke id van het bedrijf.
Gebruikersrol	folder.folderRecipientParties.partyDetails.userRole	string	De rol die is toegewezen aan de gebruiker.
Afdeling	folder.folderRecipientParties.partyDetails.department	string	De afdeling waartoe de gebruiker behoort.
Title	folder.folderRecipientParties.partyDetails.title	string	De functie van de gebruiker.
Actief	folder.folderRecipientParties.partyDetails.active	boolean	Geeft aan of de gebruiker of record actief is.
Locale	folder.folderRecipientParties.partyDetails.requestLocale	string	De landinstelling voor de gebruiker.
Delen met afdeling	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Geeft aan of enveloppen worden gedeeld over de afdeling.
Kiescode	folder.folderRecipientParties.partyDetails.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.folderRecipientParties.partyDetails.mobileNumber	string	Het mobiele telefoonnummer.
Statusfilter	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Een filter voor documentstatus.
Datumfilter	folder.folderRecipientParties.partyDetails.docDateFilter	string	Een filter voor documentdatum.
Beveiligde veldtoegang	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Hiermee wordt aangegeven of de gebruiker toegang heeft tot beveiligde velden.
Zijbalk uitvouwen	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Geeft aan of de zijbalk standaard is uitgevouwen.
Adv. E-mailvalidatie	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Geeft aan of geavanceerde e-mailvalidatie is ingeschakeld.
Manager-id	folder.folderRecipientParties.partyDetails.managerId	string	De unieke id van de manager van de gebruiker.
Aantal aanmeldingen	folder.folderRecipientParties.partyDetails.loginCount	integer	Het aantal keren dat de gebruiker zich heeft aangemeld.
E-mail opnieuw instellen van wachtwoord	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Hiermee wordt aangegeven of een e-mail voor het opnieuw instellen van een wachtwoord moet worden verzonden.
Afdelings-id	folder.folderRecipientParties.partyDetails.departmentId	string	De unieke id van de afdeling.
Primair bedrijf	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Het primaire bedrijf dat is gekoppeld aan de gebruiker.
Apparaattype	folder.folderRecipientParties.partyDetails.deviceType	string	Het type apparaat dat wordt gebruikt.
Apparaattoken	folder.folderRecipientParties.partyDetails.deviceToken	string	Het pushmeldingstoken voor het apparaat.
Beschrijving van onderaannemer	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Een beschrijving van de onderaannemer of externe ondertekenaar.
Onderaannemerorganisatie	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	De naam van de organisatie van de onderaannemer of externe ondertekenaar.
Datum van onderaannemer toegevoegd	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	De datum waarop de onderaannemer is toegevoegd (Unix-tijdstempel in milliseconden).
Bron	folder.folderRecipientParties.partyDetails.source	string	Het bronsysteem van waaruit de externe ondertekenaar is toegevoegd.
Kiescode	folder.folderRecipientParties.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.folderRecipientParties.mobileNumber	string	Het mobiele telefoonnummer.
Handtekeningtype	folder.folderRecipientParties.signerSignatureType	string	Het type handtekening dat de ondertekenaar gebruikt.
toestemmingen	folder.folderRecipientParties.contractPermissions	string	De machtigingen die aan deze partij zijn verleend voor het contract.
Ondertekeningsorder	folder.folderRecipientParties.partySequence	integer	Het volgnummer voor de ondertekeningsvolgorde voor deze geadresseerde.
Werkstroomvolgorde	folder.folderRecipientParties.workflowSignSequence	integer	Het volgnummer van de werkstroomondertekening.
Envelop-id	folder.folderRecipientParties.envelopeId	integer	De unieke id van de envelop.
Bedrijfs-id van geadresseerde	folder.folderRecipientParties.partyCompanyId	integer	De unieke id van het bedrijf dat aan deze ontvanger is gekoppeld.
Deelmodus	folder.folderRecipientParties.sharingMode	string	De deelmodus voor deze envelop.
URL voor toegang van geadresseerden	folder.folderRecipientParties.folderAccessURL	string	De URL die de ontvanger kan gebruiken om de envelop te openen en te ondertekenen.
Beveiligingsmodus	folder.folderRecipientParties.securityMode	string	De beveiligingsmodus die op deze envelop wordt toegepast.
Comments	folder.folderRecipientParties.extraComments	string	Aanvullende opmerkingen bij de envelop.
Naamwijziging toestaan	folder.folderRecipientParties.allowNameChange	boolean	Hiermee wordt aangegeven of de geadresseerde zijn of haar naam mag bijwerken.
Naam bijgewerkt	folder.folderRecipientParties.signerNameUpdated	boolean	Geeft aan of de ondertekenaar zijn of haar naam heeft bijgewerkt.
Verificatieniveau ondertekenaar	folder.folderRecipientParties.signerAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de ondertekenaar.
Toegangscode	folder.folderRecipientParties.userDefinedAccessCode	string	Een aangepaste toegangscode die is gedefinieerd voor de ondertekenaar.
Handtekening-id	folder.folderRecipientParties.signatureId	string	De unieke id van de handtekening.
Rol van geadresseerde	folder.folderRecipientParties.partyRole	string	De rol die is toegewezen aan deze ontvanger in de werkstroom voor ondertekening.
Bedrijfsveld	folder.folderRecipientParties.companyFieldValue	string	De waarde van het veld bedrijfsnaam in de handtekening.
Titelveld	folder.folderRecipientParties.titleFieldValue	string	De waarde van het titelveld in de handtekening.
Reden voor ondertekening	folder.folderRecipientParties.reasonSigning	string	De reden waarom de ontvanger het document ondertekent.
Betalingsveld toegevoegd	folder.folderRecipientParties.payFieldAdded	boolean	Geeft aan of er een betalingsveld is toegevoegd.
Begunstigde	folder.folderRecipientParties.payee	boolean	Geeft aan of deze ontvanger de begunstigde is.
Terugkerende betaling	folder.folderRecipientParties.recurringFieldExist	boolean	Hiermee wordt aangegeven of er een terugkerend betalingsveld bestaat.
Afdrukken en ondertekenen voltooid	folder.folderRecipientParties.printAndSignCompleted	boolean	Geeft aan of het proces voor afdrukken en ondertekenen is voltooid.
Paid	folder.folderRecipientParties.paid	boolean	Geeft aan of de betaling is voltooid.
Optionele ondertekenaar toegestaan	folder.folderRecipientParties.allowOptionalSigner	boolean	Geeft aan of deze geadresseerde een optionele ondertekenaar is.
Optionele ondertekenaars	folder.folderRecipientParties.optionalSigners	array of integer	De lijst met optionele partij-id's voor deze envelop.
Url voor ondertekening van auteur	folder.folderAccessURLForAuthor	string	De URL die de afzender kan gebruiken voor toegang tot de envelop.
Concepttoegangs-URL	folder.draftFolderAccessURL	string	De URL die wordt gebruikt voor toegang tot de conceptversie van de envelop.
Bordruimteondertekening	folder.boardRoomSign	boolean	Hiermee wordt aangegeven of de ondertekeningsmodus voor vergaderruimten is ingeschakeld.
Logo opnemen	folder.includeLogo	boolean	Geeft aan of het bedrijfslogo is opgenomen in e-mailberichten.
Achtergrondkleur van knop	folder.email_btnBgColor	string	De achtergrondkleur van de e-mailknop.
Tekstkleur van knop	folder.email_btnTxtColor	string	De tekstkleur van de e-mailknop.
E-maillogo	folder.emailTemplateLogo	string	De logo-URL die wordt gebruikt in de e-mailsjabloon.
E-mailsjabloon-id	folder.emailTemplateId	integer	De unieke id van de e-mailsjabloon.
E-mailkoptekst	folder.emailHeader	string	De koptekst die wordt gebruikt in e-mailberichten met meldingen.
E-mailvoettekst	folder.emailFooter	string	De voettekst die wordt gebruikt in e-mailberichten met meldingen.
Geplande opschoning	folder.purgeFlag	boolean	Geeft aan of de envelop is gepland voor opschonen.
Begindatum opschonen	folder.purgeStartDate	string	De datum van waaruit het opschonen is gepland.
Einddatum opschonen	folder.purgeEndDate	string	De datum waarop het opschonen is gepland.
Id bulksgewijs verzenden	folder.bulkId	integer	De unieke id van de bulksgewijze verzendbewerking.
Handtekeningvolgorde afdwingen	folder.enforceSignWorkflow	boolean	Hiermee wordt aangegeven of geadresseerden zich moeten aanmelden bij de gedefinieerde reeks.
Huidige stap	folder.currentWorkflowStep	integer	De huidige stap in de werkstroom voor ondertekening.
Transactiebron	folder.transactionSource	string	Het bronsysteem dat deze transactie heeft gestart.
Aanpasbaar	folder.editable	boolean	Geeft aan of het item kan worden bewerkt.
In-Person ondertekenen	folder.inPersonSignable	boolean	Hiermee wordt aangegeven of de envelop persoonlijk kan worden aangemeld.
Herinneringen overschrijven	folder.overrideAccountReminders	boolean	Hiermee wordt aangegeven of herinneringsinstellingen op accountniveau worden overschreven.
Overdracht overschrijven	folder.overrideAccountRecipientDelegation	boolean	Hiermee wordt aangegeven of de delegatie-instellingen op accountniveau worden overschreven.
Delegatie toestaan	folder.allowRecipientsToDelegate	boolean	Hiermee wordt aangegeven of geadresseerden ondertekening mogen delegeren.
Id	folder.envelopeId	integer	De unieke id van de envelop.
Naam	folder.envelopeName	string	De naam van de envelop.
Originator-id	folder.envelopeOriginatorId	integer	De unieke id van de gebruiker die de envelop heeft gemaakt.
Bedrijfs-id	folder.envelopeCompanyId	integer	De unieke id van het bedrijf dat eigenaar is van de envelop.
Date	folder.envelopeDate	integer	De datum waarop de envelop is gemaakt (Unix-tijdstempel in milliseconden).
Gedeelde datum	folder.envelopeSharedDate	integer	De datum waarop de envelop is gedeeld (Unix-tijdstempel in milliseconden).
Status	folder.envelopeStatus	string	De huidige status van de envelop.
Contract-id's	folder.envelopeContractIds	array of integer	De lijst met contract-id's die aan deze envelop zijn gekoppeld.
Machtigingen voor geadresseerden	folder.envelopePartyPermissions	array of object	De lijst met machtigingen voor geadresseerden voor deze envelop.
Ontvanger-id	folder.envelopePartyPermissions.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	folder.envelopePartyPermissions.partyDetails.partyId	integer	De unieke id van de ontvanger.
Voornaam	folder.envelopePartyPermissions.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	folder.envelopePartyPermissions.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailadres	folder.envelopePartyPermissions.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
Tijdelijke aanduiding	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Hiermee wordt aangegeven of deze partij een tijdelijke ontvanger is.
Address	folder.envelopePartyPermissions.partyDetails.address	string	Het fysieke adres van de ontvanger.
Aanmaakdatum	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	De datum waarop de record is gemaakt (Unix-tijdstempel in milliseconden).
Afmelden voor e-mailberichten	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Hiermee wordt aangegeven of de geadresseerde zich heeft afgemeld voor e-mailmeldingen.
Unieke ontvanger-id	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Een unieke systeem-id voor deze ontvanger.
Verificatieniveau	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	De verificatiemethode die is vereist voor deze ontvanger.
Datum van wachtwoord bijgewerkt	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	De datum waarop het wachtwoord voor het laatst is bijgewerkt.
Status bijgewerkt wachtwoord	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Geeft aan of het wachtwoord is bijgewerkt.
Bedrijfs-id	folder.envelopePartyPermissions.partyDetails.companyId	integer	De unieke id van het bedrijf.
Gebruikersrol	folder.envelopePartyPermissions.partyDetails.userRole	string	De rol die is toegewezen aan de gebruiker.
Afdeling	folder.envelopePartyPermissions.partyDetails.department	string	De afdeling waartoe de gebruiker behoort.
Title	folder.envelopePartyPermissions.partyDetails.title	string	De functie van de gebruiker.
Actief	folder.envelopePartyPermissions.partyDetails.active	boolean	Geeft aan of de gebruiker of record actief is.
Locale	folder.envelopePartyPermissions.partyDetails.requestLocale	string	De landinstelling voor de gebruiker.
Delen met afdeling	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Geeft aan of enveloppen worden gedeeld over de afdeling.
Kiescode	folder.envelopePartyPermissions.partyDetails.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Het mobiele telefoonnummer.
Statusfilter	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Een filter voor documentstatus.
Datumfilter	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Een filter voor documentdatum.
Beveiligde veldtoegang	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Hiermee wordt aangegeven of de gebruiker toegang heeft tot beveiligde velden.
Zijbalk uitvouwen	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Geeft aan of de zijbalk standaard is uitgevouwen.
Adv. E-mailvalidatie	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Geeft aan of geavanceerde e-mailvalidatie is ingeschakeld.
Manager-id	folder.envelopePartyPermissions.partyDetails.managerId	string	De unieke id van de manager van de gebruiker.
Aantal aanmeldingen	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Het aantal keren dat de gebruiker zich heeft aangemeld.
E-mail opnieuw instellen van wachtwoord	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Hiermee wordt aangegeven of een e-mail voor het opnieuw instellen van een wachtwoord moet worden verzonden.
Afdelings-id	folder.envelopePartyPermissions.partyDetails.departmentId	string	De unieke id van de afdeling.
Primair bedrijf	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Het primaire bedrijf dat is gekoppeld aan de gebruiker.
Apparaattype	folder.envelopePartyPermissions.partyDetails.deviceType	string	Het type apparaat dat wordt gebruikt.
Apparaattoken	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Het pushmeldingstoken voor het apparaat.
Beschrijving van onderaannemer	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Een beschrijving van de onderaannemer of externe ondertekenaar.
Onderaannemerorganisatie	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	De naam van de organisatie van de onderaannemer of externe ondertekenaar.
Datum van onderaannemer toegevoegd	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	De datum waarop de onderaannemer is toegevoegd (Unix-tijdstempel in milliseconden).
Bron	folder.envelopePartyPermissions.partyDetails.source	string	Het bronsysteem van waaruit de externe ondertekenaar is toegevoegd.
Kiescode	folder.envelopePartyPermissions.dialingCode	string	De internationale kiescode voor het telefoonnummer.
Mobiel nummer	folder.envelopePartyPermissions.mobileNumber	string	Het mobiele telefoonnummer.
Handtekeningtype	folder.envelopePartyPermissions.signerSignatureType	string	Het type handtekening dat de ondertekenaar gebruikt.
toestemmingen	folder.envelopePartyPermissions.contractPermissions	string	De machtigingen die aan deze partij zijn verleend voor het contract.
Ondertekeningsorder	folder.envelopePartyPermissions.partySequence	integer	Het volgnummer voor de ondertekeningsvolgorde voor deze geadresseerde.
Werkstroomvolgorde	folder.envelopePartyPermissions.workflowSignSequence	integer	Het volgnummer van de werkstroomondertekening.
Envelop-id	folder.envelopePartyPermissions.envelopeId	integer	De unieke id van de envelop.
Bedrijfs-id van geadresseerde	folder.envelopePartyPermissions.partyCompanyId	integer	De unieke id van het bedrijf dat aan deze ontvanger is gekoppeld.
Deelmodus	folder.envelopePartyPermissions.sharingMode	string	De deelmodus voor deze envelop.
URL voor toegang van geadresseerden	folder.envelopePartyPermissions.folderAccessURL	string	De URL die de ontvanger kan gebruiken om de envelop te openen en te ondertekenen.
Beveiligingsmodus	folder.envelopePartyPermissions.securityMode	string	De beveiligingsmodus die op deze envelop wordt toegepast.
Comments	folder.envelopePartyPermissions.extraComments	string	Aanvullende opmerkingen bij de envelop.
Naamwijziging toestaan	folder.envelopePartyPermissions.allowNameChange	boolean	Hiermee wordt aangegeven of de geadresseerde zijn of haar naam mag bijwerken.
Naam bijgewerkt	folder.envelopePartyPermissions.signerNameUpdated	boolean	Geeft aan of de ondertekenaar zijn of haar naam heeft bijgewerkt.
Verificatieniveau ondertekenaar	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de ondertekenaar.
Toegangscode	folder.envelopePartyPermissions.userDefinedAccessCode	string	Een aangepaste toegangscode die is gedefinieerd voor de ondertekenaar.
Handtekening-id	folder.envelopePartyPermissions.signatureId	string	De unieke id van de handtekening.
Rol van geadresseerde	folder.envelopePartyPermissions.partyRole	string	De rol die is toegewezen aan deze ontvanger in de werkstroom voor ondertekening.
Bedrijfsveld	folder.envelopePartyPermissions.companyFieldValue	string	De waarde van het veld bedrijfsnaam in de handtekening.
Titelveld	folder.envelopePartyPermissions.titleFieldValue	string	De waarde van het titelveld in de handtekening.
Reden voor ondertekening	folder.envelopePartyPermissions.reasonSigning	string	De reden waarom de ontvanger het document ondertekent.
Betalingsveld toegevoegd	folder.envelopePartyPermissions.payFieldAdded	boolean	Geeft aan of er een betalingsveld is toegevoegd.
Begunstigde	folder.envelopePartyPermissions.payee	boolean	Geeft aan of deze ontvanger de begunstigde is.
Terugkerende betaling	folder.envelopePartyPermissions.recurringFieldExist	boolean	Hiermee wordt aangegeven of er een terugkerend betalingsveld bestaat.
Afdrukken en ondertekenen voltooid	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Geeft aan of het proces voor afdrukken en ondertekenen is voltooid.
Paid	folder.envelopePartyPermissions.paid	boolean	Geeft aan of de betaling is voltooid.
Verificatieniveau	folder.envelopeAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de envelop.
Bulk voor eenmalige aanmelding	folder.allowSingleSignerInBulk	boolean	Hiermee wordt aangegeven of een eenmalige ondertekenaar is toegestaan in de modus voor bulksgewijs verzenden.
File-Based naamgeving	folder.folderNameBasedOnFileNaming	boolean	Geeft aan of de mapnaam is gebaseerd op de bestandsnaam.
Naam van document File-Based	folder.documentNameBasedOnFileNaming	boolean	Geeft aan of de documentnaam is gebaseerd op de bestandsnaam.
Certificaatnaam File-Based	folder.certificateNameBasedOnFileNaming	boolean	Geeft aan of de certificaatnaam is gebaseerd op de bestandsnaam.
Naamgeving van pre-exec-bestanden	folder.enableFileNamingBeforeExecution	boolean	Geeft aan of bestandsnaamgeving is ingeschakeld voordat het document wordt uitgevoerd.
Payee Added	folder.payeeAddedd	boolean	Geeft aan of er een beloning is toegevoegd.
Self-Signing ingeschakeld	folder.selfSignerEnabled	boolean	Hiermee wordt aangegeven of de modus voor zelfondertekening is ingeschakeld.
Notaris ingeschakeld	folder.notaryEnabled	boolean	Hiermee wordt aangegeven of notarisondertekening is ingeschakeld.
Beperkte zichtbaarheid	folder.limitedVisibilityFlag	boolean	Hiermee wordt aangegeven of beperkte zichtbaarheid is ingeschakeld voor deze envelop.
Zichtbaarheid na ondertekening	folder.postSigningVisibility	boolean	Geeft aan of zichtbaarheid na ondertekening is ingeschakeld.
Natte handtekening	folder.wetSignatureEnabled	boolean	Hiermee wordt aangegeven of natte handtekeningen zijn ingeschakeld.
Samenvoegen ingeschakeld	folder.mergeEnabled	boolean	Geeft aan of het samenvoegen van documenten is ingeschakeld.
Ingesloten ondertekeningssessies	embeddedSigningSessions	array of object	De lijst met ingesloten ondertekeningssessies, één per ontvanger. Alleen aanwezig wanneer createEmbeddedSigningSession waar is.
E-mailadres van ondertekenaar	embeddedSigningSessions.emailIdOfSigner	string	Het e-mailadres van de geadresseerde voor deze ingesloten ondertekeningssessie.
Token voor ondertekening	embeddedSigningSessions.embeddedToken	string	Het unieke token voor de ingesloten ondertekeningssessie van deze geadresseerde.
URL van ondertekeningssessie	embeddedSigningSessions.embeddedSessionURL	string	De URL voor het openen of insluiten van het document voor deze geadresseerde.
Ingesloten verzendtoken	embeddedToken	string	Het token voor de ingesloten verzendsessie. Alleen aanwezig wanneer createEmbeddedSendingSession waar is.
Sessie-URL verzenden	embeddedSessionURL	string	De URL voor het openen of insluiten van de auteur van de envelop om de envelop voor te bereiden en te verzenden. Alleen aanwezig wanneer createEmbeddedSendingSession waar is.
Result	result	string	Het resultaat van de bewerking.
Message	message	string	Een bericht met een beschrijving van het resultaat van de bewerking.

Envelopbestanden downloaden

Bewerkings-id:: DownloadEnvelopeFiles

Hiermee downloadt u de voltooide documenten van een envelop als een bestand.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelop-id	folderId	True	string	De unieke id van de envelop waarvan u de documenten wilt downloaden.

Retouren

response: binary

Envelopdetails ophalen

Bewerkings-id:: GetEnvelopeDetails

Haalt de volledige details van een envelop op, inclusief de status, geadresseerden en documenten.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelop-id	folderId	True	integer	De unieke id van de envelop die moet worden opgehaald.
Toegangstoken	access_token		string	Het OAuth 2.0-toegangstoken voor verificatie.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de bewerking is geslaagd (bijvoorbeeld 'geslaagd').
Id	folder.folderId	integer	De unieke id van de envelop.
Naam	folder.folderName	string	De naam van de envelop.
Auteur-id	folder.folderAuthorId	integer	De unieke id van de gebruiker die de envelop heeft gemaakt.
Voornaam van auteur	folder.folderAuthorFirstName	string	De voornaam van de maker van de envelop.
Achternaam van auteur	folder.folderAuthorLastName	string	De achternaam van de maker van de envelop.
E-mail schrijven	folder.folderAuthorEmail	string	Het e-mailadres van de maker van de envelop.
Auteurrol	folder.folderAuthorRole	string	De accountrol van de maker van de envelop.
Bedrijfs-id	folder.folderCompanyId	integer	De unieke id van het bedrijf waartoe de envelop behoort.
Aanmaakdatum	folder.folderCreationDate	integer	De datum en tijd waarop de envelop is gemaakt, in Unix milliseconden.
Verzonden datum	folder.folderSentDate	integer	De datum en tijd waarop de envelop naar geadresseerden is verzonden, in Unix milliseconden. Null als dit nog niet is verzonden.
Status	folder.folderStatus	string	De huidige status van de envelop (bijvoorbeeld GEDEELD, UITGEVOERD, CONCEPT, GEANNULEERD).
Document-ID's	folder.folderDocumentIds	array of integer	De lijst met document-id's die zijn opgenomen in deze envelop.
Documents	folder.documentsList	array of object	Details van elk document in de envelop.
Document-ID	folder.documentsList.documentId	integer	De unieke identificatie van het document.
Contract-id	folder.documentsList.contractId	integer	De unieke id van het contract dat aan dit document is gekoppeld.
Bedrijfs-id	folder.documentsList.companyId	integer	De unieke id van het bedrijf waartoe dit document behoort.
Gemaakt door	folder.documentsList.contractCreatedBy	integer	De gebruikers-id van de persoon die het contract heeft gemaakt.
Gemaakt op	folder.documentsList.contractCreatedOn	integer	De datum waarop het contract is gemaakt, in Unix milliseconden.
Contractsoort	folder.documentsList.contractType	string	Het type of de categorie van het contract.
Documentstatus	folder.documentsList.contractStatus	string	De huidige ondertekeningsstatus van het document (bijvoorbeeld WAITING_FOR_SIGNATURE, EXECUTED).
Aanpasbaar	folder.documentsList.editable	boolean	Geeft aan of het document kan worden bewerkt.
Versie-id	folder.documentsList.contractVersionId	integer	De unieke id van de huidige documentversie.
Versienaam	folder.documentsList.contractVersionName	string	De naam van de huidige documentversie.
Versiebeschrijving	folder.documentsList.contractVersionDesc	string	Een beschrijving van de huidige documentversie.
Versie gemaakt door	folder.documentsList.versionCreatedby	integer	De gebruikers-id van de persoon die deze documentversie heeft gemaakt.
Versie gemaakt op	folder.documentsList.versionCreatedOn	integer	De datum waarop deze documentversie is gemaakt, in Unix milliseconden.
Versienummer	folder.documentsList.contractVersionNumber	integer	Het versienummer van het document.
Ontvangers	folder.folderRecipientParties	array of object	De lijst met geadresseerden voor deze envelop, inclusief de ondertekeningsstatus en toegangskoppelingen.
Ontvanger-id	folder.folderRecipientParties.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	folder.folderRecipientParties.partyDetails.partyId	integer	De unieke id van de ontvanger.
Voornaam	folder.folderRecipientParties.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	folder.folderRecipientParties.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailen	folder.folderRecipientParties.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
Address	folder.folderRecipientParties.partyDetails.address	string	Het adres van de geadresseerde.
Account gemaakt op	folder.folderRecipientParties.partyDetails.dateCreated	integer	De datum waarop het account van de ontvanger is gemaakt, in Unix milliseconden.
toestemmingen	folder.folderRecipientParties.contractPermissions	string	De ondertekeningsmachtigingen die aan deze geadresseerde zijn verleend (bijvoorbeeld FILL_FIELDS_AND_SIGN).
Ondertekeningsorder	folder.folderRecipientParties.partySequence	integer	De positie van deze ontvanger in de ondertekeningsorder.
Werkstroomvolgorde	folder.folderRecipientParties.workflowSignSequence	integer	Het volgnummer van de werkstroomondertekening voor deze geadresseerde.
Envelop-id	folder.folderRecipientParties.envelopeId	integer	De id van de envelop waartoe deze geadresseerde behoort.
Deelmodus	folder.folderRecipientParties.sharingMode	string	De methode die wordt gebruikt om het document te delen met deze geadresseerde (bijvoorbeeld e-mail).
Ondertekenings-URL	folder.folderRecipientParties.folderAccessURL	string	De unieke ondertekenings-URL voor deze geadresseerde. Null als de envelop al is voltooid of geannuleerd.
Beveiligingsmodus	folder.folderRecipientParties.securityMode	string	De beveiligingsmodus die is toegepast op de toegang van deze geadresseerde.
Extra opmerkingen	folder.folderRecipientParties.extraComments	string	Eventuele aanvullende opmerkingen die zijn opgenomen in de ondertekeningsuitnodiging voor deze geadresseerde.
URL voor auteurtoegang	folder.folderAccessURLForAuthor	string	De URL voor de auteur van de envelop voor toegang tot het document. Null indien niet van toepassing.
Bulk-id	folder.bulkId	integer	De id van de bulksgewijs verzenden batch waartoe deze envelop behoort, indien van toepassing.
Handtekeningvolgorde afdwingen	folder.enforceSignWorkflow	boolean	Hiermee wordt aangegeven of geadresseerden zich moeten aanmelden bij de opgegeven volgorde.
Huidige werkstroomstap	folder.currentWorkflowStep	integer	De huidige stap in de werkstroom voor ondertekening.
Transactiebron	folder.transactionSource	string	De bron waarmee deze enveloptransactie is gestart.
Aanpasbaar	folder.editable	boolean	Hiermee wordt aangegeven of de envelop nog steeds kan worden bewerkt.
In-Person ondertekenen	folder.inPersonSignable	boolean	Hiermee wordt aangegeven of de envelop persoonlijk kan worden aangemeld.
Herinneringen overschrijven	folder.overrideAccountReminders	boolean	Hiermee wordt aangegeven of herinneringsinstellingen op accountniveau worden overschreven voor deze envelop.
Id	folder.envelopeId	integer	De unieke id van de envelop. Dezelfde waarde als Envelop-id (folderId).
Naam	folder.envelopeName	string	De naam van de envelop. Dezelfde waarde als Envelopnaam (folderName).
Originator-id	folder.envelopeOriginatorId	integer	De gebruikers-id van de persoon die de envelop heeft gemaakt.
Bedrijfs-id	folder.envelopeCompanyId	integer	De id van het bedrijf waartoe de envelop behoort.
Date	folder.envelopeDate	integer	De datum en tijd waarop de envelop is gemaakt, in Unix milliseconden.
Gedeelde datum	folder.envelopeSharedDate	integer	De datum en tijd waarop de envelop is gedeeld met geadresseerden, in Unix milliseconden. Null als dit nog niet is gedeeld.
Status	folder.envelopeStatus	string	De huidige status van de envelop. Dezelfde waarde als Envelopstatus (folderStatus).
Contract-id's	folder.envelopeContractIds	array of integer	De lijst met contract-id's die aan deze envelop zijn gekoppeld.
Machtigingen van derden	folder.envelopePartyPermissions	array of object	De lijst met geadresseerden en hun ondertekeningsmachtigingen. Dezelfde structuur als ontvangers.
Ontvanger-id	folder.envelopePartyPermissions.partyId	integer	De unieke id van de ontvanger.
Voornaam	folder.envelopePartyPermissions.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	folder.envelopePartyPermissions.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailen	folder.envelopePartyPermissions.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
toestemmingen	folder.envelopePartyPermissions.contractPermissions	string	De ondertekeningsmachtigingen voor deze geadresseerde.
Ondertekeningsorder	folder.envelopePartyPermissions.partySequence	integer	De positie van deze ontvanger in de ondertekeningsorder.
Ondertekenings-URL	folder.envelopePartyPermissions.folderAccessURL	string	De unieke ondertekenings-URL voor deze geadresseerde.
Alle velden	allFields	array of object	De lijst met alle handtekening- en formuliervelden die in de documenten van de envelop worden geplaatst.
Veld-id	allFields.fieldTagId	integer	De unieke id van het veld.
Document-ID	allFields.contractId	integer	De id van het document waartoe dit veld behoort.
Versie-id	allFields.versionId	integer	De versie-id van het document waartoe dit veld behoort.
Veldtype	allFields.fieldType	string	Het type veld (bijvoorbeeld signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
Paginanummer	allFields.documentPageNumber	integer	Het paginanummer waar dit veld wordt geplaatst.
Id van velddocumenten	allFields.docFieldId	string	De id op documentniveau voor dit veld.
Verantwoordelijke partij	allFields.partyResponsible	integer	De partij-id die verantwoordelijk is voor het invullen van dit veld.
Is afhankelijk	allFields.dependent	boolean	Geeft aan of de zichtbaarheid van dit veld afhankelijk is van de waarde van een ander veld.
Required	allFields.required	boolean	Hiermee wordt aangegeven of dit veld moet worden ingevuld voordat het document kan worden verzonden.
Veldwaarde	allFields.value	string	De huidige waarde van het veld, indien ingevuld.
Veldwaarden	allFieldsNameValue	array of object	Een vereenvoudigde lijst met alle veldnamen en de huidige waarden. Gebruik deze optie om ingevulde veldgegevens van een ondertekende envelop te lezen.
Veld-id	allFieldsNameValue.fieldId	integer	De unieke id van het veld.
Document-ID	allFieldsNameValue.documentId	integer	De id van het document waartoe dit veld behoort.
Versie-id	allFieldsNameValue.documentVersionId	integer	De versie-id van het document waartoe dit veld behoort.
Veldtype	allFieldsNameValue.fieldType	string	Het type veld (bijvoorbeeld textfield, signfield, datefield, checkboxfield, dropdownfield).
Veldnaam	allFieldsNameValue.name	string	Het label of de naam van het veld zoals gedefinieerd in de sjabloon.
Veldwaarde	allFieldsNameValue.value	string	De waarde die is ingevoerd of geselecteerd voor dit veld.
Envelopgeschiedenis	Folder History	array of object	Het audittrail van alle acties die op deze envelop worden uitgevoerd, in chronologische volgorde.
Voornaam	Folder History.firstName	string	De voornaam van de persoon die de actie heeft uitgevoerd.
Achternaam	Folder History.lastName	string	De achternaam van de persoon die de actie heeft uitgevoerd.
E-mailen	Folder History.email	string	Het e-mailadres van de persoon die de actie heeft uitgevoerd.
Envelop-id	Folder History.envelopeId	integer	De id van de envelop waarop de actie is uitgevoerd.
Date	Folder History.dateChanged	integer	De datum en tijd waarop de actie heeft plaatsgevonden, in Unix milliseconden.
Partij-id	Folder History.changeDoneByParty	integer	De partij-id van de persoon die de actie heeft uitgevoerd.
Action	Folder History.action	string	De actie die wordt uitgevoerd op de envelop (bijvoorbeeld Gemaakt, InviteSentTo, InviteAccepted, Ondertekend, Uitgevoerd).

Enveloppen verplaatsen naar Prullenbak

Bewerkings-id:: MoveEnvelopestoRecycleBin

Hiermee verplaatst u een of meer enveloppen naar de prullenbak. Enveloppen in de Prullenbak worden niet definitief verwijderd.

Parameters

Name	Sleutel	Vereist	Type	Description
Map-id's	folderIds	True	array of integer	Een matrix van envelop-id's waarop moet worden gehandeld.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de bewerking is geslaagd.

Enveloppen verwijderen

Bewerkings-id:: DeleteEnvelopes

Hiermee verwijdert u een of meer enveloppen definitief.

Parameters

Name	Sleutel	Vereist	Type	Description
Map-id's	folderIds	True	array of integer	Een matrix van envelop-id's waarop moet worden gehandeld.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de bewerking is geslaagd.

Geschiedenis van envelopactiviteit ophalen

Bewerkings-id:: GetEnvelopeActivityHistory

Hiermee haalt u een volledig activiteitenlogboek voor een envelop op, met alle acties die zijn uitgevoerd door geadresseerden en de afzender.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelop-id	folderId	True	integer	De unieke id van de envelop waarvan u de activiteitengeschiedenis wilt ophalen.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Envelop-id	details.folderId	integer	De unieke id van de envelop.
Ingesloten documenten	details.enclosedDocuments	string	De naam van de documenten die in de envelop zijn geplaatst.
Ontvangers	details.envelopeRecipients	string	De namen van alle geadresseerden op de envelop.
Author	details.author	string	De naam van de gebruiker die de envelop heeft gemaakt.
Status	details.status	string	De huidige status van de envelop (bijvoorbeeld GEDEELD, UITGEVOERD, GEANNULEERD).
Datum van laatste activiteit	details.latestActivityDate	string	De datum en tijd van de meest recente activiteit op de envelop.
Aanmaakdatum	details.dateCreated	string	De datum en tijd waarop de envelop is gemaakt.
Verzonden datum	details.dateSent	string	De datum en tijd waarop de envelop naar geadresseerden is verzonden.
Activities	details.activities	array of object	De chronologische lijst van alle acties die op deze envelop worden uitgevoerd.
Activity	details.activities.activity	string	Een door mensen leesbare beschrijving van de actie die is opgetreden.
Action	details.activities.action	string	Het type uitgevoerde actie (bijvoorbeeld Gemaakt, Uitnodiging verzonden, Geopend, Bekeken, Ondertekend).
User	details.activities.user	string	De naam van de gebruiker die de actie heeft uitgevoerd.
Envelopstatus	details.activities.folderStatus	string	De status van de envelop op het moment dat deze actie heeft plaatsgevonden.
Time	details.activities.time	string	De datum en tijd waarop de actie heeft plaatsgevonden.
Bron	details.activities.source	string	De bron van waaruit de actie is uitgevoerd (bijvoorbeeld web).
IP-adres	details.activities.ipAddress	string	Het IP-adres van waaruit de actie is uitgevoerd, indien beschikbaar.

Herinnering voor handtekening verzenden

Bewerkings-id:: SendSignatureReminder

Hiermee wordt een herinneringsmelding verzonden naar geadresseerden van een envelop in behandeling en wordt hen gevraagd om de ondertekening te voltooien.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelop-id	folderId	True	integer	De id van de envelop.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Envelop-id	reminder sent	integer	De id van de envelop waarvoor de herinnering is verzonden.

PDF met één document downloaden

Bewerkings-id:: DownloadSingleDocumentPDF

Hiermee downloadt u één document van een envelop als PDF-bestand.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelop-id	folderId	True	string	De unieke id van de envelop die het document bevat dat moet worden gedownload.
Documentnummer	docNumber	True	string	De index van het document dat moet worden gedownload vanaf 1.

Retouren

response: binary

Rapport downloaden

Bewerkings-id:: DownloadReport

Hiermee downloadt u een envelopactiviteitsrapport als een Microsoft Excel-bestand. Gebruik de filters om de resultaten te beperken op status, datumbereik, envelopnaam, auteur of ondertekenaar.

Parameters

Name	Sleutel	Type	Description
envelopStatus	status	string	De statussen van de map waarmee we een rapport gaan filteren
Aanmaakdatum vanaf	creationDateFrom	string	Begin van het bereik Aanmaakdatum. Geaccepteerde indeling: JJJJ-MM-DD.
Aanmaakdatum tot	creationDateTo	string	Einde van het bereik Aanmaakdatum. Geaccepteerde indeling: JJJJ-MM-DD.
Envelopnaam	folderName	string	Elke map die deze tekenreeks bevat.
Velden opnemen	includeFields	string	Stel in op 'true' om envelopveldwaarden in het rapport op te nemen. De standaardwaarde is 'false'.
E-mail schrijven	authorEmail	string	Filter het rapport zodat alleen enveloppen worden opgenomen die zijn gemaakt door dit e-mailadres van de auteur.
E-mailadres van ondertekenaar	signerEmail	string	Filter het rapport zodat alleen enveloppen worden opgenomen waarin dit e-mailadres een ondertekenaar is.

Retouren

Rapportbestand: binary

Sjablonen ophalen op sjabloon-id's

Bewerkings-id:: GetTemplatesbyTemplateIds

Hiermee worden details voor een of meer sjablonen opgehaald op basis van hun id's.

Parameters

Name	Sleutel	Vereist	Type	Description
Sjabloon-id's	templateIds	True	array of integer	Een matrix met sjabloon-id's die moeten worden opgehaald.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Totaal aantal sjablonen	total_templates	integer	Het totale aantal geretourneerde sjablonen.
Sjabloonlijst	templateIdList	object	Een kaart met sjabloongegevens die zijn gesleuteld op sjabloon-id. Elk item bevat de details van de sjabloon en de bijbehorende velden.

Sjabloon maken op basis van Base64

Bewerkings-id:: CreateTemplatefromBase64

Hiermee maakt u een nieuwe sjabloon met een met Base64 gecodeerde PDF-tekenreeks. Gebruik dit wanneer uw PDF-bestand al beschikbaar is als een Base64-tekenreeks in uw stroom, bijvoorbeeld vanuit een SharePoint-bestand of OneDrive document.

Parameters

Name	Sleutel	Vereist	Type	Description
Sjabloonnaam	templateName	True	string	De naam voor de sjabloon. Moet eindigen met de .pdf extensie (bijvoorbeeld onboarding.pdf).
Base64-bestandsreeks	base64FileString	True	string	BASE64-tekenreeks van een PDF voor het maken van de sjabloon. Deze moet openbaar toegankelijk zijn wanneer u de sjabloon maakt.
Invoertype	inputType	True	string	De invoermethode voor het document. Altijd ingesteld op 'base64' voor deze actie.
Teksttags verwerken	processTextTags	True	boolean	Wanneer deze optie is ingeschakeld, scant Foxit eSign het document op Teksttags en converteert deze automatisch naar handtekeningvelden.
Acrovelden verwerken	processAcroFields	True	boolean	Wanneer deze optie is ingeschakeld, scant Foxit eSign het document op AcroFields en converteert deze automatisch naar handtekeningvelden.
Alles delen	shareAll	True	boolean	Deel deze sjabloon met alle gebruikers in uw account.
Aantal partijen	numberOfParties	True	integer	Het aantal geadresseerden voor deze sjabloon. Moet kleiner zijn dan 20.
Themakleur	themeColor		string	Een CSS-kleurwaarde om het thema van de ingesloten sjabloonsessie aan te passen (bijvoorbeeld #42caf4).
E-mail schrijven	authorEmail		string	Het e-mailadres van een andere gebruiker in het account dat moet worden ingesteld als auteur van deze sjabloon.
Ingesloten sjabloonsessie maken	createEmbeddedTemplateSession		boolean	Als deze optie is ingesteld op true, wordt er een ingesloten sjabloonsessie gemaakt, zodat u de Foxit eSign-sjablooneditor rechtstreeks kunt openen en velden naar de sjabloon kunt slepen en neerzetten.
Omleidings-URL	redirectURL		string	Als ingesloten sjabloonsessie maken waar is, wordt de URL waarnaar de gebruiker wordt omgeleid nadat deze op Opslaan en Sluiten in de ingesloten sjablooneditor heeft geklikt.
Sjabloon voor verzenden verbergen	hideSendTemplate		boolean	Indien waar, wordt de knop Verzenden verborgen in de ingesloten sjablooneditor.
Geadresseerden herstellen	fixRecipientParties		boolean	Indien waar, kunnen de geadresseerden die al zijn toegevoegd, niet worden gewijzigd in de ingesloten sjablooneditor.
Velden	Fields		object
permissions	permission	True	string
Volgorde	sequence	True	integer	Een uniek volgnummer voor deze partij, beginnend vanaf 1. Hiermee definieert u de ondertekeningsvolgorde wanneer Aanmeldingsreeks is ingeschakeld.
Rol van geadresseerde	partyRole	True	string	De rol die is toegewezen aan deze partij in de sjabloon.
Meer actie verbergen	hideMoreAction		boolean	Indien waar, wordt de knop Meer acties verborgen in de ingesloten sjabloonsessie.
Delen met iedereen verbergen	hideShareWithAll		boolean	Indien waar, is de optie Delen met alle verborgen in de ingesloten sjabloonsessie.
Add Party verbergen	hideAddParty		boolean	Indien waar, worden alle opties voor het toevoegen van party's verborgen in de ingesloten sjabloonsessie.
Knop Mij verbergen	hideMeButton		boolean	Indien waar, wordt de knop Ik op geadresseerden verborgen in de ingesloten sjabloonsessie.
Knop Anderen verbergen	hideOthersButton		boolean	Indien waar, wordt de knop Overige op Geadresseerden verborgen in de ingesloten sjabloonsessie.
Veldnaam voor geadresseerden verbergen	hideFieldNameForRecipients		boolean	Indien waar, worden veldnamen verborgen voor geadresseerden voor gegevensinvoer en geavanceerde velden.
Selectievakjerand verbergen	hideCheckboxBorder		boolean	Indien waar, worden de randen van selectievakjes verborgen in de uitgevoerde documenten.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de bewerking is geslaagd (bijvoorbeeld 'geslaagd').
Message	message	string	Een beschrijving van het resultaat van de bewerking.
Id	template.templateId	integer	De unieke id van de gemaakte sjabloon. Gebruik deze optie om enveloppen te maken op basis van deze sjabloon.
Naam	template.templateName	string	De naam van de sjabloon.
Description	template.templateDesc	string	Een beschrijving van de sjabloon.
Type	template.templateType	string	Het type sjabloon.
Aanmaakdatum	template.templateCreationDate	string	De datum waarop de sjabloon is gemaakt.
Laatst bijgewerkt	template.templateLastUpdateDate	string	De datum waarop de sjabloon voor het laatst is bijgewerkt.
Aanpasbaar	template.editable	boolean	Geeft aan of de sjabloon kan worden bewerkt.
Aantal partijen	template.numberOfParties	integer	Het aantal geadresseerden dat in de sjabloon is gedefinieerd.
Totaal aantal pagina's	template.totalPages	integer	Het totale aantal pagina's in het sjabloondocument.
Bedrijfs-id	template.companyId	integer	De id van het bedrijf waartoe deze sjabloon behoort.
Gedeeld met alle	template.shareAll	boolean	Geeft aan of deze sjabloon wordt gedeeld met alle gebruikers in het account.
Machtigingen van derden	template.templatePartyPermissions	array of object	De lijst met ontvangersrollen en de bijbehorende machtigingen die in deze sjabloon zijn gedefinieerd.
Partij-id	template.templatePartyPermissions.template_party_id	integer	De unieke id van dit item van de sjabloonpartij.
Id	template.templatePartyPermissions.templateId	integer	De id van de sjabloon waartoe deze partij behoort.
toestemmingen	template.templatePartyPermissions.templatePermissions	string	De ondertekeningsmachtigingen voor deze partij (bijvoorbeeld FILL_FIELDS_AND_SIGN).
Ondertekeningsorder	template.templatePartyPermissions.partySequence	integer	De positie van de ondertekeningsorder voor deze partij.
Rol van partij	template.templatePartyPermissions.templatePartyRole	string	De rolnaam die aan deze partij is toegewezen in de sjabloon. Gebruik deze optie bij het maken van een envelop op basis van de sjabloon.
Gebruikers-ID	template.templateCreatedBy.partyId	integer	De unieke id van de gebruiker.
Voornaam	template.templateCreatedBy.firstName	string	De voornaam van de gebruiker.
Achternaam	template.templateCreatedBy.lastName	string	De achternaam van de gebruiker.
E-mailen	template.templateCreatedBy.emailId	string	Het e-mailadres van de gebruiker.
Sjabloonvelden	allfields	array of object	De lijst met alle handtekening- en formuliervelden die in de sjabloon zijn gedefinieerd.
Veld-id	allfields.fieldTagId	integer	De unieke id van het veld.
Sjabloon-ID	allfields.templateId	integer	De id van de sjabloon waartoe dit veld behoort.
Bedrijfs-id	allfields.companyId	integer	Het bedrijfsaccount waartoe dit veld behoort.
Veldtype	allfields.fieldType	string	Het type veld (bijvoorbeeld signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Paginanummer	allfields.documentPageNumber	integer	Het paginanummer van het document waarin dit veld wordt geplaatst.
Verantwoordelijke partij	allfields.partyResponsible	integer	Het partijreeksnummer dat verantwoordelijk is voor het invullen van dit veld.
Partijvolgorde	allfields.partyResponsibleSequence	integer	De volgordepositie van de verantwoordelijke partij.
Id van velddocumenten	allfields.docFieldId	string	De id op documentniveau voor dit veld.
Is afhankelijk	allfields.dependent	boolean	Geeft aan of de zichtbaarheid van dit veld afhankelijk is van de waarde van een ander veld.
Tabvolgorde	allfields.tabOrder	integer	De tabvolgorde voor het navigeren tussen velden.
Required	allfields.required	boolean	Hiermee wordt aangegeven of dit veld moet worden ingevuld voordat het document kan worden ondertekend.
Naam van aangepast veld	allfields.customFieldName	string	Een aangepaste naam die aan dit veld is toegewezen.
Alles delen	allfields.shareAll	boolean	Geeft aan of dit veld wordt gedeeld met alle gebruikers.
Bewerken toestaan	allfields.allowEdit	boolean	Hiermee wordt aangegeven of dit veld kan worden bewerkt door de geadresseerde.
Naam van tekstveld	allfields.textfieldName	string	Het label van het tekstveld (van toepassing wanneer fieldType 'textfield' is).
Value	allfields.value	string	De vooraf ingevulde of ingevoerde waarde van het veld.
Tekengrootte	allfields.fontSize	integer	De tekengrootte die wordt gebruikt voor tekst in dit veld.
Trapsgewijze tekstdia 3	allfields.fontColor	string	De tekstkleur die wordt gebruikt voor tekst in dit veld (bijvoorbeeld #000000).
Alleen lezen	allfields.readOnly	boolean	Geeft aan of het veld het kenmerk Alleen-lezen heeft en niet kan worden bewerkt door de geadresseerde.
Meerdere lijnen	allfields.multiLine	boolean	Hiermee wordt aangegeven of het tekstveld meerdere regels invoer accepteert (van toepassing wanneer fieldType 'textfield' is).
Tekenlimiet	allfields.characterLimit	integer	Het maximum aantal tekens dat is toegestaan in het veld (van toepassing wanneer fieldType 'textfield' is).
Datumveldnaam	allfields.datefieldName	string	Het label van het datumveld (van toepassing wanneer fieldType 'datefield' is).
Datumnotatie	allfields.dateFormat	string	De datumnotatie die door dit veld wordt gebruikt (bijvoorbeeld MM/DD/JJJJ) (van toepassing wanneer fieldType 'datefield' is).
Naam van selectievakje	allfields.cbname	string	Het label van het selectievakjeveld (van toepassing wanneer fieldType 'checkboxfield' is).
Selectievakjegroep	allfields.cbgroup	string	De groepsnaam voor dit selectievakje (van toepassing wanneer fieldType 'checkboxfield' is).
Gecontroleerd	allfields.checked	boolean	Hiermee wordt aangegeven of het selectievakje standaard is ingeschakeld (van toepassing wanneer fieldType 'checkboxfield' is).
Beveiligde veldnaam	allfields.securedfieldName	string	Het label van het beveiligde veld (van toepassing wanneer fieldType 'securedfield' is).
Tekens die moeten worden weergegeven	allfields.charToDisplay	integer	Het aantal niet-gemaskeerde tekens dat moet worden weergegeven aan het einde van een beveiligde veldwaarde (van toepassing wanneer fieldType 'securedfield' is).
Handtekening-id	allfields.signatureId	string	De id van de handtekening die is toegepast op dit tekenveld (van toepassing wanneer fieldType 'signfield' is).
Eerste afbeelding	allfields.initialImage	string	De afbeeldingsgegevens voor de initialen die op dit veld zijn toegepast (van toepassing wanneer fieldType 'initialfield' is).
Naam van bijlageveld	allfields.attachmentfieldName	string	De naam van het bijlageveld (van toepassing wanneer fieldType 'attachmentfield' is).
Beschrijving van bijlage	allfields.attachmentfieldDescription	string	Een beschrijving van wat u moet bijvoegen (van toepassing wanneer fieldType 'attachmentfield' is).

Sjabloon maken op url

Bewerkings-id:: CreateTemplatefromURL

Hiermee maakt u een nieuwe sjabloon met een openbaar toegankelijke PDF-URL.

Parameters

Name	Sleutel	Vereist	Type	Description
Sjabloonnaam	templateName	True	string	De naam voor de sjabloon. Moet eindigen met de .pdf extensie (bijvoorbeeld onboarding.pdf).
Sjabloon-URL	templateUrl	True	string	De openbaar toegankelijke URL van het PDF-document dat moet worden gebruikt als sjabloon.
Invoertype	inputType	True	string	De invoermethode voor het document. Altijd ingesteld op URL voor deze actie.
Teksttags verwerken	processTextTags	True	boolean	Wanneer deze optie is ingeschakeld, scant Foxit eSign het document op Teksttags en converteert deze automatisch naar handtekeningvelden.
Acrovelden verwerken	processAcroFields	True	boolean	Wanneer deze optie is ingeschakeld, scant Foxit eSign het document op AcroFields en converteert deze automatisch naar handtekeningvelden.
Alles delen	shareAll	True	boolean	Deel deze sjabloon met alle gebruikers in uw account.
Aantal partijen	numberOfParties	True	integer	Voeg het aantal partijen in de sjabloon toe. De waarden van deze parameter moeten kleiner zijn dan 20.
Themakleur	themeColor		string	Voer een CSS-waarde in voor een kleur om het thema van createEmbeddedTemplateSession te wijzigen.
E-mail schrijven	authorEmail		string	Voer een e-mailadres in van een andere gebruiker in een account dat wordt gebruikt als auteur voor deze sjabloon.
Ingesloten sjabloonsessie maken	createEmbeddedTemplateSession		boolean	Als deze optie is ingesteld als waar, wordt de weergave voor het voorbereiden van de Foxit eSign-sjabloon rechtstreeks door een ingesloten sjabloonsessie geopend. Het slepen en neerzetten van verschillende velden op de sjabloon is beschikbaar.
Omleidings-URL	redirectURL		string	Als createEmbeddedTemplateSession waar is, kan de absolute URL worden ingevoerd voor de landingspagina op elke website/toepassing, waarnaar de gebruiker wordt omgeleid na het klikken op Opslaan en sluiten in de ingesloten sjabloonweergave.
Sjabloon voor verzenden verbergen	hideSendTemplate		boolean	Indien waar, wordt de knop Verzenden verborgen in een ingesloten sjabloonweergave.
Geadresseerden herstellen	fixRecipientParties		boolean	Indien waar, kan in de ingesloten sjabloonweergave de partijen voor de envelop die al zijn toegevoegd, niet wijzigen.
Velden	Fields		object
permissions	permission	True	string
Volgorde	sequence	True	integer	Een uniek volgnummer voor deze partij, beginnend vanaf 1. Hiermee definieert u de ondertekeningsvolgorde wanneer Aanmeldingsreeks is ingeschakeld.
Rol van geadresseerde	partyRole	True	string	De rol die is toegewezen aan deze partij in de sjabloon.
Meer actie verbergen	hideMoreAction		boolean	Indien waar, wordt de knop Meer acties verborgen in de sjabloonsessie.
Delen met iedereen verbergen	hideShareWithAll		boolean	Indien waar, wordt de optie Delen met alles verborgen in de sjabloonsessie.
Add Party verbergen	hideAddParty		boolean	Indien waar, worden alle opties van een partij in een ingesloten sjabloonsessie verborgen.
Knop Mij verbergen	hideMeButton		boolean	Indien waar, wordt de knop 'Ik' op geadresseerden verborgen in een ingesloten sjabloonsessie.
Knop Anderen verbergen	hideOthersButton		boolean	Indien waar, wordt de knop 'Anderen' op geadresseerden verborgen in een ingesloten sjabloonsessie.
Optie Bestaande contactpersoon selecteren verbergen	hideExistingContactSelectOption		boolean	Indien waar, wordt het invoervak Bestaande contactpersoon zoeken en toevoegen verborgen voor geadresseerden in een ingesloten sjabloonsessie.
Veldnaam voor geadresseerden verbergen	hideFieldNameForRecipients		boolean	Veldnamen verbergen voor ontvangers voor gegevensinvoervelden en geavanceerde velden. (Behalve keuzerondje, selectievakje, afbeelding en hyperlink).
Selectievakjerand verbergen	hideCheckboxBorder		boolean	Randen van selectievakje worden verborgen in de uitgevoerde documenten.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de bewerking is geslaagd (bijvoorbeeld 'geslaagd').
Message	message	string	Een beschrijving van het resultaat van de bewerking.
Id	template.templateId	integer	De unieke id van de gemaakte sjabloon. Gebruik deze optie om enveloppen te maken op basis van deze sjabloon.
Naam	template.templateName	string	De naam van de sjabloon.
Description	template.templateDesc	string	Een beschrijving van de sjabloon.
Type	template.templateType	string	Het type sjabloon.
Aanmaakdatum	template.templateCreationDate	string	De datum waarop de sjabloon is gemaakt.
Laatst bijgewerkt	template.templateLastUpdateDate	string	De datum waarop de sjabloon voor het laatst is bijgewerkt.
Aanpasbaar	template.editable	boolean	Geeft aan of de sjabloon kan worden bewerkt.
Aantal partijen	template.numberOfParties	integer	Het aantal geadresseerden dat in de sjabloon is gedefinieerd.
Totaal aantal pagina's	template.totalPages	integer	Het totale aantal pagina's in het sjabloondocument.
Bedrijfs-id	template.companyId	integer	De id van het bedrijf waartoe deze sjabloon behoort.
Gedeeld met alle	template.shareAll	boolean	Geeft aan of deze sjabloon wordt gedeeld met alle gebruikers in het account.
Patroon aangepaste naam	template.templateCustomName	string	Het aangepaste naampatroon dat is toegepast op enveloppen die op basis van deze sjabloon zijn gemaakt.
Machtigingen van derden	template.templatePartyPermissions	array of object	De lijst met ontvangersrollen en de bijbehorende machtigingen die in deze sjabloon zijn gedefinieerd.
Partij-id	template.templatePartyPermissions.template_party_id	integer	De unieke id van dit item van de sjabloonpartij.
Id	template.templatePartyPermissions.templateId	integer	De id van de sjabloon waartoe deze partij behoort.
toestemmingen	template.templatePartyPermissions.templatePermissions	string	De ondertekeningsmachtigingen voor deze partij (bijvoorbeeld FILL_FIELDS_AND_SIGN).
Ondertekeningsorder	template.templatePartyPermissions.partySequence	integer	De positie van de ondertekeningsorder voor deze partij.
Rol van partij	template.templatePartyPermissions.templatePartyRole	string	De rolnaam die aan deze partij is toegewezen in de sjabloon. Gebruik deze optie bij het maken van een envelop op basis van de sjabloon.
Partij-id	template.templatePartyPermissions.partyId	integer	De id van de partij die aan deze rol is toegewezen, indien vooraf toegewezen.
Gebruikers-ID	template.templateCreatedBy.partyId	integer	De unieke id van de gebruiker.
Voornaam	template.templateCreatedBy.firstName	string	De voornaam van de gebruiker.
Achternaam	template.templateCreatedBy.lastName	string	De achternaam van de gebruiker.
E-mailen	template.templateCreatedBy.emailId	string	Het e-mailadres van de gebruiker.
Bedrijfs-id	template.templateCreatedBy.companyId	integer	De id van het bedrijf waartoe de gebruiker behoort.
Gebruikersrol	template.templateCreatedBy.userRole	string	De rol van de gebruiker binnen de organisatie.
Actief	template.templateCreatedBy.active	boolean	Geeft aan of het account van de gebruiker actief is.
Gebruikers-ID	template.templateLastUpdatedBy.partyId	integer	De unieke id van de gebruiker.
Voornaam	template.templateLastUpdatedBy.firstName	string	De voornaam van de gebruiker.
Achternaam	template.templateLastUpdatedBy.lastName	string	De achternaam van de gebruiker.
E-mailen	template.templateLastUpdatedBy.emailId	string	Het e-mailadres van de gebruiker.
Bedrijfs-id	template.templateLastUpdatedBy.companyId	integer	De id van het bedrijf waartoe de gebruiker behoort.
Gebruikersrol	template.templateLastUpdatedBy.userRole	string	De rol van de gebruiker binnen de organisatie.
Actief	template.templateLastUpdatedBy.active	boolean	Geeft aan of het account van de gebruiker actief is.
Sjabloonvelden	allfields	array of object	De lijst met alle handtekening- en formuliervelden die in de sjabloon zijn gedefinieerd.
Veld-id	allfields.fieldTagId	integer	De unieke id van het veld.
Sjabloon-ID	allfields.templateId	integer	De id van de sjabloon waartoe dit veld behoort.
Bedrijfs-id	allfields.companyId	integer	Het bedrijfsaccount waartoe dit veld behoort.
Veldtype	allfields.fieldType	string	Het type veld (bijvoorbeeld signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Paginanummer	allfields.documentPageNumber	integer	Het paginanummer van het document waarin dit veld wordt geplaatst.
Verantwoordelijke partij	allfields.partyResponsible	integer	Het partijreeksnummer dat verantwoordelijk is voor het invullen van dit veld.
Partijvolgorde	allfields.partyResponsibleSequence	integer	De volgordepositie van de verantwoordelijke partij.
Id van velddocumenten	allfields.docFieldId	string	De id op documentniveau voor dit veld.
Is afhankelijk	allfields.dependent	boolean	Geeft aan of de zichtbaarheid van dit veld afhankelijk is van de waarde van een ander veld.
Tabvolgorde	allfields.tabOrder	integer	De tabvolgorde voor het navigeren tussen velden.
Required	allfields.required	boolean	Hiermee wordt aangegeven of dit veld moet worden ingevuld voordat het document kan worden ondertekend.
Naam van aangepast veld	allfields.customFieldName	string	Een aangepaste naam die aan dit veld is toegewezen.
Alles delen	allfields.shareAll	boolean	Geeft aan of dit veld wordt gedeeld met alle gebruikers.
Bewerken toestaan	allfields.allowEdit	boolean	Hiermee wordt aangegeven of dit veld kan worden bewerkt door de geadresseerde.
Naam van tekstveld	allfields.textfieldName	string	Het label van het tekstveld (van toepassing wanneer fieldType 'textfield' is).
Value	allfields.value	string	De vooraf ingevulde of ingevoerde waarde van het veld.
Tekengrootte	allfields.fontSize	integer	De tekengrootte die wordt gebruikt voor tekst in dit veld.
Trapsgewijze tekstdia 3	allfields.fontColor	string	De tekstkleur die wordt gebruikt voor tekst in dit veld (bijvoorbeeld #000000).
Alleen lezen	allfields.readOnly	boolean	Geeft aan of het veld het kenmerk Alleen-lezen heeft en niet kan worden bewerkt door de geadresseerde.
Meerdere lijnen	allfields.multiLine	boolean	Hiermee wordt aangegeven of het tekstveld meerdere regels invoer accepteert (van toepassing wanneer fieldType 'textfield' is).
Tekenlimiet	allfields.characterLimit	integer	Het maximum aantal tekens dat is toegestaan in het veld (van toepassing wanneer fieldType 'textfield' is).
Datumveldnaam	allfields.datefieldName	string	Het label van het datumveld (van toepassing wanneer fieldType 'datefield' is).
Datumnotatie	allfields.dateFormat	string	De datumnotatie die door dit veld wordt gebruikt (bijvoorbeeld MM/DD/JJJJ) (van toepassing wanneer fieldType 'datefield' is).
Naam van selectievakje	allfields.cbname	string	Het label van het selectievakjeveld (van toepassing wanneer fieldType 'checkboxfield' is).
Selectievakjegroep	allfields.cbgroup	string	De groepsnaam voor dit selectievakje (van toepassing wanneer fieldType 'checkboxfield' is).
Gecontroleerd	allfields.checked	boolean	Hiermee wordt aangegeven of het selectievakje standaard is ingeschakeld (van toepassing wanneer fieldType 'checkboxfield' is).
Beveiligde veldnaam	allfields.securedfieldName	string	Het label van het beveiligde veld (van toepassing wanneer fieldType 'securedfield' is).
Tekens die moeten worden weergegeven	allfields.charToDisplay	integer	Het aantal niet-gemaskeerde tekens dat moet worden weergegeven aan het einde van een beveiligde veldwaarde (van toepassing wanneer fieldType 'securedfield' is).
Handtekening-id	allfields.signatureId	string	De id van de handtekening die is toegepast op dit tekenveld (van toepassing wanneer fieldType 'signfield' is).
Eerste afbeelding	allfields.initialImage	string	De afbeeldingsgegevens voor de initialen die op dit veld zijn toegepast (van toepassing wanneer fieldType 'initialfield' is).
Naam van bijlageveld	allfields.attachmentfieldName	string	De naam van het bijlageveld (van toepassing wanneer fieldType 'attachmentfield' is).
Beschrijving van bijlage	allfields.attachmentfieldDescription	string	Een beschrijving van wat u moet bijvoegen (van toepassing wanneer fieldType 'attachmentfield' is).

Sjabloondetails ophalen

Bewerkings-id:: GetTemplateDetails

Hiermee haalt u de volledige details van een specifieke sjabloon op, inclusief de velden en geadresseerden.

Parameters

Name	Sleutel	Vereist	Type	Description
Sjabloon-ID	templateId	True	string	De unieke id van de sjabloon die moet worden opgehaald.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Id	template.templateId	integer	De unieke id van de sjabloon.
Naam	template.templateName	string	De naam van de sjabloon.
Description	template.templateDesc	string	Een beschrijving van de sjabloon.
Type	template.templateType	string	Het type sjabloon.
Aanmaakdatum	template.templateCreationDate	integer	De datum waarop de sjabloon is gemaakt, in Unix milliseconden.
Laatst bijgewerkt	template.templateLastUpdateDate	integer	De datum waarop de sjabloon voor het laatst is bijgewerkt, in Unix milliseconden.
Aanpasbaar	template.editable	boolean	Geeft aan of de sjabloon kan worden bewerkt.
Aantal partijen	template.numberOfParties	integer	Het aantal ondertekeningspartijen dat in de sjabloon is gedefinieerd.
Totaal aantal pagina's	template.totalPages	integer	Het totale aantal pagina's in het sjabloondocument.
Bedrijfs-id	template.companyId	integer	Het bedrijfsaccount waartoe de sjabloon behoort.
Delen met iedereen	template.shareAll	boolean	Geeft aan of de sjabloon wordt gedeeld met alle gebruikers in het account.
Patroon aangepaste naam	template.templateCustomName	string	Het aangepaste naampatroon dat is toegepast op enveloppen die op basis van deze sjabloon zijn gemaakt.
Machtigingen van derden	template.templatePartyPermissions	array of object	De lijst met rollen van geadresseerden en de bijbehorende ondertekeningsmachtigingen die in deze sjabloon zijn gedefinieerd.
Partij-id	template.templatePartyPermissions.template_party_id	integer	De unieke id van dit item van de sjabloonpartij.
Id	template.templatePartyPermissions.templateId	integer	De id van de sjabloon waartoe deze partij behoort.
toestemmingen	template.templatePartyPermissions.templatePermissions	string	De ondertekeningsmachtigingen voor deze partij (bijvoorbeeld FILL_FIELDS_AND_SIGN).
Ondertekeningsorder	template.templatePartyPermissions.partySequence	integer	De positie van de ondertekeningsorder voor deze partij.
Rol van partij	template.templatePartyPermissions.templatePartyRole	string	De rolnaam die aan deze partij is toegewezen. Gebruik deze waarde bij het maken van een envelop op basis van deze sjabloon.
Partij-id	template.templatePartyPermissions.partyId	integer	De id van de partij die aan deze rol is toegewezen, indien vooraf toegewezen.
Partij-id	template.templateCreatedBy.partyId	integer	De unieke id van de gebruiker.
Voornaam	template.templateCreatedBy.firstName	string	De voornaam van de gebruiker.
Achternaam	template.templateCreatedBy.lastName	string	De achternaam van de gebruiker.
E-mailen	template.templateCreatedBy.emailId	string	Het e-mailadres van de gebruiker.
Afdeling	template.templateCreatedBy.department	string	De afdeling van de gebruiker.
Title	template.templateCreatedBy.title	string	De functie van de gebruiker.
Actief	template.templateCreatedBy.active	boolean	Geeft aan of het gebruikersaccount actief is.
Partij-id	template.templateLastUpdatedBy.partyId	integer	De unieke id van de gebruiker.
Voornaam	template.templateLastUpdatedBy.firstName	string	De voornaam van de gebruiker.
Achternaam	template.templateLastUpdatedBy.lastName	string	De achternaam van de gebruiker.
E-mailen	template.templateLastUpdatedBy.emailId	string	Het e-mailadres van de gebruiker.
Afdeling	template.templateLastUpdatedBy.department	string	De afdeling van de gebruiker.
Title	template.templateLastUpdatedBy.title	string	De functie van de gebruiker.
Actief	template.templateLastUpdatedBy.active	boolean	Geeft aan of het gebruikersaccount actief is.
Alle velden	allfields	array of object	De lijst met alle velden die in deze sjabloon zijn gedefinieerd.
Veldtag-id	allfields.fieldTagId	integer	De unieke id van het veld.
Sjabloon-ID	allfields.templateId	integer	De id van de sjabloon waartoe dit veld behoort.
Bedrijfs-id	allfields.companyId	integer	Het bedrijfsaccount waartoe dit veld behoort.
Veldtype	allfields.fieldType	string	Het type veld (bijvoorbeeld signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Paginanummer	allfields.documentPageNumber	integer	Het paginanummer van het document waarin dit veld wordt geplaatst.
Verantwoordelijke partij	allfields.partyResponsible	integer	Het volgnummer van de partij dat verantwoordelijk is voor het voltooien van dit veld.
Partijvolgorde	allfields.partyResponsibleSequence	integer	De volgordepositie van de verantwoordelijke partij.
Documentveld-id	allfields.docFieldId	string	De id van dit veld in het document.
Afhankelijk	allfields.dependent	boolean	Geeft aan of de zichtbaarheid van dit veld afhankelijk is van de waarde van een ander veld.
Tabvolgorde	allfields.tabOrder	integer	De tabvolgorde voor het navigeren tussen velden.
Required	allfields.required	boolean	Hiermee wordt aangegeven of dit veld moet worden voltooid voordat het document kan worden ondertekend.
Naam van aangepast veld	allfields.customFieldName	string	Een aangepaste naam die aan dit veld is toegewezen.
Alles delen	allfields.shareAll	boolean	Geeft aan of dit veld wordt gedeeld met alle gebruikers.
Bewerken toestaan	allfields.allowEdit	boolean	Hiermee wordt aangegeven of dit veld kan worden bewerkt door de geadresseerde.
Naam van tekstveld	allfields.textfieldName	string	Het label van het tekstveld (van toepassing wanneer fieldType 'textfield' is).
Value	allfields.value	string	De vooraf ingevulde of ingevoerde waarde van het veld.
Tekengrootte	allfields.fontSize	integer	De tekengrootte die wordt gebruikt voor tekst in dit veld.
Trapsgewijze tekstdia 3	allfields.fontColor	string	De tekstkleur die wordt gebruikt voor tekst in dit veld (bijvoorbeeld #000000).
Alleen lezen	allfields.readOnly	boolean	Geeft aan of het veld het kenmerk Alleen-lezen heeft en niet kan worden bewerkt door de geadresseerde.
Meerdere lijnen	allfields.multiLine	boolean	Hiermee wordt aangegeven of het tekstveld meerdere regels invoer accepteert (van toepassing wanneer fieldType 'textfield' is).
Tekenlimiet	allfields.characterLimit	integer	Het maximum aantal tekens dat is toegestaan in het veld (van toepassing wanneer fieldType 'textfield' is).
Datumveldnaam	allfields.datefieldName	string	Het label van het datumveld (van toepassing wanneer fieldType 'datefield' is).
Datumnotatie	allfields.dateFormat	string	De datumnotatie die door dit veld wordt gebruikt (bijvoorbeeld MM/DD/JJJJ) (van toepassing wanneer fieldType 'datefield' is).
Naam van selectievakje	allfields.cbname	string	Het label van het selectievakjeveld (van toepassing wanneer fieldType 'checkboxfield' is).
Selectievakjegroep	allfields.cbgroup	string	De groepsnaam voor dit selectievakje, gebruikt wanneer meerdere selectievakjes zijn gekoppeld (van toepassing wanneer fieldType 'checkboxfield' is).
Gecontroleerd	allfields.checked	boolean	Hiermee wordt aangegeven of het selectievakje standaard is ingeschakeld (van toepassing wanneer fieldType 'checkboxfield' is).
Beveiligde veldnaam	allfields.securedfieldName	string	Het label van het beveiligde veld (van toepassing wanneer fieldType 'securedfield' is).
Tekens die moeten worden weergegeven	allfields.charToDisplay	integer	Het aantal niet-gemaskeerde tekens dat moet worden weergegeven aan het einde van een beveiligde veldwaarde (van toepassing wanneer fieldType 'securedfield' is).
Handtekening-id	allfields.signatureId	string	De id van de handtekening die is toegepast op dit tekenveld (van toepassing wanneer fieldType 'signfield' is).
Eerste afbeelding	allfields.initialImage	string	De afbeeldingsgegevens voor de initialen die op dit veld zijn toegepast (van toepassing wanneer fieldType 'initialfield' is).
Naam van bijlageveld	allfields.attachmentfieldName	string	De naam van het bijlageveld (van toepassing wanneer fieldType 'attachmentfield' is).
Beschrijving van bijlage	allfields.attachmentfieldDescription	string	Een beschrijving van wat u moet bijvoegen (van toepassing wanneer fieldType 'attachmentfield' is).

Verwijderde envelopgeschiedenis ophalen

Bewerkings-id:: GetDeletedEnvelopeHistory

Hiermee wordt een geschiedenis opgehaald van enveloppen die zijn verwijderd of verplaatst naar de Prullenbak.

Parameters

Name	Sleutel	Vereist	Type	Description
Envelop-id	folderId	True	string	De unieke id van de envelop waarvan u de verwijderingsgeschiedenis wilt ophalen.

Retouren

Name	Pad	Type	Description
Result	result	string	Geeft aan of de aanvraag is geslaagd.
Verwijderde envelopgegevens	Deleted Folder Log Info	array of object	Samenvattingsinformatie over de verwijderde envelop.
Envelop-id	Deleted Folder Log Info.folderId	integer	De unieke id van de verwijderde envelop.
Envelopnaam	Deleted Folder Log Info.folderName	string	De naam van de verwijderde envelop.
Documentnaam	Deleted Folder Log Info.documentName	string	De naam van het document in de verwijderde envelop.
Document-ID	Deleted Folder Log Info.documentId	string	De unieke id van het document in de verwijderde envelop.
Verwijderingsdatum	Deleted Folder Log Info.deletionDate	integer	De datum en tijd waarop de envelop is verwijderd, in Unix milliseconden.
Verwijderd door	Deleted Folder Log Info.deletedBy	string	De naam van de gebruiker die de envelop heeft verwijderd.
Geschiedenis van verwijderingslogboek	Deleted Folder Log History	array of object	Het stapsgewijze logboek van alle verwijderingsacties die op de envelop worden uitgevoerd.
Uitgevoerd door	Deleted Folder Log History.partiesName	string	De naam van de gebruiker die de verwijderingsstap heeft uitgevoerd.
Bron	Deleted Folder Log History.source	string	De bron waaruit de verwijdering is geïnitieerd (bijvoorbeeld Web, API).
Event	Deleted Folder Log History.event	string	De specifieke verwijderingsactie uitgevoerd (bijvoorbeeld Map verwijderen, Alle partijen uit map verwijderen).

Webhooktrigger afmelden

Bewerkings-id:: DeleteTriggerWebhookChannel

Hiermee verwijdert u een actief webhookkanaalabonnement op basis van de kanaal-id. Gebruik deze actie om webhookabonnementen op te schonen die niet meer nodig zijn.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaal-ID	channelId	True	integer	De id van het webhookkanaal dat u wilt verwijderen.

Triggers

Wanneer een envelop is ondertekend	Wordt geactiveerd wanneer een geadresseerde de envelop ondertekent.
Wanneer een envelop volledig wordt uitgevoerd	Triggers wanneer alle geadresseerden zijn ondertekend en de envelop volledig wordt uitgevoerd.
Wanneer een envelop wordt bekeken	Wordt geactiveerd wanneer een geadresseerde wordt geopend en de envelop bekijkt.
Wanneer een envelop wordt geannuleerd	Triggers wanneer een envelop wordt geannuleerd door een geadresseerde of de afzender.
Wanneer een envelop wordt verwijderd	Triggers wanneer een envelop wordt verwijderd.
Wanneer een envelop wordt verzonden	Triggers wanneer een envelop naar geadresseerden wordt verzonden. Deze gebeurtenis wordt alleen geactiveerd wanneer webhookniveau is ingesteld op 'Account'.

Wanneer een envelop is ondertekend

Bewerkings-id:: TriggerEnvelopeSigned

Wordt geactiveerd wanneer een geadresseerde de envelop ondertekent.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaalnaam	channelName	True	string	Een naam om dit webhookabonnement in uw account te identificeren.
Webhookniveau	webhookLevel	True	string	Account: wordt geactiveerd voor alle enveloppen (web en API). API-app: wordt alleen geactiveerd voor enveloppen die zijn gemaakt via de API.
Webhookgeheim	webhookSecret		string	Optional. Foxit eSign ondertekent elke nettolading van de webhook met HMAC-SHA-256 met behulp van dit geheim voor verificatie.

Retouren

De gebeurtenisgegevens die zijn ontvangen van Foxit eSign wanneer een webhookgebeurtenis wordt geactiveerd.

WebhookEventPayload: WebhookEventPayload

Wanneer een envelop volledig wordt uitgevoerd

Bewerkings-id:: TriggerEnvelopeExecuted

Triggers wanneer alle geadresseerden zijn ondertekend en de envelop volledig wordt uitgevoerd.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaalnaam	channelName	True	string	Een naam om dit webhookabonnement in uw account te identificeren.
Webhookniveau	webhookLevel	True	string	Account: wordt geactiveerd voor alle enveloppen (web en API). API-app: wordt alleen geactiveerd voor enveloppen die zijn gemaakt via de API.
Webhookgeheim	webhookSecret		string	Optional. Foxit eSign ondertekent elke nettolading van de webhook met HMAC-SHA-256 met behulp van dit geheim voor verificatie.

Retouren

De gebeurtenisgegevens die zijn ontvangen van Foxit eSign wanneer een webhookgebeurtenis wordt geactiveerd.

WebhookEventPayload: WebhookEventPayload

Wanneer een envelop wordt bekeken

Bewerkings-id:: TriggerEnvelopeViewed

Wordt geactiveerd wanneer een geadresseerde wordt geopend en de envelop bekijkt.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaalnaam	channelName	True	string	Een naam om dit webhookabonnement in uw account te identificeren.
Webhookniveau	webhookLevel	True	string	Account: wordt geactiveerd voor alle enveloppen (web en API). API-app: wordt alleen geactiveerd voor enveloppen die zijn gemaakt via de API.
Webhookgeheim	webhookSecret		string	Optional. Foxit eSign ondertekent elke nettolading van de webhook met HMAC-SHA-256 met behulp van dit geheim voor verificatie.

Retouren

De gebeurtenisgegevens die zijn ontvangen van Foxit eSign wanneer een webhookgebeurtenis wordt geactiveerd.

WebhookEventPayload: WebhookEventPayload

Wanneer een envelop wordt geannuleerd

Bewerkings-id:: TriggerEnvelopeCancelled

Triggers wanneer een envelop wordt geannuleerd door een geadresseerde of de afzender.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaalnaam	channelName	True	string	Een naam om dit webhookabonnement in uw account te identificeren.
Webhookniveau	webhookLevel	True	string	Account: wordt geactiveerd voor alle enveloppen (web en API). API-app: wordt alleen geactiveerd voor enveloppen die zijn gemaakt via de API.
Webhookgeheim	webhookSecret		string	Optional. Foxit eSign ondertekent elke nettolading van de webhook met HMAC-SHA-256 met behulp van dit geheim voor verificatie.

Retouren

De gebeurtenisgegevens die zijn ontvangen van Foxit eSign wanneer een webhookgebeurtenis wordt geactiveerd.

WebhookEventPayload: WebhookEventPayload

Wanneer een envelop wordt verwijderd

Bewerkings-id:: TriggerEnvelopeDeleted

Triggers wanneer een envelop wordt verwijderd.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaalnaam	channelName	True	string	Een naam om dit webhookabonnement in uw account te identificeren.
Webhookniveau	webhookLevel	True	string	Account: wordt geactiveerd voor alle enveloppen (web en API). API-app: wordt alleen geactiveerd voor enveloppen die zijn gemaakt via de API.
Webhookgeheim	webhookSecret		string	Optional. Foxit eSign ondertekent elke nettolading van de webhook met HMAC-SHA-256 met behulp van dit geheim voor verificatie.

Retouren

De gebeurtenisgegevens die zijn ontvangen van Foxit eSign wanneer een webhookgebeurtenis wordt geactiveerd.

WebhookEventPayload: WebhookEventPayload

Wanneer een envelop wordt verzonden

Bewerkings-id:: TriggerEnvelopeSent

Triggers wanneer een envelop naar geadresseerden wordt verzonden. Deze gebeurtenis wordt alleen geactiveerd wanneer webhookniveau is ingesteld op 'Account'.

Parameters

Name	Sleutel	Vereist	Type	Description
Kanaalnaam	channelName	True	string	Een naam om dit webhookabonnement in uw account te identificeren.
Webhookniveau	webhookLevel	True	string	Account: wordt geactiveerd voor enveloppen die worden verzonden via web of API. API-app: wordt alleen geactiveerd voor enveloppen die zijn gemaakt via de API. De folder_sent gebeurtenis wordt alleen geactiveerd op accountniveau.
Webhookgeheim	webhookSecret		string	Optional. Foxit eSign ondertekent elke nettolading van de webhook met HMAC-SHA-256 met behulp van dit geheim voor verificatie.

Retouren

De gebeurtenisgegevens die zijn ontvangen van Foxit eSign wanneer een webhookgebeurtenis wordt geactiveerd.

WebhookEventPayload: WebhookEventPayload

Definities

WebhookEventPayload

De gebeurtenisgegevens die zijn ontvangen van Foxit eSign wanneer een webhookgebeurtenis wordt geactiveerd.

Name	Pad	Type	Description
Gebeurtenisnaam	event_name	string	De naam van de gebeurtenis die is geactiveerd (bijvoorbeeld folder_sent, folder_signed, folder_executed).
Gebeurtenisdatum	event_date	integer	De datum en tijd waarop de gebeurtenis heeft plaatsgevonden (Unix-tijdstempel in milliseconden).
Id	data.folder.folderId	integer	De unieke id van de envelop.
Naam	data.folder.folderName	string	De naam van de envelop.
Aangepaste naam	data.folder.folderCustomName	string	De aangepaste naam die aan de envelop is toegewezen.
Password	data.folder.folderPassword	string	Het toegangswachtwoord voor de envelop, indien ingesteld.
Creator-id	data.folder.folderAuthorId	integer	De gebruikers-id van de maker van de envelop.
Voornaam maker	data.folder.folderAuthorFirstName	string	De voornaam van de maker van de envelop.
Achternaam van maker	data.folder.folderAuthorLastName	string	De achternaam van de maker van de envelop.
E-mail maker	data.folder.folderAuthorEmail	string	Het e-mailadres van de maker van de envelop.
Rol maker	data.folder.folderAuthorRole	string	De accountrol van de maker van de envelop.
Bedrijfs-id	data.folder.folderCompanyId	integer	De bedrijfs-id die eigenaar is van de envelop.
Aanmaakdatum	data.folder.folderCreationDate	integer	De datum waarop de envelop is gemaakt (Unix-tijdstempel in milliseconden).
Verzonden datum	data.folder.folderSentDate	integer	De datum waarop de envelop is verzonden (Unix-tijdstempel in milliseconden).
Status	data.folder.folderStatus	string	De huidige status van de envelop.
Aangepast veld 1	data.folder.custom_field1	string	Het eerste aangepaste metagegevensveld.
Aangepast veld 2	data.folder.custom_field2	string	Het tweede aangepaste metagegevensveld.
Metagegevens	data.folder.metadata	string	Aangepaste metagegevens die zijn gekoppeld aan de envelop.
Document-ID's	data.folder.folderDocumentIds	array of integer	De lijst met document-id's in de envelop.
Documents	data.folder.documentsList	array of object	De lijst met documenten in de envelop.
Document-ID	data.folder.documentsList.documentId	integer	De unieke identificatie van het document.
Contract-id	data.folder.documentsList.contractId	integer	De contract-id voor dit document.
Bedrijfs-id	data.folder.documentsList.companyId	integer	De bedrijfs-id voor dit document.
Gemaakt door	data.folder.documentsList.contractCreatedBy	integer	De gebruikers-id van de persoon die het contract heeft gemaakt.
Gemaakt op	data.folder.documentsList.contractCreatedOn	integer	De datum waarop het contract is gemaakt (Unix-tijdstempel in milliseconden).
Contractsoort	data.folder.documentsList.contractType	string	Het type contract.
Contractstatus	data.folder.documentsList.contractStatus	string	De huidige status van het contract.
Aanpasbaar	data.folder.documentsList.editable	boolean	Geeft aan of het document kan worden bewerkt.
Versie-id	data.folder.documentsList.contractVersionId	integer	De versie-id van het contract.
Versienaam	data.folder.documentsList.contractVersionName	string	De naam van de contractversie.
Versiebeschrijving	data.folder.documentsList.contractVersionDesc	string	Een beschrijving van de contractversie.
Versie gemaakt door	data.folder.documentsList.versionCreatedby	integer	De gebruikers-id van de persoon die deze versie heeft gemaakt.
Versie gemaakt op	data.folder.documentsList.versionCreatedOn	integer	De datum waarop deze versie is gemaakt (Unix-tijdstempel in milliseconden).
Versienummer	data.folder.documentsList.contractVersionNumber	integer	Het versienummer van het contract.
Transactiebron	data.folder.documentsList.contractTransactionSource	string	Het bronsysteem dat het contract heeft gestart.
Ontvangers	data.folder.folderRecipientParties	array of object	De lijst met geadresseerden voor deze envelop.
Ontvanger-id	data.folder.folderRecipientParties.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	data.folder.folderRecipientParties.partyDetails.partyId	integer	De unieke id van de ontvanger.
Voornaam	data.folder.folderRecipientParties.partyDetails.firstName	string	De voornaam van de geadresseerde.
Achternaam	data.folder.folderRecipientParties.partyDetails.lastName	string	De achternaam van de geadresseerde.
E-mailen	data.folder.folderRecipientParties.partyDetails.emailId	string	Het e-mailadres van de geadresseerde.
Tijdelijke aanduiding	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Of dit een tijdelijke aanduiding voor geadresseerde is.
Address	data.folder.folderRecipientParties.partyDetails.address	string	Het adres van de geadresseerde.
Aanmaakdatum	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	De datum waarop de geadresseerderecord is gemaakt (Unix-tijdstempel in milliseconden).
Afmelden voor e-mailberichten	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Of de geadresseerde zich heeft afgemeld voor e-mailberichten.
Unieke ID	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Een unieke systeem-id voor deze ontvanger.
Verificatieniveau	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	De verificatiemethode voor deze ontvanger.
Datum van wachtwoord bijgewerkt	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	De datum waarop het wachtwoord voor het laatst is bijgewerkt.
Wachtwoordstatus	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Of het wachtwoord is bijgewerkt.
Kiescode	data.folder.folderRecipientParties.dialingCode	string	De internationale kiescode.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	Het mobiele nummer van de ontvanger.
Handtekeningtype	data.folder.folderRecipientParties.signerSignatureType	string	Het type handtekening dat de ondertekenaar gebruikt.
toestemmingen	data.folder.folderRecipientParties.contractPermissions	string	De machtigingen die aan deze geadresseerde zijn verleend.
Ondertekeningsorder	data.folder.folderRecipientParties.partySequence	integer	De ondertekeningsvolgorde voor deze geadresseerde.
Werkstroomvolgorde	data.folder.folderRecipientParties.workflowSignSequence	integer	Het volgnummer van de werkstroomondertekening.
Envelop-id	data.folder.folderRecipientParties.envelopeId	integer	De envelop-id die aan deze geadresseerde is gekoppeld.
Bedrijfs-id van geadresseerde	data.folder.folderRecipientParties.partyCompanyId	integer	De bedrijfs-id van deze ontvanger.
Deelmodus	data.folder.folderRecipientParties.sharingMode	string	De modus voor delen voor deze geadresseerde.
Url voor ondertekening van geadresseerden	data.folder.folderRecipientParties.folderAccessURL	string	De URL voor deze geadresseerde om de envelop te openen en te ondertekenen.
Beveiligingsmodus	data.folder.folderRecipientParties.securityMode	string	De beveiligingsmodus voor deze ontvanger.
Comments	data.folder.folderRecipientParties.extraComments	string	Aanvullende opmerkingen voor de ontvanger.
Naamwijziging toestaan	data.folder.folderRecipientParties.allowNameChange	boolean	Of de geadresseerde zijn of haar naam kan bijwerken.
Naam bijgewerkt	data.folder.folderRecipientParties.signerNameUpdated	boolean	Of de ondertekenaar zijn of haar naam heeft bijgewerkt.
Verificatieniveau ondertekenaar	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de ondertekenaar.
Toegangscode	data.folder.folderRecipientParties.userDefinedAccessCode	string	Een aangepaste toegangscode voor de ondertekenaar.
Handtekening-id	data.folder.folderRecipientParties.signatureId	string	De id van de toegepaste handtekening.
Role	data.folder.folderRecipientParties.partyRole	string	De rol van deze ontvanger in de werkstroom voor ondertekening.
Bedrijfsveld	data.folder.folderRecipientParties.companyFieldValue	string	De waarde van het veld bedrijfsnaam.
Titelveld	data.folder.folderRecipientParties.titleFieldValue	string	De waarde van het titelveld.
Reden voor ondertekening	data.folder.folderRecipientParties.reasonSigning	string	De reden voor ondertekening.
Betalingsveld toegevoegd	data.folder.folderRecipientParties.payFieldAdded	boolean	Of er een betalingsveld is toegevoegd.
Begunstigde	data.folder.folderRecipientParties.payee	boolean	Of deze ontvanger de begunstigde is.
Terugkerende betaling	data.folder.folderRecipientParties.recurringFieldExist	boolean	Of er een terugkerend betalingsveld bestaat.
Afdrukken en ondertekenen voltooid	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Of afdrukken en ondertekenen is voltooid.
Optionele ondertekenaar	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Of deze geadresseerde een optionele ondertekenaar is.
Optionele ondertekenaars	data.folder.folderRecipientParties.optionalSigners	array of integer	Optionele id's van ondertekenaar.
Paid	data.folder.folderRecipientParties.paid	boolean	Of de betaling is voltooid.
URL voor auteurtoegang	data.folder.folderAccessURLForAuthor	string	De URL voor de auteur van de envelop voor toegang tot de envelop.
Concepttoegangs-URL	data.folder.draftFolderAccessURL	string	De URL voor toegang tot de envelop in de conceptstatus.
Bordruimteondertekening	data.folder.boardRoomSign	boolean	Of de ondertekeningsmodus van de boardroom is ingeschakeld.
Logo opnemen	data.folder.includeLogo	boolean	Of het bedrijfslogo is opgenomen in e-mailberichten.
Achtergrondkleur van knop	data.folder.email_btnBgColor	string	De achtergrondkleur van de actieknop voor e-mail.
Tekstkleur van knop	data.folder.email_btnTxtColor	string	De tekstkleur van de actieknop voor e-mail.
E-maillogo	data.folder.emailTemplateLogo	string	De logo-URL die wordt gebruikt in de e-mailsjabloon.
E-mailsjabloon-id	data.folder.emailTemplateId	integer	De id van de gebruikte e-mailsjabloon.
E-mailkoptekst	data.folder.emailHeader	string	De koptekst in e-mailberichten met meldingen.
E-mailvoettekst	data.folder.emailFooter	string	De voettekst in e-mailberichten met meldingen.
Geplande opschoning	data.folder.purgeFlag	boolean	Of de envelop is gepland voor opschonen.
Begindatum opschonen	data.folder.purgeStartDate	string	De begindatum voor de opschoningsplanning.
Einddatum opschonen	data.folder.purgeEndDate	string	De einddatum voor de opschoningsplanning.
Bulk-id	data.folder.bulkId	integer	De bewerkings-id voor bulksgewijs verzenden, indien van toepassing.
Handtekeningvolgorde afdwingen	data.folder.enforceSignWorkflow	boolean	Of geadresseerden zich moeten aanmelden bij de gedefinieerde volgorde.
Huidige werkstroomstap	data.folder.currentWorkflowStep	integer	De huidige stap in de werkstroom voor ondertekening.
Transactiebron	data.folder.transactionSource	string	Het bronsysteem dat deze transactie heeft gestart.
Aanpasbaar	data.folder.editable	boolean	Of de envelop bewerkbaar is.
In-Person ondertekenen	data.folder.inPersonSignable	boolean	Of de envelop ondersteuning biedt voor persoonlijk ondertekenen.
Herinneringen overschrijven	data.folder.overrideAccountReminders	boolean	Of de instellingen voor herinneringen op accountniveau worden overschreven.
Overdracht overschrijven	data.folder.overrideAccountRecipientDelegation	boolean	Of de instellingen voor delegering op accountniveau worden overschreven.
Delegatie toestaan	data.folder.allowRecipientsToDelegate	boolean	Of geadresseerden ondertekening kunnen delegeren.
Id	data.folder.envelopeId	integer	De unieke envelop-id (alias van folderId).
Naam	data.folder.envelopeName	string	De naam van de envelop (alias van folderName).
Originator-id	data.folder.envelopeOriginatorId	integer	De gebruikers-id die afkomstig is van de envelop.
Bedrijfs-id	data.folder.envelopeCompanyId	integer	De bedrijfs-id die eigenaar is van de envelop.
Date	data.folder.envelopeDate	integer	De datum waarop de envelop is gemaakt (Unix-tijdstempel in milliseconden).
Gedeelde datum	data.folder.envelopeSharedDate	integer	De datum waarop de envelop is gedeeld (Unix-tijdstempel in milliseconden).
Status	data.folder.envelopeStatus	string	De huidige status van de envelop.
Contract-id's	data.folder.envelopeContractIds	array of integer	De contract-id's die aan deze envelop zijn gekoppeld.
Machtigingen van derden	data.folder.envelopePartyPermissions	array of object	De lijst met machtigingen voor geadresseerden (dezelfde structuur als ontvangers).
Ontvanger-id	data.folder.envelopePartyPermissions.partyId	integer	De unieke id van de ontvanger.
Ontvanger-id	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Voornaam	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Achternaam	data.folder.envelopePartyPermissions.partyDetails.lastName	string
E-mailen	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Tijdelijke aanduiding	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Aanmaakdatum	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Afmelden voor e-mailberichten	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Unieke ID	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Verificatieniveau	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Datum van wachtwoord bijgewerkt	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Wachtwoordstatus	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Kiescode	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Handtekeningtype	data.folder.envelopePartyPermissions.signerSignatureType	string
toestemmingen	data.folder.envelopePartyPermissions.contractPermissions	string
Ondertekeningsorder	data.folder.envelopePartyPermissions.partySequence	integer
Werkstroomvolgorde	data.folder.envelopePartyPermissions.workflowSignSequence	integer
Envelop-id	data.folder.envelopePartyPermissions.envelopeId	integer
Bedrijfs-id van geadresseerde	data.folder.envelopePartyPermissions.partyCompanyId	integer
Deelmodus	data.folder.envelopePartyPermissions.sharingMode	string
Url voor ondertekening van geadresseerden	data.folder.envelopePartyPermissions.folderAccessURL	string
Beveiligingsmodus	data.folder.envelopePartyPermissions.securityMode	string
Comments	data.folder.envelopePartyPermissions.extraComments	string
Naamwijziging toestaan	data.folder.envelopePartyPermissions.allowNameChange	boolean
Naam bijgewerkt	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Verificatieniveau ondertekenaar	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Toegangscode	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
Handtekening-id	data.folder.envelopePartyPermissions.signatureId	string
Role	data.folder.envelopePartyPermissions.partyRole	string
Bedrijfsveld	data.folder.envelopePartyPermissions.companyFieldValue	string
Titelveld	data.folder.envelopePartyPermissions.titleFieldValue	string
Reden voor ondertekening	data.folder.envelopePartyPermissions.reasonSigning	string
Betalingsveld toegevoegd	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Begunstigde	data.folder.envelopePartyPermissions.payee	boolean
Terugkerende betaling	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Afdrukken en ondertekenen voltooid	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Optionele ondertekenaar	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Optionele ondertekenaars	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Paid	data.folder.envelopePartyPermissions.paid	boolean
Verificatieniveau	data.folder.envelopeAuthenticationLevel	string	Het verificatieniveau dat is vereist voor de envelop.
Bulk voor eenmalige aanmelding	data.folder.allowSingleSignerInBulk	boolean	Of een eenmalige ondertekenaar is toegestaan in bulkmodus.
File-Based mapnaam	data.folder.folderNameBasedOnFileNaming	boolean
naam van File-Based document	data.folder.documentNameBasedOnFileNaming	boolean
File-Based certificaatnaam	data.folder.certificateNameBasedOnFileNaming	boolean
Naamgeving van pre-exec-bestanden	data.folder.enableFileNamingBeforeExecution	boolean
Payee Added	data.folder.payeeAddedd	boolean
Self-Signing ingeschakeld	data.folder.selfSignerEnabled	boolean
Notaris ingeschakeld	data.folder.notaryEnabled	boolean
Beperkte zichtbaarheid	data.folder.limitedVisibilityFlag	boolean
Zichtbaarheid na ondertekening	data.folder.postSigningVisibility	boolean
Natte handtekening	data.folder.wetSignatureEnabled	boolean
Samenvoegen ingeschakeld	data.folder.mergeEnabled	boolean

binary

Dit is het basisgegevenstype 'binair'.