Ellenőrizve

Összekötő az Ellenőrzött API-hoz egyéni dokumentum-aláírási folyamatok létrehozásához.

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 China-régiók - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	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)

Érintkezés
Név	Ellenőrizve
URL	https://verified.eu/en/#about-us
Email	support@verified.eu

Összekötő metaadatai
Kiadó	Crm – Konsulterna i Sverige AB
Webhely	https://verified.eu/
Adatvédelmi irányelvek	https://verified.eu/trust-center
Kategóriák	Tartalom és fájlok; Termelékenység

Az ellenőrzött szoftver az elektronikus azonosítás és a digitális aláírás szolgáltatójaként működik. Ez az összekötő lehetővé teszi, hogy integrálható legyen az Ellenőrzött API-ba, és egyszerű és intuitív aláírási folyamatokat hozzon létre az alkalmazásban.

Előfeltételek

A folytatáshoz a következőkre lesz szüksége:

Hitelesített fiók regisztrálása

Hitelesítő adatok lekérése

Ez az összekötő alapszintű hitelesítést használ. A felhasználónak meg kell jelenítenie a felhasználónevet, a jelszót és a cégazonosítót a kapcsolat létrehozásakor. A felhasználónév és a jelszó megegyezik az Ellenőrzött portálra való bejelentkezéshez használt jelszóval. A cégazonosító lekéréséhez be kell jelentkeznie az Ellenőrzött portálra, válassza ki a megfelelő vállalatot, ha több van, és másolja a cégazonosítót az URL-címről.

Első lépések

Gyakori használati eset az aláírási folyamat elindítása és kezelése, azaz az automatizálás beállítása az ellenőrzött dokumentumoknak való aláíráshoz és az aláírt dokumentumok rendszeres visszaállításához. Az ellenőrzött aláírási folyamat elindításához használt gyakori műveletek közé tartozik a boríték létrehozása – leíró vagy boríték létrehozása – alapértelmezett, Dokumentum hozzáadása borítékhoz, Fájl hozzáadása a dokumentumhoz, Címzett hozzáadása a borítékhoz és a boríték közzétételi állapotának frissítése. A dokumentumok ellenőrzött állapotának ellenőrzéséhez használt gyakori műveletek közé tartozik a Boríték lekérése azonosító szerint, Az összes dokumentum lekérése borítékazonosító, Fájlok lekérése dokumentumazonosító szerint, Fájl URL-címének lekérése azonosító szerint. Vegye figyelembe, hogy a Biztonsági jogkivonat létrehozása művelet mindig első lépésként használatos a következő lépésekben használandó biztonsági jogkivonat beszerzéséhez.

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

Jelenleg az alábbi korlátozások ismertek.

Minden folyamat elején létre kell hozni egy hitelesítési jogkivonatot, amelyet minden következő lépésben újra fel kell használni.
Dokumentum hozzáadásához HTTP-kérést kell küldenie egy adott URL-címre.
Az új keresési végpont használatához aktiválni kell a fiókhoz az Ellenőrzött suppoert használatával.

GYIK

Hogyan tölthetek fel dokumentumot ellenőrzöttre?

Ha tényleges dokumentumot szeretne feltölteni, létre kell hoznia egy fájlt az Ellenőrzött API-ban, és fel kell töltenie a dokumentum kivonatát az Ellenőrzött API-ból megválaszolt blob URL-címre.

Hogyan kaphatom meg a borítékot a Borítékazonosító lekérése művelet használata után?

A borítékot létrehozó lépések egy uid azonosítóval válaszolnak, amely a boríték teljes elérési útja (például: "/borítékok/ABCDE"). Más lépésekhez csak a uid utolsó részére van szükség (ami a tényleges borítékazonosító, az "ABCDE" példában).

Íme egy példa erre

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

Hogyan szerezhetem be a dokumentumazonosítót a Dokumentum hozzáadása borítékhoz művelet használata után?

A dokumentumot létrehozó lépések az új dokumentum fejlécbeli helyével válaszolnak. A hely a dokumentum teljes elérési útja (például: "/api/borítékok/ABCDE/documents/FGHIJ"). A következő lépésekhez csak a dokumentumazonosítóra (esetünkben: FGHIJ) van szükség.

Íme egy példa erre

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

