Foxit eSign (előzetes verzió)

A Foxit eSign egy elektronikus aláírási megoldás, amely lehetővé teszi a dokumentumok online küldését, aláírását és kezelését – így nincs szükség nyomtatásra, vizsgálatra vagy levelezésre. Töltse fel a dokumentumot, határozza meg az aláírási mezőket, és küldje el a címzetteknek a gyors, jogilag kötelező eSignatures számára.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate régió kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government régiók      - Azure Kína régiói      - Amerikai Védelmi Minisztérium (DoD)
Power Apps	prémium	Az összes Power Apps régió kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate régió kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Contact
Név	Foxit eSign-támogatás
URL	https://www.foxit.com
Email	api@foxit.com

Összekötő metaadatai
Publisher	Foxit Software Inc.
Webhely	https://www.foxit.com/esign-pdf/
Adatvédelmi irányelvek	https://www.foxit.com/company/privacy-policy.html
Categories	Termelékenység; Tartalom és fájlok

Foxit eSign

A Foxit eSign egy nagyvállalati szintű elektronikus aláírási megoldás, amely lehetővé teszi a vállalatok számára a jogilag kötelező erejű dokumentumok teljes online küldését, aláírását és kezelését – így nincs szükség nyomtatásra, vizsgálatra vagy levelezésre. Töltse fel a dokumentumot, határozza meg az aláírási mezőket, és küldje el a címzetteknek gyors és biztonságos eSignatures. A Foxit eSign teljes mértékben megfelel a főbb elektronikus aláírási törvényeknek, például az ESIGN-nek és az UETA-nak, titkosítással védi az átvitt és inaktív dokumentumokat, és támogatja a többtényezős hitelesítést, hogy csak az arra jogosult aláírók férhessenek hozzá és írhassák alá a dokumentumokat.

A Foxit eSign-összekötő Microsoft Power Automate lehetővé teszi a teljes dokumentum-aláírási munkafolyamat automatizálását – a borítékok létrehozásától és aláírásra való elküldésétől az állapot nyomon követéséig, a befejezett dokumentumok letöltéséhez, a sablonok kezeléséhez és az alárendelt műveletek elindításához a borítékesemények esetén.

Publisher: Foxit Corporation

Prerequisites

Az összekötő használatához a következőkre lesz szüksége:

• Egyéni összekötővel vagy prémium szintű összekötő hozzáféréssel rendelkező Microsoft Power Apps vagy Power Automate csomag
• Foxit eSign-fiók – hozzon létre egyet itt
• Az API-hozzáférés engedélyezve van a Foxit eSign-fiókban (lásd alább a hitelesítő adatok beszerzését)

Hitelesítő adatok beszerzése

1. Hozzon létre egy Foxit eSign-fiókot , ha még nem rendelkezik ilyen fiókkal.
2. Lépjen kapcsolatba a Foxit Sales csapatával, és kérje az API-hozzáférés engedélyezését a fiókjában. A jóváhagyást követően az API-hozzáférés aktiválódik a fiókjában.
3. Az Power Automate keresse meg a Foxit eSign függvényt az összekötők listájában, és válassza a Kapcsolat létrehozása lehetőséget.
4. A rendszer átirányítja a Foxit eSign bejelentkezési lapjára. Jelentkezzen be Foxit eSign hitelesítő adataival a kapcsolat engedélyezéséhez.
5. Az engedélyezés után a kapcsolat készen áll a folyamatokban való használatra.

Első lépések

A kapcsolat létrehozása után megkezdheti a folyamatok létrehozását a Foxit eSign-összekötővel:

• Eseményindítók használatával automatikusan elindíthat egy folyamatot egy borítékesemény bekövetkezésekor (például amikor az összes fél aláírta).
• A műveletek segítségével borítékokat hozhat létre, aláírás-emlékeztetőket küldhet, letöltött dokumentumokat tölthet le, sablonokat kezelhet stb.
• Több művelet összekapcsolása – például hozzon létre egy borítékot egy sablonból, várja meg a teljesen végrehajtott eseményindítót, majd töltse le az aláírt dokumentumot, és tárolja SharePoint.

Támogatott eseményindítók

Trigger	Description
Boríték küldésekor	Akkor aktiválódik, ha egy borítékot küldenek a címzetteknek. A Webhook-szint fiókra van állítva.
Boríték megtekintésekor	Aktiválódik, amikor egy címzett megnyílik, és megtekinti a borítékot.
Boríték aláírásakor	Akkor aktiválódik, amikor egy címzett aláírja a borítékot.
Ha egy borítékot törölnek	Akkor aktiválódik, ha egy címzett vagy a feladó visszavon egy borítékot.
Boríték teljes végrehajtásakor	Akkor aktiválódik, ha az összes címzett aláírta, és a boríték teljesen elkészült.
Boríték törlésekor	A boríték törlésekor aktiválódik.

Támogatott műveletek

Borítékok

Tevékenység	Description
Boríték létrehozása URL-címből	Egy borítékot hoz létre és küld el egy nyilvánosan elérhető PDF-URL-cím használatával.
Boríték létrehozása a Base64-ből	Egy Base64 kódolású PDF-dokumentum használatával hoz létre és küld el egy borítékot.
Boríték létrehozása sablonból	Létrehoz és elküld egy borítékot egy meglévő Foxit eSign-sablonból.
Boríték részleteinek lekérése	Lekéri a boríték teljes adatait és aktuális állapotát.
Borítékazonosítók lekérése	Lekéri a borítékazonosítók listáját a szűrési feltételek alapján.
Aláírás-emlékeztető küldése	Emlékeztető értesítést küld a boríték függőben lévő aláíróinak.
Borítékfájlok letöltése	Letölti az összes aláírt dokumentumot egy borítékba zip-fájlként.
Egydokumentumos PDF letöltése	Egyetlen dokumentumot tölt le egy borítékból PDF-fájlként.
Borítékok áthelyezése lomtárba	Egy vagy több boríték áthelyezése a lomtárba.
Boríték megszakítása	Törli a borítékot, és értesíti a címzetteket.
Borítékok törlése	Véglegesen töröl egy vagy több borítékot.
Borítéktevékenységek előzményeinek lekérése	A boríték teljes tevékenységnaplójának lekérése.
Törölt boríték előzményeinek lekérése	Lekéri a fiókban törölt borítékok előzményeit.

Templates

Tevékenység	Description
Sablon létrehozása URL-címből	Nyilvánosan elérhető PDF-URL-cím használatával létrehoz egy újrafelhasználható aláírási sablont.
Sablon létrehozása a Base64-ből	Egy Base64 kódolású PDF-dokumentum használatával létrehoz egy újrafelhasználható aláírósablont.
Sablon részleteinek lekérése	Lekéri egy adott sablon teljes adatait, beleértve a meződefiníciókat is.
Sablonok lekérése sablonazonosítók alapján	Lekéri egy vagy több sablon részleteit a azonosítójuk alapján.
Az összes sablon listájának lekérése	Lekéri a fiókban elérhető összes sablont.

Webhooks

Tevékenység	Description
Az összes webhookcsatorna listázása	A fiókban konfigurált összes webhook-csatorna listáját adja vissza.
Webhook csatorna részleteinek lekérése	Lekéri egy adott webhookcsatorna adatait.

E-mail-csoportok

Tevékenység	Description
E-mail-csoport létrehozása	Új e-mail-csoportot hoz létre a borítékokban címzettként való használatra.
E-mail-csoport adatainak lekérése	Lekéri egy e-mail-csoport adatait és tagjait.

Jelentések

Tevékenység	Description
Jelentés letöltése	Letölt egy fióktevékenység-jelentést Microsoft Excel formátumban.

Ismert problémák és korlátozások

• Sebességkorlát: A Foxit eSign API fiókonként 5 percenként legfeljebb 4000 kérést tesz lehetővé. A korlátot meghaladó kérések választ kapnak 429 Too Many Requests . Javasoljuk, hogy az újrapróbálkozási logikát exponenciális visszalépéssel implementálja a folyamatokban, hogy ezt a kecsesen kezelje.

• Fájlméretkorlát: A dokumentumonkénti maximális fájlméret 25 MB. Ez a korlát az egyes fájlokra vonatkozik, nem a teljes borítékméretre.

• Webhook automatikus leiratkozás: A Foxit eSign webhook törlési API korlátozása miatt (amely a DELETE helyett POST metódust használ), Power Automate nem lehet automatikusan törölni a webhookcsatorna-előfizetéseket egy eseményindítóalapú folyamat törlése vagy módosításakor. A Minden webhook csatorna listázása művelet használatával azonosíthatja az aktív csatornákat és a Foxit eSign portált az előfizetések eltávolításához egy folyamat leszerelésekor.

• Boríték küldésekor – Csak fiókszint: A "Boríték küldésekor" eseményindító csak akkor aktiválódik, ha a Webhook-szint Fiók értékre van állítva. Nem aktiválódik az API-alkalmazás szintjén létrehozott borítékok esetében. Az eseményindító konfigurálásakor győződjön meg arról, hogy a fiókszintet választja.

• Regionális elérhetőség: Az összekötő észak-amerikai (NA1) és EU-régiós fiókokhoz is elérhető. Válassza ki a megfelelő kiszolgálórégiót a kapcsolat konfigurálásakor. Ha nem a megfelelő régióhoz csatlakozik, hitelesítési hibák következnek be.

• Base64-dokumentumméret: A Base64-ből származó boríték létrehozása vagy a Base64-műveletek sablonjának használatakor a Base64 kódolt sztringnek 25 MB-nál nem nagyobb forrásfájlnak kell lennie.

Támogatás

A fejlesztői támogatásért forduljon a Foxit eSign csapatához a következő címen devsupport@foxitsoftware.com: .

Támogatási eset beküldéséhez látogasson el https://kb.foxit.com/s/submit-a-caseide.

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

Aláírás-emlékeztető küldése	Emlékeztető értesítést küld a boríték függőben lévő címzettjeinek, és kéri, hogy fejezze be az aláírást.
Az összes sablon listájának lekérése	A fiókban elérhető összes sablon listáját adja vissza.
Az összes webhookcsatorna listázása	A fiókban konfigurált összes webhook-csatorna listáját adja vissza.
Boríték létrehozása a Base64-ből	Egy Base64 kódolású PDF-dokumentum használatával hoz létre és küld el egy borítékot.
Boríték létrehozása sablonból	Egy meglévő sablonnal hoz létre és küld el egy borítékot. A címzett adatai testre szabhatók.
Boríték létrehozása URL-címből	Borítékot hoz létre és küld el nyilvánosan elérhető PDF-URL-címek használatával. Adja meg a dokumentum URL-címét és a címzett adatait az aláírási folyamat elindításához.
Boríték megszakítása	Visszavonja az elküldött borítékot. A címzettek a továbbiakban nem tudják aláírni a dokumentumokat.
Boríték részleteinek lekérése	Lekéri a boríték teljes adatait, beleértve az állapotát, a címzetteket és a dokumentumokat.
Borítékazonosítók lekérése	Az állapot szerint szűrt borítékazonosítók listáját adja vissza. Ezzel megkereshet egy adott állapotú borítékot.
Borítékfájlok letöltése	Letölti a kitöltött dokumentumokat egy borítékból fájlként.
Borítékok törlése	Véglegesen töröl egy vagy több borítékot.
Borítékok áthelyezése lomtárba	Egy vagy több boríték áthelyezése a lomtárba. A lomtárban lévő borítékok nem törlődnek véglegesen.
Borítéktevékenységek előzményeinek lekérése	Egy boríték teljes tevékenységnaplójának lekérése, amely megjeleníti a címzettek és a feladó által végrehajtott összes műveletet.
E-mail-csoport adatainak lekérése	Egy meglévő e-mail csoport adatait kéri le.
E-mail-csoport létrehozása	Létrehoz egy új e-mail csoportot, amellyel egyszerre több címzettnek küldhet borítékokat.
Egydokumentumos PDF letöltése	Egyetlen dokumentumot tölt le egy borítékból PDF-fájlként.
Jelentés letöltése	Egy borítéktevékenység-jelentést tölt le Microsoft Excel fájlként. A szűrőkkel az eredményeket állapot, dátumtartomány, borítéknév, szerző vagy aláíró szerint szűkítheti.
Leiratkozás webhook eseményindító	Egy aktív webhookcsatorna-előfizetést töröl a csatornaazonosítója alapján. Ezzel a művelettal törölheti a már nem szükséges webhook-előfizetéseket.
Sablon létrehozása a Base64-ből	Létrehoz egy új sablont egy Base64 kódolású PDF-sztring használatával. Ezt akkor használja, ha a PDF-fájl már elérhető Base64-sztringként a folyamatban, például SharePoint fájlból vagy OneDrive dokumentumból.
Sablon létrehozása URL-címből	Létrehoz egy új sablont egy nyilvánosan elérhető PDF-URL-cím használatával.
Sablon részleteinek lekérése	Lekéri egy adott sablon teljes adatait, beleértve a mezőket és a címzetteket is.
Sablonok lekérése sablonazonosítók alapján	Lekéri egy vagy több sablon részleteit a azonosítójuk alapján.
Törölt boríték előzményeinek lekérése	Lekéri a törölt vagy a lomtárba áthelyezett borítékok előzményeit.
Webhook csatorna részleteinek lekérése	Lekéri egy adott webhookcsatorna adatait.

Aláírás-emlékeztető küldése

Műveletazonosító:

SendSignatureReminder

Emlékeztető értesítést küld a boríték függőben lévő címzettjeinek, és kéri, hogy fejezze be az aláírást.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	folderId	True	integer	A boríték azonosítója.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Boríték azonosítója	reminder sent	integer	Annak a borítéknak az azonosítója, amelyre az emlékeztetőt küldték.

Az összes sablon listájának lekérése

Műveletazonosító:

GetalistofallTemplates

A fiókban elérhető összes sablon listáját adja vissza.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Összes sablon	total_templates	integer	A fiókban lévő sablonok teljes száma.
Sablonok listája	templatesList	array of object	A fiókban elérhető összes sablon listája.
Sablon ID	templatesList.templateId	integer	A sablon egyedi azonosítója. Ezzel az azonosítóval boríték létrehozása sablonból a sablon aláírásra való elküldéséhez.
Sablon neve	templatesList.templateName	string	A sablon neve.
Sablon leírása	templatesList.templateDesc	string	A sablon leírása.
Sablon típusa	templatesList.templateType	string	A sablon típusa vagy kategóriája.
Létrehozás dátuma	templatesList.templateCreationDate	integer	A sablon létrehozásának dátuma Unix ezredmásodpercben.
Utolsó frissítés dátuma	templatesList.templateLastUpdateDate	integer	A sablon utolsó frissítésének dátuma Unix ezredmásodpercben.
Módosítható	templatesList.editable	boolean	Azt jelzi, hogy a sablon szerkeszthető-e.
Felek száma	templatesList.numberOfParties	integer	A sablonban meghatározott aláíró felek száma.
Cégazonosító	templatesList.companyId	integer	Az a vállalati fiók, amelyhez a sablon tartozik.
Megosztás az összeskel	templatesList.shareAll	boolean	Azt jelzi, hogy a sablon meg van-e osztva a fiók összes felhasználójával.
Fél azonosítója	templatesList.templateCreatedBy.partyId	integer	A felhasználó egyedi azonosítója.
Keresztnév	templatesList.templateCreatedBy.firstName	string	A felhasználó utóneve.
Vezetéknév	templatesList.templateCreatedBy.lastName	string	A felhasználó vezetékneve.
Email	templatesList.templateCreatedBy.emailId	string	A felhasználó e-mail címe.
Fél azonosítója	templatesList.templateLastUpdatedBy.partyId	integer	A felhasználó egyedi azonosítója.
Keresztnév	templatesList.templateLastUpdatedBy.firstName	string	A felhasználó utóneve.
Vezetéknév	templatesList.templateLastUpdatedBy.lastName	string	A felhasználó vezetékneve.
Email	templatesList.templateLastUpdatedBy.emailId	string	A felhasználó e-mail címe.

Az összes webhookcsatorna listázása

Műveletazonosító:

ListallWebhookChannels

A fiókban konfigurált összes webhook-csatorna listáját adja vissza.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Összes csatorna	total_channel	integer	A fiókban konfigurált webhook-csatornák teljes száma.
Webhook-csatornák	templatesList	array of object	A fiók összes webhook csatornájának listája.
Csatornaazonosító	templatesList.channelId	integer	A webhook csatorna egyedi azonosítója.
Cégazonosító	templatesList.companyId	integer	Az a vállalati fiók, amelyhez ez a csatorna tartozik.
Csatorna neve	templatesList.channelName	string	A webhook csatorna neve.
Webhook URL-címe	templatesList.webhookUrl	string	Az URL-cím, amelyet a Foxit eSign meghív egy előfizetett esemény bekövetkezésekor.
Webhook titkos kódja	templatesList.webhookSecret	string	A webhook hasznos adatainak ellenőrzéséhez használt titkos kulcs.
Létrehozás dátuma	templatesList.dateCreated	integer	A csatorna létrehozásának dátuma Unix ezredmásodpercben.
Dátum frissítve	templatesList.dateUpdated	integer	A csatorna utolsó frissítésének dátuma Unix ezredmásodpercben.
Webhook szintje	templatesList.webhookLevel	string	A webhook csatorna hatóköre. "Account" (eseményindítók minden borítékhoz) vagy "API-alkalmazás" (csak az API-n keresztül létrehozott borítékok esetén aktiválódik).
Status	templatesList.status	string	A csatorna aktuális állapota. Vagy "aktív" vagy "deactive".
Boríték elküldve	templatesList.eventsSubscribedMap.folder_sent	boolean	A boríték címzetteknek való elküldésekor aktiválódik.
Boríték megtekintve	templatesList.eventsSubscribedMap.folder_viewed	boolean	Akkor aktiválódik, ha egy címzett megnyit egy borítékot.
Boríték aláírva	templatesList.eventsSubscribedMap.folder_signed	boolean	Akkor aktiválódik, ha egy címzett aláír egy borítékot.
Boríték törölve	templatesList.eventsSubscribedMap.folder_cancelled	boolean	A boríték törlésekor aktiválódik.
Boríték végrehajtva	templatesList.eventsSubscribedMap.folder_executed	boolean	Akkor aktiválódik, ha az összes fél aláírta a borítékot, és a borítékot teljes mértékben végrehajtja.
Boríték törölve	templatesList.eventsSubscribedMap.folder_deleted	boolean	A boríték törlésekor aktiválódik.

Boríték létrehozása a Base64-ből

Műveletazonosító:

CreateEnvelopefromBase64

Egy Base64 kódolású PDF-dokumentum használatával hoz létre és küld el egy borítékot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték neve	folderName	True	string	A boríték neve.
Bemeneti típus	inputType		string	A dokumentumforrás bemeneti típusa. A művelet alap64-esre van javítva.
Base64-fájlsztringek	base64FileString	True	array of string	Elküldendő Base64-kódolt PDF-dokumentumok tömbje.
Fájlnevek	fileNames	True	array of string	Az egyes dokumentumok megjelenítendő neveinek tömbje a Base64 Fájlsztring tömbdel megegyező sorrendben.
Keresztnév	firstName	True	string	A címzett utóneve.
Vezetéknév	lastName	True	string	A címzett vezetékneve.
E-mail-cím	emailId	True	string	A címzett e-mail-címe.
engedélyek	permission	True	string
Sequence	sequence	True	integer	Ezzel a mezővel sorszámot rendelhet egy címzetthez a címzettek listájában. Használjon egyedi sorszámokat az egyes felekhez 1,2,3,4-től kezdve.... Ha egyetlen személy többször is megjelenik az aláírási munkafolyamatban, minden alkalommal rendeljen hozzá egy másik sorozatot, amikor a címzett ismétlődik.
signerAuthLevels	signerAuthLevel		string	Az aláíró által ellenőrzési célokra használt hitelesítési szint
Helyőrző	isPlaceholder		boolean	Ezzel a mezővel kezdeményezheti, hogy a fél helyőrző legyen. Megjegyzés: 1. A firstName, a lastName és a emailId paraméter értékének üresnek kell lennie a féltől. 2. A helyőrző hozzáadásához egy címzettet újra kell adni "PARTY_ASSIGNER" engedéllyel.
Címzett szerepkör	partyRole		string	Ezzel a mezővel helyőrző szerepkört rendelhet hozzá.
Névváltoztatás engedélyezése	allowNameChange		string	Az érték lehet igaz vagy hamis: Ez a paraméter lehetővé teszi, hogy az aláíró az aláírási folyamat befejezése előtt frissítse az utónevet és a vezetéknevet.
Munkafolyamat-sorozat	workflowSequence		integer	Munkafolyamat-sorszám hozzárendelése ehhez a címzetthez. Ha engedélyezve van a bejelentkezési sorrend, a címzettek növekvő sorrendben kapják meg az aláírási meghívást.
Gazdagép e-mail-azonosítója	hostEmailId		string	In-Person rendszergazda e-mail-címe.
Hozzáférési kód	userDefinedAccessCode		string	A paraméter hozzáférési kódot fog tartalmazni, ha a "signerAuthLevel" érték "Felhasználó által definiált hozzáférési kódként" van beállítva a hitelesítéshez. Megjegyzés: 1. A kódok nem megkülönböztetik a kis- és nagybetűket. 2. A rendszer nem küldi el ezt a kódot, ezért ezt a kódot közvetlenül meg kell osztania az aláíróval. 3. A hozzáférési kód tartalmazhat ábécéket, számokat és a következő speciális karaktereket: @,&;,{,}%,(,),~,|,!,+,^.
Fél az e-mail-csoport	partyIsEmailGroup		boolean	Ezt a paramétert akkor használja, ha tömegesen hoz létre egy partit. Megjegyzés: Ha ez a paraméter igaz, a rendszer figyelmen kívül hagyja a fél vezetéknevét, vezetéknevét és e-mail-azonosítóját.
E-mail-csoport azonosítója	emailGroupId		integer	Adja meg az e-mail-címet a csoportos létrehozáshoz használni kívánt csoportazonosítónak.
Egyszeri aláíró tömeges	allowSingleSignerInBulk		boolean	Ezzel a paraméterlel csak egy személy jelentkezhet be e-mail-csoportba.
Tárcsázási kód	dialingCode		string	Ezzel a mezővel az ország betárcsázási kódjai mobilszám-előtagok a címzettek listájában.
Mobilszám	mobileNumber		string	Ezzel a mezővel mobilszámot rendelhet egy címzetthez a címzettek listájában.
Mezők	Fields		object
Küldés most	sendNow		boolean	Ha engedélyezve van, a Foxit eSign azonnal egyedi aláírási hivatkozást küld az egyes címzettek e-mail-címére. Tiltsa le ezt a műveletet a boríték piszkozatként való mentéséhez.
Beágyazott aláíró munkamenet létrehozása	createEmbeddedSigningSession	True	boolean	Az aláíró munkamenet-jogkivonat anélkül jön létre, hogy e-maileket küldene a címzetteknek.
Beágyazott aláírási munkamenet létrehozása minden fél számára	createEmbeddedSigningSessionForAllParties		boolean	Ha igaz értékre van állítva, a boríték minden címzettje számára létrejön egy beágyazott aláírási URL-cím.
Szövegcímkék feldolgozása	processTextTags	True	boolean	Az érték lehet igaz vagy hamis. Ez a mező határozza meg, hogy a Foxit eSign elemezze-e a szövegcímkék dokumentumait, hogy foxit eSign mezőkké alakítsa őket.
Acro-mezők feldolgozása	processAcroFields	True	boolean	Ez a mező határozza meg, hogy a Foxit eSign elemezze-e az AcroFields dokumentumait, hogy foxit eSign mezőkké alakítsa őket.
Bejelentkezési sorrend	signInSequence		boolean	Ez a mező határozza meg, hogy a címzettek egymás után fogják-e aláírni a borítékdokumentumokat. Ha hamis, akkor az összes címzett egyidejűleg kap meghívó e-mailt. Ha igaz, akkor az egyes címzettek egymás után kapnak meghívó e-mailt, miután az előző címzett elvégezte a szükséges feladatot, például a dokumentumok aláírását vagy a mezők kitöltését stb.
Személyes engedélyezés	inPersonEnable		boolean	Ez a mező arra szolgál, hogy elindítsa a személyes aláírási folyamatot, amely percek alatt bármilyen eszközön egyszerűen elvégezhető, és szükség esetén elkerüli az e-mail-alapú aláírásokat. Ha hamis, akkor az összes címzett egyidejűleg megkapja a meghívó e-mailt. Ha igaz, akkor a személyes rendszergazda egy meghívó e-mailt kap az aláíró aláírási folyamatának elindításához.
Címzett felek javítása	fixRecipientParties		boolean	Ha igaz, akkor a beágyazott küldési nézetben nem módosíthatók a borítékhoz tartozó felek, amelyeket a kérés részeként már hozzáadtak.
Dokumentumok javítása	fixDocuments		boolean	Ha igaz, akkor a beágyazott küldés nem tudja módosítani a borítékhoz tartozó dokumentumokat, amelyeket a kérés részeként már hozzáadtak.
Sikeres küldés URL-címe	sendSuccessUrl		string	Adja meg a kezdőlap abszolút URL-címét, amelyre az aláíró a mappa beágyazott küldő nézetben való sikeres elküldése után lesz átirányítva.
Küldési hiba URL-címe	sendErrorUrl		string	Adja meg a kezdőlap abszolút URL-címét, amelyre a rendszer átirányítja az aláírót, ha hiba történik a mappa beágyazott küldő nézetben való elküldése során.
Beágyazott küldési munkamenet létrehozása	createEmbeddedSendingSession		boolean	Ha igaz értékre van állítva, beágyazott jogkivonatot hoz létre a Foxit eSign dokumentumelőkészítő nézetének megnyitásához.
Beágyazott aláírók e-mail-azonosítói	embeddedSignersEmailIds		array of string	Azoknak a címzetteknek az e-mail-azonosítóit tartalmazó tömb, akiknek létre kell hoznia egy beágyazott aláíró munkamenetet. A felek listájában szereplő címzett felek e-mail-azonosítói.
Sikeres aláírás URL-címe	signSuccessUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a beágyazott aláíró nézetben való sikeres bejelentkezés után átirányítja a rendszer.
Aláírás elutasításának URL-címe	signDeclineUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre átirányítja a rendszer, ha nem jelentkezik be beágyazott aláíró nézetben.
Későbbi aláírás URL-címe	signLaterUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a rendszer átirányítja, ha később a beágyazott aláíró nézetben szeretne bejelentkezni.
Aláírási hiba URL-címe	signErrorUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a rendszer átirányítja, ha hiba történik a dokumentum beágyazott aláíró nézetben való aláírása során.
Küldés és beágyazott aláírási munkamenet engedélyezése	allowSendNowAndEmbeddedSigningSession		boolean	Ha igaz értékre van állítva, a Foxit eSign egyedi aláírási hivatkozást küld az egyes címzetteknek. Ez CSAK akkor alkalmazható, ha a sendNow és a createEmbeddedSigningSession paraméter igaz.
Speciális e-mail-ellenőrzés	allowAdvancedEmailValidation		boolean	Ellenőrizze a felek e-mail-címét, ha igazként van beállítva.
Sikeres aláírás URL-címe minden fél számára	signSuccessUrlAllParties		boolean	Ha igaz értékre van állítva, a rendszer a sikeres aláírás után átirányítja az aláírót a signSuccessUrlban megadott URL-címre. Ez csak akkor alkalmazható, ha a sendNow igaz.
E-mail-sablon azonosítója	emailTemplateId		integer	Adja meg az e-mail-sablon azonosítóját az alapértelmezett e-mail-sablonoktól eltérő e-mail-sablonok küldéséhez.
Aláíró utasításazonosítója	signerInstructionId		integer	Adja meg az utasításazonosítót az aláírók alapértelmezett utasításaitól eltérő utasítások küldéséhez.
Megerősítő utasítás azonosítója	confirmationInstructionId		string	Adja meg a megerősítő utasítás azonosítóját, hogy az alapértelmezett megerősítési utasításoktól eltérő megerősítési utasításokat küldjön.
Téma színe	themeColor		string	Adja meg a CSS-értéket a téma színének beállításához.
A munkamenet lejár	sessionExpire		boolean	Állítsa igaz értékre a beágyazott aláírási munkamenet lejáratának elindításához.
Lejárat	expiry		integer	Akkor szükséges, ha a sessionExpire igaz. Adja meg az időtartamot a beágyazott aláírási munkamenet lejáratának ezredmásodpercében.
Függő mező neve	dependentFieldName	True	string	Annak a mezőnek a neve, amelynek láthatóságát a szülőmező vezérli.
Szülőmező neve	parentFieldName	True	string	Annak a szülőmezőnek a neve, amelynek értéke szabályozza a függő mező láthatóságát. Támogatott szülőmezőtípusok: szövegmező, szövegmező, jelölőnégyzet, választógomb, legördülő lista.
Szülőmező értéke	parentFieldValue	True	string	Annak a szülőmezőnek az értéke, amely a függő mezőt aktiválja, hogy láthatóvá váljon. A jelölőnégyzet és a választógomb mezőinél használja a bejelölt vagy a bejelöletlen jelölőnégyzetet.
Beállítások	options	True	string	További egyeztetési lehetőségek szövegalapú szülőmezőkhöz. Elfogadott értékek: isblank, allowNull, contains.
Metadaták	metadata		object	Ennek kulcsérték-párban kell lennie. Legfeljebb 1000 kulcsértékpár engedélyezett.
Feladó e-mail-címe	senderEmail		string	adja meg egy másik felhasználó e-mail-címét a fiókjában, amelyet a dokumentum(ok) mappa címzett feleknek való elküldéséhez használunk.
A Hozzáadás gomb elrejtése	hideAddMeButton		boolean	Ha igaz, elrejti a "Hozzáadás" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Új hozzáadása gomb elrejtése	hideAddNewButton		boolean	Ha igaz, elrejti az "Új hozzáadása" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Csoport hozzáadása gomb elrejtése	hideAddGroupButton		boolean	Ha igaz, elrejti a "Csoport hozzáadása" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Címzettek mezőnevének elrejtése	hideFieldNameForRecipients		boolean	Adatbeviteli mezők és speciális mezők címzettjeinek mezőneveinek elrejtése. (Kivéve a választógombot, a jelölőnégyzetet, a képet és a hivatkozást).
Jelölőnégyzetszegély elrejtése	hideCheckboxBorder		boolean	A jelölőnégyzet szegélyei el lesznek rejtve a végrehajtott dokumentumokban.
Aláíró kijelölése lehetőség elrejtése	hideSignerSelectOption		boolean	Ha igaz, elrejti a "Meglévő aláíró neve/e-mail" beviteli mezőt a címzett feleken egy beágyazott küldési munkamenetben.
Aláírói műveletek elrejtése	hideSignerActions		boolean	Ha igaz, elrejti az aláíró "szerkesztés", "módosítás" és "eltávolítás" műveleteit a címzett feleken egy beágyazott küldési munkamenetben.
Feladó nevének elrejtése	hideSenderName		boolean	Ha igaz, egy beágyazott küldési munkamenetben elrejti a feladó nevét a címzett felek között.
Mappanév elrejtése	hideFolderName		boolean	Ha igaz, mindkét beágyazott munkamenetben elrejti a mappa nevét a navigációs sávon.
Dokumentumok nevének elrejtése	hideDocumentsName		boolean	Ha igaz, mindkét beágyazott munkamenetben elrejti a dokumentum nevét.
Elutasítás elrejtése aláíráshoz	hideDeclineToSign		boolean	Ha igaz, elrejti a "Megtagadás az aláírástól" lehetőséget az aláíró számára.
További műveletek elrejtése	hideMoreAction		boolean	Ha igaz, elrejti a "További műveletek" gombot a küldési/aláírási munkamenetben. A "Küldés most": igaz, nem rejt el semmit.
Küldés elrejtése gomb	hideSendButton		boolean	Ha igaz, elrejti a Küldés gombot a beágyazott küldési munkamenetben.
Következő kötelező mezőbtn elrejtése	hideNextRequiredFieldbtn		boolean	Ha igaz értékre van állítva, elrejti a navigációs gombot, amely az aláírókat a következő kötelező mezőre helyezi át.
Mindkét beágyazott munkamenetre szükség van	requiredBothEmbeddedSession		boolean	Ha igaz, a beágyazott küldési és aláírási URL-címeket együtt hozza létre.
Borítékjelszó	folderPassword		string	Ezt a jelszót az aláírónak/szerzőnek kell megadnia a digitálisan aláírt dokumentum megnyitásához. Ha a paraméter üresen marad, akkor a digitálisan aláírt dokumentum megnyitásához nincs szükség jelszóra.
Engedélyezés lépésről lépésre	enableStepByStep		boolean	Lépésenkénti művelet engedélyezése a beágyazott küldési munkamenetben.
A Felek hozzáadása beállítás elrejtése	hideAddPartiesOption		boolean	Ha igaz, elrejti a felek hozzáadásának lehetőségét Piszkozat- és sablonlétrehozási módban.
Önaláírás	selfSign		boolean	Lehetővé teszi a beágyazott önaláírást API-k használatával. Ez a paraméter csak akkor alkalmazható, ha a createEmbeddedSendingSession paraméter igaz.
Önaláírás sikeres url-címe	selfSignerSuccessUrl		string	Adja meg a webhely/alkalmazás kezdőlapjának abszolút URL-címét, amelyre a rendszer átirányítja a felhasználót, miután sikeresen önaláírta a mappát a beágyazott küldési nézetben.

