Foxit eSign (förhandsversion)

Foxit eSign är en elektronisk signaturlösning som gör att du kan skicka, signera och hantera dokument online – vilket eliminerar behovet av utskrift, genomsökning eller utskick. Ladda upp dokumentet, definiera signaturfält och skicka det till mottagarna för snabba, juridiskt bindande eSignatures.

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

Service Class Regions
Copilot Studio Premium Alla Power Automate regioner förutom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Standard Alla Logic Apps-regioner utom följande:
     - Azure Government regioner
     - Azure kinaregioner
     - US Department of Defense (DoD)
Power Apps Premium Alla Power Apps regioner förutom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alla Power Automate regioner förutom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Contact
Name Stöd för Foxit eSign
URL https://www.foxit.com
E-postmeddelande api@foxit.com
Metadata för anslutningsprogram
Publisher Foxit Software Inc.
Webbplats https://www.foxit.com/esign-pdf/
Sekretesspolicy https://www.foxit.com/company/privacy-policy.html
Kategorier Produktivitet; Innehåll och filer

Foxit eSign

Foxit eSign är en elektronisk signaturlösning i företagsklass som gör det möjligt för företag att skicka, signera och hantera juridiskt bindande dokument helt online – vilket eliminerar behovet av utskrift, genomsökning eller utskick. Ladda upp dokumentet, definiera signaturfält och skicka det till mottagarna för snabba, säkra eSignatures. Foxit eSign är helt kompatibelt med viktiga lagar för elektroniska signaturer, inklusive ESIGN och UETA, använder kryptering för att skydda dokument under överföring och i vila och stöder multifaktorautentisering för att säkerställa att endast auktoriserade undertecknare kan komma åt och signera dina dokument.

Med Foxit eSign-anslutningsappen för Microsoft Power Automate kan du automatisera ditt fullständiga arbetsflöde för dokumentsignering – från att skapa kuvert och skicka dem för signatur, till att spåra status, ladda ned slutförda dokument, hantera mallar och utlösa underordnade åtgärder när kuverthändelser inträffar.

Publisher: Foxit Corporation

Förutsättningar

Om du vill använda den här anslutningsappen behöver du:

  • En Microsoft Power Apps- eller Power Automate-plan med anpassad anslutningsapp eller premiumanslutningsåtkomst
  • Ett Foxit eSign-konto – skapa ett här
  • API-åtkomst aktiverad på ditt Foxit eSign-konto (se Hämta autentiseringsuppgifter nedan)

Hämta autentiseringsuppgifter

  1. Skapa ett Foxit eSign-konto om du inte redan har ett.
  2. Kontakta Foxit Sales-teamet för att begära ATT API-åtkomst ska aktiveras på ditt konto. När api-åtkomsten har godkänts aktiveras den på ditt konto.
  3. I Power Automate söker du efter Foxit eSign i anslutningslistan och väljer Skapa anslutning.
  4. Du omdirigeras till foxit eSign-inloggningssidan. Logga in med dina Foxit eSign-autentiseringsuppgifter för att auktorisera anslutningen.
  5. När anslutningen har godkänts är den redo att användas i dina flöden.

Getting Started

När du har skapat en anslutning kan du börja skapa flöden med hjälp av Foxit eSign-anslutningsappen:

  • Använd utlösare för att starta ett flöde automatiskt när en kuverthändelse inträffar (t.ex. när alla parter har signerat).
  • Använd åtgärder för att skapa kuvert, skicka signaturpåminnelser, ladda ned slutförda dokument, hantera mallar med mera.
  • Länka flera åtgärder tillsammans – till exempel skapa ett kuvert från en mall, vänta på den fullständigt utförda utlösaren och ladda sedan ned det signerade dokumentet och lagra det i SharePoint.

Utlösare som stöds

Trigger Description
När ett kuvert skickas Utlöses när ett kuvert skickas till mottagarna. Kräver webhooknivå inställd på Konto.
När ett kuvert visas Utlöses när en mottagare öppnas och visar kuvertet.
När ett kuvert signeras Utlöses när en mottagare signerar kuvertet.
När ett kuvert avbryts Utlöses när ett kuvert avbryts av en mottagare eller avsändaren.
När ett kuvert körs fullständigt Utlöses när alla mottagare har signerat och kuvertet är helt klart.
När ett kuvert tas bort Utlöses när ett kuvert tas bort.

Åtgärder som stöds

Kuvert

Action Description
Skapa kuvert från URL Skapar och skickar ett kuvert med en offentligt tillgänglig PDF-URL.
Skapa kuvert från Base64 Skapar och skickar ett kuvert med ett Base64-kodat PDF-dokument.
Skapa kuvert från mall Skapar och skickar ett kuvert från en befintlig Foxit eSign-mall.
Hämta kuvertinformation Hämtar fullständig information och aktuell status för ett kuvert.
Hämta kuvert-ID:t Hämtar en lista över kuvert-ID:t baserat på filtervillkor.
Skicka signaturpåminnelse Skickar ett påminnelsemeddelande till väntande undertecknare av ett kuvert.
Ladda ned kuvertfiler Laddar ned alla signerade dokument i ett kuvert som en zip-fil.
Ladda ned PDF-fil för enskilda dokument Laddar ned ett enda dokument från ett kuvert som PDF.
Flytta kuvert till papperskorgen Flyttar ett eller flera kuvert till papperskorgen.
Avbryt kuvert Avbryter ett kuvert och meddelar mottagarna.
Ta bort kuvert Tar bort ett eller flera kuvert permanent.
Hämta historik för kuvertaktivitet Hämtar den fullständiga aktivitetsloggen för ett kuvert.
Hämta borttagen kuverthistorik Hämtar historiken för borttagna kuvert i kontot.

Mallar

Action Description
Skapa mall från URL Skapar en återanvändbar signeringsmall med en offentligt tillgänglig PDF-URL.
Skapa mall från Base64 Skapar en återanvändbar signeringsmall med hjälp av ett Base64-kodat PDF-dokument.
Hämta mallinformation Hämtar fullständig information om en specifik mall, inklusive fältdefinitioner.
Hämta mallar efter mall-ID Hämtar information om en eller flera mallar med sina ID:n.
Hämta en lista över alla mallar Hämtar alla tillgängliga mallar i kontot.

Webhooks

Action Description
Visa en lista över alla Webhook-kanaler Returnerar en lista över alla webhook-kanaler som konfigurerats i kontot.
Hämta information om Webhook-kanalen Hämtar information om en specifik webhook-kanal.

E-postgrupper

Action Description
Skapa e-postgrupp Skapar en ny e-postgrupp som ska användas som mottagare i kuvert.
Hämta information om e-postgrupp Hämtar information och medlemmar i en e-postgrupp.

Rapporter

Action Description
Ladda ned rapport Laddar ned en kontoaktivitetsrapport i Microsoft Excel format.

Kända problem och begränsningar

  • Hastighetsgräns: Foxit eSign API tillåter upp till 4 000 begäranden per 5 minuter per konto. Begäranden som överskrider den här gränsen får ett 429 Too Many Requests svar. Vi rekommenderar att du implementerar omprövningslogik med exponentiell backoff i dina flöden för att hantera detta på ett korrekt sätt.

  • Filstorleksgräns: Den maximala filstorleken per dokument är 25 MB. Den här gränsen gäller för enskilda filer, inte den totala kuvertstorleken.

  • Webhook Auto-Unsubscribe: På grund av en begränsning i borttagnings-API:et för Foxit eSign-webhook (som använder en POST-metod i stället för DELETE) kan Power Automate inte automatiskt rensa webhook-kanalprenumerationer när ett utlösarbaserat flöde tas bort eller ändras. Använd åtgärden Lista alla Webhook-kanaler för att identifiera aktiva kanaler och Foxit eSign-portalen för att ta bort prenumerationer när du inaktiverar ett flöde.

  • När ett kuvert skickas – Endast kontonivå: Utlösaren "När ett kuvert skickas" utlöses bara när Webhook-nivån är inställd på Konto. Det utlöses inte för kuvert som skapats på API-appnivå . Se till att du väljer Kontonivå när du konfigurerar den här utlösaren.

  • Regional tillgänglighet: Anslutningsappen är tillgänglig för både Konton för Nordamerika (NA1) och EU-regioner. Välj lämplig serverregion när du konfigurerar anslutningen. Om du ansluter till fel region resulterar det i autentiseringsfel.

  • Base64-dokumentstorlek: När du använder åtgärderna Skapa kuvert från Base64 eller Skapa mall från Base64 måste den Base64-kodade strängen motsvara en källfil som inte är större än 25 MB.

Stöd

Kontakta Foxit eSign-teamet på devsupport@foxitsoftware.com.

Om du vill skicka ett supportärende går du till https://kb.foxit.com/s/submit-a-case.

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Avbryt kuvert

Avbryter ett skickat kuvert. Mottagarna kommer inte längre att kunna signera dokumenten.
Avbryt prenumeration på Webhook-utlösare

Tar bort en aktiv webhook-kanalprenumeration med dess kanal-ID. Använd den här åtgärden för att rensa webhook-prenumerationer som inte längre behövs.
Flytta kuvert till papperskorgen

Flyttar ett eller flera kuvert till papperskorgen. Kuvert i papperskorgen tas inte bort permanent.
Hämta borttagen kuverthistorik

Hämtar en historik över kuvert som har tagits bort eller flyttats till papperskorgen.
Hämta en lista över alla mallar

Returnerar en lista över alla mallar som är tillgängliga i ditt konto.
Hämta historik för kuvertaktivitet

Hämtar en fullständig aktivitetslogg för ett kuvert som visar alla åtgärder som vidtagits av mottagare och avsändaren.
Hämta information om e-postgrupp

Hämtar information om en befintlig e-postgrupp.
Hämta information om Webhook-kanalen

Hämtar information om en specifik webhook-kanal.
Hämta kuvert-ID:t

Returnerar en lista med kuvert-ID:t filtrerade efter status. Använd det här alternativet om du vill hitta kuvert i ett visst tillstånd.
Hämta kuvertinformation

Hämtar fullständig information om ett kuvert, inklusive dess status, mottagare och dokument.
Hämta mallar efter mall-ID

Hämtar information om en eller flera mallar med sina ID:n.
Hämta mallinformation

Hämtar fullständig information om en viss mall, inklusive dess fält och mottagare.
Ladda ned kuvertfiler

Laddar ned de ifyllda dokumenten från ett kuvert som en fil.
Ladda ned PDF-fil för enskilda dokument

Laddar ned ett enda dokument från ett kuvert som en PDF-fil.
Ladda ned rapport

Laddar ned en kuvertaktivitetsrapport som en Microsoft Excel fil. Använd filtren för att begränsa resultatet efter status, datumintervall, kuvertnamn, författare eller undertecknare.
Skapa e-postgrupp

Skapar en ny e-postgrupp som kan användas för att skicka kuvert till flera mottagare samtidigt.
Skapa kuvert från Base64

Skapar och skickar ett kuvert med ett Base64-kodat PDF-dokument.
Skapa kuvert från mall

Skapar och skickar ett kuvert med hjälp av en befintlig mall. Mottagarinformation kan anpassas.
Skapa kuvert från URL

Skapar och skickar ett kuvert med offentligt tillgängliga PDF-URL:er. Ange dokument-URL:er och mottagarinformation för att initiera signeringsprocessen.
Skapa mall från Base64

Skapar en ny mall med en Base64-kodad PDF-sträng. Använd detta när PDF-filen redan är tillgänglig som en Base64-sträng i flödet, till exempel från en SharePoint fil eller OneDrive dokument.
Skapa mall från URL

Skapar en ny mall med en offentligt tillgänglig PDF-URL.
Skicka signaturpåminnelse

Skickar ett påminnelsemeddelande till väntande mottagare av ett kuvert, vilket uppmanar dem att slutföra signeringen.
Ta bort kuvert

Tar bort ett eller flera kuvert permanent.
Visa en lista över alla Webhook-kanaler

Returnerar en lista över alla webhook-kanaler som konfigurerats i ditt konto.

Avbryt kuvert

Åtgärds-ID:
CancelEnvelope

Avbryter ett skickat kuvert. Mottagarna kommer inte längre att kunna signera dokumenten.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvert-ID
 folderId True integer

ID:t för kuvertet som ska avbrytas.
Orsak till annullering
 reason_for_cancellation True string

Anledningen till att du avbröt kuvertet. Detta registreras i kuvertaktivitetshistoriken.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Avbrutna kuvert-ID:t
 folders cancelled array of integer

Listan över kuvert-ID:t som har avbrutits.

Avbryt prenumeration på Webhook-utlösare

Åtgärds-ID:
DeleteTriggerWebhookChannel

Tar bort en aktiv webhook-kanalprenumeration med dess kanal-ID. Använd den här åtgärden för att rensa webhook-prenumerationer som inte längre behövs.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanal-ID
 channelId True integer

ID:t för den webhook-kanal som ska tas bort.

Flytta kuvert till papperskorgen

Åtgärds-ID:
MoveEnvelopestoRecycleBin

Flyttar ett eller flera kuvert till papperskorgen. Kuvert i papperskorgen tas inte bort permanent.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mapp-ID:t
 folderIds True array of integer

En matris med kuvert-ID:t att agera på.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om åtgärden lyckades.

Hämta borttagen kuverthistorik

Åtgärds-ID:
GetDeletedEnvelopeHistory

Hämtar en historik över kuvert som har tagits bort eller flyttats till papperskorgen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvert-ID
 folderId True string

Den unika identifieraren för kuvertet vars borttagningshistorik du vill hämta.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Borttagen kuvertinformation
 Deleted Folder Log Info array of object

Sammanfattningsinformation om det borttagna kuvertet.
Kuvert-ID
 Deleted Folder Log Info.folderId integer

Den unika identifieraren för det borttagna kuvertet.
Kuvertnamn
 Deleted Folder Log Info.folderName string

Namnet på det borttagna kuvertet.
Dokumentnamn
 Deleted Folder Log Info.documentName string

Namnet på dokumentet i det borttagna kuvertet.
Dokument-ID
 Deleted Folder Log Info.documentId string

Den unika identifieraren för dokumentet i det borttagna kuvertet.
Borttagningsdatum
 Deleted Folder Log Info.deletionDate integer

Datum och tid då kuvertet togs bort i Unix millisekunder.
Borttagen av
 Deleted Folder Log Info.deletedBy string

Namnet på den användare som tog bort kuvertet.
Borttagningslogghistorik
 Deleted Folder Log History array of object

Den stegvisa loggen över alla borttagningsåtgärder som utförs på kuvertet.
Utförs av
 Deleted Folder Log History.partiesName string

Namnet på den användare som utförde borttagningssteget.
Källa
 Deleted Folder Log History.source string

Källan som borttagningen initierades från (t.ex. webb, API).
Event
 Deleted Folder Log History.event string

Den specifika borttagningsåtgärd som utförs (t.ex. Ta bort mapp, Ta bort alla parter från mappen).

Hämta en lista över alla mallar

Åtgärds-ID:
GetalistofallTemplates

Returnerar en lista över alla mallar som är tillgängliga i ditt konto.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Totalt antal mallar
 total_templates integer

Det totala antalet mallar i ditt konto.
Malllista
 templatesList array of object

Listan över alla mallar som är tillgängliga i kontot.
Mall-id
 templatesList.templateId integer

Mallens unika identifierare. Använd det här ID:t med Skapa kuvert från mall för att skicka mallen för signering.
Mallnamn
 templatesList.templateName string

Namnet på mallen.
Mallbeskrivning
 templatesList.templateDesc string

En beskrivning av mallen.
Malltyp
 templatesList.templateType string

Mallens typ eller kategori.
Skapelsedatum
 templatesList.templateCreationDate integer

Det datum då mallen skapades i Unix millisekunder.
Senast uppdaterat datum
 templatesList.templateLastUpdateDate integer

Det datum då mallen senast uppdaterades i Unix-millisekunder.
Redigerbar
 templatesList.editable boolean

Anger om mallen kan redigeras.
Antal parter
 templatesList.numberOfParties integer

Antalet signeringsparter som definierats i mallen.
Företags-ID
 templatesList.companyId integer

Företagskontot som mallen tillhör.
Dela med alla
 templatesList.shareAll boolean

Anger om mallen delas med alla användare i kontot.
Part-ID
 templatesList.templateCreatedBy.partyId integer

Användarens unika identifierare.
Förnamn
 templatesList.templateCreatedBy.firstName string

Användarens förnamn.
Efternamn
 templatesList.templateCreatedBy.lastName string

Användarens efternamn.
E-postmeddelande
 templatesList.templateCreatedBy.emailId string

Användarens e-postadress.
Part-ID
 templatesList.templateLastUpdatedBy.partyId integer

Användarens unika identifierare.
Förnamn
 templatesList.templateLastUpdatedBy.firstName string

Användarens förnamn.
Efternamn
 templatesList.templateLastUpdatedBy.lastName string

Användarens efternamn.
E-postmeddelande
 templatesList.templateLastUpdatedBy.emailId string

Användarens e-postadress.

Hämta historik för kuvertaktivitet

Åtgärds-ID:
GetEnvelopeActivityHistory

Hämtar en fullständig aktivitetslogg för ett kuvert som visar alla åtgärder som vidtagits av mottagare och avsändaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvert-ID
 folderId True integer

Den unika identifieraren för kuvertet vars aktivitetshistorik du vill hämta.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Kuvert-ID
 details.folderId integer

Kuvertets unika identifierare.
Omslutna dokument
 details.enclosedDocuments string

Namnet på de dokument som omges av kuvertet.
Mottagare
 details.envelopeRecipients string

Namnen på alla mottagare på kuvertet.
Author
 details.author string

Namnet på den användare som skapade kuvertet.
Status
 details.status string

Den aktuella statusen för kuvertet (t.ex. SHARED, EXECUTED, CANCELLED).
Senaste aktivitetsdatum
 details.latestActivityDate string

Datum och tid för den senaste aktiviteten på kuvertet.
Skapelsedatum
 details.dateCreated string

Datum och tid då kuvertet skapades.
Skickat datum
 details.dateSent string

Datum och tid då kuvertet skickades till mottagarna.
Activities
 details.activities array of object

Kronologisk lista över alla åtgärder som vidtagits på detta kuvert.
Activity
 details.activities.activity string

En läsbar beskrivning av åtgärden som inträffade.
Action
 details.activities.action string

Vilken typ av åtgärd som utförs (t.ex. Skapad, Inbjudan skickad, Öppnad, Visad, Signerad).
User
 details.activities.user string

Namnet på den användare som utförde åtgärden.
Kuvertstatus
 details.activities.folderStatus string

Status för kuvertet vid den tidpunkt då åtgärden inträffade.
Time
 details.activities.time string

Datum och tid då åtgärden inträffade.
Källa
 details.activities.source string

Källan som åtgärden utfördes från (t.ex. webben).
IP-adress
 details.activities.ipAddress string

IP-adressen som åtgärden utfördes från, om den är tillgänglig.

Hämta information om e-postgrupp

Åtgärds-ID:
GetEmailGroupDetails

Hämtar information om en befintlig e-postgrupp.

Parametrar

Name Nyckel Obligatorisk Typ Description
Namn på e-postgrupp
 emailGroupNames True array of string

En matris med e-postgruppnamn som används för att identifiera grupperna.

Returer

Name Sökväg Typ Description
E-postgrupper
 allEmailGroups array of object

Listan över e-postgrupper som matchar de begärda gruppnamnen.
grupp-id
 allEmailGroups.groupId integer

Den unika identifieraren för e-postgruppen.
Gruppnamn
 allEmailGroups.groupName string

Namnet på e-postgruppen.
Gruppbeskrivning
 allEmailGroups.groupDesc string

Beskrivningen av e-postgruppen.
Skapelsedatum
 allEmailGroups.dateCreated integer

Det datum då e-postgruppen skapades i Unix millisekunder.
Företags-ID
 allEmailGroups.companyId integer

Företagskontot som den här e-postgruppen tillhör.
Parties
 allEmailGroups.parties array of object

Listan över mottagare i den här e-postgruppen.
Förnamn
 allEmailGroups.parties.firstName string

Mottagarens förnamn.
Efternamn
 allEmailGroups.parties.lastName string

Mottagarens efternamn.
E-postmeddelande
 allEmailGroups.parties.emailId string

Mottagarens e-postadress.

Hämta information om Webhook-kanalen

Åtgärds-ID:
GetWebhookChannelDetails

Hämtar information om en specifik webhook-kanal.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanal-ID
 channelId True string

Den unika identifieraren för den webhook-kanal som ska hämtas.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
ID
 channel.channelId integer

Den unika identifieraren för webhook-kanalen.
Företags-ID
 channel.companyId integer

Företagskontot som kanalen tillhör.
Name
 channel.channelName string

Namnet på webhookens kanal.
Webhook-URL
 channel.webhookUrl string

Den URL som Foxit eSign anropar när en prenumerationshändelse inträffar.
Webhook-hemlighet
 channel.webhookSecret string

Den hemliga nyckel som används för att verifiera webhook-nyttolaster.
Skapelsedatum
 channel.dateCreated integer

Det datum då kanalen skapades i Unix millisekunder.
Datum uppdaterat
 channel.dateUpdated integer

Det datum då kanalen senast uppdaterades i Unix millisekunder.
Webhook-nivå
 channel.webhookLevel string

Webhook-kanalens omfång. Antingen "Konto" (utlösare för alla kuvert) eller "API App" (utlösare endast för kuvert som skapats via API:et).
Status
 channel.status string

Kanalens aktuella status. Antingen "aktiv" eller "deaktiv".
Kuvert skickat
 channel.eventsSubscribedMap.folder_sent boolean

Utlöses när ett kuvert skickas till mottagarna.
Kuvertet visas
 channel.eventsSubscribedMap.folder_viewed boolean

Utlöses när ett kuvert öppnas av en mottagare.
Kuvert signerat
 channel.eventsSubscribedMap.folder_signed boolean

Utlöses när ett kuvert signeras av en mottagare.
Kuvertet avbröts
 channel.eventsSubscribedMap.folder_cancelled boolean

Utlöses när ett kuvert avbryts.
Kuvertet körs
 channel.eventsSubscribedMap.folder_executed boolean

Utlöses när alla parter har signerat och kuvertet har körts fullständigt.
Kuvertet har tagits bort
 channel.eventsSubscribedMap.folder_deleted boolean

Utlöses när ett kuvert tas bort.

Hämta kuvert-ID:t

Åtgärds-ID:
GetEnvelopeIds

Returnerar en lista med kuvert-ID:t filtrerade efter status. Använd det här alternativet om du vill hitta kuvert i ett visst tillstånd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Datum från
 dateFrom True string

Start av datumintervallet för att skapa kuvertet. Godkänt format: ÅÅÅÅ-MM-DD.
Datum till
 dateTo True string

Slutet av datumintervallet för skapande av kuvert. Godkänt format: ÅÅÅÅ-MM-DD. DateTo-värdet måste vara inom 6 månader från dateFrom-värdet.
Status
 status string

Filtrera kuvert efter status. Godkända värden: EXECUTED, SHARED, DRAFT, PARTIALLY SIGNED, CANCELLED, EXPIRED, DELETED. Om det utelämnas returneras kuvert med någon status.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Message
 message string

Ett sammanfattningsmeddelande som anger hur många kuvert-ID:t som returnerades.
Kuvert-ID:t
 allFolderIds array of integer

Listan över kuvert-ID:t som matchar filtervillkoren. Använd dessa ID:er med Hämta kuvertinformation för att hämta fullständig kuvertinformation.

Hämta kuvertinformation

Åtgärds-ID:
GetEnvelopeDetails

Hämtar fullständig information om ett kuvert, inklusive dess status, mottagare och dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvert-ID
 folderId True integer

Den unika identifieraren för kuvertet som ska hämtas.
Åtkomsttoken
 access_token string

OAuth 2.0-åtkomsttoken för autentisering.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om åtgärden lyckades (t.ex. "lyckades").
ID
 folder.folderId integer

Kuvertets unika ID.
Name
 folder.folderName string

Kuvertets namn.
Redigerings-ID
 folder.folderAuthorId integer

Det unika ID:t för den användare som skapade kuvertet.
Författarens förnamn
 folder.folderAuthorFirstName string

Förnamnet på kuvertskapare.
Författarens efternamn
 folder.folderAuthorLastName string

Efternamnet på kuvertskapare.
E-postförfattare
 folder.folderAuthorEmail string

E-postadressen till kuvertskapare.
Redigeringsroll
 folder.folderAuthorRole string

Kontorollen för kuvertskapare.
Företags-ID
 folder.folderCompanyId integer