Hogyan szerezhetem be a folyamatazonosítót egy borítékból?

Amikor egy borítékra vonatkozó információt tölt be, a kapcsolódó folyamat a válasz része lesz (például: "/flow/default"). A válaszban egy folyamat azonosítójának nevezzük, de csak az utolsó részre van szükség, amikor egy másik lépés (például a folyamat állapotának lekérése) kéri a folyamatazonosítót.

Íme egy példa erre

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

Hogyan használhatom az új keresési műveletet?

Az új keresési művelet használatához aktiválni kell a keresési végpontot az ellenőrzött szervezetnél. Ehhez meg kell adnia egy e-mailt az Ellenőrzött támogatásnak, beleértve a szervezeti azonosítóját, hogy aktiválhassák a végpontot.

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:


Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
felhasználónév	securestring	Az api felhasználóneve	True
jelszó	securestring	Az api jelszava	True
Cégazonosító	karakterlánc	A cégazonosítót az Ellenőrzött adja meg. Az URL-címben a app.verified.eu	True

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

Adott címzett lekérése borítékhoz	Egy adott borítékhoz egy adott címzettet kap.
Alapértelmezett leíró lekérése	Lekéri a borítékok alapértelmezett leíróit.
Aláírási hivatkozás létrehozása	Létrehoz egy aláírási hivatkozást. A megvalósítás folyamatspecifikus, és előfordulhat, hogy hiányzik az adott folyamathoz.
Az összes boríték címzettjének lekérése	Lekéri egy adott boríték összes címzettjének nevét.
Az összes boríték lekérdezése (elavult)	Lekérdezi az adott szűrőnek megfelelő összes borítékot. (Elavult)
Az összes dokumentum lekérése borítékazonosító alapján	Lekéri az adott borítékhoz kapcsolódó összes dokumentumot.
Az összes leíró lekérése	Lekéri az aktuális vállalat összes leírójának listáját. A lista szűrhető.
Biztonsági jogkivonat létrehozása	Lekéri a hitelesítési jogkivonatot az Ellenőrzött API-ból.
Boríték kuka állapotának beállítása	Egy adott boríték állapotát kukába állítja.
Boríték közzétételi állapotának frissítése	Frissíti egy adott boríték közzétételi állapotát.
Boríték lekérése azonosító szerint	Lekéri egy adott boríték részleteit.
Boríték létrehozása – alapértelmezett	Új borítékot hoz létre az alapértelmezett leíró használatával.
Boríték létrehozása – leíró	Egy borítékot hoz létre egy adott leíró alapján.
Boríték megszakítási állapotának beállítása	Egy adott boríték állapotát megszakítottra állítja.
Boríték törlése azonosító szerint	Töröl egy adott borítékot.
Borítékbeállítások frissítése	Frissíti egy adott boríték beállításait.
Cég lekérése azonosító alapján	Egy adott vállalat adatainak lekérdezése.
Címzett frissítése azonosító szerint	Frissíti a címzettet.
Címzett hozzáadása borítékhoz	Egy címzettet ad hozzá egy adott borítékhoz.
Dokumentum hozzáadása borítékhoz	Új dokumentumot ad hozzá egy meglévő borítékhoz.
Dokumentum lekérése azonosító alapján	Egy adott dokumentum adatainak lekérdezése.
Dokumentum létrehozása sablonból	Előre konfigurált sablonból hoz létre dokumentumot.
Dokumentum megszakítási állapotának beállítása	Egy adott dokumentum állapotát megszakítottra állítja.
Dokumentum törlése azonosító alapján	Egy adott dokumentum törlése.
Felhasználói adatok lekérése	Lekéri az aktuálisan bejelentkezett felhasználó adatait.
Felhasználói beállítások lekérése	Lekéri egy adott felhasználó beállításait.
Folyamatállapot lekérése borítékazonosító alapján	Lekéri egy adott boríték aktuális folyamatállapotát.
Fájl hozzáadása a dokumentumhoz	Fájl hozzáadása meglévő dokumentumhoz.
Fájl lekérése azonosító szerint	Információt kap egy adott fájlról.
Fájl URL-címének lekérése azonosító szerint	Lekéri egy adott fájl URL-címét.
Fájlok lekérése dokumentumazonosító szerint	Lekéri az összes fájlt egy adott dokumentumhoz.
Keresés az összes borítékban	Keressen rá az összes olyan borítékra, amely megfelel egy adott szűrőnek.
Leíró lekérése azonosító alapján	Lekéri egy adott leíró adatait.
Értesítés küldése	Értesítést küld egy adott boríték átfogadóinak.