Válaszok

Name	Elérési út	Típus	Description
azonosító	folder.folderId	integer	Az újonnan létrehozott boríték egyedi azonosítója. Ezt a borítékra való hivatkozáshoz használja a következő műveletekben.
Név	folder.folderName	string	Az újonnan létrehozott boríték neve.
Egyéni név	folder.folderCustomName	string	A boríték egyéni neve.
Password	folder.folderPassword	string	Ha be van állítva a boríték hozzáférési jelszava.
Létrehozó azonosítója	folder.folderAuthorId	integer	A boríték létrehozójának egyedi azonosítója.
Létrehozó utóneve	folder.folderAuthorFirstName	string	A borítékkészítő utóneve.
Létrehozó vezetékneve	folder.folderAuthorLastName	string	A borítékkészítő vezetékneve.
Létrehozó e-mail-címe	folder.folderAuthorEmail	string	A borítékkészítő e-mail-címe.
Létrehozói szerepkör	folder.folderAuthorRole	string	A borítékkészítő szerepe.
Cégazonosító	folder.folderCompanyId	integer	A borítékot birtokoló vállalat egyedi azonosítója.
Létrehozás dátuma	folder.folderCreationDate	integer	A boríték létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Elküldött dátum	folder.folderSentDate	integer	A boríték elküldésének dátuma (Unix időbélyeg ezredmásodpercben).
Status	folder.folderStatus	string	A boríték aktuális állapota.
Egyéni mező 1	folder.custom_field1	string	A boríték első egyéni metaadatmezője.
Egyéni mező 2	folder.custom_field2	string	A boríték második egyéni metaadatmezője.
Metadaták	folder.metadata	string	A borítékhoz társított egyéni metaadatok.
Dokumentumazonosítók	folder.folderDocumentIds	array of integer	A borítékban található dokumentumazonosítók listája.
Documents	folder.documentsList	array of object	A borítékban lévő dokumentumok listája.
Dokumentumazonosító	folder.documentsList.documentId	integer	A dokumentum egyedi azonosítója.
Szerződés azonosítója	folder.documentsList.contractId	integer	A szerződés egyedi azonosítója.
Cégazonosító	folder.documentsList.companyId	integer	A vállalat egyedi azonosítója.
Készítette:	folder.documentsList.contractCreatedBy	integer	A szerződést létrehozó személy felhasználói azonosítója.
Létrehozás dátuma:	folder.documentsList.contractCreatedOn	string	A szerződés létrehozásának dátuma és időpontja.
Szerződés típusa	folder.documentsList.contractType	string	A szerződés típusa.
Szerződés állapota	folder.documentsList.contractStatus	string	A szerződés aktuális állapota.
Módosítható	folder.documentsList.editable	boolean	Azt jelzi, hogy az elem szerkeszthető-e.
Verzióazonosító	folder.documentsList.contractVersionId	integer	A szerződés verziójának egyedi azonosítója.
Verzió neve	folder.documentsList.contractVersionName	string	A szerződés verziójának neve.
Verzió leírása	folder.documentsList.contractVersionDesc	string	A szerződés verziójának leírása.
Által létrehozott verzió	folder.documentsList.versionCreatedby	integer	A verziót létrehozó személy felhasználói azonosítója.
Verzió:	folder.documentsList.versionCreatedOn	string	A verzió létrehozásának dátuma és időpontja.
Verziószám	folder.documentsList.contractVersionNumber	integer	A szerződés verziószáma.
Tranzakció forrása	folder.documentsList.contractTransactionSource	string	A szerződéstranzakciót kezdeményező forrásrendszer.
Címzettek	folder.folderRecipientParties	array of object	A boríték címzettjeinek listája.
Címzett azonosítója	folder.folderRecipientParties.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	folder.folderRecipientParties.partyDetails.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	folder.folderRecipientParties.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	folder.folderRecipientParties.partyDetails.lastName	string	A címzett vezetékneve.
E-mail-cím	folder.folderRecipientParties.partyDetails.emailId	string	A címzett e-mail-címe.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Azt jelzi, hogy ez a fél helyőrző címzett-e.
Address	folder.folderRecipientParties.partyDetails.address	string	A címzett fizikai címe.
Létrehozás dátuma	folder.folderRecipientParties.partyDetails.dateCreated	integer	A rekord létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
E-mailek letiltása	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Jelzi, hogy a címzett lemondta-e az e-mail-értesítéseket.
Egyedi címzett-azonosító	folder.folderRecipientParties.partyDetails.uniquePartyId	string	A címzett egyedi rendszerazonosítója.
Hitelesítési szint	folder.folderRecipientParties.partyDetails.authenticationLevel	string	A címzetthez szükséges hitelesítési módszer.
Jelszó frissítése dátuma	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A jelszó utolsó frissítésének dátuma.
Jelszóval frissített állapot	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Azt jelzi, hogy a jelszó frissült-e.
Cégazonosító	folder.folderRecipientParties.partyDetails.companyId	integer	A vállalat egyedi azonosítója.
Felhasználói szerepkör	folder.folderRecipientParties.partyDetails.userRole	string	A felhasználóhoz rendelt szerepkör.
Department	folder.folderRecipientParties.partyDetails.department	string	Az a részleg, amelyhez a felhasználó tartozik.
Cím	folder.folderRecipientParties.partyDetails.title	string	A felhasználó beosztása.
Aktív	folder.folderRecipientParties.partyDetails.active	boolean	Azt jelzi, hogy a felhasználó vagy a rekord aktív-e.
Helyszín	folder.folderRecipientParties.partyDetails.requestLocale	string	A felhasználó területi beállítása.
Megosztás a Depttel	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Azt jelzi, hogy a borítékok meg vannak-e osztva a részlegen.
Tárcsázási kód	folder.folderRecipientParties.partyDetails.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.folderRecipientParties.partyDetails.mobileNumber	string	A mobiltelefonszám.
Állapotszűrő	folder.folderRecipientParties.partyDetails.docStatusFilter	string	A dokumentum állapotának szűrője.
Dátumszűrő	folder.folderRecipientParties.partyDetails.docDateFilter	string	A dokumentumdátum szűrője.
Biztonságos mezőhozzáférés	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Azt jelzi, hogy a felhasználó rendelkezik-e hozzáféréssel a biztonságos mezőkhöz.
Oldalsáv kibontása	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Azt jelzi, hogy az oldalsáv alapértelmezés szerint ki van-e bontva.
Adv. E-mail-ellenőrzés	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Azt jelzi, hogy engedélyezve van-e a speciális e-mail-ellenőrzés.
Vezető azonosítója	folder.folderRecipientParties.partyDetails.managerId	string	A felhasználó kezelőjének egyedi azonosítója.
Bejelentkezések száma	folder.folderRecipientParties.partyDetails.loginCount	integer	A felhasználó által bejelentkezett alkalmak száma.
E-mail jelszó kérése	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Azt jelzi, hogy a jelszó-visszaállítási e-mailt kell-e küldeni.
Részlegazonosító	folder.folderRecipientParties.partyDetails.departmentId	string	A részleg egyedi azonosítója.
Elsődleges vállalat	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	A felhasználóhoz társított elsődleges vállalat.
Eszköz típusa	folder.folderRecipientParties.partyDetails.deviceType	string	A használt eszköz típusa.
Eszközjogkivonat	folder.folderRecipientParties.partyDetails.deviceToken	string	Az eszköz leküldéses értesítési jogkivonata.
Alvállalkozó leírása	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Az alvállalkozó vagy a külső aláíró leírása.
Alvállalkozói szervezet	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Az alvállalkozó vagy külső aláíró szervezetneve.
Alvállalkozó hozzáadott dátuma	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Az alvállalkozó hozzáadásának dátuma (Unix időbélyeg ezredmásodpercben).
Forrás	folder.folderRecipientParties.partyDetails.source	string	A forrásrendszer, amelyből a külső aláírót hozzáadták.
Tárcsázási kód	folder.folderRecipientParties.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.folderRecipientParties.mobileNumber	string	A mobiltelefonszám.
Aláírás típusa	folder.folderRecipientParties.signerSignatureType	string	Az aláíró által használt aláírás típusa.
Jogosultságok	folder.folderRecipientParties.contractPermissions	string	A feleknek a szerződéshez adott engedélyek.
Aláírási rendelés	folder.folderRecipientParties.partySequence	integer	A címzett aláírási rendelésének sorszáma.
Munkafolyamat-sorozat	folder.folderRecipientParties.workflowSignSequence	integer	A munkafolyamat aláírási sorszáma.
Boríték azonosítója	folder.folderRecipientParties.envelopeId	integer	A boríték egyedi azonosítója.
Címzett cégazonosítója	folder.folderRecipientParties.partyCompanyId	integer	A címzetthez társított vállalat egyedi azonosítója.
Megosztási mód	folder.folderRecipientParties.sharingMode	string	A boríték megosztási módja.
Címzett hozzáférési URL-címe	folder.folderRecipientParties.folderAccessURL	string	A címzett által a boríték elérésére és aláírására használható URL-cím.
Biztonsági mód	folder.folderRecipientParties.securityMode	string	A borítékra alkalmazott biztonsági mód.
Comments	folder.folderRecipientParties.extraComments	string	További megjegyzések a borítékban.
Névváltoztatás engedélyezése	folder.folderRecipientParties.allowNameChange	boolean	Azt jelzi, hogy a címzett frissítheti-e a nevét.
Név frissítve	folder.folderRecipientParties.signerNameUpdated	boolean	Azt jelzi, hogy az aláíró frissítette-e a nevét.
Aláíró hitelesítési szintje	folder.folderRecipientParties.signerAuthenticationLevel	string	Az aláíróhoz szükséges hitelesítési szint.
Hozzáférési kód	folder.folderRecipientParties.userDefinedAccessCode	string	Az aláíróhoz definiált egyéni hozzáférési kód.
Aláírás azonosítója	folder.folderRecipientParties.signatureId	string	Az aláírás egyedi azonosítója.
Címzett szerepkör	folder.folderRecipientParties.partyRole	string	A címzetthez rendelt szerepkör az aláírási munkafolyamatban.
Céges mező	folder.folderRecipientParties.companyFieldValue	string	A cégnév mező értéke az aláírásban.
Címmező	folder.folderRecipientParties.titleFieldValue	string	Az aláírás címmezőjének értéke.
Az aláírás oka	folder.folderRecipientParties.reasonSigning	string	A címzett aláírásának oka.
Fizetési mező hozzáadva	folder.folderRecipientParties.payFieldAdded	boolean	Azt jelzi, hogy egy fizetési mező lett-e hozzáadva.
Kedvezményezett	folder.folderRecipientParties.payee	boolean	Azt jelzi, hogy ez a címzett-e a kedvezményezett.
Ismétlődő fizetés	folder.folderRecipientParties.recurringFieldExist	boolean	Azt jelzi, hogy létezik-e ismétlődő fizetési mező.
Nyomtatás és aláírás kész	folder.folderRecipientParties.printAndSignCompleted	boolean	Azt jelzi, hogy a nyomtatási és aláírási folyamat befejeződött-e.
Paid	folder.folderRecipientParties.paid	boolean	Jelzi, hogy a fizetés befejeződött-e.
Választható aláíró engedélyezett	folder.folderRecipientParties.allowOptionalSigner	boolean	Azt jelzi, hogy ez a címzett nem kötelező aláíró-e.
Választható aláírók	folder.folderRecipientParties.optionalSigners	array of integer	A boríték opcionális aláíró félazonosítóinak listája.
Szerző aláírási URL-címe	folder.folderAccessURLForAuthor	string	A feladó által a boríték eléréséhez használható URL-cím.
Hozzáférési url-cím piszkozata	folder.draftFolderAccessURL	string	A boríték piszkozatverziójának eléréséhez használt URL-cím.
Társasszoba aláírása	folder.boardRoomSign	boolean	Azt jelzi, hogy engedélyezve van-e a táblaszoba-aláírási mód.
Embléma belefoglalása	folder.includeLogo	boolean	Jelzi, hogy a cég emblémája szerepel-e az e-mailekben.
Gomb háttérszíne	folder.email_btnBgColor	string	Az e-mail gomb háttérszíne.
Gomb szövegszíne	folder.email_btnTxtColor	string	Az e-mail gomb szövegszíne.
E-mail e-mail e-	folder.emailTemplateLogo	string	Az e-mail-sablonban használt e-mail URL-cím.
E-mail-sablon azonosítója	folder.emailTemplateId	integer	Az e-mail-sablon egyedi azonosítója.
E-mail fejléc	folder.emailHeader	string	Az értesítési e-mailekben használt fejlécszöveg.
E-mail élőláb	folder.emailFooter	string	Az értesítési e-mailekben használt élőláb szövege.
Ütemezett törlés	folder.purgeFlag	boolean	Azt jelzi, hogy a boríték törlésre van-e ütemezve.
Törlés kezdő dátuma	folder.purgeStartDate	string	A törlés ütemezésének dátuma.
Végdátum törlése	folder.purgeEndDate	string	A törlés ütemezésének dátuma.
Tömeges küldés azonosítója	folder.bulkId	integer	A tömeges küldési művelet egyedi azonosítója.
Előrendelés kényszerítése	folder.enforceSignWorkflow	boolean	Azt jelzi, hogy a címzetteknek be kell-e jelentkezniük a megadott sorrendbe.
Aktuális lépés	folder.currentWorkflowStep	integer	Az aláírási munkafolyamat aktuális lépése.
Tranzakció forrása	folder.transactionSource	string	A tranzakciót kezdeményező forrásrendszer.
Módosítható	folder.editable	boolean	Azt jelzi, hogy az elem szerkeszthető-e.
In-Person aláírása	folder.inPersonSignable	boolean	Jelzi, hogy a borítékot személyesen lehet-e aláírni.
Emlékeztetők felülbírálása	folder.overrideAccountReminders	boolean	Azt jelzi, hogy a fiókszintű emlékeztető beállításai felül vannak-e bírálva.
Delegálás felülbírálása	folder.overrideAccountRecipientDelegation	boolean	Azt jelzi, hogy a fiókszintű delegálási beállítások felül vannak-e bírálva.
Delegálás engedélyezése	folder.allowRecipientsToDelegate	boolean	Azt jelzi, hogy a címzettek delegálhatják-e az aláírást.
azonosító	folder.envelopeId	integer	A boríték egyedi azonosítója.
Név	folder.envelopeName	string	A boríték neve.
Kezdeményező azonosítója	folder.envelopeOriginatorId	integer	A borítékot létrehozó felhasználó egyedi azonosítója.
Cégazonosító	folder.envelopeCompanyId	integer	A borítékot birtokoló vállalat egyedi azonosítója.
Date	folder.envelopeDate	integer	A boríték létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Megosztott dátum	folder.envelopeSharedDate	integer	A boríték megosztásának dátuma (Unix időbélyeg ezredmásodpercben).
Status	folder.envelopeStatus	string	A boríték aktuális állapota.
Szerződésazonosítók	folder.envelopeContractIds	array of integer	A borítékhoz társított szerződésazonosítók listája.
Címzett engedélyei	folder.envelopePartyPermissions	array of object	A boríték címzett engedélyeinek listája.
Címzett azonosítója	folder.envelopePartyPermissions.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	folder.envelopePartyPermissions.partyDetails.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	folder.envelopePartyPermissions.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	folder.envelopePartyPermissions.partyDetails.lastName	string	A címzett vezetékneve.
E-mail-cím	folder.envelopePartyPermissions.partyDetails.emailId	string	A címzett e-mail-címe.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Azt jelzi, hogy ez a fél helyőrző címzett-e.
Address	folder.envelopePartyPermissions.partyDetails.address	string	A címzett fizikai címe.
Létrehozás dátuma	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	A rekord létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
E-mailek letiltása	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Jelzi, hogy a címzett lemondta-e az e-mail-értesítéseket.
Egyedi címzett-azonosító	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	A címzett egyedi rendszerazonosítója.
Hitelesítési szint	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	A címzetthez szükséges hitelesítési módszer.
Jelszó frissítése dátuma	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	A jelszó utolsó frissítésének dátuma.
Jelszóval frissített állapot	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Azt jelzi, hogy a jelszó frissült-e.
Cégazonosító	folder.envelopePartyPermissions.partyDetails.companyId	integer	A vállalat egyedi azonosítója.
Felhasználói szerepkör	folder.envelopePartyPermissions.partyDetails.userRole	string	A felhasználóhoz rendelt szerepkör.
Department	folder.envelopePartyPermissions.partyDetails.department	string	Az a részleg, amelyhez a felhasználó tartozik.
Cím	folder.envelopePartyPermissions.partyDetails.title	string	A felhasználó beosztása.
Aktív	folder.envelopePartyPermissions.partyDetails.active	boolean	Azt jelzi, hogy a felhasználó vagy a rekord aktív-e.
Helyszín	folder.envelopePartyPermissions.partyDetails.requestLocale	string	A felhasználó területi beállítása.
Megosztás a Depttel	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Azt jelzi, hogy a borítékok meg vannak-e osztva a részlegen.
Tárcsázási kód	folder.envelopePartyPermissions.partyDetails.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	A mobiltelefonszám.
Állapotszűrő	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	A dokumentum állapotának szűrője.
Dátumszűrő	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	A dokumentumdátum szűrője.
Biztonságos mezőhozzáférés	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Azt jelzi, hogy a felhasználó rendelkezik-e hozzáféréssel a biztonságos mezőkhöz.
Oldalsáv kibontása	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Azt jelzi, hogy az oldalsáv alapértelmezés szerint ki van-e bontva.
Adv. E-mail-ellenőrzés	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Azt jelzi, hogy engedélyezve van-e a speciális e-mail-ellenőrzés.
Vezető azonosítója	folder.envelopePartyPermissions.partyDetails.managerId	string	A felhasználó kezelőjének egyedi azonosítója.
Bejelentkezések száma	folder.envelopePartyPermissions.partyDetails.loginCount	integer	A felhasználó által bejelentkezett alkalmak száma.
E-mail jelszó kérése	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Azt jelzi, hogy a jelszó-visszaállítási e-mailt kell-e küldeni.
Részlegazonosító	folder.envelopePartyPermissions.partyDetails.departmentId	string	A részleg egyedi azonosítója.
Elsődleges vállalat	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	A felhasználóhoz társított elsődleges vállalat.
Eszköz típusa	folder.envelopePartyPermissions.partyDetails.deviceType	string	A használt eszköz típusa.
Eszközjogkivonat	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Az eszköz leküldéses értesítési jogkivonata.
Alvállalkozó leírása	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Az alvállalkozó vagy a külső aláíró leírása.
Alvállalkozói szervezet	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Az alvállalkozó vagy külső aláíró szervezetneve.
Alvállalkozó hozzáadott dátuma	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Az alvállalkozó hozzáadásának dátuma (Unix időbélyeg ezredmásodpercben).
Forrás	folder.envelopePartyPermissions.partyDetails.source	string	A forrásrendszer, amelyből a külső aláírót hozzáadták.
Tárcsázási kód	folder.envelopePartyPermissions.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.envelopePartyPermissions.mobileNumber	string	A mobiltelefonszám.
Aláírás típusa	folder.envelopePartyPermissions.signerSignatureType	string	Az aláíró által használt aláírás típusa.
Jogosultságok	folder.envelopePartyPermissions.contractPermissions	string	A feleknek a szerződéshez adott engedélyek.
Aláírási rendelés	folder.envelopePartyPermissions.partySequence	integer	A címzett aláírási rendelésének sorszáma.
Munkafolyamat-sorozat	folder.envelopePartyPermissions.workflowSignSequence	integer	A munkafolyamat aláírási sorszáma.
Boríték azonosítója	folder.envelopePartyPermissions.envelopeId	integer	A boríték egyedi azonosítója.
Címzett cégazonosítója	folder.envelopePartyPermissions.partyCompanyId	integer	A címzetthez társított vállalat egyedi azonosítója.
Megosztási mód	folder.envelopePartyPermissions.sharingMode	string	A boríték megosztási módja.
Címzett hozzáférési URL-címe	folder.envelopePartyPermissions.folderAccessURL	string	A címzett által a boríték elérésére és aláírására használható URL-cím.
Biztonsági mód	folder.envelopePartyPermissions.securityMode	string	A borítékra alkalmazott biztonsági mód.
Comments	folder.envelopePartyPermissions.extraComments	string	További megjegyzések a borítékban.
Névváltoztatás engedélyezése	folder.envelopePartyPermissions.allowNameChange	boolean	Azt jelzi, hogy a címzett frissítheti-e a nevét.
Név frissítve	folder.envelopePartyPermissions.signerNameUpdated	boolean	Azt jelzi, hogy az aláíró frissítette-e a nevét.
Aláíró hitelesítési szintje	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Az aláíróhoz szükséges hitelesítési szint.
Hozzáférési kód	folder.envelopePartyPermissions.userDefinedAccessCode	string	Az aláíróhoz definiált egyéni hozzáférési kód.
Aláírás azonosítója	folder.envelopePartyPermissions.signatureId	string	Az aláírás egyedi azonosítója.
Címzett szerepkör	folder.envelopePartyPermissions.partyRole	string	A címzetthez rendelt szerepkör az aláírási munkafolyamatban.
Céges mező	folder.envelopePartyPermissions.companyFieldValue	string	A cégnév mező értéke az aláírásban.
Címmező	folder.envelopePartyPermissions.titleFieldValue	string	Az aláírás címmezőjének értéke.
Az aláírás oka	folder.envelopePartyPermissions.reasonSigning	string	A címzett aláírásának oka.
Fizetési mező hozzáadva	folder.envelopePartyPermissions.payFieldAdded	boolean	Azt jelzi, hogy egy fizetési mező lett-e hozzáadva.
Kedvezményezett	folder.envelopePartyPermissions.payee	boolean	Azt jelzi, hogy ez a címzett-e a kedvezményezett.
Ismétlődő fizetés	folder.envelopePartyPermissions.recurringFieldExist	boolean	Azt jelzi, hogy létezik-e ismétlődő fizetési mező.
Nyomtatás és aláírás kész	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Azt jelzi, hogy a nyomtatási és aláírási folyamat befejeződött-e.
Paid	folder.envelopePartyPermissions.paid	boolean	Jelzi, hogy a fizetés befejeződött-e.
Hitelesítési szint	folder.envelopeAuthenticationLevel	string	A borítékhoz szükséges hitelesítési szint.
Egyszeri aláíró tömeges	folder.allowSingleSignerInBulk	boolean	Azt jelzi, hogy egyetlen aláíró engedélyezve van-e tömeges küldési módban.
File-Based elnevezése	folder.folderNameBasedOnFileNaming	boolean	Azt jelzi, hogy a mappa neve a fájlnéven alapul-e.
Dokumentum File-Based neve	folder.documentNameBasedOnFileNaming	boolean	Azt jelzi, hogy a dokumentum neve a fájlnéven alapul-e.
Tanúsítvány File-Based neve	folder.certificateNameBasedOnFileNaming	boolean	Azt jelzi, hogy a tanúsítvány neve a fájlnéven alapul-e.
Exec előtti fájlelnevezés	folder.enableFileNamingBeforeExecution	boolean	Azt jelzi, hogy engedélyezve van-e a fájlelnevezés a dokumentum végrehajtása előtt.
Kedvezményezett hozzáadva	folder.payeeAddedd	boolean	Azt jelzi, hogy a kedvezményezett hozzá lett-e adva.
Self-Signing engedélyezve	folder.selfSignerEnabled	boolean	Azt jelzi, hogy engedélyezve van-e az önaláírási mód.
Közjegyző engedélyezve	folder.notaryEnabled	boolean	Azt jelzi, hogy engedélyezve van-e a közjegyzői aláírás.
Korlátozott láthatóság	folder.limitedVisibilityFlag	boolean	Azt jelzi, hogy engedélyezve van-e a korlátozott láthatóság ehhez a borítékhoz.
Aláírás utáni láthatóság	folder.postSigningVisibility	boolean	Azt jelzi, hogy engedélyezve van-e az aláírás utáni láthatóság.
Nedves aláírás	folder.wetSignatureEnabled	boolean	Azt jelzi, hogy engedélyezve vannak-e a nedves aláírások.
Egyesítés engedélyezve	folder.mergeEnabled	boolean	Azt jelzi, hogy engedélyezve van-e a dokumentumegyesítés.
Beágyazott aláíró munkamenetek	embeddedSigningSessions	array of object	A beágyazott aláíró munkamenetek listája, címzettenként egy. Csak akkor jelenik meg, ha a createEmbeddedSigningSession igaz.
Aláíró e-mail-címe	embeddedSigningSessions.emailIdOfSigner	string	A beágyazott aláíró munkamenet címzettjének e-mail-címe.
Aláírási jogkivonat	embeddedSigningSessions.embeddedToken	string	A címzett beágyazott aláíró munkamenetének egyedi jogkivonata.
Aláíró munkamenet URL-címe	embeddedSigningSessions.embeddedSessionURL	string	A címzett számára a dokumentum aláírásához megnyitni vagy beágyazni kívánt URL-cím.
Beágyazott küldési jogkivonat	embeddedToken	string	A beágyazott küldési munkamenet jogkivonata. Csak akkor jelenik meg, ha a createEmbeddedSendingSession igaz.
Munkamenet URL-címének küldése	embeddedSessionURL	string	A boríték készítőjének a boríték elkészítéséhez és elküldéséhez szükséges URL-cím. Csak akkor jelenik meg, ha a createEmbeddedSendingSession igaz.
Result	result	string	A művelet eredménye.
Message	message	string	A művelet eredményét leíró üzenet.