Det unika ID för företaget som kuvertet tillhör.
Skapandedatum
 folder.folderCreationDate integer

Datum och tid då kuvertet skapades i Unix-millisekunder.
Skickat datum
 folder.folderSentDate integer

Datum och tid då kuvertet skickades till mottagarna i Unix millisekunder. Null om det inte har skickats ännu.
Status
 folder.folderStatus string

Kuvertets aktuella status (t.ex. DELAD, KÖRD, UTKAST, ANNULLERAD).
Dokument-ID
 folder.folderDocumentIds array of integer

Listan över dokument-ID:t som ingår i det här kuvertet.
Documents
 folder.documentsList array of object

Information om varje dokument som ingår i kuvertet.
Dokument-ID
 folder.documentsList.documentId integer

Dokumentets unika identifierare.
Kontrakts-ID
 folder.documentsList.contractId integer

Den unika identifieraren för kontraktet som är associerat med det här dokumentet.
Företags-ID
 folder.documentsList.companyId integer

Det unika ID:t för företaget som dokumentet tillhör.
Skapad av
 folder.documentsList.contractCreatedBy integer

Användar-ID för den person som skapade kontraktet.
Skapad på
 folder.documentsList.contractCreatedOn integer

Datumet då kontraktet skapades i Unix millisekunder.
Kontraktstyp
 folder.documentsList.contractType string

Typen eller kategorin för kontraktet.
Dokumentstatus
 folder.documentsList.contractStatus string

Dokumentets aktuella signeringsstatus (t.ex. WAITING_FOR_SIGNATURE, KÖRD).
Redigerbar
 folder.documentsList.editable boolean

Anger om dokumentet kan redigeras.
Versions-ID
 folder.documentsList.contractVersionId integer

Det unika ID:t för den aktuella dokumentversionen.
Versionsnamn
 folder.documentsList.contractVersionName string

Namnet på den aktuella dokumentversionen.
Versionsbeskrivning
 folder.documentsList.contractVersionDesc string

En beskrivning av den aktuella dokumentversionen.
Version skapad av
 folder.documentsList.versionCreatedby integer

Användar-ID för den person som skapade den här dokumentversionen.
Version skapad på
 folder.documentsList.versionCreatedOn integer

Det datum då den här dokumentversionen skapades i Unix millisekunder.
Versionsnummer
 folder.documentsList.contractVersionNumber integer

Versionsnumret för dokumentet.
Mottagare
 folder.folderRecipientParties array of object

Listan över mottagare för det här kuvertet, inklusive deras signeringsstatus och åtkomstlänkar.
Mottagarens ID
 folder.folderRecipientParties.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 folder.folderRecipientParties.partyDetails.partyId integer

Mottagarens unika identifierare.
Förnamn
 folder.folderRecipientParties.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 folder.folderRecipientParties.partyDetails.lastName string

Mottagarens efternamn.
E-postmeddelande
 folder.folderRecipientParties.partyDetails.emailId string

Mottagarens e-postadress.
Address
 folder.folderRecipientParties.partyDetails.address string

Mottagarens adress.
Datum då kontot skapades
 folder.folderRecipientParties.partyDetails.dateCreated integer

Det datum då mottagarens konto skapades i Unix millisekunder.
Permissions
 folder.folderRecipientParties.contractPermissions string

De signeringsbehörigheter som beviljats den här mottagaren (t.ex. FILL_FIELDS_AND_SIGN).
Signeringsorder
 folder.folderRecipientParties.partySequence integer

Mottagarens position i signeringsordningen.
Arbetsflödessekvens
 folder.folderRecipientParties.workflowSignSequence integer

Sekvensnumret för arbetsflödessignering för den här mottagaren.
Kuvert-ID
 folder.folderRecipientParties.envelopeId integer

ID:t för kuvertet som mottagaren tillhör.
Delningsläge
 folder.folderRecipientParties.sharingMode string

Den metod som används för att dela dokumentet med den här mottagaren (t.ex. e-post).
Signerings-URL
 folder.folderRecipientParties.folderAccessURL string

Den unika signerings-URL:en för den här mottagaren. Null om kuvertet redan har slutförts eller avbrutits.
Säkerhetsläge
 folder.folderRecipientParties.securityMode string

Säkerhetsläget som tillämpas på mottagarens åtkomst.
Extra kommentarer
 folder.folderRecipientParties.extraComments string

Eventuella ytterligare kommentarer som ingår i signeringsinbjudan för den här mottagaren.
Url för redigeringsåtkomst
 folder.folderAccessURLForAuthor string

Url:en för kuvertförfattaren att komma åt dokumentet. Null om inte tillämpligt.
Mass-ID
 folder.bulkId integer

ID:t för massutskicket som kuvertet tillhör, om det finns.
Framtvinga signeringsorder
 folder.enforceSignWorkflow boolean

Anger om mottagarna måste logga in i den angivna ordningen.
Aktuellt arbetsflödessteg
 folder.currentWorkflowStep integer

Det aktuella steget i signeringsarbetsflödet.
Transaktionskälla
 folder.transactionSource string

Källan som initierade den här kuverttransaktionen.
Redigerbar
 folder.editable boolean

Anger om kuvertet fortfarande kan redigeras.
In-Person signering
 folder.inPersonSignable boolean

Anger om kuvertet kan loggas in personligen.
Åsidosätt påminnelser
 folder.overrideAccountReminders boolean

Anger om inställningarna för påminnelser på kontonivå åsidosättas för det här kuvertet.
ID
 folder.envelopeId integer

Kuvertets unika ID. Samma värde som Kuvert-ID (folderId).
Name
 folder.envelopeName string

Kuvertets namn. Samma värde som Kuvertnamn (folderName).
Ursprungs-ID
 folder.envelopeOriginatorId integer

Användar-ID för den person som skapade kuvertet.
Företags-ID
 folder.envelopeCompanyId integer

ID:t för företaget som kuvertet tillhör.
Date
 folder.envelopeDate integer

Datum och tid då kuvertet skapades i Unix-millisekunder.
Delat datum
 folder.envelopeSharedDate integer

Datum och tid då kuvertet delades med mottagare, i Unix millisekunder. Null om det inte har delats ännu.
Status
 folder.envelopeStatus string

Kuvertets aktuella status. Samma värde som Kuvertstatus (folderStatus).
Kontrakts-ID:t
 folder.envelopeContractIds array of integer

Listan över kontrakt-ID:t som är associerade med det här kuvertet.
Partbehörigheter
 folder.envelopePartyPermissions array of object

Listan över mottagare och deras signeringsbehörigheter. Samma struktur som mottagare.
Mottagarens ID
 folder.envelopePartyPermissions.partyId integer

Mottagarens unika identifierare.
Förnamn
 folder.envelopePartyPermissions.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 folder.envelopePartyPermissions.partyDetails.lastName string

Mottagarens efternamn.
E-postmeddelande
 folder.envelopePartyPermissions.partyDetails.emailId string

Mottagarens e-postadress.
Permissions
 folder.envelopePartyPermissions.contractPermissions string

Signeringsbehörigheterna för den här mottagaren.
Signeringsorder
 folder.envelopePartyPermissions.partySequence integer

Mottagarens position i signeringsordningen.
Signerings-URL
 folder.envelopePartyPermissions.folderAccessURL string

Den unika signerings-URL:en för den här mottagaren.
Alla fält
 allFields array of object

Listan över alla signatur- och formulärfält som placerats i kuvertets dokument.
Fält-ID
 allFields.fieldTagId integer

Fältets unika identifierare.
Dokument-ID
 allFields.contractId integer

ID:t för dokumentet som det här fältet tillhör.
Versions-ID
 allFields.versionId integer

Versions-ID:t för det dokument som det här fältet tillhör.
Fälttyp
 allFields.fieldType string

Typ av fält (t.ex. signfield, textfält, datefield, checkboxfield, dropdownfield, initialfield).
Sidnummer
 allFields.documentPageNumber integer

Sidnumret där det här fältet är placerat.
Fältdokument-ID
 allFields.docFieldId string

Identifieraren på dokumentnivå för det här fältet.
Ansvarig part
 allFields.partyResponsible integer

Det part-ID som ansvarar för att fylla i det här fältet.
Är beroende
 allFields.dependent boolean

Anger om det här fältets synlighet beror på ett annat fälts värde.
Obligatoriskt
 allFields.required boolean

Anger om det här fältet måste fyllas i innan dokumentet kan skickas.
Fältvärde
 allFields.value string

Det aktuella värdet för fältet, om det är fyllt.
Fältvärden
 allFieldsNameValue array of object

En förenklad lista över alla fältnamn och deras aktuella värden. Använd detta för att läsa ifyllda fältdata från ett signerat kuvert.
Fält-ID
 allFieldsNameValue.fieldId integer

Fältets unika identifierare.
Dokument-ID
 allFieldsNameValue.documentId integer

ID:t för dokumentet som det här fältet tillhör.
Versions-ID
 allFieldsNameValue.documentVersionId integer

Versions-ID:t för det dokument som det här fältet tillhör.
Fälttyp
 allFieldsNameValue.fieldType string

Typ av fält (t.ex. textfält, signfield, datefield, checkboxfield, dropdownfield).
Fältnamn
 allFieldsNameValue.name string

Etiketten eller namnet på fältet enligt definitionen i mallen.
Fältvärde
 allFieldsNameValue.value string

Värdet som angetts eller valts för det här fältet.
Kuverthistorik
 Folder History array of object

Spårningsloggen för alla åtgärder som vidtagits på det här kuvertet, i kronologisk ordning.
Förnamn
 Folder History.firstName string

Förnamnet på den person som utförde åtgärden.
Efternamn
 Folder History.lastName string

Efternamnet på den person som utförde åtgärden.
E-postmeddelande
 Folder History.email string

E-postadressen till den person som utförde åtgärden.
Kuvert-ID
 Folder History.envelopeId integer

ID:t för kuvertet som åtgärden utfördes på.
Date
 Folder History.dateChanged integer

Datum och tid då åtgärden inträffade i Unix-millisekunder.
Part-ID
 Folder History.changeDoneByParty integer

Part-ID:t för den person som utförde åtgärden.
Action
 Folder History.action string

Åtgärden som utförs på kuvertet (t.ex. Skapad, InviteSentTo, InviteAccepted, Signed, Executed).

Hämta mallar efter mall-ID

Åtgärds-ID:
GetTemplatesbyTemplateIds

Hämtar information om en eller flera mallar med sina ID:n.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mall-ID:t
 templateIds True array of integer

En matris med mall-ID:t som ska hämtas.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Totalt antal mallar
 total_templates integer

Det totala antalet mallar som returneras.
Malllista
 templateIdList object

En karta över malldata som är nyckelade efter mall-ID. Varje post innehåller mallinformationen och dess fält.

Hämta mallinformation

Åtgärds-ID:
GetTemplateDetails

Hämtar fullständig information om en viss mall, inklusive dess fält och mottagare.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mall-id
 templateId True string

Den unika identifieraren för mallen som ska hämtas.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
ID
 template.templateId integer

Mallens unika identifierare.
Name
 template.templateName string

Namnet på mallen.
Description
 template.templateDesc string

En beskrivning av mallen.
Type
 template.templateType string

Mallens typ.
Skapelsedatum
 template.templateCreationDate integer

Det datum då mallen skapades i Unix millisekunder.
Senast uppdaterat datum
 template.templateLastUpdateDate integer

Det datum då mallen senast uppdaterades i Unix-millisekunder.
Redigerbar
 template.editable boolean

Anger om mallen kan redigeras.
Antal parter
 template.numberOfParties integer

Antalet signeringsparter som definierats i mallen.
Totalt antal sidor
 template.totalPages integer

Det totala antalet sidor i malldokumentet.
Företags-ID
 template.companyId integer

Företagskontot som mallen tillhör.
Dela med alla
 template.shareAll boolean

Anger om mallen delas med alla användare i kontot.
Mönster för anpassat namn
 template.templateCustomName string

Det anpassade namnmönstret som tillämpas på kuvert som skapats från den här mallen.
Partbehörigheter
 template.templatePartyPermissions array of object

Listan över mottagarroller och deras signeringsbehörigheter som definierats i den här mallen.
Part-ID
 template.templatePartyPermissions.template_party_id integer

Det unika ID:t för den här mallpartposten.
ID
 template.templatePartyPermissions.templateId integer

ID:t för mallen som den här parten tillhör.
Permissions
 template.templatePartyPermissions.templatePermissions string

Signeringsbehörigheterna för den här parten (t.ex. FILL_FIELDS_AND_SIGN).
Signeringsorder
 template.templatePartyPermissions.partySequence integer

Signeringsorderpositionen för den här parten.
Partroll
 template.templatePartyPermissions.templatePartyRole string

Det rollnamn som tilldelats den här parten. Använd det här värdet när du skapar ett kuvert från den här mallen.
Part-ID
 template.templatePartyPermissions.partyId integer

ID:t för den part som tilldelats den här rollen, om det är förtilldelat.
Part-ID
 template.templateCreatedBy.partyId integer

Användarens unika identifierare.
Förnamn
 template.templateCreatedBy.firstName string

Användarens förnamn.
Efternamn
 template.templateCreatedBy.lastName string

Användarens efternamn.
E-postmeddelande
 template.templateCreatedBy.emailId string

Användarens e-postadress.
Avdelning
 template.templateCreatedBy.department string

Användarens avdelning.
Title
 template.templateCreatedBy.title string

Användarens jobbrubrik.
Aktivt
 template.templateCreatedBy.active boolean

Anger om användarkontot är aktivt.
Part-ID
 template.templateLastUpdatedBy.partyId integer

Användarens unika identifierare.
Förnamn
 template.templateLastUpdatedBy.firstName string

Användarens förnamn.
Efternamn
 template.templateLastUpdatedBy.lastName string

Användarens efternamn.
E-postmeddelande
 template.templateLastUpdatedBy.emailId string

Användarens e-postadress.
Avdelning
 template.templateLastUpdatedBy.department string

Användarens avdelning.
Title
 template.templateLastUpdatedBy.title string

Användarens jobbrubrik.
Aktivt
 template.templateLastUpdatedBy.active boolean

Anger om användarkontot är aktivt.
Alla fält
 allfields array of object

Listan över alla fält som definierats i den här mallen.
Fälttagg-ID
 allfields.fieldTagId integer

Fältets unika identifierare.
Mall-id
 allfields.templateId integer

ID:t för mallen som det här fältet tillhör.
Företags-ID
 allfields.companyId integer

Företagskontot som det här fältet tillhör.
Fälttyp
 allfields.fieldType string