Adott címzett lekérése borítékhoz

Műveletazonosító:: GetEnvelopesEnvelopeIdRecipientsRecipientId

Egy adott borítékhoz egy adott címzettet kap.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Címzett azonosítója	recipient-id	True	string	A szóban forgó címzettek azonosítója

Válaszok

Recipient: Recipient

Alapértelmezett leíró lekérése

Műveletazonosító:: GetEnvelopeDescriptorsDefault

Lekéri a borítékok alapértelmezett leíróit.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Szűrők	filters		string	Lekérdezés szűrése az alösszeg kiválasztásához

Válaszok

Leíró: Descriptor

Aláírási hivatkozás létrehozása

Műveletazonosító:: PostEnvelopesEnvelopeIdJobsGetSignLink

Létrehoz egy aláírási hivatkozást. A megvalósítás folyamatspecifikus, és előfordulhat, hogy hiányzik az adott folyamathoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Azonosító	id		string
Átirányítás ide:	redirectTo		uri	Teljes URL-cím, amely átirányítja a felhasználót az aláírás után.

Válaszok

Name	Elérési út	Típus	Description
URL	getSignLink.recipient.{recipient-id}.url	string

Az összes boríték címzettjének lekérése

Műveletazonosító:: GetEnvelopesEnvelopeIdRecipients

Lekéri egy adott boríték összes címzettjének nevét.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója

Válaszok

response: array of Recipient

Az összes boríték lekérdezése (elavult)

Műveletazonosító:: GetQueryEnvelopes

Lekérdezi az adott szűrőnek megfelelő összes borítékot. (Elavult)

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Szűrők	filters		string	Lekérdezés szűrése az alösszeg kiválasztásához
Ettől kezdve	from		integer	Kezdő dátum
Limit	limit		integer	Összeghatár
Fajta	sort		string	Rendezési szempont:

Válaszok

response: array of EnvelopeDescriptorString

Az összes dokumentum lekérése borítékazonosító alapján

Műveletazonosító:: GetEnvelopesEnvelopeIdDocuments

Lekéri az adott borítékhoz kapcsolódó összes dokumentumot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója

Válaszok

response: array of Document

Az összes leíró lekérése

Műveletazonosító:: GetEnvelopeDescriptors

Lekéri az aktuális vállalat összes leírójának listáját. A lista szűrhető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Szűrők	filters		string	Lekérdezés szűrése az alösszeg kiválasztásához

Válaszok

response: array of Descriptor

Biztonsági jogkivonat létrehozása

Műveletazonosító:: PostAuthenticate

Lekéri a hitelesítési jogkivonatot az Ellenőrzött API-ból.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
IP-zárolás nélkül	withoutIpLock	True	integer	Függetlenül attól, hogy az Ellenőrzött aktiválja-e az IP-zárolást (0, alapértelmezett) vagy sem (1)

Válaszok

Name	Elérési út	Típus	Description
Jelző	token	string	Hozzáférési jogkivonat

Boríték kuka állapotának beállítása

Műveletazonosító:: PutEnvelopesEnvelopeIdTrashStatus

Egy adott boríték állapotát kukába állítja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Comment	comment		string

Boríték közzétételi állapotának frissítése

Műveletazonosító:: PutEnvelopesEnvelopeIdPublishStatus

Frissíti egy adott boríték közzétételi állapotát.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Közzétett	published	True	boolean

Boríték lekérése azonosító szerint

Műveletazonosító:: GetEnvelopesEnvelopeId

Lekéri egy adott boríték részleteit.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója

Válaszok

Boríték: Envelope

Boríték létrehozása – alapértelmezett

Műveletazonosító:: PostEnvelopeDescriptorsDefaultEnvelopes

Új borítékot hoz létre az alapértelmezett leíró használatával.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Email	email		string
Keresztnév	givenName		string
Vezetéknév	familyName		string
Automatikus emlékeztetők	automaticReminders		number
Lejárat	expiration		string
Hash	hash		string

Válaszok