Boríték létrehozása sablonból

Műveletazonosító:

CreateEnvelopefromTemplate

Egy meglévő sablonnal hoz létre és küld el egy borítékot. A címzett adatai testre szabhatók.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték neve	folderName		string	A dokumentum(ok) mappa neve. Ha ez az érték nincs megadva, akkor a dokumentum(ok) mappaneve megegyezik a sablon(ok) nevével.
Sablonazonosítók	templateIds	True	array of integer	A mappa dokumentumainak létrehozásához használni kívánt sablonazonosítók tömbje.
Mezők	fields		object	Átadhatja a sablonokban használt mezőértékeket, hogy előre kitöltse őket a sablonból létrehozott dokumentumokban. FIELD_NAME a sablonban használt mező neve. FIELD_VALUE a dokumentummező értéke.
Speciális e-mail-ellenőrzés	allowAdvancedEmailValidation		boolean	Ellenőrizze a felek e-mail-címét, ha igazként van beállítva.
Keresztnév	firstName	True	string	A címzett utóneve.
Vezetéknév	lastName	True	string	A címzett vezetékneve.
E-mail-cím	emailId	True	string	A címzett e-mail-címe.
engedélyek	permission	True	string
Sequence	sequence	True	integer	Ezzel a mezővel sorszámot rendelhet egy címzetthez a címzettek listájában. Használjon egyedi sorszámokat az egyes felekhez 1,2,3,4-től kezdve.... Ha egyetlen személy többször is megjelenik az aláírási munkafolyamatban, minden alkalommal rendeljen hozzá egy másik sorozatot, amikor a címzett ismétlődik.
signerAuthLevels	signerAuthLevel		string	Az aláíró által ellenőrzési célokra használt hitelesítési szint
Helyőrző	isPlaceholder		boolean	Ezzel a mezővel kezdeményezheti, hogy a fél helyőrző legyen. Megjegyzés: 1. A firstName, a lastName és a emailId paraméter értékének üresnek kell lennie a féltől. 2. A helyőrző hozzáadásához egy címzettet újra kell adni "PARTY_ASSIGNER" engedéllyel.
Címzett szerepkör	partyRole		string	Ezzel a mezővel helyőrző szerepkört rendelhet hozzá.
Névváltoztatás engedélyezése	allowNameChange		string	Az érték lehet igaz vagy hamis: Ez a paraméter lehetővé teszi, hogy az aláíró az aláírási folyamat befejezése előtt frissítse az utónevet és a vezetéknevet.
Munkafolyamat-sorozat	workflowSequence		integer	Munkafolyamat-sorszám hozzárendelése ehhez a címzetthez. Ha engedélyezve van a bejelentkezési sorrend, a címzettek növekvő sorrendben kapják meg az aláírási meghívást.
Gazdagép e-mail-azonosítója	hostEmailId		string	In-Person rendszergazda e-mail-címe.
Hozzáférési kód	userDefinedAccessCode		string	A paraméter hozzáférési kódot fog tartalmazni, ha a "signerAuthLevel" érték "Felhasználó által definiált hozzáférési kódként" van beállítva a hitelesítéshez. Megjegyzés: 1. A kódok nem megkülönböztetik a kis- és nagybetűket. 2. A rendszer nem küldi el ezt a kódot, ezért ezt a kódot közvetlenül meg kell osztania az aláíróval. 3. A hozzáférési kód tartalmazhat ábécéket, számokat és a következő speciális karaktereket: @,&;,{,}%,(,),~,|,!,+,^.
Fél az e-mail-csoport	partyIsEmailGroup		boolean	Ezt a paramétert akkor használja, ha tömegesen hoz létre egy partit. Megjegyzés: Ha ez a paraméter igaz, a rendszer figyelmen kívül hagyja a fél vezetéknevét, vezetéknevét és e-mail-azonosítóját.
E-mail-csoport azonosítója	emailGroupId		integer	Adja meg az e-mail-címet a csoportos létrehozáshoz használni kívánt csoportazonosítónak.
Egyszeri aláíró tömeges	allowSingleSignerInBulk		boolean	Ezzel a paraméterlel csak egy személy jelentkezhet be e-mail-csoportba.
Tárcsázási kód	dialingCode		string	Ezzel a mezővel az ország betárcsázási kódjai mobilszám-előtagok a címzettek listájában.
Mobilszám	mobileNumber		string	Ezzel a mezővel mobilszámot rendelhet egy címzetthez a címzettek listájában.
Borítékjelszó	folderPassword		string	Ezt a jelszót az aláírónak/szerzőnek kell megadnia a digitálisan aláírt dokumentum megnyitásához. Ha a paraméter üresen marad, akkor a digitálisan aláírt dokumentum megnyitásához nincs szükség jelszóra.
Bejelentkezési sorrend	signInSequence		boolean	Ez a mező határozza meg, hogy a címzettek egymás után fogják-e aláírni a borítékdokumentumokat. Ha hamis, akkor az összes címzett egyidejűleg kap meghívó e-mailt. Ha igaz, akkor az egyes címzettek egymás után kapnak meghívó e-mailt, miután az előző címzett elvégezte a szükséges feladatot, például a dokumentumok aláírását vagy a mezők kitöltését stb.
Személyes engedélyezés	inPersonEnable		boolean	Ez a mező arra szolgál, hogy elindítsa a személyes aláírási folyamatot, amely percek alatt bármilyen eszközön egyszerűen elvégezhető, és szükség esetén elkerüli az e-mail-alapú aláírásokat. Ha hamis, akkor az összes címzett egyidejűleg megkapja a meghívó e-mailt. Ha igaz, akkor a személyes rendszergazda egy meghívó e-mailt kap az aláíró aláírási folyamatának elindításához.
Küldés most	sendNow		boolean	Ha engedélyezve van, a Foxit eSign azonnal egyedi aláírási hivatkozást küld az egyes címzettek e-mail-címére. Tiltsa le ezt a műveletet a boríték piszkozatként való mentéséhez.
Sikeres aláírás URL-címe minden fél számára	signSuccessUrlAllParties		boolean	Ha igaz értékre van állítva, a rendszer a sikeres aláírás után átirányítja az aláírót a signSuccessUrlban megadott URL-címre. Ez csak akkor alkalmazható, ha a sendNow igaz.
Beágyazott küldési munkamenet létrehozása	createEmbeddedSendingSession		boolean	Ha igaz értékre van állítva, beágyazott URL-címet hoz létre a Foxit eSign dokumentumelőkészítő nézetének megnyitásához.
Címzett felek javítása	fixRecipientParties		boolean	Ha igaz, akkor a beágyazott küldési nézetben nem módosíthatók a borítékhoz tartozó felek, amelyeket a kérés részeként már hozzáadtak.
Dokumentumok javítása	fixDocuments		boolean	Ha igaz, akkor a beágyazott küldés nem tudja módosítani a borítékhoz tartozó dokumentumokat, amelyeket a kérés részeként már hozzáadtak.
Sikeres küldés URL-címe	sendSuccessUrl		string	Adja meg a kezdőlap abszolút URL-címét, amelyre az aláíró a mappa beágyazott küldő nézetben való sikeres elküldése után lesz átirányítva.
Küldési hiba URL-címe	sendErrorUrl		string	Adja meg a kezdőlap abszolút URL-címét, amelyre a rendszer átirányítja az aláírót, ha hiba történik a mappa beágyazott küldő nézetben való elküldése során.
Aláíró kijelölése lehetőség elrejtése	hideSignerSelectOption		boolean	Ha igaz, elrejti a "Meglévő aláíró neve/e-mail" beviteli mezőt a címzett feleken egy beágyazott küldési munkamenetben.
Aláírói műveletek elrejtése	hideSignerActions		boolean	Ha igaz, elrejti az aláíró "szerkesztés", "módosítás" és "eltávolítás" műveleteit a címzett feleken egy beágyazott küldési munkamenetben.
Feladó nevének elrejtése	hideSenderName		boolean	Ha igaz, egy beágyazott küldési munkamenetben elrejti a feladó nevét a címzett felek között.
Küldés elrejtése gomb	hideSendButton		boolean	Ha igaz, elrejti a Küldés gombot a beágyazott küldési munkamenetben.
Mappanév elrejtése	hideFolderName		boolean	Ha igaz, mindkét beágyazott munkamenetben elrejti a mappa nevét a navigációs sávon.
Dokumentumok nevének elrejtése	hideDocumentsName		boolean	Ha igaz, mindkét beágyazott munkamenetben elrejti a dokumentum nevét.
A Hozzáadás gomb elrejtése	hideAddMeButton		boolean	Ha igaz, elrejti a "Hozzáadás" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Új hozzáadása gomb elrejtése	hideAddNewButton		boolean	Ha igaz, elrejti az "Új hozzáadása" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Csoport hozzáadása gomb elrejtése	hideAddGroupButton		boolean	Ha igaz, elrejti a "Csoport hozzáadása" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Beágyazott aláíró munkamenet létrehozása	createEmbeddedSigningSession		boolean	Az aláíró munkamenet-jogkivonat anélkül jön létre, hogy e-maileket küldene a címzetteknek.
Beágyazott aláírási munkamenet létrehozása minden fél számára	createEmbeddedSigningSessionForAllParties		boolean	Ha igaz értékre van állítva, a rendszer beágyazott aláírási URL-címet hoz létre a boríték minden címzettje számára. Ha hamis, csak a beágyazott aláírók e-mail-azonosítóiban felsorolt címzettek kapnak beágyazott munkamenetet.
Beágyazott aláírók e-mail-azonosítói	embeddedSignersEmailIds		array of string	Azoknak a címzetteknek az e-mail-azonosítóit tartalmazó tömb, akiknek létre kell hoznia egy beágyazott aláíró munkamenetet. A felek listájában szereplő címzett felek e-mail-azonosítói.
Sikeres aláírás URL-címe	signSuccessUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a beágyazott aláíró nézetben való sikeres bejelentkezés után átirányítja a rendszer.
Aláírás elutasításának URL-címe	signDeclineUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre átirányítja a rendszer, ha nem jelentkezik be beágyazott aláíró nézetben.
Későbbi aláírás URL-címe	signLaterUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a rendszer átirányítja, ha később a beágyazott aláíró nézetben szeretne bejelentkezni.
Aláírási hiba URL-címe	signErrorUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a rendszer átirányítja, ha hiba történik a dokumentum beágyazott aláíró nézetben való aláírása során.
Következő kötelező mező btn elrejtése	hideNextRequiredFieldBtn		boolean	Ha igaz értékre van állítva, elrejti a navigációs gombot, amely az aláírókat a következő kötelező mezőre helyezi át.
Téma színe	themeColor		string	Adja meg a CSS-értéket a téma színének beállításához.
Elutasítás elrejtése aláíráshoz	hideDeclineToSign		boolean	Ha igaz értékre van állítva, elrejti az Aláírás elutasítása beállítást az aláírási képernyőn.
További műveletek elrejtése	hideMoreAction		boolean	Ha igaz értékre van állítva, elrejti a További műveletek gombot a küldési és aláírási munkamenetben. Nincs hatása, ha a Küldés most igaz.
A Felek hozzáadása beállítás elrejtése	hideAddPartiesOption		boolean	Ha igaz értékre van állítva, elrejti a felek hozzáadásának lehetőségét Piszkozat- és sablonlétrehozási módban.
A munkamenet lejár	sessionExpire		boolean	Állítsa igaz értékre a beágyazott aláírási munkamenet lejáratának elindításához.
Lejárat	expiry		integer	Akkor szükséges, ha a sessionExpire igaz. Adja meg az időtartamot a beágyazott aláírási munkamenet lejáratának ezredmásodpercében.
Feladó e-mail-címe	senderEmail		string	adja meg egy másik felhasználó e-mail-címét a fiókjában, amelyet a dokumentum(ok) mappa címzett feleknek való elküldéséhez használunk.
Küldés és beágyazott aláírási munkamenet engedélyezése	allowSendNowAndEmbeddedSigningSession		boolean	Ha igaz értékre van állítva, a Foxit eSign aláírási meghívó e-mailt küld minden címzettnek, és beágyazott aláíró hivatkozást is létrehoz azon címzettek számára, akiknek az e-mailje szerepel a Beágyazott aláíró e-mailben. Az e-mail és a beágyazott hivatkozás is egyszerre aktív.
Engedélyezés lépésről lépésre	enableStepByStep		boolean	Lépésenkénti művelet engedélyezése a beágyazott küldési munkamenetben.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a művelet sikeres volt-e (pl. "siker").
Message	message	string	A művelet eredményének leírása.
Beágyazott aláíró munkamenetek	embeddedSigningSessions	array of object	A beágyazott aláíró munkamenetek listája, címzettenként egy. Csak akkor jelenik meg, ha a createEmbeddedSigningSession igaz.
Aláíró e-mail-címe	embeddedSigningSessions.emailIdOfSigner	string	A beágyazott aláíró munkamenet címzettjének e-mail-címe.
Aláírási jogkivonat	embeddedSigningSessions.embeddedToken	string	A címzett beágyazott aláíró munkamenetének egyedi jogkivonata.
Aláíró munkamenet URL-címe	embeddedSigningSessions.embeddedSessionURL	string	A címzett számára a dokumentum aláírásához megnyitni vagy beágyazni kívánt URL-cím.
Beágyazott küldési jogkivonat	embeddedToken	string	A beágyazott küldési munkamenet jogkivonata. Csak akkor jelenik meg, ha a createEmbeddedSendingSession igaz.
Munkamenet URL-címének küldése	embeddedSessionURL	string	A boríték készítőjének a boríték elkészítéséhez és elküldéséhez szükséges URL-cím. Csak akkor jelenik meg, ha a createEmbeddedSendingSession igaz.
azonosító	folder.folderId	integer	A létrehozott boríték egyedi azonosítója. Ezzel hivatkozhat a borítékra a későbbi műveletek során.
Név	folder.folderName	string	A boríték neve.
Egyéni név	folder.folderCustomName	string	A borítékhoz rendelt egyéni név.
Password	folder.folderPassword	string	A borítékhoz beállított jelszó, ha van ilyen.
Szerző azonosítója	folder.folderAuthorId	integer	A borítékot létrehozó felhasználó egyedi azonosítója.
Szerző utóneve	folder.folderAuthorFirstName	string	A borítékkészítő utóneve.
Szerző vezetékneve	folder.folderAuthorLastName	string	A borítékkészítő vezetékneve.
Szerző e-mail	folder.folderAuthorEmail	string	A boríték létrehozójának e-mail-címe.
Szerzői szerepkör	folder.folderAuthorRole	string	A borítékkészítő fiókszerepköre.
Cégazonosító	folder.folderCompanyId	integer	Annak a cégnek az egyedi azonosítója, amelyhez a boríték tartozik.
Létrehozás dátuma	folder.folderCreationDate	integer	A boríték létrehozásának dátuma és időpontja Unix ezredmásodpercben.
Elküldött dátum	folder.folderSentDate	integer	A boríték elküldésének dátuma és időpontja Unix ezredmásodpercben.
Status	folder.folderStatus	string	A boríték aktuális állapota (pl. MEGOSZTOTT, VÉGREHAJTVA, PISZKOZAT, VISSZAVONVA).
Egyéni mező 1	folder.custom_field1	string	Az 1. egyéni mező értéke a borítékon van beállítva.
Egyéni mező 2	folder.custom_field2	string	A borítékon beállított 2. egyéni mező értéke.
Metadaták	folder.metadata	string	A borítékhoz társított további metaadatok.
Dokumentumazonosítók	folder.folderDocumentIds	array of integer	A borítékban szereplő dokumentumazonosítók listája.
Documents	folder.documentsList	array of object	A borítékban szereplő minden dokumentum részletei.
Dokumentumazonosító	folder.documentsList.documentId	integer	A dokumentum egyedi azonosítója.
Szerződés azonosítója	folder.documentsList.contractId	integer	A dokumentumhoz társított szerződés egyedi azonosítója.
Cégazonosító	folder.documentsList.companyId	integer	Annak a vállalatnak az egyedi azonosítója, amelyhez ez a dokumentum tartozik.
Készítette:	folder.documentsList.contractCreatedBy	integer	A szerződést létrehozó személy felhasználói azonosítója.
Létrehozás dátuma:	folder.documentsList.contractCreatedOn	string	A szerződés létrehozásának dátuma.
Szerződés típusa	folder.documentsList.contractType	string	A szerződés típusa.
Dokumentum állapota	folder.documentsList.contractStatus	string	A dokumentum aktuális aláírási állapota (például WAITING_FOR_SIGNATURE, EXECUTED).
Módosítható	folder.documentsList.editable	boolean	Azt jelzi, hogy a dokumentum szerkeszthető-e.
Verzióazonosító	folder.documentsList.contractVersionId	integer	Az aktuális dokumentumverzió egyedi azonosítója.
Verzió neve	folder.documentsList.contractVersionName	string	Az aktuális dokumentumverzió neve.
Verzió leírása	folder.documentsList.contractVersionDesc	string	Az aktuális dokumentumverzió leírása.
Által létrehozott verzió	folder.documentsList.versionCreatedby	integer	A dokumentumverziót létrehozó személy felhasználói azonosítója.
Verzió:	folder.documentsList.versionCreatedOn	string	A dokumentumverzió létrehozásának dátuma.
Verziószám	folder.documentsList.contractVersionNumber	integer	A dokumentum verziószáma.
Tranzakció forrása	folder.documentsList.contractTransactionSource	string	A szerződési tranzakció forrása.
Címzettek	folder.folderRecipientParties	array of object	A boríték címzettjeinek listája, beleértve az egyéni aláírási hivatkozásaikat is.
Címzett azonosítója	folder.folderRecipientParties.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	folder.folderRecipientParties.partyDetails.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	folder.folderRecipientParties.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	folder.folderRecipientParties.partyDetails.lastName	string	A címzett vezetékneve.
Email	folder.folderRecipientParties.partyDetails.emailId	string	A címzett e-mail-címe.
Helyőrző	folder.folderRecipientParties.partyDetails.placeholder	boolean	Azt jelzi, hogy ez a címzett helyőrző-e.
Address	folder.folderRecipientParties.partyDetails.address	string	A címzett címe.
Fiók létrehozási dátuma	folder.folderRecipientParties.partyDetails.dateCreated	integer	A címzett fiókja létrehozásának dátuma Unix ezredmásodpercben.
E-mailek letiltása	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Jelzi, hogy a címzett lemondta-e az e-mail-értesítéseket.
Egyedi fél azonosítója	folder.folderRecipientParties.partyDetails.uniquePartyId	string	A címzett egyedi sztringazonosítója.
Hitelesítési szint	folder.folderRecipientParties.partyDetails.authenticationLevel	string	A címzetthez szükséges hitelesítési szint.
Cégazonosító	folder.folderRecipientParties.partyDetails.companyId	integer	Annak a vállalatnak az azonosítója, amelyhez a címzett tartozik.
Felhasználói szerepkör	folder.folderRecipientParties.partyDetails.userRole	string	A címzett szerepe a szervezeten belül.
Department	folder.folderRecipientParties.partyDetails.department	string	A címzett részlege.
Cím	folder.folderRecipientParties.partyDetails.title	string	A címzett beosztása.
Aktív	folder.folderRecipientParties.partyDetails.active	boolean	Azt jelzi, hogy a címzett fiókja aktív-e.
Tárcsázási kód	folder.folderRecipientParties.partyDetails.dialingCode	string	A címzett telefonszámának országhívószáma.
Mobilszám	folder.folderRecipientParties.partyDetails.mobileNumber	string	A címzett mobiltelefonszáma.
Alvállalkozó leírása	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Az alvállalkozó leírása, ha van.
Alvállalkozói szervezet	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Az alvállalkozó szervezetének neve, ha van ilyen.
Alvállalkozó hozzáadott dátuma	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Az alvállalkozó hozzáadásának dátuma Unix ezredmásodpercben.
Forrás	folder.folderRecipientParties.partyDetails.source	string	A forrás, amelyen keresztül a címzettet hozzáadták.
Tárcsázási kód	folder.folderRecipientParties.dialingCode	string	A címzett mobilszámának országhívószáma.
Mobilszám	folder.folderRecipientParties.mobileNumber	string	A címzett mobilszáma.
Aláírás típusa	folder.folderRecipientParties.signerSignatureType	string	A címzett számára engedélyezett aláírás típusa.
Jogosultságok	folder.folderRecipientParties.contractPermissions	string	A címzettnek adott aláírási engedélyek (például FILL_FIELDS_AND_SIGN).
Aláírási rendelés	folder.folderRecipientParties.partySequence	integer	A címzett pozíciója az aláírási rendelésben.
Munkafolyamat-sorozat	folder.folderRecipientParties.workflowSignSequence	integer	A címzett munkafolyamat-aláírási sorszáma.
Boríték azonosítója	folder.folderRecipientParties.envelopeId	integer	Annak a borítéknak az azonosítója, amelyhez a címzett tartozik.
Fél cégazonosítója	folder.folderRecipientParties.partyCompanyId	integer	Annak a vállalatnak az azonosítója, amelyhez a címzett tartozik.
Megosztási mód	folder.folderRecipientParties.sharingMode	string	A dokumentumnak a címzettel való megosztására használt módszer (pl. e-mail).
Aláírási URL-cím	folder.folderRecipientParties.folderAccessURL	string	A címzett egyedi aláírási URL-címe. Ezzel közvetlenül megoszthatja az aláírási hivatkozást.
Biztonsági mód	folder.folderRecipientParties.securityMode	string	A címzett hozzáférésére alkalmazott biztonsági mód.
További megjegyzések	folder.folderRecipientParties.extraComments	string	A címzett aláírási meghívásában szereplő további megjegyzések.
Névváltoztatás engedélyezése	folder.folderRecipientParties.allowNameChange	boolean	Azt jelzi, hogy a címzett az aláírás előtt módosíthatja-e a nevét.
Név frissítve	folder.folderRecipientParties.signerNameUpdated	boolean	Azt jelzi, hogy a címzett frissítette-e a megjelenített nevét.
Hitelesítési szint	folder.folderRecipientParties.signerAuthenticationLevel	string	A címzettnek a dokumentum eléréséhez szükséges hitelesítési módszer.
Hozzáférési kód	folder.folderRecipientParties.userDefinedAccessCode	string	A címzettnek egyéni hozzáférési kódra van szüksége a dokumentum megnyitásához.
Aláírás azonosítója	folder.folderRecipientParties.signatureId	string	A címzett által használt mentett aláírás azonosítója.
Címzett szerepkör	folder.folderRecipientParties.partyRole	string	A címzetthez rendelt szerepkör a borítékban.
Vállalati mező értéke	folder.folderRecipientParties.companyFieldValue	string	A címzett számára előre kitöltött vállalati mezőérték.
Címmező értéke	folder.folderRecipientParties.titleFieldValue	string	A címzett címmezőjének értéke előre kitöltve.
Az aláírás oka	folder.folderRecipientParties.reasonSigning	string	A címzett által megadott aláírás oka.
Hozzáadott fizetési mező	folder.folderRecipientParties.payFieldAdded	boolean	Azt jelzi, hogy hozzá lett-e adva egy fizetési mező ehhez a címzetthez.
Fizetős	folder.folderRecipientParties.payee	boolean	Azt jelzi, hogy ez a címzett kedvezményezett-e.
Ismétlődő mező létezik	folder.folderRecipientParties.recurringFieldExist	boolean	Azt jelzi, hogy léteznek-e ismétlődő fizetési mezők a címzett számára.
Nyomtatás és aláírás befejezve	folder.folderRecipientParties.printAndSignCompleted	boolean	Azt jelzi, hogy a címzett végrehajtott-e egy nyomtatási és aláírási műveletet.
Választható aláíró engedélyezése	folder.folderRecipientParties.allowOptionalSigner	boolean	Azt jelzi, hogy a címzett kihagyható-e választható aláíróként.
Választható aláírók	folder.folderRecipientParties.optionalSigners	string	A címzetthez társított választható aláírók listája, ha vannak ilyenek.
Paid	folder.folderRecipientParties.paid	boolean	Azt jelzi, hogy a címzett teljesítette-e a fizetést.
Szerzői hozzáférés URL-címe	folder.folderAccessURLForAuthor	string	A boríték szerzőjének URL-címe a dokumentum eléréséhez.
Hozzáférési url-cím piszkozata	folder.draftFolderAccessURL	string	A borítékot piszkozat állapotban elérő URL-cím.
Táblatábla	folder.boardRoomSign	boolean	Jelzi, hogy engedélyezve van-e a táblaszoba aláírása ehhez a borítékhoz.
Embléma belefoglalása	folder.includeLogo	boolean	Azt jelzi, hogy a cég emblémája szerepel-e az e-mail-értesítésekben.
E-mail gomb színe	folder.email_btnBgColor	string	A művelet gomb háttérszíne az aláíró e-mailben.
E-mail gomb szövegszíne	folder.email_btnTxtColor	string	A művelet gomb szövegszíne az aláíró e-mailben.
E-mail e-mail e-	folder.emailTemplateLogo	string	Az e-mail-sablonban használt e-mail-kép.
E-mail-sablon azonosítója	folder.emailTemplateId	integer	Az értesítések aláírásához használt e-mail-sablon azonosítója.
E-mail fejléc	folder.emailHeader	string	Az értesítési e-mailekben szereplő egyéni fejlécszöveg.
E-mail élőláb	folder.emailFooter	string	Az egyéni élőláb szövege az értesítési e-mailek aláírása során.
Ütemezett törlés	folder.purgeFlag	boolean	Azt jelzi, hogy a boríték automatikus törlésre van-e ütemezve.
Törlés kezdő dátuma	folder.purgeStartDate	string	A törlési időszak kezdő dátuma.
Végdátum törlése	folder.purgeEndDate	string	A boríték kiürítésének dátuma.
Tömeges azonosító	folder.bulkId	integer	A borítékot küldő tömeges küldési köteg azonosítója, ha van ilyen.
Előrendelés kényszerítése	folder.enforceSignWorkflow	boolean	Azt jelzi, hogy a címzetteknek be kell-e jelentkezniük a megadott sorrendbe.
Aktuális munkafolyamat-lépés	folder.currentWorkflowStep	integer	Az aláírási munkafolyamat aktuális lépése.
Tranzakció forrása	folder.transactionSource	string	A borítéktranzakciót kezdeményező forrás.
Módosítható	folder.editable	boolean	Azt jelzi, hogy a boríték továbbra is szerkeszthető-e.
In-Person aláírása	folder.inPersonSignable	boolean	Jelzi, hogy a borítékot személyesen lehet-e aláírni.
Emlékeztetők felülbírálása	folder.overrideAccountReminders	boolean	Azt jelzi, hogy a fiókszintű emlékeztető beállításai felülbíráltak-e ennél a borítéknál.
Delegálás felülbírálása	folder.overrideAccountRecipientDelegation	boolean	Azt jelzi, hogy a fiókszintű delegálási beállítások felül vannak-e bírálva ehhez a borítékhoz.
Delegálás engedélyezése	folder.allowRecipientsToDelegate	boolean	Azt jelzi, hogy a címzettek delegálhatják-e aláírásukat egy másik személynek.
azonosító	folder.envelopeId	integer	A boríték egyedi azonosítója. Ugyanaz az érték, mint a Boríték azonosítója (folderId).
Név	folder.envelopeName	string	A boríték neve. Ugyanaz az érték, mint a boríték neve (folderName).
Kezdeményező azonosítója	folder.envelopeOriginatorId	integer	A borítékot létrehozó személy felhasználói azonosítója.
Cégazonosító	folder.envelopeCompanyId	integer	Annak a cégnek az azonosítója, amelyhez a boríték tartozik.
Date	folder.envelopeDate	integer	A boríték létrehozásának dátuma és időpontja Unix ezredmásodpercben.
Megosztott dátum	folder.envelopeSharedDate	integer	A borítéknak a címzettekkel való megosztásának dátuma és időpontja Unix ezredmásodpercben.
Status	folder.envelopeStatus	string	A boríték aktuális állapota. Ugyanaz az érték, mint a boríték állapota (folderStatus).
Szerződésazonosítók	folder.envelopeContractIds	array of integer	A borítékhoz társított szerződésazonosítók listája.
Fél engedélyei	folder.envelopePartyPermissions	array of object	A címzettek listája és aláírási engedélyei. Ugyanaz a struktúra, mint a címzettek.
Címzett azonosítója	folder.envelopePartyPermissions.partyId	integer	A címzett egyedi azonosítója.
Aláírási URL-cím	folder.envelopePartyPermissions.folderAccessURL	string	A címzett egyedi aláírási URL-címe.
Jogosultságok	folder.envelopePartyPermissions.contractPermissions	string	A címzett aláírási engedélyei.
Aláírási rendelés	folder.envelopePartyPermissions.partySequence	integer	A címzett pozíciója az aláírási rendelésben.
Hitelesítési szint	folder.envelopeAuthenticationLevel	string	A teljes borítékra alkalmazott hitelesítési szint.
Egyszeri aláíró tömeges engedélyezése	folder.allowSingleSignerInBulk	boolean	Azt jelzi, hogy egyetlen aláíró engedélyezve van-e tömeges küldési módban.
Név fájl alapján	folder.folderNameBasedOnFileNaming	boolean	Azt jelzi, hogy a boríték neve a fájlnévből származik-e.
Dokumentum neve fájl alapján	folder.documentNameBasedOnFileNaming	boolean	Azt jelzi, hogy a dokumentum neve a fájlnévből származik-e.
Tanúsítványnév fájl alapján	folder.certificateNameBasedOnFileNaming	boolean	Azt jelzi, hogy a tanúsítvány neve a fájlnévből származik-e.
Fájlelnevezés engedélyezése	folder.enableFileNamingBeforeExecution	boolean	Azt jelzi, hogy a rendszer kéri-e a fájlelnevezést a boríték elküldése előtt.
Kedvezményezett hozzáadva	folder.payeeAddedd	boolean	Jelzi, hogy egy kedvezményezettet hozzáadtak-e a borítékhoz.
Önaláírás	folder.selfSignerEnabled	boolean	Azt jelzi, hogy a feladó is aláíró-e ezen a borítékon.
Közjegyző engedélyezve	folder.notaryEnabled	boolean	Jelzi, hogy engedélyezve van-e a boríték közjegyzői jelölése.
Korlátozott láthatóság	folder.limitedVisibilityFlag	boolean	Azt jelzi, hogy engedélyezve van-e a dokumentum korlátozott láthatósága.
Aláírás utáni láthatóság	folder.postSigningVisibility	boolean	Azt jelzi, hogy a címzettek megtekinthetik-e az aláírt dokumentumot a befejezés után.
Nedves aláírás engedélyezve	folder.wetSignatureEnabled	boolean	Azt jelzi, hogy a borítékhoz engedélyezve vannak-e nedves (kézzel írt) aláírások.
Egyesítés engedélyezve	folder.mergeEnabled	boolean	Azt jelzi, hogy engedélyezve van-e a boríték dokumentumegyesítése.