Typ av fält (t.ex. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Sidnummer
 allfields.documentPageNumber integer

Sidnumret för dokumentet där det här fältet är placerat.
Ansvarig part
 allfields.partyResponsible integer

Det partisekvensnummer som ansvarar för att slutföra det här fältet.
Partsekvens
 allfields.partyResponsibleSequence integer

Den ansvariga partens sekvensposition.
Dokumentfält-ID
 allfields.docFieldId string

Identifieraren för det här fältet i dokumentet.
Beroende
 allfields.dependent boolean

Anger om det här fältets synlighet beror på ett annat fälts värde.
Tabbordning
 allfields.tabOrder integer

Tabbordningen för navigering mellan fält.
Obligatoriskt
 allfields.required boolean

Anger om det här fältet måste slutföras innan dokumentet kan signeras.
Namn på anpassat fält
 allfields.customFieldName string

Ett anpassat namn som tilldelats det här fältet.
Dela alla
 allfields.shareAll boolean

Anger om det här fältet delas med alla användare.
Tillåt redigering
 allfields.allowEdit boolean

Anger om det här fältet kan redigeras av mottagaren.
Namn på textfält
 allfields.textfieldName string

Etiketten för textfältet (gäller när fieldType är "textfält").
Value
 allfields.value string

Det förfyllda eller angivna värdet för fältet.
Fontstorlek
 allfields.fontSize integer

Teckenstorleken som används för text i det här fältet.
Teckenfärg
 allfields.fontColor string

Teckenfärgen som används för text i det här fältet (t.ex. #0000000).
Skrivskyddad
 allfields.readOnly boolean

Anger om fältet är skrivskyddat och inte kan redigeras av mottagaren.
Flera linjer
 allfields.multiLine boolean

Anger om textfältet accepterar flera indatarader (gäller när fieldType är "textfält").
Teckengräns
 allfields.characterLimit integer

Det maximala antalet tecken som tillåts i fältet (gäller när fieldType är "textfält").
Namn på datumfält
 allfields.datefieldName string

Etiketten för datumfältet (gäller när fieldType är "datefield").
Datumformat
 allfields.dateFormat string

Datumformatet som används av det här fältet (t.ex. MM/DD/ÅÅÅÅ) (gäller när fieldType är "datefield").
Kryssrutenamn
 allfields.cbname string

Kryssrutans etikett (gäller när fieldType är "kryssrutefält").
Kryssrutegrupp
 allfields.cbgroup string

Gruppnamnet för den här kryssrutan används när flera kryssrutor är länkade (gäller när fieldType är "kryssrutafält").
Kontrollerad
 allfields.checked boolean

Anger om kryssrutan är markerad som standard (gäller när fieldType är "kryssrutefält").
Namn på skyddat fält
 allfields.securedfieldName string

Etiketten för det skyddade fältet (gäller när fieldType är "securedfield").
Tecken som ska visas
 allfields.charToDisplay integer

Antalet omaskerade tecken som ska visas i slutet av ett skyddat fältvärde (gäller när fieldType är "securedfield").
Signaturidentitet
 allfields.signatureId string

ID:t för signaturen som tillämpas på det här teckenfältet (gäller när fieldType är "signfield").
Initial bild
 allfields.initialImage string

Bilddata för initialerna som tillämpas på det här fältet (gäller när fieldType är "initialfield").
Fältnamn för bifogad fil
 allfields.attachmentfieldName string

Namnet på det bifogade fältet (gäller när fieldType är "attachmentfield").
Beskrivning av bifogad fil
 allfields.attachmentfieldDescription string

En beskrivning av vad som ska bifogas (gäller när fieldType är "attachmentfield").

Ladda ned kuvertfiler

Åtgärds-ID:
DownloadEnvelopeFiles

Laddar ned de ifyllda dokumenten från ett kuvert som en fil.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvert-ID
 folderId True string

Den unika identifieraren för kuvertet vars dokument du vill ladda ned.

Returer

response
binary

Ladda ned PDF-fil för enskilda dokument

Åtgärds-ID:
DownloadSingleDocumentPDF

Laddar ned ett enda dokument från ett kuvert som en PDF-fil.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvert-ID
 folderId True string

Den unika identifieraren för kuvertet som innehåller dokumentet som ska laddas ned.
Dokumentnummer
 docNumber True string

Indexet för dokumentet som ska laddas ned, från och med 1.

Returer

response
binary

Ladda ned rapport

Åtgärds-ID:
DownloadReport

Laddar ned en kuvertaktivitetsrapport som en Microsoft Excel fil. Använd filtren för att begränsa resultatet efter status, datumintervall, kuvertnamn, författare eller undertecknare.

Parametrar

Name Nyckel Obligatorisk Typ Description
envelopeStatus
 status string

Status för mappen som vi ska filtrera en rapport efter
Skapandedatum från
 creationDateFrom string

Start av skapandedatumintervallet. Godkänt format: ÅÅÅÅ-MM-DD.
Skapandedatum till
 creationDateTo string

Slutet av skapandedatumintervallet. Godkänt format: ÅÅÅÅ-MM-DD.
Kuvertnamn
 folderName string

Alla mappar som innehåller den här strängen.
Inkludera fält
 includeFields string

Ange "true" för att inkludera kuvertfältvärden i rapporten. Standardvärdet är "false".
E-postförfattare
 authorEmail string

Filtrera rapporten så att den endast innehåller kuvert som skapats av den här författarens e-postadress.
E-post för undertecknare
 signerEmail string

Filtrera rapporten så att den endast innehåller kuvert där den här e-postadressen är en undertecknare.

Returer

Rapportfil
binary

Skapa e-postgrupp

Åtgärds-ID:
CreateEmailGroup

Skapar en ny e-postgrupp som kan användas för att skicka kuvert till flera mottagare samtidigt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Gruppnamn
 emailGroupName True string

Namnet på den nya e-postgruppen.
Gruppbeskrivning
 emailGroupDescription string

En valfri beskrivning för e-postgruppen.
Tillåt avancerad e-postverifiering
 allowAdvancedEmailValidation boolean

När det är aktiverat verifierar Foxit eSign att alla e-postadresser i gruppen kan nås innan de skickas.
Förnamn
 firstName True string

Mottagarens förnamn.
Efternamn
 lastName True string

Mottagarens efternamn.
E-postmeddelande
 emailId True string

Mottagarens e-postadress.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Message
 message string

Ett bekräftelsemeddelande för den utförda åtgärden.
grupp-id
 emailGroup.groupId integer

Den unika identifieraren för e-postgruppen. Använd det här ID:t när du skickar kuvert till gruppen.
Gruppnamn
 emailGroup.groupName string

Namnet på e-postgruppen.
Gruppbeskrivning
 emailGroup.groupDesc string

Beskrivningen av e-postgruppen.
Skapelsedatum
 emailGroup.dateCreated integer

Det datum då e-postgruppen skapades i Unix millisekunder.
Företags-ID
 emailGroup.companyId integer

Företagskontot som den här e-postgruppen tillhör.
Parties
 emailGroup.parties array of object

Listan över mottagare i e-postgruppen.
Förnamn
 emailGroup.parties.firstName string

Mottagarens förnamn.
Efternamn
 emailGroup.parties.lastName string

Mottagarens efternamn.
E-postmeddelande
 emailGroup.parties.emailId string

Mottagarens e-postadress.

Skapa kuvert från Base64

Åtgärds-ID:
CreateEnvelopefromBase64

Skapar och skickar ett kuvert med ett Base64-kodat PDF-dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvertnamn
 folderName True string

Namnet på kuvertet.
Indatatyp
 inputType string

Indatatyp för dokumentkälla. Har korrigerats till base64 för den här åtgärden.
Base64-filsträngar
 base64FileString True array of string

En matris med Base64-kodade PDF-dokument som ska skickas.
Filnamn
 fileNames True array of string

En matris med visningsnamn för varje dokument i samma ordning som base64-filsträngsmatrisen.
Förnamn
 firstName True string

Mottagarens förnamn.
Efternamn
 lastName True string

Mottagarens efternamn.
E-postadress
 emailId True string

Mottagarens e-postadress.
permissions
 permission True string
Sekvens
 sequence True integer

Använd det här fältet om du vill tilldela ett sekvensnummer till en mottagare i listan över mottagarparter. Använd unika sekvensnummer för varje part som börjar med 1 som 1,2,3,4.... Om en enskild person visas flera gånger i signeringsarbetsflödet tilldelar du en annan sekvens varje gång mottagaren upprepas.
signerAuthLevels
 signerAuthLevel string

Den autentiseringsnivå som en undertecknare använder för verifieringsändamål
Är platshållare
 isPlaceholder boolean

Använd det här fältet för att initiera att parten är en platshållare. Obs! 1. värdet för parametern firstName, lastName och emailId måste vara tomt för den här parten. 2. Om du vill lägga till platshållaren måste en mottagare få behörigheten "PARTY_ASSIGNER".
Mottagarroll
 partyRole string

Använd det här fältet för att tilldela en roll som platshållare.
Tillåt namnändring
 allowNameChange string

Värdet kan vara antingen sant eller falskt Använd den här parametern för att tillåta att undertecknaren uppdaterar för- och efternamn innan signeringsprocessen slutförs.
Arbetsflödessekvens
 workflowSequence integer

Tilldela mottagaren ett arbetsflödessekvensnummer. När inloggningssekvensen är aktiverad får mottagarna sin signeringsinbjudan i stigande sekvensordning.
Värd-E-post-ID
 hostEmailId string

E-postadress till In-Person administratör.
Åtkomstkod
 userDefinedAccessCode string

Parametern innehåller Åtkomstkod när värdet "signerAuthLevel" anges som "Användardefinierad åtkomstkod" för autentisering. Obs! 1. Koder är inte skiftlägeskänsliga. 2. Systemet skickar inte den här koden så du måste dela den här koden direkt med undertecknaren. 3. Åtkomstkod kan innehålla alfabet, siffror och följande specialtecken: @,&,{,},%,(,),~,|,!,+,^.
Parten är e-postgrupp
 partyIsEmailGroup boolean

Använd den här parametern när du skapar en part som bulk. Observera: Om den här parametern är sann ignoreras firstName, lastName och emailId för den här parten.
E-postgrupp-ID
 emailGroupId integer

Skicka e-postmeddelandet till det grupp-ID som du vill använda för att skapa massutskick.
Massinloggning för enkel undertecknare
 allowSingleSignerInBulk boolean

Använd den här parametern om du bara vill tillåta att en person loggar in i e-postgruppen.
Uppringningskod
 dialingCode string

Använd det här fältet för att tilldela ett lands uppringningskoder är mobilnummerprefix till en mottagare i listan över mottagarparter.
Mobilnummer
 mobileNumber string

Använd det här fältet om du vill tilldela ett mobilnummer till en mottagare i listan över mottagarparter.
Fält
 Fields object
Skicka nu
 sendNow boolean

När det är aktiverat skickar Foxit eSign omedelbart en unik signeringslänk till varje mottagares e-postadress. Inaktivera detta om du vill spara kuvertet som ett utkast i stället.
Skapa inbäddad signeringssession
 createEmbeddedSigningSession True boolean

Signeringssessionstoken genereras utan att skicka ut e-postmeddelanden till mottagarna.
Skapa inbäddad signeringssession för alla parter
 createEmbeddedSigningSessionForAllParties boolean

Om värdet är true genereras en inbäddad signerings-URL för varje mottagare i kuvertet.
Bearbeta texttaggar
 processTextTags True boolean

Värdet kan vara antingen sant eller falskt. Det här fältet används för att avgöra om Foxit eSign ska parsa dokumenten för texttaggar för att konvertera dem till Foxit eSign-fält.
Bearbeta Acro-fält
 processAcroFields True boolean

Det här fältet används för att avgöra om Foxit eSign ska parsa dokumenten för AcroFields för att konvertera dem till Foxit eSign-fält.
Logga in sekvens
 signInSequence boolean

Det här fältet används för att avgöra om mottagarna kommer att signera kuvertdokumenten i en sekvens. Om det är falskt får alla mottagare e-postinbjudan samtidigt. När det är sant får varje mottagare e-postinbjudan successivt efter att den tidigare mottagaren har slutfört den nödvändiga uppgiften, till exempel signera dokument eller fylla i fält osv.
Aktivera personligen
 inPersonEnable boolean

Det här fältet används för att initiera den personliga signeringsprocessen som enkelt kan slutföras på valfri enhet på några minuter och undviker e-postbaserade signaturer där det behövs. Om det är falskt får alla mottagare e-postinbjudan samtidigt. När det är sant får administratören en inbjudan via e-post för att initiera signeringsprocessen för undertecknaren.
Åtgärda mottagarparter
 fixRecipientParties boolean

Om det är sant kan inte den inbäddade sändningsvyn ändra parterna för kuvertet som redan har lagts till som en del av den här begäran.
Åtgärda dokument
 fixDocuments boolean

Om det är sant kan inte den inbäddade sändningen ändra dokumenten för kuvertet som redan har lagts till som en del av den här begäran.
Skicka lyckad URL
 sendSuccessUrl string

Ange den absoluta URL:en för landningssidan, som undertecknaren omdirigeras till när mappen har skickats i den inbäddade sändningsvyn.
Skicka fel-URL
 sendErrorUrl string

Ange den absoluta URL:en för landningssidan, som undertecknaren omdirigeras till om felet uppstår när mappen skickas i den inbäddade sändningsvyn.
Skapa inbäddad sändningssession
 createEmbeddedSendingSession boolean

Om värdet är true genereras en inbäddad token för att öppna dokumentet som förbereder vyn för Foxit eSign.
E-post-ID för inbäddade undertecknare
 embeddedSignersEmailIds array of string

En matris med e-post-ID:t för mottagare för vilka en inbäddad signeringssession måste skapas. E-post-ID:t från mottagarparterna som lagts till i listan över parter.
Url för signeringsframgång
 signSuccessUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till när de har loggat in i den inbäddade signeringsvyn.
Url för nekande av tecken
 signDeclineUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om de avböjer att logga in i den inbäddade signeringsvyn.
Signera senare URL
 signLaterUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om de väljer att logga in senare i den inbäddade signeringsvyn.
Url för teckenfel
 signErrorUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om felet uppstår när dokumentet signeras i den inbäddade signeringsvyn.
Tillåt skicka nu och inbäddad signeringssession
 allowSendNowAndEmbeddedSigningSession boolean

Om värdet är sant skickar Foxit eSign en unik signeringslänk till varje mottagare. Detta gäller ENDAST när parametrarna sendNow och createEmbeddedSigningSession är sanna.
Avancerad e-postverifiering
 allowAdvancedEmailValidation boolean

Verifiera parternas e-postadress när den anges som true.
Sign Success URL Alla parter
 signSuccessUrlAllParties boolean

Om värdet är true omdirigeras undertecknaren till URL:en som anges i signSuccessUrl efter att signeringen har slutförts. Detta gäller endast när sendNow är sant.
E-postmalls-ID
 emailTemplateId integer

Skicka e-postmalls-ID:t för att skicka andra e-postmallar än standardmallar för e-post.
Signer-instruktions-ID
 signerInstructionId integer

Skicka instruktions-ID:t för att skicka andra inloggningsinstruktioner än standardanvisningarna för undertecknaren.
Bekräftelseinstruktions-ID
 confirmationInstructionId string

Skicka bekräftelseinstruktions-ID:t för att skicka andra bekräftelseinstruktioner än standardbekräftelseinstruktionerna.
Temafärg
 themeColor string

Ange CSS-värdet för att ange temafärgen.
Sessionen upphör att gälla
 sessionExpire boolean

Ange som true för att initiera förfallningen av den inbäddade signeringssessionen.
Upphörande
 expiry integer

Krävs om sessionExpire är sant. Ange varaktighet i millisekunder för förfallodatum för den inbäddade signeringssessionen.
Namn på beroende fält
 dependentFieldName True string

Namnet på det fält vars synlighet styrs av det överordnade fältet.
Namn på överordnat fält
 parentFieldName True string

Namnet på det överordnade fältet vars värde styr synligheten för det beroende fältet. Överordnade fälttyper som stöds: textfält, textruta, kryssruta, alternativknapp, listruta.
Överordnat fältvärde
 parentFieldValue True string

Värdet för det överordnade fältet som utlöser det beroende fältet så att det blir synligt. För kryssrutor och alternativknappfält använder du markerat eller avmarkerat.
Options
 options True string

Ytterligare matchningsalternativ för textbaserade överordnade fält. Godkända värden: isblank, allowNull, innehåller.
Metadata
 metadata object

Detta bör vara i nyckel/värde-par. Maximalt 1 000 nyckel/värde-par tillåts.
E-post för avsändare
 senderEmail string

ange e-post för en annan användare i ditt konto som ska användas för att skicka den här dokumentmappen till mottagarparterna.
Dölj knappen Lägg till mig
 hideAddMeButton boolean

Om det är sant döljs knappen "Lägg till mig" på mottagarparterna i en inbäddad sändningssession.
Dölj knappen Lägg till ny
 hideAddNewButton boolean

Om det är sant döljs knappen "Lägg till ny" på mottagarparter i en inbäddad sändningssession.
Dölj knappen Lägg till grupp
 hideAddGroupButton boolean

Om det är sant döljs knappen "Lägg till grupp" på mottagarparter i en inbäddad sändningssession.
Dölj fältnamn för mottagare
 hideFieldNameForRecipients boolean

Dölj fältnamn för mottagare för datainmatningsfält och avancerade fält. (Förutom alternativknappen, kryssrutan, bilden och hyperlänken).
Dölj kryssrutan kantlinje
 hideCheckboxBorder boolean

Kryssrutans kantlinjer döljs i de utförda dokumenten.
Dölj alternativet Välj undertecknare
 hideSignerSelectOption boolean

Om det är sant döljs indatarutan "Befintlig undertecknare/e-post" på mottagarparter i en inbäddad sändningssession.
Dölj undertecknaråtgärder
 hideSignerActions boolean

Om det är sant döljs undertecknarens åtgärder "redigera", "ändra" och "ta bort" på mottagarparter i en inbäddad sändningssession.
Dölj avsändarens namn
 hideSenderName boolean

Om det är sant döljs avsändarens namn på mottagarparterna i en inbäddad sändningssession.
Dölj mappnamn
 hideFolderName boolean

Om det är sant döljs mappnamnet i navigeringen i båda inbäddade sessioner.
Dölj dokumentnamn
 hideDocumentsName boolean

Om det är sant döljs dokumentnamnet i båda inbäddade sessioner.
Dölj neka att signera
 hideDeclineToSign boolean

Om det är sant döljs alternativet "Neka att signera" för undertecknaren.
Dölj mer åtgärd
 hideMoreAction boolean

Om sant döljs knappen "Fler åtgärder" i sändnings-/signeringssessionen. När det gäller "Skicka nu": sant döljer det ingenting.
Dölj knappen Skicka
 hideSendButton boolean

Om det är sant döljs knappen Skicka i den inbäddade sändningssessionen.
Dölj nästa obligatoriska fieldbtn
 hideNextRequiredFieldbtn boolean

Om värdet är true döljer du navigeringsknappen som flyttar undertecknarna till nästa obligatoriska fält.
Krävs både inbäddad session
 requiredBothEmbeddedSession boolean

Om det är sant genereras de inbäddade url:erna för sändning och signering tillsammans.
Kuvertlösenord
 folderPassword string

Det här lösenordet krävs av undertecknaren/författaren för att öppna det digitalt signerade dokumentet. Om parametern hålls tom krävs inget lösenord för att öppna det digitalt signerade dokumentet.
Aktivera steg för steg
 enableStepByStep boolean

Aktivera steg för steg-åtgärd i den inbäddade sändningssessionen.
Dölj alternativet Lägg till parter
 hideAddPartiesOption boolean

Om det är sant döljs alternativet för att lägga till parterna i läget Skapa utkast och mall.
Självsigna
 selfSign boolean

Den aktiverar inbäddade självsigner via API:er. Den här parametern gäller endast när parametern createEmbeddedSendingSession är true.
Url för lyckad självsignerare
 selfSignerSuccessUrl string

Ange den absoluta URL:en för landningssidan på din webbplats/ditt program, som användaren omdirigeras till efter att självsignering har skickat mappen i den inbäddade sändningsvyn.

Returer

Name Sökväg Typ Description
ID
 folder.folderId integer

Det unika ID:t för det nyligen skapade kuvertet. Använd detta i efterföljande åtgärder för att referera till det här kuvertet.
Name
 folder.folderName string

Namnet på det nyligen skapade kuvertet.
Anpassat namn
 folder.folderCustomName string

Ett anpassat namn på kuvertet.
Lösenord
 folder.folderPassword string

Åtkomstlösenordet för kuvertet, om det anges.
Skapar-ID
 folder.folderAuthorId integer

Den unika identifieraren för kuvertskaparen.
Skaparens förnamn
 folder.folderAuthorFirstName string

Kuvertskapares förnamn.
Skaparens efternamn
 folder.folderAuthorLastName string

Kuvertskaparens efternamn.
E-post för skapare
 folder.folderAuthorEmail string

Kuvertskaparens e-postadress.
Skaparroll
 folder.folderAuthorRole string

Rollen som kuvertskapare.
Företags-ID
 folder.folderCompanyId integer

Den unika identifieraren för det företag som äger kuvertet.
Skapelsedatum
 folder.folderCreationDate integer

Det datum då kuvertet skapades (Unix-tidsstämpel i millisekunder).
Skickat datum
 folder.folderSentDate integer

Det datum då kuvertet skickades (Unix-tidsstämpel i millisekunder).
Status
 folder.folderStatus string

Kuvertets aktuella status.
Anpassat fält 1
 folder.custom_field1 string

Det första anpassade metadatafältet för kuvertet.
Anpassat fält 2
 folder.custom_field2 string

Det andra anpassade metadatafältet för kuvertet.
Metadata
 folder.metadata string

Anpassade metadata som är associerade med kuvertet.
Dokument-ID
 folder.folderDocumentIds array of integer

Listan över dokument-ID:t som finns i kuvertet.
Documents
 folder.documentsList array of object

Listan över dokument i kuvertet.
Dokument-ID
 folder.documentsList.documentId integer

Dokumentets unika identifierare.
Kontrakts-ID
 folder.documentsList.contractId integer

Den unika identifieraren för kontraktet.
Företags-ID
 folder.documentsList.companyId integer

Företagets unika identifierare.
Skapad av
 folder.documentsList.contractCreatedBy integer

Användar-ID för den person som skapade kontraktet.
Skapad på
 folder.documentsList.contractCreatedOn string

Datum och tid då kontraktet skapades.
Kontraktstyp
 folder.documentsList.contractType string

Typ av kontrakt.
Kontraktsstatus
 folder.documentsList.contractStatus string

Kontraktets aktuella status.
Redigerbar
 folder.documentsList.editable boolean

Anger om objektet kan redigeras.
Versions-ID
 folder.documentsList.contractVersionId integer

Den unika identifieraren för kontraktsversionen.
Versionsnamn
 folder.documentsList.contractVersionName string

Namnet på kontraktsversionen.
Versionsbeskrivning
 folder.documentsList.contractVersionDesc string

En beskrivning av kontraktsversionen.
Version skapad av
 folder.documentsList.versionCreatedby integer

Användar-ID för den person som skapade den här versionen.
Version skapad på
 folder.documentsList.versionCreatedOn string

Datum och tid då den här versionen skapades.
Versionsnummer
 folder.documentsList.contractVersionNumber integer

Versionsnumret för kontraktet.
Transaktionskälla
 folder.documentsList.contractTransactionSource string

Källsystemet som initierade kontraktstransaktionen.
Mottagare
 folder.folderRecipientParties array of object

Listan över mottagarparter för detta kuvert.
Mottagarens ID
 folder.folderRecipientParties.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 folder.folderRecipientParties.partyDetails.partyId integer

Mottagarens unika identifierare.
Förnamn
 folder.folderRecipientParties.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 folder.folderRecipientParties.partyDetails.lastName string

Mottagarens efternamn.
E-postadress
 folder.folderRecipientParties.partyDetails.emailId string

Mottagarens e-postadress.
Platshållare
 folder.folderRecipientParties.partyDetails.placeholder boolean

Anger om den här parten är en platshållarmottagare.
Address
 folder.folderRecipientParties.partyDetails.address string

Mottagarens fysiska adress.
Skapelsedatum
 folder.folderRecipientParties.partyDetails.dateCreated integer

Datumet då posten skapades (Unix-tidsstämpel i millisekunder).
Avregistrera e-postmeddelanden
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

Anger om mottagaren har valt bort e-postaviseringar.
Unikt mottagar-ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

En unik systemidentifierare för den här mottagaren.
Autentiseringsnivå
 folder.folderRecipientParties.partyDetails.authenticationLevel string

Den autentiseringsmetod som krävs för den här mottagaren.
Lösenord uppdaterat datum
 folder.folderRecipientParties.partyDetails.passwordUpdateDate string

Datumet då lösenordet senast uppdaterades.
Status för lösenord har uppdaterats
 folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

Anger om lösenordet har uppdaterats.
Företags-ID
 folder.folderRecipientParties.partyDetails.companyId integer

Företagets unika identifierare.
Användarroll
 folder.folderRecipientParties.partyDetails.userRole string

Rollen som tilldelats användaren.
Avdelning
 folder.folderRecipientParties.partyDetails.department string

Den avdelning som användaren tillhör.
Title
 folder.folderRecipientParties.partyDetails.title string

Användarens jobbrubrik.
Aktivt
 folder.folderRecipientParties.partyDetails.active boolean

Anger om användaren eller posten är aktiv.
Lokal
 folder.folderRecipientParties.partyDetails.requestLocale string

Språkinställningen för användaren.
Dela med Dept
 folder.folderRecipientParties.partyDetails.share_among_department boolean

Anger om kuvert delas över hela avdelningen.
Uppringningskod
 folder.folderRecipientParties.partyDetails.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.folderRecipientParties.partyDetails.mobileNumber string

Mobiltelefonnumret.
Statusfilter
 folder.folderRecipientParties.partyDetails.docStatusFilter string

Ett filter för dokumentstatus.
Datumfilter
 folder.folderRecipientParties.partyDetails.docDateFilter string

Ett filter för dokumentdatum.
Säker fältåtkomst
 folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

Anger om användaren har åtkomst till säkra fält.
Expandera sidopanelen
 folder.folderRecipientParties.partyDetails.expandSidebar boolean

Anger om sidofältet expanderas som standard.
Adv. E-postverifiering
 folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

Anger om avancerad e-postverifiering är aktiverad.
Chefs-ID
 folder.folderRecipientParties.partyDetails.managerId string

Den unika identifieraren för användarens chef.
Antal inloggningar
 folder.folderRecipientParties.partyDetails.loginCount integer

Antalet gånger användaren har loggat in.
E-post för lösenordsåterställning
 folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

Anger om ett e-postmeddelande för lösenordsåterställning ska skickas.
Avdelnings-ID
 folder.folderRecipientParties.partyDetails.departmentId string

Den unika identifieraren för avdelningen.
Primärt företag
 folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

Det primära företaget som är associerat med användaren.
Enhetstyp
 folder.folderRecipientParties.partyDetails.deviceType string

Vilken typ av enhet som används.
Enhetstoken
 folder.folderRecipientParties.partyDetails.deviceToken string

Push-meddelandetoken för enheten.
Beskrivning av underleverantör
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

En beskrivning av underleverantören eller den externa undertecknaren.
Underleverantörsorganisation
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

Underleverantörens eller den externa undertecknarens organisationsnamn.
Underleverantör har lagts till
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

Det datum då underleverantören lades till (Unix-tidsstämpel i millisekunder).
Källa
 folder.folderRecipientParties.partyDetails.source string

Källsystemet som den externa undertecknaren lades till från.
Uppringningskod
 folder.folderRecipientParties.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.folderRecipientParties.mobileNumber string

Mobiltelefonnumret.
Signaturtyp
 folder.folderRecipientParties.signerSignatureType string

Den typ av signatur som undertecknaren ska använda.
Permissions
 folder.folderRecipientParties.contractPermissions string

De behörigheter som beviljats den här parten för kontraktet.
Signeringsorder
 folder.folderRecipientParties.partySequence integer

Sekvensnumret för signeringsordningen för den här mottagaren.
Arbetsflödessekvens
 folder.folderRecipientParties.workflowSignSequence integer

Sekvensnumret för arbetsflödessignering.
Kuvert-ID
 folder.folderRecipientParties.envelopeId integer

Kuvertets unika identifierare.
Mottagarens företags-ID
 folder.folderRecipientParties.partyCompanyId integer

Den unika identifieraren för det företag som är associerat med den här mottagaren.
Delningsläge
 folder.folderRecipientParties.sharingMode string

Delningsläget för det här kuvertet.
URL för mottagaråtkomst
 folder.folderRecipientParties.folderAccessURL string

Den URL som mottagaren kan använda för att komma åt och signera kuvertet.
Säkerhetsläge
 folder.folderRecipientParties.securityMode string

Säkerhetsläget som tillämpas på det här kuvertet.
Comments
 folder.folderRecipientParties.extraComments string

Ytterligare kommentarer som ingår i kuvertet.
Tillåt namnändring
 folder.folderRecipientParties.allowNameChange boolean

Anger om mottagaren får uppdatera sitt namn.
Namn uppdaterat
 folder.folderRecipientParties.signerNameUpdated boolean

Anger om undertecknaren har uppdaterat sitt namn.
Autentiseringsnivå för undertecknare
 folder.folderRecipientParties.signerAuthenticationLevel string

Den autentiseringsnivå som krävs för undertecknaren.
Åtkomstkod
 folder.folderRecipientParties.userDefinedAccessCode string

En anpassad åtkomstkod som definierats för undertecknaren.
Signaturidentitet
 folder.folderRecipientParties.signatureId string

Den unika identifieraren för signaturen.
Mottagarroll
 folder.folderRecipientParties.partyRole string

Rollen som tilldelats den här mottagaren i signeringsarbetsflödet.
Företagsfält
 folder.folderRecipientParties.companyFieldValue string

Värdet för fältet företagsnamn i signaturen.
Rubrikfält
 folder.folderRecipientParties.titleFieldValue string

Värdet för rubrikfältet i signaturen.
Orsak till signering
 folder.folderRecipientParties.reasonSigning string

Anledningen till att mottagaren signerar dokumentet.
Betalningsfält har lagts till
 folder.folderRecipientParties.payFieldAdded boolean

Anger om ett betalningsfält har lagts till.
Betalningsmottagare
 folder.folderRecipientParties.payee boolean

Anger om mottagaren är betalningsmottagaren.
Återkommande betalning
 folder.folderRecipientParties.recurringFieldExist boolean

Anger om det finns ett återkommande betalningsfält.
Skriv ut och signera klar
 folder.folderRecipientParties.printAndSignCompleted boolean

Anger om utskrifts- och signeringsprocessen är klar.
Paid
 folder.folderRecipientParties.paid boolean

Anger om betalningen har slutförts.
Valfri undertecknare tillåts
 folder.folderRecipientParties.allowOptionalSigner boolean

Anger om mottagaren är en valfri undertecknare.
Valfria undertecknare
 folder.folderRecipientParties.optionalSigners array of integer

Listan över valfria signeringspart-ID:er för det här kuvertet.
Url för redigeringssignering
 folder.folderAccessURLForAuthor string

Den URL som avsändaren kan använda för att komma åt kuvertet.
URL för utkaståtkomst
 folder.draftFolderAccessURL string

Url:en som används för att komma åt utkastversionen av kuvertet.
Signering av styrelserum
 folder.boardRoomSign boolean

Anger om brädrummets signeringsläge är aktiverat.
Inkludera logotyp
 folder.includeLogo boolean

Anger om företagslogotypen ingår i e-postmeddelanden.
Bakgrundsfärg för knapp
 folder.email_btnBgColor string

Bakgrundsfärgen för e-postknappen.
Knapptextfärg
 folder.email_btnTxtColor string

Textfärgen på e-postknappen.
E-postlogotyp
 folder.emailTemplateLogo string

Logotyp-URL:en som används i e-postmallen.
E-postmalls-ID
 folder.emailTemplateId integer

Den unika identifieraren för e-postmallen.
E-postrubrik
 folder.emailHeader string

Rubriktexten som används i e-postaviseringar.
E-postfot
 folder.emailFooter string

Sidfotstexten som används i e-postaviseringar.
Rensa schemalagd
 folder.purgeFlag boolean

Anger om kuvertet är schemalagt för rensning.
Rensa startdatum
 folder.purgeStartDate string

Det datum då rensningen är schemalagd att börja.
Rensa slutdatum
 folder.purgeEndDate string

Det datum då rensningen är schemalagd att slutföras.
Massutskicks-ID
 folder.bulkId integer

Den unika identifieraren för masssändningsåtgärden.
Framtvinga signeringsorder
 folder.enforceSignWorkflow boolean

Anger om mottagarna måste logga in i den definierade sekvensen.
Aktuellt steg
 folder.currentWorkflowStep integer

Det aktuella steget i signeringsarbetsflödet.
Transaktionskälla
 folder.transactionSource string

Källsystemet som initierade den här transaktionen.
Redigerbar
 folder.editable boolean

Anger om objektet kan redigeras.
In-Person signering
 folder.inPersonSignable boolean

Anger om kuvertet kan loggas in personligen.
Åsidosätt påminnelser
 folder.overrideAccountReminders boolean

Anger om inställningarna för påminnelser på kontonivå är åsidosatta.
Åsidosätt delegering
 folder.overrideAccountRecipientDelegation boolean

Anger om delegeringsinställningarna på kontonivå är åsidosatta.
Tillåt delegering
 folder.allowRecipientsToDelegate boolean

Anger om mottagare får delegera signering.
ID
 folder.envelopeId integer

Kuvertets unika identifierare.
Name
 folder.envelopeName string

Kuvertets namn.
Ursprungs-ID
 folder.envelopeOriginatorId integer

Den unika identifieraren för den användare som skapade kuvertet.
Företags-ID
 folder.envelopeCompanyId integer

Den unika identifieraren för det företag som äger kuvertet.
Date
 folder.envelopeDate integer

Det datum då kuvertet skapades (Unix-tidsstämpel i millisekunder).
Delat datum
 folder.envelopeSharedDate integer

Det datum då kuvertet delades (Unix-tidsstämpel i millisekunder).
Status
 folder.envelopeStatus string

Kuvertets aktuella status.
Kontrakts-ID:t
 folder.envelopeContractIds array of integer

Listan över kontrakt-ID:t som är associerade med det här kuvertet.
Mottagarbehörigheter
 folder.envelopePartyPermissions array of object

Listan över mottagarbehörigheter för det här kuvertet.
Mottagarens ID
 folder.envelopePartyPermissions.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 folder.envelopePartyPermissions.partyDetails.partyId integer

Mottagarens unika identifierare.
Förnamn
 folder.envelopePartyPermissions.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 folder.envelopePartyPermissions.partyDetails.lastName string

Mottagarens efternamn.
E-postadress
 folder.envelopePartyPermissions.partyDetails.emailId string

Mottagarens e-postadress.
Platshållare
 folder.envelopePartyPermissions.partyDetails.placeholder boolean

Anger om den här parten är en platshållarmottagare.
Address
 folder.envelopePartyPermissions.partyDetails.address string

Mottagarens fysiska adress.
Skapelsedatum
 folder.envelopePartyPermissions.partyDetails.dateCreated integer

Datumet då posten skapades (Unix-tidsstämpel i millisekunder).
Avregistrera e-postmeddelanden
 folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

Anger om mottagaren har valt bort e-postaviseringar.
Unikt mottagar-ID
 folder.envelopePartyPermissions.partyDetails.uniquePartyId string

En unik systemidentifierare för den här mottagaren.
Autentiseringsnivå
 folder.envelopePartyPermissions.partyDetails.authenticationLevel string

Den autentiseringsmetod som krävs för den här mottagaren.
Lösenord uppdaterat datum
 folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

Datumet då lösenordet senast uppdaterades.
Status för lösenord har uppdaterats
 folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

Anger om lösenordet har uppdaterats.
Företags-ID
 folder.envelopePartyPermissions.partyDetails.companyId integer

Företagets unika identifierare.
Användarroll
 folder.envelopePartyPermissions.partyDetails.userRole string

Rollen som tilldelats användaren.
Avdelning
 folder.envelopePartyPermissions.partyDetails.department string

Den avdelning som användaren tillhör.
Title
 folder.envelopePartyPermissions.partyDetails.title string

Användarens jobbrubrik.
Aktivt
 folder.envelopePartyPermissions.partyDetails.active boolean

Anger om användaren eller posten är aktiv.
Lokal
 folder.envelopePartyPermissions.partyDetails.requestLocale string

Språkinställningen för användaren.
Dela med Dept
 folder.envelopePartyPermissions.partyDetails.share_among_department boolean

Anger om kuvert delas över hela avdelningen.
Uppringningskod
 folder.envelopePartyPermissions.partyDetails.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.envelopePartyPermissions.partyDetails.mobileNumber string

Mobiltelefonnumret.
Statusfilter
 folder.envelopePartyPermissions.partyDetails.docStatusFilter string

Ett filter för dokumentstatus.
Datumfilter
 folder.envelopePartyPermissions.partyDetails.docDateFilter string

Ett filter för dokumentdatum.
Säker fältåtkomst
 folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

Anger om användaren har åtkomst till säkra fält.
Expandera sidopanelen
 folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

Anger om sidofältet expanderas som standard.
Adv. E-postverifiering
 folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

Anger om avancerad e-postverifiering är aktiverad.
Chefs-ID
 folder.envelopePartyPermissions.partyDetails.managerId string

Den unika identifieraren för användarens chef.
Antal inloggningar
 folder.envelopePartyPermissions.partyDetails.loginCount integer

Antalet gånger användaren har loggat in.
E-post för lösenordsåterställning
 folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

Anger om ett e-postmeddelande för lösenordsåterställning ska skickas.
Avdelnings-ID
 folder.envelopePartyPermissions.partyDetails.departmentId string

Den unika identifieraren för avdelningen.
Primärt företag
 folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

Det primära företaget som är associerat med användaren.
Enhetstyp
 folder.envelopePartyPermissions.partyDetails.deviceType string

Vilken typ av enhet som används.
Enhetstoken
 folder.envelopePartyPermissions.partyDetails.deviceToken string

Push-meddelandetoken för enheten.
Beskrivning av underleverantör
 folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

En beskrivning av underleverantören eller den externa undertecknaren.
Underleverantörsorganisation
 folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

Underleverantörens eller den externa undertecknarens organisationsnamn.
Underleverantör har lagts till
 folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

Det datum då underleverantören lades till (Unix-tidsstämpel i millisekunder).
Källa
 folder.envelopePartyPermissions.partyDetails.source string

Källsystemet som den externa undertecknaren lades till från.
Uppringningskod
 folder.envelopePartyPermissions.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.envelopePartyPermissions.mobileNumber string

Mobiltelefonnumret.
Signaturtyp
 folder.envelopePartyPermissions.signerSignatureType string

Den typ av signatur som undertecknaren ska använda.
Permissions
 folder.envelopePartyPermissions.contractPermissions string

De behörigheter som beviljats den här parten för kontraktet.
Signeringsorder
 folder.envelopePartyPermissions.partySequence integer

Sekvensnumret för signeringsordningen för den här mottagaren.
Arbetsflödessekvens
 folder.envelopePartyPermissions.workflowSignSequence integer

Sekvensnumret för arbetsflödessignering.
Kuvert-ID
 folder.envelopePartyPermissions.envelopeId integer

Kuvertets unika identifierare.
Mottagarens företags-ID
 folder.envelopePartyPermissions.partyCompanyId integer

Den unika identifieraren för det företag som är associerat med den här mottagaren.
Delningsläge
 folder.envelopePartyPermissions.sharingMode string

Delningsläget för det här kuvertet.
URL för mottagaråtkomst
 folder.envelopePartyPermissions.folderAccessURL string

Den URL som mottagaren kan använda för att komma åt och signera kuvertet.
Säkerhetsläge
 folder.envelopePartyPermissions.securityMode string

Säkerhetsläget som tillämpas på det här kuvertet.
Comments
 folder.envelopePartyPermissions.extraComments string

Ytterligare kommentarer som ingår i kuvertet.
Tillåt namnändring
 folder.envelopePartyPermissions.allowNameChange boolean

Anger om mottagaren får uppdatera sitt namn.
Namn uppdaterat
 folder.envelopePartyPermissions.signerNameUpdated boolean

Anger om undertecknaren har uppdaterat sitt namn.
Autentiseringsnivå för undertecknare
 folder.envelopePartyPermissions.signerAuthenticationLevel string

Den autentiseringsnivå som krävs för undertecknaren.
Åtkomstkod
 folder.envelopePartyPermissions.userDefinedAccessCode string

En anpassad åtkomstkod som definierats för undertecknaren.
Signaturidentitet
 folder.envelopePartyPermissions.signatureId string

Den unika identifieraren för signaturen.
Mottagarroll
 folder.envelopePartyPermissions.partyRole string

Rollen som tilldelats den här mottagaren i signeringsarbetsflödet.
Företagsfält
 folder.envelopePartyPermissions.companyFieldValue string

Värdet för fältet företagsnamn i signaturen.
Rubrikfält
 folder.envelopePartyPermissions.titleFieldValue string

Värdet för rubrikfältet i signaturen.
Orsak till signering
 folder.envelopePartyPermissions.reasonSigning string

Anledningen till att mottagaren signerar dokumentet.
Betalningsfält har lagts till
 folder.envelopePartyPermissions.payFieldAdded boolean

Anger om ett betalningsfält har lagts till.
Betalningsmottagare
 folder.envelopePartyPermissions.payee boolean

Anger om mottagaren är betalningsmottagaren.
Återkommande betalning
 folder.envelopePartyPermissions.recurringFieldExist boolean

Anger om det finns ett återkommande betalningsfält.
Skriv ut och signera klar
 folder.envelopePartyPermissions.printAndSignCompleted boolean

Anger om utskrifts- och signeringsprocessen är klar.
Paid
 folder.envelopePartyPermissions.paid boolean

Anger om betalningen har slutförts.
Autentiseringsnivå
 folder.envelopeAuthenticationLevel string

Den autentiseringsnivå som krävs för kuvertet.
Massinloggning för enkel undertecknare
 folder.allowSingleSignerInBulk boolean

Anger om en enkel undertecknare tillåts i massutskicksläge.
File-Based namngivning
 folder.folderNameBasedOnFileNaming boolean

Anger om mappnamnet baseras på filnamnet.
Doc File-Based Name
 folder.documentNameBasedOnFileNaming boolean

Anger om dokumentnamnet baseras på filnamnet.
Certifikat File-Based namn
 folder.certificateNameBasedOnFileNaming boolean

Anger om certifikatnamnet baseras på filnamnet.
Pre-Exec-filnamngivning
 folder.enableFileNamingBeforeExecution boolean

Anger om filnamngivning är aktiverat före dokumentkörning.
Betalningsmottagaren har lagts till
 folder.payeeAddedd boolean

Anger om en betalningsmottagare har lagts till.
Self-Signing aktiverat
 folder.selfSignerEnabled boolean

Anger om självsigneringsläget är aktiverat.
Notarie aktiverad
 folder.notaryEnabled boolean

Anger om notariesignering är aktiverat.
Begränsad synlighet
 folder.limitedVisibilityFlag boolean

Anger om begränsad synlighet är aktiverat för det här kuvertet.
Synlighet efter tecken
 folder.postSigningVisibility boolean

Anger om synligheten efter signering är aktiverad.
Våt signatur
 folder.wetSignatureEnabled boolean

Anger om våta signaturer är aktiverade.
Sammanslagning aktiverat
 folder.mergeEnabled boolean

Anger om dokumentsammanslagningen är aktiverad.
Inbäddade signeringssessioner
 embeddedSigningSessions array of object

Listan över inbäddade signeringssessioner, en per mottagare. Endast när createEmbeddedSigningSession är sant.
E-post för undertecknare
 embeddedSigningSessions.emailIdOfSigner string

E-postadressen till mottagaren för den här inbäddade signeringssessionen.
Signeringstoken
 embeddedSigningSessions.embeddedToken string

Den unika token för den här mottagarens inbäddade signeringssession.
URL för signeringssession
 embeddedSigningSessions.embeddedSessionURL string

Url:en som ska öppnas eller bäddas in för den här mottagaren för att signera dokumentet.
Inbäddad sändningstoken
 embeddedToken string

Token för den inbäddade sändningssessionen. Endast när createEmbeddedSendingSession är sant.
Skicka sessions-URL
 embeddedSessionURL string

Url:en som ska öppnas eller bäddas in för kuvertförfattaren för att förbereda och skicka kuvertet. Endast när createEmbeddedSendingSession är sant.
Result
 result string

Resultatet av operationen.
Message
 message string

Ett meddelande som beskriver resultatet av åtgärden.

Skapa kuvert från mall

Åtgärds-ID:
CreateEnvelopefromTemplate

Skapar och skickar ett kuvert med hjälp av en befintlig mall. Mottagarinformation kan anpassas.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvertnamn
 folderName string

Namnet på mappen/dokumenten. Om det här värdet inte anges behålls namnet på dokumentmappen på samma sätt som mallnamnen.
Mall-ID:t
 templateIds True array of integer

En matris med mall-ID:t som du vill använda för att skapa dokumenten för den här mappen.
Fält
 fields object

Du kan skicka fältvärdena som används i mallarna för att fylla i dem i dokumenten som skapats från mallen. FIELD_NAME är namnet på det fält som används i mallen. FIELD_VALUE är dokumentets fältvärde.
Avancerad e-postverifiering
 allowAdvancedEmailValidation boolean

Verifiera parternas e-postadresser när de anges som sanna.
Förnamn
 firstName True string

Mottagarens förnamn.
Efternamn
 lastName True string

Mottagarens efternamn.
E-postadress
 emailId True string

Mottagarens e-postadress.
permissions
 permission True string
Sekvens
 sequence True integer

Använd det här fältet om du vill tilldela ett sekvensnummer till en mottagare i listan över mottagarparter. Använd unika sekvensnummer för varje part som börjar med 1 som 1,2,3,4.... Om en enskild person visas flera gånger i signeringsarbetsflödet tilldelar du en annan sekvens varje gång mottagaren upprepas.
signerAuthLevels
 signerAuthLevel string

Den autentiseringsnivå som en undertecknare använder för verifieringsändamål
Är platshållare
 isPlaceholder boolean

Använd det här fältet för att initiera att parten är en platshållare. Obs! 1. värdet för parametern firstName, lastName och emailId måste vara tomt för den här parten. 2. Om du vill lägga till platshållaren måste en mottagare få behörigheten "PARTY_ASSIGNER".
Mottagarroll
 partyRole string

Använd det här fältet för att tilldela en roll som platshållare.
Tillåt namnändring
 allowNameChange string

Värdet kan vara antingen sant eller falskt Använd den här parametern för att tillåta att undertecknaren uppdaterar för- och efternamn innan signeringsprocessen slutförs.
Arbetsflödessekvens
 workflowSequence integer

Tilldela mottagaren ett arbetsflödessekvensnummer. När inloggningssekvensen är aktiverad får mottagarna sin signeringsinbjudan i stigande sekvensordning.
Värd-E-post-ID
 hostEmailId string

E-postadress till In-Person administratör.
Åtkomstkod
 userDefinedAccessCode string

Parametern innehåller Åtkomstkod när värdet "signerAuthLevel" anges som "Användardefinierad åtkomstkod" för autentisering. Obs! 1. Koder är inte skiftlägeskänsliga. 2. Systemet skickar inte den här koden så du måste dela den här koden direkt med undertecknaren. 3. Åtkomstkod kan innehålla alfabet, siffror och följande specialtecken: @,&,{,},%,(,),~,|,!,+,^.
Parten är e-postgrupp
 partyIsEmailGroup boolean

Använd den här parametern när du skapar en part som bulk. Observera: Om den här parametern är sann ignoreras firstName, lastName och emailId för den här parten.
E-postgrupp-ID
 emailGroupId integer

Skicka e-postmeddelandet till det grupp-ID som du vill använda för att skapa massutskick.
Massinloggning för enkel undertecknare
 allowSingleSignerInBulk boolean

Använd den här parametern om du bara vill tillåta att en person loggar in i e-postgruppen.
Uppringningskod
 dialingCode string

Använd det här fältet för att tilldela ett lands uppringningskoder är mobilnummerprefix till en mottagare i listan över mottagarparter.
Mobilnummer
 mobileNumber string

Använd det här fältet om du vill tilldela ett mobilnummer till en mottagare i listan över mottagarparter.
Kuvertlösenord
 folderPassword string

Det här lösenordet krävs av undertecknaren/författaren för att öppna det digitalt signerade dokumentet. Om parametern hålls tom krävs inget lösenord för att öppna det digitalt signerade dokumentet.
Logga in sekvens
 signInSequence boolean

Det här fältet används för att avgöra om mottagarna kommer att signera kuvertdokumenten i en sekvens. Om det är falskt får alla mottagare e-postinbjudan samtidigt. När det är sant får varje mottagare e-postinbjudan successivt efter att den tidigare mottagaren har slutfört den nödvändiga uppgiften, till exempel signera dokument eller fylla i fält osv.
Aktivera personligen
 inPersonEnable boolean

Det här fältet används för att initiera den personliga signeringsprocessen som enkelt kan slutföras på valfri enhet på några minuter och undviker e-postbaserade signaturer där det behövs. Om det är falskt får alla mottagare e-postinbjudan samtidigt. När det är sant får administratören en inbjudan via e-post för att initiera signeringsprocessen för undertecknaren.
Skicka nu
 sendNow boolean

När det är aktiverat skickar Foxit eSign omedelbart en unik signeringslänk till varje mottagares e-postadress. Inaktivera detta om du vill spara kuvertet som ett utkast i stället.
Sign Success URL Alla parter
 signSuccessUrlAllParties boolean

Om värdet är true omdirigeras undertecknaren till URL:en som anges i signSuccessUrl efter att signeringen har slutförts. Detta gäller endast när sendNow är sant.
Skapa inbäddad sändningssession
 createEmbeddedSendingSession boolean

Om värdet är true genereras en inbäddad URL för att öppna dokumentet som förbereder vyn för Foxit eSign.
Åtgärda mottagarparter
 fixRecipientParties boolean

Om det är sant kan inte den inbäddade sändningsvyn ändra parterna för kuvertet som redan har lagts till som en del av den här begäran.
Åtgärda dokument
 fixDocuments boolean

Om det är sant kan inte den inbäddade sändningen ändra dokumenten för kuvertet som redan har lagts till som en del av den här begäran.
Skicka lyckad URL
 sendSuccessUrl string

Ange den absoluta URL:en för landningssidan, som undertecknaren omdirigeras till när mappen har skickats i den inbäddade sändningsvyn.
Skicka fel-URL
 sendErrorUrl string

Ange den absoluta URL:en för landningssidan, som undertecknaren omdirigeras till om felet uppstår när mappen skickas i den inbäddade sändningsvyn.
Dölj alternativet Välj undertecknare
 hideSignerSelectOption boolean

Om det är sant döljs indatarutan "Befintlig undertecknare/e-post" på mottagarparter i en inbäddad sändningssession.
Dölj undertecknaråtgärder
 hideSignerActions boolean

Om det är sant döljs undertecknarens åtgärder "redigera", "ändra" och "ta bort" på mottagarparter i en inbäddad sändningssession.
Dölj avsändarens namn
 hideSenderName boolean

Om det är sant döljs avsändarens namn på mottagarparterna i en inbäddad sändningssession.
Dölj knappen Skicka
 hideSendButton boolean

Om det är sant döljs knappen Skicka i den inbäddade sändningssessionen.
Dölj mappnamn
 hideFolderName boolean

Om det är sant döljs mappnamnet i navigeringen i båda inbäddade sessioner.
Dölj dokumentnamn
 hideDocumentsName boolean

Om det är sant döljs dokumentnamnet i båda inbäddade sessioner.
Dölj knappen Lägg till mig
 hideAddMeButton boolean

Om det är sant döljs knappen "Lägg till mig" på mottagarparterna i en inbäddad sändningssession.
Dölj knappen Lägg till ny
 hideAddNewButton boolean

Om det är sant döljs knappen "Lägg till ny" på mottagarparter i en inbäddad sändningssession.
Dölj knappen Lägg till grupp
 hideAddGroupButton boolean

Om det är sant döljs knappen "Lägg till grupp" på mottagarparter i en inbäddad sändningssession.
Skapa inbäddad signeringssession
 createEmbeddedSigningSession boolean

Signeringssessionstoken genereras utan att skicka ut e-postmeddelanden till mottagarna.
Skapa inbäddad signeringssession för alla parter
 createEmbeddedSigningSessionForAllParties boolean

Om värdet är true genereras en inbäddad signerings-URL för varje mottagare i kuvertet. Om det är falskt får endast mottagare som anges i E-post-ID:t för inbäddade undertecknare en inbäddad session.
E-post-ID för inbäddade undertecknare
 embeddedSignersEmailIds array of string

En matris med e-post-ID:t för mottagare för vilka en inbäddad signeringssession måste skapas. E-post-ID:t från mottagarparterna som lagts till i listan över parter.
Url för signeringsframgång
 signSuccessUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till när de har loggat in i den inbäddade signeringsvyn.
Url för nekande av tecken
 signDeclineUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om de avböjer att logga in i den inbäddade signeringsvyn.
Signera senare URL
 signLaterUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om de väljer att logga in senare i den inbäddade signeringsvyn.
Url för teckenfel
 signErrorUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om felet uppstår när dokumentet signeras i den inbäddade signeringsvyn.
Dölj nästa obligatoriska fält btn
 hideNextRequiredFieldBtn boolean

Om värdet är true döljer du navigeringsknappen som flyttar undertecknarna till nästa obligatoriska fält.
Temafärg
 themeColor string

Ange CSS-värdet för att ange temafärgen.
Dölj neka att signera
 hideDeclineToSign boolean

Om värdet är true döljer du alternativet Neka till tecken på signeringsskärmen.
Dölj mer åtgärd
 hideMoreAction boolean

Om värdet är true döljer du knappen Fler åtgärder i sändnings- och signeringssessionen. Har ingen effekt när Skicka nu är sant.
Dölj alternativet Lägg till parter
 hideAddPartiesOption boolean

Om värdet är true döljer du alternativet för att lägga till parter i läget Skapa utkast och mall.
Sessionen upphör att gälla
 sessionExpire boolean

Ange som true för att initiera förfallningen av den inbäddade signeringssessionen.
Upphörande
 expiry integer

Krävs om sessionExpire är sant. Ange varaktighet i millisekunder för förfallodatum för den inbäddade signeringssessionen.
E-post för avsändare
 senderEmail string

ange e-post för en annan användare i ditt konto som ska användas för att skicka den här dokumentmappen till mottagarparterna.
Tillåt skicka nu och inbäddad signeringssession
 allowSendNowAndEmbeddedSigningSession boolean

Om värdet är true skickar Foxit eSign ett e-postmeddelande med signeringsinbjudan till varje mottagare och genererar även en inbäddad signeringslänk för mottagare vars e-post ingår i Embedded Signer Email. Både e-postmeddelandet och den inbäddade länken är aktiva samtidigt.
Aktivera steg för steg
 enableStepByStep boolean

Aktivera steg för steg-åtgärd i den inbäddade sändningssessionen.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om åtgärden lyckades (t.ex. "lyckades").
Message
 message string

En beskrivning av åtgärdsresultatet.
Inbäddade signeringssessioner
 embeddedSigningSessions array of object

Listan över inbäddade signeringssessioner, en per mottagare. Endast när createEmbeddedSigningSession är sant.
E-post för undertecknare
 embeddedSigningSessions.emailIdOfSigner string

E-postadressen till mottagaren för den här inbäddade signeringssessionen.
Signeringstoken
 embeddedSigningSessions.embeddedToken string

Den unika token för den här mottagarens inbäddade signeringssession.
URL för signeringssession
 embeddedSigningSessions.embeddedSessionURL string

Url:en som ska öppnas eller bäddas in för den här mottagaren för att signera dokumentet.
Inbäddad sändningstoken
 embeddedToken string

Token för den inbäddade sändningssessionen. Endast när createEmbeddedSendingSession är sant.
Skicka sessions-URL
 embeddedSessionURL string

Url:en som ska öppnas eller bäddas in för kuvertförfattaren för att förbereda och skicka kuvertet. Endast när createEmbeddedSendingSession är sant.
ID
 folder.folderId integer

Det unika ID:t för det skapade kuvertet. Använd detta för att referera till kuvertet i efterföljande åtgärder.
Name
 folder.folderName string

Kuvertets namn.
Anpassat namn
 folder.folderCustomName string

Det anpassade namn som tilldelats kuvertet.
Lösenord
 folder.folderPassword string

Lösenordet som angetts för kuvertet, om det finns något.
Redigerings-ID
 folder.folderAuthorId integer

Det unika ID:t för den användare som skapade kuvertet.
Författarens förnamn
 folder.folderAuthorFirstName string

Förnamnet på kuvertskapare.
Författarens efternamn
 folder.folderAuthorLastName string

Efternamnet på kuvertskapare.
E-postförfattare
 folder.folderAuthorEmail string

E-postadressen till kuvertskapare.
Redigeringsroll
 folder.folderAuthorRole string

Kontorollen för kuvertskapare.
Företags-ID
 folder.folderCompanyId integer

Det unika ID för företaget som kuvertet tillhör.
Skapandedatum
 folder.folderCreationDate integer

Datum och tid då kuvertet skapades i Unix-millisekunder.
Skickat datum
 folder.folderSentDate integer

Datum och tid då kuvertet skickades till mottagarna i Unix millisekunder.
Status
 folder.folderStatus string

Kuvertets aktuella status (t.ex. DELAD, KÖRD, UTKAST, ANNULLERAD).
Anpassat fält 1
 folder.custom_field1 string

Värdet för anpassat fält 1 som angetts på kuvertet.
Anpassat fält 2
 folder.custom_field2 string

Värdet för anpassat fält 2 som angetts på kuvertet.
Metadata
 folder.metadata string

Eventuella ytterligare metadata som är associerade med kuvertet.
Dokument-ID
 folder.folderDocumentIds array of integer

Listan över dokument-ID:t som ingår i det här kuvertet.
Documents
 folder.documentsList array of object

Information om varje dokument som ingår i kuvertet.
Dokument-ID
 folder.documentsList.documentId integer

Dokumentets unika identifierare.
Kontrakts-ID
 folder.documentsList.contractId integer

Den unika identifieraren för kontraktet som är associerat med det här dokumentet.
Företags-ID
 folder.documentsList.companyId integer

Det unika ID:t för företaget som dokumentet tillhör.
Skapad av
 folder.documentsList.contractCreatedBy integer

Användar-ID för den person som skapade kontraktet.
Skapad på
 folder.documentsList.contractCreatedOn string

Datumet då kontraktet skapades.
Kontraktstyp
 folder.documentsList.contractType string

Typ av kontrakt.
Dokumentstatus
 folder.documentsList.contractStatus string

Dokumentets aktuella signeringsstatus (t.ex. WAITING_FOR_SIGNATURE, KÖRD).
Redigerbar
 folder.documentsList.editable boolean

Anger om dokumentet kan redigeras.
Versions-ID
 folder.documentsList.contractVersionId integer

Det unika ID:t för den aktuella dokumentversionen.
Versionsnamn
 folder.documentsList.contractVersionName string

Namnet på den aktuella dokumentversionen.
Versionsbeskrivning
 folder.documentsList.contractVersionDesc string

En beskrivning av den aktuella dokumentversionen.
Version skapad av
 folder.documentsList.versionCreatedby integer

Användar-ID för den person som skapade den här dokumentversionen.
Version skapad på
 folder.documentsList.versionCreatedOn string

Det datum då den här dokumentversionen skapades.
Versionsnummer
 folder.documentsList.contractVersionNumber integer

Versionsnumret för dokumentet.
Transaktionskälla
 folder.documentsList.contractTransactionSource string

Källan till kontraktstransaktionen.
Mottagare
 folder.folderRecipientParties array of object

Listan över mottagare för det här kuvertet, inklusive deras enskilda signeringslänkar.
Mottagarens ID
 folder.folderRecipientParties.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 folder.folderRecipientParties.partyDetails.partyId integer

Mottagarens unika identifierare.
Förnamn
 folder.folderRecipientParties.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 folder.folderRecipientParties.partyDetails.lastName string

Mottagarens efternamn.
E-postmeddelande
 folder.folderRecipientParties.partyDetails.emailId string

Mottagarens e-postadress.
Är platshållare
 folder.folderRecipientParties.partyDetails.placeholder boolean

Anger om mottagaren är en platshållare.
Address
 folder.folderRecipientParties.partyDetails.address string

Mottagarens adress.
Datum då kontot skapades
 folder.folderRecipientParties.partyDetails.dateCreated integer

Det datum då mottagarens konto skapades i Unix millisekunder.
Avregistrera e-postmeddelanden
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

Anger om mottagaren har valt bort e-postaviseringar.
Unikt part-ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

En unik strängidentifierare för mottagaren.
Autentiseringsnivå
 folder.folderRecipientParties.partyDetails.authenticationLevel string

Den autentiseringsnivå som krävs för den här mottagaren.
Företags-ID
 folder.folderRecipientParties.partyDetails.companyId integer

ID:t för det företag som mottagaren tillhör.
Användarroll
 folder.folderRecipientParties.partyDetails.userRole string

Mottagarens roll inom organisationen.
Avdelning
 folder.folderRecipientParties.partyDetails.department string

Mottagarens avdelning.
Title
 folder.folderRecipientParties.partyDetails.title string

Mottagarens jobbtitel.
Aktivt
 folder.folderRecipientParties.partyDetails.active boolean

Anger om mottagarens konto är aktivt.
Uppringningskod
 folder.folderRecipientParties.partyDetails.dialingCode string

Landets uppringningskod för mottagarens telefonnummer.
Mobilnummer
 folder.folderRecipientParties.partyDetails.mobileNumber string

Mottagarens mobiltelefonnummer.
Beskrivning av underleverantör
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

En beskrivning av underleverantören, om tillämpligt.
Underleverantörsorganisation
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

Underleverantörens organisationsnamn, om tillämpligt.
Underleverantör har lagts till
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

Datumet då underleverantören lades till i Unix millisekunder.
Källa
 folder.folderRecipientParties.partyDetails.source string

Källan som mottagaren lades till genom.
Uppringningskod
 folder.folderRecipientParties.dialingCode string

Landsnummer för mottagarens mobilnummer.
Mobilnummer
 folder.folderRecipientParties.mobileNumber string

Mottagarens mobilnummer.
Signaturtyp
 folder.folderRecipientParties.signerSignatureType string

Den typ av signatur som tillåts för den här mottagaren.
Permissions
 folder.folderRecipientParties.contractPermissions string

De signeringsbehörigheter som beviljats den här mottagaren (t.ex. FILL_FIELDS_AND_SIGN).
Signeringsorder
 folder.folderRecipientParties.partySequence integer

Mottagarens position i signeringsordningen.
Arbetsflödessekvens
 folder.folderRecipientParties.workflowSignSequence integer

Sekvensnumret för arbetsflödessignering för den här mottagaren.
Kuvert-ID
 folder.folderRecipientParties.envelopeId integer

ID:t för kuvertet som mottagaren tillhör.
Företags-ID för part
 folder.folderRecipientParties.partyCompanyId integer

ID:t för det företag som mottagaren tillhör.
Delningsläge
 folder.folderRecipientParties.sharingMode string

Den metod som används för att dela dokumentet med den här mottagaren (t.ex. e-post).
Signerings-URL
 folder.folderRecipientParties.folderAccessURL string

Den unika signerings-URL:en för den här mottagaren. Använd detta om du vill dela signeringslänken direkt.
Säkerhetsläge
 folder.folderRecipientParties.securityMode string

Säkerhetsläget som tillämpas på mottagarens åtkomst.
Extra kommentarer
 folder.folderRecipientParties.extraComments string

Eventuella ytterligare kommentarer som ingår i signeringsinbjudan för den här mottagaren.
Tillåt namnändring
 folder.folderRecipientParties.allowNameChange boolean

Anger om mottagaren får ändra sitt namn innan signering.
Namn uppdaterat
 folder.folderRecipientParties.signerNameUpdated boolean

Anger om mottagaren har uppdaterat sitt visningsnamn.
Autentiseringsnivå
 folder.folderRecipientParties.signerAuthenticationLevel string

Den autentiseringsmetod som krävs för att mottagaren ska få åtkomst till dokumentet.
Åtkomstkod
 folder.folderRecipientParties.userDefinedAccessCode string

En anpassad åtkomstkod som krävs för att mottagaren ska kunna öppna dokumentet.
Signaturidentitet
 folder.folderRecipientParties.signatureId string

ID:t för den sparade signaturen som används av den här mottagaren.
Mottagarroll
 folder.folderRecipientParties.partyRole string

Rollen som tilldelats den här mottagaren i kuvertet.
Företagets fältvärde
 folder.folderRecipientParties.companyFieldValue string

Företagets fältvärde ifyllt för den här mottagaren.
Rubrikfältvärde
 folder.folderRecipientParties.titleFieldValue string

Värdet för rubrikfältet ifyllt för den här mottagaren.
Orsak till signering
 folder.folderRecipientParties.reasonSigning string

Anledningen till signering som tillhandahålls av den här mottagaren.
Fältet Betala har lagts till
 folder.folderRecipientParties.payFieldAdded boolean

Anger om ett betalningsfält har lagts till för den här mottagaren.
Är betalningsmottagare
 folder.folderRecipientParties.payee boolean

Anger om mottagaren är betalningsmottagare.
Återkommande fält finns
 folder.folderRecipientParties.recurringFieldExist boolean

Anger om det finns återkommande betalningsfält för den här mottagaren.
Skriv ut och signera slutfört
 folder.folderRecipientParties.printAndSignCompleted boolean

Anger om mottagaren har slutfört en utskrifts- och signeringsåtgärd.
Tillåt valfri undertecknare
 folder.folderRecipientParties.allowOptionalSigner boolean

Anger om mottagaren kan hoppas över som valfri undertecknare.
Valfria undertecknare
 folder.folderRecipientParties.optionalSigners string

Listan över valfria undertecknare som är associerade med den här mottagaren, om några.
Paid
 folder.folderRecipientParties.paid boolean

Anger om mottagaren har slutfört betalningen.
Url för redigeringsåtkomst
 folder.folderAccessURLForAuthor string

Url:en för kuvertförfattaren att komma åt dokumentet.
URL för utkaståtkomst
 folder.draftFolderAccessURL string

URL:en för att komma åt kuvertet när det är i utkasttillstånd.
Skylt för brädrum
 folder.boardRoomSign boolean

Anger om styrelserumssignering är aktiverat för det här kuvertet.
Inkludera logotyp
 folder.includeLogo boolean

Anger om företagslogotypen ingår i e-postaviseringar.
Färg på e-postknapp
 folder.email_btnBgColor string

Bakgrundsfärgen på åtgärdsknappen i signeringsmeddelandet.
Textfärg för e-postknapp
 folder.email_btnTxtColor string

Textfärgen på åtgärdsknappen i signeringsmeddelandet.
E-postlogotyp
 folder.emailTemplateLogo string

Logotypbilden som används i e-postmallen.
E-postmalls-ID
 folder.emailTemplateId integer

ID för e-postmallen som används för signeringsmeddelanden.
E-postrubrik
 folder.emailHeader string

Den anpassade rubriktexten i e-postmeddelanden om signeringsmeddelanden.
E-postfot
 folder.emailFooter string

Den anpassade sidfotstexten i e-postmeddelanden om signeringsmeddelanden.
Rensa schemalagd
 folder.purgeFlag boolean

Anger om kuvertet är schemalagt för automatisk rensning.
Rensa startdatum
 folder.purgeStartDate string

Det datum då rensningsperioden börjar.
Rensa slutdatum
 folder.purgeEndDate string

Det datum då kuvertet ska rensas.
Mass-ID
 folder.bulkId integer

ID:t för massutskicket som kuvertet tillhör, om det finns.
Framtvinga signeringsorder
 folder.enforceSignWorkflow boolean

Anger om mottagarna måste logga in i den angivna ordningen.
Aktuellt arbetsflödessteg
 folder.currentWorkflowStep integer

Det aktuella steget i signeringsarbetsflödet.
Transaktionskälla
 folder.transactionSource string

Källan som initierade den här kuverttransaktionen.
Redigerbar
 folder.editable boolean

Anger om kuvertet fortfarande kan redigeras.
In-Person signering
 folder.inPersonSignable boolean

Anger om kuvertet kan loggas in personligen.
Åsidosätt påminnelser
 folder.overrideAccountReminders boolean

Anger om inställningarna för påminnelser på kontonivå åsidosättas för det här kuvertet.
Åsidosätt delegering
 folder.overrideAccountRecipientDelegation boolean

Anger om delegeringsinställningarna på kontonivå åsidosättas för det här kuvertet.
Tillåt delegering
 folder.allowRecipientsToDelegate boolean

Anger om mottagarna får delegera sin signering till en annan person.
ID
 folder.envelopeId integer

Kuvertets unika ID. Samma värde som Kuvert-ID (folderId).
Name
 folder.envelopeName string

Kuvertets namn. Samma värde som Kuvertnamn (folderName).
Ursprungs-ID
 folder.envelopeOriginatorId integer

Användar-ID för den person som skapade kuvertet.
Företags-ID
 folder.envelopeCompanyId integer

ID:t för företaget som kuvertet tillhör.
Date
 folder.envelopeDate integer

Datum och tid då kuvertet skapades i Unix-millisekunder.
Delat datum
 folder.envelopeSharedDate integer

Datum och tid då kuvertet delades med mottagare, i Unix millisekunder.
Status
 folder.envelopeStatus string

Kuvertets aktuella status. Samma värde som Kuvertstatus (folderStatus).
Kontrakts-ID:t
 folder.envelopeContractIds array of integer

Listan över kontrakt-ID:t som är associerade med det här kuvertet.
Partbehörigheter
 folder.envelopePartyPermissions array of object

Listan över mottagare och deras signeringsbehörigheter. Samma struktur som mottagare.
Mottagarens ID
 folder.envelopePartyPermissions.partyId integer

Mottagarens unika identifierare.
Signerings-URL
 folder.envelopePartyPermissions.folderAccessURL string

Den unika signerings-URL:en för den här mottagaren.
Permissions
 folder.envelopePartyPermissions.contractPermissions string

Signeringsbehörigheterna för den här mottagaren.
Signeringsorder
 folder.envelopePartyPermissions.partySequence integer

Mottagarens position i signeringsordningen.
Autentiseringsnivå
 folder.envelopeAuthenticationLevel string

Autentiseringsnivån som tillämpas på hela kuvertet.
Tillåt massinloggning av enkel undertecknare
 folder.allowSingleSignerInBulk boolean

Anger om en enkel undertecknare tillåts i massutskicksläge.
Namn baserat på fil
 folder.folderNameBasedOnFileNaming boolean

Anger om kuvertnamnet härleds från filnamnet.
Dokumentnamn baserat på fil
 folder.documentNameBasedOnFileNaming boolean

Anger om dokumentnamnet härleds från filnamnet.
Certifikatnamn baserat på fil
 folder.certificateNameBasedOnFileNaming boolean

Anger om certifikatnamnet härleds från filnamnet.
Aktivera filnamngivning
 folder.enableFileNamingBeforeExecution boolean

Anger om filnamngivning tillfrågas innan kuvertet skickas.
Betalningsmottagaren har lagts till
 folder.payeeAddedd boolean

Anger om en betalningsmottagare har lagts till i kuvertet.
Självsignerare
 folder.selfSignerEnabled boolean

Anger om avsändaren också är en undertecknare på det här kuvertet.
Notarie aktiverad
 folder.notaryEnabled boolean

Anger om notarisering är aktiverat för det här kuvertet.
Begränsad synlighet
 folder.limitedVisibilityFlag boolean

Anger om begränsad dokumentsynlighet är aktiverad.
Synlighet efter signering
 folder.postSigningVisibility boolean

Anger om mottagarna kan visa det signerade dokumentet efter slutförandet.
Våt signatur aktiverad
 folder.wetSignatureEnabled boolean

Anger om våta (handskrivna) signaturer är aktiverade för det här kuvertet.
Sammanslagning aktiverat
 folder.mergeEnabled boolean

Anger om dokumentsammanslagningen är aktiverad för det här kuvertet.

Skapa kuvert från URL

Åtgärds-ID:
CreateEnvelopefromURL

Skapar och skickar ett kuvert med offentligt tillgängliga PDF-URL:er. Ange dokument-URL:er och mottagarinformation för att initiera signeringsprocessen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvertnamn
 folderName True string

Namnet på kuvertet.
Indatatyp
 inputType string

Anger dokumentkällans format. Ange url för att ange fil-URL:er eller base64 för att tillhandahålla Base64-kodat filinnehåll.
Fil-URL:ar
 fileUrls True array of string

En matris med offentligt tillgängliga URL:er som pekar på de dokument som ska läggas till i det här kuvertet.
Filnamn
 fileNames True array of string

En matris med visningsnamn för varje dokument i samma ordning som Fil-URL:er.
Förnamn
 firstName True string

Mottagarens förnamn.
Efternamn
 lastName True string

Mottagarens efternamn.
E-postadress
 emailId True string

Mottagarens e-postadress.
permissions
 permission True string
Sekvens
 sequence True integer

Använd det här fältet om du vill tilldela ett sekvensnummer till en mottagare i listan över mottagarparter. Använd unika sekvensnummer för varje part som börjar med 1 som 1,2,3,4.... Om en enskild person visas flera gånger i signeringsarbetsflödet tilldelar du en annan sekvens varje gång mottagaren upprepas.
signerAuthLevels
 signerAuthLevel string

Den autentiseringsnivå som en undertecknare använder för verifieringsändamål
Är platshållare
 isPlaceholder boolean

Använd det här fältet för att initiera att parten är en platshållare. Obs! 1. värdet för parametern firstName, lastName och emailId måste vara tomt för den här parten. 2. Om du vill lägga till platshållaren måste en mottagare få behörigheten "PARTY_ASSIGNER".
Mottagarroll
 partyRole string

Använd det här fältet för att tilldela en roll som platshållare.
Tillåt namnändring
 allowNameChange string

Värdet kan vara antingen sant eller falskt Använd den här parametern för att tillåta att undertecknaren uppdaterar för- och efternamn innan signeringsprocessen slutförs.
Arbetsflödessekvens
 workflowSequence integer

Tilldela mottagaren ett arbetsflödessekvensnummer. När inloggningssekvensen är aktiverad får mottagarna sin signeringsinbjudan i stigande sekvensordning.
Värd-E-post-ID
 hostEmailId string

E-postadress till In-Person administratör.
Åtkomstkod
 userDefinedAccessCode string

Parametern innehåller Åtkomstkod när värdet "signerAuthLevel" anges som "Användardefinierad åtkomstkod" för autentisering. Obs! 1. Koder är inte skiftlägeskänsliga. 2. Systemet skickar inte den här koden så du måste dela den här koden direkt med undertecknaren. 3. Åtkomstkod kan innehålla alfabet, siffror och följande specialtecken: @,&,{,},%,(,),~,|,!,+,^.
Parten är e-postgrupp
 partyIsEmailGroup boolean

Använd den här parametern när du skapar en part som bulk. Observera: Om den här parametern är sann ignoreras firstName, lastName och emailId för den här parten.
E-postgrupp-ID
 emailGroupId integer

Skicka e-postmeddelandet till det grupp-ID som du vill använda för att skapa massutskick.
Massinloggning för enkel undertecknare
 allowSingleSignerInBulk boolean

Använd den här parametern om du bara vill tillåta att en person loggar in i e-postgruppen.
Uppringningskod
 dialingCode string

Använd det här fältet för att tilldela ett lands uppringningskoder är mobilnummerprefix till en mottagare i listan över mottagarparter.
Mobilnummer
 mobileNumber string

Använd det här fältet om du vill tilldela ett mobilnummer till en mottagare i listan över mottagarparter.
Fält
 Fields object
Skicka nu
 sendNow boolean

När det är aktiverat skickar Foxit eSign omedelbart en unik signeringslänk till varje mottagares e-postadress. Inaktivera detta om du vill spara kuvertet som ett utkast i stället.
Skapa inbäddad signeringssession
 createEmbeddedSigningSession True boolean

Signeringssessionstoken genereras utan att skicka ut e-postmeddelanden till mottagarna.
Skapa inbäddad signeringssession för alla parter
 createEmbeddedSigningSessionForAllParties boolean

Om värdet är true genereras en inbäddad signerings-URL för varje mottagare i kuvertet.
Bearbeta texttaggar
 processTextTags True boolean

Värdet kan vara antingen sant eller falskt. Det här fältet används för att avgöra om Foxit eSign ska parsa dokumenten för texttaggar för att konvertera dem till Foxit eSign-fält.
Bearbeta Acro-fält
 processAcroFields True boolean

Det här fältet används för att avgöra om Foxit eSign ska parsa dokumenten för AcroFields för att konvertera dem till Foxit eSign-fält.
Logga in sekvens
 signInSequence boolean

Det här fältet används för att avgöra om mottagarna kommer att signera kuvertdokumenten i en sekvens. Om det är falskt får alla mottagare e-postinbjudan samtidigt. När det är sant får varje mottagare e-postinbjudan successivt efter att den tidigare mottagaren har slutfört den nödvändiga uppgiften, till exempel signera dokument eller fylla i fält osv.
Aktivera personligen
 inPersonEnable boolean

Det här fältet används för att initiera den personliga signeringsprocessen som enkelt kan slutföras på valfri enhet på några minuter och undviker e-postbaserade signaturer där det behövs. Om det är falskt får alla mottagare e-postinbjudan samtidigt. När det är sant får administratören en inbjudan via e-post för att initiera signeringsprocessen för undertecknaren.
Åtgärda mottagarparter
 fixRecipientParties boolean

Om det är sant kan inte den inbäddade sändningsvyn ändra parterna för kuvertet som redan har lagts till som en del av den här begäran.
Åtgärda dokument
 fixDocuments boolean

Om det är sant kan inte den inbäddade sändningen ändra dokumenten för kuvertet som redan har lagts till som en del av den här begäran.
Skicka lyckad URL
 sendSuccessUrl string

Ange den absoluta URL:en för landningssidan, som undertecknaren omdirigeras till när mappen har skickats i den inbäddade sändningsvyn.
Skicka fel-URL
 sendErrorUrl string

Ange den absoluta URL:en för landningssidan, som undertecknaren omdirigeras till om felet uppstår när mappen skickas i den inbäddade sändningsvyn.
Skapa inbäddad sändningssession
 createEmbeddedSendingSession boolean

Om värdet är true genereras en inbäddad token för att öppna dokumentet som förbereder vyn för Foxit eSign.
E-post-ID för inbäddade undertecknare
 embeddedSignersEmailIds array of string

En matris med e-post-ID:t för mottagare för vilka en inbäddad signeringssession måste skapas. E-post-ID:t från mottagarparterna som lagts till i listan över parter.
Url för signeringsframgång
 signSuccessUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till när de har loggat in i den inbäddade signeringsvyn.
Url för nekande av tecken
 signDeclineUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om de avböjer att logga in i den inbäddade signeringsvyn.
Signera senare URL
 signLaterUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om de väljer att logga in senare i den inbäddade signeringsvyn.
Url för teckenfel
 signErrorUrl string

Ange den absoluta URL:en för de undertecknare som ska omdirigeras till om felet uppstår när dokumentet signeras i den inbäddade signeringsvyn.
Tillåt skicka nu och inbäddad signeringssession
 allowSendNowAndEmbeddedSigningSession boolean

Om värdet är sant skickar Foxit eSign en unik signeringslänk till varje mottagare. Detta gäller ENDAST när parametrarna sendNow och createEmbeddedSigningSession är sanna.
Avancerad e-postverifiering
 allowAdvancedEmailValidation boolean

Verifiera parternas e-postadress när den anges som true.
Sign Success URL Alla parter
 signSuccessUrlAllParties boolean

Om värdet är true omdirigeras undertecknaren till URL:en som anges i signSuccessUrl efter att signeringen har slutförts. Detta gäller endast när sendNow är sant.
E-postmalls-ID
 emailTemplateId integer

Skicka e-postmalls-ID:t för att skicka andra e-postmallar än standardmallar för e-post.
Signer-instruktions-ID
 signerInstructionId integer

Skicka instruktions-ID:t för att skicka andra inloggningsinstruktioner än standardanvisningarna för undertecknaren.
Bekräftelseinstruktions-ID
 confirmationInstructionId string

Skicka bekräftelseinstruktions-ID:t för att skicka andra bekräftelseinstruktioner än standardbekräftelseinstruktionerna.
Temafärg
 themeColor string

Ange CSS-värdet för att ange temafärgen.
Sessionen upphör att gälla
 sessionExpire boolean

Ange som true för att initiera förfallningen av den inbäddade signeringssessionen.
Upphörande
 expiry integer

Krävs om sessionExpire är sant. Ange varaktighet i millisekunder för förfallodatum för den inbäddade signeringssessionen.
Namn på beroende fält
 dependentFieldName True string

Namnet på det fält vars synlighet styrs av det överordnade fältet.
Namn på överordnat fält
 parentFieldName True string

Namnet på det överordnade fältet vars värde styr synligheten för det beroende fältet. Överordnade fälttyper som stöds: textfält, textruta, kryssruta, alternativknapp, listruta.
Överordnat fältvärde
 parentFieldValue True string

Värdet för det överordnade fältet som utlöser det beroende fältet så att det blir synligt. För kryssrutor och alternativknappfält använder du markerat eller avmarkerat.
Options
 options True string

Ytterligare matchningsalternativ för textbaserade överordnade fält. Godkända värden: isblank, allowNull, innehåller.
Metadata
 metadata object

Detta bör vara i nyckel/värde-par. Maximalt 1 000 nyckel/värde-par tillåts.
E-post för avsändare
 senderEmail string

ange e-post för en annan användare i ditt konto som ska användas för att skicka den här dokumentmappen till mottagarparterna.
Dölj knappen Lägg till mig
 hideAddMeButton boolean

Om det är sant döljs knappen "Lägg till mig" på mottagarparterna i en inbäddad sändningssession.
Dölj knappen Lägg till ny
 hideAddNewButton boolean

Om det är sant döljs knappen "Lägg till ny" på mottagarparter i en inbäddad sändningssession.
Dölj knappen Lägg till grupp
 hideAddGroupButton boolean

Om det är sant döljs knappen "Lägg till grupp" på mottagarparter i en inbäddad sändningssession.
Dölj fältnamn för mottagare
 hideFieldNameForRecipients boolean

Dölj fältnamn för mottagare för datainmatningsfält och avancerade fält. (Förutom alternativknappen, kryssrutan, bilden och hyperlänken).
Dölj kryssrutan kantlinje
 hideCheckboxBorder boolean

Kryssrutans kantlinjer döljs i de utförda dokumenten.
Dölj alternativet Välj undertecknare
 hideSignerSelectOption boolean

Om det är sant döljs indatarutan "Befintlig undertecknare/e-post" på mottagarparter i en inbäddad sändningssession.
Dölj undertecknaråtgärder
 hideSignerActions boolean

Om det är sant döljs undertecknarens åtgärder "redigera", "ändra" och "ta bort" på mottagarparter i en inbäddad sändningssession.
Dölj avsändarens namn
 hideSenderName boolean

Om det är sant döljs avsändarens namn på mottagarparterna i en inbäddad sändningssession.
Dölj mappnamn
 hideFolderName boolean

Om det är sant döljs mappnamnet i navigeringen i båda inbäddade sessioner.
Dölj dokumentnamn
 hideDocumentsName boolean

Om det är sant döljs dokumentnamnet i båda inbäddade sessioner.
Dölj neka att signera
 hideDeclineToSign boolean

Om det är sant döljs alternativet "Neka att signera" för undertecknaren.
Dölj mer åtgärd
 hideMoreAction boolean

Om sant döljs knappen "Fler åtgärder" i sändnings-/signeringssessionen. När det gäller "Skicka nu": sant döljer det ingenting.
Dölj knappen Skicka
 hideSendButton boolean

Om det är sant döljs knappen Skicka i den inbäddade sändningssessionen.
Dölj nästa obligatoriska fieldbtn
 hideNextRequiredFieldbtn boolean

Om värdet är true döljer du navigeringsknappen som flyttar undertecknarna till nästa obligatoriska fält.
Krävs både inbäddad session
 requiredBothEmbeddedSession boolean

Om det är sant genereras de inbäddade url:erna för sändning och signering tillsammans.
Kuvertlösenord
 folderPassword string

Det här lösenordet krävs av undertecknaren/författaren för att öppna det digitalt signerade dokumentet. Om parametern hålls tom krävs inget lösenord för att öppna det digitalt signerade dokumentet.
Aktivera steg för steg
 enableStepByStep boolean

Aktivera steg för steg-åtgärd i den inbäddade sändningssessionen.
Dölj alternativet Lägg till parter
 hideAddPartiesOption boolean

Om det är sant döljs alternativet för att lägga till parterna i läget Skapa utkast och mall.
Självsigna
 selfSign boolean

Den aktiverar inbäddade självsigner via API:er. Den här parametern gäller endast när parametern createEmbeddedSendingSession är true.
Url för lyckad självsignerare
 selfSignerSuccessUrl string

Ange den absoluta URL:en för landningssidan på din webbplats/ditt program, som användaren omdirigeras till efter att självsignering har skickat mappen i den inbäddade sändningsvyn.

Returer

Name Sökväg Typ Description
ID
 folder.folderId integer

Det unika ID:t för det nyligen skapade kuvertet. Använd detta i efterföljande åtgärder för att referera till det här kuvertet.
Name
 folder.folderName string

Namnet på det nyligen skapade kuvertet.
Anpassat namn
 folder.folderCustomName string

Ett anpassat namn på kuvertet.
Lösenord
 folder.folderPassword string

Åtkomstlösenordet för kuvertet, om det anges.
Skapar-ID
 folder.folderAuthorId integer

Den unika identifieraren för kuvertskaparen.
Skaparens förnamn
 folder.folderAuthorFirstName string

Kuvertskapares förnamn.
Skaparens efternamn
 folder.folderAuthorLastName string

Kuvertskaparens efternamn.
E-post för skapare
 folder.folderAuthorEmail string

Kuvertskaparens e-postadress.
Skaparroll
 folder.folderAuthorRole string

Rollen som kuvertskapare.
Företags-ID
 folder.folderCompanyId integer

Den unika identifieraren för det företag som äger kuvertet.
Skapelsedatum
 folder.folderCreationDate integer

Det datum då kuvertet skapades (Unix-tidsstämpel i millisekunder).
Skickat datum
 folder.folderSentDate integer

Det datum då kuvertet skickades (Unix-tidsstämpel i millisekunder).
Status
 folder.folderStatus string

Kuvertets aktuella status.
Anpassat fält 1
 folder.custom_field1 string

Det första anpassade metadatafältet för kuvertet.
Anpassat fält 2
 folder.custom_field2 string

Det andra anpassade metadatafältet för kuvertet.
Metadata
 folder.metadata string

Anpassade metadata som är associerade med kuvertet.
Dokument-ID
 folder.folderDocumentIds array of integer

Listan över dokument-ID:t som finns i kuvertet.
Documents
 folder.documentsList array of object

Listan över dokument i kuvertet.
Dokument-ID
 folder.documentsList.documentId integer

Dokumentets unika identifierare.
Kontrakts-ID
 folder.documentsList.contractId integer

Den unika identifieraren för kontraktet.
Företags-ID
 folder.documentsList.companyId integer

Företagets unika identifierare.
Skapad av
 folder.documentsList.contractCreatedBy integer

Användar-ID för den person som skapade kontraktet.
Skapad på
 folder.documentsList.contractCreatedOn string

Datum och tid då kontraktet skapades.
Kontraktstyp
 folder.documentsList.contractType string

Typ av kontrakt.
Kontraktsstatus
 folder.documentsList.contractStatus string

Kontraktets aktuella status.
Redigerbar
 folder.documentsList.editable boolean

Anger om objektet kan redigeras.
Versions-ID
 folder.documentsList.contractVersionId integer

Den unika identifieraren för kontraktsversionen.
Versionsnamn
 folder.documentsList.contractVersionName string

Namnet på kontraktsversionen.
Versionsbeskrivning
 folder.documentsList.contractVersionDesc string

En beskrivning av kontraktsversionen.
Version skapad av
 folder.documentsList.versionCreatedby integer

Användar-ID för den person som skapade den här versionen.
Version skapad på
 folder.documentsList.versionCreatedOn string

Datum och tid då den här versionen skapades.
Versionsnummer
 folder.documentsList.contractVersionNumber integer

Versionsnumret för kontraktet.
Transaktionskälla
 folder.documentsList.contractTransactionSource string

Källsystemet som initierade kontraktstransaktionen.
Mottagare
 folder.folderRecipientParties array of object

Listan över mottagarparter för detta kuvert.
Mottagarens ID
 folder.folderRecipientParties.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 folder.folderRecipientParties.partyDetails.partyId integer

Mottagarens unika identifierare.
Förnamn
 folder.folderRecipientParties.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 folder.folderRecipientParties.partyDetails.lastName string

Mottagarens efternamn.
E-postadress
 folder.folderRecipientParties.partyDetails.emailId string

Mottagarens e-postadress.
Platshållare
 folder.folderRecipientParties.partyDetails.placeholder boolean

Anger om den här parten är en platshållarmottagare.
Address
 folder.folderRecipientParties.partyDetails.address string

Mottagarens fysiska adress.
Skapelsedatum
 folder.folderRecipientParties.partyDetails.dateCreated integer

Datumet då posten skapades (Unix-tidsstämpel i millisekunder).
Avregistrera e-postmeddelanden
 folder.folderRecipientParties.partyDetails.optOutEmails boolean

Anger om mottagaren har valt bort e-postaviseringar.
Unikt mottagar-ID
 folder.folderRecipientParties.partyDetails.uniquePartyId string

En unik systemidentifierare för den här mottagaren.
Autentiseringsnivå
 folder.folderRecipientParties.partyDetails.authenticationLevel string

Den autentiseringsmetod som krävs för den här mottagaren.
Lösenord uppdaterat datum
 folder.folderRecipientParties.partyDetails.passwordUpdateDate string

Datumet då lösenordet senast uppdaterades.
Status för lösenord har uppdaterats
 folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

Anger om lösenordet har uppdaterats.
Företags-ID
 folder.folderRecipientParties.partyDetails.companyId integer

Företagets unika identifierare.
Användarroll
 folder.folderRecipientParties.partyDetails.userRole string

Rollen som tilldelats användaren.
Avdelning
 folder.folderRecipientParties.partyDetails.department string

Den avdelning som användaren tillhör.
Title
 folder.folderRecipientParties.partyDetails.title string

Användarens jobbrubrik.
Aktivt
 folder.folderRecipientParties.partyDetails.active boolean

Anger om användaren eller posten är aktiv.
Lokal
 folder.folderRecipientParties.partyDetails.requestLocale string

Språkinställningen för användaren.
Dela med Dept
 folder.folderRecipientParties.partyDetails.share_among_department boolean

Anger om kuvert delas över hela avdelningen.
Uppringningskod
 folder.folderRecipientParties.partyDetails.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.folderRecipientParties.partyDetails.mobileNumber string

Mobiltelefonnumret.
Statusfilter
 folder.folderRecipientParties.partyDetails.docStatusFilter string

Ett filter för dokumentstatus.
Datumfilter
 folder.folderRecipientParties.partyDetails.docDateFilter string

Ett filter för dokumentdatum.
Säker fältåtkomst
 folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

Anger om användaren har åtkomst till säkra fält.
Expandera sidopanelen
 folder.folderRecipientParties.partyDetails.expandSidebar boolean

Anger om sidofältet expanderas som standard.
Adv. E-postverifiering
 folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

Anger om avancerad e-postverifiering är aktiverad.
Chefs-ID
 folder.folderRecipientParties.partyDetails.managerId string

Den unika identifieraren för användarens chef.
Antal inloggningar
 folder.folderRecipientParties.partyDetails.loginCount integer

Antalet gånger användaren har loggat in.
E-post för lösenordsåterställning
 folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

Anger om ett e-postmeddelande för lösenordsåterställning ska skickas.
Avdelnings-ID
 folder.folderRecipientParties.partyDetails.departmentId string

Den unika identifieraren för avdelningen.
Primärt företag
 folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

Det primära företaget som är associerat med användaren.
Enhetstyp
 folder.folderRecipientParties.partyDetails.deviceType string

Vilken typ av enhet som används.
Enhetstoken
 folder.folderRecipientParties.partyDetails.deviceToken string

Push-meddelandetoken för enheten.
Beskrivning av underleverantör
 folder.folderRecipientParties.partyDetails.subcontractorDescription string

En beskrivning av underleverantören eller den externa undertecknaren.
Underleverantörsorganisation
 folder.folderRecipientParties.partyDetails.subcontractorOrganization string

Underleverantörens eller den externa undertecknarens organisationsnamn.
Underleverantör har lagts till
 folder.folderRecipientParties.partyDetails.subcAddedDate integer

Det datum då underleverantören lades till (Unix-tidsstämpel i millisekunder).
Källa
 folder.folderRecipientParties.partyDetails.source string

Källsystemet som den externa undertecknaren lades till från.
Uppringningskod
 folder.folderRecipientParties.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.folderRecipientParties.mobileNumber string

Mobiltelefonnumret.
Signaturtyp
 folder.folderRecipientParties.signerSignatureType string

Den typ av signatur som undertecknaren ska använda.
Permissions
 folder.folderRecipientParties.contractPermissions string

De behörigheter som beviljats den här parten för kontraktet.
Signeringsorder
 folder.folderRecipientParties.partySequence integer

Sekvensnumret för signeringsordningen för den här mottagaren.
Arbetsflödessekvens
 folder.folderRecipientParties.workflowSignSequence integer

Sekvensnumret för arbetsflödessignering.
Kuvert-ID
 folder.folderRecipientParties.envelopeId integer

Kuvertets unika identifierare.
Mottagarens företags-ID
 folder.folderRecipientParties.partyCompanyId integer

Den unika identifieraren för det företag som är associerat med den här mottagaren.
Delningsläge
 folder.folderRecipientParties.sharingMode string

Delningsläget för det här kuvertet.
URL för mottagaråtkomst
 folder.folderRecipientParties.folderAccessURL string

Den URL som mottagaren kan använda för att komma åt och signera kuvertet.
Säkerhetsläge
 folder.folderRecipientParties.securityMode string

Säkerhetsläget som tillämpas på det här kuvertet.
Comments
 folder.folderRecipientParties.extraComments string

Ytterligare kommentarer som ingår i kuvertet.
Tillåt namnändring
 folder.folderRecipientParties.allowNameChange boolean

Anger om mottagaren får uppdatera sitt namn.
Namn uppdaterat
 folder.folderRecipientParties.signerNameUpdated boolean

Anger om undertecknaren har uppdaterat sitt namn.
Autentiseringsnivå för undertecknare
 folder.folderRecipientParties.signerAuthenticationLevel string

Den autentiseringsnivå som krävs för undertecknaren.
Åtkomstkod
 folder.folderRecipientParties.userDefinedAccessCode string

En anpassad åtkomstkod som definierats för undertecknaren.
Signaturidentitet
 folder.folderRecipientParties.signatureId string

Den unika identifieraren för signaturen.
Mottagarroll
 folder.folderRecipientParties.partyRole string

Rollen som tilldelats den här mottagaren i signeringsarbetsflödet.
Företagsfält
 folder.folderRecipientParties.companyFieldValue string

Värdet för fältet företagsnamn i signaturen.
Rubrikfält
 folder.folderRecipientParties.titleFieldValue string

Värdet för rubrikfältet i signaturen.
Orsak till signering
 folder.folderRecipientParties.reasonSigning string

Anledningen till att mottagaren signerar dokumentet.
Betalningsfält har lagts till
 folder.folderRecipientParties.payFieldAdded boolean

Anger om ett betalningsfält har lagts till.
Betalningsmottagare
 folder.folderRecipientParties.payee boolean

Anger om mottagaren är betalningsmottagaren.
Återkommande betalning
 folder.folderRecipientParties.recurringFieldExist boolean

Anger om det finns ett återkommande betalningsfält.
Skriv ut och signera klar
 folder.folderRecipientParties.printAndSignCompleted boolean

Anger om utskrifts- och signeringsprocessen är klar.
Paid
 folder.folderRecipientParties.paid boolean

Anger om betalningen har slutförts.
Valfri undertecknare tillåts
 folder.folderRecipientParties.allowOptionalSigner boolean

Anger om mottagaren är en valfri undertecknare.
Valfria undertecknare
 folder.folderRecipientParties.optionalSigners array of integer

Listan över valfria signeringspart-ID:er för det här kuvertet.
Url för redigeringssignering
 folder.folderAccessURLForAuthor string

Den URL som avsändaren kan använda för att komma åt kuvertet.
URL för utkaståtkomst
 folder.draftFolderAccessURL string

Url:en som används för att komma åt utkastversionen av kuvertet.
Signering av styrelserum
 folder.boardRoomSign boolean

Anger om brädrummets signeringsläge är aktiverat.
Inkludera logotyp
 folder.includeLogo boolean

Anger om företagslogotypen ingår i e-postmeddelanden.
Bakgrundsfärg för knapp
 folder.email_btnBgColor string

Bakgrundsfärgen för e-postknappen.
Knapptextfärg
 folder.email_btnTxtColor string

Textfärgen på e-postknappen.
E-postlogotyp
 folder.emailTemplateLogo string

Logotyp-URL:en som används i e-postmallen.
E-postmalls-ID
 folder.emailTemplateId integer

Den unika identifieraren för e-postmallen.
E-postrubrik
 folder.emailHeader string

Rubriktexten som används i e-postaviseringar.
E-postfot
 folder.emailFooter string

Sidfotstexten som används i e-postaviseringar.
Rensa schemalagd
 folder.purgeFlag boolean

Anger om kuvertet är schemalagt för rensning.
Rensa startdatum
 folder.purgeStartDate string

Det datum då rensningen är schemalagd att börja.
Rensa slutdatum
 folder.purgeEndDate string

Det datum då rensningen är schemalagd att slutföras.
Massutskicks-ID
 folder.bulkId integer

Den unika identifieraren för masssändningsåtgärden.
Framtvinga signeringsorder
 folder.enforceSignWorkflow boolean

Anger om mottagarna måste logga in i den definierade sekvensen.
Aktuellt steg
 folder.currentWorkflowStep integer

Det aktuella steget i signeringsarbetsflödet.
Transaktionskälla
 folder.transactionSource string

Källsystemet som initierade den här transaktionen.
Redigerbar
 folder.editable boolean

Anger om objektet kan redigeras.
In-Person signering
 folder.inPersonSignable boolean

Anger om kuvertet kan loggas in personligen.
Åsidosätt påminnelser
 folder.overrideAccountReminders boolean

Anger om inställningarna för påminnelser på kontonivå är åsidosatta.
Åsidosätt delegering
 folder.overrideAccountRecipientDelegation boolean

Anger om delegeringsinställningarna på kontonivå är åsidosatta.
Tillåt delegering
 folder.allowRecipientsToDelegate boolean

Anger om mottagare får delegera signering.
ID
 folder.envelopeId integer

Kuvertets unika identifierare.
Name
 folder.envelopeName string

Kuvertets namn.
Ursprungs-ID
 folder.envelopeOriginatorId integer

Den unika identifieraren för den användare som skapade kuvertet.
Företags-ID
 folder.envelopeCompanyId integer

Den unika identifieraren för det företag som äger kuvertet.
Date
 folder.envelopeDate integer

Det datum då kuvertet skapades (Unix-tidsstämpel i millisekunder).
Delat datum
 folder.envelopeSharedDate integer

Det datum då kuvertet delades (Unix-tidsstämpel i millisekunder).
Status
 folder.envelopeStatus string

Kuvertets aktuella status.
Kontrakts-ID:t
 folder.envelopeContractIds array of integer

Listan över kontrakt-ID:t som är associerade med det här kuvertet.
Mottagarbehörigheter
 folder.envelopePartyPermissions array of object

Listan över mottagarbehörigheter för det här kuvertet.
Mottagarens ID
 folder.envelopePartyPermissions.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 folder.envelopePartyPermissions.partyDetails.partyId integer

Mottagarens unika identifierare.
Förnamn
 folder.envelopePartyPermissions.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 folder.envelopePartyPermissions.partyDetails.lastName string

Mottagarens efternamn.
E-postadress
 folder.envelopePartyPermissions.partyDetails.emailId string

Mottagarens e-postadress.
Platshållare
 folder.envelopePartyPermissions.partyDetails.placeholder boolean

Anger om den här parten är en platshållarmottagare.
Address
 folder.envelopePartyPermissions.partyDetails.address string

Mottagarens fysiska adress.
Skapelsedatum
 folder.envelopePartyPermissions.partyDetails.dateCreated integer

Datumet då posten skapades (Unix-tidsstämpel i millisekunder).
Avregistrera e-postmeddelanden
 folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

Anger om mottagaren har valt bort e-postaviseringar.
Unikt mottagar-ID
 folder.envelopePartyPermissions.partyDetails.uniquePartyId string

En unik systemidentifierare för den här mottagaren.
Autentiseringsnivå
 folder.envelopePartyPermissions.partyDetails.authenticationLevel string

Den autentiseringsmetod som krävs för den här mottagaren.
Lösenord uppdaterat datum
 folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

Datumet då lösenordet senast uppdaterades.
Status för lösenord har uppdaterats
 folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

Anger om lösenordet har uppdaterats.
Företags-ID
 folder.envelopePartyPermissions.partyDetails.companyId integer

Företagets unika identifierare.
Användarroll
 folder.envelopePartyPermissions.partyDetails.userRole string

Rollen som tilldelats användaren.
Avdelning
 folder.envelopePartyPermissions.partyDetails.department string

Den avdelning som användaren tillhör.
Title
 folder.envelopePartyPermissions.partyDetails.title string

Användarens jobbrubrik.
Aktivt
 folder.envelopePartyPermissions.partyDetails.active boolean

Anger om användaren eller posten är aktiv.
Lokal
 folder.envelopePartyPermissions.partyDetails.requestLocale string

Språkinställningen för användaren.
Dela med Dept
 folder.envelopePartyPermissions.partyDetails.share_among_department boolean

Anger om kuvert delas över hela avdelningen.
Uppringningskod
 folder.envelopePartyPermissions.partyDetails.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.envelopePartyPermissions.partyDetails.mobileNumber string

Mobiltelefonnumret.
Statusfilter
 folder.envelopePartyPermissions.partyDetails.docStatusFilter string

Ett filter för dokumentstatus.
Datumfilter
 folder.envelopePartyPermissions.partyDetails.docDateFilter string

Ett filter för dokumentdatum.
Säker fältåtkomst
 folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

Anger om användaren har åtkomst till säkra fält.
Expandera sidopanelen
 folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

Anger om sidofältet expanderas som standard.
Adv. E-postverifiering
 folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

Anger om avancerad e-postverifiering är aktiverad.
Chefs-ID
 folder.envelopePartyPermissions.partyDetails.managerId string

Den unika identifieraren för användarens chef.
Antal inloggningar
 folder.envelopePartyPermissions.partyDetails.loginCount integer

Antalet gånger användaren har loggat in.
E-post för lösenordsåterställning
 folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

Anger om ett e-postmeddelande för lösenordsåterställning ska skickas.
Avdelnings-ID
 folder.envelopePartyPermissions.partyDetails.departmentId string

Den unika identifieraren för avdelningen.
Primärt företag
 folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

Det primära företaget som är associerat med användaren.
Enhetstyp
 folder.envelopePartyPermissions.partyDetails.deviceType string

Vilken typ av enhet som används.
Enhetstoken
 folder.envelopePartyPermissions.partyDetails.deviceToken string

Push-meddelandetoken för enheten.
Beskrivning av underleverantör
 folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

En beskrivning av underleverantören eller den externa undertecknaren.
Underleverantörsorganisation
 folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

Underleverantörens eller den externa undertecknarens organisationsnamn.
Underleverantör har lagts till
 folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

Det datum då underleverantören lades till (Unix-tidsstämpel i millisekunder).
Källa
 folder.envelopePartyPermissions.partyDetails.source string

Källsystemet som den externa undertecknaren lades till från.
Uppringningskod
 folder.envelopePartyPermissions.dialingCode string

Den internationella uppringningskoden för telefonnumret.
Mobilnummer
 folder.envelopePartyPermissions.mobileNumber string

Mobiltelefonnumret.
Signaturtyp
 folder.envelopePartyPermissions.signerSignatureType string

Den typ av signatur som undertecknaren ska använda.
Permissions
 folder.envelopePartyPermissions.contractPermissions string

De behörigheter som beviljats den här parten för kontraktet.
Signeringsorder
 folder.envelopePartyPermissions.partySequence integer

Sekvensnumret för signeringsordningen för den här mottagaren.
Arbetsflödessekvens
 folder.envelopePartyPermissions.workflowSignSequence integer

Sekvensnumret för arbetsflödessignering.
Kuvert-ID
 folder.envelopePartyPermissions.envelopeId integer

Kuvertets unika identifierare.
Mottagarens företags-ID
 folder.envelopePartyPermissions.partyCompanyId integer

Den unika identifieraren för det företag som är associerat med den här mottagaren.
Delningsläge
 folder.envelopePartyPermissions.sharingMode string

Delningsläget för det här kuvertet.
URL för mottagaråtkomst
 folder.envelopePartyPermissions.folderAccessURL string

Den URL som mottagaren kan använda för att komma åt och signera kuvertet.
Säkerhetsläge
 folder.envelopePartyPermissions.securityMode string

Säkerhetsläget som tillämpas på det här kuvertet.
Comments
 folder.envelopePartyPermissions.extraComments string

Ytterligare kommentarer som ingår i kuvertet.
Tillåt namnändring
 folder.envelopePartyPermissions.allowNameChange boolean

Anger om mottagaren får uppdatera sitt namn.
Namn uppdaterat
 folder.envelopePartyPermissions.signerNameUpdated boolean

Anger om undertecknaren har uppdaterat sitt namn.
Autentiseringsnivå för undertecknare
 folder.envelopePartyPermissions.signerAuthenticationLevel string

Den autentiseringsnivå som krävs för undertecknaren.
Åtkomstkod
 folder.envelopePartyPermissions.userDefinedAccessCode string

En anpassad åtkomstkod som definierats för undertecknaren.
Signaturidentitet
 folder.envelopePartyPermissions.signatureId string

Den unika identifieraren för signaturen.
Mottagarroll
 folder.envelopePartyPermissions.partyRole string

Rollen som tilldelats den här mottagaren i signeringsarbetsflödet.
Företagsfält
 folder.envelopePartyPermissions.companyFieldValue string

Värdet för fältet företagsnamn i signaturen.
Rubrikfält
 folder.envelopePartyPermissions.titleFieldValue string

Värdet för rubrikfältet i signaturen.
Orsak till signering
 folder.envelopePartyPermissions.reasonSigning string

Anledningen till att mottagaren signerar dokumentet.
Betalningsfält har lagts till
 folder.envelopePartyPermissions.payFieldAdded boolean

Anger om ett betalningsfält har lagts till.
Betalningsmottagare
 folder.envelopePartyPermissions.payee boolean

Anger om mottagaren är betalningsmottagaren.
Återkommande betalning
 folder.envelopePartyPermissions.recurringFieldExist boolean

Anger om det finns ett återkommande betalningsfält.
Skriv ut och signera klar
 folder.envelopePartyPermissions.printAndSignCompleted boolean

Anger om utskrifts- och signeringsprocessen är klar.
Paid
 folder.envelopePartyPermissions.paid boolean

Anger om betalningen har slutförts.
Autentiseringsnivå
 folder.envelopeAuthenticationLevel string

Den autentiseringsnivå som krävs för kuvertet.
Massinloggning för enkel undertecknare
 folder.allowSingleSignerInBulk boolean

Anger om en enkel undertecknare tillåts i massutskicksläge.
File-Based namngivning
 folder.folderNameBasedOnFileNaming boolean

Anger om mappnamnet baseras på filnamnet.
Doc File-Based Name
 folder.documentNameBasedOnFileNaming boolean

Anger om dokumentnamnet baseras på filnamnet.
Certifikat File-Based namn
 folder.certificateNameBasedOnFileNaming boolean

Anger om certifikatnamnet baseras på filnamnet.
Pre-Exec-filnamngivning
 folder.enableFileNamingBeforeExecution boolean

Anger om filnamngivning är aktiverat före dokumentkörning.
Betalningsmottagaren har lagts till
 folder.payeeAddedd boolean

Anger om en betalningsmottagare har lagts till.
Self-Signing aktiverat
 folder.selfSignerEnabled boolean

Anger om självsigneringsläget är aktiverat.
Notarie aktiverad
 folder.notaryEnabled boolean

Anger om notariesignering är aktiverat.
Begränsad synlighet
 folder.limitedVisibilityFlag boolean

Anger om begränsad synlighet är aktiverat för det här kuvertet.
Synlighet efter tecken
 folder.postSigningVisibility boolean

Anger om synligheten efter signering är aktiverad.
Våt signatur
 folder.wetSignatureEnabled boolean

Anger om våta signaturer är aktiverade.
Sammanslagning aktiverat
 folder.mergeEnabled boolean

Anger om dokumentsammanslagningen är aktiverad.
Inbäddade signeringssessioner
 embeddedSigningSessions array of object

Listan över inbäddade signeringssessioner, en per mottagare. Endast när createEmbeddedSigningSession är sant.
E-post för undertecknare
 embeddedSigningSessions.emailIdOfSigner string

E-postadressen till mottagaren för den här inbäddade signeringssessionen.
Signeringstoken
 embeddedSigningSessions.embeddedToken string

Den unika token för den här mottagarens inbäddade signeringssession.
URL för signeringssession
 embeddedSigningSessions.embeddedSessionURL string

Url:en som ska öppnas eller bäddas in för den här mottagaren för att signera dokumentet.
Inbäddad sändningstoken
 embeddedToken string

Token för den inbäddade sändningssessionen. Endast när createEmbeddedSendingSession är sant.
Skicka sessions-URL
 embeddedSessionURL string

Url:en som ska öppnas eller bäddas in för kuvertförfattaren för att förbereda och skicka kuvertet. Endast när createEmbeddedSendingSession är sant.
Result
 result string

Resultatet av operationen.
Message
 message string

Ett meddelande som beskriver resultatet av åtgärden.

Skapa mall från Base64

Åtgärds-ID:
CreateTemplatefromBase64

Skapar en ny mall med en Base64-kodad PDF-sträng. Använd detta när PDF-filen redan är tillgänglig som en Base64-sträng i flödet, till exempel från en SharePoint fil eller OneDrive dokument.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mallnamn
 templateName True string

Namnet på mallen. Måste avslutas med tillägget .pdf (t.ex. onboarding.pdf).
Base64-filsträng
 base64FileString True string

BASE64-sträng i en PDF-fil för att skapa mallen. Den bör vara offentligt tillgänglig när du skapar mallen.
Indatatyp
 inputType True string

Indatametoden för dokumentet. Ställ alltid in på "base64" för den här åtgärden.
Bearbeta texttaggar
 processTextTags True boolean

När det är aktiverat genomsöker Foxit eSign dokumentet efter texttaggar och konverterar dem automatiskt till signaturfält.
Bearbeta Acro-fält
 processAcroFields True boolean

När det är aktiverat genomsöker Foxit eSign dokumentet efter AcroFields och konverterar dem automatiskt till signaturfält.
Dela alla
 shareAll True boolean

Dela den här mallen med alla användare i ditt konto.
Antal parter
 numberOfParties True integer

Antalet mottagarparter för den här mallen. Måste vara mindre än 20.
Temafärg
 themeColor string

Ett CSS-färgvärde för att anpassa temat för den inbäddade mallsessionen (t.ex. #42caf4).
E-postförfattare
 authorEmail string

E-postadressen till en annan användare i kontot som ska anges som skapare av den här mallen.
Skapa inbäddad mallsession
 createEmbeddedTemplateSession boolean

Om värdet är true skapas en inbäddad mallsession så att du kan öppna Foxit eSign-mallredigeraren direkt och dra och släppa fält till mallen.
Omdirigerings-URL
 redirectURL string

Om Skapa inbäddad mallsession är sant omdirigerar du användaren till url:en när användaren har klickat på Spara och stäng i den inbäddade mallredigeraren.
Dölj skicka mall
 hideSendTemplate boolean

Om det är sant är knappen Skicka dold i den inbäddade mallredigeraren.
Åtgärda mottagarparter
 fixRecipientParties boolean

Om det är sant kan de mottagarparter som redan har lagts till inte ändras i den inbäddade mallredigeraren.
Fält
 Fields object
permissions
 permission True string
Sekvens
 sequence True integer

Ett unikt sekvensnummer för den här parten från och med 1. Definierar signeringsordningen när inloggningssekvensen är aktiverad.
Mottagarroll
 partyRole True string

Rollen som tilldelats den här parten i mallen.
Dölj mer åtgärd
 hideMoreAction boolean

Om det är sant döljs knappen Fler åtgärder i den inbäddade mallsessionen.
Dölj resurs med alla
 hideShareWithAll boolean

Om det är sant döljs alternativet Dela med alla i den inbäddade mallsessionen.
Dölj lägg till part
 hideAddParty boolean

Om det är sant döljs alla alternativ för att lägga till part i den inbäddade mallsessionen.
Dölj mig-knappen
 hideMeButton boolean

Om det är sant döljs knappen Jag på mottagarparter i den inbäddade mallsessionen.
Dölj knappen Andra
 hideOthersButton boolean

Om det är sant döljs knappen Andra på mottagarparter i den inbäddade mallsessionen.
Dölj fältnamn för mottagare
 hideFieldNameForRecipients boolean

Om sant döljs fältnamn från mottagare för datainmatning och avancerade fält.
Dölj kryssrutan kantlinje
 hideCheckboxBorder boolean

Om det är sant döljs kryssrutorna i de dokument som körs.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om åtgärden lyckades (t.ex. "lyckades").
Message
 message string

En beskrivning av åtgärdsresultatet.
ID
 template.templateId integer

Det unika ID:t för den skapade mallen. Använd det här alternativet om du vill skapa kuvert från den här mallen.
Name
 template.templateName string

Namnet på mallen.
Description
 template.templateDesc string

En beskrivning av mallen.
Type
 template.templateType string

Mallens typ.
Skapandedatum
 template.templateCreationDate string

Det datum då mallen skapades.
Senast uppdaterat datum
 template.templateLastUpdateDate string

Datumet då mallen senast uppdaterades.
Redigerbar
 template.editable boolean

Anger om mallen kan redigeras.
Antal parter
 template.numberOfParties integer

Antalet mottagarparter som definierats i mallen.
Totalt antal sidor
 template.totalPages integer

Det totala antalet sidor i malldokumentet.
Företags-ID
 template.companyId integer

ID:t för det företag som mallen tillhör.
Delas med alla
 template.shareAll boolean

Anger om den här mallen delas med alla användare i kontot.
Partbehörigheter
 template.templatePartyPermissions array of object

Listan över mottagarroller och deras behörigheter som definierats i den här mallen.
Part-ID
 template.templatePartyPermissions.template_party_id integer

Det unika ID:t för den här mallpartposten.
ID
 template.templatePartyPermissions.templateId integer

ID:t för mallen som den här parten tillhör.
Permissions
 template.templatePartyPermissions.templatePermissions string

Signeringsbehörigheterna för den här parten (t.ex. FILL_FIELDS_AND_SIGN).
Signeringsorder
 template.templatePartyPermissions.partySequence integer

Signeringsorderpositionen för den här parten.
Partroll
 template.templatePartyPermissions.templatePartyRole string

Det rollnamn som tilldelats den här parten i mallen. Använd detta när du skapar ett kuvert från mallen.
Användar-ID
 template.templateCreatedBy.partyId integer

Användarens unika ID.
Förnamn
 template.templateCreatedBy.firstName string

Användarens förnamn.
Efternamn
 template.templateCreatedBy.lastName string

Användarens efternamn.
E-postmeddelande
 template.templateCreatedBy.emailId string

Användarens e-postadress.
Mallfält
 allfields array of object

Listan över alla signatur- och formulärfält som definierats i mallen.
Fält-ID
 allfields.fieldTagId integer

Fältets unika identifierare.
Mall-id
 allfields.templateId integer

ID:t för mallen som det här fältet tillhör.
Företags-ID
 allfields.companyId integer

Företagskontot som det här fältet tillhör.
Fälttyp
 allfields.fieldType string

Typ av fält (t.ex. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Sidnummer
 allfields.documentPageNumber integer

Sidnumret för dokumentet där det här fältet är placerat.
Ansvarig part
 allfields.partyResponsible integer

Det partisekvensnummer som ansvarar för att fylla i det här fältet.
Partsekvens
 allfields.partyResponsibleSequence integer

Den ansvariga partens sekvensposition.
Fältdokument-ID
 allfields.docFieldId string

Identifieraren på dokumentnivå för det här fältet.
Är beroende
 allfields.dependent boolean

Anger om det här fältets synlighet beror på ett annat fälts värde.
Tabbordning
 allfields.tabOrder integer

Tabbordningen för navigering mellan fält.
Obligatoriskt
 allfields.required boolean

Anger om det här fältet måste fyllas i innan dokumentet kan signeras.
Namn på anpassat fält
 allfields.customFieldName string

Ett anpassat namn som tilldelats det här fältet.
Dela alla
 allfields.shareAll boolean

Anger om det här fältet delas med alla användare.
Tillåt redigering
 allfields.allowEdit boolean

Anger om det här fältet kan redigeras av mottagaren.
Namn på textfält
 allfields.textfieldName string

Etiketten för textfältet (gäller när fieldType är "textfält").
Value
 allfields.value string

Det förfyllda eller angivna värdet för fältet.
Fontstorlek
 allfields.fontSize integer

Teckenstorleken som används för text i det här fältet.
Teckenfärg
 allfields.fontColor string

Teckenfärgen som används för text i det här fältet (t.ex. #0000000).
Skrivskyddad
 allfields.readOnly boolean

Anger om fältet är skrivskyddat och inte kan redigeras av mottagaren.
Flera linjer
 allfields.multiLine boolean

Anger om textfältet accepterar flera indatarader (gäller när fieldType är "textfält").
Teckengräns
 allfields.characterLimit integer

Det maximala antalet tecken som tillåts i fältet (gäller när fieldType är "textfält").
Namn på datumfält
 allfields.datefieldName string

Etiketten för datumfältet (gäller när fieldType är "datefield").
Datumformat
 allfields.dateFormat string

Datumformatet som används av det här fältet (t.ex. MM/DD/ÅÅÅÅ) (gäller när fieldType är "datefield").
Kryssrutenamn
 allfields.cbname string

Kryssrutans etikett (gäller när fieldType är "kryssrutefält").
Kryssrutegrupp
 allfields.cbgroup string

Gruppnamnet för den här kryssrutan (gäller när fieldType är "kryssrutefält").
Kontrollerad
 allfields.checked boolean

Anger om kryssrutan är markerad som standard (gäller när fieldType är "kryssrutefält").
Namn på skyddat fält
 allfields.securedfieldName string

Etiketten för det skyddade fältet (gäller när fieldType är "securedfield").
Tecken som ska visas
 allfields.charToDisplay integer

Antalet omaskerade tecken som ska visas i slutet av ett skyddat fältvärde (gäller när fieldType är "securedfield").
Signaturidentitet
 allfields.signatureId string

ID:t för signaturen som tillämpas på det här teckenfältet (gäller när fieldType är "signfield").
Initial bild
 allfields.initialImage string

Bilddata för initialerna som tillämpas på det här fältet (gäller när fieldType är "initialfield").
Fältnamn för bifogad fil
 allfields.attachmentfieldName string

Namnet på det bifogade fältet (gäller när fieldType är "attachmentfield").
Beskrivning av bifogad fil
 allfields.attachmentfieldDescription string

En beskrivning av vad som ska bifogas (gäller när fieldType är "attachmentfield").

Skapa mall från URL

Åtgärds-ID:
CreateTemplatefromURL

Skapar en ny mall med en offentligt tillgänglig PDF-URL.

Parametrar

Name Nyckel Obligatorisk Typ Description
Mallnamn
 templateName True string

Namnet på mallen. Måste avslutas med tillägget .pdf (t.ex. onboarding.pdf).
Mall-URL
 templateUrl True string

Den offentligt tillgängliga URL:en för PDF-dokumentet som ska användas som mall.
Indatatyp
 inputType True string

Indatametoden för dokumentet. Ange alltid url för den här åtgärden.
Bearbeta texttaggar
 processTextTags True boolean

När det är aktiverat genomsöker Foxit eSign dokumentet efter texttaggar och konverterar dem automatiskt till signaturfält.
Bearbeta Acro-fält
 processAcroFields True boolean

När det är aktiverat genomsöker Foxit eSign dokumentet efter AcroFields och konverterar dem automatiskt till signaturfält.
Dela alla
 shareAll True boolean

Dela den här mallen med alla användare i ditt konto.
Antal parter
 numberOfParties True integer

Lägg till antal parter i mallen. Värdena för den här parametern ska vara mindre än 20.
Temafärg
 themeColor string

Ange ett css-värde för en färg för att ändra temat createEmbeddedTemplateSession .
E-postförfattare
 authorEmail string

Ange e-post för en annan användare i ett konto som ska användas som författare för den här mallen.
Skapa inbäddad mallsession
 createEmbeddedTemplateSession boolean

Om det anges som sant öppnar en inbäddad mallsession direkt vyn för förberedelsevyn för Foxit eSign-mallen. Du kan dra och släppa olika fält i mallen.
Omdirigerings-URL
 redirectURL string

Om createEmbeddedTemplateSession är sant kan den absoluta URL:en anges för landningssidan på alla webbplatser/program, som användaren omdirigeras till efter att ha klickat på "spara och stänga" i den inbäddade mallvyn.
Dölj skicka mall
 hideSendTemplate boolean

Om det är sant döljs knappen Skicka i en inbäddad mallvy.
Åtgärda mottagarparter
 fixRecipientParties boolean

Om det är sant kan du inte ändra parterna för kuvertet som redan har lagts till i den inbäddade mallvyn.
Fält
 Fields object
permissions
 permission True string
Sekvens
 sequence True integer

Ett unikt sekvensnummer för den här parten från och med 1. Definierar signeringsordningen när inloggningssekvensen är aktiverad.
Mottagarroll
 partyRole True string

Rollen som tilldelats den här parten i mallen.
Dölj mer åtgärd
 hideMoreAction boolean

Om det är sant döljs knappen Fler åtgärder i mallsessionen.
Dölj resurs med alla
 hideShareWithAll boolean

Om det är sant döljs alternativet "Dela med alla" i mallsessionen.
Dölj lägg till part
 hideAddParty boolean

Om det är sant döljs alla alternativ för lägg till part i en inbäddad mallsession.
Dölj mig-knappen
 hideMeButton boolean

Om det är sant döljs knappen "Jag" på mottagarparterna i en inbäddad mallsession.
Dölj knappen Andra
 hideOthersButton boolean

Om det är sant döljs knappen "Andra" på mottagarparterna i en inbäddad mallsession.
Dölj alternativet Välj befintlig kontakt
 hideExistingContactSelectOption boolean

Om det är sant döljs indatarutan "Hitta och lägg till befintlig kontakt" på mottagarparter i en inbäddad mallsession.
Dölj fältnamn för mottagare
 hideFieldNameForRecipients boolean

Dölj fältnamn för mottagare för datainmatningsfält och avancerade fält. (Förutom alternativknappen, kryssrutan, bilden och hyperlänken).
Dölj kryssrutan kantlinje
 hideCheckboxBorder boolean

Kryssrutans kantlinjer döljs i de utförda dokumenten.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om åtgärden lyckades (t.ex. "lyckades").
Message
 message string

En beskrivning av åtgärdsresultatet.
ID
 template.templateId integer

Det unika ID:t för den skapade mallen. Använd det här alternativet om du vill skapa kuvert från den här mallen.
Name
 template.templateName string

Namnet på mallen.
Description
 template.templateDesc string

En beskrivning av mallen.
Type
 template.templateType string

Mallens typ.
Skapandedatum
 template.templateCreationDate string

Det datum då mallen skapades.
Senast uppdaterat datum
 template.templateLastUpdateDate string

Datumet då mallen senast uppdaterades.
Redigerbar
 template.editable boolean

Anger om mallen kan redigeras.
Antal parter
 template.numberOfParties integer

Antalet mottagarparter som definierats i mallen.
Totalt antal sidor
 template.totalPages integer

Det totala antalet sidor i malldokumentet.
Företags-ID
 template.companyId integer

ID:t för det företag som mallen tillhör.
Delas med alla
 template.shareAll boolean

Anger om den här mallen delas med alla användare i kontot.
Mönster för anpassat namn
 template.templateCustomName string

Det anpassade namnmönstret som tillämpas på kuvert som skapats från den här mallen.
Partbehörigheter
 template.templatePartyPermissions array of object

Listan över mottagarroller och deras behörigheter som definierats i den här mallen.
Part-ID
 template.templatePartyPermissions.template_party_id integer

Det unika ID:t för den här mallpartposten.
ID
 template.templatePartyPermissions.templateId integer

ID:t för mallen som den här parten tillhör.
Permissions
 template.templatePartyPermissions.templatePermissions string

Signeringsbehörigheterna för den här parten (t.ex. FILL_FIELDS_AND_SIGN).
Signeringsorder
 template.templatePartyPermissions.partySequence integer

Signeringsorderpositionen för den här parten.
Partroll
 template.templatePartyPermissions.templatePartyRole string

Det rollnamn som tilldelats den här parten i mallen. Använd detta när du skapar ett kuvert från mallen.
Part-ID
 template.templatePartyPermissions.partyId integer

ID:t för den part som tilldelats den här rollen, om det är förtilldelat.
Användar-ID
 template.templateCreatedBy.partyId integer

Användarens unika ID.
Förnamn
 template.templateCreatedBy.firstName string

Användarens förnamn.
Efternamn
 template.templateCreatedBy.lastName string

Användarens efternamn.
E-postmeddelande
 template.templateCreatedBy.emailId string

Användarens e-postadress.
Företags-ID
 template.templateCreatedBy.companyId integer

ID:t för företaget som användaren tillhör.
Användarroll
 template.templateCreatedBy.userRole string

Användarens roll inom organisationen.
Aktivt
 template.templateCreatedBy.active boolean

Anger om användarens konto är aktivt.
Användar-ID
 template.templateLastUpdatedBy.partyId integer

Användarens unika ID.
Förnamn
 template.templateLastUpdatedBy.firstName string

Användarens förnamn.
Efternamn
 template.templateLastUpdatedBy.lastName string

Användarens efternamn.
E-postmeddelande
 template.templateLastUpdatedBy.emailId string

Användarens e-postadress.
Företags-ID
 template.templateLastUpdatedBy.companyId integer

ID:t för företaget som användaren tillhör.
Användarroll
 template.templateLastUpdatedBy.userRole string

Användarens roll inom organisationen.
Aktivt
 template.templateLastUpdatedBy.active boolean

Anger om användarens konto är aktivt.
Mallfält
 allfields array of object

Listan över alla signatur- och formulärfält som definierats i mallen.
Fält-ID
 allfields.fieldTagId integer

Fältets unika identifierare.
Mall-id
 allfields.templateId integer

ID:t för mallen som det här fältet tillhör.
Företags-ID
 allfields.companyId integer

Företagskontot som det här fältet tillhör.
Fälttyp
 allfields.fieldType string

Typ av fält (t.ex. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Sidnummer
 allfields.documentPageNumber integer

Sidnumret för dokumentet där det här fältet är placerat.
Ansvarig part
 allfields.partyResponsible integer

Det partisekvensnummer som ansvarar för att fylla i det här fältet.
Partsekvens
 allfields.partyResponsibleSequence integer

Den ansvariga partens sekvensposition.
Fältdokument-ID
 allfields.docFieldId string

Identifieraren på dokumentnivå för det här fältet.
Är beroende
 allfields.dependent boolean

Anger om det här fältets synlighet beror på ett annat fälts värde.
Tabbordning
 allfields.tabOrder integer

Tabbordningen för navigering mellan fält.
Obligatoriskt
 allfields.required boolean

Anger om det här fältet måste fyllas i innan dokumentet kan signeras.
Namn på anpassat fält
 allfields.customFieldName string

Ett anpassat namn som tilldelats det här fältet.
Dela alla
 allfields.shareAll boolean

Anger om det här fältet delas med alla användare.
Tillåt redigering
 allfields.allowEdit boolean

Anger om det här fältet kan redigeras av mottagaren.
Namn på textfält
 allfields.textfieldName string

Etiketten för textfältet (gäller när fieldType är "textfält").
Value
 allfields.value string

Det förfyllda eller angivna värdet för fältet.
Fontstorlek
 allfields.fontSize integer

Teckenstorleken som används för text i det här fältet.
Teckenfärg
 allfields.fontColor string

Teckenfärgen som används för text i det här fältet (t.ex. #0000000).
Skrivskyddad
 allfields.readOnly boolean

Anger om fältet är skrivskyddat och inte kan redigeras av mottagaren.
Flera linjer
 allfields.multiLine boolean

Anger om textfältet accepterar flera indatarader (gäller när fieldType är "textfält").
Teckengräns
 allfields.characterLimit integer

Det maximala antalet tecken som tillåts i fältet (gäller när fieldType är "textfält").
Namn på datumfält
 allfields.datefieldName string

Etiketten för datumfältet (gäller när fieldType är "datefield").
Datumformat
 allfields.dateFormat string

Datumformatet som används av det här fältet (t.ex. MM/DD/ÅÅÅÅ) (gäller när fieldType är "datefield").
Kryssrutenamn
 allfields.cbname string

Kryssrutans etikett (gäller när fieldType är "kryssrutefält").
Kryssrutegrupp
 allfields.cbgroup string

Gruppnamnet för den här kryssrutan (gäller när fieldType är "kryssrutefält").
Kontrollerad
 allfields.checked boolean

Anger om kryssrutan är markerad som standard (gäller när fieldType är "kryssrutefält").
Namn på skyddat fält
 allfields.securedfieldName string

Etiketten för det skyddade fältet (gäller när fieldType är "securedfield").
Tecken som ska visas
 allfields.charToDisplay integer

Antalet omaskerade tecken som ska visas i slutet av ett skyddat fältvärde (gäller när fieldType är "securedfield").
Signaturidentitet
 allfields.signatureId string

ID:t för signaturen som tillämpas på det här teckenfältet (gäller när fieldType är "signfield").
Initial bild
 allfields.initialImage string

Bilddata för initialerna som tillämpas på det här fältet (gäller när fieldType är "initialfield").
Fältnamn för bifogad fil
 allfields.attachmentfieldName string

Namnet på det bifogade fältet (gäller när fieldType är "attachmentfield").
Beskrivning av bifogad fil
 allfields.attachmentfieldDescription string

En beskrivning av vad som ska bifogas (gäller när fieldType är "attachmentfield").

Skicka signaturpåminnelse

Åtgärds-ID:
SendSignatureReminder

Skickar ett påminnelsemeddelande till väntande mottagare av ett kuvert, vilket uppmanar dem att slutföra signeringen.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kuvert-ID
 folderId True integer

Kuvertets ID.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Kuvert-ID
 reminder sent integer

ID för kuvertet som påminnelsen skickades för.

Ta bort kuvert

Åtgärds-ID:
DeleteEnvelopes

Tar bort ett eller flera kuvert permanent.

Parametrar

Name Nyckel Obligatorisk Typ Description
folderIds
 folderIds array of integer

Returer

Name Sökväg Typ Description
Result
 result string

Anger om åtgärden lyckades.

Visa en lista över alla Webhook-kanaler

Åtgärds-ID:
ListallWebhookChannels

Returnerar en lista över alla webhook-kanaler som konfigurerats i ditt konto.

Returer

Name Sökväg Typ Description
Result
 result string

Anger om begäran lyckades.
Totalt antal kanaler
 total_channel integer

Det totala antalet webhook-kanaler som konfigurerats i kontot.
Webhook-kanaler
 templatesList array of object

Listan över alla webhook-kanaler i kontot.
Kanal-ID
 templatesList.channelId integer

Den unika identifieraren för webhook-kanalen.
Företags-ID
 templatesList.companyId integer

Företagskontot som kanalen tillhör.
Kanalnamn
 templatesList.channelName string

Namnet på webhookens kanal.
Webhook-URL
 templatesList.webhookUrl string

Den URL som Foxit eSign anropar när en prenumerationshändelse inträffar.
Webhook-hemlighet
 templatesList.webhookSecret string

Den hemliga nyckel som används för att verifiera webhook-nyttolaster.
Skapelsedatum
 templatesList.dateCreated integer

Det datum då kanalen skapades i Unix millisekunder.
Datum uppdaterat
 templatesList.dateUpdated integer

Det datum då kanalen senast uppdaterades i Unix millisekunder.
Webhook-nivå
 templatesList.webhookLevel string

Webhook-kanalens omfång. Antingen "Konto" (utlösare för alla kuvert) eller "API App" (utlösare endast för kuvert som skapats via API:et).
Status
 templatesList.status string

Kanalens aktuella status. Antingen "aktiv" eller "deaktiv".
Kuvert skickat
 templatesList.eventsSubscribedMap.folder_sent boolean

Utlöses när ett kuvert skickas till mottagarna.
Kuvertet visas
 templatesList.eventsSubscribedMap.folder_viewed boolean

Utlöses när ett kuvert öppnas av en mottagare.
Kuvert signerat
 templatesList.eventsSubscribedMap.folder_signed boolean

Utlöses när ett kuvert signeras av en mottagare.
Kuvertet avbröts
 templatesList.eventsSubscribedMap.folder_cancelled boolean

Utlöses när ett kuvert avbryts.
Kuvertet körs
 templatesList.eventsSubscribedMap.folder_executed boolean

Utlöses när alla parter har signerat och kuvertet har körts fullständigt.
Kuvertet har tagits bort
 templatesList.eventsSubscribedMap.folder_deleted boolean

Utlöses när ett kuvert tas bort.

Utlösare

När ett kuvert avbryts

Utlöses när ett kuvert avbryts av en mottagare eller avsändaren.
När ett kuvert körs fullständigt

Utlöses när alla mottagare har signerats och kuvertet körs fullständigt.
När ett kuvert signeras

Utlöses när en mottagare signerar kuvertet.
När ett kuvert skickas

Utlöses när ett kuvert skickas till mottagarna. Den här händelsen utlöses bara när Webhook-nivån är inställd på "Konto".
När ett kuvert tas bort

Utlöses när ett kuvert tas bort.
När ett kuvert visas

Utlöses när en mottagare öppnas och visar kuvertet.

När ett kuvert avbryts

Åtgärds-ID:
TriggerEnvelopeCancelled

Utlöses när ett kuvert avbryts av en mottagare eller avsändaren.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanalnamn
 channelName True string

Ett namn för att identifiera den här webhook-prenumerationen i ditt konto.
Webhook-nivå
 webhookLevel True string

Konto: utlöses för alla kuvert (webb och API). API-app: utlöses endast för kuvert som skapats via API:et.
Webhook-hemlighet
 webhookSecret string

Optional. Foxit eSign signerar varje webhook-nyttolast med HMAC-SHA-256 med hjälp av den här hemligheten för verifiering.

Returer

Händelsedata som tas emot från Foxit eSign när en webhook-händelse utlöses.

WebhookEventPayload
WebhookEventPayload

När ett kuvert körs fullständigt

Åtgärds-ID:
TriggerEnvelopeExecuted

Utlöses när alla mottagare har signerats och kuvertet körs fullständigt.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanalnamn
 channelName True string

Ett namn för att identifiera den här webhook-prenumerationen i ditt konto.
Webhook-nivå
 webhookLevel True string

Konto: utlöses för alla kuvert (webb och API). API-app: utlöses endast för kuvert som skapats via API:et.
Webhook-hemlighet
 webhookSecret string

Optional. Foxit eSign signerar varje webhook-nyttolast med HMAC-SHA-256 med hjälp av den här hemligheten för verifiering.

Returer

Händelsedata som tas emot från Foxit eSign när en webhook-händelse utlöses.

WebhookEventPayload
WebhookEventPayload

När ett kuvert signeras

Åtgärds-ID:
TriggerEnvelopeSigned

Utlöses när en mottagare signerar kuvertet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanalnamn
 channelName True string

Ett namn för att identifiera den här webhook-prenumerationen i ditt konto.
Webhook-nivå
 webhookLevel True string

Konto: utlöses för alla kuvert (webb och API). API-app: utlöses endast för kuvert som skapats via API:et.
Webhook-hemlighet
 webhookSecret string

Optional. Foxit eSign signerar varje webhook-nyttolast med HMAC-SHA-256 med hjälp av den här hemligheten för verifiering.

Returer

Händelsedata som tas emot från Foxit eSign när en webhook-händelse utlöses.

WebhookEventPayload
WebhookEventPayload

När ett kuvert skickas

Åtgärds-ID:
TriggerEnvelopeSent

Utlöses när ett kuvert skickas till mottagarna. Den här händelsen utlöses bara när Webhook-nivån är inställd på "Konto".

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanalnamn
 channelName True string

Ett namn för att identifiera den här webhook-prenumerationen i ditt konto.
Webhook-nivå
 webhookLevel True string

Konto: utlöses för kuvert som skickas via webben eller API. API-app: utlöses endast för kuvert som skapats via API:et. Händelsen folder_sent utlöses bara på kontonivå.
Webhook-hemlighet
 webhookSecret string

Optional. Foxit eSign signerar varje webhook-nyttolast med HMAC-SHA-256 med hjälp av den här hemligheten för verifiering.

Returer

Händelsedata som tas emot från Foxit eSign när en webhook-händelse utlöses.

WebhookEventPayload
WebhookEventPayload

När ett kuvert tas bort

Åtgärds-ID:
TriggerEnvelopeDeleted

Utlöses när ett kuvert tas bort.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanalnamn
 channelName True string

Ett namn för att identifiera den här webhook-prenumerationen i ditt konto.
Webhook-nivå
 webhookLevel True string

Konto: utlöses för alla kuvert (webb och API). API-app: utlöses endast för kuvert som skapats via API:et.
Webhook-hemlighet
 webhookSecret string

Optional. Foxit eSign signerar varje webhook-nyttolast med HMAC-SHA-256 med hjälp av den här hemligheten för verifiering.

Returer

Händelsedata som tas emot från Foxit eSign när en webhook-händelse utlöses.

WebhookEventPayload
WebhookEventPayload

När ett kuvert visas

Åtgärds-ID:
TriggerEnvelopeViewed

Utlöses när en mottagare öppnas och visar kuvertet.

Parametrar

Name Nyckel Obligatorisk Typ Description
Kanalnamn
 channelName True string

Ett namn för att identifiera den här webhook-prenumerationen i ditt konto.
Webhook-nivå
 webhookLevel True string

Konto: utlöses för alla kuvert (webb och API). API-app: utlöses endast för kuvert som skapats via API:et.
Webhook-hemlighet
 webhookSecret string

Optional. Foxit eSign signerar varje webhook-nyttolast med HMAC-SHA-256 med hjälp av den här hemligheten för verifiering.

Returer

Händelsedata som tas emot från Foxit eSign när en webhook-händelse utlöses.

WebhookEventPayload
WebhookEventPayload

Definitioner

WebhookEventPayload

Händelsedata som tas emot från Foxit eSign när en webhook-händelse utlöses.

Name Sökväg Typ Description
Händelsenamn
 event_name string

Namnet på händelsen som utlöstes (t.ex. folder_sent, folder_signed, folder_executed).
Händelsedatum
 event_date integer

Datum och tid då händelsen inträffade (Unix-tidsstämpel i millisekunder).
ID
 data.folder.folderId integer

Kuvertets unika ID.
Name
 data.folder.folderName string

Kuvertets namn.
Anpassat namn
 data.folder.folderCustomName string

Det anpassade namn som tilldelats kuvertet.
Lösenord
 data.folder.folderPassword string

Åtkomstlösenordet för kuvertet, om det anges.
Skapar-ID
 data.folder.folderAuthorId integer

Användar-ID för kuvertskapare.
Skaparens förnamn
 data.folder.folderAuthorFirstName string

Förnamnet på kuvertskapare.
Skaparens efternamn
 data.folder.folderAuthorLastName string

Efternamnet på kuvertskapare.
E-post för skapare
 data.folder.folderAuthorEmail string

E-postadressen till kuvertskapare.
Skaparroll
 data.folder.folderAuthorRole string

Kontorollen för kuvertskapare.
Företags-ID
 data.folder.folderCompanyId integer

Företags-ID:t som äger kuvertet.
Skapelsedatum
 data.folder.folderCreationDate integer

Det datum då kuvertet skapades (Unix-tidsstämpel i millisekunder).
Skickat datum
 data.folder.folderSentDate integer

Det datum då kuvertet skickades (Unix-tidsstämpel i millisekunder).
Status
 data.folder.folderStatus string

Kuvertets aktuella status.
Anpassat fält 1
 data.folder.custom_field1 string

Det första anpassade metadatafältet.
Anpassat fält 2
 data.folder.custom_field2 string

Det andra anpassade metadatafältet.
Metadata
 data.folder.metadata string

Anpassade metadata som är associerade med kuvertet.
Dokument-ID
 data.folder.folderDocumentIds array of integer

Listan över dokument-ID:t i kuvertet.
Documents
 data.folder.documentsList array of object

Listan över dokument i kuvertet.
Dokument-ID
 data.folder.documentsList.documentId integer

Dokumentets unika identifierare.
Kontrakts-ID
 data.folder.documentsList.contractId integer

Kontrakts-ID:t för det här dokumentet.
Företags-ID
 data.folder.documentsList.companyId integer

Företags-ID för det här dokumentet.
Skapad av
 data.folder.documentsList.contractCreatedBy integer

Användar-ID för den person som skapade kontraktet.
Skapad på
 data.folder.documentsList.contractCreatedOn integer

Datumet då kontraktet skapades (Unix-tidsstämpel i millisekunder).
Kontraktstyp
 data.folder.documentsList.contractType string

Typ av kontrakt.
Kontraktsstatus
 data.folder.documentsList.contractStatus string

Kontraktets aktuella status.
Redigerbar
 data.folder.documentsList.editable boolean

Anger om dokumentet kan redigeras.
Versions-ID
 data.folder.documentsList.contractVersionId integer

Versions-ID för kontraktet.
Versionsnamn
 data.folder.documentsList.contractVersionName string

Namnet på kontraktsversionen.
Versionsbeskrivning
 data.folder.documentsList.contractVersionDesc string

En beskrivning av kontraktsversionen.
Version skapad av
 data.folder.documentsList.versionCreatedby integer

Användar-ID för den person som skapade den här versionen.
Version skapad på
 data.folder.documentsList.versionCreatedOn integer

Det datum då den här versionen skapades (Unix-tidsstämpel i millisekunder).
Versionsnummer
 data.folder.documentsList.contractVersionNumber integer

Versionsnumret för kontraktet.
Transaktionskälla
 data.folder.documentsList.contractTransactionSource string

Källsystemet som initierade kontraktet.
Mottagare
 data.folder.folderRecipientParties array of object

Listan över mottagare för det här kuvertet.
Mottagarens ID
 data.folder.folderRecipientParties.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 data.folder.folderRecipientParties.partyDetails.partyId integer

Mottagarens unika ID.
Förnamn
 data.folder.folderRecipientParties.partyDetails.firstName string

Mottagarens förnamn.
Efternamn
 data.folder.folderRecipientParties.partyDetails.lastName string

Mottagarens efternamn.
E-postmeddelande
 data.folder.folderRecipientParties.partyDetails.emailId string

Mottagarens e-postadress.
Platshållare
 data.folder.folderRecipientParties.partyDetails.placeholder boolean

Om det här är en platshållarmottagare.
Address
 data.folder.folderRecipientParties.partyDetails.address string

Mottagarens adress.
Skapelsedatum
 data.folder.folderRecipientParties.partyDetails.dateCreated integer

Det datum då mottagarposten skapades (Unix-tidsstämpel i millisekunder).
Avregistrera e-postmeddelanden
 data.folder.folderRecipientParties.partyDetails.optOutEmails boolean

Om mottagaren har valt bort e-post.
Unikt ID
 data.folder.folderRecipientParties.partyDetails.uniquePartyId string

En unik systemidentifierare för den här mottagaren.
Autentiseringsnivå
 data.folder.folderRecipientParties.partyDetails.authenticationLevel string

Autentiseringsmetoden för den här mottagaren.
Lösenord uppdaterat datum
 data.folder.folderRecipientParties.partyDetails.passwordUpdateDate string

Datumet då lösenordet senast uppdaterades.
Lösenordsstatus
 data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

Om lösenordet har uppdaterats.
Uppringningskod
 data.folder.folderRecipientParties.dialingCode string

Den internationella uppringningskoden.
Mobile
 data.folder.folderRecipientParties.mobileNumber string

Mottagarens mobilnummer.
Signaturtyp
 data.folder.folderRecipientParties.signerSignatureType string

Den typ av signatur som undertecknaren ska använda.
Permissions
 data.folder.folderRecipientParties.contractPermissions string

De behörigheter som beviljats den här mottagaren.
Signeringsorder
 data.folder.folderRecipientParties.partySequence integer

Signeringsbeställningen för den här mottagaren.
Arbetsflödessekvens
 data.folder.folderRecipientParties.workflowSignSequence integer

Sekvensnumret för arbetsflödessignering.
Kuvert-ID
 data.folder.folderRecipientParties.envelopeId integer

Kuvert-ID:t som är associerat med den här mottagaren.
Mottagarens företags-ID
 data.folder.folderRecipientParties.partyCompanyId integer

Företagets ID för den här mottagaren.
Delningsläge
 data.folder.folderRecipientParties.sharingMode string

Delningsläget för den här mottagaren.
Url för mottagarsignering
 data.folder.folderRecipientParties.folderAccessURL string

Url:en för den här mottagaren att komma åt och signera kuvertet.
Säkerhetsläge
 data.folder.folderRecipientParties.securityMode string

Säkerhetsläget för den här mottagaren.
Comments
 data.folder.folderRecipientParties.extraComments string

Ytterligare kommentarer för mottagaren.
Tillåt namnändring
 data.folder.folderRecipientParties.allowNameChange boolean

Om mottagaren kan uppdatera sitt namn.
Namn uppdaterat
 data.folder.folderRecipientParties.signerNameUpdated boolean

Om undertecknaren har uppdaterat sitt namn.
Autentiseringsnivå för undertecknare
 data.folder.folderRecipientParties.signerAuthenticationLevel string

Den autentiseringsnivå som krävs för undertecknaren.
Åtkomstkod
 data.folder.folderRecipientParties.userDefinedAccessCode string

En anpassad åtkomstkod för undertecknaren.
Signaturidentitet
 data.folder.folderRecipientParties.signatureId string

ID:t för den tillämpade signaturen.
Befattning
 data.folder.folderRecipientParties.partyRole string

Den här mottagarens roll i signeringsarbetsflödet.
Företagsfält
 data.folder.folderRecipientParties.companyFieldValue string

Fältvärdet för företagsnamn.
Rubrikfält
 data.folder.folderRecipientParties.titleFieldValue string

Värdet för rubrikfält.
Orsak till signering
 data.folder.folderRecipientParties.reasonSigning string

Anledningen till undertecknandet.
Betalningsfält har lagts till
 data.folder.folderRecipientParties.payFieldAdded boolean

Om ett betalningsfält har lagts till.
Betalningsmottagare
 data.folder.folderRecipientParties.payee boolean

Om mottagaren är betalningsmottagare.
Återkommande betalning
 data.folder.folderRecipientParties.recurringFieldExist boolean

Om det finns ett återkommande betalningsfält.
Skriv ut och signera klar
 data.folder.folderRecipientParties.printAndSignCompleted boolean

Om utskrift och tecken är slutförda.
Valfri undertecknare
 data.folder.folderRecipientParties.allowOptionalSigner boolean

Om mottagaren är en valfri undertecknare.
Valfria undertecknare
 data.folder.folderRecipientParties.optionalSigners array of integer

Valfria part-ID:t för undertecknaren.
Paid
 data.folder.folderRecipientParties.paid boolean

Om betalningen har slutförts.
Url för redigeringsåtkomst
 data.folder.folderAccessURLForAuthor string

Url:en för kuvertförfattaren att komma åt kuvertet.
URL för utkaståtkomst
 data.folder.draftFolderAccessURL string

URL:en för att komma åt kuvertet i utkasttillstånd.
Signering av styrelserum
 data.folder.boardRoomSign boolean

Om signeringsläget för styrelserum är aktiverat.
Inkludera logotyp
 data.folder.includeLogo boolean

Om företagets logotyp ingår i e-postmeddelanden.
Bakgrundsfärg för knapp
 data.folder.email_btnBgColor string

Bakgrundsfärgen för e-poståtgärdsknappen.
Knapptextfärg
 data.folder.email_btnTxtColor string

Textfärgen för e-poståtgärdsknappen.
E-postlogotyp
 data.folder.emailTemplateLogo string

Logotyp-URL:en som används i e-postmallen.
E-postmalls-ID
 data.folder.emailTemplateId integer

ID:t för den e-postmall som används.
E-postrubrik
 data.folder.emailHeader string

Rubriktexten i e-postaviseringar.
E-postfot
 data.folder.emailFooter string

Sidfotstexten i e-postaviseringar.
Rensa schemalagd
 data.folder.purgeFlag boolean

Om kuvertet är schemalagt för rensning.
Rensa startdatum
 data.folder.purgeStartDate string

Startdatumet för rensningsschemat.
Rensa slutdatum
 data.folder.purgeEndDate string

Slutdatum för rensningsschemat.
Mass-ID
 data.folder.bulkId integer

Åtgärds-ID för massutskick, om tillämpligt.
Framtvinga signeringsorder
 data.folder.enforceSignWorkflow boolean

Om mottagarna måste logga in i den definierade ordningen.
Aktuellt arbetsflödessteg
 data.folder.currentWorkflowStep integer

Det aktuella steget i signeringsarbetsflödet.
Transaktionskälla
 data.folder.transactionSource string

Källsystemet som initierade den här transaktionen.
Redigerbar
 data.folder.editable boolean

Om kuvertet kan redigeras.
In-Person signering
 data.folder.inPersonSignable boolean

Om kuvertet stöder personlig signering.
Åsidosätt påminnelser
 data.folder.overrideAccountReminders boolean

Om inställningarna för påminnelser på kontonivå är åsidosatta.
Åsidosätt delegering
 data.folder.overrideAccountRecipientDelegation boolean

Om delegeringsinställningarna på kontonivå är åsidosatta.
Tillåt delegering
 data.folder.allowRecipientsToDelegate boolean

Om mottagarna kan delegera signering.
ID
 data.folder.envelopeId integer

Det unika kuvert-ID:t (aliaset för folderId).
Name
 data.folder.envelopeName string

Kuvertnamnet (aliaset för folderName).
Ursprungs-ID
 data.folder.envelopeOriginatorId integer

Användar-ID:t som kom från kuvertet.
Företags-ID
 data.folder.envelopeCompanyId integer

Företags-ID:t som äger kuvertet.
Date
 data.folder.envelopeDate integer

Det datum då kuvertet skapades (Unix-tidsstämpel i millisekunder).
Delat datum
 data.folder.envelopeSharedDate integer

Det datum då kuvertet delades (Unix-tidsstämpel i millisekunder).
Status
 data.folder.envelopeStatus string

Kuvertets aktuella status.
Kontrakts-ID:t
 data.folder.envelopeContractIds array of integer

Kontrakt-ID:t som är associerade med det här kuvertet.
Partbehörigheter
 data.folder.envelopePartyPermissions array of object

Listan med mottagarbehörigheter (samma struktur som Mottagare).
Mottagarens ID
 data.folder.envelopePartyPermissions.partyId integer

Mottagarens unika identifierare.
Mottagarens ID
 data.folder.envelopePartyPermissions.partyDetails.partyId integer
Förnamn
 data.folder.envelopePartyPermissions.partyDetails.firstName string
Efternamn
 data.folder.envelopePartyPermissions.partyDetails.lastName string
E-postmeddelande
 data.folder.envelopePartyPermissions.partyDetails.emailId string
Platshållare
 data.folder.envelopePartyPermissions.partyDetails.placeholder boolean
Address
 data.folder.envelopePartyPermissions.partyDetails.address string
Skapelsedatum
 data.folder.envelopePartyPermissions.partyDetails.dateCreated integer
Avregistrera e-postmeddelanden
 data.folder.envelopePartyPermissions.partyDetails.optOutEmails boolean
Unikt ID
 data.folder.envelopePartyPermissions.partyDetails.uniquePartyId string
Autentiseringsnivå
 data.folder.envelopePartyPermissions.partyDetails.authenticationLevel string
Lösenord uppdaterat datum
 data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string
Lösenordsstatus
 data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean
Uppringningskod
 data.folder.envelopePartyPermissions.dialingCode string
Mobile
 data.folder.envelopePartyPermissions.mobileNumber string
Signaturtyp
 data.folder.envelopePartyPermissions.signerSignatureType string
Permissions
 data.folder.envelopePartyPermissions.contractPermissions string
Signeringsorder
 data.folder.envelopePartyPermissions.partySequence integer
Arbetsflödessekvens
 data.folder.envelopePartyPermissions.workflowSignSequence integer
Kuvert-ID
 data.folder.envelopePartyPermissions.envelopeId integer
Mottagarens företags-ID
 data.folder.envelopePartyPermissions.partyCompanyId integer
Delningsläge
 data.folder.envelopePartyPermissions.sharingMode string
Url för mottagarsignering
 data.folder.envelopePartyPermissions.folderAccessURL string
Säkerhetsläge
 data.folder.envelopePartyPermissions.securityMode string
Comments
 data.folder.envelopePartyPermissions.extraComments string
Tillåt namnändring
 data.folder.envelopePartyPermissions.allowNameChange boolean
Namn uppdaterat
 data.folder.envelopePartyPermissions.signerNameUpdated boolean
Autentiseringsnivå för undertecknare
 data.folder.envelopePartyPermissions.signerAuthenticationLevel string
Åtkomstkod
 data.folder.envelopePartyPermissions.userDefinedAccessCode string
Signaturidentitet
 data.folder.envelopePartyPermissions.signatureId string
Befattning
 data.folder.envelopePartyPermissions.partyRole string
Företagsfält
 data.folder.envelopePartyPermissions.companyFieldValue string
Rubrikfält
 data.folder.envelopePartyPermissions.titleFieldValue string
Orsak till signering
 data.folder.envelopePartyPermissions.reasonSigning string
Betalningsfält har lagts till
 data.folder.envelopePartyPermissions.payFieldAdded boolean
Betalningsmottagare
 data.folder.envelopePartyPermissions.payee boolean
Återkommande betalning
 data.folder.envelopePartyPermissions.recurringFieldExist boolean
Skriv ut och signera klar
 data.folder.envelopePartyPermissions.printAndSignCompleted boolean
Valfri undertecknare
 data.folder.envelopePartyPermissions.allowOptionalSigner boolean
Valfria undertecknare
 data.folder.envelopePartyPermissions.optionalSigners array of integer
Paid
 data.folder.envelopePartyPermissions.paid boolean
Autentiseringsnivå
 data.folder.envelopeAuthenticationLevel string

Den autentiseringsnivå som krävs för kuvertet.
Massinloggning för enkel undertecknare
 data.folder.allowSingleSignerInBulk boolean

Om en enkel undertecknare tillåts i massläge.
File-Based mappnamn
 data.folder.folderNameBasedOnFileNaming boolean
File-Based dokumentnamn
 data.folder.documentNameBasedOnFileNaming boolean
File-Based certifikatnamn
 data.folder.certificateNameBasedOnFileNaming boolean
Pre-Exec-filnamngivning
 data.folder.enableFileNamingBeforeExecution boolean
Betalningsmottagaren har lagts till
 data.folder.payeeAddedd boolean
Self-Signing aktiverat
 data.folder.selfSignerEnabled boolean
Notarie aktiverad
 data.folder.notaryEnabled boolean
Begränsad synlighet
 data.folder.limitedVisibilityFlag boolean
Synlighet efter tecken
 data.folder.postSigningVisibility boolean
Våt signatur
 data.folder.wetSignatureEnabled boolean
Sammanslagning aktiverat
 data.folder.mergeEnabled boolean

binary

Det här är den grundläggande datatypen "binär".