Name	Elérési út	Típus	Description
uid	uid	string

Boríték létrehozása – leíró

Műveletazonosító:: PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Egy borítékot hoz létre egy adott leíró alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Borítékleíró azonosítója	envelope-descriptor-id	True	string	A borítékleíró azonosítója
Email	email		string
Keresztnév	givenName		string
Vezetéknév	familyName		string
Automatikus emlékeztetők	automaticReminders		number
Lejárat	expiration		string
Hash	hash		string

Válaszok

Name	Elérési út	Típus	Description
uid	uid	string

Boríték megszakítási állapotának beállítása

Műveletazonosító:: PutEnvelopesEnvelopeIdAbortStatus

Egy adott boríték állapotát megszakítottra állítja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
hozzászólás	comment		string

Boríték törlése azonosító szerint

Műveletazonosító:: DeleteEnvelopesEnvelopeId

Töröl egy adott borítékot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója

Borítékbeállítások frissítése

Műveletazonosító:: PutEnvelopesEnvelopeId

Frissíti egy adott boríték beállításait.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Szekvenciális aláírás	sequentialSigning		boolean
Üdvözlés	greeting		string
Lejárat	expiration		date	Dátum a következő formátumban 2017-02-26T21:59:59.999Z
Automatikus emlékeztetők	automaticReminders		number	X Nappal a lejárat előtt

Cég lekérése azonosító alapján

Műveletazonosító:: GetCompaniesCompanyId

Egy adott vállalat adatainak lekérdezése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	company-id	True	string	A szóban forgó vállalat azonosítója

Válaszok

Cég: Company

Címzett frissítése azonosító szerint

Műveletazonosító:: PutEnvelopesEnvelopeIdRecipientsRecipientId

Frissíti a címzettet.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Címzett azonosítója	recipient-id	True	string	A szóban forgó címzettek azonosítója
Keresztnév	givenName	True	string
Vezetéknév	familyName	True	string
Nyelv	language	True	string
Aláírási módszer	signingMethod	True	string
Értesítési módszer	notificationMethod		string
E-mail	email	True	string
Telefon	telephone		string	A formátumnak +<countryCode><telefonos számnak kell lennie>
Order	order		integer
Tevékenység	action	True	string	Annak a műveletnek az ellenőrzött neve, amelyet a címzettnek végre kell hajtania.
Címke	label	True	string	Címzett szerepkörének/műveletének címkéje
Név	name	True	string	A címzett szerepkörének ellenőrzött neve
Secure	secure		boolean
SMS	sms		boolean
TAJ szám	ssn		string
Bank	bank		string

Címzett hozzáadása borítékhoz

Műveletazonosító:: PostEnvelopesEnvelopeIdRecipients

Egy címzettet ad hozzá egy adott borítékhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Keresztnév	givenName	True	string
Vezetéknév	familyName	True	string
Nyelv	language	True	string
Aláírási módszer	signingMethod	True	string
Értesítési módszer	notificationMethod		string
E-mail	email	True	string
Telefon	telephone		string	A formátumnak +<countryCode><telefonos számnak kell lennie>
Order	order		integer
Tevékenység	action	True	string	Annak a műveletnek az ellenőrzött neve, amelyet a címzettnek végre kell hajtania.
Címke	label	True	string	Címzett szerepkörének/műveletének címkéje
Név	name	True	string	A címzett szerepkörének ellenőrzött neve
Secure	secure		boolean
SMS	sms		boolean
TAJ szám	ssn		string
Bank	bank		string

Dokumentum hozzáadása borítékhoz

Műveletazonosító:: PostEnvelopesEnvelopeIdDocuments

Új dokumentumot ad hozzá egy meglévő borítékhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Hash	hash		integer
Név	name	True	string
Forrás	source		string

Dokumentum lekérése azonosító alapján

Műveletazonosító:: GetEnvelopesEnvelopeIdDocumentsDocumentId

Egy adott dokumentum adatainak lekérdezése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója

Válaszok

Dokumentum: Document

Dokumentum létrehozása sablonból

Műveletazonosító:: PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Előre konfigurált sablonból hoz létre dokumentumot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója
Sablon azonosítója	template-id	True	string	A használandó sablon azonosítója
			object

Dokumentum megszakítási állapotának beállítása