Boríték létrehozása URL-címből

Műveletazonosító:

CreateEnvelopefromURL

Borítékot hoz létre és küld el nyilvánosan elérhető PDF-URL-címek használatával. Adja meg a dokumentum URL-címét és a címzett adatait az aláírási folyamat elindításához.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték neve	folderName	True	string	A boríték neve.
Bemeneti típus	inputType		string	Megadja a dokumentum forrásformátumát. Állítsa be az URL-címet a fájl URL-címeinek megadásához, vagy a base64-es base64-kódolt fájltartalom megadásához.
Fájl URL-címei	fileUrls	True	array of string	Nyilvánosan elérhető URL-címek tömbje, amely a borítékhoz hozzáadni kívánt dokumentumokra mutat.
Fájlnevek	fileNames	True	array of string	Az egyes dokumentumok megjelenítendő neveinek tömbje, a Fájl URL-címével megegyező sorrendben.
Keresztnév	firstName	True	string	A címzett utóneve.
Vezetéknév	lastName	True	string	A címzett vezetékneve.
E-mail-cím	emailId	True	string	A címzett e-mail-címe.
engedélyek	permission	True	string
Sequence	sequence	True	integer	Ezzel a mezővel sorszámot rendelhet egy címzetthez a címzettek listájában. Használjon egyedi sorszámokat az egyes felekhez 1,2,3,4-től kezdve.... Ha egyetlen személy többször is megjelenik az aláírási munkafolyamatban, minden alkalommal rendeljen hozzá egy másik sorozatot, amikor a címzett ismétlődik.
signerAuthLevels	signerAuthLevel		string	Az aláíró által ellenőrzési célokra használt hitelesítési szint
Helyőrző	isPlaceholder		boolean	Ezzel a mezővel kezdeményezheti, hogy a fél helyőrző legyen. Megjegyzés: 1. A firstName, a lastName és a emailId paraméter értékének üresnek kell lennie a féltől. 2. A helyőrző hozzáadásához egy címzettet újra kell adni "PARTY_ASSIGNER" engedéllyel.
Címzett szerepkör	partyRole		string	Ezzel a mezővel helyőrző szerepkört rendelhet hozzá.
Névváltoztatás engedélyezése	allowNameChange		string	Az érték lehet igaz vagy hamis: Ez a paraméter lehetővé teszi, hogy az aláíró az aláírási folyamat befejezése előtt frissítse az utónevet és a vezetéknevet.
Munkafolyamat-sorozat	workflowSequence		integer	Munkafolyamat-sorszám hozzárendelése ehhez a címzetthez. Ha engedélyezve van a bejelentkezési sorrend, a címzettek növekvő sorrendben kapják meg az aláírási meghívást.
Gazdagép e-mail-azonosítója	hostEmailId		string	In-Person rendszergazda e-mail-címe.
Hozzáférési kód	userDefinedAccessCode		string	A paraméter hozzáférési kódot fog tartalmazni, ha a "signerAuthLevel" érték "Felhasználó által definiált hozzáférési kódként" van beállítva a hitelesítéshez. Megjegyzés: 1. A kódok nem megkülönböztetik a kis- és nagybetűket. 2. A rendszer nem küldi el ezt a kódot, ezért ezt a kódot közvetlenül meg kell osztania az aláíróval. 3. A hozzáférési kód tartalmazhat ábécéket, számokat és a következő speciális karaktereket: @,&;,{,}%,(,),~,|,!,+,^.
Fél az e-mail-csoport	partyIsEmailGroup		boolean	Ezt a paramétert akkor használja, ha tömegesen hoz létre egy partit. Megjegyzés: Ha ez a paraméter igaz, a rendszer figyelmen kívül hagyja a fél vezetéknevét, vezetéknevét és e-mail-azonosítóját.
E-mail-csoport azonosítója	emailGroupId		integer	Adja meg az e-mail-címet a csoportos létrehozáshoz használni kívánt csoportazonosítónak.
Egyszeri aláíró tömeges	allowSingleSignerInBulk		boolean	Ezzel a paraméterlel csak egy személy jelentkezhet be e-mail-csoportba.
Tárcsázási kód	dialingCode		string	Ezzel a mezővel az ország betárcsázási kódjai mobilszám-előtagok a címzettek listájában.
Mobilszám	mobileNumber		string	Ezzel a mezővel mobilszámot rendelhet egy címzetthez a címzettek listájában.
Mezők	Fields		object
Küldés most	sendNow		boolean	Ha engedélyezve van, a Foxit eSign azonnal egyedi aláírási hivatkozást küld az egyes címzettek e-mail-címére. Tiltsa le ezt a műveletet a boríték piszkozatként való mentéséhez.
Beágyazott aláíró munkamenet létrehozása	createEmbeddedSigningSession	True	boolean	Az aláíró munkamenet-jogkivonat anélkül jön létre, hogy e-maileket küldene a címzetteknek.
Beágyazott aláírási munkamenet létrehozása minden fél számára	createEmbeddedSigningSessionForAllParties		boolean	Ha igaz értékre van állítva, a boríték minden címzettje számára létrejön egy beágyazott aláírási URL-cím.
Szövegcímkék feldolgozása	processTextTags	True	boolean	Az érték lehet igaz vagy hamis. Ez a mező határozza meg, hogy a Foxit eSign elemezze-e a szövegcímkék dokumentumait, hogy foxit eSign mezőkké alakítsa őket.
Acro-mezők feldolgozása	processAcroFields	True	boolean	Ez a mező határozza meg, hogy a Foxit eSign elemezze-e az AcroFields dokumentumait, hogy foxit eSign mezőkké alakítsa őket.
Bejelentkezési sorrend	signInSequence		boolean	Ez a mező határozza meg, hogy a címzettek egymás után fogják-e aláírni a borítékdokumentumokat. Ha hamis, akkor az összes címzett egyidejűleg kap meghívó e-mailt. Ha igaz, akkor az egyes címzettek egymás után kapnak meghívó e-mailt, miután az előző címzett elvégezte a szükséges feladatot, például a dokumentumok aláírását vagy a mezők kitöltését stb.
Személyes engedélyezés	inPersonEnable		boolean	Ez a mező arra szolgál, hogy elindítsa a személyes aláírási folyamatot, amely percek alatt bármilyen eszközön egyszerűen elvégezhető, és szükség esetén elkerüli az e-mail-alapú aláírásokat. Ha hamis, akkor az összes címzett egyidejűleg megkapja a meghívó e-mailt. Ha igaz, akkor a személyes rendszergazda egy meghívó e-mailt kap az aláíró aláírási folyamatának elindításához.
Címzett felek javítása	fixRecipientParties		boolean	Ha igaz, akkor a beágyazott küldési nézetben nem módosíthatók a borítékhoz tartozó felek, amelyeket a kérés részeként már hozzáadtak.
Dokumentumok javítása	fixDocuments		boolean	Ha igaz, akkor a beágyazott küldés nem tudja módosítani a borítékhoz tartozó dokumentumokat, amelyeket a kérés részeként már hozzáadtak.
Sikeres küldés URL-címe	sendSuccessUrl		string	Adja meg a kezdőlap abszolút URL-címét, amelyre az aláíró a mappa beágyazott küldő nézetben való sikeres elküldése után lesz átirányítva.
Küldési hiba URL-címe	sendErrorUrl		string	Adja meg a kezdőlap abszolút URL-címét, amelyre a rendszer átirányítja az aláírót, ha hiba történik a mappa beágyazott küldő nézetben való elküldése során.
Beágyazott küldési munkamenet létrehozása	createEmbeddedSendingSession		boolean	Ha igaz értékre van állítva, beágyazott jogkivonatot hoz létre a Foxit eSign dokumentumelőkészítő nézetének megnyitásához.
Beágyazott aláírók e-mail-azonosítói	embeddedSignersEmailIds		array of string	Azoknak a címzetteknek az e-mail-azonosítóit tartalmazó tömb, akiknek létre kell hoznia egy beágyazott aláíró munkamenetet. A felek listájában szereplő címzett felek e-mail-azonosítói.
Sikeres aláírás URL-címe	signSuccessUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a beágyazott aláíró nézetben való sikeres bejelentkezés után átirányítja a rendszer.
Aláírás elutasításának URL-címe	signDeclineUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre átirányítja a rendszer, ha nem jelentkezik be beágyazott aláíró nézetben.
Későbbi aláírás URL-címe	signLaterUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a rendszer átirányítja, ha később a beágyazott aláíró nézetben szeretne bejelentkezni.
Aláírási hiba URL-címe	signErrorUrl		string	Adja meg azoknak az aláíróknak az abszolút URL-címét, akikre a rendszer átirányítja, ha hiba történik a dokumentum beágyazott aláíró nézetben való aláírása során.
Küldés és beágyazott aláírási munkamenet engedélyezése	allowSendNowAndEmbeddedSigningSession		boolean	Ha igaz értékre van állítva, a Foxit eSign egyedi aláírási hivatkozást küld az egyes címzetteknek. Ez CSAK akkor alkalmazható, ha a sendNow és a createEmbeddedSigningSession paraméter igaz.
Speciális e-mail-ellenőrzés	allowAdvancedEmailValidation		boolean	Ellenőrizze a felek e-mail-címét, ha igazként van beállítva.
Sikeres aláírás URL-címe minden fél számára	signSuccessUrlAllParties		boolean	Ha igaz értékre van állítva, a rendszer a sikeres aláírás után átirányítja az aláírót a signSuccessUrlban megadott URL-címre. Ez csak akkor alkalmazható, ha a sendNow igaz.
E-mail-sablon azonosítója	emailTemplateId		integer	Adja meg az e-mail-sablon azonosítóját az alapértelmezett e-mail-sablonoktól eltérő e-mail-sablonok küldéséhez.
Aláíró utasításazonosítója	signerInstructionId		integer	Adja meg az utasításazonosítót az aláírók alapértelmezett utasításaitól eltérő utasítások küldéséhez.
Megerősítő utasítás azonosítója	confirmationInstructionId		string	Adja meg a megerősítő utasítás azonosítóját, hogy az alapértelmezett megerősítési utasításoktól eltérő megerősítési utasításokat küldjön.
Téma színe	themeColor		string	Adja meg a CSS-értéket a téma színének beállításához.
A munkamenet lejár	sessionExpire		boolean	Állítsa igaz értékre a beágyazott aláírási munkamenet lejáratának elindításához.
Lejárat	expiry		integer	Akkor szükséges, ha a sessionExpire igaz. Adja meg az időtartamot a beágyazott aláírási munkamenet lejáratának ezredmásodpercében.
Függő mező neve	dependentFieldName	True	string	Annak a mezőnek a neve, amelynek láthatóságát a szülőmező vezérli.
Szülőmező neve	parentFieldName	True	string	Annak a szülőmezőnek a neve, amelynek értéke szabályozza a függő mező láthatóságát. Támogatott szülőmezőtípusok: szövegmező, szövegmező, jelölőnégyzet, választógomb, legördülő lista.
Szülőmező értéke	parentFieldValue	True	string	Annak a szülőmezőnek az értéke, amely a függő mezőt aktiválja, hogy láthatóvá váljon. A jelölőnégyzet és a választógomb mezőinél használja a bejelölt vagy a bejelöletlen jelölőnégyzetet.
Beállítások	options	True	string	További egyeztetési lehetőségek szövegalapú szülőmezőkhöz. Elfogadott értékek: isblank, allowNull, contains.
Metadaták	metadata		object	Ennek kulcsérték-párban kell lennie. Legfeljebb 1000 kulcsértékpár engedélyezett.
Feladó e-mail-címe	senderEmail		string	adja meg egy másik felhasználó e-mail-címét a fiókjában, amelyet a dokumentum(ok) mappa címzett feleknek való elküldéséhez használunk.
A Hozzáadás gomb elrejtése	hideAddMeButton		boolean	Ha igaz, elrejti a "Hozzáadás" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Új hozzáadása gomb elrejtése	hideAddNewButton		boolean	Ha igaz, elrejti az "Új hozzáadása" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Csoport hozzáadása gomb elrejtése	hideAddGroupButton		boolean	Ha igaz, elrejti a "Csoport hozzáadása" gombot a címzett feleken egy beágyazott küldési munkamenetben.
Címzettek mezőnevének elrejtése	hideFieldNameForRecipients		boolean	Adatbeviteli mezők és speciális mezők címzettjeinek mezőneveinek elrejtése. (Kivéve a választógombot, a jelölőnégyzetet, a képet és a hivatkozást).
Jelölőnégyzetszegély elrejtése	hideCheckboxBorder		boolean	A jelölőnégyzet szegélyei el lesznek rejtve a végrehajtott dokumentumokban.
Aláíró kijelölése lehetőség elrejtése	hideSignerSelectOption		boolean	Ha igaz, elrejti a "Meglévő aláíró neve/e-mail" beviteli mezőt a címzett feleken egy beágyazott küldési munkamenetben.
Aláírói műveletek elrejtése	hideSignerActions		boolean	Ha igaz, elrejti az aláíró "szerkesztés", "módosítás" és "eltávolítás" műveleteit a címzett feleken egy beágyazott küldési munkamenetben.
Feladó nevének elrejtése	hideSenderName		boolean	Ha igaz, egy beágyazott küldési munkamenetben elrejti a feladó nevét a címzett felek között.
Mappanév elrejtése	hideFolderName		boolean	Ha igaz, mindkét beágyazott munkamenetben elrejti a mappa nevét a navigációs sávon.
Dokumentumok nevének elrejtése	hideDocumentsName		boolean	Ha igaz, mindkét beágyazott munkamenetben elrejti a dokumentum nevét.
Elutasítás elrejtése aláíráshoz	hideDeclineToSign		boolean	Ha igaz, elrejti a "Megtagadás az aláírástól" lehetőséget az aláíró számára.
További műveletek elrejtése	hideMoreAction		boolean	Ha igaz, elrejti a "További műveletek" gombot a küldési/aláírási munkamenetben. A "Küldés most": igaz, nem rejt el semmit.
Küldés elrejtése gomb	hideSendButton		boolean	Ha igaz, elrejti a Küldés gombot a beágyazott küldési munkamenetben.
Következő kötelező mezőbtn elrejtése	hideNextRequiredFieldbtn		boolean	Ha igaz értékre van állítva, elrejti a navigációs gombot, amely az aláírókat a következő kötelező mezőre helyezi át.
Mindkét beágyazott munkamenetre szükség van	requiredBothEmbeddedSession		boolean	Ha igaz, a beágyazott küldési és aláírási URL-címeket együtt hozza létre.
Borítékjelszó	folderPassword		string	Ezt a jelszót az aláírónak/szerzőnek kell megadnia a digitálisan aláírt dokumentum megnyitásához. Ha a paraméter üresen marad, akkor a digitálisan aláírt dokumentum megnyitásához nincs szükség jelszóra.
Engedélyezés lépésről lépésre	enableStepByStep		boolean	Lépésenkénti művelet engedélyezése a beágyazott küldési munkamenetben.
A Felek hozzáadása beállítás elrejtése	hideAddPartiesOption		boolean	Ha igaz, elrejti a felek hozzáadásának lehetőségét Piszkozat- és sablonlétrehozási módban.
Önaláírás	selfSign		boolean	Lehetővé teszi a beágyazott önaláírást API-k használatával. Ez a paraméter csak akkor alkalmazható, ha a createEmbeddedSendingSession paraméter igaz.
Önaláírás sikeres url-címe	selfSignerSuccessUrl		string	Adja meg a webhely/alkalmazás kezdőlapjának abszolút URL-címét, amelyre a rendszer átirányítja a felhasználót, miután sikeresen önaláírta a mappát a beágyazott küldési nézetben.