Műveletazonosító:: PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Egy adott dokumentum állapotát megszakítottra állítja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója

Dokumentum törlése azonosító alapján

Műveletazonosító:: DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Egy adott dokumentum törlése.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója

Felhasználói adatok lekérése

Műveletazonosító:: GetAuthUserinfo

Lekéri az aktuálisan bejelentkezett felhasználó adatait.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat

Válaszok

Törzs: UserInfo

Felhasználói beállítások lekérése

Műveletazonosító:: GetCompaniesCompanyIdUsersUserIdSettings

Lekéri egy adott felhasználó beállításait.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	company-id	True	string	A szóban forgó vállalat azonosítója
Felhasználói azonosító	user-id	True	string	A szóban forgó felhasználó azonosítója

Válaszok

Törzs: Setting

Folyamatállapot lekérése borítékazonosító alapján

Műveletazonosító:: GetFlowsFlowIdJobsEnvelopeId

Lekéri egy adott boríték aktuális folyamatállapotát.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Folyamatazonosító	flow-id	True	string	A szóban forgó folyamat azonosítója

Válaszok

Name	Elérési út	Típus	Description
Jelző	token	string

Fájl hozzáadása a dokumentumhoz

Műveletazonosító:: PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Fájl hozzáadása meglévő dokumentumhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója
Név	name	True	string
FileType	fileType	True	string
Hash	hash		string

Válaszok

File: File

Fájl lekérése azonosító szerint

Műveletazonosító:: GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Információt kap egy adott fájlról.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója
Fájlazonosító	file-id	True	string	A szóban forgó fájl azonosítója

Válaszok

File: File

Fájl URL-címének lekérése azonosító szerint

Műveletazonosító:: GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Lekéri egy adott fájl URL-címét.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója
Fájlazonosító	file-id	True	string	A szóban forgó fájl azonosítója
Objektumként	asObject		boolean	Meghatározza, hogy a válasz objektum-e

Válaszok

Name	Elérési út	Típus	Description
URL	url	string	Fájl URL-címe

Fájlok lekérése dokumentumazonosító szerint

Műveletazonosító:: GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Lekéri az összes fájlt egy adott dokumentumhoz.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Dokumentumazonosító	document-id	True	string	A szóban forgó dokumentum azonosítója

Válaszok

response: array of File

Keresés az összes borítékban

Műveletazonosító:: GetSearchEnvelopes

Keressen rá az összes olyan borítékra, amely megfelel egy adott szűrőnek.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Szűrők	filters		string	Lekérdezés szűrése az alösszeg kiválasztásához
Ettől kezdve	from		integer	Kezdő dátum
Limit	limit		integer	Összeghatár
Fajta	sort		string	Rendezési szempont:

Válaszok

response: array of EnvelopeDescriptorString

Leíró lekérése azonosító alapján

Műveletazonosító:: GetEnvelopeDescriptorsEnvelopeDescriptorId

Lekéri egy adott leíró adatait.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Borítékleíró azonosítója	envelope-descriptor-id	True	string	A borítékleíró azonosítója

Válaszok

Leíró: Descriptor

Értesítés küldése

Műveletazonosító:: PostEnvelopesEnvelopIdJobsSendNotification

Értesítést küld egy adott boríték átfogadóinak.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Jelző	token	True	string	A "Biztonsági jogkivonat létrehozása" művelettől kapott jogkivonat
Cégazonosító	x-namespace		string	A művelethez használandó cégazonosító. Formátum /vállalatok/<cégazonosító>. Ha nincs beállítva, alapértelmezés szerint a kapcsolat cégazonosítóját adja meg.
Boríték azonosítója	envelope-id	True	string	A szóban forgó boríték azonosítója
Üdvözlés	greeting		string
Címzett azonosítója	id	True	string	Annak a címzettnek az azonosítója, akinek az értesítést el kell küldeni.

Definíciók

Setting

Name	Elérési út	Típus
Global	global	string
Aláíró nyelv	preferences.signatoryLanguage	string
Üdvözlés	preferences.greeting	string
Aláírási módszer	preferences.signingMethod	string
Emlékeztető eltolása	preferences.reminderOffset	string

Felhasználói információk

Name	Elérési út	Típus
Keresztnév	givenName	string
Vezetéknév	familyName	string
Email	email	string
Nyelv	metadata.language	string
Hiányzó jelszó	missingPassword	boolean
Engedélyezve van	isEnabled	boolean
Namespace	namespace	string
Enabled	enabled	boolean
UID	uid	string
Azonosító	id	string
Szerepkörök	roles	array of Role
Validated	validated	boolean

Cég

Name	Elérési út	Típus
Név	name	string
Reg. Szám	regNumber	string
Létrehozott	created	string
Módosított	modified	string
Address	address	string
City	city	string
Irányítószám	zipCode	string
Embléma	logo	string
Country	country	string
Uid	uid	string
Azonosító	id	string

Recipient

Name	Elérési út	Típus	Description
UID	uid	string	Címzett UID azonosítója
Namespace	namespace	string	Címzett névtere
Létrehozott	created	string	Címzett létrehozva
Role	role	RoleActionString
Vezetéknév	familyName	string	Címzett vezetékneve
Keresztnév	givenName	string	Címzett frist neve
Nyelv	language	string	Címzett nyelve
Email	email	string	Címzett e-mail címe
Aláírási módszer	signingMethod	string	Címzett aláíró methida
Értesítési módszer	notificationMethod	string
Order	order	integer	Címzett rendelése
Azonosító	id	string	Címzett azonosítója
Módosított	modified	string	Címzett módosítva
Bejelentett	notified	boolean
Befejeződött	completed	boolean
demandAttachment	demandAttachment	boolean
TAJ szám	ssn	string
Bank	bank	string
Secure	secure	boolean
SMS	sms	boolean
Telefon	telephone	string
Aláírások	signatures	object
Notifications	notifications	array of Notification

Role

Name	Elérési út	Típus	Description
Típus	action.type	string
módszerek	action.methods	array of string
Címke	label	string	Címke
Num. Max	numMax	integer	Num. Max
Num. Min	numMin	integer	Num. Min
Szerepkör neve	roleName	string

RoleActionString

Name	Elérési út	Típus	Description
Tevékenység	action	ActionString	Tevékenység
Címke	label	string	Címke
Num. Max	numMax	integer	Num. Max
Num. Min	numMin	integer	Num. Min
Szerepkör neve	roleName	string

ActionString

Tevékenység

Tevékenység: string

Boríték

Name	Elérési út	Típus	Description
Azonosító	id	string	Boríték azonosítója
UID	uid	string	Boríték UID azonosítója
Namespace	namespace	string	Boríték névtere
verzió	version	integer	Boríték verziója
Közzétett	published	boolean	Boríték közzétéve
Complete	completed	boolean	Boríték kész
Megszakadt	aborted	boolean	Boríték avorted
Kukába	trashed	boolean	Boríték kukába
Szekvenciális aláírás	sequentialSigning	boolean
Autmatikus emlékeztetők	automaticReminders	integer
Létrehozott	created	string	Boríték létrehozva
Módosított	modified	string	Boríték módosítva
Lejárt	expired	boolean	Boríték lejárt
Flow	flow	Flow
Leíró	descriptor	Descriptor
Személy	sender	Person
Documents	documents	array of Document
Címzettek	recipients	array of Recipient
Címkék	tags	array of object
Tulajdonosok	owners	array of Person

EnvelopeDescriptorString

Name	Elérési út	Típus	Description
Azonosító	id	string	Boríték azonosítója
UID	uid	string	Boríték UID azonosítója
Namespace	namespace	string	Boríték névtere
verzió	version	integer	Boríték verziója
Közzétett	published	boolean	Boríték közzétéve
Complete	completed	boolean	Boríték kész
Megszakadt	aborted	boolean	Boríték avorted
Kukába	trashed	boolean	Boríték kukába
Szekvenciális aláírás	sequentialSigning	boolean
Autmatikus emlékeztetők	automaticReminders	integer
Létrehozott	created	string	Boríték létrehozva
Módosított	modified	string	Boríték módosítva
Lejárt	expired	boolean	Boríték lejárt
Flow	flow	Flow
Leíró	descriptor	string	Borítékleíró
Személy	sender	Person
Documents	documents	array of Document
Címzettek	recipients	array of Recipient
Címkék	tags	array of object
Tulajdonosok	owners	array of Person

File