Válaszok

Name	Elérési út	Típus	Description
azonosító	folder.folderId	integer	Az újonnan létrehozott boríték egyedi azonosítója. Ezt a borítékra való hivatkozáshoz használja a következő műveletekben.
Név	folder.folderName	string	Az újonnan létrehozott boríték neve.
Egyéni név	folder.folderCustomName	string	A boríték egyéni neve.
Password	folder.folderPassword	string	Ha be van állítva a boríték hozzáférési jelszava.
Létrehozó azonosítója	folder.folderAuthorId	integer	A boríték létrehozójának egyedi azonosítója.
Létrehozó utóneve	folder.folderAuthorFirstName	string	A borítékkészítő utóneve.
Létrehozó vezetékneve	folder.folderAuthorLastName	string	A borítékkészítő vezetékneve.
Létrehozó e-mail-címe	folder.folderAuthorEmail	string	A borítékkészítő e-mail-címe.
Létrehozói szerepkör	folder.folderAuthorRole	string	A borítékkészítő szerepe.
Cégazonosító	folder.folderCompanyId	integer	A borítékot birtokoló vállalat egyedi azonosítója.
Létrehozás dátuma	folder.folderCreationDate	integer	A boríték létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Elküldött dátum	folder.folderSentDate	integer	A boríték elküldésének dátuma (Unix időbélyeg ezredmásodpercben).
Status	folder.folderStatus	string	A boríték aktuális állapota.
Egyéni mező 1	folder.custom_field1	string	A boríték első egyéni metaadatmezője.
Egyéni mező 2	folder.custom_field2	string	A boríték második egyéni metaadatmezője.
Metadaták	folder.metadata	string	A borítékhoz társított egyéni metaadatok.
Dokumentumazonosítók	folder.folderDocumentIds	array of integer	A borítékban található dokumentumazonosítók listája.
Documents	folder.documentsList	array of object	A borítékban lévő dokumentumok listája.
Dokumentumazonosító	folder.documentsList.documentId	integer	A dokumentum egyedi azonosítója.
Szerződés azonosítója	folder.documentsList.contractId	integer	A szerződés egyedi azonosítója.
Cégazonosító	folder.documentsList.companyId	integer	A vállalat egyedi azonosítója.
Készítette:	folder.documentsList.contractCreatedBy	integer	A szerződést létrehozó személy felhasználói azonosítója.
Létrehozás dátuma:	folder.documentsList.contractCreatedOn	string	A szerződés létrehozásának dátuma és időpontja.
Szerződés típusa	folder.documentsList.contractType	string	A szerződés típusa.
Szerződés állapota	folder.documentsList.contractStatus	string	A szerződés aktuális állapota.
Módosítható	folder.documentsList.editable	boolean	Azt jelzi, hogy az elem szerkeszthető-e.
Verzióazonosító	folder.documentsList.contractVersionId	integer	A szerződés verziójának egyedi azonosítója.
Verzió neve	folder.documentsList.contractVersionName	string	A szerződés verziójának neve.
Verzió leírása	folder.documentsList.contractVersionDesc	string	A szerződés verziójának leírása.
Által létrehozott verzió	folder.documentsList.versionCreatedby	integer	A verziót létrehozó személy felhasználói azonosítója.
Verzió:	folder.documentsList.versionCreatedOn	string	A verzió létrehozásának dátuma és időpontja.
Verziószám	folder.documentsList.contractVersionNumber	integer	A szerződés verziószáma.
Tranzakció forrása	folder.documentsList.contractTransactionSource	string	A szerződéstranzakciót kezdeményező forrásrendszer.
Címzettek	folder.folderRecipientParties	array of object	A boríték címzettjeinek listája.
Címzett azonosítója	folder.folderRecipientParties.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	folder.folderRecipientParties.partyDetails.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	folder.folderRecipientParties.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	folder.folderRecipientParties.partyDetails.lastName	string	A címzett vezetékneve.
E-mail-cím	folder.folderRecipientParties.partyDetails.emailId	string	A címzett e-mail-címe.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	Azt jelzi, hogy ez a fél helyőrző címzett-e.
Address	folder.folderRecipientParties.partyDetails.address	string	A címzett fizikai címe.
Létrehozás dátuma	folder.folderRecipientParties.partyDetails.dateCreated	integer	A rekord létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
E-mailek letiltása	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Jelzi, hogy a címzett lemondta-e az e-mail-értesítéseket.
Egyedi címzett-azonosító	folder.folderRecipientParties.partyDetails.uniquePartyId	string	A címzett egyedi rendszerazonosítója.
Hitelesítési szint	folder.folderRecipientParties.partyDetails.authenticationLevel	string	A címzetthez szükséges hitelesítési módszer.
Jelszó frissítése dátuma	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A jelszó utolsó frissítésének dátuma.
Jelszóval frissített állapot	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Azt jelzi, hogy a jelszó frissült-e.
Cégazonosító	folder.folderRecipientParties.partyDetails.companyId	integer	A vállalat egyedi azonosítója.
Felhasználói szerepkör	folder.folderRecipientParties.partyDetails.userRole	string	A felhasználóhoz rendelt szerepkör.
Department	folder.folderRecipientParties.partyDetails.department	string	Az a részleg, amelyhez a felhasználó tartozik.
Cím	folder.folderRecipientParties.partyDetails.title	string	A felhasználó beosztása.
Aktív	folder.folderRecipientParties.partyDetails.active	boolean	Azt jelzi, hogy a felhasználó vagy a rekord aktív-e.
Helyszín	folder.folderRecipientParties.partyDetails.requestLocale	string	A felhasználó területi beállítása.
Megosztás a Depttel	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Azt jelzi, hogy a borítékok meg vannak-e osztva a részlegen.
Tárcsázási kód	folder.folderRecipientParties.partyDetails.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.folderRecipientParties.partyDetails.mobileNumber	string	A mobiltelefonszám.
Állapotszűrő	folder.folderRecipientParties.partyDetails.docStatusFilter	string	A dokumentum állapotának szűrője.
Dátumszűrő	folder.folderRecipientParties.partyDetails.docDateFilter	string	A dokumentumdátum szűrője.
Biztonságos mezőhozzáférés	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Azt jelzi, hogy a felhasználó rendelkezik-e hozzáféréssel a biztonságos mezőkhöz.
Oldalsáv kibontása	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Azt jelzi, hogy az oldalsáv alapértelmezés szerint ki van-e bontva.
Adv. E-mail-ellenőrzés	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Azt jelzi, hogy engedélyezve van-e a speciális e-mail-ellenőrzés.
Vezető azonosítója	folder.folderRecipientParties.partyDetails.managerId	string	A felhasználó kezelőjének egyedi azonosítója.
Bejelentkezések száma	folder.folderRecipientParties.partyDetails.loginCount	integer	A felhasználó által bejelentkezett alkalmak száma.
E-mail jelszó kérése	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Azt jelzi, hogy a jelszó-visszaállítási e-mailt kell-e küldeni.
Részlegazonosító	folder.folderRecipientParties.partyDetails.departmentId	string	A részleg egyedi azonosítója.
Elsődleges vállalat	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	A felhasználóhoz társított elsődleges vállalat.
Eszköz típusa	folder.folderRecipientParties.partyDetails.deviceType	string	A használt eszköz típusa.
Eszközjogkivonat	folder.folderRecipientParties.partyDetails.deviceToken	string	Az eszköz leküldéses értesítési jogkivonata.
Alvállalkozó leírása	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Az alvállalkozó vagy a külső aláíró leírása.
Alvállalkozói szervezet	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Az alvállalkozó vagy külső aláíró szervezetneve.
Alvállalkozó hozzáadott dátuma	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Az alvállalkozó hozzáadásának dátuma (Unix időbélyeg ezredmásodpercben).
Forrás	folder.folderRecipientParties.partyDetails.source	string	A forrásrendszer, amelyből a külső aláírót hozzáadták.
Tárcsázási kód	folder.folderRecipientParties.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.folderRecipientParties.mobileNumber	string	A mobiltelefonszám.
Aláírás típusa	folder.folderRecipientParties.signerSignatureType	string	Az aláíró által használt aláírás típusa.
Jogosultságok	folder.folderRecipientParties.contractPermissions	string	A feleknek a szerződéshez adott engedélyek.
Aláírási rendelés	folder.folderRecipientParties.partySequence	integer	A címzett aláírási rendelésének sorszáma.
Munkafolyamat-sorozat	folder.folderRecipientParties.workflowSignSequence	integer	A munkafolyamat aláírási sorszáma.
Boríték azonosítója	folder.folderRecipientParties.envelopeId	integer	A boríték egyedi azonosítója.
Címzett cégazonosítója	folder.folderRecipientParties.partyCompanyId	integer	A címzetthez társított vállalat egyedi azonosítója.
Megosztási mód	folder.folderRecipientParties.sharingMode	string	A boríték megosztási módja.
Címzett hozzáférési URL-címe	folder.folderRecipientParties.folderAccessURL	string	A címzett által a boríték elérésére és aláírására használható URL-cím.
Biztonsági mód	folder.folderRecipientParties.securityMode	string	A borítékra alkalmazott biztonsági mód.
Comments	folder.folderRecipientParties.extraComments	string	További megjegyzések a borítékban.
Névváltoztatás engedélyezése	folder.folderRecipientParties.allowNameChange	boolean	Azt jelzi, hogy a címzett frissítheti-e a nevét.
Név frissítve	folder.folderRecipientParties.signerNameUpdated	boolean	Azt jelzi, hogy az aláíró frissítette-e a nevét.
Aláíró hitelesítési szintje	folder.folderRecipientParties.signerAuthenticationLevel	string	Az aláíróhoz szükséges hitelesítési szint.
Hozzáférési kód	folder.folderRecipientParties.userDefinedAccessCode	string	Az aláíróhoz definiált egyéni hozzáférési kód.
Aláírás azonosítója	folder.folderRecipientParties.signatureId	string	Az aláírás egyedi azonosítója.
Címzett szerepkör	folder.folderRecipientParties.partyRole	string	A címzetthez rendelt szerepkör az aláírási munkafolyamatban.
Céges mező	folder.folderRecipientParties.companyFieldValue	string	A cégnév mező értéke az aláírásban.
Címmező	folder.folderRecipientParties.titleFieldValue	string	Az aláírás címmezőjének értéke.
Az aláírás oka	folder.folderRecipientParties.reasonSigning	string	A címzett aláírásának oka.
Fizetési mező hozzáadva	folder.folderRecipientParties.payFieldAdded	boolean	Azt jelzi, hogy egy fizetési mező lett-e hozzáadva.
Kedvezményezett	folder.folderRecipientParties.payee	boolean	Azt jelzi, hogy ez a címzett-e a kedvezményezett.
Ismétlődő fizetés	folder.folderRecipientParties.recurringFieldExist	boolean	Azt jelzi, hogy létezik-e ismétlődő fizetési mező.
Nyomtatás és aláírás kész	folder.folderRecipientParties.printAndSignCompleted	boolean	Azt jelzi, hogy a nyomtatási és aláírási folyamat befejeződött-e.
Paid	folder.folderRecipientParties.paid	boolean	Jelzi, hogy a fizetés befejeződött-e.
Választható aláíró engedélyezett	folder.folderRecipientParties.allowOptionalSigner	boolean	Azt jelzi, hogy ez a címzett nem kötelező aláíró-e.
Választható aláírók	folder.folderRecipientParties.optionalSigners	array of integer	A boríték opcionális aláíró félazonosítóinak listája.
Szerző aláírási URL-címe	folder.folderAccessURLForAuthor	string	A feladó által a boríték eléréséhez használható URL-cím.
Hozzáférési url-cím piszkozata	folder.draftFolderAccessURL	string	A boríték piszkozatverziójának eléréséhez használt URL-cím.
Társasszoba aláírása	folder.boardRoomSign	boolean	Azt jelzi, hogy engedélyezve van-e a táblaszoba-aláírási mód.
Embléma belefoglalása	folder.includeLogo	boolean	Jelzi, hogy a cég emblémája szerepel-e az e-mailekben.
Gomb háttérszíne	folder.email_btnBgColor	string	Az e-mail gomb háttérszíne.
Gomb szövegszíne	folder.email_btnTxtColor	string	Az e-mail gomb szövegszíne.
E-mail e-mail e-	folder.emailTemplateLogo	string	Az e-mail-sablonban használt e-mail URL-cím.
E-mail-sablon azonosítója	folder.emailTemplateId	integer	Az e-mail-sablon egyedi azonosítója.
E-mail fejléc	folder.emailHeader	string	Az értesítési e-mailekben használt fejlécszöveg.
E-mail élőláb	folder.emailFooter	string	Az értesítési e-mailekben használt élőláb szövege.
Ütemezett törlés	folder.purgeFlag	boolean	Azt jelzi, hogy a boríték törlésre van-e ütemezve.
Törlés kezdő dátuma	folder.purgeStartDate	string	A törlés ütemezésének dátuma.
Végdátum törlése	folder.purgeEndDate	string	A törlés ütemezésének dátuma.
Tömeges küldés azonosítója	folder.bulkId	integer	A tömeges küldési művelet egyedi azonosítója.
Előrendelés kényszerítése	folder.enforceSignWorkflow	boolean	Azt jelzi, hogy a címzetteknek be kell-e jelentkezniük a megadott sorrendbe.
Aktuális lépés	folder.currentWorkflowStep	integer	Az aláírási munkafolyamat aktuális lépése.
Tranzakció forrása	folder.transactionSource	string	A tranzakciót kezdeményező forrásrendszer.
Módosítható	folder.editable	boolean	Azt jelzi, hogy az elem szerkeszthető-e.
In-Person aláírása	folder.inPersonSignable	boolean	Jelzi, hogy a borítékot személyesen lehet-e aláírni.
Emlékeztetők felülbírálása	folder.overrideAccountReminders	boolean	Azt jelzi, hogy a fiókszintű emlékeztető beállításai felül vannak-e bírálva.
Delegálás felülbírálása	folder.overrideAccountRecipientDelegation	boolean	Azt jelzi, hogy a fiókszintű delegálási beállítások felül vannak-e bírálva.
Delegálás engedélyezése	folder.allowRecipientsToDelegate	boolean	Azt jelzi, hogy a címzettek delegálhatják-e az aláírást.
azonosító	folder.envelopeId	integer	A boríték egyedi azonosítója.
Név	folder.envelopeName	string	A boríték neve.
Kezdeményező azonosítója	folder.envelopeOriginatorId	integer	A borítékot létrehozó felhasználó egyedi azonosítója.
Cégazonosító	folder.envelopeCompanyId	integer	A borítékot birtokoló vállalat egyedi azonosítója.
Date	folder.envelopeDate	integer	A boríték létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Megosztott dátum	folder.envelopeSharedDate	integer	A boríték megosztásának dátuma (Unix időbélyeg ezredmásodpercben).
Status	folder.envelopeStatus	string	A boríték aktuális állapota.
Szerződésazonosítók	folder.envelopeContractIds	array of integer	A borítékhoz társított szerződésazonosítók listája.
Címzett engedélyei	folder.envelopePartyPermissions	array of object	A boríték címzett engedélyeinek listája.
Címzett azonosítója	folder.envelopePartyPermissions.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	folder.envelopePartyPermissions.partyDetails.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	folder.envelopePartyPermissions.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	folder.envelopePartyPermissions.partyDetails.lastName	string	A címzett vezetékneve.
E-mail-cím	folder.envelopePartyPermissions.partyDetails.emailId	string	A címzett e-mail-címe.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Azt jelzi, hogy ez a fél helyőrző címzett-e.
Address	folder.envelopePartyPermissions.partyDetails.address	string	A címzett fizikai címe.
Létrehozás dátuma	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	A rekord létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
E-mailek letiltása	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Jelzi, hogy a címzett lemondta-e az e-mail-értesítéseket.
Egyedi címzett-azonosító	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	A címzett egyedi rendszerazonosítója.
Hitelesítési szint	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	A címzetthez szükséges hitelesítési módszer.
Jelszó frissítése dátuma	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	A jelszó utolsó frissítésének dátuma.
Jelszóval frissített állapot	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Azt jelzi, hogy a jelszó frissült-e.
Cégazonosító	folder.envelopePartyPermissions.partyDetails.companyId	integer	A vállalat egyedi azonosítója.
Felhasználói szerepkör	folder.envelopePartyPermissions.partyDetails.userRole	string	A felhasználóhoz rendelt szerepkör.
Department	folder.envelopePartyPermissions.partyDetails.department	string	Az a részleg, amelyhez a felhasználó tartozik.
Cím	folder.envelopePartyPermissions.partyDetails.title	string	A felhasználó beosztása.
Aktív	folder.envelopePartyPermissions.partyDetails.active	boolean	Azt jelzi, hogy a felhasználó vagy a rekord aktív-e.
Helyszín	folder.envelopePartyPermissions.partyDetails.requestLocale	string	A felhasználó területi beállítása.
Megosztás a Depttel	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Azt jelzi, hogy a borítékok meg vannak-e osztva a részlegen.
Tárcsázási kód	folder.envelopePartyPermissions.partyDetails.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	A mobiltelefonszám.
Állapotszűrő	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	A dokumentum állapotának szűrője.
Dátumszűrő	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	A dokumentumdátum szűrője.
Biztonságos mezőhozzáférés	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Azt jelzi, hogy a felhasználó rendelkezik-e hozzáféréssel a biztonságos mezőkhöz.
Oldalsáv kibontása	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Azt jelzi, hogy az oldalsáv alapértelmezés szerint ki van-e bontva.
Adv. E-mail-ellenőrzés	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Azt jelzi, hogy engedélyezve van-e a speciális e-mail-ellenőrzés.
Vezető azonosítója	folder.envelopePartyPermissions.partyDetails.managerId	string	A felhasználó kezelőjének egyedi azonosítója.
Bejelentkezések száma	folder.envelopePartyPermissions.partyDetails.loginCount	integer	A felhasználó által bejelentkezett alkalmak száma.
E-mail jelszó kérése	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Azt jelzi, hogy a jelszó-visszaállítási e-mailt kell-e küldeni.
Részlegazonosító	folder.envelopePartyPermissions.partyDetails.departmentId	string	A részleg egyedi azonosítója.
Elsődleges vállalat	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	A felhasználóhoz társított elsődleges vállalat.
Eszköz típusa	folder.envelopePartyPermissions.partyDetails.deviceType	string	A használt eszköz típusa.
Eszközjogkivonat	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Az eszköz leküldéses értesítési jogkivonata.
Alvállalkozó leírása	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Az alvállalkozó vagy a külső aláíró leírása.
Alvállalkozói szervezet	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Az alvállalkozó vagy külső aláíró szervezetneve.
Alvállalkozó hozzáadott dátuma	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Az alvállalkozó hozzáadásának dátuma (Unix időbélyeg ezredmásodpercben).
Forrás	folder.envelopePartyPermissions.partyDetails.source	string	A forrásrendszer, amelyből a külső aláírót hozzáadták.
Tárcsázási kód	folder.envelopePartyPermissions.dialingCode	string	A telefonszám nemzetközi tárcsázási kódja.
Mobilszám	folder.envelopePartyPermissions.mobileNumber	string	A mobiltelefonszám.
Aláírás típusa	folder.envelopePartyPermissions.signerSignatureType	string	Az aláíró által használt aláírás típusa.
Jogosultságok	folder.envelopePartyPermissions.contractPermissions	string	A feleknek a szerződéshez adott engedélyek.
Aláírási rendelés	folder.envelopePartyPermissions.partySequence	integer	A címzett aláírási rendelésének sorszáma.
Munkafolyamat-sorozat	folder.envelopePartyPermissions.workflowSignSequence	integer	A munkafolyamat aláírási sorszáma.
Boríték azonosítója	folder.envelopePartyPermissions.envelopeId	integer	A boríték egyedi azonosítója.
Címzett cégazonosítója	folder.envelopePartyPermissions.partyCompanyId	integer	A címzetthez társított vállalat egyedi azonosítója.
Megosztási mód	folder.envelopePartyPermissions.sharingMode	string	A boríték megosztási módja.
Címzett hozzáférési URL-címe	folder.envelopePartyPermissions.folderAccessURL	string	A címzett által a boríték elérésére és aláírására használható URL-cím.
Biztonsági mód	folder.envelopePartyPermissions.securityMode	string	A borítékra alkalmazott biztonsági mód.
Comments	folder.envelopePartyPermissions.extraComments	string	További megjegyzések a borítékban.
Névváltoztatás engedélyezése	folder.envelopePartyPermissions.allowNameChange	boolean	Azt jelzi, hogy a címzett frissítheti-e a nevét.
Név frissítve	folder.envelopePartyPermissions.signerNameUpdated	boolean	Azt jelzi, hogy az aláíró frissítette-e a nevét.
Aláíró hitelesítési szintje	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Az aláíróhoz szükséges hitelesítési szint.
Hozzáférési kód	folder.envelopePartyPermissions.userDefinedAccessCode	string	Az aláíróhoz definiált egyéni hozzáférési kód.
Aláírás azonosítója	folder.envelopePartyPermissions.signatureId	string	Az aláírás egyedi azonosítója.
Címzett szerepkör	folder.envelopePartyPermissions.partyRole	string	A címzetthez rendelt szerepkör az aláírási munkafolyamatban.
Céges mező	folder.envelopePartyPermissions.companyFieldValue	string	A cégnév mező értéke az aláírásban.
Címmező	folder.envelopePartyPermissions.titleFieldValue	string	Az aláírás címmezőjének értéke.
Az aláírás oka	folder.envelopePartyPermissions.reasonSigning	string	A címzett aláírásának oka.
Fizetési mező hozzáadva	folder.envelopePartyPermissions.payFieldAdded	boolean	Azt jelzi, hogy egy fizetési mező lett-e hozzáadva.
Kedvezményezett	folder.envelopePartyPermissions.payee	boolean	Azt jelzi, hogy ez a címzett-e a kedvezményezett.
Ismétlődő fizetés	folder.envelopePartyPermissions.recurringFieldExist	boolean	Azt jelzi, hogy létezik-e ismétlődő fizetési mező.
Nyomtatás és aláírás kész	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Azt jelzi, hogy a nyomtatási és aláírási folyamat befejeződött-e.
Paid	folder.envelopePartyPermissions.paid	boolean	Jelzi, hogy a fizetés befejeződött-e.
Hitelesítési szint	folder.envelopeAuthenticationLevel	string	A borítékhoz szükséges hitelesítési szint.
Egyszeri aláíró tömeges	folder.allowSingleSignerInBulk	boolean	Azt jelzi, hogy egyetlen aláíró engedélyezve van-e tömeges küldési módban.
File-Based elnevezése	folder.folderNameBasedOnFileNaming	boolean	Azt jelzi, hogy a mappa neve a fájlnéven alapul-e.
Dokumentum File-Based neve	folder.documentNameBasedOnFileNaming	boolean	Azt jelzi, hogy a dokumentum neve a fájlnéven alapul-e.
Tanúsítvány File-Based neve	folder.certificateNameBasedOnFileNaming	boolean	Azt jelzi, hogy a tanúsítvány neve a fájlnéven alapul-e.
Exec előtti fájlelnevezés	folder.enableFileNamingBeforeExecution	boolean	Azt jelzi, hogy engedélyezve van-e a fájlelnevezés a dokumentum végrehajtása előtt.
Kedvezményezett hozzáadva	folder.payeeAddedd	boolean	Azt jelzi, hogy a kedvezményezett hozzá lett-e adva.
Self-Signing engedélyezve	folder.selfSignerEnabled	boolean	Azt jelzi, hogy engedélyezve van-e az önaláírási mód.
Közjegyző engedélyezve	folder.notaryEnabled	boolean	Azt jelzi, hogy engedélyezve van-e a közjegyzői aláírás.
Korlátozott láthatóság	folder.limitedVisibilityFlag	boolean	Azt jelzi, hogy engedélyezve van-e a korlátozott láthatóság ehhez a borítékhoz.
Aláírás utáni láthatóság	folder.postSigningVisibility	boolean	Azt jelzi, hogy engedélyezve van-e az aláírás utáni láthatóság.
Nedves aláírás	folder.wetSignatureEnabled	boolean	Azt jelzi, hogy engedélyezve vannak-e a nedves aláírások.
Egyesítés engedélyezve	folder.mergeEnabled	boolean	Azt jelzi, hogy engedélyezve van-e a dokumentumegyesítés.
Beágyazott aláíró munkamenetek	embeddedSigningSessions	array of object	A beágyazott aláíró munkamenetek listája, címzettenként egy. Csak akkor jelenik meg, ha a createEmbeddedSigningSession igaz.
Aláíró e-mail-címe	embeddedSigningSessions.emailIdOfSigner	string	A beágyazott aláíró munkamenet címzettjének e-mail-címe.
Aláírási jogkivonat	embeddedSigningSessions.embeddedToken	string	A címzett beágyazott aláíró munkamenetének egyedi jogkivonata.
Aláíró munkamenet URL-címe	embeddedSigningSessions.embeddedSessionURL	string	A címzett számára a dokumentum aláírásához megnyitni vagy beágyazni kívánt URL-cím.
Beágyazott küldési jogkivonat	embeddedToken	string	A beágyazott küldési munkamenet jogkivonata. Csak akkor jelenik meg, ha a createEmbeddedSendingSession igaz.
Munkamenet URL-címének küldése	embeddedSessionURL	string	A boríték készítőjének a boríték elkészítéséhez és elküldéséhez szükséges URL-cím. Csak akkor jelenik meg, ha a createEmbeddedSendingSession igaz.
Result	result	string	A művelet eredménye.
Message	message	string	A művelet eredményét leíró üzenet.

Boríték megszakítása

Műveletazonosító:

CancelEnvelope

Visszavonja az elküldött borítékot. A címzettek a továbbiakban nem tudják aláírni a dokumentumokat.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	folderId	True	integer	A lemondandó boríték azonosítója.
A lemondás oka	reason_for_cancellation	True	string	A boríték lemondásának oka. Ezt a borítéktevékenységek előzményei rögzítik.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Törölt borítékazonosítók	folders cancelled	array of integer	A sikeresen törölt borítékazonosítók listája.

Boríték részleteinek lekérése

Műveletazonosító:

GetEnvelopeDetails