Name	Elérési út	Típus	Description
Azonosító	id	string	Fájlazonosító
URL	url	string	Fájl URL-címe
Név	name	string	Fájlnév
MimeType	mimeType	string
Fájltípus	fileType	string
Tárolási elérési út	storagePath	string
Feltöltve:	uploadedAt	string
Létrehozott	created	string	Fájl létrehozva
Tulajdonosok	owners	array of object
UID	owners.uid	string	Fájltulajdonos UID azonosítója
Azonosító	owners._id	string	Fájltulajdonos azonosítója
Namespace	namespace	string
UID	uid	string	Fájl UID azonosítója

Flow

Name	Elérési út	Típus	Description
Azonosító	id	string	Folyamatazonosító
Név	name	string	Folyamat neve

Leíró

Name	Elérési út	Típus	Description
Név	name	string	Leíró neve
verzió	version	integer	Leíró verzió
UID	uid	string	Leíró UID azonosítója
Törölt	deleted	boolean	Leíró törlése
Public	public	boolean	Leíró nyilvános
Lejárt	expired	boolean	A leíró lejárt
Azonosító	id	string	Leíró azonosítója
Mandatory	mandatory	boolean	Leíró kötelező
Címke	label	string	Leíró címke
Típus	type	string	Leíró típusa
Szerepkörök	roles	array of Role
Tulajdonosok	owners	array of Person
Flow	flow	Flow
defaultValues	defaultValues	DefaultValues	defaultValues
Instances	instances	array of object

Személy

Name	Elérési út	Típus	Description
UID	uid	string	Személy UID azonosítója
Keresztnév	givenName	string	Személy utóneve
Vezetéknév	familyName	string	Személy vezetékneve
Email	email	string	Személy e-mail-címe
Nyelv	language	string	Személy nyelve
Order	order	integer	Személy rendelése

Dokumentum

Name	Elérési út	Típus	Description
Címke	label	string	Dokumentumcímke
Típus	type	string	Dokumentum típusa
Hash	hash	integer	Dokumentumkivonat
Num. Max	numMax	integer	Dokumentumszám. Max
Num. Min	numMin	integer	Dokumentumszám. Min
UID	uid	string	Dokumentum UID azonosítója
Namespace	namespace	string	Dokumentumnévtér
Forrás	source	string	Dokumentumforrás
Létrehozott	created	string	Dokumentum létrehozva
Név	name	string	Dokumentum neve
Azonosító	id	string	Dokumentumazonosító
Módosított	modified	string	Dokumentum módosítva
Elutasította	rejected	boolean	Dokumentum elutasítva
Aláírt	signed	boolean	Aláírt dokumentum
Kukába	trashed	boolean	Dokumentum kukába
Megszakadt	aborted	boolean	Dokumentum megszakítva
verzió	version	integer	Dokumentumverzió
attachments	attachments	array of Attachment
Flow	flow	Flow
roles	roles	array of Role
Template	template	Template
Leíró	descriptor	Descriptor
Aláírások	signatures	array of Signature

Attachment

Name	Elérési út	Típus	Description
Címke	label	string	Mellékletcímke
Num. Max	numMax	integer	Melléklet száma. Max
Num. Min	numMin	integer	Melléklet száma.min
Hash	hash	integer	Melléklet kivonata

Template

Name	Elérési út	Típus	Description
Típus	type	string	Sablon típusa
HTML	html	string
PDFHTML	pdfHtml	string
Azonosító	id	string
UID	uid	string
Namespace	namespace	string
verzió	version	integer
Létrehozott	created	string
Módosított	modified	string
Módosított	published	boolean
Befejeződött	completed	boolean
Megszakadt	aborted	boolean

Signature

Name	Elérési út	Típus	Description
azonosító	id	string
Eredet	origin	string
Keresztnév	givenName	string	Keresztnév
Vezetéknév	familyName	string	Vezetéknév
Email	email	string	Email
IP	ip	string
Date	date	string
Státusz	status	string
Comment	comment	string

DefaultValues

defaultValues

Name	Elérési út	Típus	Description
Személy	signer	Person
Személy	reviewer	Person

Notification

Name	Elérési út	Típus
azonosító	id	string
UID	uid	string
Namespace	namespace	string
Státusz	status	string
Order	order	integer
Részletek	details	object
Date	date	string