Lekéri a boríték teljes adatait, beleértve az állapotát, a címzetteket és a dokumentumokat.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	folderId	True	integer	A lekérendő boríték egyedi azonosítója.
Hozzáférési jogkivonat	access_token		string	Az OAuth 2.0 hitelesítési jogkivonata.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a művelet sikeres volt-e (pl. "siker").
azonosító	folder.folderId	integer	A boríték egyedi azonosítója.
Név	folder.folderName	string	A boríték neve.
Szerző azonosítója	folder.folderAuthorId	integer	A borítékot létrehozó felhasználó egyedi azonosítója.
Szerző utóneve	folder.folderAuthorFirstName	string	A borítékkészítő utóneve.
Szerző vezetékneve	folder.folderAuthorLastName	string	A borítékkészítő vezetékneve.
Szerző e-mail	folder.folderAuthorEmail	string	A boríték létrehozójának e-mail-címe.
Szerzői szerepkör	folder.folderAuthorRole	string	A borítékkészítő fiókszerepköre.
Cégazonosító	folder.folderCompanyId	integer	Annak a cégnek az egyedi azonosítója, amelyhez a boríték tartozik.
Létrehozás dátuma	folder.folderCreationDate	integer	A boríték létrehozásának dátuma és időpontja Unix ezredmásodpercben.
Elküldött dátum	folder.folderSentDate	integer	A boríték elküldésének dátuma és időpontja Unix ezredmásodpercben. Null érték, ha még nincs elküldve.
Status	folder.folderStatus	string	A boríték aktuális állapota (pl. MEGOSZTOTT, VÉGREHAJTVA, PISZKOZAT, VISSZAVONVA).
Dokumentumazonosítók	folder.folderDocumentIds	array of integer	A borítékban szereplő dokumentumazonosítók listája.
Documents	folder.documentsList	array of object	A borítékban szereplő minden dokumentum részletei.
Dokumentumazonosító	folder.documentsList.documentId	integer	A dokumentum egyedi azonosítója.
Szerződés azonosítója	folder.documentsList.contractId	integer	A dokumentumhoz társított szerződés egyedi azonosítója.
Cégazonosító	folder.documentsList.companyId	integer	Annak a vállalatnak az egyedi azonosítója, amelyhez ez a dokumentum tartozik.
Készítette:	folder.documentsList.contractCreatedBy	integer	A szerződést létrehozó személy felhasználói azonosítója.
Létrehozás dátuma:	folder.documentsList.contractCreatedOn	integer	A szerződés létrehozásának dátuma Unix ezredmásodpercben.
Szerződés típusa	folder.documentsList.contractType	string	A szerződés típusa vagy kategóriája.
Dokumentum állapota	folder.documentsList.contractStatus	string	A dokumentum aktuális aláírási állapota (például WAITING_FOR_SIGNATURE, EXECUTED).
Módosítható	folder.documentsList.editable	boolean	Azt jelzi, hogy a dokumentum szerkeszthető-e.
Verzióazonosító	folder.documentsList.contractVersionId	integer	Az aktuális dokumentumverzió egyedi azonosítója.
Verzió neve	folder.documentsList.contractVersionName	string	Az aktuális dokumentumverzió neve.
Verzió leírása	folder.documentsList.contractVersionDesc	string	Az aktuális dokumentumverzió leírása.
Által létrehozott verzió	folder.documentsList.versionCreatedby	integer	A dokumentumverziót létrehozó személy felhasználói azonosítója.
Verzió:	folder.documentsList.versionCreatedOn	integer	A dokumentumverzió létrehozásának dátuma Unix ezredmásodpercben.
Verziószám	folder.documentsList.contractVersionNumber	integer	A dokumentum verziószáma.
Címzettek	folder.folderRecipientParties	array of object	A boríték címzettjeinek listája, beleértve az aláírási állapotukat és a hozzáférési hivatkozásokat.
Címzett azonosítója	folder.folderRecipientParties.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	folder.folderRecipientParties.partyDetails.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	folder.folderRecipientParties.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	folder.folderRecipientParties.partyDetails.lastName	string	A címzett vezetékneve.
Email	folder.folderRecipientParties.partyDetails.emailId	string	A címzett e-mail-címe.
Address	folder.folderRecipientParties.partyDetails.address	string	A címzett címe.
Fiók létrehozási dátuma	folder.folderRecipientParties.partyDetails.dateCreated	integer	A címzett fiókja létrehozásának dátuma Unix ezredmásodpercben.
Jogosultságok	folder.folderRecipientParties.contractPermissions	string	A címzettnek adott aláírási engedélyek (például FILL_FIELDS_AND_SIGN).
Aláírási rendelés	folder.folderRecipientParties.partySequence	integer	A címzett pozíciója az aláírási rendelésben.
Munkafolyamat-sorozat	folder.folderRecipientParties.workflowSignSequence	integer	A címzett munkafolyamat-aláírási sorszáma.
Boríték azonosítója	folder.folderRecipientParties.envelopeId	integer	Annak a borítéknak az azonosítója, amelyhez a címzett tartozik.
Megosztási mód	folder.folderRecipientParties.sharingMode	string	A dokumentumnak a címzettel való megosztására használt módszer (pl. e-mail).
Aláírási URL-cím	folder.folderRecipientParties.folderAccessURL	string	A címzett egyedi aláírási URL-címe. Null értékű, ha a borítékot már befejezték vagy visszavonták.
Biztonsági mód	folder.folderRecipientParties.securityMode	string	A címzett hozzáférésére alkalmazott biztonsági mód.
További megjegyzések	folder.folderRecipientParties.extraComments	string	A címzett aláírási meghívásában szereplő további megjegyzések.
Szerzői hozzáférés URL-címe	folder.folderAccessURLForAuthor	string	A boríték szerzőjének URL-címe a dokumentum eléréséhez. Null értékű, ha nem alkalmazható.
Tömeges azonosító	folder.bulkId	integer	A borítékot küldő tömeges küldési köteg azonosítója, ha van ilyen.
Előrendelés kényszerítése	folder.enforceSignWorkflow	boolean	Azt jelzi, hogy a címzetteknek be kell-e jelentkezniük a megadott sorrendbe.
Aktuális munkafolyamat-lépés	folder.currentWorkflowStep	integer	Az aláírási munkafolyamat aktuális lépése.
Tranzakció forrása	folder.transactionSource	string	A borítéktranzakciót kezdeményező forrás.
Módosítható	folder.editable	boolean	Azt jelzi, hogy a boríték továbbra is szerkeszthető-e.
In-Person aláírása	folder.inPersonSignable	boolean	Jelzi, hogy a borítékot személyesen lehet-e aláírni.
Emlékeztetők felülbírálása	folder.overrideAccountReminders	boolean	Azt jelzi, hogy a fiókszintű emlékeztető beállításai felülbíráltak-e ennél a borítéknál.
azonosító	folder.envelopeId	integer	A boríték egyedi azonosítója. Ugyanaz az érték, mint a Boríték azonosítója (folderId).
Név	folder.envelopeName	string	A boríték neve. Ugyanaz az érték, mint a boríték neve (folderName).
Kezdeményező azonosítója	folder.envelopeOriginatorId	integer	A borítékot létrehozó személy felhasználói azonosítója.
Cégazonosító	folder.envelopeCompanyId	integer	Annak a cégnek az azonosítója, amelyhez a boríték tartozik.
Date	folder.envelopeDate	integer	A boríték létrehozásának dátuma és időpontja Unix ezredmásodpercben.
Megosztott dátum	folder.envelopeSharedDate	integer	A borítéknak a címzettekkel való megosztásának dátuma és időpontja Unix ezredmásodpercben. Null érték, ha még nincs megosztva.
Status	folder.envelopeStatus	string	A boríték aktuális állapota. Ugyanaz az érték, mint a boríték állapota (folderStatus).
Szerződésazonosítók	folder.envelopeContractIds	array of integer	A borítékhoz társított szerződésazonosítók listája.
Fél engedélyei	folder.envelopePartyPermissions	array of object	A címzettek listája és aláírási engedélyei. Ugyanaz a struktúra, mint a címzettek.
Címzett azonosítója	folder.envelopePartyPermissions.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	folder.envelopePartyPermissions.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	folder.envelopePartyPermissions.partyDetails.lastName	string	A címzett vezetékneve.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	A címzett e-mail-címe.
Jogosultságok	folder.envelopePartyPermissions.contractPermissions	string	A címzett aláírási engedélyei.
Aláírási rendelés	folder.envelopePartyPermissions.partySequence	integer	A címzett pozíciója az aláírási rendelésben.
Aláírási URL-cím	folder.envelopePartyPermissions.folderAccessURL	string	A címzett egyedi aláírási URL-címe.
Minden mező	allFields	array of object	A boríték dokumentumaiban elhelyezett aláírás- és űrlapmezők listája.
Mezőazonosító	allFields.fieldTagId	integer	A mező egyedi azonosítója.
Dokumentumazonosító	allFields.contractId	integer	Annak a dokumentumnak az azonosítója, amelyhez ez a mező tartozik.
Verzióazonosító	allFields.versionId	integer	Annak a dokumentumnak a verzióazonosítója, amelyhez ez a mező tartozik.
Mezőtípus	allFields.fieldType	string	A mező típusa (pl. signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
Oldalszám	allFields.documentPageNumber	integer	Az oldalszám, ahová a mező kerül.
Mező dokumentumazonosítója	allFields.docFieldId	string	A mező dokumentumszintű azonosítója.
Felelős fél	allFields.partyResponsible	integer	A mező kitöltéséért felelős félazonosító.
Függő	allFields.dependent	boolean	Azt jelzi, hogy a mező láthatósága függ-e egy másik mező értékétől.
Szükséges	allFields.required	boolean	Azt jelzi, hogy a mezőt ki kell-e tölteni a dokumentum elküldése előtt.
Mező értéke	allFields.value	string	A mező aktuális értéke, ha ki van töltve.
Mezőértékek	allFieldsNameValue	array of object	Az összes mezőnév és azok aktuális értékeinek egyszerűsített listája. Ezzel kitöltött mezők adatait olvashatja be egy aláírt borítékból.
Mezőazonosító	allFieldsNameValue.fieldId	integer	A mező egyedi azonosítója.
Dokumentumazonosító	allFieldsNameValue.documentId	integer	Annak a dokumentumnak az azonosítója, amelyhez ez a mező tartozik.
Verzióazonosító	allFieldsNameValue.documentVersionId	integer	Annak a dokumentumnak a verzióazonosítója, amelyhez ez a mező tartozik.
Mezőtípus	allFieldsNameValue.fieldType	string	A mező típusa (például textfield, signfield, datefield, checkboxfield, dropdownfield).
Mező neve	allFieldsNameValue.name	string	A sablonban meghatározott mező címkéje vagy neve.
Mező értéke	allFieldsNameValue.value	string	A mezőhöz megadott vagy kijelölt érték.
Borítékelőzmények	Folder History	array of object	A borítékon végrehajtott összes művelet naplója időrendi sorrendben.
Keresztnév	Folder History.firstName	string	A műveletet végrehajtó személy utóneve.
Vezetéknév	Folder History.lastName	string	A műveletet végrehajtó személy vezetékneve.
Email	Folder History.email	string	A műveletet végrehajtó személy e-mail-címe.
Boríték azonosítója	Folder History.envelopeId	integer	Annak a borítéknak az azonosítója, amelyen a műveletet végrehajtották.
Date	Folder History.dateChanged	integer	A művelet dátuma és időpontja Unix ezredmásodpercben.
Fél azonosítója	Folder History.changeDoneByParty	integer	A műveletet végrehajtó személy félazonosítója.
Tevékenység	Folder History.action	string	A borítékon végrehajtott művelet (pl. Created, InviteSentTo, InviteAccepted, Signed, Executed).

Borítékazonosítók lekérése

Műveletazonosító:

GetEnvelopeIds

Az állapot szerint szűrt borítékazonosítók listáját adja vissza. Ezzel megkereshet egy adott állapotú borítékot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Dátum innen:	dateFrom	True	string	A boríték létrehozási dátumtartományának kezdete. Elfogadott formátum: YYYY-MM-DD.
Dátum:	dateTo	True	string	A boríték létrehozási dátumtartományának vége. Elfogadott formátum: YYYY-MM-DD. A dateTo értéknek a dateFrom értékétől számított 6 hónapon belül kell lennie.
Status	status		string	Borítékok szűrése állapot szerint. Elfogadott értékek: EXECUTED, SHARED, DRAFT, RÉSZLEGESEN ALÁÍRT, VISSZAVONT, LEJÁRT, TÖRÖLVE. Ha nincs megadva, a rendszer bármilyen állapotú borítékot ad vissza.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Message	message	string	Összegző üzenet, amely azt jelzi, hogy hány borítékazonosító lett visszaadva.
Borítékazonosítók	allFolderIds	array of integer	A szűrőfeltételeknek megfelelő borítékazonosítók listája. A boríték részleteinek lekéréséhez használja ezeket az azonosítókat a boríték részleteinek lekéréséhez.

Borítékfájlok letöltése

Műveletazonosító:

DownloadEnvelopeFiles

Letölti a kitöltött dokumentumokat egy borítékból fájlként.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	folderId	True	string	Annak a borítéknak az egyedi azonosítója, amelynek dokumentumait le szeretné tölteni.

Válaszok

response

binary

Borítékok törlése

Műveletazonosító:

DeleteEnvelopes

Véglegesen töröl egy vagy több borítékot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
folderIds	folderIds		array of integer

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a művelet sikeres volt-e.

Borítékok áthelyezése lomtárba

Műveletazonosító:

MoveEnvelopestoRecycleBin

Egy vagy több boríték áthelyezése a lomtárba. A lomtárban lévő borítékok nem törlődnek véglegesen.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Mappaazonosítók	folderIds	True	array of integer	Borítékazonosítók tömbje, a rajta való működéshez.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a művelet sikeres volt-e.

Borítéktevékenységek előzményeinek lekérése

Műveletazonosító:

GetEnvelopeActivityHistory

Egy boríték teljes tevékenységnaplójának lekérése, amely megjeleníti a címzettek és a feladó által végrehajtott összes műveletet.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	folderId	True	integer	Annak a borítéknak az egyedi azonosítója, amelynek tevékenységi előzményeit le szeretné kérni.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Boríték azonosítója	details.folderId	integer	A boríték egyedi azonosítója.
Csatolt dokumentumok	details.enclosedDocuments	string	A borítékban található dokumentum(ok) neve.
Címzettek	details.envelopeRecipients	string	A borítékon lévő összes címzett neve.
Author	details.author	string	A borítékot létrehozó felhasználó neve.
Status	details.status	string	A boríték aktuális állapota (pl. MEGOSZTOTT, VÉGREHAJTVA, VISSZAVONVA).
Legutóbbi tevékenység dátuma	details.latestActivityDate	string	A borítékon található legutóbbi tevékenység dátuma és időpontja.
Létrehozás dátuma	details.dateCreated	string	A boríték létrehozásának dátuma és időpontja.
Elküldött dátum	details.dateSent	string	A boríték címzetteknek való elküldésének dátuma és időpontja.
Activities	details.activities	array of object	A borítékon végrehajtott összes művelet időrendi listája.
Activity	details.activities.activity	string	A végrehajtott művelet ember által olvasható leírása.
Tevékenység	details.activities.action	string	A végrehajtott művelet típusa (pl. Létrehozás, Elküldött meghívó, Megnyitott, Megtekintett, Aláírt).
User	details.activities.user	string	A műveletet végrehajtó felhasználó neve.
Boríték állapota	details.activities.folderStatus	string	A boríték állapota a művelet végrehajtásakor.
Idő	details.activities.time	string	A művelet dátuma és időpontja.
Forrás	details.activities.source	string	Az a forrás, amelyből a műveletet végrehajtották (pl. web).
IP-cím	details.activities.ipAddress	string	Az IP-cím, amelyről a műveletet végrehajtották, ha elérhető.

E-mail-csoport adatainak lekérése

Műveletazonosító:

GetEmailGroupDetails

Egy meglévő e-mail csoport adatait kéri le.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
E-mail-csoportnevek	emailGroupNames	True	array of string	A csoportok azonosítására használt e-mail-csoportnevek tömbje.

Válaszok

Name	Elérési út	Típus	Description
E-mail-csoportok	allEmailGroups	array of object	A kért csoportneveknek megfelelő e-mail-csoportok listája.
Csoportazonosító	allEmailGroups.groupId	integer	Az e-mail-csoport egyedi azonosítója.
Csoport neve	allEmailGroups.groupName	string	Az e-mail-csoport neve.
Csoport leírása	allEmailGroups.groupDesc	string	Az e-mail-csoport leírása.
Létrehozás dátuma	allEmailGroups.dateCreated	integer	Az e-mail-csoport létrehozásának dátuma Unix ezredmásodpercben.
Cégazonosító	allEmailGroups.companyId	integer	Az a vállalati fiók, amelyhez ez az e-mail-csoport tartozik.
Parties	allEmailGroups.parties	array of object	Az e-mail-csoportban lévő címzettek listája.
Keresztnév	allEmailGroups.parties.firstName	string	A címzett utóneve.
Vezetéknév	allEmailGroups.parties.lastName	string	A címzett vezetékneve.
Email	allEmailGroups.parties.emailId	string	A címzett e-mail-címe.

E-mail-csoport létrehozása

Műveletazonosító:

CreateEmailGroup

Létrehoz egy új e-mail csoportot, amellyel egyszerre több címzettnek küldhet borítékokat.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csoport neve	emailGroupName	True	string	Az új e-mail csoport neve.
Csoport leírása	emailGroupDescription		string	Az e-mail-csoport opcionális leírása.
Speciális e-mail-ellenőrzés engedélyezése	allowAdvancedEmailValidation		boolean	Ha engedélyezve van, a Foxit eSign ellenőrzi, hogy a csoport összes e-mail-címe elérhető-e küldés előtt.
Keresztnév	firstName	True	string	A címzett utóneve.
Vezetéknév	lastName	True	string	A címzett vezetékneve.
Email	emailId	True	string	A címzett e-mail-címe.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Message	message	string	A végrehajtott művelet megerősítő üzenete.
Csoportazonosító	emailGroup.groupId	integer	Az e-mail-csoport egyedi azonosítója. Használja ezt az azonosítót, amikor borítékokat küld a csoportnak.
Csoport neve	emailGroup.groupName	string	Az e-mail-csoport neve.
Csoport leírása	emailGroup.groupDesc	string	Az e-mail-csoport leírása.
Létrehozás dátuma	emailGroup.dateCreated	integer	Az e-mail-csoport létrehozásának dátuma Unix ezredmásodpercben.
Cégazonosító	emailGroup.companyId	integer	Az a vállalati fiók, amelyhez ez az e-mail-csoport tartozik.
Parties	emailGroup.parties	array of object	Az e-mail-csoportban lévő címzettek listája.
Keresztnév	emailGroup.parties.firstName	string	A címzett utóneve.
Vezetéknév	emailGroup.parties.lastName	string	A címzett vezetékneve.
Email	emailGroup.parties.emailId	string	A címzett e-mail-címe.

Egydokumentumos PDF letöltése

Műveletazonosító:

DownloadSingleDocumentPDF

Egyetlen dokumentumot tölt le egy borítékból PDF-fájlként.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	folderId	True	string	A letöltendő dokumentumot tartalmazó boríték egyedi azonosítója.
Dokumentum száma	docNumber	True	string	A letölteni kívánt dokumentum indexe 1-től kezdve.

Válaszok

response

binary

Jelentés letöltése

Műveletazonosító:

DownloadReport

Egy borítéktevékenység-jelentést tölt le Microsoft Excel fájlként. A szűrőkkel az eredményeket állapot, dátumtartomány, borítéknév, szerző vagy aláíró szerint szűkítheti.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
borítékStatus	status		string	Annak a mappának az állapota, amellyel szűrni fogjuk a jelentést
Létrehozás dátuma innen:	creationDateFrom		string	A létrehozási dátumtartomány kezdete. Elfogadott formátum: YYYY-MM-DD.
Létrehozás dátuma	creationDateTo		string	A létrehozási dátumtartomány vége. Elfogadott formátum: YYYY-MM-DD.
Boríték neve	folderName		string	Bármely mappa, amely tartalmazza ezt a sztringet.
Mezők belefoglalása	includeFields		string	Állítsa a "true" értéket a boríték mezőértékeinek a jelentésbe való belefoglalásához. Alapértelmezés szerint "false".
Szerző e-mail	authorEmail		string	Szűrje a jelentést úgy, hogy csak a szerző e-mail-címe által létrehozott borítékokat tartalmazza.
Aláíró e-mail-címe	signerEmail		string	Szűrje a jelentést úgy, hogy csak olyan borítékokat tartalmazzon, ahol ez az e-mail-cím aláíró.

Válaszok

Jelentésfájl

binary

Leiratkozás webhook eseményindító

Műveletazonosító:

DeleteTriggerWebhookChannel

Egy aktív webhookcsatorna-előfizetést töröl a csatornaazonosítója alapján. Ezzel a művelettal törölheti a már nem szükséges webhook-előfizetéseket.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatornaazonosító	channelId	True	integer	A törölni kívánt webhookcsatorna azonosítója.

Sablon létrehozása a Base64-ből

Műveletazonosító:

CreateTemplatefromBase64

Létrehoz egy új sablont egy Base64 kódolású PDF-sztring használatával. Ezt akkor használja, ha a PDF-fájl már elérhető Base64-sztringként a folyamatban, például SharePoint fájlból vagy OneDrive dokumentumból.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Sablon neve	templateName	True	string	A sablon neve. A .pdf kiterjesztéssel kell végződnie (például onboarding.pdf).
Base64 fájlsztring	base64FileString	True	string	EGY PDF BASE64-sztringje a sablon létrehozásához. A sablon létrehozásakor nyilvánosan elérhetőnek kell lennie.
Bemeneti típus	inputType	True	string	A dokumentum bemeneti módszere. Ehhez a művelethez mindig állítsa a "base64" értéket.
Szövegcímkék feldolgozása	processTextTags	True	boolean	Ha engedélyezve van, a Foxit eSign szövegcímkéket keres a dokumentumban, és automatikusan aláírásmezőkké alakítja őket.
Acro-mezők feldolgozása	processAcroFields	True	boolean	Ha engedélyezve van, a Foxit eSign megvizsgálja a dokumentumot az AcroFieldsben, és automatikusan aláírásmezőkké alakítja őket.
Az összes megosztása	shareAll	True	boolean	Ossza meg ezt a sablont a fiókjában lévő összes felhasználóval.
Felek száma	numberOfParties	True	integer	A sablon címzettjeinek száma. 20-nál kisebbnek kell lennie.
Téma színe	themeColor		string	CSS-színérték a beágyazott sablonmunkamenet témájának testreszabásához (például #42caf4).
Szerző e-mail	authorEmail		string	A sablon szerzőjeként beállítani kívánt fiók egy másik felhasználójának e-mail-címe.
Beágyazott sablon munkamenetének létrehozása	createEmbeddedTemplateSession		boolean	Ha igaz értékre van állítva, létrejön egy beágyazott sablonmunkamenet, így közvetlenül megnyithatja a Foxit eSign sablonszerkesztőt, és a mezőket a sablonra húzhatja.
Átirányítási URL-cím	redirectURL		string	Ha a Beágyazott sablon létrehozása munkamenet igaz, a beágyazott sablonszerkesztőBen a Mentés és bezárás gombra kattintás után a felhasználót átirányító URL-cím.
Sablon küldése elrejtése	hideSendTemplate		boolean	Ha igaz, a Küldés gomb rejtett a beágyazott sablonszerkesztőben.
Címzett felek javítása	fixRecipientParties		boolean	Ha igaz, a már hozzáadott címzett felek nem módosíthatók a beágyazott sablonszerkesztőben.
Mezők	Fields		object
engedélyek	permission	True	string
Sequence	sequence	True	integer	A parti egyedi sorszáma 1-től kezdve. Meghatározza az aláírási sorrendet, ha engedélyezve van a bejelentkezési sorrend.
Címzett szerepkör	partyRole	True	string	A sablonban ehhez a félhez rendelt szerepkör.
További műveletek elrejtése	hideMoreAction		boolean	Ha ez igaz, a További műveletek gomb el van rejtve a beágyazott sablon munkamenetében.
Megosztás elrejtése az összeskel	hideShareWithAll		boolean	Ha igaz, a Megosztás mindennel lehetőség elrejtve van a beágyazott sablon munkamenetében.
Párt hozzáadása elrejtése	hideAddParty		boolean	Ha ez igaz, a beágyazott sablon munkamenetében minden hozzáadási lehetőség el van rejtve.
Elrejtés gomb	hideMeButton		boolean	Ha igaz, a címzett feleken lévő Én gomb el van rejtve a beágyazott sablon munkamenetben.
Mások elrejtése gomb	hideOthersButton		boolean	Ha igaz, a címzett felek Egyéb gombja elrejtve van a beágyazott sablon munkamenetében.
Címzettek mezőnevének elrejtése	hideFieldNameForRecipients		boolean	Ha igaz, a mezőnevek rejtettek az adatbevitel és a speciális mezők címzettjei elől.
Jelölőnégyzetszegély elrejtése	hideCheckboxBorder		boolean	Ha igaz, a jelölőnégyzetszegélyek rejtettek a végrehajtott dokumentumokban.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a művelet sikeres volt-e (pl. "siker").
Message	message	string	A művelet eredményének leírása.
azonosító	template.templateId	integer	A létrehozott sablon egyedi azonosítója. Ezzel borítékokat hozhat létre ebből a sablonból.
Név	template.templateName	string	A sablon neve.
Description	template.templateDesc	string	A sablon leírása.
Típus	template.templateType	string	A sablon típusa.
Létrehozás dátuma	template.templateCreationDate	string	A sablon létrehozásának dátuma.
Utolsó frissítés dátuma	template.templateLastUpdateDate	string	A sablon utolsó frissítésének dátuma.
Módosítható	template.editable	boolean	Azt jelzi, hogy a sablon szerkeszthető-e.
Felek száma	template.numberOfParties	integer	A sablonban meghatározott címzettek száma.
Összes oldal	template.totalPages	integer	A sablondokumentum lapjainak teljes száma.
Cégazonosító	template.companyId	integer	Annak a vállalatnak az azonosítója, amelyhez a sablon tartozik.
Megosztva az összeskel	template.shareAll	boolean	Azt jelzi, hogy a sablon meg van-e osztva a fiók összes felhasználójával.
Fél engedélyei	template.templatePartyPermissions	array of object	A címzetti szerepkörök listája és a sablonban meghatározott engedélyük.
Fél azonosítója	template.templatePartyPermissions.template_party_id	integer	A sablonparti bejegyzés egyedi azonosítója.
azonosító	template.templatePartyPermissions.templateId	integer	Annak a sablonnak az azonosítója, amelyhez a fél tartozik.
Jogosultságok	template.templatePartyPermissions.templatePermissions	string	A fél aláírási engedélyei (például FILL_FIELDS_AND_SIGN).
Aláírási rendelés	template.templatePartyPermissions.partySequence	integer	A fél aláírási rendelési pozíciója.
Pártszerepkör	template.templatePartyPermissions.templatePartyRole	string	A sablonban ehhez a félhez rendelt szerepkörnév. Használja ezt a sablonból származó boríték létrehozásakor.
Felhasználói azonosító	template.templateCreatedBy.partyId	integer	A felhasználó egyedi azonosítója.
Keresztnév	template.templateCreatedBy.firstName	string	A felhasználó utóneve.
Vezetéknév	template.templateCreatedBy.lastName	string	A felhasználó vezetékneve.
Email	template.templateCreatedBy.emailId	string	A felhasználó e-mail címe.
Sablonmezők	allfields	array of object	A sablonban definiált összes aláírás- és űrlapmező listája.
Mezőazonosító	allfields.fieldTagId	integer	A mező egyedi azonosítója.
Sablon ID	allfields.templateId	integer	Annak a sablonnak az azonosítója, amelyhez ez a mező tartozik.
Cégazonosító	allfields.companyId	integer	A mezőhöz tartozó vállalati fiók.
Mezőtípus	allfields.fieldType	string	A mező típusa (pl. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Oldalszám	allfields.documentPageNumber	integer	Annak a dokumentumnak az oldalszáma, amelyben a mező található.
Felelős fél	allfields.partyResponsible	integer	A mező kitöltéséért felelős félütemezési szám.
Partiütemezés	allfields.partyResponsibleSequence	integer	A felelős fél sorrendi pozíciója.
Mező dokumentumazonosítója	allfields.docFieldId	string	A mező dokumentumszintű azonosítója.
Függő	allfields.dependent	boolean	Azt jelzi, hogy a mező láthatósága függ-e egy másik mező értékétől.
Tabulátorsorrend	allfields.tabOrder	integer	A mezők közötti navigálás lapsorrendje.
Szükséges	allfields.required	boolean	Azt jelzi, hogy a mezőt ki kell-e tölteni a dokumentum aláírása előtt.
Egyéni mező neve	allfields.customFieldName	string	A mezőhöz rendelt egyéni név.
Az összes megosztása	allfields.shareAll	boolean	Azt jelzi, hogy ez a mező meg van-e osztva az összes felhasználóval.
Szerkesztés engedélyezése	allfields.allowEdit	boolean	Azt jelzi, hogy a címzett szerkesztheti-e ezt a mezőt.
Szövegmező neve	allfields.textfieldName	string	A szövegmező címkéje (akkor alkalmazható, ha a mezőtípus "szövegmező").
Érték	allfields.value	string	A mező előre kitöltött vagy beírt értéke.
Betűméret	allfields.fontSize	integer	A mező szövegéhez használt betűméret.
Betűszín	allfields.fontColor	string	A mező szövegéhez használt betűszín (pl. #0000000).
Csak olvasható	allfields.readOnly	boolean	Azt jelzi, hogy a mező írásvédett-e, és a címzett nem szerkesztheti-e.
Többsoros	allfields.multiLine	boolean	Azt jelzi, hogy a szövegmező több sornyi bemenetet fogad-e el (akkor alkalmazható, ha a fieldType mező "szövegmező").
Karakterkorlát	allfields.characterLimit	integer	A mezőben megengedett karakterek maximális száma (akkor alkalmazható, ha a mezőtípus szövegmező).
Dátummező neve	allfields.datefieldName	string	A dátummező címkéje (akkor alkalmazható, ha a mezőtípus "datefield").
Dátumformátum	allfields.dateFormat	string	A mező által használt dátumformátum (például MM/DD/YYYY) (akkor alkalmazható, ha a mezőtípus "datefield").
Jelölőnégyzet neve	allfields.cbname	string	A jelölőnégyzet címkéje (akkor alkalmazható, ha a fieldType mező).
Jelölőnégyzetcsoport	allfields.cbgroup	string	A jelölőnégyzet csoportneve (akkor érvényes, ha a fieldType mező).
Ellenőrizve	allfields.checked	boolean	Azt jelzi, hogy a jelölőnégyzet alapértelmezés szerint be van-e jelölve (akkor érvényes, ha a fieldType mező "jelölőnégyzetmező").
Védett mező neve	allfields.securedfieldName	string	A védett mező címkéje (akkor alkalmazható, ha a fieldType "biztonságos mező").
Megjelenítendő karakter	allfields.charToDisplay	integer	A védett mezőérték végén megjelenítendő maszkolt karakterek száma (akkor alkalmazható, ha a fieldType értéke "biztonságos mező").
Aláírás azonosítója	allfields.signatureId	string	Az erre a jelmezőre alkalmazott aláírás azonosítója (akkor érvényes, ha a fieldType mező "signfield").
Kezdeti kép	allfields.initialImage	string	A mezőre alkalmazott monogramok képadatai (akkor érvényesek, ha a fieldType a "initialfield" mező).
Mellékletmező neve	allfields.attachmentfieldName	string	A mellékletmező neve (akkor alkalmazható, ha a fieldType a "attachmentfield" mező).
Melléklet leírása	allfields.attachmentfieldDescription	string	A csatolandó elemek leírása (akkor alkalmazható, ha a fieldType a "attachmentfield").

Sablon létrehozása URL-címből

Műveletazonosító:

CreateTemplatefromURL

Létrehoz egy új sablont egy nyilvánosan elérhető PDF-URL-cím használatával.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Sablon neve	templateName	True	string	A sablon neve. A .pdf kiterjesztéssel kell végződnie (például onboarding.pdf).
Sablon URL-címe	templateUrl	True	string	A sablonként használni kívánt PDF-dokumentum nyilvánosan elérhető URL-címe.
Bemeneti típus	inputType	True	string	A dokumentum bemeneti módszere. Ehhez a művelethez mindig állítsa be az "URL" értéket.
Szövegcímkék feldolgozása	processTextTags	True	boolean	Ha engedélyezve van, a Foxit eSign szövegcímkéket keres a dokumentumban, és automatikusan aláírásmezőkké alakítja őket.
Acro-mezők feldolgozása	processAcroFields	True	boolean	Ha engedélyezve van, a Foxit eSign megvizsgálja a dokumentumot az AcroFieldsben, és automatikusan aláírásmezőkké alakítja őket.
Az összes megosztása	shareAll	True	boolean	Ossza meg ezt a sablont a fiókjában lévő összes felhasználóval.
Felek száma	numberOfParties	True	integer	Adja hozzá a sablonban szereplő felek számát. A paraméter értékeinek 20-nál kisebbnek kell lenniük.
Téma színe	themeColor		string	Adjon meg egy css-értéket egy színhez a createEmbeddedTemplateSession témájának módosításához.
Szerző e-mail	authorEmail		string	Adjon meg egy másik felhasználó e-mail-címét egy olyan fiókban, amelyet a sablon szerzőjeként használunk.
Beágyazott sablon munkamenetének létrehozása	createEmbeddedTemplateSession		boolean	Ha igaz értékre van állítva, egy beágyazott sablon munkamenettel közvetlenül megnyithatja a Foxit eSign-sablon előkészítő nézetét. A sablon különböző mezőinek húzása és elvetése elérhető lesz.
Átirányítás URL-címe	redirectURL		string	Ha a createEmbeddedTemplateSession igaz, az abszolút URL-cím bármely webhely/alkalmazás kezdőlapjára beírható, amelyre a beágyazott sablon nézetben a "Mentés és bezárás" gombra kattintás után a rendszer átirányítja a felhasználót.
Sablon küldése elrejtése	hideSendTemplate		boolean	Ha igaz, elrejti a Küldés gombot egy beágyazott sablonnézetben.
Címzett felek javítása	fixRecipientParties		boolean	Ha igaz, akkor a beágyazott sablon nézetben nem módosíthatók a már hozzáadott borítékhoz tartozó felek.
Mezők	Fields		object
engedélyek	permission	True	string
Sequence	sequence	True	integer	A parti egyedi sorszáma 1-től kezdve. Meghatározza az aláírási sorrendet, ha engedélyezve van a bejelentkezési sorrend.
Címzett szerepkör	partyRole	True	string	A sablonban ehhez a félhez rendelt szerepkör.
További műveletek elrejtése	hideMoreAction		boolean	Ha igaz, elrejti a "További műveletek" gombot a sablon munkamenetében.
Megosztás elrejtése az összeskel	hideShareWithAll		boolean	Ha igaz, elrejti a "Megosztás az összesgel" lehetőséget a sablonmunkamenetben.
Párt hozzáadása elrejtése	hideAddParty		boolean	Ha igaz, az elrejti a felek összes beállítását egy beágyazott sablonmunkamenetben.
Elrejtés gomb	hideMeButton		boolean	Ha igaz, az elrejti a "Me" gombot a címzett feleken egy beágyazott sablonmunkamenetben.
Mások elrejtése gomb	hideOthersButton		boolean	Ha igaz, elrejti a "Mások" gombot a címzett feleken egy beágyazott sablon-munkamenetben.
Meglévő partnerválasztási lehetőség elrejtése	hideExistingContactSelectOption		boolean	Ha igaz, elrejti a "Meglévő partner keresése és hozzáadása" beviteli mezőt a címzett feleken egy beágyazott sablonmunkamenetben.
Címzettek mezőnevének elrejtése	hideFieldNameForRecipients		boolean	Adatbeviteli mezők és speciális mezők címzettjeinek mezőneveinek elrejtése. (Kivéve a választógombot, a jelölőnégyzetet, a képet és a hivatkozást).
Jelölőnégyzetszegély elrejtése	hideCheckboxBorder		boolean	A jelölőnégyzet szegélyei el lesznek rejtve a végrehajtott dokumentumokban.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a művelet sikeres volt-e (pl. "siker").
Message	message	string	A művelet eredményének leírása.
azonosító	template.templateId	integer	A létrehozott sablon egyedi azonosítója. Ezzel borítékokat hozhat létre ebből a sablonból.
Név	template.templateName	string	A sablon neve.
Description	template.templateDesc	string	A sablon leírása.
Típus	template.templateType	string	A sablon típusa.
Létrehozás dátuma	template.templateCreationDate	string	A sablon létrehozásának dátuma.
Utolsó frissítés dátuma	template.templateLastUpdateDate	string	A sablon utolsó frissítésének dátuma.
Módosítható	template.editable	boolean	Azt jelzi, hogy a sablon szerkeszthető-e.
Felek száma	template.numberOfParties	integer	A sablonban meghatározott címzettek száma.
Összes oldal	template.totalPages	integer	A sablondokumentum lapjainak teljes száma.
Cégazonosító	template.companyId	integer	Annak a vállalatnak az azonosítója, amelyhez a sablon tartozik.
Megosztva az összeskel	template.shareAll	boolean	Azt jelzi, hogy a sablon meg van-e osztva a fiók összes felhasználójával.
Egyéni névminta	template.templateCustomName	string	A sablonból létrehozott borítékokra alkalmazott egyéni névminta.
Fél engedélyei	template.templatePartyPermissions	array of object	A címzetti szerepkörök listája és a sablonban meghatározott engedélyük.
Fél azonosítója	template.templatePartyPermissions.template_party_id	integer	A sablonparti bejegyzés egyedi azonosítója.
azonosító	template.templatePartyPermissions.templateId	integer	Annak a sablonnak az azonosítója, amelyhez a fél tartozik.
Jogosultságok	template.templatePartyPermissions.templatePermissions	string	A fél aláírási engedélyei (például FILL_FIELDS_AND_SIGN).
Aláírási rendelés	template.templatePartyPermissions.partySequence	integer	A fél aláírási rendelési pozíciója.
Pártszerepkör	template.templatePartyPermissions.templatePartyRole	string	A sablonban ehhez a félhez rendelt szerepkörnév. Használja ezt a sablonból származó boríték létrehozásakor.
Fél azonosítója	template.templatePartyPermissions.partyId	integer	Az ehhez a szerepkörhöz rendelt fél azonosítója, ha előre hozzárendelték.
Felhasználói azonosító	template.templateCreatedBy.partyId	integer	A felhasználó egyedi azonosítója.
Keresztnév	template.templateCreatedBy.firstName	string	A felhasználó utóneve.
Vezetéknév	template.templateCreatedBy.lastName	string	A felhasználó vezetékneve.
Email	template.templateCreatedBy.emailId	string	A felhasználó e-mail címe.
Cégazonosító	template.templateCreatedBy.companyId	integer	Annak a vállalatnak az azonosítója, amelyhez a felhasználó tartozik.
Felhasználói szerepkör	template.templateCreatedBy.userRole	string	A felhasználó szerepköre a szervezeten belül.
Aktív	template.templateCreatedBy.active	boolean	Azt jelzi, hogy a felhasználó fiókja aktív-e.
Felhasználói azonosító	template.templateLastUpdatedBy.partyId	integer	A felhasználó egyedi azonosítója.
Keresztnév	template.templateLastUpdatedBy.firstName	string	A felhasználó utóneve.
Vezetéknév	template.templateLastUpdatedBy.lastName	string	A felhasználó vezetékneve.
Email	template.templateLastUpdatedBy.emailId	string	A felhasználó e-mail címe.
Cégazonosító	template.templateLastUpdatedBy.companyId	integer	Annak a vállalatnak az azonosítója, amelyhez a felhasználó tartozik.
Felhasználói szerepkör	template.templateLastUpdatedBy.userRole	string	A felhasználó szerepköre a szervezeten belül.
Aktív	template.templateLastUpdatedBy.active	boolean	Azt jelzi, hogy a felhasználó fiókja aktív-e.
Sablonmezők	allfields	array of object	A sablonban definiált összes aláírás- és űrlapmező listája.
Mezőazonosító	allfields.fieldTagId	integer	A mező egyedi azonosítója.
Sablon ID	allfields.templateId	integer	Annak a sablonnak az azonosítója, amelyhez ez a mező tartozik.
Cégazonosító	allfields.companyId	integer	A mezőhöz tartozó vállalati fiók.
Mezőtípus	allfields.fieldType	string	A mező típusa (pl. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Oldalszám	allfields.documentPageNumber	integer	Annak a dokumentumnak az oldalszáma, amelyben a mező található.
Felelős fél	allfields.partyResponsible	integer	A mező kitöltéséért felelős félütemezési szám.
Partiütemezés	allfields.partyResponsibleSequence	integer	A felelős fél sorrendi pozíciója.
Mező dokumentumazonosítója	allfields.docFieldId	string	A mező dokumentumszintű azonosítója.
Függő	allfields.dependent	boolean	Azt jelzi, hogy a mező láthatósága függ-e egy másik mező értékétől.
Tabulátorsorrend	allfields.tabOrder	integer	A mezők közötti navigálás lapsorrendje.
Szükséges	allfields.required	boolean	Azt jelzi, hogy a mezőt ki kell-e tölteni a dokumentum aláírása előtt.
Egyéni mező neve	allfields.customFieldName	string	A mezőhöz rendelt egyéni név.
Az összes megosztása	allfields.shareAll	boolean	Azt jelzi, hogy ez a mező meg van-e osztva az összes felhasználóval.
Szerkesztés engedélyezése	allfields.allowEdit	boolean	Azt jelzi, hogy a címzett szerkesztheti-e ezt a mezőt.
Szövegmező neve	allfields.textfieldName	string	A szövegmező címkéje (akkor alkalmazható, ha a mezőtípus "szövegmező").
Érték	allfields.value	string	A mező előre kitöltött vagy beírt értéke.
Betűméret	allfields.fontSize	integer	A mező szövegéhez használt betűméret.
Betűszín	allfields.fontColor	string	A mező szövegéhez használt betűszín (pl. #0000000).
Csak olvasható	allfields.readOnly	boolean	Azt jelzi, hogy a mező írásvédett-e, és a címzett nem szerkesztheti-e.
Többsoros	allfields.multiLine	boolean	Azt jelzi, hogy a szövegmező több sornyi bemenetet fogad-e el (akkor alkalmazható, ha a fieldType mező "szövegmező").
Karakterkorlát	allfields.characterLimit	integer	A mezőben megengedett karakterek maximális száma (akkor alkalmazható, ha a mezőtípus szövegmező).
Dátummező neve	allfields.datefieldName	string	A dátummező címkéje (akkor alkalmazható, ha a mezőtípus "datefield").
Dátumformátum	allfields.dateFormat	string	A mező által használt dátumformátum (például MM/DD/YYYY) (akkor alkalmazható, ha a mezőtípus "datefield").
Jelölőnégyzet neve	allfields.cbname	string	A jelölőnégyzet címkéje (akkor alkalmazható, ha a fieldType mező).
Jelölőnégyzetcsoport	allfields.cbgroup	string	A jelölőnégyzet csoportneve (akkor érvényes, ha a fieldType mező).
Ellenőrizve	allfields.checked	boolean	Azt jelzi, hogy a jelölőnégyzet alapértelmezés szerint be van-e jelölve (akkor érvényes, ha a fieldType mező "jelölőnégyzetmező").
Védett mező neve	allfields.securedfieldName	string	A védett mező címkéje (akkor alkalmazható, ha a fieldType "biztonságos mező").
Megjelenítendő karakter	allfields.charToDisplay	integer	A védett mezőérték végén megjelenítendő maszkolt karakterek száma (akkor alkalmazható, ha a fieldType értéke "biztonságos mező").
Aláírás azonosítója	allfields.signatureId	string	Az erre a jelmezőre alkalmazott aláírás azonosítója (akkor érvényes, ha a fieldType mező "signfield").
Kezdeti kép	allfields.initialImage	string	A mezőre alkalmazott monogramok képadatai (akkor érvényesek, ha a fieldType a "initialfield" mező).
Mellékletmező neve	allfields.attachmentfieldName	string	A mellékletmező neve (akkor alkalmazható, ha a fieldType a "attachmentfield" mező).
Melléklet leírása	allfields.attachmentfieldDescription	string	A csatolandó elemek leírása (akkor alkalmazható, ha a fieldType a "attachmentfield").

Sablon részleteinek lekérése

Műveletazonosító:

GetTemplateDetails

Lekéri egy adott sablon teljes adatait, beleértve a mezőket és a címzetteket is.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Sablon ID	templateId	True	string	A lekérendő sablon egyedi azonosítója.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
azonosító	template.templateId	integer	A sablon egyedi azonosítója.
Név	template.templateName	string	A sablon neve.
Description	template.templateDesc	string	A sablon leírása.
Típus	template.templateType	string	A sablon típusa.
Létrehozás dátuma	template.templateCreationDate	integer	A sablon létrehozásának dátuma Unix ezredmásodpercben.
Utolsó frissítés dátuma	template.templateLastUpdateDate	integer	A sablon utolsó frissítésének dátuma Unix ezredmásodpercben.
Módosítható	template.editable	boolean	Azt jelzi, hogy a sablon szerkeszthető-e.
Felek száma	template.numberOfParties	integer	A sablonban meghatározott aláíró felek száma.
Összes oldal	template.totalPages	integer	A sablondokumentum lapjainak teljes száma.
Cégazonosító	template.companyId	integer	Az a vállalati fiók, amelyhez a sablon tartozik.
Megosztás az összeskel	template.shareAll	boolean	Azt jelzi, hogy a sablon meg van-e osztva a fiók összes felhasználójával.
Egyéni névminta	template.templateCustomName	string	A sablonból létrehozott borítékokra alkalmazott egyéni névminta.
Fél engedélyei	template.templatePartyPermissions	array of object	A sablonban definiált címzetti szerepkörök listája és aláírási engedélyei.
Fél azonosítója	template.templatePartyPermissions.template_party_id	integer	A sablonparti bejegyzés egyedi azonosítója.
azonosító	template.templatePartyPermissions.templateId	integer	Annak a sablonnak az azonosítója, amelyhez a fél tartozik.
Jogosultságok	template.templatePartyPermissions.templatePermissions	string	A fél aláírási engedélyei (például FILL_FIELDS_AND_SIGN).
Aláírási rendelés	template.templatePartyPermissions.partySequence	integer	A fél aláírási rendelési pozíciója.
Pártszerepkör	template.templatePartyPermissions.templatePartyRole	string	A félhez rendelt szerepkörnév. Ezt az értéket akkor használja, ha ebből a sablonból hoz létre borítékot.
Fél azonosítója	template.templatePartyPermissions.partyId	integer	Az ehhez a szerepkörhöz rendelt fél azonosítója, ha előre hozzárendelték.
Fél azonosítója	template.templateCreatedBy.partyId	integer	A felhasználó egyedi azonosítója.
Keresztnév	template.templateCreatedBy.firstName	string	A felhasználó utóneve.
Vezetéknév	template.templateCreatedBy.lastName	string	A felhasználó vezetékneve.
Email	template.templateCreatedBy.emailId	string	A felhasználó e-mail címe.
Department	template.templateCreatedBy.department	string	A felhasználó részlege.
Cím	template.templateCreatedBy.title	string	A felhasználó beosztása.
Aktív	template.templateCreatedBy.active	boolean	Azt jelzi, hogy a felhasználói fiók aktív-e.
Fél azonosítója	template.templateLastUpdatedBy.partyId	integer	A felhasználó egyedi azonosítója.
Keresztnév	template.templateLastUpdatedBy.firstName	string	A felhasználó utóneve.
Vezetéknév	template.templateLastUpdatedBy.lastName	string	A felhasználó vezetékneve.
Email	template.templateLastUpdatedBy.emailId	string	A felhasználó e-mail címe.
Department	template.templateLastUpdatedBy.department	string	A felhasználó részlege.
Cím	template.templateLastUpdatedBy.title	string	A felhasználó beosztása.
Aktív	template.templateLastUpdatedBy.active	boolean	Azt jelzi, hogy a felhasználói fiók aktív-e.
Minden mező	allfields	array of object	A sablonban definiált összes mező listája.
Mezőcímke azonosítója	allfields.fieldTagId	integer	A mező egyedi azonosítója.
Sablon ID	allfields.templateId	integer	Annak a sablonnak az azonosítója, amelyhez ez a mező tartozik.
Cégazonosító	allfields.companyId	integer	A mezőhöz tartozó vállalati fiók.
Mezőtípus	allfields.fieldType	string	A mező típusa (pl. signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).
Oldalszám	allfields.documentPageNumber	integer	Annak a dokumentumnak az oldalszáma, amelyben a mező található.
Felelős fél	allfields.partyResponsible	integer	A mező kitöltéséért felelős félütemezési szám.
Partiütemezés	allfields.partyResponsibleSequence	integer	A felelős fél sorrendi pozíciója.
Dokumentummező azonosítója	allfields.docFieldId	string	A mező azonosítója a dokumentumban.
Függő	allfields.dependent	boolean	Azt jelzi, hogy a mező láthatósága függ-e egy másik mező értékétől.
Tabulátorsorrend	allfields.tabOrder	integer	A mezők közötti navigálás lapsorrendje.
Szükséges	allfields.required	boolean	Azt jelzi, hogy a mezőt be kell-e fejezni a dokumentum aláírása előtt.
Egyéni mező neve	allfields.customFieldName	string	A mezőhöz rendelt egyéni név.
Az összes megosztása	allfields.shareAll	boolean	Azt jelzi, hogy ez a mező meg van-e osztva az összes felhasználóval.
Szerkesztés engedélyezése	allfields.allowEdit	boolean	Azt jelzi, hogy a címzett szerkesztheti-e ezt a mezőt.
Szövegmező neve	allfields.textfieldName	string	A szövegmező címkéje (akkor alkalmazható, ha a mezőtípus "szövegmező").
Érték	allfields.value	string	A mező előre kitöltött vagy beírt értéke.
Betűméret	allfields.fontSize	integer	A mező szövegéhez használt betűméret.
Betűszín	allfields.fontColor	string	A mező szövegéhez használt betűszín (pl. #0000000).
Csak olvasható	allfields.readOnly	boolean	Azt jelzi, hogy a mező írásvédett-e, és a címzett nem szerkesztheti-e.
Többsoros	allfields.multiLine	boolean	Azt jelzi, hogy a szövegmező több sornyi bemenetet fogad-e el (akkor alkalmazható, ha a fieldType mező "szövegmező").
Karakterkorlát	allfields.characterLimit	integer	A mezőben megengedett karakterek maximális száma (akkor alkalmazható, ha a mezőtípus szövegmező).
Dátummező neve	allfields.datefieldName	string	A dátummező címkéje (akkor alkalmazható, ha a mezőtípus "datefield").
Dátumformátum	allfields.dateFormat	string	A mező által használt dátumformátum (például MM/DD/YYYY) (akkor alkalmazható, ha a mezőtípus "datefield").
Jelölőnégyzet neve	allfields.cbname	string	A jelölőnégyzet címkéje (akkor alkalmazható, ha a fieldType mező).
Jelölőnégyzetcsoport	allfields.cbgroup	string	A jelölőnégyzet csoportneve, amely több jelölőnégyzet összekapcsolásakor használatos (akkor érvényes, ha a fieldType mező mezője "jelölőnégyzetmező").
Ellenőrizve	allfields.checked	boolean	Azt jelzi, hogy a jelölőnégyzet alapértelmezés szerint be van-e jelölve (akkor érvényes, ha a fieldType mező "jelölőnégyzetmező").
Védett mező neve	allfields.securedfieldName	string	A védett mező címkéje (akkor alkalmazható, ha a fieldType "biztonságos mező").
Megjelenítendő karakter	allfields.charToDisplay	integer	A védett mezőérték végén megjelenítendő maszkolt karakterek száma (akkor alkalmazható, ha a fieldType értéke "biztonságos mező").
Aláírás azonosítója	allfields.signatureId	string	Az erre a jelmezőre alkalmazott aláírás azonosítója (akkor érvényes, ha a fieldType mező "signfield").
Kezdeti kép	allfields.initialImage	string	A mezőre alkalmazott monogramok képadatai (akkor érvényesek, ha a fieldType a "initialfield" mező).
Mellékletmező neve	allfields.attachmentfieldName	string	A mellékletmező neve (akkor alkalmazható, ha a fieldType a "attachmentfield" mező).
Melléklet leírása	allfields.attachmentfieldDescription	string	A csatolandó elemek leírása (akkor alkalmazható, ha a fieldType a "attachmentfield").

Sablonok lekérése sablonazonosítók alapján

Műveletazonosító:

GetTemplatesbyTemplateIds

Lekéri egy vagy több sablon részleteit a azonosítójuk alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Sablonazonosítók	templateIds	True	array of integer	A lekérendő sablonazonosítók tömbje.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Összes sablon	total_templates	integer	A visszaadott sablonok teljes száma.
Sablonlista	templateIdList	object	Sablonadatok térképe sablonazonosító alapján. Minden bejegyzés tartalmazza a sablon részleteit és mezőit.

Törölt boríték előzményeinek lekérése

Műveletazonosító:

GetDeletedEnvelopeHistory

Lekéri a törölt vagy a lomtárba áthelyezett borítékok előzményeit.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	folderId	True	string	Annak a borítéknak az egyedi azonosítója, amelynek a törlési előzményeit le szeretné kérni.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
Törölt boríték adatai	Deleted Folder Log Info	array of object	A törölt boríték összesítő információja.
Boríték azonosítója	Deleted Folder Log Info.folderId	integer	A törölt boríték egyedi azonosítója.
Boríték neve	Deleted Folder Log Info.folderName	string	A törölt boríték neve.
Dokumentum neve	Deleted Folder Log Info.documentName	string	A törölt borítékban lévő dokumentum neve.
Dokumentumazonosító	Deleted Folder Log Info.documentId	string	A dokumentum egyedi azonosítója a törölt borítékban.
Törlés dátuma	Deleted Folder Log Info.deletionDate	integer	A boríték törlésének dátuma és időpontja Unix ezredmásodpercben.
Törölte:	Deleted Folder Log Info.deletedBy	string	Annak a felhasználónak a neve, aki törölte a borítékot.
Törlési naplóelőzmények	Deleted Folder Log History	array of object	A borítékon végrehajtott törlési műveletek részletes naplója.
Végrehajtotta:	Deleted Folder Log History.partiesName	string	A törlési lépést végrehajtó felhasználó neve.
Forrás	Deleted Folder Log History.source	string	Az a forrás, amelyről a törlést kezdeményezték (például web, API).
Event	Deleted Folder Log History.event	string	Az elvégzett konkrét törlési művelet (pl. Mappa törlése, Minden fél törlése a mappából).

Webhook csatorna részleteinek lekérése

Műveletazonosító:

GetWebhookChannelDetails

Lekéri egy adott webhookcsatorna adatait.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatornaazonosító	channelId	True	string	A lekérendő webhookcsatorna egyedi azonosítója.

Válaszok

Name	Elérési út	Típus	Description
Result	result	string	Azt jelzi, hogy a kérés sikeres volt-e.
azonosító	channel.channelId	integer	A webhook csatorna egyedi azonosítója.
Cégazonosító	channel.companyId	integer	Az a vállalati fiók, amelyhez ez a csatorna tartozik.
Név	channel.channelName	string	A webhook csatorna neve.
Webhook URL-címe	channel.webhookUrl	string	Az URL-cím, amelyet a Foxit eSign meghív egy előfizetett esemény bekövetkezésekor.
Webhook titkos kódja	channel.webhookSecret	string	A webhook hasznos adatainak ellenőrzéséhez használt titkos kulcs.
Létrehozás dátuma	channel.dateCreated	integer	A csatorna létrehozásának dátuma Unix ezredmásodpercben.
Dátum frissítve	channel.dateUpdated	integer	A csatorna utolsó frissítésének dátuma Unix ezredmásodpercben.
Webhook szintje	channel.webhookLevel	string	A webhook csatorna hatóköre. "Account" (eseményindítók minden borítékhoz) vagy "API-alkalmazás" (csak az API-n keresztül létrehozott borítékok esetén aktiválódik).
Status	channel.status	string	A csatorna aktuális állapota. Vagy "aktív" vagy "deactive".
Boríték elküldve	channel.eventsSubscribedMap.folder_sent	boolean	A boríték címzetteknek való elküldésekor aktiválódik.
Boríték megtekintve	channel.eventsSubscribedMap.folder_viewed	boolean	Akkor aktiválódik, ha egy címzett megnyit egy borítékot.
Boríték aláírva	channel.eventsSubscribedMap.folder_signed	boolean	Akkor aktiválódik, ha egy címzett aláír egy borítékot.
Boríték törölve	channel.eventsSubscribedMap.folder_cancelled	boolean	A boríték törlésekor aktiválódik.
Boríték végrehajtva	channel.eventsSubscribedMap.folder_executed	boolean	Akkor aktiválódik, ha az összes fél aláírta a borítékot, és a borítékot teljes mértékben végrehajtja.
Boríték törölve	channel.eventsSubscribedMap.folder_deleted	boolean	A boríték törlésekor aktiválódik.

Triggerek

Boríték aláírásakor	Aktiválódik, amikor egy címzett aláírja a borítékot.
Boríték küldésekor	A boríték címzetteknek való elküldésekor aktiválódik. Ez az esemény csak akkor aktiválódik, ha a Webhook szint "Fiók" értékre van állítva.
Boríték megtekintésekor	Aktiválódik, amikor egy címzett megnyílik, és megtekinti a borítékot.
Boríték teljes végrehajtásakor	Akkor aktiválódik, ha az összes címzett aláírta a borítékot, és a borítékot teljes mértékben végrehajtja.
Boríték törlésekor	A boríték törlésekor aktiválódik.
Ha egy borítékot törölnek	Akkor aktiválódik, ha egy címzett vagy a feladó megszakítja a borítékot.

Boríték aláírásakor

Műveletazonosító:

TriggerEnvelopeSigned

Aktiválódik, amikor egy címzett aláírja a borítékot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatorna neve	channelName	True	string	A webhook-előfizetés azonosítására szolgáló név a fiókjában.
Webhook szintje	webhookLevel	True	string	Fiók: az összes boríték (web és API) esetében aktiválódik. API-alkalmazás: csak az API-val létrehozott borítékok esetén aktiválódik.
Webhook titkos kódja	webhookSecret		string	Opcionális. A Foxit eSign minden webhook hasznos adatát aláírja a HMAC-SHA-256-tal ezzel a titkos kóddal az ellenőrzéshez.

Válaszok

A Foxit eSign eseményadatai, amikor egy webhook esemény kigyullad.

WebhookEventPayload

WebhookEventPayload

Boríték küldésekor

Műveletazonosító:

TriggerEnvelopeSent

A boríték címzetteknek való elküldésekor aktiválódik. Ez az esemény csak akkor aktiválódik, ha a Webhook szint "Fiók" értékre van állítva.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatorna neve	channelName	True	string	A webhook-előfizetés azonosítására szolgáló név a fiókjában.
Webhook szintje	webhookLevel	True	string	Fiók: a webes vagy API-val küldött borítékok esetében aktiválódik. API-alkalmazás: csak az API-val létrehozott borítékok esetén aktiválódik. A folder_sent esemény csak fiókszinten aktiválódik.
Webhook titkos kódja	webhookSecret		string	Opcionális. A Foxit eSign minden webhook hasznos adatát aláírja a HMAC-SHA-256-tal ezzel a titkos kóddal az ellenőrzéshez.

Válaszok

A Foxit eSign eseményadatai, amikor egy webhook esemény kigyullad.

WebhookEventPayload

WebhookEventPayload

Boríték megtekintésekor

Műveletazonosító:

TriggerEnvelopeViewed

Aktiválódik, amikor egy címzett megnyílik, és megtekinti a borítékot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatorna neve	channelName	True	string	A webhook-előfizetés azonosítására szolgáló név a fiókjában.
Webhook szintje	webhookLevel	True	string	Fiók: az összes boríték (web és API) esetében aktiválódik. API-alkalmazás: csak az API-val létrehozott borítékok esetén aktiválódik.
Webhook titkos kódja	webhookSecret		string	Opcionális. A Foxit eSign minden webhook hasznos adatát aláírja a HMAC-SHA-256-tal ezzel a titkos kóddal az ellenőrzéshez.

Válaszok

A Foxit eSign eseményadatai, amikor egy webhook esemény kigyullad.

WebhookEventPayload

WebhookEventPayload

Boríték teljes végrehajtásakor

Műveletazonosító:

TriggerEnvelopeExecuted

Akkor aktiválódik, ha az összes címzett aláírta a borítékot, és a borítékot teljes mértékben végrehajtja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatorna neve	channelName	True	string	A webhook-előfizetés azonosítására szolgáló név a fiókjában.
Webhook szintje	webhookLevel	True	string	Fiók: az összes boríték (web és API) esetében aktiválódik. API-alkalmazás: csak az API-val létrehozott borítékok esetén aktiválódik.
Webhook titkos kódja	webhookSecret		string	Opcionális. A Foxit eSign minden webhook hasznos adatát aláírja a HMAC-SHA-256-tal ezzel a titkos kóddal az ellenőrzéshez.

Válaszok

A Foxit eSign eseményadatai, amikor egy webhook esemény kigyullad.

WebhookEventPayload

WebhookEventPayload

Boríték törlésekor

Műveletazonosító:

TriggerEnvelopeDeleted

A boríték törlésekor aktiválódik.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatorna neve	channelName	True	string	A webhook-előfizetés azonosítására szolgáló név a fiókjában.
Webhook szintje	webhookLevel	True	string	Fiók: az összes boríték (web és API) esetében aktiválódik. API-alkalmazás: csak az API-val létrehozott borítékok esetén aktiválódik.
Webhook titkos kódja	webhookSecret		string	Opcionális. A Foxit eSign minden webhook hasznos adatát aláírja a HMAC-SHA-256-tal ezzel a titkos kóddal az ellenőrzéshez.

Válaszok

A Foxit eSign eseményadatai, amikor egy webhook esemény kigyullad.

WebhookEventPayload

WebhookEventPayload

Ha egy borítékot törölnek

Műveletazonosító:

TriggerEnvelopeCancelled

Akkor aktiválódik, ha egy címzett vagy a feladó megszakítja a borítékot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Csatorna neve	channelName	True	string	A webhook-előfizetés azonosítására szolgáló név a fiókjában.
Webhook szintje	webhookLevel	True	string	Fiók: az összes boríték (web és API) esetében aktiválódik. API-alkalmazás: csak az API-val létrehozott borítékok esetén aktiválódik.
Webhook titkos kódja	webhookSecret		string	Opcionális. A Foxit eSign minden webhook hasznos adatát aláírja a HMAC-SHA-256-tal ezzel a titkos kóddal az ellenőrzéshez.

Válaszok

A Foxit eSign eseményadatai, amikor egy webhook esemény kigyullad.

WebhookEventPayload

WebhookEventPayload

Definíciók

WebhookEventPayload

A Foxit eSign eseményadatai, amikor egy webhook esemény kigyullad.

Name	Elérési út	Típus	Description
Esemény neve	event_name	string	Az aktivált esemény neve (például folder_sent, folder_signed, folder_executed).
Esemény dátuma	event_date	integer	Az esemény bekövetkezésének dátuma és időpontja (Unix időbélyeg ezredmásodpercben).
azonosító	data.folder.folderId	integer	A boríték egyedi azonosítója.
Név	data.folder.folderName	string	A boríték neve.
Egyéni név	data.folder.folderCustomName	string	A borítékhoz rendelt egyéni név.
Password	data.folder.folderPassword	string	Ha be van állítva a boríték hozzáférési jelszava.
Létrehozó azonosítója	data.folder.folderAuthorId	integer	A boríték létrehozójának felhasználói azonosítója.
Létrehozó utóneve	data.folder.folderAuthorFirstName	string	A borítékkészítő utóneve.
Létrehozó vezetékneve	data.folder.folderAuthorLastName	string	A borítékkészítő vezetékneve.
Létrehozó e-mail-címe	data.folder.folderAuthorEmail	string	A boríték létrehozójának e-mail-címe.
Létrehozói szerepkör	data.folder.folderAuthorRole	string	A borítékkészítő fiókszerepköre.
Cégazonosító	data.folder.folderCompanyId	integer	A borítékot birtokoló cégazonosító.
Létrehozás dátuma	data.folder.folderCreationDate	integer	A boríték létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Elküldött dátum	data.folder.folderSentDate	integer	A boríték elküldésének dátuma (Unix időbélyeg ezredmásodpercben).
Status	data.folder.folderStatus	string	A boríték aktuális állapota.
Egyéni mező 1	data.folder.custom_field1	string	Az első egyéni metaadatmező.
Egyéni mező 2	data.folder.custom_field2	string	A második egyéni metaadatmező.
Metadaták	data.folder.metadata	string	A borítékhoz társított egyéni metaadatok.
Dokumentumazonosítók	data.folder.folderDocumentIds	array of integer	A borítékban lévő dokumentumazonosítók listája.
Documents	data.folder.documentsList	array of object	A borítékban lévő dokumentumok listája.
Dokumentumazonosító	data.folder.documentsList.documentId	integer	A dokumentum egyedi azonosítója.
Szerződés azonosítója	data.folder.documentsList.contractId	integer	A dokumentum szerződésazonosítója.
Cégazonosító	data.folder.documentsList.companyId	integer	A dokumentum cégazonosítója.
Készítette:	data.folder.documentsList.contractCreatedBy	integer	A szerződést létrehozó személy felhasználói azonosítója.
Létrehozás dátuma:	data.folder.documentsList.contractCreatedOn	integer	A szerződés létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Szerződés típusa	data.folder.documentsList.contractType	string	A szerződés típusa.
Szerződés állapota	data.folder.documentsList.contractStatus	string	A szerződés aktuális állapota.
Módosítható	data.folder.documentsList.editable	boolean	Azt jelzi, hogy a dokumentum szerkeszthető-e.
Verzióazonosító	data.folder.documentsList.contractVersionId	integer	A szerződés verzióazonosítója.
Verzió neve	data.folder.documentsList.contractVersionName	string	A szerződés verziójának neve.
Verzió leírása	data.folder.documentsList.contractVersionDesc	string	A szerződés verziójának leírása.
Által létrehozott verzió	data.folder.documentsList.versionCreatedby	integer	A verziót létrehozó személy felhasználói azonosítója.
Verzió:	data.folder.documentsList.versionCreatedOn	integer	A verzió létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Verziószám	data.folder.documentsList.contractVersionNumber	integer	A szerződés verziószáma.
Tranzakció forrása	data.folder.documentsList.contractTransactionSource	string	A szerződést kezdeményező forrásrendszer.
Címzettek	data.folder.folderRecipientParties	array of object	A boríték címzettjeinek listája.
Címzett azonosítója	data.folder.folderRecipientParties.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	data.folder.folderRecipientParties.partyDetails.partyId	integer	A címzett egyedi azonosítója.
Keresztnév	data.folder.folderRecipientParties.partyDetails.firstName	string	A címzett utóneve.
Vezetéknév	data.folder.folderRecipientParties.partyDetails.lastName	string	A címzett vezetékneve.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	A címzett e-mail-címe.
Placeholder	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Hogy ez helyőrző címzett-e.
Address	data.folder.folderRecipientParties.partyDetails.address	string	A címzett címe.
Létrehozás dátuma	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	A címzett rekord létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
E-mailek letiltása	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Azt jelzi, hogy a címzett letiltotta-e az e-maileket.
Egyedi azonosító	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	A címzett egyedi rendszerazonosítója.
Hitelesítési szint	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	A címzett hitelesítési módszere.
Jelszó frissítése dátuma	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	A jelszó utolsó frissítésének dátuma.
Jelszó állapota	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Azt jelzi, hogy a jelszó frissült-e.
Tárcsázási kód	data.folder.folderRecipientParties.dialingCode	string	A nemzetközi tárcsázási kód.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	A címzett mobilszáma.
Aláírás típusa	data.folder.folderRecipientParties.signerSignatureType	string	Az aláíró által használt aláírás típusa.
Jogosultságok	data.folder.folderRecipientParties.contractPermissions	string	A címzettnek adott engedélyek.
Aláírási rendelés	data.folder.folderRecipientParties.partySequence	integer	A címzett aláírási megrendelése.
Munkafolyamat-sorozat	data.folder.folderRecipientParties.workflowSignSequence	integer	A munkafolyamat aláírási sorszáma.
Boríték azonosítója	data.folder.folderRecipientParties.envelopeId	integer	A címzetthez társított borítékazonosító.
Címzett cégazonosítója	data.folder.folderRecipientParties.partyCompanyId	integer	A címzett cégazonosítója.
Megosztási mód	data.folder.folderRecipientParties.sharingMode	string	A címzett megosztási módja.
Címzett aláírási URL-címe	data.folder.folderRecipientParties.folderAccessURL	string	A címzett URL-címe a boríték eléréséhez és aláírásához.
Biztonsági mód	data.folder.folderRecipientParties.securityMode	string	A címzett biztonsági módja.
Comments	data.folder.folderRecipientParties.extraComments	string	További megjegyzések a címzett számára.
Névváltoztatás engedélyezése	data.folder.folderRecipientParties.allowNameChange	boolean	Hogy a címzett frissítheti-e a nevét.
Név frissítve	data.folder.folderRecipientParties.signerNameUpdated	boolean	Azt jelzi, hogy az aláíró frissítette-e a nevüket.
Aláíró hitelesítési szintje	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Az aláíróhoz szükséges hitelesítési szint.
Hozzáférési kód	data.folder.folderRecipientParties.userDefinedAccessCode	string	Egyéni hozzáférési kód az aláíróhoz.
Aláírás azonosítója	data.folder.folderRecipientParties.signatureId	string	Az alkalmazott aláírás azonosítója.
Role	data.folder.folderRecipientParties.partyRole	string	A címzett szerepe az aláírási munkafolyamatban.
Céges mező	data.folder.folderRecipientParties.companyFieldValue	string	A cégnév mező értéke.
Címmező	data.folder.folderRecipientParties.titleFieldValue	string	A címmező értéke.
Az aláírás oka	data.folder.folderRecipientParties.reasonSigning	string	Az aláírás oka.
Fizetési mező hozzáadva	data.folder.folderRecipientParties.payFieldAdded	boolean	A fizetési mező hozzáadása.
Kedvezményezett	data.folder.folderRecipientParties.payee	boolean	Hogy ez a címzett-e a kedvezményezett.
Ismétlődő fizetés	data.folder.folderRecipientParties.recurringFieldExist	boolean	Azt jelzi, hogy létezik-e ismétlődő fizetési mező.
Nyomtatás és aláírás kész	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Azt jelzi, hogy a nyomtatás és az aláírás befejeződött-e.
Nem kötelező aláíró	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Azt jelzi, hogy ez a címzett nem kötelező aláíró-e.
Választható aláírók	data.folder.folderRecipientParties.optionalSigners	array of integer	Választható aláíró félazonosítók.
Paid	data.folder.folderRecipientParties.paid	boolean	Azt jelzi, hogy a kifizetés befejeződött-e.
Szerzői hozzáférés URL-címe	data.folder.folderAccessURLForAuthor	string	A boríték szerzőjének URL-címe a boríték eléréséhez.
Hozzáférési url-cím piszkozata	data.folder.draftFolderAccessURL	string	A boríték piszkozatállapotban való eléréséhez szükséges URL-cím.
Társasszoba aláírása	data.folder.boardRoomSign	boolean	Azt jelzi, hogy engedélyezve van-e a társasházi aláírási mód.
Embléma belefoglalása	data.folder.includeLogo	boolean	Azt jelzi, hogy a cég emblémája szerepel-e az e-mailekben.
Gomb háttérszíne	data.folder.email_btnBgColor	string	Az e-mail művelet gomb háttérszíne.
Gomb szövegszíne	data.folder.email_btnTxtColor	string	Az e-mail művelet gomb szövegszíne.
E-mail e-mail e-	data.folder.emailTemplateLogo	string	Az e-mail-sablonban használt e-mail URL-cím.
E-mail-sablon azonosítója	data.folder.emailTemplateId	integer	A használt e-mail-sablon azonosítója.
E-mail fejléc	data.folder.emailHeader	string	Az értesítési e-mailek fejlécszövege.
E-mail élőláb	data.folder.emailFooter	string	Az élőláb szövege az értesítési e-mailekben.
Ütemezett törlés	data.folder.purgeFlag	boolean	Azt jelzi, hogy a boríték törlésre van-e ütemezve.
Törlés kezdő dátuma	data.folder.purgeStartDate	string	A törlési ütemezés kezdő dátuma.
Végdátum törlése	data.folder.purgeEndDate	string	A törlési ütemezés záró dátuma.
Tömeges azonosító	data.folder.bulkId	integer	A tömeges küldési művelet azonosítója, ha van ilyen.
Előrendelés kényszerítése	data.folder.enforceSignWorkflow	boolean	Azt jelzi, hogy a címzetteknek be kell-e jelentkezniük a megadott sorrendbe.
Aktuális munkafolyamat-lépés	data.folder.currentWorkflowStep	integer	Az aláírási munkafolyamat aktuális lépése.
Tranzakció forrása	data.folder.transactionSource	string	A tranzakciót kezdeményező forrásrendszer.
Módosítható	data.folder.editable	boolean	A boríték szerkeszthető-e.
In-Person aláírása	data.folder.inPersonSignable	boolean	A boríték támogatja-e a személyes aláírást.
Emlékeztetők felülbírálása	data.folder.overrideAccountReminders	boolean	A fiókszintű emlékeztető beállításai felül vannak-e bírálva.
Delegálás felülbírálása	data.folder.overrideAccountRecipientDelegation	boolean	A fiókszintű delegálási beállítások felül vannak-e bírálva.
Delegálás engedélyezése	data.folder.allowRecipientsToDelegate	boolean	Azt jelzi, hogy a címzettek delegálhatnak-e aláírást.
azonosító	data.folder.envelopeId	integer	Az egyedi borítékazonosító (a folderId aliasa).
Név	data.folder.envelopeName	string	A boríték neve (a mappanév aliasa).
Kezdeményező azonosítója	data.folder.envelopeOriginatorId	integer	A borítékot létrehozó felhasználói azonosító.
Cégazonosító	data.folder.envelopeCompanyId	integer	A borítékot birtokoló cégazonosító.
Date	data.folder.envelopeDate	integer	A boríték létrehozásának dátuma (Unix időbélyeg ezredmásodpercben).
Megosztott dátum	data.folder.envelopeSharedDate	integer	A boríték megosztásának dátuma (Unix időbélyeg ezredmásodpercben).
Status	data.folder.envelopeStatus	string	A boríték aktuális állapota.
Szerződésazonosítók	data.folder.envelopeContractIds	array of integer	A borítékhoz társított szerződésazonosítók.
Fél engedélyei	data.folder.envelopePartyPermissions	array of object	A címzettek engedélylistája (ugyanaz a struktúra, mint a címzettek).
Címzett azonosítója	data.folder.envelopePartyPermissions.partyId	integer	A címzett egyedi azonosítója.
Címzett azonosítója	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Keresztnév	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Vezetéknév	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Placeholder	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
Létrehozás dátuma	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
E-mailek letiltása	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Egyedi azonosító	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Hitelesítési szint	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Jelszó frissítése dátuma	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Jelszó állapota	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Tárcsázási kód	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Aláírás típusa	data.folder.envelopePartyPermissions.signerSignatureType	string
Jogosultságok	data.folder.envelopePartyPermissions.contractPermissions	string
Aláírási rendelés	data.folder.envelopePartyPermissions.partySequence	integer
Munkafolyamat-sorozat	data.folder.envelopePartyPermissions.workflowSignSequence	integer
Boríték azonosítója	data.folder.envelopePartyPermissions.envelopeId	integer
Címzett cégazonosítója	data.folder.envelopePartyPermissions.partyCompanyId	integer
Megosztási mód	data.folder.envelopePartyPermissions.sharingMode	string
Címzett aláírási URL-címe	data.folder.envelopePartyPermissions.folderAccessURL	string
Biztonsági mód	data.folder.envelopePartyPermissions.securityMode	string
Comments	data.folder.envelopePartyPermissions.extraComments	string
Névváltoztatás engedélyezése	data.folder.envelopePartyPermissions.allowNameChange	boolean
Név frissítve	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Aláíró hitelesítési szintje	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Hozzáférési kód	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
Aláírás azonosítója	data.folder.envelopePartyPermissions.signatureId	string
Role	data.folder.envelopePartyPermissions.partyRole	string
Céges mező	data.folder.envelopePartyPermissions.companyFieldValue	string
Címmező	data.folder.envelopePartyPermissions.titleFieldValue	string
Az aláírás oka	data.folder.envelopePartyPermissions.reasonSigning	string
Fizetési mező hozzáadva	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Kedvezményezett	data.folder.envelopePartyPermissions.payee	boolean
Ismétlődő fizetés	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Nyomtatás és aláírás kész	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Nem kötelező aláíró	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Választható aláírók	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Paid	data.folder.envelopePartyPermissions.paid	boolean
Hitelesítési szint	data.folder.envelopeAuthenticationLevel	string	A borítékhoz szükséges hitelesítési szint.
Egyszeri aláíró tömeges	data.folder.allowSingleSignerInBulk	boolean	Azt jelzi, hogy egyetlen aláíró engedélyezve van-e tömeges módban.
File-Based mappa neve	data.folder.folderNameBasedOnFileNaming	boolean
File-Based dokumentum neve	data.folder.documentNameBasedOnFileNaming	boolean
File-Based tanúsítvány neve	data.folder.certificateNameBasedOnFileNaming	boolean
Exec előtti fájlelnevezés	data.folder.enableFileNamingBeforeExecution	boolean
Kedvezményezett hozzáadva	data.folder.payeeAddedd	boolean
Self-Signing engedélyezve	data.folder.selfSignerEnabled	boolean
Közjegyző engedélyezve	data.folder.notaryEnabled	boolean
Korlátozott láthatóság	data.folder.limitedVisibilityFlag	boolean
Aláírás utáni láthatóság	data.folder.postSigningVisibility	boolean
Nedves aláírás	data.folder.wetSignatureEnabled	boolean
Egyesítés engedélyezve	data.folder.mergeEnabled	boolean

bináris

Ez a bináris alapszintű adattípus.