Foxit eSign (Önizleme)

Foxit eSign, belgeleri çevrimiçi olarak göndermenize, imzalamanıza ve yönetmenize olanak tanıyan, yazdırma, tarama veya postalama gereksinimini ortadan kaldıran bir elektronik imza çözümüdür. Belgenizi karşıya yükleyin, imza alanlarını tanımlayın ve hızlı, yasal olarak bağlayıcı eSignatures için alıcılara gönderin.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Service Class Regions
Copilot Studio Premium Aşağıdakiler dışında tüm Power Automate bölgeleri:
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Logic Apps Standart Aşağıdakiler dışında tüm Logic Apps bölgeleri :
     - Azure Kamu bölgeleri
     - Azure Çin bölgeleri
     - ABD Savunma Bakanlığı (DoD)
Power Apps Premium Aşağıdakiler dışında tüm Power Apps bölgeleri:
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Power Automate Premium Aşağıdakiler dışında tüm Power Automate bölgeleri:
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Contact
İsim Foxit eSign Desteği
URL https://www.foxit.com
E-posta api@foxit.com
Bağlayıcı Meta Verileri
Publisher Foxit Software Inc.
Web Sitesi https://www.foxit.com/esign-pdf/
Gizlilik ilkesi https://www.foxit.com/company/privacy-policy.html
Kategoriler Verimli -lik; İçerik ve Dosyalar

Foxit eSign

Foxit eSign, işletmelerin yasal olarak bağlayıcı belgeleri tamamen çevrimiçi olarak göndermesine, imzalamasına ve yönetmesine olanak tanıyan kurumsal düzeyde bir elektronik imza çözümüdür ve yazdırma, tarama veya posta ihtiyacını ortadan kaldırır. Belgenizi karşıya yükleyin, imza alanlarını tanımlayın ve hızlı, güvenli eSignatures için alıcılara gönderin. Foxit eSign, ESIGN ve UETA dahil olmak üzere önemli elektronik imza yasalarıyla tamamen uyumludur, aktarımdaki ve bekleyen belgeleri korumak için şifreleme kullanır ve yalnızca yetkili imzalayanların belgelerinize erişip imzalayabilmesini sağlamak için çok faktörlü kimlik doğrulamasını destekler.

Microsoft Power Automate için Foxit eSign bağlayıcısı, zarf oluşturma ve imza için gönderme, durumu izleme, tamamlanmış belgeleri indirme, şablonları yönetme ve zarf olayları gerçekleştiğinde aşağı akış eylemlerini tetikleme gibi tüm belge imzalama iş akışınızı otomatikleştirmenizi sağlar.

Publisher: Foxit Corporation

Prerequisites

Bu bağlayıcıyı kullanmak için şunları yapmanız gerekir:

  • Özel bağlayıcı veya premium bağlayıcı erişimine sahip bir Microsoft Power Apps veya Power Automate planı
  • Foxit eSign hesabı — burada bir hesap oluşturun
  • Foxit eSign hesabınızda API erişimi etkinleştirildi (aşağıdaki Kimlik Bilgilerini Alma bölümüne bakın)

Kimlik Bilgilerini Alma

  1. Henüz bir hesabınız yoksa bir Foxit eSign hesabı oluşturun.
  2. Hesabınızda API erişiminin etkinleştirilmesini istemek için Foxit Satış ekibine başvurun. Onayladıktan sonra api erişimi hesabınızda etkinleştirilir.
  3. Power Automate bağlayıcı listesinde Foxit eSign araması yapın ve Bağlantı oluştur'u seçin.
  4. Foxit eSign oturum açma sayfasına yönlendirilirsiniz. Bağlantıyı yetkilendirmek için Foxit eSign kimlik bilgilerinizle oturum açın.
  5. Yetkilendirildikten sonra bağlantı akışlarınızda kullanılmaya hazırdır.

Getting Started

Bağlantı oluşturduktan sonra Foxit eSign bağlayıcısını kullanarak akış oluşturmaya başlayabilirsiniz:

  • Bir zarf olayı gerçekleştiğinde (örneğin, tüm taraflar imzalandığında) akışı otomatik olarak başlatmak için tetikleyicileri kullanın.
  • Zarf oluşturmak, imza anımsatıcıları göndermek, tamamlanmış belgeleri indirmek, şablonları yönetmek ve daha fazlası için eylemleri kullanın.
  • Birden çok eylemi birbirine zincirleyin; örneğin, şablondan bir zarf oluşturun, tam olarak yürütülen tetikleyiciyi bekleyin, ardından imzalanan belgeyi indirin ve SharePoint depolayın.

Desteklenen Tetikleyiciler

Trigger Description
Bir zarf gönderildiğinde Alıcılara bir zarf gönderildiğinde tetikler. Web Kancası Düzeyi'nin Hesap olarak ayarlanmasını gerektirir.
Zarf görüntülendiğinde Alıcı açıldığında ve zarfı görüntülediğinde tetikler.
Bir zarf imzalandığında Alıcı zarfı imzaladığında tetikler.
Zarf iptal edildiğinde Zarf bir alıcı veya gönderen tarafından iptal edildiğinde tetikler.
Bir zarf tam olarak yürütülürken Tüm alıcılar imzaladığında ve zarf tamamen tamamlandığında tetikler.
Bir zarf silindiğinde Zarf silindiğinde tetikler.

Desteklenen Eylemler

Zarf

Action Description
URL'den Zarf Oluştur Genel olarak erişilebilen bir PDF URL'sini kullanarak zarf oluşturur ve gönderir.
Base64'ten Zarf Oluştur Base64 kodlu PDF belgesini kullanarak zarf oluşturur ve gönderir.
Şablondan Zarf Oluştur Mevcut foxit eSign şablonundan bir zarf oluşturur ve gönderir.
Zarf Ayrıntılarını Al Zarfın tüm ayrıntılarını ve geçerli durumunu alır.
Zarf Kimliklerini Alma Filtre ölçütlerine göre zarf kimliklerinin listesini alır.
İmza Anımsatıcısı Gönder Bekleyen imzalayanlara bir zarfın anımsatıcı bildirimini gönderir.
Zarf Dosyalarını İndir Zarftaki tüm imzalı belgeleri zip dosyası olarak indirir.
Tek Belge PDF'sini indirin Zarftan pdf olarak tek bir belge indirir.
Zarfları Geri Dönüşüm Kutusuna Taşı Bir veya daha fazla zarfı geri dönüşüm kutusuna taşır.
Zarfı İptal Et Zarfı iptal eder ve alıcılara bildirir.
Zarfları Sil Bir veya daha fazla zarfı kalıcı olarak siler.
Zarf Etkinlik Geçmişini Al Bir zarfın tam etkinlik günlüğünü alır.
Silinen Zarf Geçmişini Al Hesaptaki silinen zarfların geçmişini alır.

Şablonlar

Action Description
URL'den Şablon Oluştur Genel olarak erişilebilen bir PDF URL'si kullanarak yeniden kullanılabilir bir imzalama şablonu oluşturur.
Base64'ten Şablon Oluşturma Base64 ile kodlanmış bir PDF belgesi kullanarak yeniden kullanılabilir bir imzalama şablonu oluşturur.
Şablon Ayrıntılarını Alma Alan tanımları dahil olmak üzere belirli bir şablonun tüm ayrıntılarını alır.
Şablon Kimliklerine Göre Şablon Alma Kimliklerine göre bir veya daha fazla şablonun ayrıntılarını alır.
Tüm Şablonların Listesini Alma Hesapta bulunan tüm şablonları alır.

Webhooks

Action Description
Tüm Web Kancası Kanallarını Listele Hesapta yapılandırılan tüm web kancası kanallarının listesini döndürür.
Web Kancası Kanal Ayrıntılarını Alma Belirli bir web kancası kanalının ayrıntılarını alır.

E-posta Grupları

Action Description
E-posta Grubu Oluştur Zarflarda alıcı olarak kullanılmak üzere yeni bir e-posta grubu oluşturur.
E-posta Grubu Ayrıntılarını Alma E-posta grubunun ayrıntılarını ve üyelerini alır.

Reports

Action Description
Raporu İndir Bir hesap etkinlik raporunu Microsoft Excel biçimde indirir.

Bilinen Sorunlar ve Sınırlamalar

  • Hız Sınırı: Foxit eSign API'si hesap başına 5 dakikada 4.000 isteke kadar izin verir. Bu sınırı aşan istekler bir 429 Too Many Requests yanıt alır. Bunu düzgün bir şekilde işlemek için akışlarınızda üstel geri alma ile yeniden deneme mantığı uygulamanız önerilir.

  • Dosya Boyutu Sınırı: Belge başına dosya boyutu üst sınırı 25 MB'tır. Bu sınır, toplam zarf boyutu için değil, tek tek dosyalar için geçerlidir.

  • Web Kancası Otomatik Abonelikten Çıkma: Foxit eSign web kancası silme API'sindeki (DELETE yerine POST yöntemi kullanan) bir sınırlama nedeniyle Power Automate tetikleyici tabanlı bir akış silindiğinde veya değiştirildiğinde web kancası kanal aboneliklerini otomatik olarak temizleyemez. Etkin kanalları tanımlamak için Tüm Web Kancası Kanallarını Listele eylemini ve akışın yetkisini alırken abonelikleri kaldırmak için Foxit eSign portalını kullanın.

  • Bir zarf gönderildiğinde — Yalnızca Hesap Düzeyi: "Zarf gönderildiğinde" tetikleyicisi yalnızca Web Kancası Düzeyi Hesap olarak ayarlandığında tetikler. API Uygulaması düzeyinde oluşturulan zarflar için tetiklenmez. Bu tetikleyiciyi yapılandırırken Hesap düzeyi'ni seçtiğinizden emin olun.

  • Bölgesel Kullanılabilirlik: Bağlayıcı hem Kuzey Amerika (NA1) hem de AB bölge hesapları için kullanılabilir. Bağlantınızı yapılandırırken uygun sunucu bölgesini seçin. Yanlış bölgeye bağlanmak kimlik doğrulaması hatalarına neden olur.

  • Base64 Belge Boyutu: Base64'ten Zarf Oluştur veya Base64'ten Şablon Oluştur eylemleri kullanılırken, Base64 ile kodlanmış dize 25 MB'tan büyük olmayan bir kaynak dosyaya karşılık gelir.

Support

Geliştirici desteği için adresinden devsupport@foxitsoftware.comFoxit eSign ekibine başvurun.

Destek talebi göndermek için adresini ziyaret edin https://kb.foxit.com/s/submit-a-case.

Azaltma Sınırları

Name Çağrılar Yenileme Dönemi
Bağlantı başına API çağrıları 100 60 saniye

Eylemler

Base64'ten Zarf Oluştur

Base64 kodlu PDF belgesini kullanarak zarf oluşturur ve gönderir.

Base64'ten Şablon Oluşturma

Base64 kodlu PDF dizesini kullanarak yeni bir şablon oluşturur. PDF dosyanız akışınızda base64 dizesi olarak kullanılabiliyorsa (örneğin, bir SharePoint dosyasından veya OneDrive belgesinden) bunu kullanın.

E-posta Grubu Ayrıntılarını Alma

Mevcut bir e-posta grubunun ayrıntılarını alır.

E-posta Grubu Oluştur

Aynı anda birden çok alıcıya zarf göndermek için kullanılabilecek yeni bir e-posta grubu oluşturur.

İmza Anımsatıcısı Gönder

Bekleyen alıcılara bir zarfın anımsatıcı bildirimi göndererek imzalamayı tamamlamalarını ister.

Raporu İndir

Zarf etkinlik raporunu Microsoft Excel dosyası olarak indirir. Sonuçları duruma, tarih aralığına, zarf adına, yazara veya imzalayana göre daraltmak için filtreleri kullanın.

Silinen Zarf Geçmişini Al

Silinmiş veya geri dönüşüm kutusuna taşınmış zarfların geçmişini alır.

Tek Belge PDF'sini indirin

Zarftan pdf dosyası olarak tek bir belge indirir.

Tüm Web Kancası Kanallarını Listeleme

Hesabınızda yapılandırılan tüm web kancası kanallarının listesini döndürür.

Tüm Şablonların listesini alma

Hesabınızdaki kullanılabilir tüm şablonların listesini döndürür.

URL'den Zarf Oluştur

Genel olarak erişilebilen PDF URL'lerini kullanarak bir zarf oluşturur ve gönderir. İmzalama işlemini başlatmak için belge URL'lerini ve alıcı ayrıntılarını sağlayın.

URL'den Şablon Oluştur

Genel olarak erişilebilen bir PDF URL'si kullanarak yeni bir şablon oluşturur.

Web Kancası Kanal Ayrıntılarını Alma

Belirli bir web kancası kanalının ayrıntılarını alır.

Web Kancası Tetikleyicisi Aboneliğini Kaldır

Etkin bir web kancası kanalı aboneliğini kanal kimliğine göre siler. Artık gerekli olmayan web kancası aboneliklerini temizlemek için bu eylemi kullanın.

Zarf Ayrıntılarını Al

Zarfın durumu, alıcıları ve belgeleri de dahil olmak üzere tüm ayrıntılarını alır.

Zarf Dosyalarını İndir

Tamamlanan belgeleri bir zarftan dosya olarak indirir.

Zarf Etkinlik Geçmişini Al

Bir zarf için, alıcılar ve gönderen tarafından yapılan tüm eylemleri gösteren tam etkinlik günlüğünü alır.

Zarf Kimliklerini Al

Duruma göre filtrelenmiş zarf kimliklerinin listesini döndürür. Belirli bir durumdaki zarfları bulmak için bunu kullanın.

Zarfları Geri Dönüşüm Kutusuna Taşı

Bir veya daha fazla zarfı geri dönüşüm kutusuna taşır. Geri dönüşüm kutusundaki zarflar kalıcı olarak silinmez.

Zarfları Sil

Bir veya daha fazla zarfı kalıcı olarak siler.

Zarfı İptal Et

Gönderilen zarfı iptal eder. Alıcılar artık belgeleri imzalayamaz.

Şablon Ayrıntılarını Alma

Alanları ve alıcıları dahil olmak üzere belirli bir şablonun tüm ayrıntılarını alır.

Şablon Kimliklerine Göre Şablon Alma

Kimliklerine göre bir veya daha fazla şablonun ayrıntılarını alır.

Şablondan Zarf Oluştur

Var olan bir şablonu kullanarak zarf oluşturur ve gönderir. Alıcı ayrıntıları özelleştirilebilir.

Base64'ten Zarf Oluştur

Base64 kodlu PDF belgesini kullanarak zarf oluşturur ve gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Adı
folderName True string

Bu zarfın adı.

Giriş Türü
inputType string

Belge kaynağı için giriş türü. Bu eylem için base64 olarak düzeltildi.

Base64 Dosya Dizeleri
base64FileString True array of string

Gönderilecek Base64 kodlanmış PDF belgeleri dizisi.

Dosya Adları
fileNames True array of string

Her belge için Base64 Dosya Dizesi dizisiyle aynı sırada görünen ad dizisi.

İlk İsim
firstName True string

Alıcının adı.

Soyadı
lastName True string

Alıcının soyadı.

E-Posta Adresi
emailId True string

Alıcının e-posta adresi.

permissions
permission True string
Sequence
sequence True integer

Alıcı tarafları listesindeki bir alıcıya sıra numarası atamak için bu alanı kullanın. 1,2,3,4 gibi 1 ile başlayan her taraf için benzersiz sıra numaraları kullanın.... İmzalama iş akışında tek bir kişi birden çok kez görünüyorsa, lütfen alıcı her yinelendiğinde farklı bir sıra atayın.

signerAuthLevels
signerAuthLevel string

İmzalayanın doğrulama amacıyla yararlanacağı kimlik doğrulama düzeyi

Yer Tutucudur
isPlaceholder boolean

Bu alanı, bir yer tutucu olan partiyi başlatmak için kullanın. Not: 1. firstName, lastName, emailId parametresinin değeri bu taraf için boş olmalıdır. 2. Yer tutucuyu eklemek için bir alıcı 'PARTY_ASSIGNER' izniyle yeniden kaydedilmelidir.

Alıcı Rolü
partyRole string

Yer tutucu rolü atamak için bu alanı kullanın.

Ad Değişikliğine İzin Ver
allowNameChange string

Değer true veya false olabilir İmzalayanın imzalama işlemini tamamlamadan önce adı ve soyadını güncelleştirmesine izin vermek için bu parametreyi kullanın.

İş Akışı Dizisi
workflowSequence integer

Bu alıcıya bir iş akışı sıra numarası atayın. Oturum Açma Sırası etkinleştirildiğinde, alıcılar imzalama davetlerini artan sırada alır.

Konak E-posta Kimliği
hostEmailId string

In-Person Yöneticisinin e-posta adresi.

Erişim Kodu
userDefinedAccessCode string

Parametre, kimlik doğrulaması için "signerAuthLevel" değeri "Kullanıcı tanımlı Erişim Kodu" olarak ayarlandığında Erişim Kodu içerir. Not: 1. Kodlar büyük/küçük harfe duyarlı değildir. 2. Sistem bu kodu göndermez, bu nedenle bu kodu doğrudan imzalayanla paylaşmanız gerekir. 3. Erişim kodu alfabeleri, sayıları ve şu özel karakterleri içerebilir: @,&;{,},%,(,),~,|,!,+,^.

Grup E-posta Grubudur
partyIsEmailGroup boolean

Toplu olarak grup oluştururken bu parametreyi kullanın. Not: Bu parametre true ise, bu tarafın firstName, lastName ve emailId değeri yoksayılır.

E-posta Grubu Kimliği
emailGroupId integer

Toplu oluşturmak için kullanmak istediğiniz grup kimliğini e-postaya geçirin.

Tek İmzalayan Toplu
allowSingleSignerInBulk boolean

Yalnızca bir kişinin e-posta grubunda oturum açmasına izin vermek için bu parametreyi kullanın.

Arama Kodu
dialingCode string

Ülke arayarak bağlanma kodları, alıcı tarafları listesindeki bir alıcıya mobil numara ön ekleridir atamak için bu alanı kullanın.

Cep Telefonu Numarası
mobileNumber string

Alıcı tarafları listesindeki bir alıcıya cep telefonu numarası atamak için bu alanı kullanın.

Alanlar
Fields object
Şimdi Gönder
sendNow boolean

Etkinleştirildiğinde, Foxit eSign hemen her alıcının e-posta adresine benzersiz bir imzalama bağlantısı gönderir. Bunun yerine zarfı taslak olarak kaydetmek için bunu devre dışı bırakın.

Ekli İmzalama Oturumu Oluşturma
createEmbeddedSigningSession True boolean

İmzalama oturumu belirteci, alıcılara e-posta göndermeden oluşturulur.

Tüm Taraflar için Ekli İmzalama Oturumu Oluşturma
createEmbeddedSigningSessionForAllParties boolean

true olarak ayarlanırsa, zarftaki her alıcı için eklenmiş bir imzalama URL'si oluşturulur.

Metin Etiketlerini İşleme
processTextTags True boolean

Değer true veya false olabilir. Bu alan, Foxit eSign'ın Metin Etiketleri belgelerini Foxit eSign alanlarına dönüştürmek üzere ayrıştırıp ayrıştırmayacağını belirlemek için kullanılır.

İşlem Acro Alanları
processAcroFields True boolean

Bu alan, Foxit eSign'ın AcroFields belgelerini Foxit eSign alanlarına dönüştürmek üzere ayrıştırıp ayrıştırmayacağını belirlemek için kullanılır.

Oturum Açma Sırası
signInSequence boolean

Bu alan, alıcıların zarf belgelerini sırayla imzalayıp imzalamayacağını belirlemek için kullanılır. False ise, tüm alıcılar aynı anda davet e-postası alır. Doğru olduğunda, önceki alıcı gerekli görevi tamamladıktan sonra her alıcı, belgeleri imzalama veya alanları doldurma gibi sırayla davet e-postası alır.

Kişi Olarak Etkinleştir
inPersonEnable boolean

Bu alan, herhangi bir cihazda birkaç dakika içinde kolayca tamamlanabilen ve gerektiğinde e-posta tabanlı imzalardan kaçınan, kişi içi imzalama işlemini başlatmak için kullanılır. False ise, tüm alıcılar davet e-postasını aynı anda alır. Doğru olduğunda, bizzat yönetici imzalayan için imzalama işlemini başlatmak üzere bir davet e-postası alır.

Alıcı Taraflarını Düzelt
fixRecipientParties boolean

Doğruysa, eklenmiş gönderme görünümünde, bu isteğin bir parçası olarak zaten eklenmiş olan zarfın tarafları değiştirilemez.

Belgeleri Düzeltme
fixDocuments boolean

True ise, eklenmiş göndermede bu isteğin bir parçası olarak zaten eklenmiş olan zarfın belgeleri değiştirilemez.

Başarılı Url'si Gönder
sendSuccessUrl string

Katıştırılmış gönderme görünümünde klasörü başarıyla gönderdikten sonra imzalayanın yeniden yönlendirileceği giriş sayfasının mutlak URL'sini girin.

Hata Url'si Gönder
sendErrorUrl string

Katıştırılmış gönderme görünümünde klasörü gönderirken hata gelirse, imzalayanın yönlendirileceği giriş sayfasının mutlak URL'sini girin.

Ekli Gönderme Oturumu Oluşturma
createEmbeddedSendingSession boolean

true olarak ayarlanırsa, Foxit eSign görünümünü hazırlayan belgeyi açmak için eklenmiş bir belirteç oluşturur.

Ekli İmzalayanlar E-posta Kimlikleri
embeddedSignersEmailIds array of string

Ekli imzalama oturumu oluşturulması gereken alıcıların e-posta kimlikleri dizisi. Taraflar listesine eklenen alıcı tarafların e-posta kimlikleri.

İmza Başarılı Url'si
signSuccessUrl string

Ekli imzalama görünümünde başarıyla oturum açtıktan sonra yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Reddetme Url'sini İmzala
signDeclineUrl string

Ekli imzalama görünümünde oturum açmayı reddederse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Daha Sonra İmzala URL'si
signLaterUrl string

Ekli imzalama görünümünde daha sonra oturum açmayı seçerse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Hata Url'sini İmzala
signErrorUrl string

Belgeyi ekli imzalama görünümünde imzalama sırasında hata gelirse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Şimdi Gönder ve Ekli İmzalama oturumuna izin ver
allowSendNowAndEmbeddedSigningSession boolean

True olarak ayarlanırsa, Foxit eSign her alıcıya benzersiz imzalama bağlantısı gönderir. Bu YALNIZCA sendNow ve createEmbeddedSigningSession parametreleri true olduğunda geçerlidir.

Gelişmiş E-posta Doğrulaması
allowAdvancedEmailValidation boolean

True olarak ayarlandığında tarafların e-posta adresini doğrulayın.

İmza Başarılı Url'si Tüm Taraflar
signSuccessUrlAllParties boolean

True olarak ayarlanırsa, imzalayan, başarıyla imzalandıktan sonra signSuccessUrl içinde sağlanan URL'ye yönlendirilir. Bu yalnızca sendNow doğru olduğunda geçerlidir.

E-posta Şablonu Kimliği
emailTemplateId integer

Varsayılan e-posta şablonları dışındaki e-posta şablonlarını göndermek için e-posta şablonu kimliğini geçirin.

İmzalayan Yönerge Kimliği
signerInstructionId integer

Varsayılan imzalayan yönergeleri dışında imzalayan yönergeleri göndermek için yönerge kimliğini geçirin.

Onay YönergeSi Kimliği
confirmationInstructionId string

Varsayılan onay yönergeleri dışında onay yönergeleri göndermek için onay yönerge kimliğini geçirin.

Tema Rengi
themeColor string

Tema rengini ayarlamak için CSS değerini girin.

Oturumun Süresi Doldu
sessionExpire boolean

Katıştırılmış imzalama oturumunun süresinin dolmasına başlatmak için true olarak ayarlayın.

Süre sonu
expiry integer

sessionExpire true ise gereklidir. Katıştırılmış imzalama oturumunda süre sonunu milisaniye olarak girin.

Bağımlı Alan Adı
dependentFieldName True string

Görünürlüğü üst alan tarafından denetlenen alanın adı.

Üst Alan Adı
parentFieldName True string

Değeri bağımlı alanın görünürlüğünü denetleyen üst alanın adı. Desteklenen üst alan türleri: metin alanı, metin kutusu, onay kutusu, radyo düğmesi, açılan menü.

Üst Alan Değeri
parentFieldValue True string

Bağımlı alanın görünür olmasını tetikleyen üst alanın değeri. Onay kutusu ve radyo düğmesi alanları için işaretli veya işaretsiz seçeneğini kullanın.

Options
options True string

Metin tabanlı üst alanlar için ek eşleştirme seçenekleri. Kabul edilen değerler: isblank, allowNull, contains.

Meta veriler
metadata object

Bu anahtar değer çiftinde olmalıdır. En fazla 1000 anahtar değer çifti izin verilir.

Gönderen E-postası
senderEmail string

Hesabınızdaki başka bir kullanıcının e-postasını girin. Bu belge veya klasör alıcı taraflarına göndermek için kullanılacaktır.

Beni Ekle Düğmesini Gizle
hideAddMeButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Beni Ekle" düğmesini gizler.

Yeni Ekle Düğmesini Gizle
hideAddNewButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Yeni Ekle" düğmesini gizler.

Grup Ekle Düğmesini Gizle
hideAddGroupButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Grup Ekle" düğmesini gizler.

Alıcılar için Alan Adını Gizle
hideFieldNameForRecipients boolean

Veri Giriş Alanları ve Gelişmiş Alanlar için Alıcılar için alan adlarını gizleyin. (Radyo düğmesi, Onay Kutusu, Resim ve Köprü hariç).

Onay Kutusu Kenarlığını Gizle
hideCheckboxBorder boolean

Yürütülen belgelerde Onay Kutusunun kenarlıkları gizlenir.

İmzalayan Seçme Seçeneğini Gizle
hideSignerSelectOption boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarında "Mevcut İmzalayan Adı/E-postası" giriş kutusunu gizler.

İmzalayan Eylemlerini Gizle
hideSignerActions boolean

Doğruysa, ekli bir gönderme oturumunda Alıcı Taraflarında imzalayan "düzenle", "değiştir" ve "kaldır" eylemlerini gizler.

Gönderen Adını Gizle
hideSenderName boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarında gönderenin adını gizler.

Klasör Adını Gizle
hideFolderName boolean

True ise, her iki ekli oturumda da gezintideki klasör adını gizler.

Belge Adını Gizle
hideDocumentsName boolean

True ise, her iki katıştırılmış oturumda da belge adını gizler.

İmzalayacak Reddet'i gizle
hideDeclineToSign boolean

Doğruysa, imzalayan için "İmzayı Reddet" seçeneğini gizler.

Diğer Eylemi Gizle
hideMoreAction boolean

Doğruysa, gönderme/imzalama oturumunda "Diğer Eylemler" düğmesini gizler. "Şimdi Gönder": true durumunda hiçbir şey gizlenmeyecektir.

Gönder Düğmesini Gizle
hideSendButton boolean

Doğruysa, eklenmiş gönderme oturumunda Gönder düğmesini gizler.

Sonraki Gerekli Alanı Gizlebtn
hideNextRequiredFieldbtn boolean

true olarak ayarlanırsa, imzalayanları bir sonraki gerekli alana taşıyan gezinti düğmesini gizler.

Gerekli Her İki Katıştırılmış Oturum
requiredBothEmbeddedSession boolean

True ise, eklenmiş gönderme ve imzalama URL'lerini birlikte oluşturur.

Zarf Parolası
folderPassword string

Dijital olarak imzalanan belgeyi açmak için imzalayan/yazan kişi bu parolayı gerektirir. Parametre boş tutulursa, dijital olarak imzalanan belgeyi açmak için parola gerekmez.

Adım Adım Etkinleştir
enableStepByStep boolean

Eklenmiş gönderme oturumunda adım adım eylemi etkinleştirmek için.

Taraf Ekle Seçeneğini Gizle
hideAddPartiesOption boolean

Doğruysa, Taslak ve Şablon Oluşturma modunda taraf ekleme seçeneğini gizler.

Kendi Kendine İmzala
selfSign boolean

API'ler aracılığıyla tümleşik Self Sign'a olanak tanır. Bu parametre yalnızca createEmbeddedSendingSession parametresi true olduğunda geçerlidir.

Kendinden İmzalayan Başarı Url'si
selfSignerSuccessUrl string

Web sitenizdeki/uygulamanızdaki giriş sayfasının mutlak URL'sini girin. Bu url, ekli gönderme görünümünde klasörü başarıyla kendi kendine imzaladıktan sonra yeniden yönlendirilecektir.

Döndürülenler

Name Yol Tür Description
Kimlik
folder.folderId integer

Yeni oluşturulan zarfın benzersiz kimliği. Bu zarfa başvurmak için bunu sonraki eylemlerde kullanın.

İsim
folder.folderName string

Yeni oluşturulan zarfın adı.

Özel Ad
folder.folderCustomName string

Zarf için özel bir ad.

Şifre
folder.folderPassword string

Ayarlandıysa zarfın erişim parolası.

Oluşturucu Kimliği
folder.folderAuthorId integer

Zarf oluşturucusunun benzersiz tanımlayıcısı.

Oluşturucu Adı
folder.folderAuthorFirstName string

Zarfı oluşturanın adı.

Oluşturucu Soyadı
folder.folderAuthorLastName string

Zarfı oluşturanın soyadı.

Oluşturucu E-postası
folder.folderAuthorEmail string

Zarf oluşturucusunun e-posta adresi.

Oluşturucu Rolü
folder.folderAuthorRole string

Zarfı oluşturanın rolü.

Şirket Kimliği
folder.folderCompanyId integer

Zarfın sahibi olan şirketin benzersiz tanımlayıcısı.

Oluşturulma Tarihi
folder.folderCreationDate integer

Zarfın oluşturulduğu tarih (Milisaniye cinsinden Unix zaman damgası).

Gönderme Tarihi
folder.folderSentDate integer

Zarfın gönderildiği tarih (Milisaniye cinsinden Unix zaman damgası).

Status
folder.folderStatus string

Zarfın geçerli durumu.

Özel Alan 1
folder.custom_field1 string

Zarfın ilk özel meta veri alanı.

Özel Alan 2
folder.custom_field2 string

Zarfın ikinci özel meta veri alanı.

Meta veriler
folder.metadata string

Zarfla ilişkilendirilmiş özel meta veriler.

Belge Kimlikleri
folder.folderDocumentIds array of integer

Zarfta bulunan belge kimliklerinin listesi.

Documents
folder.documentsList array of object

Zarftaki belgelerin listesi.

Belge Kimliği
folder.documentsList.documentId integer

Belgenin benzersiz tanımlayıcısı.

Sözleşme Kimliği
folder.documentsList.contractId integer

Sözleşmenin benzersiz tanımlayıcısı.

Şirket Kimliği
folder.documentsList.companyId integer

Şirketin benzersiz tanımlayıcısı.

Oluşturan
folder.documentsList.contractCreatedBy integer

Sözleşmeyi oluşturan kişinin kullanıcı kimliği.

Oluşturulma Tarihi
folder.documentsList.contractCreatedOn string

Sözleşmenin oluşturulduğu tarih ve saat.

Sözleşme Türü
folder.documentsList.contractType string

Sözleşmenin türü.

Sözleşme Durumu
folder.documentsList.contractStatus string

Sözleşmenin geçerli durumu.

Düzenlenebilir
folder.documentsList.editable boolean

Öğenin düzenlenebilir olup olmadığını gösterir.

Sürüm Kimliği
folder.documentsList.contractVersionId integer

Sözleşme sürümünün benzersiz tanımlayıcısı.

Sürüm Adı
folder.documentsList.contractVersionName string

Sözleşme sürümünün adı.

Sürüm Açıklaması
folder.documentsList.contractVersionDesc string

Sözleşme sürümünün açıklaması.

Oluşturan Sürüm
folder.documentsList.versionCreatedby integer

Bu sürümü oluşturan kişinin kullanıcı kimliği.

Sürüm Oluşturma Tarihi
folder.documentsList.versionCreatedOn string

Bu sürümün oluşturulduğu tarih ve saat.

Sürüm Numarası
folder.documentsList.contractVersionNumber integer

Sözleşmenin sürüm numarası.

İşlem Kaynağı
folder.documentsList.contractTransactionSource string

Sözleşme işlemini başlatan kaynak sistem.

Alıcı
folder.folderRecipientParties array of object

Bu zarfın alıcı taraflarının listesi.

Alıcı Kimliği
folder.folderRecipientParties.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
folder.folderRecipientParties.partyDetails.partyId integer

Alıcının benzersiz tanımlayıcısı.

İlk İsim
folder.folderRecipientParties.partyDetails.firstName string

Alıcının adı.

Soyadı
folder.folderRecipientParties.partyDetails.lastName string

Alıcının soyadı.

E-Posta Adresi
folder.folderRecipientParties.partyDetails.emailId string

Alıcının e-posta adresi.

Yer tutucu
folder.folderRecipientParties.partyDetails.placeholder boolean

Bu tarafın yer tutucu alıcı olup olmadığını gösterir.

Adres
folder.folderRecipientParties.partyDetails.address string

Alıcının fiziksel adresi.

Oluşturulma Tarihi
folder.folderRecipientParties.partyDetails.dateCreated integer

Kaydın oluşturulduğu tarih (milisaniye cinsinden Unix zaman damgası).

E-postaları Geri Çevir
folder.folderRecipientParties.partyDetails.optOutEmails boolean

Alıcının e-posta bildirimlerini geri çevirip geri çevirmediğini gösterir.

Benzersiz Alıcı Kimliği
folder.folderRecipientParties.partyDetails.uniquePartyId string

Bu alıcı için benzersiz bir sistem tanımlayıcısı.

Kimlik Doğrulama Düzeyi
folder.folderRecipientParties.partyDetails.authenticationLevel string

Bu alıcı için gereken kimlik doğrulama yöntemi.

Parola Güncelleştirme Tarihi
folder.folderRecipientParties.partyDetails.passwordUpdateDate string

Parolanın son güncelleştirilildiği tarih.

Parola Güncelleştirildi Durumu
folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

Parolanın güncelleştirilip güncelleştirilmediğini gösterir.

Şirket Kimliği
folder.folderRecipientParties.partyDetails.companyId integer

Şirketin benzersiz tanımlayıcısı.

Kullanıcı Rolü
folder.folderRecipientParties.partyDetails.userRole string

Kullanıcıya atanan rol.

Bölüm
folder.folderRecipientParties.partyDetails.department string

Kullanıcının ait olduğu bölüm.

Başlık
folder.folderRecipientParties.partyDetails.title string

Kullanıcının iş unvanı.

Aktif
folder.folderRecipientParties.partyDetails.active boolean

Kullanıcının veya kaydın etkin olup olmadığını gösterir.

Locale
folder.folderRecipientParties.partyDetails.requestLocale string

Kullanıcının yerel ayarı.

Bölüm ile paylaş
folder.folderRecipientParties.partyDetails.share_among_department boolean

Zarfların departman genelinde paylaşılıp paylaşılmadığını gösterir.

Arama Kodu
folder.folderRecipientParties.partyDetails.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.folderRecipientParties.partyDetails.mobileNumber string

Cep telefonu numarası.

Durum Filtresi
folder.folderRecipientParties.partyDetails.docStatusFilter string

Belge durumu filtresi.

Tarih Filtresi
folder.folderRecipientParties.partyDetails.docDateFilter string

Belge tarihi filtresi.

Güvenli Alan Erişimi
folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

Kullanıcının güvenli alanlara erişimi olup olmadığını gösterir.

Kenar Çubuğunu Genişlet
folder.folderRecipientParties.partyDetails.expandSidebar boolean

Kenar çubuğunun varsayılan olarak genişletilmiş olup olmadığını gösterir.

E-posta Doğrulama
folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

Gelişmiş e-posta doğrulamasının etkinleştirilip etkinleştirilmediğini gösterir.

Yönetici Kimliği
folder.folderRecipientParties.partyDetails.managerId string

Kullanıcının yöneticisinin benzersiz tanımlayıcısı.

Oturum Açma Sayısı
folder.folderRecipientParties.partyDetails.loginCount integer

Kullanıcının oturum açma sayısı.

Parola Sıfırlama E-postası
folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

Parola sıfırlama e-postası gönderilmesi gerekip gerekmediğini gösterir.

Departman Kimliği
folder.folderRecipientParties.partyDetails.departmentId string

Bölümün benzersiz tanımlayıcısı.

Birincil Şirket
folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

Kullanıcıyla ilişkili birincil şirket.

Cihaz Türü
folder.folderRecipientParties.partyDetails.deviceType string

Kullanılan cihaz türü.

Cihaz Belirteci
folder.folderRecipientParties.partyDetails.deviceToken string

Cihaz için anında iletme bildirimi belirteci.

Taşeron Açıklaması
folder.folderRecipientParties.partyDetails.subcontractorDescription string

Alt yüklenicinin veya dış imzalayanın açıklaması.

Alt Yüklenici Kuruluşu
folder.folderRecipientParties.partyDetails.subcontractorOrganization string

Alt yüklenicinin veya dış imzalayanın kuruluş adı.

Taşeron Ekleme Tarihi
folder.folderRecipientParties.partyDetails.subcAddedDate integer

Alt yüklenicinin eklendiği tarih (milisaniye cinsinden Unix zaman damgası).

Source
folder.folderRecipientParties.partyDetails.source string

Dış imzalayanın eklendiği kaynak sistem.

Arama Kodu
folder.folderRecipientParties.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.folderRecipientParties.mobileNumber string

Cep telefonu numarası.

İmza Türü
folder.folderRecipientParties.signerSignatureType string

İmzalayanın kullanacağı imza türü.

İzinler
folder.folderRecipientParties.contractPermissions string

Sözleşme için bu tarafa verilen izinler.

İmzalama Sırası
folder.folderRecipientParties.partySequence integer

Bu alıcı için imzalama siparişi sıra numarası.

İş Akışı Dizisi
folder.folderRecipientParties.workflowSignSequence integer

İş akışı imzalama sırası numarası.

Zarf Kimliği
folder.folderRecipientParties.envelopeId integer

Zarfın benzersiz tanımlayıcısı.

Alıcı Şirket Kimliği
folder.folderRecipientParties.partyCompanyId integer

Bu alıcıyla ilişkili şirketin benzersiz tanımlayıcısı.

Paylaşım Modu
folder.folderRecipientParties.sharingMode string

Bu zarfın paylaşım modu.

Alıcı Erişim URL'si
folder.folderRecipientParties.folderAccessURL string

Alıcının zarfa erişmek ve zarfı imzalamak için kullanabileceği URL.

Güvenlik Modu
folder.folderRecipientParties.securityMode string

Bu zarfa uygulanan güvenlik modu.

Açıklamalar
folder.folderRecipientParties.extraComments string

Zarfa eklenen ek açıklamalar.

Ad Değişikliğine İzin Ver
folder.folderRecipientParties.allowNameChange boolean

Alıcının adını güncelleştirmesine izin verilip verilmeyeceğini gösterir.

Ad Güncelleştirildi
folder.folderRecipientParties.signerNameUpdated boolean

İmzalayanın adını güncelleştirip güncelleştirmediğini gösterir.

İmzalayan Kimlik Doğrulama Düzeyi
folder.folderRecipientParties.signerAuthenticationLevel string

İmzalayan için gereken kimlik doğrulama düzeyi.

Erişim Kodu
folder.folderRecipientParties.userDefinedAccessCode string

İmzalayan için tanımlanan özel erişim kodu.

İmza Kimliği
folder.folderRecipientParties.signatureId string

İmzanın benzersiz tanımlayıcısı.

Alıcı Rolü
folder.folderRecipientParties.partyRole string

İmzalama iş akışında bu alıcıya atanan rol.

Şirket Alanı
folder.folderRecipientParties.companyFieldValue string

İmzadaki şirket adı alanının değeri.

Başlık Alanı
folder.folderRecipientParties.titleFieldValue string

İmzadaki başlık alanının değeri.

İmzalama Nedeni
folder.folderRecipientParties.reasonSigning string

Alıcının belgeyi imzalama nedeni.

Ödeme Alanı Eklendi
folder.folderRecipientParties.payFieldAdded boolean

Ödeme alanının eklenip eklenmediğini gösterir.

Alacaklı
folder.folderRecipientParties.payee boolean

Bu alıcının alacaklı olup olmadığını gösterir.

Yinelenen Ödeme
folder.folderRecipientParties.recurringFieldExist boolean

Yinelenen ödeme alanının mevcut olup olmadığını gösterir.

Yazdırma ve İmza Bitti
folder.folderRecipientParties.printAndSignCompleted boolean

Yazdırma ve imzalama işleminin tamamlanıp tamamlanmadığını gösterir.

Paid
folder.folderRecipientParties.paid boolean

Ödemenin tamamlanıp tamamlanmadığını gösterir.

İsteğe Bağlı İmzalayana İzin Verildi
folder.folderRecipientParties.allowOptionalSigner boolean

Bu alıcının isteğe bağlı bir imzalayan olup olmadığını gösterir.

İsteğe Bağlı İmzalayanlar
folder.folderRecipientParties.optionalSigners array of integer

Bu zarf için isteğe bağlı imzalayan taraf kimliklerinin listesi.

Yazar İmzalama URL'si
folder.folderAccessURLForAuthor string

Gönderenin zarfa erişmek için kullanabileceği URL.

Taslak Erişim URL'si
folder.draftFolderAccessURL string

Zarfın taslak sürümüne erişmek için kullanılan URL.

Yönetim Kurulu İmzalama
folder.boardRoomSign boolean

Pano odası imzalama modunun etkinleştirilip etkinleştirilmediğini gösterir.

Logo Ekle
folder.includeLogo boolean

Şirket logosunun e-postalara eklenip eklenmediğini gösterir.

Düğme Arka Plan Rengi
folder.email_btnBgColor string

E-posta düğmesinin arka plan rengi.

Düğme Metin Rengi
folder.email_btnTxtColor string

E-posta düğmesinin metin rengi.

E-posta Logosu
folder.emailTemplateLogo string

E-posta şablonunda kullanılan logo URL'si.

E-posta Şablonu Kimliği
folder.emailTemplateId integer

E-posta şablonunun benzersiz tanımlayıcısı.

E-posta Üst Bilgisi
folder.emailHeader string

Bildirim e-postalarında kullanılan üst bilgi metni.

E-posta Alt Bilgisi
folder.emailFooter string

Bildirim e-postalarında kullanılan alt bilgi metni.

Zamanlanmış Temizleme
folder.purgeFlag boolean

Zarfın temizleme için zamanlanıp zamanlanmadığını gösterir.

Başlangıç Tarihini Temizle
folder.purgeStartDate string

Temizleme işleminin başlamak üzere zamanlandığı tarih.

Bitiş Tarihini Temizle
folder.purgeEndDate string

Temizleme işleminin tamamlanmak üzere zamanlandığı tarih.

Toplu Gönderme Kimliği
folder.bulkId integer

Toplu gönderme işleminin benzersiz tanımlayıcısı.

İmza Sırasını Zorla
folder.enforceSignWorkflow boolean

Alıcıların tanımlı sırada oturum açması gerekip gerekmediğini gösterir.

Geçerli Adım
folder.currentWorkflowStep integer

İmzalama iş akışındaki geçerli adım.

İşlem Kaynağı
folder.transactionSource string

Bu işlemi başlatan kaynak sistem.

Düzenlenebilir
folder.editable boolean

Öğenin düzenlenebilir olup olmadığını gösterir.

In-Person İmzalama
folder.inPersonSignable boolean

Zarfın bizzat imzalanıp imzalanamayacağını gösterir.

Anımsatıcıları Geçersiz Kıl
folder.overrideAccountReminders boolean

Hesap düzeyi anımsatıcı ayarlarının geçersiz kılınıp kılınmadığını gösterir.

TemsilciYi Geçersiz Kıl
folder.overrideAccountRecipientDelegation boolean

Hesap düzeyinde temsilci seçme ayarlarının geçersiz kılınıp kılınmadığını gösterir.

Temsilci Seçmeye İzin Ver
folder.allowRecipientsToDelegate boolean

Alıcıların imzalamayı temsilci olarak atamasına izin verilip verilmeyeceğini gösterir.

Kimlik
folder.envelopeId integer

Zarfın benzersiz tanımlayıcısı.

İsim
folder.envelopeName string

Zarfın adı.

Kaynak Kimliği
folder.envelopeOriginatorId integer

Zarfı oluşturan kullanıcının benzersiz tanımlayıcısı.

Şirket Kimliği
folder.envelopeCompanyId integer

Zarfın sahibi olan şirketin benzersiz tanımlayıcısı.

Date
folder.envelopeDate integer

Zarfın oluşturulduğu tarih (Milisaniye cinsinden Unix zaman damgası).

Paylaşılan Tarih
folder.envelopeSharedDate integer

Zarfın paylaşıldığı tarih (milisaniye cinsinden Unix zaman damgası).

Status
folder.envelopeStatus string

Zarfın geçerli durumu.

Sözleşme kimlikleri
folder.envelopeContractIds array of integer

Bu zarfla ilişkili sözleşme kimliklerinin listesi.

Alıcı İzinleri
folder.envelopePartyPermissions array of object

Bu zarf için alıcı izinlerinin listesi.

Alıcı Kimliği
folder.envelopePartyPermissions.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
folder.envelopePartyPermissions.partyDetails.partyId integer

Alıcının benzersiz tanımlayıcısı.

İlk İsim
folder.envelopePartyPermissions.partyDetails.firstName string

Alıcının adı.

Soyadı
folder.envelopePartyPermissions.partyDetails.lastName string

Alıcının soyadı.

E-Posta Adresi
folder.envelopePartyPermissions.partyDetails.emailId string

Alıcının e-posta adresi.

Yer tutucu
folder.envelopePartyPermissions.partyDetails.placeholder boolean

Bu tarafın yer tutucu alıcı olup olmadığını gösterir.

Adres
folder.envelopePartyPermissions.partyDetails.address string

Alıcının fiziksel adresi.

Oluşturulma Tarihi
folder.envelopePartyPermissions.partyDetails.dateCreated integer

Kaydın oluşturulduğu tarih (milisaniye cinsinden Unix zaman damgası).

E-postaları Geri Çevir
folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

Alıcının e-posta bildirimlerini geri çevirip geri çevirmediğini gösterir.

Benzersiz Alıcı Kimliği
folder.envelopePartyPermissions.partyDetails.uniquePartyId string

Bu alıcı için benzersiz bir sistem tanımlayıcısı.

Kimlik Doğrulama Düzeyi
folder.envelopePartyPermissions.partyDetails.authenticationLevel string

Bu alıcı için gereken kimlik doğrulama yöntemi.

Parola Güncelleştirme Tarihi
folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

Parolanın son güncelleştirilildiği tarih.

Parola Güncelleştirildi Durumu
folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

Parolanın güncelleştirilip güncelleştirilmediğini gösterir.

Şirket Kimliği
folder.envelopePartyPermissions.partyDetails.companyId integer

Şirketin benzersiz tanımlayıcısı.

Kullanıcı Rolü
folder.envelopePartyPermissions.partyDetails.userRole string

Kullanıcıya atanan rol.

Bölüm
folder.envelopePartyPermissions.partyDetails.department string

Kullanıcının ait olduğu bölüm.

Başlık
folder.envelopePartyPermissions.partyDetails.title string

Kullanıcının iş unvanı.

Aktif
folder.envelopePartyPermissions.partyDetails.active boolean

Kullanıcının veya kaydın etkin olup olmadığını gösterir.

Locale
folder.envelopePartyPermissions.partyDetails.requestLocale string

Kullanıcının yerel ayarı.

Bölüm ile paylaş
folder.envelopePartyPermissions.partyDetails.share_among_department boolean

Zarfların departman genelinde paylaşılıp paylaşılmadığını gösterir.

Arama Kodu
folder.envelopePartyPermissions.partyDetails.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.envelopePartyPermissions.partyDetails.mobileNumber string

Cep telefonu numarası.

Durum Filtresi
folder.envelopePartyPermissions.partyDetails.docStatusFilter string

Belge durumu filtresi.

Tarih Filtresi
folder.envelopePartyPermissions.partyDetails.docDateFilter string

Belge tarihi filtresi.

Güvenli Alan Erişimi
folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

Kullanıcının güvenli alanlara erişimi olup olmadığını gösterir.

Kenar Çubuğunu Genişlet
folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

Kenar çubuğunun varsayılan olarak genişletilmiş olup olmadığını gösterir.

E-posta Doğrulama
folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

Gelişmiş e-posta doğrulamasının etkinleştirilip etkinleştirilmediğini gösterir.

Yönetici Kimliği
folder.envelopePartyPermissions.partyDetails.managerId string

Kullanıcının yöneticisinin benzersiz tanımlayıcısı.

Oturum Açma Sayısı
folder.envelopePartyPermissions.partyDetails.loginCount integer

Kullanıcının oturum açma sayısı.

Parola Sıfırlama E-postası
folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

Parola sıfırlama e-postası gönderilmesi gerekip gerekmediğini gösterir.

Departman Kimliği
folder.envelopePartyPermissions.partyDetails.departmentId string

Bölümün benzersiz tanımlayıcısı.

Birincil Şirket
folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

Kullanıcıyla ilişkili birincil şirket.

Cihaz Türü
folder.envelopePartyPermissions.partyDetails.deviceType string

Kullanılan cihaz türü.

Cihaz Belirteci
folder.envelopePartyPermissions.partyDetails.deviceToken string

Cihaz için anında iletme bildirimi belirteci.

Taşeron Açıklaması
folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

Alt yüklenicinin veya dış imzalayanın açıklaması.

Alt Yüklenici Kuruluşu
folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

Alt yüklenicinin veya dış imzalayanın kuruluş adı.

Taşeron Ekleme Tarihi
folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

Alt yüklenicinin eklendiği tarih (milisaniye cinsinden Unix zaman damgası).

Source
folder.envelopePartyPermissions.partyDetails.source string

Dış imzalayanın eklendiği kaynak sistem.

Arama Kodu
folder.envelopePartyPermissions.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.envelopePartyPermissions.mobileNumber string

Cep telefonu numarası.

İmza Türü
folder.envelopePartyPermissions.signerSignatureType string

İmzalayanın kullanacağı imza türü.

İzinler
folder.envelopePartyPermissions.contractPermissions string

Sözleşme için bu tarafa verilen izinler.

İmzalama Sırası
folder.envelopePartyPermissions.partySequence integer

Bu alıcı için imzalama siparişi sıra numarası.

İş Akışı Dizisi
folder.envelopePartyPermissions.workflowSignSequence integer

İş akışı imzalama sırası numarası.

Zarf Kimliği
folder.envelopePartyPermissions.envelopeId integer

Zarfın benzersiz tanımlayıcısı.

Alıcı Şirket Kimliği
folder.envelopePartyPermissions.partyCompanyId integer

Bu alıcıyla ilişkili şirketin benzersiz tanımlayıcısı.

Paylaşım Modu
folder.envelopePartyPermissions.sharingMode string

Bu zarfın paylaşım modu.

Alıcı Erişim URL'si
folder.envelopePartyPermissions.folderAccessURL string

Alıcının zarfa erişmek ve zarfı imzalamak için kullanabileceği URL.

Güvenlik Modu
folder.envelopePartyPermissions.securityMode string

Bu zarfa uygulanan güvenlik modu.

Açıklamalar
folder.envelopePartyPermissions.extraComments string

Zarfa eklenen ek açıklamalar.

Ad Değişikliğine İzin Ver
folder.envelopePartyPermissions.allowNameChange boolean

Alıcının adını güncelleştirmesine izin verilip verilmeyeceğini gösterir.

Ad Güncelleştirildi
folder.envelopePartyPermissions.signerNameUpdated boolean

İmzalayanın adını güncelleştirip güncelleştirmediğini gösterir.

İmzalayan Kimlik Doğrulama Düzeyi
folder.envelopePartyPermissions.signerAuthenticationLevel string

İmzalayan için gereken kimlik doğrulama düzeyi.

Erişim Kodu
folder.envelopePartyPermissions.userDefinedAccessCode string

İmzalayan için tanımlanan özel erişim kodu.

İmza Kimliği
folder.envelopePartyPermissions.signatureId string

İmzanın benzersiz tanımlayıcısı.

Alıcı Rolü
folder.envelopePartyPermissions.partyRole string

İmzalama iş akışında bu alıcıya atanan rol.

Şirket Alanı
folder.envelopePartyPermissions.companyFieldValue string

İmzadaki şirket adı alanının değeri.

Başlık Alanı
folder.envelopePartyPermissions.titleFieldValue string

İmzadaki başlık alanının değeri.

İmzalama Nedeni
folder.envelopePartyPermissions.reasonSigning string

Alıcının belgeyi imzalama nedeni.

Ödeme Alanı Eklendi
folder.envelopePartyPermissions.payFieldAdded boolean

Ödeme alanının eklenip eklenmediğini gösterir.

Alacaklı
folder.envelopePartyPermissions.payee boolean

Bu alıcının alacaklı olup olmadığını gösterir.

Yinelenen Ödeme
folder.envelopePartyPermissions.recurringFieldExist boolean

Yinelenen ödeme alanının mevcut olup olmadığını gösterir.

Yazdırma ve İmza Bitti
folder.envelopePartyPermissions.printAndSignCompleted boolean

Yazdırma ve imzalama işleminin tamamlanıp tamamlanmadığını gösterir.

Paid
folder.envelopePartyPermissions.paid boolean

Ödemenin tamamlanıp tamamlanmadığını gösterir.

Kimlik Doğrulama Düzeyi
folder.envelopeAuthenticationLevel string

Zarf için gereken kimlik doğrulama düzeyi.

Tek İmzalayan Toplu
folder.allowSingleSignerInBulk boolean

Toplu gönderme modunda tek bir imzalayana izin verilip verilmeyeceğini gösterir.

File-Based Adlandırma
folder.folderNameBasedOnFileNaming boolean

Klasör adının dosya adını temel alıp almayacağını gösterir.

Belge File-Based Adı
folder.documentNameBasedOnFileNaming boolean

Belge adının dosya adını temel alıp almayacağını gösterir.

Sertifika File-Based Adı
folder.certificateNameBasedOnFileNaming boolean

Sertifika adının dosya adını temel alıp almayacağını gösterir.

Exec Öncesi Dosya Adlandırma
folder.enableFileNamingBeforeExecution boolean

Belge yürütmeden önce dosya adlandırmanın etkinleştirilip etkinleştirilmediğini gösterir.

Payee Eklendi
folder.payeeAddedd boolean

Bir ödemenin eklenip eklenmediğini gösterir.

Self-Signing Etkin
folder.selfSignerEnabled boolean

Otomatik imzalama modunun etkinleştirilip etkinleştirilmediğini gösterir.

Noter Etkin
folder.notaryEnabled boolean

Noter imzalamanın etkinleştirilip etkinleştirilmediğini gösterir.

Sınırlı Görünürlük
folder.limitedVisibilityFlag boolean

Bu zarf için sınırlı görünürlüğün etkinleştirilip etkinleştirilmediğini gösterir.

İmza Sonrası Görünürlük
folder.postSigningVisibility boolean

İmzalama sonrası görünürlüğün etkinleştirilip etkinleştirilmediğini gösterir.

Islak İmza
folder.wetSignatureEnabled boolean

Islak imzaların etkinleştirilip etkinleştirilmediğini gösterir.

Birleştirme Etkin
folder.mergeEnabled boolean

Belge birleştirmenin etkinleştirilip etkinleştirilmediğini gösterir.

Ekli İmzalama Oturumları
embeddedSigningSessions array of object

Alıcı başına bir tane olan ekli imzalama oturumlarının listesi. Yalnızca createEmbeddedSigningSession true olduğunda bulunur.

İmzalayan E-postası
embeddedSigningSessions.emailIdOfSigner string

Bu ekli imzalama oturumu için alıcının e-posta adresi.

İmzalama Belirteci
embeddedSigningSessions.embeddedToken string

Bu alıcının ekli imzalama oturumu için benzersiz belirteç.

İmzalama Oturumu URL'si
embeddedSigningSessions.embeddedSessionURL string

Bu alıcının belgeyi imzalaması için aç veya ekle URL'si.

Ekli Gönderme Belirteci
embeddedToken string

Eklenmiş gönderme oturumu için belirteç. Yalnızca createEmbeddedSendingSession true olduğunda bulunur.

Oturum URL'si Gönderiliyor
embeddedSessionURL string

Zarf yazarının zarfı hazırlaması ve göndermesi için açılacak veya eklenmek üzere URL. Yalnızca createEmbeddedSendingSession true olduğunda bulunur.

Result
result string

İşlemin sonucu.

Message
message string

İşlemin sonucunu açıklayan bir ileti.

Base64'ten Şablon Oluşturma

Base64 kodlu PDF dizesini kullanarak yeni bir şablon oluşturur. PDF dosyanız akışınızda base64 dizesi olarak kullanılabiliyorsa (örneğin, bir SharePoint dosyasından veya OneDrive belgesinden) bunu kullanın.

Parametreler

Name Anahtar Gerekli Tür Description
Şablon Adı
templateName True string

Şablonun adı. .pdf uzantısıyla bitmelidir (örneğin, onboarding.pdf).

Base64 Dosya Dizesi
base64FileString True string

Şablon oluşturmak için PDF'nin BASE64 dizesi. Şablonu oluştururken genel olarak erişilebilir olmalıdır.

Giriş Türü
inputType True string

Belgenin giriş yöntemi. Bu eylem için her zaman 'base64' olarak ayarlayın.

Metin Etiketlerini İşleme
processTextTags True boolean

Etkinleştirildiğinde, Foxit eSign belgeyi Metin Etiketleri için tarar ve otomatik olarak imza alanlarına dönüştürür.

İşlem Acro Alanları
processAcroFields True boolean

Foxit eSign etkinleştirildiğinde belgeyi AcroFields için tarar ve otomatik olarak imza alanlarına dönüştürür.

Tümünü Paylaş
shareAll True boolean

Bu şablonu hesabınızdaki tüm kullanıcılarla paylaşın.

Taraf Sayısı
numberOfParties True integer

Bu şablon için alıcı taraflarının sayısı. 20'den küçük olmalıdır.

Tema Rengi
themeColor string

Eklenen şablon oturumunun temasını özelleştirmek için bir CSS renk değeri (örneğin, #42caf4).

E-posta Yaz
authorEmail string

Bu şablonun yazarı olarak ayarlanacak hesaptaki başka bir kullanıcının e-posta adresi.

Ekli Şablon Oluşturma Oturumu
createEmbeddedTemplateSession boolean

True olarak ayarlanırsa, Foxit eSign şablon düzenleyicisini doğrudan açabilmeniz ve alanları şablona sürükleyip bırakabilmeniz için eklenmiş bir şablon oturumu oluşturulur.

Yeniden yönlendirme URL'si
redirectURL string

Eklenmiş Şablon Oluşturma Oturumu doğruysa, ekli şablon düzenleyicisinde Kaydet ve Kapat'a tıkladıktan sonra kullanıcıyı yeniden yönlendirilecek URL.

Gönderme Şablonunu Gizle
hideSendTemplate boolean

Doğruysa, Gönder düğmesi eklenmiş şablon düzenleyicisinde gizlenir.

Alıcı Taraflarını Düzelt
fixRecipientParties boolean

Doğruysa, eklenmiş şablon düzenleyicisinde zaten eklenmiş olan alıcı tarafları değiştirilemez.

Alanlar
Fields object
permissions
permission True string
Sequence
sequence True integer

Bu taraf için 1'den başlayarak benzersiz bir sıra numarası. Oturum Açma Sırası etkinleştirildiğinde imzalama sırasını tanımlar.

Alıcı Rolü
partyRole True string

Şablonda bu tarafa atanan rol.

Diğer Eylemi Gizle
hideMoreAction boolean

True ise, ekli şablon oturumunda Diğer Eylemler düğmesi gizlenir.

Herkesle Paylaş'ın gizlenir
hideShareWithAll boolean

Doğruysa, Tümüyle Paylaş seçeneği eklenmiş şablon oturumunda gizlenir.

Grup Ekle'yi gizle
hideAddParty boolean

Doğruysa, eklenen şablon oturumunda tüm grup ekleme seçenekleri gizlenir.

Beni Gizle Düğmesi
hideMeButton boolean

Doğruysa, Alıcı Taraflarındaki Ben düğmesi eklenmiş şablon oturumunda gizlenir.

Diğerlerini Gizle Düğmesi
hideOthersButton boolean

Doğruysa, Alıcı Taraflarındaki Diğer düğmesi eklenmiş şablon oturumunda gizlenir.

Alıcılar için Alan Adını Gizle
hideFieldNameForRecipients boolean

Doğruysa, alan adları veri girişi ve gelişmiş alanlar için alıcılardan gizlenir.

Onay Kutusu Kenarlığını Gizle
hideCheckboxBorder boolean

True ise, yürütülen belgelerde onay kutusu kenarlıkları gizlenir.

Döndürülenler

Name Yol Tür Description
Result
result string

İşlemin başarılı olup olmadığını gösterir (örneğin, 'başarı').

Message
message string

İşlem sonucunun açıklaması.

Kimlik
template.templateId integer

Oluşturulan şablonun benzersiz kimliği. Bu şablondan zarf oluşturmak için bunu kullanın.

İsim
template.templateName string

Şablonun adı.

Description
template.templateDesc string

Şablonun açıklaması.

Türü
template.templateType string

Şablonun türü.

Oluşturma Tarihi
template.templateCreationDate string

Şablonun oluşturulduğu tarih.

Son Güncelleştirme Tarihi
template.templateLastUpdateDate string

Şablonun son güncelleştirilildiği tarih.

Düzenlenebilir
template.editable boolean

Şablonun düzenlenip düzenlenemeyeceğini gösterir.

Taraf Sayısı
template.numberOfParties integer

Şablonda tanımlanan alıcı taraflarının sayısı.

Toplam Sayfa Sayısı
template.totalPages integer

Şablon belgesindeki toplam sayfa sayısı.

Şirket Kimliği
template.companyId integer

Bu şablonun ait olduğu şirketin kimliği.

Tümüyle Paylaşılan
template.shareAll boolean

Bu şablonun hesaptaki tüm kullanıcılarla paylaşılıp paylaşılmadığını gösterir.

Grup İzinleri
template.templatePartyPermissions array of object

Bu şablonda tanımlanan alıcı rollerinin ve izinlerinin listesi.

Taraf kimliği
template.templatePartyPermissions.template_party_id integer

Bu şablon taraf girişinin benzersiz kimliği.

Kimlik
template.templatePartyPermissions.templateId integer

Bu tarafın ait olduğu şablonun kimliği.

İzinler
template.templatePartyPermissions.templatePermissions string

Bu taraf için imzalama izinleri (örneğin, FILL_FIELDS_AND_SIGN).

İmzalama Sırası
template.templatePartyPermissions.partySequence integer

Bu parti için imza siparişi konumu.

Grup Rolü
template.templatePartyPermissions.templatePartyRole string

Şablonda bu tarafa atanan rol adı. Şablondan zarf oluştururken bunu kullanın.

Kullanıcı kimliği
template.templateCreatedBy.partyId integer

Kullanıcının benzersiz kimliği.

İlk İsim
template.templateCreatedBy.firstName string

Kullanıcının adı.

Soyadı
template.templateCreatedBy.lastName string

Kullanıcının soyadı.

E-posta
template.templateCreatedBy.emailId string

Kullanıcının e-posta adresi.

Şablon Alanları
allfields array of object

Şablonda tanımlanan tüm imza ve form alanlarının listesi.

Alan Kimliği
allfields.fieldTagId integer

Alanın benzersiz tanımlayıcısı.

Şablon Kimliği
allfields.templateId integer

Bu alanın ait olduğu şablonun kimliği.

Şirket Kimliği
allfields.companyId integer

Bu alanın ait olduğu şirket hesabı.

Alan Türü
allfields.fieldType string

Alanın türü (örneğin, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).

Sayfa Numarası
allfields.documentPageNumber integer

Bu alanın yerleştirildiği belgenin sayfa numarası.

Sorumlu Taraf
allfields.partyResponsible integer

Bu alanı doldurmaktan sorumlu olan taraf dizisi numarası.

Parti Dizisi
allfields.partyResponsibleSequence integer

Sorumlu tarafın sıra konumu.

Alan Belge Kimliği
allfields.docFieldId string

Bu alanın belge düzeyi tanımlayıcısı.

Bağımlıdır
allfields.dependent boolean

Bu alanın görünürlüğünün başka bir alanın değerine bağlı olup olmadığını gösterir.

Sekme Sırası
allfields.tabOrder integer

Alanlar arasında gezinmek için sekme sırası.

Zorunlu
allfields.required boolean

Belgenin imzalanması için bu alanın doldurulması gerekip gerekmediğini gösterir.

Özel Alan Adı
allfields.customFieldName string

Bu alana atanan özel ad.

Tümünü Paylaş
allfields.shareAll boolean

Bu alanın tüm kullanıcılarla paylaşılıp paylaşılmadığını gösterir.

Düzenlemeye İzin Ver
allfields.allowEdit boolean

Bu alanın alıcı tarafından düzenlenip düzenlenemeyeceğini gösterir.

Metin Alanı Adı
allfields.textfieldName string

Metin alanının etiketi (fieldType 'textfield' olduğunda geçerlidir).

Değer
allfields.value string

Alanın önceden doldurulmuş veya girilmiş değeri.

Yazı Tipi Boyutu
allfields.fontSize integer

Bu alandaki metin için kullanılan yazı tipi boyutu.

Yazı Tipi Rengi
allfields.fontColor string

Bu alandaki metin için kullanılan yazı tipi rengi (örneğin, #000000).

Yalnızca Okunur
allfields.readOnly boolean

Alanın salt okunur olup olmadığını ve alıcı tarafından düzenlenemeyeceğini gösterir.

Çok Satırlı
allfields.multiLine boolean

Metin alanının birden çok giriş satırı kabul edip etmediğini gösterir (fieldType 'textfield' olduğunda geçerlidir).

Karakter Sınırı
allfields.characterLimit integer

Alanda izin verilen en fazla karakter sayısı (fieldType 'textfield' olduğunda geçerlidir).

Tarih Alanı Adı
allfields.datefieldName string

Tarih alanının etiketi (fieldType 'datefield' olduğunda geçerlidir).

Tarih Biçimi
allfields.dateFormat string

Bu alan tarafından kullanılan tarih biçimi (örn. AA/GG/YYYY) (fieldType 'datefield' olduğunda geçerlidir).

Onay Kutusu Adı
allfields.cbname string

Onay kutusu alanının etiketi (fieldType 'checkboxfield' olduğunda geçerlidir).

Onay Kutusu Grubu
allfields.cbgroup string

Bu onay kutusunun grup adı (fieldType 'onay kutusualanı' olduğunda geçerlidir).

Kontrol edildi
allfields.checked boolean

Onay kutusunun varsayılan olarak işaretli olup olmadığını gösterir (fieldType 'onay kutusualanı' olduğunda geçerlidir).

Güvenli Alan Adı
allfields.securedfieldName string

Güvenli alanın etiketi (fieldType 'securedfield' olduğunda geçerlidir).

Görüntülenecek Karakterler
allfields.charToDisplay integer

Güvenli alan değerinin sonunda görüntülenecek maskelenmemiş karakter sayısı (fieldType 'securedfield' olduğunda geçerlidir).

İmza Kimliği
allfields.signatureId string

Bu imza alanına uygulanan imzanın kimliği (fieldType 'signfield' olduğunda geçerlidir).

İlk Görüntü
allfields.initialImage string

Bu alana uygulanan baş harflerin görüntü verileri (fieldType 'initialfield' olduğunda geçerlidir).

Ek Alan Adı
allfields.attachmentfieldName string

Ek alanının adı (fieldType 'attachmentfield' olduğunda geçerlidir).

Ek Açıklaması
allfields.attachmentfieldDescription string

Ekleneceklerin açıklaması (fieldType 'attachmentfield' olduğunda geçerlidir).

E-posta Grubu Ayrıntılarını Alma

Mevcut bir e-posta grubunun ayrıntılarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
E-posta Grubu Adları
emailGroupNames True array of string

Grupları tanımlamak için kullanılan e-posta grubu adları dizisi.

Döndürülenler

Name Yol Tür Description
E-posta Grupları
allEmailGroups array of object

İstenen grup adlarında eşleşen e-posta gruplarının listesi.

Grup Kimliği
allEmailGroups.groupId integer

E-posta grubunun benzersiz tanımlayıcısı.

Grup Adı
allEmailGroups.groupName string

E-posta grubunun adı.

Grup Açıklaması
allEmailGroups.groupDesc string

E-posta grubunun açıklaması.

Oluşturulma Tarihi
allEmailGroups.dateCreated integer

Unix milisaniye cinsinden e-posta grubunun oluşturulduğu tarih.

Şirket Kimliği
allEmailGroups.companyId integer

Bu e-posta grubunun ait olduğu şirket hesabı.

Parties
allEmailGroups.parties array of object

Bu e-posta grubundaki alıcıların listesi.

İlk İsim
allEmailGroups.parties.firstName string

Alıcının adı.

Soyadı
allEmailGroups.parties.lastName string

Alıcının soyadı.

E-posta
allEmailGroups.parties.emailId string

Alıcının e-posta adresi.

E-posta Grubu Oluştur

Aynı anda birden çok alıcıya zarf göndermek için kullanılabilecek yeni bir e-posta grubu oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Grup Adı
emailGroupName True string

Yeni e-posta grubunun adı.

Grup Açıklaması
emailGroupDescription string

E-posta grubu için isteğe bağlı bir açıklama.

Gelişmiş E-posta Doğrulamasına İzin Ver
allowAdvancedEmailValidation boolean

Foxit eSign etkinleştirildiğinde, göndermeden önce gruptaki tüm e-posta adreslerinin erişilebilir olduğunu doğrular.

İlk İsim
firstName True string

Alıcının adı.

Soyadı
lastName True string

Alıcının soyadı.

E-posta
emailId True string

Alıcının e-posta adresi.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Message
message string

Gerçekleştirilen eylem için bir onay iletisi.

Grup Kimliği
emailGroup.groupId integer

E-posta grubunun benzersiz tanımlayıcısı. Gruba zarf gönderirken bu kimliği kullanın.

Grup Adı
emailGroup.groupName string

E-posta grubunun adı.

Grup Açıklaması
emailGroup.groupDesc string

E-posta grubunun açıklaması.

Oluşturulma Tarihi
emailGroup.dateCreated integer

Unix milisaniye cinsinden e-posta grubunun oluşturulduğu tarih.

Şirket Kimliği
emailGroup.companyId integer

Bu e-posta grubunun ait olduğu şirket hesabı.

Parties
emailGroup.parties array of object

E-posta grubundaki alıcıların listesi.

İlk İsim
emailGroup.parties.firstName string

Alıcının adı.

Soyadı
emailGroup.parties.lastName string

Alıcının soyadı.

E-posta
emailGroup.parties.emailId string

Alıcının e-posta adresi.

İmza Anımsatıcısı Gönder

Bekleyen alıcılara bir zarfın anımsatıcı bildirimi göndererek imzalamayı tamamlamalarını ister.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Kimliği
folderId True integer

Zarfın kimliği.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Zarf Kimliği
reminder sent integer

Anımsatıcının gönderildiği zarfın kimliği.

Raporu İndir

Zarf etkinlik raporunu Microsoft Excel dosyası olarak indirir. Sonuçları duruma, tarih aralığına, zarf adına, yazara veya imzalayana göre daraltmak için filtreleri kullanın.

Parametreler

Name Anahtar Gerekli Tür Description
envelopeStatus
status string

Raporu filtrelediğimiz klasörün durumları

Oluşturma Tarihi
creationDateFrom string

Oluşturma Tarihi aralığının başlangıcı. Kabul edilen biçim: YYYY-AA-GG.

Oluşturma Tarihi:
creationDateTo string

Oluşturma Tarihi aralığının sonu. Kabul edilen biçim: YYYY-AA-GG.

Zarf Adı
folderName string

Bu dizeyi içeren herhangi bir klasör.

Alanları Ekle
includeFields string

Zarf alanı değerlerini rapora eklemek için 'true' olarak ayarlayın. Varsayılan olarak 'false' kullanılır.

E-posta Yaz
authorEmail string

Raporu yalnızca bu yazar e-posta adresi tarafından oluşturulan zarfları içerecek şekilde filtreleyin.

İmzalayan E-postası
signerEmail string

Raporu yalnızca bu e-posta adresinin imzalayan olduğu zarfları içerecek şekilde filtreleyin.

Döndürülenler

Rapor Dosyası
binary

Silinen Zarf Geçmişini Al

Silinmiş veya geri dönüşüm kutusuna taşınmış zarfların geçmişini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Kimliği
folderId True string

Silme geçmişini almak istediğiniz zarfın benzersiz tanımlayıcısı.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Silinen Zarf Bilgileri
Deleted Folder Log Info array of object

Silinen zarfla ilgili özet bilgiler.

Zarf Kimliği
Deleted Folder Log Info.folderId integer

Silinen zarfın benzersiz tanımlayıcısı.

Zarf Adı
Deleted Folder Log Info.folderName string

Silinen zarfın adı.

Belge Adı
Deleted Folder Log Info.documentName string

Silinen zarftaki belgenin adı.

Belge Kimliği
Deleted Folder Log Info.documentId string

Silinen zarftaki belgenin benzersiz tanımlayıcısı.

Silme Tarihi
Deleted Folder Log Info.deletionDate integer

Zarfın silindiği tarih ve saat( Unix milisaniye cinsinden).

Silme Ölçütü
Deleted Folder Log Info.deletedBy string

Zarfı silmiş olan kullanıcının adı.

Silme Günlüğü Geçmişi
Deleted Folder Log History array of object

Zarf üzerinde gerçekleştirilen tüm silme işlemlerinin adım adım günlüğü.

Gerçekleştirilen
Deleted Folder Log History.partiesName string

Silme adımını gerçekleştiren kullanıcının adı.

Source
Deleted Folder Log History.source string

Silme işleminin başlatıldığı kaynak (örneğin, Web, API).

Event
Deleted Folder Log History.event string

Gerçekleştirilen belirli silme eylemi (ör. Klasörü Sil, Klasördeki Tüm Tarafları Sil).

Tek Belge PDF'sini indirin

Zarftan pdf dosyası olarak tek bir belge indirir.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Kimliği
folderId True string

İndirilmesi gereken belgeyi içeren zarfın benzersiz tanımlayıcısı.

Belge Numarası
docNumber True string

1'den başlayarak indirilmesi gereken belgenin dizini.

Döndürülenler

response
binary

Tüm Web Kancası Kanallarını Listeleme

Hesabınızda yapılandırılan tüm web kancası kanallarının listesini döndürür.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Toplam Kanal Sayısı
total_channel integer

Hesapta yapılandırılan web kancası kanallarının toplam sayısı.

Web Kancası Kanalları
templatesList array of object

Hesaptaki tüm web kancası kanallarının listesi.

Kanal Kimliği
templatesList.channelId integer

Web kancası kanalının benzersiz tanımlayıcısı.

Şirket Kimliği
templatesList.companyId integer

Bu kanalın ait olduğu şirket hesabı.

Kanal Adı
templatesList.channelName string

Web kancası kanalının adı.

Web Kancası URL'si
templatesList.webhookUrl string

Abone olunan bir olay gerçekleştiğinde Foxit eSign'ın çağıracağı URL.

Web Kancası Gizli Dizisi
templatesList.webhookSecret string

Web kancası yüklerini doğrulamak için kullanılan gizli anahtar.

Oluşturulma Tarihi
templatesList.dateCreated integer

Unix milisaniye cinsinden kanalın oluşturulduğu tarih.

Güncelleştirme Tarihi
templatesList.dateUpdated integer

Unix milisaniye cinsinden kanalın son güncelleştirilmiş olduğu tarih.

Web Kancası Düzeyi
templatesList.webhookLevel string

Web kancası kanalının kapsamı. 'Hesap' (tüm zarflar için tetikleyiciler) veya 'API Uygulaması' (yalnızca API aracılığıyla oluşturulan zarflar için tetikler).

Status
templatesList.status string

Kanalın geçerli durumu. 'etkin' veya 'devre dışı' olabilir.

Gönderilen Zarf
templatesList.eventsSubscribedMap.folder_sent boolean

Alıcılara zarf gönderildiğinde tetikler.

Zarf Görüntülendi
templatesList.eventsSubscribedMap.folder_viewed boolean

Bir zarf alıcı tarafından açıldığında tetikler.

Zarf İmzalı
templatesList.eventsSubscribedMap.folder_signed boolean

Bir zarf bir alıcı tarafından imzalandığında tetikler.

Zarf İptal Edildi
templatesList.eventsSubscribedMap.folder_cancelled boolean

Zarf iptal edildiğinde tetikler.

Zarf Yürütüldü
templatesList.eventsSubscribedMap.folder_executed boolean

Tüm taraflar imzaladığında ve zarf tamamen yürütülürse tetikler.

Zarf Silindi
templatesList.eventsSubscribedMap.folder_deleted boolean

Zarf silindiğinde tetikler.

Tüm Şablonların listesini alma

Hesabınızdaki kullanılabilir tüm şablonların listesini döndürür.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Toplam Şablon Sayısı
total_templates integer

Hesabınızdaki toplam şablon sayısı.

Şablonlar Listesi
templatesList array of object

Hesapta bulunan tüm şablonların listesi.

Şablon Kimliği
templatesList.templateId integer

Şablonun benzersiz tanımlayıcısı. Şablonu imzalamak üzere göndermek için Şablondan Zarf Oluştur ile bu kimliği kullanın.

Şablon Adı
templatesList.templateName string

Şablonun adı.

Şablon Açıklaması
templatesList.templateDesc string

Şablonun açıklaması.

Şablon Türü
templatesList.templateType string

Şablonun türü veya kategorisi.

Oluşturulma Tarihi
templatesList.templateCreationDate integer

Şablonun oluşturulduğu tarih( Unix milisaniye cinsinden).

Son Güncelleştirme Tarihi
templatesList.templateLastUpdateDate integer

Şablonun unix milisaniye cinsinden son güncelleştirilmiş olduğu tarih.

Düzenlenebilir
templatesList.editable boolean

Şablonun düzenlenip düzenlenemeyeceğini gösterir.

Taraf Sayısı
templatesList.numberOfParties integer

Şablonda tanımlanan imzalama taraflarının sayısı.

Şirket Kimliği
templatesList.companyId integer

Şablonun ait olduğu şirket hesabı.

Tümüyle Paylaş
templatesList.shareAll boolean

Şablonun hesaptaki tüm kullanıcılarla paylaşılıp paylaşılmadığını gösterir.

Taraf kimliği
templatesList.templateCreatedBy.partyId integer

Kullanıcının benzersiz tanımlayıcısı.

İlk İsim
templatesList.templateCreatedBy.firstName string

Kullanıcının adı.

Soyadı
templatesList.templateCreatedBy.lastName string

Kullanıcının soyadı.

E-posta
templatesList.templateCreatedBy.emailId string

Kullanıcının e-posta adresi.

Taraf kimliği
templatesList.templateLastUpdatedBy.partyId integer

Kullanıcının benzersiz tanımlayıcısı.

İlk İsim
templatesList.templateLastUpdatedBy.firstName string

Kullanıcının adı.

Soyadı
templatesList.templateLastUpdatedBy.lastName string

Kullanıcının soyadı.

E-posta
templatesList.templateLastUpdatedBy.emailId string

Kullanıcının e-posta adresi.

URL'den Zarf Oluştur

Genel olarak erişilebilen PDF URL'lerini kullanarak bir zarf oluşturur ve gönderir. İmzalama işlemini başlatmak için belge URL'lerini ve alıcı ayrıntılarını sağlayın.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Adı
folderName True string

Bu zarfın adı.

Giriş Türü
inputType string

Belge kaynak biçimini belirtir. Dosya URL'lerini sağlamak için URL olarak veya Base64 ile kodlanmış dosya içeriği sağlamak için base64 olarak ayarlayın.

Dosya Url'leri
fileUrls True array of string

Bu zarfa eklenecek belgelere işaret eden genel erişime açık URL'ler dizisi.

Dosya Adları
fileNames True array of string

Her belge için Dosya URL'leri ile aynı sırada görünen ad dizisi.

İlk İsim
firstName True string

Alıcının adı.

Soyadı
lastName True string

Alıcının soyadı.

E-Posta Adresi
emailId True string

Alıcının e-posta adresi.

permissions
permission True string
Sequence
sequence True integer

Alıcı tarafları listesindeki bir alıcıya sıra numarası atamak için bu alanı kullanın. 1,2,3,4 gibi 1 ile başlayan her taraf için benzersiz sıra numaraları kullanın.... İmzalama iş akışında tek bir kişi birden çok kez görünüyorsa, lütfen alıcı her yinelendiğinde farklı bir sıra atayın.

signerAuthLevels
signerAuthLevel string

İmzalayanın doğrulama amacıyla yararlanacağı kimlik doğrulama düzeyi

Yer Tutucudur
isPlaceholder boolean

Bu alanı, bir yer tutucu olan partiyi başlatmak için kullanın. Not: 1. firstName, lastName, emailId parametresinin değeri bu taraf için boş olmalıdır. 2. Yer tutucuyu eklemek için bir alıcı 'PARTY_ASSIGNER' izniyle yeniden kaydedilmelidir.

Alıcı Rolü
partyRole string

Yer tutucu rolü atamak için bu alanı kullanın.

Ad Değişikliğine İzin Ver
allowNameChange string

Değer true veya false olabilir İmzalayanın imzalama işlemini tamamlamadan önce adı ve soyadını güncelleştirmesine izin vermek için bu parametreyi kullanın.

İş Akışı Dizisi
workflowSequence integer

Bu alıcıya bir iş akışı sıra numarası atayın. Oturum Açma Sırası etkinleştirildiğinde, alıcılar imzalama davetlerini artan sırada alır.

Konak E-posta Kimliği
hostEmailId string

In-Person Yöneticisinin e-posta adresi.

Erişim Kodu
userDefinedAccessCode string

Parametre, kimlik doğrulaması için "signerAuthLevel" değeri "Kullanıcı tanımlı Erişim Kodu" olarak ayarlandığında Erişim Kodu içerir. Not: 1. Kodlar büyük/küçük harfe duyarlı değildir. 2. Sistem bu kodu göndermez, bu nedenle bu kodu doğrudan imzalayanla paylaşmanız gerekir. 3. Erişim kodu alfabeleri, sayıları ve şu özel karakterleri içerebilir: @,&;{,},%,(,),~,|,!,+,^.

Grup E-posta Grubudur
partyIsEmailGroup boolean

Toplu olarak grup oluştururken bu parametreyi kullanın. Not: Bu parametre true ise, bu tarafın firstName, lastName ve emailId değeri yoksayılır.

E-posta Grubu Kimliği
emailGroupId integer

Toplu oluşturmak için kullanmak istediğiniz grup kimliğini e-postaya geçirin.

Tek İmzalayan Toplu
allowSingleSignerInBulk boolean

Yalnızca bir kişinin e-posta grubunda oturum açmasına izin vermek için bu parametreyi kullanın.

Arama Kodu
dialingCode string

Ülke arayarak bağlanma kodları, alıcı tarafları listesindeki bir alıcıya mobil numara ön ekleridir atamak için bu alanı kullanın.

Cep Telefonu Numarası
mobileNumber string

Alıcı tarafları listesindeki bir alıcıya cep telefonu numarası atamak için bu alanı kullanın.

Alanlar
Fields object
Şimdi Gönder
sendNow boolean

Etkinleştirildiğinde, Foxit eSign hemen her alıcının e-posta adresine benzersiz bir imzalama bağlantısı gönderir. Bunun yerine zarfı taslak olarak kaydetmek için bunu devre dışı bırakın.

Ekli İmzalama Oturumu Oluşturma
createEmbeddedSigningSession True boolean

İmzalama oturumu belirteci, alıcılara e-posta göndermeden oluşturulur.

Tüm Taraflar için Ekli İmzalama Oturumu Oluşturma
createEmbeddedSigningSessionForAllParties boolean

true olarak ayarlanırsa, zarftaki her alıcı için eklenmiş bir imzalama URL'si oluşturulur.

Metin Etiketlerini İşleme
processTextTags True boolean

Değer true veya false olabilir. Bu alan, Foxit eSign'ın Metin Etiketleri belgelerini Foxit eSign alanlarına dönüştürmek üzere ayrıştırıp ayrıştırmayacağını belirlemek için kullanılır.

İşlem Acro Alanları
processAcroFields True boolean

Bu alan, Foxit eSign'ın AcroFields belgelerini Foxit eSign alanlarına dönüştürmek üzere ayrıştırıp ayrıştırmayacağını belirlemek için kullanılır.

Oturum Açma Sırası
signInSequence boolean

Bu alan, alıcıların zarf belgelerini sırayla imzalayıp imzalamayacağını belirlemek için kullanılır. False ise, tüm alıcılar aynı anda davet e-postası alır. Doğru olduğunda, önceki alıcı gerekli görevi tamamladıktan sonra her alıcı, belgeleri imzalama veya alanları doldurma gibi sırayla davet e-postası alır.

Kişi Olarak Etkinleştir
inPersonEnable boolean

Bu alan, herhangi bir cihazda birkaç dakika içinde kolayca tamamlanabilen ve gerektiğinde e-posta tabanlı imzalardan kaçınan, kişi içi imzalama işlemini başlatmak için kullanılır. False ise, tüm alıcılar davet e-postasını aynı anda alır. Doğru olduğunda, bizzat yönetici imzalayan için imzalama işlemini başlatmak üzere bir davet e-postası alır.

Alıcı Taraflarını Düzelt
fixRecipientParties boolean

Doğruysa, eklenmiş gönderme görünümünde, bu isteğin bir parçası olarak zaten eklenmiş olan zarfın tarafları değiştirilemez.

Belgeleri Düzeltme
fixDocuments boolean

True ise, eklenmiş göndermede bu isteğin bir parçası olarak zaten eklenmiş olan zarfın belgeleri değiştirilemez.

Başarılı Url'si Gönder
sendSuccessUrl string

Katıştırılmış gönderme görünümünde klasörü başarıyla gönderdikten sonra imzalayanın yeniden yönlendirileceği giriş sayfasının mutlak URL'sini girin.

Hata Url'si Gönder
sendErrorUrl string

Katıştırılmış gönderme görünümünde klasörü gönderirken hata gelirse, imzalayanın yönlendirileceği giriş sayfasının mutlak URL'sini girin.

Ekli Gönderme Oturumu Oluşturma
createEmbeddedSendingSession boolean

true olarak ayarlanırsa, Foxit eSign görünümünü hazırlayan belgeyi açmak için eklenmiş bir belirteç oluşturur.

Ekli İmzalayanlar E-posta Kimlikleri
embeddedSignersEmailIds array of string

Ekli imzalama oturumu oluşturulması gereken alıcıların e-posta kimlikleri dizisi. Taraflar listesine eklenen alıcı tarafların e-posta kimlikleri.

İmza Başarılı Url'si
signSuccessUrl string

Ekli imzalama görünümünde başarıyla oturum açtıktan sonra yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Reddetme Url'sini İmzala
signDeclineUrl string

Ekli imzalama görünümünde oturum açmayı reddederse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Daha Sonra İmzala URL'si
signLaterUrl string

Ekli imzalama görünümünde daha sonra oturum açmayı seçerse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Hata Url'sini İmzala
signErrorUrl string

Belgeyi ekli imzalama görünümünde imzalama sırasında hata gelirse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Şimdi Gönder ve Ekli İmzalama oturumuna izin ver
allowSendNowAndEmbeddedSigningSession boolean

True olarak ayarlanırsa, Foxit eSign her alıcıya benzersiz imzalama bağlantısı gönderir. Bu YALNIZCA sendNow ve createEmbeddedSigningSession parametreleri true olduğunda geçerlidir.

Gelişmiş E-posta Doğrulaması
allowAdvancedEmailValidation boolean

True olarak ayarlandığında tarafların e-posta adresini doğrulayın.

İmza Başarılı Url'si Tüm Taraflar
signSuccessUrlAllParties boolean

True olarak ayarlanırsa, imzalayan, başarıyla imzalandıktan sonra signSuccessUrl içinde sağlanan URL'ye yönlendirilir. Bu yalnızca sendNow doğru olduğunda geçerlidir.

E-posta Şablonu Kimliği
emailTemplateId integer

Varsayılan e-posta şablonları dışındaki e-posta şablonlarını göndermek için e-posta şablonu kimliğini geçirin.

İmzalayan Yönerge Kimliği
signerInstructionId integer

Varsayılan imzalayan yönergeleri dışında imzalayan yönergeleri göndermek için yönerge kimliğini geçirin.

Onay YönergeSi Kimliği
confirmationInstructionId string

Varsayılan onay yönergeleri dışında onay yönergeleri göndermek için onay yönerge kimliğini geçirin.

Tema Rengi
themeColor string

Tema rengini ayarlamak için CSS değerini girin.

Oturumun Süresi Doldu
sessionExpire boolean

Katıştırılmış imzalama oturumunun süresinin dolmasına başlatmak için true olarak ayarlayın.

Süre sonu
expiry integer

sessionExpire true ise gereklidir. Katıştırılmış imzalama oturumunda süre sonunu milisaniye olarak girin.

Bağımlı Alan Adı
dependentFieldName True string

Görünürlüğü üst alan tarafından denetlenen alanın adı.

Üst Alan Adı
parentFieldName True string

Değeri bağımlı alanın görünürlüğünü denetleyen üst alanın adı. Desteklenen üst alan türleri: metin alanı, metin kutusu, onay kutusu, radyo düğmesi, açılan menü.

Üst Alan Değeri
parentFieldValue True string

Bağımlı alanın görünür olmasını tetikleyen üst alanın değeri. Onay kutusu ve radyo düğmesi alanları için işaretli veya işaretsiz seçeneğini kullanın.

Options
options True string

Metin tabanlı üst alanlar için ek eşleştirme seçenekleri. Kabul edilen değerler: isblank, allowNull, contains.

Meta veriler
metadata object

Bu anahtar değer çiftinde olmalıdır. En fazla 1000 anahtar değer çifti izin verilir.

Gönderen E-postası
senderEmail string

Hesabınızdaki başka bir kullanıcının e-postasını girin. Bu belge veya klasör alıcı taraflarına göndermek için kullanılacaktır.

Beni Ekle Düğmesini Gizle
hideAddMeButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Beni Ekle" düğmesini gizler.

Yeni Ekle Düğmesini Gizle
hideAddNewButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Yeni Ekle" düğmesini gizler.

Grup Ekle Düğmesini Gizle
hideAddGroupButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Grup Ekle" düğmesini gizler.

Alıcılar için Alan Adını Gizle
hideFieldNameForRecipients boolean

Veri Giriş Alanları ve Gelişmiş Alanlar için Alıcılar için alan adlarını gizleyin. (Radyo düğmesi, Onay Kutusu, Resim ve Köprü hariç).

Onay Kutusu Kenarlığını Gizle
hideCheckboxBorder boolean

Yürütülen belgelerde Onay Kutusunun kenarlıkları gizlenir.

İmzalayan Seçme Seçeneğini Gizle
hideSignerSelectOption boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarında "Mevcut İmzalayan Adı/E-postası" giriş kutusunu gizler.

İmzalayan Eylemlerini Gizle
hideSignerActions boolean

Doğruysa, ekli bir gönderme oturumunda Alıcı Taraflarında imzalayan "düzenle", "değiştir" ve "kaldır" eylemlerini gizler.

Gönderen Adını Gizle
hideSenderName boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarında gönderenin adını gizler.

Klasör Adını Gizle
hideFolderName boolean

True ise, her iki ekli oturumda da gezintideki klasör adını gizler.

Belge Adını Gizle
hideDocumentsName boolean

True ise, her iki katıştırılmış oturumda da belge adını gizler.

İmzalayacak Reddet'i gizle
hideDeclineToSign boolean

Doğruysa, imzalayan için "İmzayı Reddet" seçeneğini gizler.

Diğer Eylemi Gizle
hideMoreAction boolean

Doğruysa, gönderme/imzalama oturumunda "Diğer Eylemler" düğmesini gizler. "Şimdi Gönder": true durumunda hiçbir şey gizlenmeyecektir.

Gönder Düğmesini Gizle
hideSendButton boolean

Doğruysa, eklenmiş gönderme oturumunda Gönder düğmesini gizler.

Sonraki Gerekli Alanı Gizlebtn
hideNextRequiredFieldbtn boolean

true olarak ayarlanırsa, imzalayanları bir sonraki gerekli alana taşıyan gezinti düğmesini gizler.

Gerekli Her İki Katıştırılmış Oturum
requiredBothEmbeddedSession boolean

True ise, eklenmiş gönderme ve imzalama URL'lerini birlikte oluşturur.

Zarf Parolası
folderPassword string

Dijital olarak imzalanan belgeyi açmak için imzalayan/yazan kişi bu parolayı gerektirir. Parametre boş tutulursa, dijital olarak imzalanan belgeyi açmak için parola gerekmez.

Adım Adım Etkinleştir
enableStepByStep boolean

Eklenmiş gönderme oturumunda adım adım eylemi etkinleştirmek için.

Taraf Ekle Seçeneğini Gizle
hideAddPartiesOption boolean

Doğruysa, Taslak ve Şablon Oluşturma modunda taraf ekleme seçeneğini gizler.

Kendi Kendine İmzala
selfSign boolean

API'ler aracılığıyla tümleşik Self Sign'a olanak tanır. Bu parametre yalnızca createEmbeddedSendingSession parametresi true olduğunda geçerlidir.

Kendinden İmzalayan Başarı Url'si
selfSignerSuccessUrl string

Web sitenizdeki/uygulamanızdaki giriş sayfasının mutlak URL'sini girin. Bu url, ekli gönderme görünümünde klasörü başarıyla kendi kendine imzaladıktan sonra yeniden yönlendirilecektir.

Döndürülenler

Name Yol Tür Description
Kimlik
folder.folderId integer

Yeni oluşturulan zarfın benzersiz kimliği. Bu zarfa başvurmak için bunu sonraki eylemlerde kullanın.

İsim
folder.folderName string

Yeni oluşturulan zarfın adı.

Özel Ad
folder.folderCustomName string

Zarf için özel bir ad.

Şifre
folder.folderPassword string

Ayarlandıysa zarfın erişim parolası.

Oluşturucu Kimliği
folder.folderAuthorId integer

Zarf oluşturucusunun benzersiz tanımlayıcısı.

Oluşturucu Adı
folder.folderAuthorFirstName string

Zarfı oluşturanın adı.

Oluşturucu Soyadı
folder.folderAuthorLastName string

Zarfı oluşturanın soyadı.

Oluşturucu E-postası
folder.folderAuthorEmail string

Zarf oluşturucusunun e-posta adresi.

Oluşturucu Rolü
folder.folderAuthorRole string

Zarfı oluşturanın rolü.

Şirket Kimliği
folder.folderCompanyId integer

Zarfın sahibi olan şirketin benzersiz tanımlayıcısı.

Oluşturulma Tarihi
folder.folderCreationDate integer

Zarfın oluşturulduğu tarih (Milisaniye cinsinden Unix zaman damgası).

Gönderme Tarihi
folder.folderSentDate integer

Zarfın gönderildiği tarih (Milisaniye cinsinden Unix zaman damgası).

Status
folder.folderStatus string

Zarfın geçerli durumu.

Özel Alan 1
folder.custom_field1 string

Zarfın ilk özel meta veri alanı.

Özel Alan 2
folder.custom_field2 string

Zarfın ikinci özel meta veri alanı.

Meta veriler
folder.metadata string

Zarfla ilişkilendirilmiş özel meta veriler.

Belge Kimlikleri
folder.folderDocumentIds array of integer

Zarfta bulunan belge kimliklerinin listesi.

Documents
folder.documentsList array of object

Zarftaki belgelerin listesi.

Belge Kimliği
folder.documentsList.documentId integer

Belgenin benzersiz tanımlayıcısı.

Sözleşme Kimliği
folder.documentsList.contractId integer

Sözleşmenin benzersiz tanımlayıcısı.

Şirket Kimliği
folder.documentsList.companyId integer

Şirketin benzersiz tanımlayıcısı.

Oluşturan
folder.documentsList.contractCreatedBy integer

Sözleşmeyi oluşturan kişinin kullanıcı kimliği.

Oluşturulma Tarihi
folder.documentsList.contractCreatedOn string

Sözleşmenin oluşturulduğu tarih ve saat.

Sözleşme Türü
folder.documentsList.contractType string

Sözleşmenin türü.

Sözleşme Durumu
folder.documentsList.contractStatus string

Sözleşmenin geçerli durumu.

Düzenlenebilir
folder.documentsList.editable boolean

Öğenin düzenlenebilir olup olmadığını gösterir.

Sürüm Kimliği
folder.documentsList.contractVersionId integer

Sözleşme sürümünün benzersiz tanımlayıcısı.

Sürüm Adı
folder.documentsList.contractVersionName string

Sözleşme sürümünün adı.

Sürüm Açıklaması
folder.documentsList.contractVersionDesc string

Sözleşme sürümünün açıklaması.

Oluşturan Sürüm
folder.documentsList.versionCreatedby integer

Bu sürümü oluşturan kişinin kullanıcı kimliği.

Sürüm Oluşturma Tarihi
folder.documentsList.versionCreatedOn string

Bu sürümün oluşturulduğu tarih ve saat.

Sürüm Numarası
folder.documentsList.contractVersionNumber integer

Sözleşmenin sürüm numarası.

İşlem Kaynağı
folder.documentsList.contractTransactionSource string

Sözleşme işlemini başlatan kaynak sistem.

Alıcı
folder.folderRecipientParties array of object

Bu zarfın alıcı taraflarının listesi.

Alıcı Kimliği
folder.folderRecipientParties.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
folder.folderRecipientParties.partyDetails.partyId integer

Alıcının benzersiz tanımlayıcısı.

İlk İsim
folder.folderRecipientParties.partyDetails.firstName string

Alıcının adı.

Soyadı
folder.folderRecipientParties.partyDetails.lastName string

Alıcının soyadı.

E-Posta Adresi
folder.folderRecipientParties.partyDetails.emailId string

Alıcının e-posta adresi.

Yer tutucu
folder.folderRecipientParties.partyDetails.placeholder boolean

Bu tarafın yer tutucu alıcı olup olmadığını gösterir.

Adres
folder.folderRecipientParties.partyDetails.address string

Alıcının fiziksel adresi.

Oluşturulma Tarihi
folder.folderRecipientParties.partyDetails.dateCreated integer

Kaydın oluşturulduğu tarih (milisaniye cinsinden Unix zaman damgası).

E-postaları Geri Çevir
folder.folderRecipientParties.partyDetails.optOutEmails boolean

Alıcının e-posta bildirimlerini geri çevirip geri çevirmediğini gösterir.

Benzersiz Alıcı Kimliği
folder.folderRecipientParties.partyDetails.uniquePartyId string

Bu alıcı için benzersiz bir sistem tanımlayıcısı.

Kimlik Doğrulama Düzeyi
folder.folderRecipientParties.partyDetails.authenticationLevel string

Bu alıcı için gereken kimlik doğrulama yöntemi.

Parola Güncelleştirme Tarihi
folder.folderRecipientParties.partyDetails.passwordUpdateDate string

Parolanın son güncelleştirilildiği tarih.

Parola Güncelleştirildi Durumu
folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

Parolanın güncelleştirilip güncelleştirilmediğini gösterir.

Şirket Kimliği
folder.folderRecipientParties.partyDetails.companyId integer

Şirketin benzersiz tanımlayıcısı.

Kullanıcı Rolü
folder.folderRecipientParties.partyDetails.userRole string

Kullanıcıya atanan rol.

Bölüm
folder.folderRecipientParties.partyDetails.department string

Kullanıcının ait olduğu bölüm.

Başlık
folder.folderRecipientParties.partyDetails.title string

Kullanıcının iş unvanı.

Aktif
folder.folderRecipientParties.partyDetails.active boolean

Kullanıcının veya kaydın etkin olup olmadığını gösterir.

Locale
folder.folderRecipientParties.partyDetails.requestLocale string

Kullanıcının yerel ayarı.

Bölüm ile paylaş
folder.folderRecipientParties.partyDetails.share_among_department boolean

Zarfların departman genelinde paylaşılıp paylaşılmadığını gösterir.

Arama Kodu
folder.folderRecipientParties.partyDetails.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.folderRecipientParties.partyDetails.mobileNumber string

Cep telefonu numarası.

Durum Filtresi
folder.folderRecipientParties.partyDetails.docStatusFilter string

Belge durumu filtresi.

Tarih Filtresi
folder.folderRecipientParties.partyDetails.docDateFilter string

Belge tarihi filtresi.

Güvenli Alan Erişimi
folder.folderRecipientParties.partyDetails.userSecureFieldAccess boolean

Kullanıcının güvenli alanlara erişimi olup olmadığını gösterir.

Kenar Çubuğunu Genişlet
folder.folderRecipientParties.partyDetails.expandSidebar boolean

Kenar çubuğunun varsayılan olarak genişletilmiş olup olmadığını gösterir.

E-posta Doğrulama
folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation boolean

Gelişmiş e-posta doğrulamasının etkinleştirilip etkinleştirilmediğini gösterir.

Yönetici Kimliği
folder.folderRecipientParties.partyDetails.managerId string

Kullanıcının yöneticisinin benzersiz tanımlayıcısı.

Oturum Açma Sayısı
folder.folderRecipientParties.partyDetails.loginCount integer

Kullanıcının oturum açma sayısı.

Parola Sıfırlama E-postası
folder.folderRecipientParties.partyDetails.sendMailForPasswordReset boolean

Parola sıfırlama e-postası gönderilmesi gerekip gerekmediğini gösterir.

Departman Kimliği
folder.folderRecipientParties.partyDetails.departmentId string

Bölümün benzersiz tanımlayıcısı.

Birincil Şirket
folder.folderRecipientParties.partyDetails.userPrimaryCompany integer

Kullanıcıyla ilişkili birincil şirket.

Cihaz Türü
folder.folderRecipientParties.partyDetails.deviceType string

Kullanılan cihaz türü.

Cihaz Belirteci
folder.folderRecipientParties.partyDetails.deviceToken string

Cihaz için anında iletme bildirimi belirteci.

Taşeron Açıklaması
folder.folderRecipientParties.partyDetails.subcontractorDescription string

Alt yüklenicinin veya dış imzalayanın açıklaması.

Alt Yüklenici Kuruluşu
folder.folderRecipientParties.partyDetails.subcontractorOrganization string

Alt yüklenicinin veya dış imzalayanın kuruluş adı.

Taşeron Ekleme Tarihi
folder.folderRecipientParties.partyDetails.subcAddedDate integer

Alt yüklenicinin eklendiği tarih (milisaniye cinsinden Unix zaman damgası).

Source
folder.folderRecipientParties.partyDetails.source string

Dış imzalayanın eklendiği kaynak sistem.

Arama Kodu
folder.folderRecipientParties.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.folderRecipientParties.mobileNumber string

Cep telefonu numarası.

İmza Türü
folder.folderRecipientParties.signerSignatureType string

İmzalayanın kullanacağı imza türü.

İzinler
folder.folderRecipientParties.contractPermissions string

Sözleşme için bu tarafa verilen izinler.

İmzalama Sırası
folder.folderRecipientParties.partySequence integer

Bu alıcı için imzalama siparişi sıra numarası.

İş Akışı Dizisi
folder.folderRecipientParties.workflowSignSequence integer

İş akışı imzalama sırası numarası.

Zarf Kimliği
folder.folderRecipientParties.envelopeId integer

Zarfın benzersiz tanımlayıcısı.

Alıcı Şirket Kimliği
folder.folderRecipientParties.partyCompanyId integer

Bu alıcıyla ilişkili şirketin benzersiz tanımlayıcısı.

Paylaşım Modu
folder.folderRecipientParties.sharingMode string

Bu zarfın paylaşım modu.

Alıcı Erişim URL'si
folder.folderRecipientParties.folderAccessURL string

Alıcının zarfa erişmek ve zarfı imzalamak için kullanabileceği URL.

Güvenlik Modu
folder.folderRecipientParties.securityMode string

Bu zarfa uygulanan güvenlik modu.

Açıklamalar
folder.folderRecipientParties.extraComments string

Zarfa eklenen ek açıklamalar.

Ad Değişikliğine İzin Ver
folder.folderRecipientParties.allowNameChange boolean

Alıcının adını güncelleştirmesine izin verilip verilmeyeceğini gösterir.

Ad Güncelleştirildi
folder.folderRecipientParties.signerNameUpdated boolean

İmzalayanın adını güncelleştirip güncelleştirmediğini gösterir.

İmzalayan Kimlik Doğrulama Düzeyi
folder.folderRecipientParties.signerAuthenticationLevel string

İmzalayan için gereken kimlik doğrulama düzeyi.

Erişim Kodu
folder.folderRecipientParties.userDefinedAccessCode string

İmzalayan için tanımlanan özel erişim kodu.

İmza Kimliği
folder.folderRecipientParties.signatureId string

İmzanın benzersiz tanımlayıcısı.

Alıcı Rolü
folder.folderRecipientParties.partyRole string

İmzalama iş akışında bu alıcıya atanan rol.

Şirket Alanı
folder.folderRecipientParties.companyFieldValue string

İmzadaki şirket adı alanının değeri.

Başlık Alanı
folder.folderRecipientParties.titleFieldValue string

İmzadaki başlık alanının değeri.

İmzalama Nedeni
folder.folderRecipientParties.reasonSigning string

Alıcının belgeyi imzalama nedeni.

Ödeme Alanı Eklendi
folder.folderRecipientParties.payFieldAdded boolean

Ödeme alanının eklenip eklenmediğini gösterir.

Alacaklı
folder.folderRecipientParties.payee boolean

Bu alıcının alacaklı olup olmadığını gösterir.

Yinelenen Ödeme
folder.folderRecipientParties.recurringFieldExist boolean

Yinelenen ödeme alanının mevcut olup olmadığını gösterir.

Yazdırma ve İmza Bitti
folder.folderRecipientParties.printAndSignCompleted boolean

Yazdırma ve imzalama işleminin tamamlanıp tamamlanmadığını gösterir.

Paid
folder.folderRecipientParties.paid boolean

Ödemenin tamamlanıp tamamlanmadığını gösterir.

İsteğe Bağlı İmzalayana İzin Verildi
folder.folderRecipientParties.allowOptionalSigner boolean

Bu alıcının isteğe bağlı bir imzalayan olup olmadığını gösterir.

İsteğe Bağlı İmzalayanlar
folder.folderRecipientParties.optionalSigners array of integer

Bu zarf için isteğe bağlı imzalayan taraf kimliklerinin listesi.

Yazar İmzalama URL'si
folder.folderAccessURLForAuthor string

Gönderenin zarfa erişmek için kullanabileceği URL.

Taslak Erişim URL'si
folder.draftFolderAccessURL string

Zarfın taslak sürümüne erişmek için kullanılan URL.

Yönetim Kurulu İmzalama
folder.boardRoomSign boolean

Pano odası imzalama modunun etkinleştirilip etkinleştirilmediğini gösterir.

Logo Ekle
folder.includeLogo boolean

Şirket logosunun e-postalara eklenip eklenmediğini gösterir.

Düğme Arka Plan Rengi
folder.email_btnBgColor string

E-posta düğmesinin arka plan rengi.

Düğme Metin Rengi
folder.email_btnTxtColor string

E-posta düğmesinin metin rengi.

E-posta Logosu
folder.emailTemplateLogo string

E-posta şablonunda kullanılan logo URL'si.

E-posta Şablonu Kimliği
folder.emailTemplateId integer

E-posta şablonunun benzersiz tanımlayıcısı.

E-posta Üst Bilgisi
folder.emailHeader string

Bildirim e-postalarında kullanılan üst bilgi metni.

E-posta Alt Bilgisi
folder.emailFooter string

Bildirim e-postalarında kullanılan alt bilgi metni.

Zamanlanmış Temizleme
folder.purgeFlag boolean

Zarfın temizleme için zamanlanıp zamanlanmadığını gösterir.

Başlangıç Tarihini Temizle
folder.purgeStartDate string

Temizleme işleminin başlamak üzere zamanlandığı tarih.

Bitiş Tarihini Temizle
folder.purgeEndDate string

Temizleme işleminin tamamlanmak üzere zamanlandığı tarih.

Toplu Gönderme Kimliği
folder.bulkId integer

Toplu gönderme işleminin benzersiz tanımlayıcısı.

İmza Sırasını Zorla
folder.enforceSignWorkflow boolean

Alıcıların tanımlı sırada oturum açması gerekip gerekmediğini gösterir.

Geçerli Adım
folder.currentWorkflowStep integer

İmzalama iş akışındaki geçerli adım.

İşlem Kaynağı
folder.transactionSource string

Bu işlemi başlatan kaynak sistem.

Düzenlenebilir
folder.editable boolean

Öğenin düzenlenebilir olup olmadığını gösterir.

In-Person İmzalama
folder.inPersonSignable boolean

Zarfın bizzat imzalanıp imzalanamayacağını gösterir.

Anımsatıcıları Geçersiz Kıl
folder.overrideAccountReminders boolean

Hesap düzeyi anımsatıcı ayarlarının geçersiz kılınıp kılınmadığını gösterir.

TemsilciYi Geçersiz Kıl
folder.overrideAccountRecipientDelegation boolean

Hesap düzeyinde temsilci seçme ayarlarının geçersiz kılınıp kılınmadığını gösterir.

Temsilci Seçmeye İzin Ver
folder.allowRecipientsToDelegate boolean

Alıcıların imzalamayı temsilci olarak atamasına izin verilip verilmeyeceğini gösterir.

Kimlik
folder.envelopeId integer

Zarfın benzersiz tanımlayıcısı.

İsim
folder.envelopeName string

Zarfın adı.

Kaynak Kimliği
folder.envelopeOriginatorId integer

Zarfı oluşturan kullanıcının benzersiz tanımlayıcısı.

Şirket Kimliği
folder.envelopeCompanyId integer

Zarfın sahibi olan şirketin benzersiz tanımlayıcısı.

Date
folder.envelopeDate integer

Zarfın oluşturulduğu tarih (Milisaniye cinsinden Unix zaman damgası).

Paylaşılan Tarih
folder.envelopeSharedDate integer

Zarfın paylaşıldığı tarih (milisaniye cinsinden Unix zaman damgası).

Status
folder.envelopeStatus string

Zarfın geçerli durumu.

Sözleşme kimlikleri
folder.envelopeContractIds array of integer

Bu zarfla ilişkili sözleşme kimliklerinin listesi.

Alıcı İzinleri
folder.envelopePartyPermissions array of object

Bu zarf için alıcı izinlerinin listesi.

Alıcı Kimliği
folder.envelopePartyPermissions.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
folder.envelopePartyPermissions.partyDetails.partyId integer

Alıcının benzersiz tanımlayıcısı.

İlk İsim
folder.envelopePartyPermissions.partyDetails.firstName string

Alıcının adı.

Soyadı
folder.envelopePartyPermissions.partyDetails.lastName string

Alıcının soyadı.

E-Posta Adresi
folder.envelopePartyPermissions.partyDetails.emailId string

Alıcının e-posta adresi.

Yer tutucu
folder.envelopePartyPermissions.partyDetails.placeholder boolean

Bu tarafın yer tutucu alıcı olup olmadığını gösterir.

Adres
folder.envelopePartyPermissions.partyDetails.address string

Alıcının fiziksel adresi.

Oluşturulma Tarihi
folder.envelopePartyPermissions.partyDetails.dateCreated integer

Kaydın oluşturulduğu tarih (milisaniye cinsinden Unix zaman damgası).

E-postaları Geri Çevir
folder.envelopePartyPermissions.partyDetails.optOutEmails boolean

Alıcının e-posta bildirimlerini geri çevirip geri çevirmediğini gösterir.

Benzersiz Alıcı Kimliği
folder.envelopePartyPermissions.partyDetails.uniquePartyId string

Bu alıcı için benzersiz bir sistem tanımlayıcısı.

Kimlik Doğrulama Düzeyi
folder.envelopePartyPermissions.partyDetails.authenticationLevel string

Bu alıcı için gereken kimlik doğrulama yöntemi.

Parola Güncelleştirme Tarihi
folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string

Parolanın son güncelleştirilildiği tarih.

Parola Güncelleştirildi Durumu
folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean

Parolanın güncelleştirilip güncelleştirilmediğini gösterir.

Şirket Kimliği
folder.envelopePartyPermissions.partyDetails.companyId integer

Şirketin benzersiz tanımlayıcısı.

Kullanıcı Rolü
folder.envelopePartyPermissions.partyDetails.userRole string

Kullanıcıya atanan rol.

Bölüm
folder.envelopePartyPermissions.partyDetails.department string

Kullanıcının ait olduğu bölüm.

Başlık
folder.envelopePartyPermissions.partyDetails.title string

Kullanıcının iş unvanı.

Aktif
folder.envelopePartyPermissions.partyDetails.active boolean

Kullanıcının veya kaydın etkin olup olmadığını gösterir.

Locale
folder.envelopePartyPermissions.partyDetails.requestLocale string

Kullanıcının yerel ayarı.

Bölüm ile paylaş
folder.envelopePartyPermissions.partyDetails.share_among_department boolean

Zarfların departman genelinde paylaşılıp paylaşılmadığını gösterir.

Arama Kodu
folder.envelopePartyPermissions.partyDetails.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.envelopePartyPermissions.partyDetails.mobileNumber string

Cep telefonu numarası.

Durum Filtresi
folder.envelopePartyPermissions.partyDetails.docStatusFilter string

Belge durumu filtresi.

Tarih Filtresi
folder.envelopePartyPermissions.partyDetails.docDateFilter string

Belge tarihi filtresi.

Güvenli Alan Erişimi
folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess boolean

Kullanıcının güvenli alanlara erişimi olup olmadığını gösterir.

Kenar Çubuğunu Genişlet
folder.envelopePartyPermissions.partyDetails.expandSidebar boolean

Kenar çubuğunun varsayılan olarak genişletilmiş olup olmadığını gösterir.

E-posta Doğrulama
folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation boolean

Gelişmiş e-posta doğrulamasının etkinleştirilip etkinleştirilmediğini gösterir.

Yönetici Kimliği
folder.envelopePartyPermissions.partyDetails.managerId string

Kullanıcının yöneticisinin benzersiz tanımlayıcısı.

Oturum Açma Sayısı
folder.envelopePartyPermissions.partyDetails.loginCount integer

Kullanıcının oturum açma sayısı.

Parola Sıfırlama E-postası
folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset boolean

Parola sıfırlama e-postası gönderilmesi gerekip gerekmediğini gösterir.

Departman Kimliği
folder.envelopePartyPermissions.partyDetails.departmentId string

Bölümün benzersiz tanımlayıcısı.

Birincil Şirket
folder.envelopePartyPermissions.partyDetails.userPrimaryCompany integer

Kullanıcıyla ilişkili birincil şirket.

Cihaz Türü
folder.envelopePartyPermissions.partyDetails.deviceType string

Kullanılan cihaz türü.

Cihaz Belirteci
folder.envelopePartyPermissions.partyDetails.deviceToken string

Cihaz için anında iletme bildirimi belirteci.

Taşeron Açıklaması
folder.envelopePartyPermissions.partyDetails.subcontractorDescription string

Alt yüklenicinin veya dış imzalayanın açıklaması.

Alt Yüklenici Kuruluşu
folder.envelopePartyPermissions.partyDetails.subcontractorOrganization string

Alt yüklenicinin veya dış imzalayanın kuruluş adı.

Taşeron Ekleme Tarihi
folder.envelopePartyPermissions.partyDetails.subcAddedDate integer

Alt yüklenicinin eklendiği tarih (milisaniye cinsinden Unix zaman damgası).

Source
folder.envelopePartyPermissions.partyDetails.source string

Dış imzalayanın eklendiği kaynak sistem.

Arama Kodu
folder.envelopePartyPermissions.dialingCode string

Telefon numarasının uluslararası arama kodu.

Cep Telefonu Numarası
folder.envelopePartyPermissions.mobileNumber string

Cep telefonu numarası.

İmza Türü
folder.envelopePartyPermissions.signerSignatureType string

İmzalayanın kullanacağı imza türü.

İzinler
folder.envelopePartyPermissions.contractPermissions string

Sözleşme için bu tarafa verilen izinler.

İmzalama Sırası
folder.envelopePartyPermissions.partySequence integer

Bu alıcı için imzalama siparişi sıra numarası.

İş Akışı Dizisi
folder.envelopePartyPermissions.workflowSignSequence integer

İş akışı imzalama sırası numarası.

Zarf Kimliği
folder.envelopePartyPermissions.envelopeId integer

Zarfın benzersiz tanımlayıcısı.

Alıcı Şirket Kimliği
folder.envelopePartyPermissions.partyCompanyId integer

Bu alıcıyla ilişkili şirketin benzersiz tanımlayıcısı.

Paylaşım Modu
folder.envelopePartyPermissions.sharingMode string

Bu zarfın paylaşım modu.

Alıcı Erişim URL'si
folder.envelopePartyPermissions.folderAccessURL string

Alıcının zarfa erişmek ve zarfı imzalamak için kullanabileceği URL.

Güvenlik Modu
folder.envelopePartyPermissions.securityMode string

Bu zarfa uygulanan güvenlik modu.

Açıklamalar
folder.envelopePartyPermissions.extraComments string

Zarfa eklenen ek açıklamalar.

Ad Değişikliğine İzin Ver
folder.envelopePartyPermissions.allowNameChange boolean

Alıcının adını güncelleştirmesine izin verilip verilmeyeceğini gösterir.

Ad Güncelleştirildi
folder.envelopePartyPermissions.signerNameUpdated boolean

İmzalayanın adını güncelleştirip güncelleştirmediğini gösterir.

İmzalayan Kimlik Doğrulama Düzeyi
folder.envelopePartyPermissions.signerAuthenticationLevel string

İmzalayan için gereken kimlik doğrulama düzeyi.

Erişim Kodu
folder.envelopePartyPermissions.userDefinedAccessCode string

İmzalayan için tanımlanan özel erişim kodu.

İmza Kimliği
folder.envelopePartyPermissions.signatureId string

İmzanın benzersiz tanımlayıcısı.

Alıcı Rolü
folder.envelopePartyPermissions.partyRole string

İmzalama iş akışında bu alıcıya atanan rol.

Şirket Alanı
folder.envelopePartyPermissions.companyFieldValue string

İmzadaki şirket adı alanının değeri.

Başlık Alanı
folder.envelopePartyPermissions.titleFieldValue string

İmzadaki başlık alanının değeri.

İmzalama Nedeni
folder.envelopePartyPermissions.reasonSigning string

Alıcının belgeyi imzalama nedeni.

Ödeme Alanı Eklendi
folder.envelopePartyPermissions.payFieldAdded boolean

Ödeme alanının eklenip eklenmediğini gösterir.

Alacaklı
folder.envelopePartyPermissions.payee boolean

Bu alıcının alacaklı olup olmadığını gösterir.

Yinelenen Ödeme
folder.envelopePartyPermissions.recurringFieldExist boolean

Yinelenen ödeme alanının mevcut olup olmadığını gösterir.

Yazdırma ve İmza Bitti
folder.envelopePartyPermissions.printAndSignCompleted boolean

Yazdırma ve imzalama işleminin tamamlanıp tamamlanmadığını gösterir.

Paid
folder.envelopePartyPermissions.paid boolean

Ödemenin tamamlanıp tamamlanmadığını gösterir.

Kimlik Doğrulama Düzeyi
folder.envelopeAuthenticationLevel string

Zarf için gereken kimlik doğrulama düzeyi.

Tek İmzalayan Toplu
folder.allowSingleSignerInBulk boolean

Toplu gönderme modunda tek bir imzalayana izin verilip verilmeyeceğini gösterir.

File-Based Adlandırma
folder.folderNameBasedOnFileNaming boolean

Klasör adının dosya adını temel alıp almayacağını gösterir.

Belge File-Based Adı
folder.documentNameBasedOnFileNaming boolean

Belge adının dosya adını temel alıp almayacağını gösterir.

Sertifika File-Based Adı
folder.certificateNameBasedOnFileNaming boolean

Sertifika adının dosya adını temel alıp almayacağını gösterir.

Exec Öncesi Dosya Adlandırma
folder.enableFileNamingBeforeExecution boolean

Belge yürütmeden önce dosya adlandırmanın etkinleştirilip etkinleştirilmediğini gösterir.

Payee Eklendi
folder.payeeAddedd boolean

Bir ödemenin eklenip eklenmediğini gösterir.

Self-Signing Etkin
folder.selfSignerEnabled boolean

Otomatik imzalama modunun etkinleştirilip etkinleştirilmediğini gösterir.

Noter Etkin
folder.notaryEnabled boolean

Noter imzalamanın etkinleştirilip etkinleştirilmediğini gösterir.

Sınırlı Görünürlük
folder.limitedVisibilityFlag boolean

Bu zarf için sınırlı görünürlüğün etkinleştirilip etkinleştirilmediğini gösterir.

İmza Sonrası Görünürlük
folder.postSigningVisibility boolean

İmzalama sonrası görünürlüğün etkinleştirilip etkinleştirilmediğini gösterir.

Islak İmza
folder.wetSignatureEnabled boolean

Islak imzaların etkinleştirilip etkinleştirilmediğini gösterir.

Birleştirme Etkin
folder.mergeEnabled boolean

Belge birleştirmenin etkinleştirilip etkinleştirilmediğini gösterir.

Ekli İmzalama Oturumları
embeddedSigningSessions array of object

Alıcı başına bir tane olan ekli imzalama oturumlarının listesi. Yalnızca createEmbeddedSigningSession true olduğunda bulunur.

İmzalayan E-postası
embeddedSigningSessions.emailIdOfSigner string

Bu ekli imzalama oturumu için alıcının e-posta adresi.

İmzalama Belirteci
embeddedSigningSessions.embeddedToken string

Bu alıcının ekli imzalama oturumu için benzersiz belirteç.

İmzalama Oturumu URL'si
embeddedSigningSessions.embeddedSessionURL string

Bu alıcının belgeyi imzalaması için aç veya ekle URL'si.

Ekli Gönderme Belirteci
embeddedToken string

Eklenmiş gönderme oturumu için belirteç. Yalnızca createEmbeddedSendingSession true olduğunda bulunur.

Oturum URL'si Gönderiliyor
embeddedSessionURL string

Zarf yazarının zarfı hazırlaması ve göndermesi için açılacak veya eklenmek üzere URL. Yalnızca createEmbeddedSendingSession true olduğunda bulunur.

Result
result string

İşlemin sonucu.

Message
message string

İşlemin sonucunu açıklayan bir ileti.

URL'den Şablon Oluştur

Genel olarak erişilebilen bir PDF URL'si kullanarak yeni bir şablon oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Şablon Adı
templateName True string

Şablonun adı. .pdf uzantısıyla bitmelidir (örneğin, onboarding.pdf).

Şablon URL'si
templateUrl True string

Şablon olarak kullanılacak PDF belgesinin genel olarak erişilebilen URL'si.

Giriş Türü
inputType True string

Belgenin giriş yöntemi. Bu eylem için her zaman 'url' olarak ayarlayın.

Metin Etiketlerini İşleme
processTextTags True boolean

Etkinleştirildiğinde, Foxit eSign belgeyi Metin Etiketleri için tarar ve otomatik olarak imza alanlarına dönüştürür.

İşlem Acro Alanları
processAcroFields True boolean

Foxit eSign etkinleştirildiğinde belgeyi AcroFields için tarar ve otomatik olarak imza alanlarına dönüştürür.

Tümünü Paylaş
shareAll True boolean

Bu şablonu hesabınızdaki tüm kullanıcılarla paylaşın.

Taraf Sayısı
numberOfParties True integer

Şablona parti sayısı ekleyin. Bu parametrenin değerleri 20'den küçük olmalıdır.

Tema Rengi
themeColor string

createEmbeddedTemplateSession temasını değiştirmek için bir renk için css değeri girin.

E-posta Yaz
authorEmail string

Bu şablonun yazarı olarak kullanılacak bir hesaba başka bir kullanıcının e-postasını girin.

Ekli Şablon Oluşturma Oturumu
createEmbeddedTemplateSession boolean

True olarak ayarlanırsa, foxit eSign şablonu hazırlama görünümünü doğrudan açmak için eklenmiş bir şablon oturumu. Şablondaki çeşitli alanları sürükleyip bırakma kullanılabilir.

Yeniden Yönlendirme Url'si
redirectURL string

createEmbeddedTemplateSession true ise, herhangi bir web sitesindeki/uygulamadaki giriş sayfası için mutlak URL girilebilir. Bu url, ekli şablon görünümünde "kaydet ve kapat" seçeneğine tıkladıktan sonra kullanıcı bu sayfaya yönlendirilir.

Gönderme Şablonunu Gizle
hideSendTemplate boolean

Doğruysa, ekli şablon görünümünde Gönder düğmesini gizler.

Alıcı Taraflarını Düzelt
fixRecipientParties boolean

Doğruysa, eklenmiş şablon görünümünde zaten eklenmiş olan zarfın taraflarını değiştiremezsiniz.

Alanlar
Fields object
permissions
permission True string
Sequence
sequence True integer

Bu taraf için 1'den başlayarak benzersiz bir sıra numarası. Oturum Açma Sırası etkinleştirildiğinde imzalama sırasını tanımlar.

Alıcı Rolü
partyRole True string

Şablonda bu tarafa atanan rol.

Diğer Eylemi Gizle
hideMoreAction boolean

Doğruysa, şablon oturumunda "Diğer Eylemler" düğmesini gizler.

Herkesle Paylaş'ın gizlenir
hideShareWithAll boolean

Doğruysa, şablon oturumunda "Tümüyle Paylaş" seçeneğini gizler.

Grup Ekle'yi gizle
hideAddParty boolean

True ise, eklenmiş bir şablon oturumunda tüm ekleme partisi seçeneklerini gizler.

Beni Gizle Düğmesi
hideMeButton boolean

Doğruysa, eklenmiş bir şablon oturumunda Alıcı Taraflarındaki "Ben" düğmesini gizler.

Diğerlerini Gizle Düğmesi
hideOthersButton boolean

Doğruysa, katıştırılmış bir şablon oturumunda Alıcı Tarafları'ndaki "Diğerleri" düğmesini gizler.

Mevcut Kişiyi Gizle Seç Seçeneği
hideExistingContactSelectOption boolean

Doğruysa, katıştırılmış şablon oturumunda Alıcı Taraflarında "Mevcut Kişiyi Bul ve Ekle" giriş kutusunu gizler.

Alıcılar için Alan Adını Gizle
hideFieldNameForRecipients boolean

Veri Giriş Alanları ve Gelişmiş Alanlar için Alıcılar için alan adlarını gizleyin. (Radyo düğmesi, Onay Kutusu, Resim ve Köprü hariç).

Onay Kutusu Kenarlığını Gizle
hideCheckboxBorder boolean

Yürütülen belgelerde Onay Kutusunun kenarlıkları gizlenir.

Döndürülenler

Name Yol Tür Description
Result
result string

İşlemin başarılı olup olmadığını gösterir (örneğin, 'başarı').

Message
message string

İşlem sonucunun açıklaması.

Kimlik
template.templateId integer

Oluşturulan şablonun benzersiz kimliği. Bu şablondan zarf oluşturmak için bunu kullanın.

İsim
template.templateName string

Şablonun adı.

Description
template.templateDesc string

Şablonun açıklaması.

Türü
template.templateType string

Şablonun türü.

Oluşturma Tarihi
template.templateCreationDate string

Şablonun oluşturulduğu tarih.

Son Güncelleştirme Tarihi
template.templateLastUpdateDate string

Şablonun son güncelleştirilildiği tarih.

Düzenlenebilir
template.editable boolean

Şablonun düzenlenip düzenlenemeyeceğini gösterir.

Taraf Sayısı
template.numberOfParties integer

Şablonda tanımlanan alıcı taraflarının sayısı.

Toplam Sayfa Sayısı
template.totalPages integer

Şablon belgesindeki toplam sayfa sayısı.

Şirket Kimliği
template.companyId integer

Bu şablonun ait olduğu şirketin kimliği.

Tümüyle Paylaşılan
template.shareAll boolean

Bu şablonun hesaptaki tüm kullanıcılarla paylaşılıp paylaşılmadığını gösterir.

Özel Ad Deseni
template.templateCustomName string

Bu şablondan oluşturulan zarflara uygulanan özel ad deseni.

Grup İzinleri
template.templatePartyPermissions array of object

Bu şablonda tanımlanan alıcı rollerinin ve izinlerinin listesi.

Taraf kimliği
template.templatePartyPermissions.template_party_id integer

Bu şablon taraf girişinin benzersiz kimliği.

Kimlik
template.templatePartyPermissions.templateId integer

Bu tarafın ait olduğu şablonun kimliği.

İzinler
template.templatePartyPermissions.templatePermissions string

Bu taraf için imzalama izinleri (örneğin, FILL_FIELDS_AND_SIGN).

İmzalama Sırası
template.templatePartyPermissions.partySequence integer

Bu parti için imza siparişi konumu.

Grup Rolü
template.templatePartyPermissions.templatePartyRole string

Şablonda bu tarafa atanan rol adı. Şablondan zarf oluştururken bunu kullanın.

Taraf kimliği
template.templatePartyPermissions.partyId integer

Önceden atanmışsa, bu role atanan tarafın kimliği.

Kullanıcı kimliği
template.templateCreatedBy.partyId integer

Kullanıcının benzersiz kimliği.

İlk İsim
template.templateCreatedBy.firstName string

Kullanıcının adı.

Soyadı
template.templateCreatedBy.lastName string

Kullanıcının soyadı.

E-posta
template.templateCreatedBy.emailId string

Kullanıcının e-posta adresi.

Şirket Kimliği
template.templateCreatedBy.companyId integer

Kullanıcının ait olduğu şirketin kimliği.

Kullanıcı Rolü
template.templateCreatedBy.userRole string

Kullanıcının kuruluştaki rolü.

Aktif
template.templateCreatedBy.active boolean

Kullanıcının hesabının etkin olup olmadığını gösterir.

Kullanıcı kimliği
template.templateLastUpdatedBy.partyId integer

Kullanıcının benzersiz kimliği.

İlk İsim
template.templateLastUpdatedBy.firstName string

Kullanıcının adı.

Soyadı
template.templateLastUpdatedBy.lastName string

Kullanıcının soyadı.

E-posta
template.templateLastUpdatedBy.emailId string

Kullanıcının e-posta adresi.

Şirket Kimliği
template.templateLastUpdatedBy.companyId integer

Kullanıcının ait olduğu şirketin kimliği.

Kullanıcı Rolü
template.templateLastUpdatedBy.userRole string

Kullanıcının kuruluştaki rolü.

Aktif
template.templateLastUpdatedBy.active boolean

Kullanıcının hesabının etkin olup olmadığını gösterir.

Şablon Alanları
allfields array of object

Şablonda tanımlanan tüm imza ve form alanlarının listesi.

Alan Kimliği
allfields.fieldTagId integer

Alanın benzersiz tanımlayıcısı.

Şablon Kimliği
allfields.templateId integer

Bu alanın ait olduğu şablonun kimliği.

Şirket Kimliği
allfields.companyId integer

Bu alanın ait olduğu şirket hesabı.

Alan Türü
allfields.fieldType string

Alanın türü (örneğin, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).

Sayfa Numarası
allfields.documentPageNumber integer

Bu alanın yerleştirildiği belgenin sayfa numarası.

Sorumlu Taraf
allfields.partyResponsible integer

Bu alanı doldurmaktan sorumlu olan taraf dizisi numarası.

Parti Dizisi
allfields.partyResponsibleSequence integer

Sorumlu tarafın sıra konumu.

Alan Belge Kimliği
allfields.docFieldId string

Bu alanın belge düzeyi tanımlayıcısı.

Bağımlıdır
allfields.dependent boolean

Bu alanın görünürlüğünün başka bir alanın değerine bağlı olup olmadığını gösterir.

Sekme Sırası
allfields.tabOrder integer

Alanlar arasında gezinmek için sekme sırası.

Zorunlu
allfields.required boolean

Belgenin imzalanması için bu alanın doldurulması gerekip gerekmediğini gösterir.

Özel Alan Adı
allfields.customFieldName string

Bu alana atanan özel ad.

Tümünü Paylaş
allfields.shareAll boolean

Bu alanın tüm kullanıcılarla paylaşılıp paylaşılmadığını gösterir.

Düzenlemeye İzin Ver
allfields.allowEdit boolean

Bu alanın alıcı tarafından düzenlenip düzenlenemeyeceğini gösterir.

Metin Alanı Adı
allfields.textfieldName string

Metin alanının etiketi (fieldType 'textfield' olduğunda geçerlidir).

Değer
allfields.value string

Alanın önceden doldurulmuş veya girilmiş değeri.

Yazı Tipi Boyutu
allfields.fontSize integer

Bu alandaki metin için kullanılan yazı tipi boyutu.

Yazı Tipi Rengi
allfields.fontColor string

Bu alandaki metin için kullanılan yazı tipi rengi (örneğin, #000000).

Yalnızca Okunur
allfields.readOnly boolean

Alanın salt okunur olup olmadığını ve alıcı tarafından düzenlenemeyeceğini gösterir.

Çok Satırlı
allfields.multiLine boolean

Metin alanının birden çok giriş satırı kabul edip etmediğini gösterir (fieldType 'textfield' olduğunda geçerlidir).

Karakter Sınırı
allfields.characterLimit integer

Alanda izin verilen en fazla karakter sayısı (fieldType 'textfield' olduğunda geçerlidir).

Tarih Alanı Adı
allfields.datefieldName string

Tarih alanının etiketi (fieldType 'datefield' olduğunda geçerlidir).

Tarih Biçimi
allfields.dateFormat string

Bu alan tarafından kullanılan tarih biçimi (örn. AA/GG/YYYY) (fieldType 'datefield' olduğunda geçerlidir).

Onay Kutusu Adı
allfields.cbname string

Onay kutusu alanının etiketi (fieldType 'checkboxfield' olduğunda geçerlidir).

Onay Kutusu Grubu
allfields.cbgroup string

Bu onay kutusunun grup adı (fieldType 'onay kutusualanı' olduğunda geçerlidir).

Kontrol edildi
allfields.checked boolean

Onay kutusunun varsayılan olarak işaretli olup olmadığını gösterir (fieldType 'onay kutusualanı' olduğunda geçerlidir).

Güvenli Alan Adı
allfields.securedfieldName string

Güvenli alanın etiketi (fieldType 'securedfield' olduğunda geçerlidir).

Görüntülenecek Karakterler
allfields.charToDisplay integer

Güvenli alan değerinin sonunda görüntülenecek maskelenmemiş karakter sayısı (fieldType 'securedfield' olduğunda geçerlidir).

İmza Kimliği
allfields.signatureId string

Bu imza alanına uygulanan imzanın kimliği (fieldType 'signfield' olduğunda geçerlidir).

İlk Görüntü
allfields.initialImage string

Bu alana uygulanan baş harflerin görüntü verileri (fieldType 'initialfield' olduğunda geçerlidir).

Ek Alan Adı
allfields.attachmentfieldName string

Ek alanının adı (fieldType 'attachmentfield' olduğunda geçerlidir).

Ek Açıklaması
allfields.attachmentfieldDescription string

Ekleneceklerin açıklaması (fieldType 'attachmentfield' olduğunda geçerlidir).

Web Kancası Kanal Ayrıntılarını Alma

Belirli bir web kancası kanalının ayrıntılarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Kimliği
channelId True string

Alınacak web kancası kanalının benzersiz tanımlayıcısı.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Kimlik
channel.channelId integer

Web kancası kanalının benzersiz tanımlayıcısı.

Şirket Kimliği
channel.companyId integer

Bu kanalın ait olduğu şirket hesabı.

İsim
channel.channelName string

Web kancası kanalının adı.

Web Kancası URL'si
channel.webhookUrl string

Abone olunan bir olay gerçekleştiğinde Foxit eSign'ın çağıracağı URL.

Web Kancası Gizli Dizisi
channel.webhookSecret string

Web kancası yüklerini doğrulamak için kullanılan gizli anahtar.

Oluşturulma Tarihi
channel.dateCreated integer

Unix milisaniye cinsinden kanalın oluşturulduğu tarih.

Güncelleştirme Tarihi
channel.dateUpdated integer

Unix milisaniye cinsinden kanalın son güncelleştirilmiş olduğu tarih.

Web Kancası Düzeyi
channel.webhookLevel string

Web kancası kanalının kapsamı. 'Hesap' (tüm zarflar için tetikleyiciler) veya 'API Uygulaması' (yalnızca API aracılığıyla oluşturulan zarflar için tetikler).

Status
channel.status string

Kanalın geçerli durumu. 'etkin' veya 'devre dışı' olabilir.

Gönderilen Zarf
channel.eventsSubscribedMap.folder_sent boolean

Alıcılara zarf gönderildiğinde tetikler.

Zarf Görüntülendi
channel.eventsSubscribedMap.folder_viewed boolean

Bir zarf alıcı tarafından açıldığında tetikler.

Zarf İmzalı
channel.eventsSubscribedMap.folder_signed boolean

Bir zarf bir alıcı tarafından imzalandığında tetikler.

Zarf İptal Edildi
channel.eventsSubscribedMap.folder_cancelled boolean

Zarf iptal edildiğinde tetikler.

Zarf Yürütüldü
channel.eventsSubscribedMap.folder_executed boolean

Tüm taraflar imzaladığında ve zarf tamamen yürütülürse tetikler.

Zarf Silindi
channel.eventsSubscribedMap.folder_deleted boolean

Zarf silindiğinde tetikler.

Web Kancası Tetikleyicisi Aboneliğini Kaldır

Etkin bir web kancası kanalı aboneliğini kanal kimliğine göre siler. Artık gerekli olmayan web kancası aboneliklerini temizlemek için bu eylemi kullanın.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Kimliği
channelId True integer

Silinecek web kancası kanalının kimliği.

Zarf Ayrıntılarını Al

Zarfın durumu, alıcıları ve belgeleri de dahil olmak üzere tüm ayrıntılarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Kimliği
folderId True integer

Alınacak zarfın benzersiz tanımlayıcısı.

Erişim Belirteci
access_token string

Kimlik doğrulaması için OAuth 2.0 erişim belirteci.

Döndürülenler

Name Yol Tür Description
Result
result string

İşlemin başarılı olup olmadığını gösterir (örneğin, 'başarı').

Kimlik
folder.folderId integer

Zarfın benzersiz kimliği.

İsim
folder.folderName string

Zarfın adı.

Yazar Kimliği
folder.folderAuthorId integer

Zarfı oluşturan kullanıcının benzersiz kimliği.

Yazar Adı
folder.folderAuthorFirstName string

Zarfı oluşturanın adı.

Yazar Soyadı
folder.folderAuthorLastName string

Zarf oluşturucusunun soyadı.

E-posta Yaz
folder.folderAuthorEmail string

Zarf oluşturucusunun e-posta adresi.

Yazar Rolü
folder.folderAuthorRole string

Zarf oluşturucusunun hesap rolü.

Şirket Kimliği
folder.folderCompanyId integer

Zarfın ait olduğu şirketin benzersiz kimliği.

Oluşturma Tarihi
folder.folderCreationDate integer

Unix milisaniye cinsinden zarfın oluşturulduğu tarih ve saat.

Gönderme Tarihi
folder.folderSentDate integer

Zarfın unix milisaniye cinsinden alıcılara gönderildiği tarih ve saat. Henüz gönderilmediyse null.

Status
folder.folderStatus string

Zarfın geçerli durumu (ör. PAYLAŞILDI, YÜRÜTÜLDÜ, TASLAK, İptal EDİlDİ).

Belge Kimlikleri
folder.folderDocumentIds array of integer

Bu zarfa eklenen belge kimliklerinin listesi.

Documents
folder.documentsList array of object

Zarfa eklenen her belgenin ayrıntıları.

Belge Kimliği
folder.documentsList.documentId integer

Belgenin benzersiz tanımlayıcısı.

Sözleşme Kimliği
folder.documentsList.contractId integer

Bu belgeyle ilişkili sözleşmenin benzersiz tanımlayıcısı.

Şirket Kimliği
folder.documentsList.companyId integer

Bu belgenin ait olduğu şirketin benzersiz kimliği.

Oluşturan
folder.documentsList.contractCreatedBy integer

Sözleşmeyi oluşturan kişinin kullanıcı kimliği.

Oluşturulma Tarihi
folder.documentsList.contractCreatedOn integer

Unix milisaniye cinsinden sözleşmenin oluşturulduğu tarih.

Sözleşme Türü
folder.documentsList.contractType string

Sözleşmenin türü veya kategorisi.

Belge Durumu
folder.documentsList.contractStatus string

Belgenin geçerli imzalama durumu (örneğin, WAITING_FOR_SIGNATURE, YÜRÜTÜLDÜ).

Düzenlenebilir
folder.documentsList.editable boolean

Belgenin düzenlenip düzenlenemeyeceğini gösterir.

Sürüm Kimliği
folder.documentsList.contractVersionId integer

Geçerli belge sürümünün benzersiz kimliği.

Sürüm Adı
folder.documentsList.contractVersionName string

Geçerli belge sürümünün adı.

Sürüm Açıklaması
folder.documentsList.contractVersionDesc string

Geçerli belge sürümünün açıklaması.

Oluşturan Sürüm
folder.documentsList.versionCreatedby integer

Bu belge sürümünü oluşturan kişinin kullanıcı kimliği.

Sürüm Oluşturma Tarihi
folder.documentsList.versionCreatedOn integer

Bu belge sürümünün oluşturulduğu tarih( Unix milisaniye cinsinden).

Sürüm Numarası
folder.documentsList.contractVersionNumber integer

Belgenin sürüm numarası.

Alıcı
folder.folderRecipientParties array of object

İmzalama durumları ve erişim bağlantıları da dahil olmak üzere bu zarfın alıcılarının listesi.

Alıcı Kimliği
folder.folderRecipientParties.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
folder.folderRecipientParties.partyDetails.partyId integer

Alıcının benzersiz tanımlayıcısı.

İlk İsim
folder.folderRecipientParties.partyDetails.firstName string

Alıcının adı.

Soyadı
folder.folderRecipientParties.partyDetails.lastName string

Alıcının soyadı.

E-posta
folder.folderRecipientParties.partyDetails.emailId string

Alıcının e-posta adresi.

Adres
folder.folderRecipientParties.partyDetails.address string

Alıcının adresi.

Hesap Oluşturma Tarihi
folder.folderRecipientParties.partyDetails.dateCreated integer

Alıcının hesabının oluşturulduğu tarih( Unix milisaniye cinsinden).

İzinler
folder.folderRecipientParties.contractPermissions string

Bu alıcıya verilen imzalama izinleri (örneğin, FILL_FIELDS_AND_SIGN).

İmzalama Sırası
folder.folderRecipientParties.partySequence integer

Bu alıcının imzalama sırasına göre konumu.

İş Akışı Dizisi
folder.folderRecipientParties.workflowSignSequence integer

Bu alıcı için iş akışı imzalama sırası numarası.

Zarf Kimliği
folder.folderRecipientParties.envelopeId integer

Bu alıcının ait olduğu zarfın kimliği.

Paylaşım Modu
folder.folderRecipientParties.sharingMode string

Belgeyi bu alıcıyla paylaşmak için kullanılan yöntem (örneğin, e-posta).

İmzalama URL'si
folder.folderRecipientParties.folderAccessURL string

Bu alıcı için benzersiz imzalama URL'si. Zarf zaten tamamlandıysa veya iptal edildiyse null.

Güvenlik Modu
folder.folderRecipientParties.securityMode string

Bu alıcının erişimine uygulanan güvenlik modu.

Ek Açıklamalar
folder.folderRecipientParties.extraComments string

Bu alıcı için imzalama davetinde yer alan tüm ek açıklamalar.

Yazma Erişim URL'si
folder.folderAccessURLForAuthor string

Belgeye erişmek için zarf yazarının URL'si. Uygulanamazsa null.

Toplu Kimlik
folder.bulkId integer

Bu zarfın ait olduğu toplu gönderme toplu işleminin kimliği (varsa).

İmza Sırasını Zorla
folder.enforceSignWorkflow boolean

Alıcıların belirtilen sırada oturum açması gerekip gerekmediğini gösterir.

Geçerli İş Akışı Adımı
folder.currentWorkflowStep integer

İmzalama iş akışındaki geçerli adım.

İşlem Kaynağı
folder.transactionSource string

Bu zarf işlemini başlatan kaynak.

Düzenlenebilir
folder.editable boolean

Zarfın hala düzenlenip düzenlenemeyeceğini gösterir.

In-Person İmzalama
folder.inPersonSignable boolean

Zarfın bizzat imzalanıp imzalanamayacağını gösterir.

Anımsatıcıları Geçersiz Kıl
folder.overrideAccountReminders boolean

Bu zarf için hesap düzeyi anımsatıcı ayarlarının geçersiz kılınıp kılınmadığını gösterir.

Kimlik
folder.envelopeId integer

Zarfın benzersiz kimliği. Zarf Kimliği (folderId) ile aynı değer.

İsim
folder.envelopeName string

Zarfın adı. Zarf Adı (folderName) ile aynı değer.

Kaynak Kimliği
folder.envelopeOriginatorId integer

Zarfı oluşturan kişinin kullanıcı kimliği.

Şirket Kimliği
folder.envelopeCompanyId integer

Zarfın ait olduğu şirketin kimliği.

Date
folder.envelopeDate integer

Unix milisaniye cinsinden zarfın oluşturulduğu tarih ve saat.

Paylaşılan Tarih
folder.envelopeSharedDate integer

Zarfın unix milisaniye cinsinden alıcılarla paylaşıldığı tarih ve saat. Henüz paylaşılmadıysa null.

Status
folder.envelopeStatus string

Zarfın geçerli durumu. Zarf Durumu (folderStatus) ile aynı değer.

Sözleşme kimlikleri
folder.envelopeContractIds array of integer

Bu zarfla ilişkili sözleşme kimliklerinin listesi.

Grup İzinleri
folder.envelopePartyPermissions array of object

Alıcıların listesi ve imza izinleri. Alıcılar ile aynı yapı.

Alıcı Kimliği
folder.envelopePartyPermissions.partyId integer

Alıcının benzersiz tanımlayıcısı.

İlk İsim
folder.envelopePartyPermissions.partyDetails.firstName string

Alıcının adı.

Soyadı
folder.envelopePartyPermissions.partyDetails.lastName string

Alıcının soyadı.

E-posta
folder.envelopePartyPermissions.partyDetails.emailId string

Alıcının e-posta adresi.

İzinler
folder.envelopePartyPermissions.contractPermissions string

Bu alıcı için imzalama izinleri.

İmzalama Sırası
folder.envelopePartyPermissions.partySequence integer

Bu alıcının imzalama sırasına göre konumu.

İmzalama URL'si
folder.envelopePartyPermissions.folderAccessURL string

Bu alıcı için benzersiz imzalama URL'si.

Tüm Alanlar
allFields array of object

Zarfın belgelerine yerleştirilen tüm imza ve form alanlarının listesi.

Alan Kimliği
allFields.fieldTagId integer

Alanın benzersiz tanımlayıcısı.

Belge Kimliği
allFields.contractId integer

Bu alanın ait olduğu belgenin kimliği.

Sürüm Kimliği
allFields.versionId integer

Bu alanın ait olduğu belgenin sürüm kimliği.

Alan Türü
allFields.fieldType string

Alanın türü (örneğin, signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).

Sayfa Numarası
allFields.documentPageNumber integer

Bu alanın yerleştirildiği sayfa numarası.

Alan Belge Kimliği
allFields.docFieldId string

Bu alanın belge düzeyi tanımlayıcısı.

Sorumlu Taraf
allFields.partyResponsible integer

Bu alanı doldurmaktan sorumlu olan taraf kimliği.

Bağımlıdır
allFields.dependent boolean

Bu alanın görünürlüğünün başka bir alanın değerine bağlı olup olmadığını gösterir.

Zorunlu
allFields.required boolean

Belge gönderilmeden önce bu alanın doldurulup doldurulmayacağını gösterir.

Alan Değeri
allFields.value string

Doldurulmuşsa, alanın geçerli değeri.

Alan Değerleri
allFieldsNameValue array of object

Tüm alan adlarının ve bunların geçerli değerlerinin basitleştirilmiş listesi. İmzalı bir zarftan doldurulmuş alan verilerini okumak için bunu kullanın.

Alan Kimliği
allFieldsNameValue.fieldId integer

Alanın benzersiz tanımlayıcısı.

Belge Kimliği
allFieldsNameValue.documentId integer

Bu alanın ait olduğu belgenin kimliği.

Sürüm Kimliği
allFieldsNameValue.documentVersionId integer

Bu alanın ait olduğu belgenin sürüm kimliği.

Alan Türü
allFieldsNameValue.fieldType string

Alanın türü (örn. metin alanı, signfield, datefield, onay kutusu alanı, açılan alan).

Alan Adı
allFieldsNameValue.name string

Şablonda tanımlandığı gibi alanın etiketi veya adı.

Alan Değeri
allFieldsNameValue.value string

Bu alan için girilen veya seçilen değer.

Zarf Geçmişi
Folder History array of object

Bu zarfta yapılan tüm eylemlerin kronolojik sırayla denetim kaydı.

İlk İsim
Folder History.firstName string

Eylemi gerçekleştiren kişinin adı.

Soyadı
Folder History.lastName string

Eylemi gerçekleştiren kişinin soyadı.

E-posta
Folder History.email string

Eylemi gerçekleştiren kişinin e-posta adresi.

Zarf Kimliği
Folder History.envelopeId integer

Eylemin gerçekleştirildiği zarfın kimliği.

Date
Folder History.dateChanged integer

Unix milisaniye cinsinden eylemin gerçekleştiği tarih ve saat.

Taraf kimliği
Folder History.changeDoneByParty integer

Eylemi gerçekleştiren kişinin taraf kimliği.

Action
Folder History.action string

Zarf üzerinde gerçekleştirilen eylem (ör. Oluşturuldu, InviteSentTo, InviteAccepted, İmzalı, Yürütüldü).

Zarf Dosyalarını İndir

Tamamlanan belgeleri bir zarftan dosya olarak indirir.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Kimliği
folderId True string

Belgelerini indirmek istediğiniz zarfın benzersiz tanımlayıcısı.

Döndürülenler

response
binary

Zarf Etkinlik Geçmişini Al

Bir zarf için, alıcılar ve gönderen tarafından yapılan tüm eylemleri gösteren tam etkinlik günlüğünü alır.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Kimliği
folderId True integer

Etkinlik geçmişini almak istediğiniz zarfın benzersiz tanımlayıcısı.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Zarf Kimliği
details.folderId integer

Zarfın benzersiz tanımlayıcısı.

Kapalı Belgeler
details.enclosedDocuments string

Zarfın içine alınmış belgelerin adı.

Alıcı
details.envelopeRecipients string

Zarfın üzerindeki tüm alıcıların adları.

Author
details.author string

Zarfı oluşturan kullanıcının adı.

Status
details.status string

Zarfın geçerli durumu (ör. PAYLAŞILDI, YÜRÜTÜLDÜ, İptal EDİlDİ).

En Son Etkinlik Tarihi
details.latestActivityDate string

Zarf üzerindeki en son etkinliğin tarihi ve saati.

Oluşturulma Tarihi
details.dateCreated string

Zarfın oluşturulduğu tarih ve saat.

Gönderilme Tarihi
details.dateSent string

Zarfın alıcılara gönderildiği tarih ve saat.

Activities
details.activities array of object

Bu zarfta yapılan tüm eylemlerin kronolojik listesi.

Activity
details.activities.activity string

Gerçekleşen eylemin okunabilir bir açıklaması.

Action
details.activities.action string

Gerçekleştirilen eylemin türü (ör. Oluşturuldu, Davet Gönderildi, Açıldı, Görüntülendi, İmzalandı).

User
details.activities.user string

Eylemi gerçekleştiren kullanıcının adı.

Zarf Durumu
details.activities.folderStatus string

Bu eylemin gerçekleştiği sırada zarfın durumu.

Time
details.activities.time string

Eylemin gerçekleştiği tarih ve saat.

Source
details.activities.source string

Eylemin gerçekleştirildiği kaynak (örneğin, Web).

IP Adresi
details.activities.ipAddress string

Varsa eylemin gerçekleştirildiği IP adresi.

Zarf Kimliklerini Al

Duruma göre filtrelenmiş zarf kimliklerinin listesini döndürür. Belirli bir durumdaki zarfları bulmak için bunu kullanın.

Parametreler

Name Anahtar Gerekli Tür Description
Başlangıç Tarihi
dateFrom True string

Zarf oluşturma tarih aralığının başlangıcı. Kabul edilen biçim: YYYY-AA-GG.

Bitiş Tarihi
dateTo True string

Zarf oluşturma tarih aralığının sonu. Kabul edilen biçim: YYYY-AA-GG. dateTo değeri dateFrom değerinden itibaren 6 ay içinde olmalıdır.

Status
status string

Zarfları duruma göre filtreleyin. Kabul edilen değerler: YÜRÜTÜLDÜ, PAYLAŞILDI, TASLAK, KISMİ İmzaLI, İptal EDİlDİ, SÜRESİ DOLDU, SİlDİ. Atlanırsa, herhangi bir duruma sahip zarflar döndürülür.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Message
message string

Kaç zarf kimliklerinin döndürüldiğini gösteren bir özet ileti.

Zarf Kimlikleri
allFolderIds array of integer

Filtre ölçütleriyle eşleşen zarf kimliklerinin listesi. Zarf bilgilerinin tamamını almak için Zarf Ayrıntılarını Al ile bu kimlikleri kullanın.

Zarfları Geri Dönüşüm Kutusuna Taşı

Bir veya daha fazla zarfı geri dönüşüm kutusuna taşır. Geri dönüşüm kutusundaki zarflar kalıcı olarak silinmez.

Parametreler

Name Anahtar Gerekli Tür Description
Klasör Kimlikleri
folderIds True array of integer

Üzerinde işlem yapmak için bir dizi zarf kimliği.

Döndürülenler

Name Yol Tür Description
Result
result string

İşlemin başarılı olup olmadığını gösterir.

Zarfları Sil

Bir veya daha fazla zarfı kalıcı olarak siler.

Parametreler

Name Anahtar Gerekli Tür Description
folderIds
folderIds array of integer

Döndürülenler

Name Yol Tür Description
Result
result string

İşlemin başarılı olup olmadığını gösterir.

Zarfı İptal Et

Gönderilen zarfı iptal eder. Alıcılar artık belgeleri imzalayamaz.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Kimliği
folderId True integer

İptal edilecek zarfın kimliği.

İptal Nedeni
reason_for_cancellation True string

Bu zarfı iptal etme sebebi. Bu, zarf etkinlik geçmişine kaydedilir.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

İptal Edilen Zarf Kimlikleri
folders cancelled array of integer

Başarıyla iptal edilen zarf kimliklerinin listesi.

Şablon Ayrıntılarını Alma

Alanları ve alıcıları dahil olmak üzere belirli bir şablonun tüm ayrıntılarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
Şablon Kimliği
templateId True string

Alınacak şablonun benzersiz tanımlayıcısı.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Kimlik
template.templateId integer

Şablonun benzersiz tanımlayıcısı.

İsim
template.templateName string

Şablonun adı.

Description
template.templateDesc string

Şablonun açıklaması.

Türü
template.templateType string

Şablonun türü.

Oluşturulma Tarihi
template.templateCreationDate integer

Şablonun oluşturulduğu tarih( Unix milisaniye cinsinden).

Son Güncelleştirme Tarihi
template.templateLastUpdateDate integer

Şablonun unix milisaniye cinsinden son güncelleştirilmiş olduğu tarih.

Düzenlenebilir
template.editable boolean

Şablonun düzenlenip düzenlenemeyeceğini gösterir.

Taraf Sayısı
template.numberOfParties integer

Şablonda tanımlanan imzalama taraflarının sayısı.

Toplam Sayfa Sayısı
template.totalPages integer

Şablon belgesindeki toplam sayfa sayısı.

Şirket Kimliği
template.companyId integer

Şablonun ait olduğu şirket hesabı.

Tümüyle Paylaş
template.shareAll boolean

Şablonun hesaptaki tüm kullanıcılarla paylaşılıp paylaşılmadığını gösterir.

Özel Ad Deseni
template.templateCustomName string

Bu şablondan oluşturulan zarflara uygulanan özel ad deseni.

Grup İzinleri
template.templatePartyPermissions array of object

Bu şablonda tanımlanan alıcı rollerinin listesi ve imza izinleri.

Taraf kimliği
template.templatePartyPermissions.template_party_id integer

Bu şablon taraf girişinin benzersiz kimliği.

Kimlik
template.templatePartyPermissions.templateId integer

Bu tarafın ait olduğu şablonun kimliği.

İzinler
template.templatePartyPermissions.templatePermissions string

Bu taraf için imzalama izinleri (örneğin, FILL_FIELDS_AND_SIGN).

İmzalama Sırası
template.templatePartyPermissions.partySequence integer

Bu parti için imza siparişi konumu.

Grup Rolü
template.templatePartyPermissions.templatePartyRole string

Bu tarafa atanan rol adı. Bu şablondan zarf oluştururken bu değeri kullanın.

Taraf kimliği
template.templatePartyPermissions.partyId integer

Önceden atanmışsa, bu role atanan tarafın kimliği.

Taraf kimliği
template.templateCreatedBy.partyId integer

Kullanıcının benzersiz tanımlayıcısı.

İlk İsim
template.templateCreatedBy.firstName string

Kullanıcının adı.

Soyadı
template.templateCreatedBy.lastName string

Kullanıcının soyadı.

E-posta
template.templateCreatedBy.emailId string

Kullanıcının e-posta adresi.

Bölüm
template.templateCreatedBy.department string

Kullanıcının departmanı.

Başlık
template.templateCreatedBy.title string

Kullanıcının iş unvanı.

Aktif
template.templateCreatedBy.active boolean

Kullanıcı hesabının etkin olup olmadığını gösterir.

Taraf kimliği
template.templateLastUpdatedBy.partyId integer

Kullanıcının benzersiz tanımlayıcısı.

İlk İsim
template.templateLastUpdatedBy.firstName string

Kullanıcının adı.

Soyadı
template.templateLastUpdatedBy.lastName string

Kullanıcının soyadı.

E-posta
template.templateLastUpdatedBy.emailId string

Kullanıcının e-posta adresi.

Bölüm
template.templateLastUpdatedBy.department string

Kullanıcının departmanı.

Başlık
template.templateLastUpdatedBy.title string

Kullanıcının iş unvanı.

Aktif
template.templateLastUpdatedBy.active boolean

Kullanıcı hesabının etkin olup olmadığını gösterir.

Tüm Alanlar
allfields array of object

Bu şablonda tanımlanan tüm alanların listesi.

Alan Etiketi Kimliği
allfields.fieldTagId integer

Alanın benzersiz tanımlayıcısı.

Şablon Kimliği
allfields.templateId integer

Bu alanın ait olduğu şablonun kimliği.

Şirket Kimliği
allfields.companyId integer

Bu alanın ait olduğu şirket hesabı.

Alan Türü
allfields.fieldType string

Alanın türü (örneğin, signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield).

Sayfa Numarası
allfields.documentPageNumber integer

Bu alanın yerleştirildiği belgenin sayfa numarası.

Taraf Sorumlu
allfields.partyResponsible integer

Bu alanı tamamlamaktan sorumlu olan taraf dizisi numarası.

Parti Dizisi
allfields.partyResponsibleSequence integer

Sorumlu tarafın sıra konumu.

Belge Alan Kimliği
allfields.docFieldId string

Belgedeki bu alanın tanımlayıcısı.

Bağımlı
allfields.dependent boolean

Bu alanın görünürlüğünün başka bir alanın değerine bağlı olup olmadığını gösterir.

Sekme Sırası
allfields.tabOrder integer

Alanlar arasında gezinmek için sekme sırası.

Zorunlu
allfields.required boolean

Belgenin imzalanması için bu alanın tamamlanıp tamamlanmayacağını gösterir.

Özel Alan Adı
allfields.customFieldName string

Bu alana atanan özel ad.

Tümünü Paylaş
allfields.shareAll boolean

Bu alanın tüm kullanıcılarla paylaşılıp paylaşılmadığını gösterir.

Düzenlemeye İzin Ver
allfields.allowEdit boolean

Bu alanın alıcı tarafından düzenlenip düzenlenemeyeceğini gösterir.

Metin Alanı Adı
allfields.textfieldName string

Metin alanının etiketi (fieldType 'textfield' olduğunda geçerlidir).

Değer
allfields.value string

Alanın önceden doldurulmuş veya girilmiş değeri.

Yazı Tipi Boyutu
allfields.fontSize integer

Bu alandaki metin için kullanılan yazı tipi boyutu.

Yazı Tipi Rengi
allfields.fontColor string

Bu alandaki metin için kullanılan yazı tipi rengi (örneğin, #000000).

Yalnızca Okunur
allfields.readOnly boolean

Alanın salt okunur olup olmadığını ve alıcı tarafından düzenlenemeyeceğini gösterir.

Çok Satırlı
allfields.multiLine boolean

Metin alanının birden çok giriş satırı kabul edip etmediğini gösterir (fieldType 'textfield' olduğunda geçerlidir).

Karakter Sınırı
allfields.characterLimit integer

Alanda izin verilen en fazla karakter sayısı (fieldType 'textfield' olduğunda geçerlidir).

Tarih Alanı Adı
allfields.datefieldName string

Tarih alanının etiketi (fieldType 'datefield' olduğunda geçerlidir).

Tarih Biçimi
allfields.dateFormat string

Bu alan tarafından kullanılan tarih biçimi (örn. AA/GG/YYYY) (fieldType 'datefield' olduğunda geçerlidir).

Onay Kutusu Adı
allfields.cbname string

Onay kutusu alanının etiketi (fieldType 'checkboxfield' olduğunda geçerlidir).

Onay Kutusu Grubu
allfields.cbgroup string

Bu onay kutusunun grup adı, birden çok onay kutusu bağlandığında kullanılır (fieldType 'onay kutusu alanı' olduğunda geçerlidir).

Kontrol edildi
allfields.checked boolean

Onay kutusunun varsayılan olarak işaretli olup olmadığını gösterir (fieldType 'onay kutusualanı' olduğunda geçerlidir).

Güvenli Alan Adı
allfields.securedfieldName string

Güvenli alanın etiketi (fieldType 'securedfield' olduğunda geçerlidir).

Görüntülenecek Karakterler
allfields.charToDisplay integer

Güvenli alan değerinin sonunda görüntülenecek maskelenmemiş karakter sayısı (fieldType 'securedfield' olduğunda geçerlidir).

İmza Kimliği
allfields.signatureId string

Bu imza alanına uygulanan imzanın kimliği (fieldType 'signfield' olduğunda geçerlidir).

İlk Görüntü
allfields.initialImage string

Bu alana uygulanan baş harflerin görüntü verileri (fieldType 'initialfield' olduğunda geçerlidir).

Ek Alan Adı
allfields.attachmentfieldName string

Ek alanının adı (fieldType 'attachmentfield' olduğunda geçerlidir).

Ek Açıklaması
allfields.attachmentfieldDescription string

Ekleneceklerin açıklaması (fieldType 'attachmentfield' olduğunda geçerlidir).

Şablon Kimliklerine Göre Şablon Alma

Kimliklerine göre bir veya daha fazla şablonun ayrıntılarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
Şablon Kimlikleri
templateIds True array of integer

Alınacak şablon kimlikleri dizisi.

Döndürülenler

Name Yol Tür Description
Result
result string

İsteğin başarılı olup olmadığını gösterir.

Toplam Şablon Sayısı
total_templates integer

Döndürülen toplam şablon sayısı.

Şablon Listesi
templateIdList object

Şablon kimliğine göre anahtarlanan şablon verilerinin haritası. Her girdi, şablon ayrıntılarını ve alanlarını içerir.

Şablondan Zarf Oluştur

Var olan bir şablonu kullanarak zarf oluşturur ve gönderir. Alıcı ayrıntıları özelleştirilebilir.

Parametreler

Name Anahtar Gerekli Tür Description
Zarf Adı
folderName string

Belgeler klasörünün adı. Bu değer sağlanmazsa, belgeler klasör adı şablon adları ile aynı tutulur.

Şablon Kimlikleri
templateIds True array of integer

Bu klasörün belgelerini oluşturmak için kullanmak istediğiniz şablon kimlikleri dizisi.

Alanlar
fields object

Şablonlardan oluşturulan belgelerde önceden doldurmak için şablonlarda kullanılan alan değerlerini geçirebilirsiniz. FIELD_NAME, şablonda kullanılan alanın adıdır. FIELD_VALUE belge alanı değeridir.

Gelişmiş E-posta Doğrulaması
allowAdvancedEmailValidation boolean

True olarak ayarlandığında tarafların e-posta adreslerini doğrulayın.

İlk İsim
firstName True string

Alıcının adı.

Soyadı
lastName True string

Alıcının soyadı.

E-Posta Adresi
emailId True string

Alıcının e-posta adresi.

permissions
permission True string
Sequence
sequence True integer

Alıcı tarafları listesindeki bir alıcıya sıra numarası atamak için bu alanı kullanın. 1,2,3,4 gibi 1 ile başlayan her taraf için benzersiz sıra numaraları kullanın.... İmzalama iş akışında tek bir kişi birden çok kez görünüyorsa, lütfen alıcı her yinelendiğinde farklı bir sıra atayın.

signerAuthLevels
signerAuthLevel string

İmzalayanın doğrulama amacıyla yararlanacağı kimlik doğrulama düzeyi

Yer Tutucudur
isPlaceholder boolean

Bu alanı, bir yer tutucu olan partiyi başlatmak için kullanın. Not: 1. firstName, lastName, emailId parametresinin değeri bu taraf için boş olmalıdır. 2. Yer tutucuyu eklemek için bir alıcı 'PARTY_ASSIGNER' izniyle yeniden kaydedilmelidir.

Alıcı Rolü
partyRole string

Yer tutucu rolü atamak için bu alanı kullanın.

Ad Değişikliğine İzin Ver
allowNameChange string

Değer true veya false olabilir İmzalayanın imzalama işlemini tamamlamadan önce adı ve soyadını güncelleştirmesine izin vermek için bu parametreyi kullanın.

İş Akışı Dizisi
workflowSequence integer

Bu alıcıya bir iş akışı sıra numarası atayın. Oturum Açma Sırası etkinleştirildiğinde, alıcılar imzalama davetlerini artan sırada alır.

Konak E-posta Kimliği
hostEmailId string

In-Person Yöneticisinin e-posta adresi.

Erişim Kodu
userDefinedAccessCode string

Parametre, kimlik doğrulaması için "signerAuthLevel" değeri "Kullanıcı tanımlı Erişim Kodu" olarak ayarlandığında Erişim Kodu içerir. Not: 1. Kodlar büyük/küçük harfe duyarlı değildir. 2. Sistem bu kodu göndermez, bu nedenle bu kodu doğrudan imzalayanla paylaşmanız gerekir. 3. Erişim kodu alfabeleri, sayıları ve şu özel karakterleri içerebilir: @,&;{,},%,(,),~,|,!,+,^.

Grup E-posta Grubudur
partyIsEmailGroup boolean

Toplu olarak grup oluştururken bu parametreyi kullanın. Not: Bu parametre true ise, bu tarafın firstName, lastName ve emailId değeri yoksayılır.

E-posta Grubu Kimliği
emailGroupId integer

Toplu oluşturmak için kullanmak istediğiniz grup kimliğini e-postaya geçirin.

Tek İmzalayan Toplu
allowSingleSignerInBulk boolean

Yalnızca bir kişinin e-posta grubunda oturum açmasına izin vermek için bu parametreyi kullanın.

Arama Kodu
dialingCode string

Ülke arayarak bağlanma kodları, alıcı tarafları listesindeki bir alıcıya mobil numara ön ekleridir atamak için bu alanı kullanın.

Cep Telefonu Numarası
mobileNumber string

Alıcı tarafları listesindeki bir alıcıya cep telefonu numarası atamak için bu alanı kullanın.

Zarf Parolası
folderPassword string

Dijital olarak imzalanan belgeyi açmak için imzalayan/yazan kişi bu parolayı gerektirir. Parametre boş tutulursa, dijital olarak imzalanan belgeyi açmak için parola gerekmez.

Oturum Açma Sırası
signInSequence boolean

Bu alan, alıcıların zarf belgelerini sırayla imzalayıp imzalamayacağını belirlemek için kullanılır. False ise, tüm alıcılar aynı anda davet e-postası alır. Doğru olduğunda, önceki alıcı gerekli görevi tamamladıktan sonra her alıcı, belgeleri imzalama veya alanları doldurma gibi sırayla davet e-postası alır.

Kişi Olarak Etkinleştir
inPersonEnable boolean

Bu alan, herhangi bir cihazda birkaç dakika içinde kolayca tamamlanabilen ve gerektiğinde e-posta tabanlı imzalardan kaçınan, kişi içi imzalama işlemini başlatmak için kullanılır. False ise, tüm alıcılar davet e-postasını aynı anda alır. Doğru olduğunda, bizzat yönetici imzalayan için imzalama işlemini başlatmak üzere bir davet e-postası alır.

Şimdi Gönder
sendNow boolean

Etkinleştirildiğinde, Foxit eSign hemen her alıcının e-posta adresine benzersiz bir imzalama bağlantısı gönderir. Bunun yerine zarfı taslak olarak kaydetmek için bunu devre dışı bırakın.

İmza Başarılı Url'si Tüm Taraflar
signSuccessUrlAllParties boolean

True olarak ayarlanırsa, imzalayan, başarıyla imzalandıktan sonra signSuccessUrl içinde sağlanan URL'ye yönlendirilir. Bu yalnızca sendNow doğru olduğunda geçerlidir.

Ekli Gönderme Oturumu Oluşturma
createEmbeddedSendingSession boolean

true olarak ayarlanırsa, Foxit eSign görünümünü hazırlayan belgeyi açmak için eklenmiş bir URL oluşturur.

Alıcı Taraflarını Düzelt
fixRecipientParties boolean

Doğruysa, eklenmiş gönderme görünümünde, bu isteğin bir parçası olarak zaten eklenmiş olan zarfın tarafları değiştirilemez.

Belgeleri Düzeltme
fixDocuments boolean

True ise, eklenmiş göndermede bu isteğin bir parçası olarak zaten eklenmiş olan zarfın belgeleri değiştirilemez.

Başarılı Url'si Gönder
sendSuccessUrl string

Katıştırılmış gönderme görünümünde klasörü başarıyla gönderdikten sonra imzalayanın yeniden yönlendirileceği giriş sayfasının mutlak URL'sini girin.

Hata Url'si Gönder
sendErrorUrl string

Katıştırılmış gönderme görünümünde klasörü gönderirken hata gelirse, imzalayanın yönlendirileceği giriş sayfasının mutlak URL'sini girin.

İmzalayan Seçme Seçeneğini Gizle
hideSignerSelectOption boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarında "Mevcut İmzalayan Adı/E-postası" giriş kutusunu gizler.

İmzalayan Eylemlerini Gizle
hideSignerActions boolean

Doğruysa, ekli bir gönderme oturumunda Alıcı Taraflarında imzalayan "düzenle", "değiştir" ve "kaldır" eylemlerini gizler.

Gönderen Adını Gizle
hideSenderName boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarında gönderenin adını gizler.

Gönder Düğmesini Gizle
hideSendButton boolean

Doğruysa, eklenmiş gönderme oturumunda Gönder düğmesini gizler.

Klasör Adını Gizle
hideFolderName boolean

True ise, her iki ekli oturumda da gezintideki klasör adını gizler.

Belge Adını Gizle
hideDocumentsName boolean

True ise, her iki katıştırılmış oturumda da belge adını gizler.

Beni Ekle Düğmesini Gizle
hideAddMeButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Beni Ekle" düğmesini gizler.

Yeni Ekle Düğmesini Gizle
hideAddNewButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Yeni Ekle" düğmesini gizler.

Grup Ekle Düğmesini Gizle
hideAddGroupButton boolean

Doğruysa, eklenmiş bir gönderme oturumunda Alıcı Taraflarındaki "Grup Ekle" düğmesini gizler.

Ekli İmzalama Oturumu Oluşturma
createEmbeddedSigningSession boolean

İmzalama oturumu belirteci, alıcılara e-posta göndermeden oluşturulur.

Tüm Taraflar için Ekli İmzalama Oturumu Oluşturma
createEmbeddedSigningSessionForAllParties boolean

true olarak ayarlanırsa, zarftaki her alıcı için eklenmiş bir imzalama URL'si oluşturulur. False ise, yalnızca Katıştırılmış İmzalayanlar E-posta Kimliklerinde listelenen alıcılar ekli oturum alır.

Ekli İmzalayanlar E-posta Kimlikleri
embeddedSignersEmailIds array of string

Ekli imzalama oturumu oluşturulması gereken alıcıların e-posta kimlikleri dizisi. Taraflar listesine eklenen alıcı tarafların e-posta kimlikleri.

İmza Başarılı Url'si
signSuccessUrl string

Ekli imzalama görünümünde başarıyla oturum açtıktan sonra yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Reddetme Url'sini İmzala
signDeclineUrl string

Ekli imzalama görünümünde oturum açmayı reddederse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Daha Sonra İmzala URL'si
signLaterUrl string

Ekli imzalama görünümünde daha sonra oturum açmayı seçerse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Hata Url'sini İmzala
signErrorUrl string

Belgeyi ekli imzalama görünümünde imzalama sırasında hata gelirse yeniden yönlendirilecek imzalayanların mutlak URL'sini girin.

Sonraki Gerekli Alanı Gizle Btn
hideNextRequiredFieldBtn boolean

true olarak ayarlanırsa, imzalayanları bir sonraki gerekli alana taşıyan gezinti düğmesini gizler.

Tema Rengi
themeColor string

Tema rengini ayarlamak için CSS değerini girin.

İmzalayacak Reddet'i gizle
hideDeclineToSign boolean

true olarak ayarlanırsa, imzalama ekranında İmzaya Reddet seçeneğini gizler.

Diğer Eylemi Gizle
hideMoreAction boolean

True olarak ayarlanırsa, gönderme ve imzalama oturumunda Diğer Eylemler düğmesini gizler. Şimdi Gönder doğru olduğunda hiçbir etkisi olmaz.

Taraf Ekle Seçeneğini Gizle
hideAddPartiesOption boolean

True olarak ayarlanırsa, Taslak ve Şablon Oluşturma modunda taraf ekleme seçeneğini gizler.

Oturumun Süresi Doldu
sessionExpire boolean

Katıştırılmış imzalama oturumunun süresinin dolmasına başlatmak için true olarak ayarlayın.

Süre sonu
expiry integer

sessionExpire true ise gereklidir. Katıştırılmış imzalama oturumunda süre sonunu milisaniye olarak girin.

Gönderen E-postası
senderEmail string

Hesabınızdaki başka bir kullanıcının e-postasını girin. Bu belge veya klasör alıcı taraflarına göndermek için kullanılacaktır.

Şimdi Gönder ve Ekli İmzalama oturumuna izin ver
allowSendNowAndEmbeddedSigningSession boolean

True olarak ayarlanırsa, Foxit eSign her alıcıya bir imzalama daveti e-postası gönderir ve e-postası Embedded Signer Email'e eklenmiş alıcılar için ekli bir imzalama bağlantısı oluşturur. Hem e-posta hem de eklenmiş bağlantı aynı anda etkindir.

Adım Adım Etkinleştir
enableStepByStep boolean

Eklenmiş gönderme oturumunda adım adım eylemi etkinleştirmek için.

Döndürülenler

Name Yol Tür Description
Result
result string

İşlemin başarılı olup olmadığını gösterir (örneğin, 'başarı').

Message
message string

İşlem sonucunun açıklaması.

Ekli İmzalama Oturumları
embeddedSigningSessions array of object

Alıcı başına bir tane olan ekli imzalama oturumlarının listesi. Yalnızca createEmbeddedSigningSession true olduğunda bulunur.

İmzalayan E-postası
embeddedSigningSessions.emailIdOfSigner string

Bu ekli imzalama oturumu için alıcının e-posta adresi.

İmzalama Belirteci
embeddedSigningSessions.embeddedToken string

Bu alıcının ekli imzalama oturumu için benzersiz belirteç.

İmzalama Oturumu URL'si
embeddedSigningSessions.embeddedSessionURL string

Bu alıcının belgeyi imzalaması için aç veya ekle URL'si.

Ekli Gönderme Belirteci
embeddedToken string

Eklenmiş gönderme oturumu için belirteç. Yalnızca createEmbeddedSendingSession true olduğunda bulunur.

Oturum URL'si Gönderiliyor
embeddedSessionURL string

Zarf yazarının zarfı hazırlaması ve göndermesi için açılacak veya eklenmek üzere URL. Yalnızca createEmbeddedSendingSession true olduğunda bulunur.

Kimlik
folder.folderId integer

Oluşturulan zarfın benzersiz kimliği. Sonraki eylemlerde zarfa başvurmak için bunu kullanın.

İsim
folder.folderName string

Zarfın adı.

Özel Ad
folder.folderCustomName string

Zarfa atanan özel ad.

Şifre
folder.folderPassword string

Varsa zarf için ayarlanan parola.

Yazar Kimliği
folder.folderAuthorId integer

Zarfı oluşturan kullanıcının benzersiz kimliği.

Yazar Adı
folder.folderAuthorFirstName string

Zarfı oluşturanın adı.

Yazar Soyadı
folder.folderAuthorLastName string

Zarf oluşturucusunun soyadı.

E-posta Yaz
folder.folderAuthorEmail string

Zarf oluşturucusunun e-posta adresi.

Yazar Rolü
folder.folderAuthorRole string

Zarf oluşturucusunun hesap rolü.

Şirket Kimliği
folder.folderCompanyId integer

Zarfın ait olduğu şirketin benzersiz kimliği.

Oluşturma Tarihi
folder.folderCreationDate integer

Unix milisaniye cinsinden zarfın oluşturulduğu tarih ve saat.

Gönderme Tarihi
folder.folderSentDate integer

Zarfın unix milisaniye cinsinden alıcılara gönderildiği tarih ve saat.

Status
folder.folderStatus string

Zarfın geçerli durumu (ör. PAYLAŞILDI, YÜRÜTÜLDÜ, TASLAK, İptal EDİlDİ).

Özel Alan 1
folder.custom_field1 string

Zarfta ayarlanan özel alan 1'in değeri.

Özel Alan 2
folder.custom_field2 string

Zarfta ayarlanan özel alan 2'nin değeri.

Meta veriler
folder.metadata string

Zarfla ilişkili tüm ek meta veriler.

Belge Kimlikleri
folder.folderDocumentIds array of integer

Bu zarfa eklenen belge kimliklerinin listesi.

Documents
folder.documentsList array of object

Zarfa eklenen her belgenin ayrıntıları.

Belge Kimliği
folder.documentsList.documentId integer

Belgenin benzersiz tanımlayıcısı.

Sözleşme Kimliği
folder.documentsList.contractId integer

Bu belgeyle ilişkili sözleşmenin benzersiz tanımlayıcısı.

Şirket Kimliği
folder.documentsList.companyId integer

Bu belgenin ait olduğu şirketin benzersiz kimliği.

Oluşturan
folder.documentsList.contractCreatedBy integer

Sözleşmeyi oluşturan kişinin kullanıcı kimliği.

Oluşturulma Tarihi
folder.documentsList.contractCreatedOn string

Sözleşmenin oluşturulduğu tarih.

Sözleşme Türü
folder.documentsList.contractType string

Sözleşmenin türü.

Belge Durumu
folder.documentsList.contractStatus string

Belgenin geçerli imzalama durumu (örneğin, WAITING_FOR_SIGNATURE, YÜRÜTÜLDÜ).

Düzenlenebilir
folder.documentsList.editable boolean

Belgenin düzenlenip düzenlenemeyeceğini gösterir.

Sürüm Kimliği
folder.documentsList.contractVersionId integer

Geçerli belge sürümünün benzersiz kimliği.

Sürüm Adı
folder.documentsList.contractVersionName string

Geçerli belge sürümünün adı.

Sürüm Açıklaması
folder.documentsList.contractVersionDesc string

Geçerli belge sürümünün açıklaması.

Oluşturan Sürüm
folder.documentsList.versionCreatedby integer

Bu belge sürümünü oluşturan kişinin kullanıcı kimliği.

Sürüm Oluşturma Tarihi
folder.documentsList.versionCreatedOn string

Bu belge sürümünün oluşturulduğu tarih.

Sürüm Numarası
folder.documentsList.contractVersionNumber integer

Belgenin sürüm numarası.

İşlem Kaynağı
folder.documentsList.contractTransactionSource string

Sözleşme işleminin kaynağı.

Alıcı
folder.folderRecipientParties array of object

Bu zarfın alıcılarının listesi ve tek tek imzalama bağlantıları.

Alıcı Kimliği
folder.folderRecipientParties.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
folder.folderRecipientParties.partyDetails.partyId integer

Alıcının benzersiz tanımlayıcısı.

İlk İsim
folder.folderRecipientParties.partyDetails.firstName string

Alıcının adı.

Soyadı
folder.folderRecipientParties.partyDetails.lastName string

Alıcının soyadı.

E-posta
folder.folderRecipientParties.partyDetails.emailId string

Alıcının e-posta adresi.

Yer Tutucudur
folder.folderRecipientParties.partyDetails.placeholder boolean

Bu alıcının yer tutucu olup olmadığını gösterir.

Adres
folder.folderRecipientParties.partyDetails.address string

Alıcının adresi.

Hesap Oluşturma Tarihi
folder.folderRecipientParties.partyDetails.dateCreated integer

Alıcının hesabının oluşturulduğu tarih( Unix milisaniye cinsinden).

E-postaları Geri Çevir
folder.folderRecipientParties.partyDetails.optOutEmails boolean

Alıcının e-posta bildirimlerini geri çevirip geri çevirmediğini gösterir.

Benzersiz Taraf Kimliği
folder.folderRecipientParties.partyDetails.uniquePartyId string

Alıcı için benzersiz bir dize tanımlayıcısı.

Kimlik Doğrulama Düzeyi
folder.folderRecipientParties.partyDetails.authenticationLevel string

Bu alıcı için gereken kimlik doğrulama düzeyi.

Şirket Kimliği
folder.folderRecipientParties.partyDetails.companyId integer

Alıcının ait olduğu şirketin kimliği.

Kullanıcı Rolü
folder.folderRecipientParties.partyDetails.userRole string

Alıcının kuruluşundaki rolü.

Bölüm
folder.folderRecipientParties.partyDetails.department string

Alıcının departmanı.

Başlık
folder.folderRecipientParties.partyDetails.title string

Alıcının iş unvanı.

Aktif
folder.folderRecipientParties.partyDetails.active boolean

Alıcının hesabının etkin olup olmadığını gösterir.

Arama Kodu
folder.folderRecipientParties.partyDetails.dialingCode string

Alıcının telefon numarasının ülke arama kodu.

Cep Telefonu Numarası
folder.folderRecipientParties.partyDetails.mobileNumber string

Alıcının cep telefonu numarası.

Taşeron Açıklaması
folder.folderRecipientParties.partyDetails.subcontractorDescription string

Varsa, alt yüklenicinin açıklaması.

Alt Yüklenici Kuruluşu
folder.folderRecipientParties.partyDetails.subcontractorOrganization string

Varsa, alt yüklenicinin kuruluş adı.

Taşeron Ekleme Tarihi
folder.folderRecipientParties.partyDetails.subcAddedDate integer

Alt yüklenicinin Unix milisaniye cinsinden eklendiği tarih.

Source
folder.folderRecipientParties.partyDetails.source string

Alıcının eklendiği kaynak.

Arama Kodu
folder.folderRecipientParties.dialingCode string

Alıcının cep telefonu numarasının ülke arama kodu.

Cep Telefonu Numarası
folder.folderRecipientParties.mobileNumber string

Alıcının cep telefonu numarası.

İmza Türü
folder.folderRecipientParties.signerSignatureType string

Bu alıcı için izin verilen imza türü.

İzinler
folder.folderRecipientParties.contractPermissions string

Bu alıcıya verilen imzalama izinleri (örneğin, FILL_FIELDS_AND_SIGN).

İmzalama Sırası
folder.folderRecipientParties.partySequence integer

Bu alıcının imzalama sırasına göre konumu.

İş Akışı Dizisi
folder.folderRecipientParties.workflowSignSequence integer

Bu alıcı için iş akışı imzalama sırası numarası.

Zarf Kimliği
folder.folderRecipientParties.envelopeId integer

Bu alıcının ait olduğu zarfın kimliği.

Taraf Şirket Kimliği
folder.folderRecipientParties.partyCompanyId integer

Bu alıcının ait olduğu şirketin kimliği.

Paylaşım Modu
folder.folderRecipientParties.sharingMode string

Belgeyi bu alıcıyla paylaşmak için kullanılan yöntem (örneğin, e-posta).

İmzalama URL'si
folder.folderRecipientParties.folderAccessURL string

Bu alıcı için benzersiz imzalama URL'si. İmzalama bağlantısını doğrudan paylaşmak için bunu kullanın.

Güvenlik Modu
folder.folderRecipientParties.securityMode string

Bu alıcının erişimine uygulanan güvenlik modu.

Ek Açıklamalar
folder.folderRecipientParties.extraComments string

Bu alıcı için imzalama davetinde yer alan tüm ek açıklamalar.

Ad Değişikliğine İzin Ver
folder.folderRecipientParties.allowNameChange boolean

Alıcının imzalamadan önce adını değiştirmesine izin verilip verilmeyeceğini gösterir.

Ad Güncelleştirildi
folder.folderRecipientParties.signerNameUpdated boolean

Alıcının görünen adını güncelleştirip güncelleştirmediğini gösterir.

Kimlik Doğrulama Düzeyi
folder.folderRecipientParties.signerAuthenticationLevel string

Bu alıcının belgeye erişmesi için gereken kimlik doğrulama yöntemi.

Erişim Kodu
folder.folderRecipientParties.userDefinedAccessCode string

Bu alıcının belgeyi açması için gereken özel erişim kodu.

İmza Kimliği
folder.folderRecipientParties.signatureId string

Bu alıcı tarafından kullanılan kaydedilmiş imzanın kimliği.

Alıcı Rolü
folder.folderRecipientParties.partyRole string

Zarfta bu alıcıya atanan rol.

Şirket Alanı Değeri
folder.folderRecipientParties.companyFieldValue string

Bu alıcı için önceden doldurulmuş şirket alanı değeri.

Başlık Alanı Değeri
folder.folderRecipientParties.titleFieldValue string

Bu alıcı için önceden doldurulmuş başlık alanı değeri.

İmzalama Nedeni
folder.folderRecipientParties.reasonSigning string

Bu alıcı tarafından sağlanan imzalama nedeni.

Ödeme Alanı Eklendi
folder.folderRecipientParties.payFieldAdded boolean

Bu alıcı için bir ödeme alanı eklenip eklenmediğini gösterir.

Is Payee
folder.folderRecipientParties.payee boolean

Bu alıcının alacaklı olup olmadığını gösterir.

Yinelenen Alan Var
folder.folderRecipientParties.recurringFieldExist boolean

Bu alıcı için yinelenen ödeme alanlarının bulunup bulunmadığını gösterir.

Yazdırma ve İmza Tamamlandı
folder.folderRecipientParties.printAndSignCompleted boolean

Alıcının yazdırma ve imzalama eylemini tamamlayıp tamamlamadığını gösterir.

İsteğe Bağlı İmzalayana İzin Ver
folder.folderRecipientParties.allowOptionalSigner boolean

Bu alıcının isteğe bağlı imzalayan olarak atlanıp atlanmayacağını gösterir.

İsteğe Bağlı İmzalayanlar
folder.folderRecipientParties.optionalSigners string

Varsa, bu alıcıyla ilişkili isteğe bağlı imzalayanların listesi.

Paid
folder.folderRecipientParties.paid boolean

Bu alıcının ödemeyi tamamlayıp tamamlamadığını gösterir.

Yazma Erişim URL'si
folder.folderAccessURLForAuthor string

Belgeye erişmek için zarf yazarının URL'si.

Taslak Erişim URL'si
folder.draftFolderAccessURL string

Zarf taslak durumundayken zarfa erişmek için URL.

Pano Odası İşareti
folder.boardRoomSign boolean

Bu zarf için pano odası imzalamanın etkinleştirilip etkinleştirilmediğini gösterir.

Logo Ekle
folder.includeLogo boolean

Şirket logosunun e-posta bildirimlerine eklenip eklenmediğini gösterir.

E-posta Düğmesi Rengi
folder.email_btnBgColor string

İmzalama e-postasında eylem düğmesinin arka plan rengi.

E-posta Düğmesi Metin Rengi
folder.email_btnTxtColor string

İmzalama e-postasında eylem düğmesinin metin rengi.

E-posta Logosu
folder.emailTemplateLogo string

E-posta şablonunda kullanılan logo resmi.

E-posta Şablonu Kimliği
folder.emailTemplateId integer

İmzalama bildirimleri için kullanılan e-posta şablonunun kimliği.

E-posta Üst Bilgisi
folder.emailHeader string

İmzalama bildirimi e-postalarındaki özel üst bilgi metni.

E-posta Alt Bilgisi
folder.emailFooter string

İmzalama bildirimi e-postalarındaki özel alt bilgi metni.

Zamanlanmış Temizleme
folder.purgeFlag boolean

Bu zarfı otomatik temizleme için zamanlanıp zamanlanmadığını gösterir.

Başlangıç Tarihini Temizle
folder.purgeStartDate string

Temizleme döneminin başladığı tarih.

Bitiş Tarihini Temizle
folder.purgeEndDate string

Zarfın temizlendiği tarih.

Toplu Kimlik
folder.bulkId integer

Bu zarfın ait olduğu toplu gönderme toplu işleminin kimliği (varsa).

İmza Sırasını Zorla
folder.enforceSignWorkflow boolean

Alıcıların belirtilen sırada oturum açması gerekip gerekmediğini gösterir.

Geçerli İş Akışı Adımı
folder.currentWorkflowStep integer

İmzalama iş akışındaki geçerli adım.

İşlem Kaynağı
folder.transactionSource string

Bu zarf işlemini başlatan kaynak.

Düzenlenebilir
folder.editable boolean

Zarfın hala düzenlenip düzenlenemeyeceğini gösterir.

In-Person İmzalama
folder.inPersonSignable boolean

Zarfın bizzat imzalanıp imzalanamayacağını gösterir.

Anımsatıcıları Geçersiz Kıl
folder.overrideAccountReminders boolean

Bu zarf için hesap düzeyi anımsatıcı ayarlarının geçersiz kılınıp kılınmadığını gösterir.

TemsilciYi Geçersiz Kıl
folder.overrideAccountRecipientDelegation boolean

Bu zarf için hesap düzeyi temsilci ayarlarının geçersiz kılınıp kılınmadığını gösterir.

Temsilci Seçmeye İzin Ver
folder.allowRecipientsToDelegate boolean

Alıcıların imzalarını başka bir kişiye devretmesine izin verilip verilmeyeceğini gösterir.

Kimlik
folder.envelopeId integer

Zarfın benzersiz kimliği. Zarf Kimliği (folderId) ile aynı değer.

İsim
folder.envelopeName string

Zarfın adı. Zarf Adı (folderName) ile aynı değer.

Kaynak Kimliği
folder.envelopeOriginatorId integer

Zarfı oluşturan kişinin kullanıcı kimliği.

Şirket Kimliği
folder.envelopeCompanyId integer

Zarfın ait olduğu şirketin kimliği.

Date
folder.envelopeDate integer

Unix milisaniye cinsinden zarfın oluşturulduğu tarih ve saat.

Paylaşılan Tarih
folder.envelopeSharedDate integer

Zarfın unix milisaniye cinsinden alıcılarla paylaşıldığı tarih ve saat.

Status
folder.envelopeStatus string

Zarfın geçerli durumu. Zarf Durumu (folderStatus) ile aynı değer.

Sözleşme kimlikleri
folder.envelopeContractIds array of integer

Bu zarfla ilişkili sözleşme kimliklerinin listesi.

Grup İzinleri
folder.envelopePartyPermissions array of object

Alıcıların listesi ve imza izinleri. Alıcılar ile aynı yapı.

Alıcı Kimliği
folder.envelopePartyPermissions.partyId integer

Alıcının benzersiz tanımlayıcısı.

İmzalama URL'si
folder.envelopePartyPermissions.folderAccessURL string

Bu alıcı için benzersiz imzalama URL'si.

İzinler
folder.envelopePartyPermissions.contractPermissions string

Bu alıcı için imzalama izinleri.

İmzalama Sırası
folder.envelopePartyPermissions.partySequence integer

Bu alıcının imzalama sırasına göre konumu.

Kimlik Doğrulama Düzeyi
folder.envelopeAuthenticationLevel string

Zarfın tamamına uygulanan kimlik doğrulama düzeyi.

Tek İmzalayana Toplu İzin Ver
folder.allowSingleSignerInBulk boolean

Toplu gönderme modunda tek bir imzalayana izin verilip verilmeyeceğini gösterir.

DosyaYa Göre Ad
folder.folderNameBasedOnFileNaming boolean

Zarf adının dosya adından türetilip türetilmiş olmadığını gösterir.

Dosyaya Göre Belge Adı
folder.documentNameBasedOnFileNaming boolean

Belge adının dosya adından türetilip türetilmiş olmadığını gösterir.

Dosyaya Göre Sertifika Adı
folder.certificateNameBasedOnFileNaming boolean

Sertifika adının dosya adından türetilip türetilmiş olmadığını gösterir.

Dosya Adlandırmayı Etkinleştir
folder.enableFileNamingBeforeExecution boolean

Zarf gönderilmeden önce dosya adlandırma istenip istenmediğini gösterir.

Payee Eklendi
folder.payeeAddedd boolean

Zarfa bir ödeme eklenip eklenmediğini gösterir.

Kendinden İmzalayan
folder.selfSignerEnabled boolean

Gönderenin aynı zamanda bu zarfta imzalayan olup olmadığını gösterir.

Noter Etkin
folder.notaryEnabled boolean

Bu zarf için noter onayının etkinleştirilip etkinleştirilmediğini gösterir.

Sınırlı Görünürlük
folder.limitedVisibilityFlag boolean

Sınırlı belge görünürlüğünün etkinleştirilip etkinleştirilmediğini gösterir.

İmzalama Sonrası Görünürlük
folder.postSigningVisibility boolean

Alıcıların tamamlandıktan sonra imzalı belgeyi görüntüleyip görüntüleyemeyeceğini gösterir.

Islak İmza Etkin
folder.wetSignatureEnabled boolean

Bu zarf için ıslak (el yazısı) imzaların etkinleştirilip etkinleştirilmediğini gösterir.

Birleştirme Etkin
folder.mergeEnabled boolean

Bu zarf için belge birleştirmenin etkinleştirilip etkinleştirilmediğini gösterir.

Tetikleyiciler

Bir zarf gönderildiğinde

Alıcılara zarf gönderildiğinde tetikler. Bu olay yalnızca Web Kancası Düzeyi 'Hesap' olarak ayarlandığında tetikler.

Bir zarf imzalandığında

Alıcı zarfı imzaladığında tetikler.

Bir zarf silindiğinde

Zarf silindiğinde tetikler.

Bir zarf tam olarak yürütülürken

Tüm alıcılar imzaladığında ve zarf tam olarak yürütülürken tetikler.

Zarf görüntülendiğinde

Alıcı açıldığında ve zarfı görüntülediğinde tetikler.

Zarf iptal edildiğinde

Bir zarf bir alıcı veya gönderen tarafından iptal edildiğinde tetikler.

Bir zarf gönderildiğinde

Alıcılara zarf gönderildiğinde tetikler. Bu olay yalnızca Web Kancası Düzeyi 'Hesap' olarak ayarlandığında tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Adı
channelName True string

Hesabınızda bu web kancası aboneliğini tanımlamak için bir ad.

Web Kancası Düzeyi
webhookLevel True string

Hesap: Web veya API aracılığıyla gönderilen zarflar için tetikler. API Uygulaması: Yalnızca API aracılığıyla oluşturulan zarflar için tetikler. folder_sent olayı yalnızca Hesap düzeyinde tetikler.

Web Kancası Gizli Dizisi
webhookSecret string

Optional. Foxit eSign, doğrulama için bu gizli diziyi kullanarak her web kancası yükünü HMAC-SHA-256 ile imzalar.

Döndürülenler

Bir web kancası olayı tetiklendiğinde Foxit eSign'dan alınan olay verileri.

WebhookEventPayload
WebhookEventPayload

Bir zarf imzalandığında

Alıcı zarfı imzaladığında tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Adı
channelName True string

Hesabınızda bu web kancası aboneliğini tanımlamak için bir ad.

Web Kancası Düzeyi
webhookLevel True string

Hesap: Tüm zarflar (web ve API) için tetikler. API Uygulaması: Yalnızca API aracılığıyla oluşturulan zarflar için tetikler.

Web Kancası Gizli Dizisi
webhookSecret string

Optional. Foxit eSign, doğrulama için bu gizli diziyi kullanarak her web kancası yükünü HMAC-SHA-256 ile imzalar.

Döndürülenler

Bir web kancası olayı tetiklendiğinde Foxit eSign'dan alınan olay verileri.

WebhookEventPayload
WebhookEventPayload

Bir zarf silindiğinde

Zarf silindiğinde tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Adı
channelName True string

Hesabınızda bu web kancası aboneliğini tanımlamak için bir ad.

Web Kancası Düzeyi
webhookLevel True string

Hesap: Tüm zarflar (web ve API) için tetikler. API Uygulaması: Yalnızca API aracılığıyla oluşturulan zarflar için tetikler.

Web Kancası Gizli Dizisi
webhookSecret string

Optional. Foxit eSign, doğrulama için bu gizli diziyi kullanarak her web kancası yükünü HMAC-SHA-256 ile imzalar.

Döndürülenler

Bir web kancası olayı tetiklendiğinde Foxit eSign'dan alınan olay verileri.

WebhookEventPayload
WebhookEventPayload

Bir zarf tam olarak yürütülürken

Tüm alıcılar imzaladığında ve zarf tam olarak yürütülürken tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Adı
channelName True string

Hesabınızda bu web kancası aboneliğini tanımlamak için bir ad.

Web Kancası Düzeyi
webhookLevel True string

Hesap: Tüm zarflar (web ve API) için tetikler. API Uygulaması: Yalnızca API aracılığıyla oluşturulan zarflar için tetikler.

Web Kancası Gizli Dizisi
webhookSecret string

Optional. Foxit eSign, doğrulama için bu gizli diziyi kullanarak her web kancası yükünü HMAC-SHA-256 ile imzalar.

Döndürülenler

Bir web kancası olayı tetiklendiğinde Foxit eSign'dan alınan olay verileri.

WebhookEventPayload
WebhookEventPayload

Zarf görüntülendiğinde

Alıcı açıldığında ve zarfı görüntülediğinde tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Adı
channelName True string

Hesabınızda bu web kancası aboneliğini tanımlamak için bir ad.

Web Kancası Düzeyi
webhookLevel True string

Hesap: Tüm zarflar (web ve API) için tetikler. API Uygulaması: Yalnızca API aracılığıyla oluşturulan zarflar için tetikler.

Web Kancası Gizli Dizisi
webhookSecret string

Optional. Foxit eSign, doğrulama için bu gizli diziyi kullanarak her web kancası yükünü HMAC-SHA-256 ile imzalar.

Döndürülenler

Bir web kancası olayı tetiklendiğinde Foxit eSign'dan alınan olay verileri.

WebhookEventPayload
WebhookEventPayload

Zarf iptal edildiğinde

Bir zarf bir alıcı veya gönderen tarafından iptal edildiğinde tetikler.

Parametreler

Name Anahtar Gerekli Tür Description
Kanal Adı
channelName True string

Hesabınızda bu web kancası aboneliğini tanımlamak için bir ad.

Web Kancası Düzeyi
webhookLevel True string

Hesap: Tüm zarflar (web ve API) için tetikler. API Uygulaması: Yalnızca API aracılığıyla oluşturulan zarflar için tetikler.

Web Kancası Gizli Dizisi
webhookSecret string

Optional. Foxit eSign, doğrulama için bu gizli diziyi kullanarak her web kancası yükünü HMAC-SHA-256 ile imzalar.

Döndürülenler

Bir web kancası olayı tetiklendiğinde Foxit eSign'dan alınan olay verileri.

WebhookEventPayload
WebhookEventPayload

Tanımlar

WebhookEventPayload

Bir web kancası olayı tetiklendiğinde Foxit eSign'dan alınan olay verileri.

Name Yol Tür Description
Olay Adı
event_name string

Tetiklenen olayın adı (örneğin, folder_sent, folder_signed, folder_executed).

Olay Tarihi
event_date integer

Olayın gerçekleştiği tarih ve saat (milisaniye cinsinden Unix zaman damgası).

Kimlik
data.folder.folderId integer

Zarfın benzersiz kimliği.

İsim
data.folder.folderName string

Zarfın adı.

Özel Ad
data.folder.folderCustomName string

Zarfa atanan özel ad.

Şifre
data.folder.folderPassword string

Ayarlandıysa zarfın erişim parolası.

Oluşturucu Kimliği
data.folder.folderAuthorId integer

Zarf oluşturucusunun kullanıcı kimliği.

Oluşturucu Adı
data.folder.folderAuthorFirstName string

Zarfı oluşturanın adı.

Oluşturucu Soyadı
data.folder.folderAuthorLastName string

Zarf oluşturucusunun soyadı.

Oluşturucu E-postası
data.folder.folderAuthorEmail string

Zarf oluşturucusunun e-posta adresi.

Oluşturucu Rolü
data.folder.folderAuthorRole string

Zarf oluşturucusunun hesap rolü.

Şirket Kimliği
data.folder.folderCompanyId integer

Zarfın sahibi olan şirket kimliği.

Oluşturulma Tarihi
data.folder.folderCreationDate integer

Zarfın oluşturulduğu tarih (Milisaniye cinsinden Unix zaman damgası).

Gönderme Tarihi
data.folder.folderSentDate integer

Zarfın gönderildiği tarih (Milisaniye cinsinden Unix zaman damgası).

Status
data.folder.folderStatus string

Zarfın geçerli durumu.

Özel Alan 1
data.folder.custom_field1 string

İlk özel meta veri alanı.

Özel Alan 2
data.folder.custom_field2 string

İkinci özel meta veri alanı.

Meta veriler
data.folder.metadata string

Zarfla ilişkilendirilmiş özel meta veriler.

Belge Kimlikleri
data.folder.folderDocumentIds array of integer

Zarftaki belge kimliklerinin listesi.

Documents
data.folder.documentsList array of object

Zarftaki belgelerin listesi.

Belge Kimliği
data.folder.documentsList.documentId integer

Belgenin benzersiz tanımlayıcısı.

Sözleşme Kimliği
data.folder.documentsList.contractId integer

Bu belgenin sözleşme kimliği.

Şirket Kimliği
data.folder.documentsList.companyId integer

Bu belgenin şirket kimliği.

Oluşturan
data.folder.documentsList.contractCreatedBy integer

Sözleşmeyi oluşturan kişinin kullanıcı kimliği.

Oluşturulma Tarihi
data.folder.documentsList.contractCreatedOn integer

Sözleşmenin oluşturulduğu tarih (milisaniye cinsinden Unix zaman damgası).

Sözleşme Türü
data.folder.documentsList.contractType string

Sözleşmenin türü.

Sözleşme Durumu
data.folder.documentsList.contractStatus string

Sözleşmenin geçerli durumu.

Düzenlenebilir
data.folder.documentsList.editable boolean

Belgenin düzenlenebilir olup olmadığını gösterir.

Sürüm Kimliği
data.folder.documentsList.contractVersionId integer

Sözleşmenin sürüm kimliği.

Sürüm Adı
data.folder.documentsList.contractVersionName string

Sözleşme sürümünün adı.

Sürüm Açıklaması
data.folder.documentsList.contractVersionDesc string

Sözleşme sürümünün açıklaması.

Oluşturan Sürüm
data.folder.documentsList.versionCreatedby integer

Bu sürümü oluşturan kişinin kullanıcı kimliği.

Sürüm Oluşturma Tarihi
data.folder.documentsList.versionCreatedOn integer

Bu sürümün oluşturulduğu tarih (milisaniye cinsinden Unix zaman damgası).

Sürüm Numarası
data.folder.documentsList.contractVersionNumber integer

Sözleşmenin sürüm numarası.

İşlem Kaynağı
data.folder.documentsList.contractTransactionSource string

Sözleşmeyi başlatan kaynak sistem.

Alıcı
data.folder.folderRecipientParties array of object

Bu zarfın alıcı listesi.

Alıcı Kimliği
data.folder.folderRecipientParties.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
data.folder.folderRecipientParties.partyDetails.partyId integer

Alıcının benzersiz kimliği.

İlk İsim
data.folder.folderRecipientParties.partyDetails.firstName string

Alıcının adı.

Soyadı
data.folder.folderRecipientParties.partyDetails.lastName string

Alıcının soyadı.

E-posta
data.folder.folderRecipientParties.partyDetails.emailId string

Alıcının e-posta adresi.

Yer tutucu
data.folder.folderRecipientParties.partyDetails.placeholder boolean

Bunun yer tutucu alıcı olup olmadığı.

Adres
data.folder.folderRecipientParties.partyDetails.address string

Alıcının adresi.

Oluşturulma Tarihi
data.folder.folderRecipientParties.partyDetails.dateCreated integer

Alıcı kaydının oluşturulduğu tarih (milisaniye cinsinden Unix zaman damgası).

E-postaları Geri Çevir
data.folder.folderRecipientParties.partyDetails.optOutEmails boolean

Alıcının e-postaları geri çevirip geri çevirmediği.

Benzersiz Kimlik
data.folder.folderRecipientParties.partyDetails.uniquePartyId string

Bu alıcı için benzersiz bir sistem tanımlayıcısı.

Kimlik Doğrulama Düzeyi
data.folder.folderRecipientParties.partyDetails.authenticationLevel string

Bu alıcı için kimlik doğrulama yöntemi.

Parola Güncelleştirme Tarihi
data.folder.folderRecipientParties.partyDetails.passwordUpdateDate string

Parolanın son güncelleştirilildiği tarih.

Parola Durumu
data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus boolean

Parolanın güncelleştirilip güncelleştirilmediği.

Arama Kodu
data.folder.folderRecipientParties.dialingCode string

Uluslararası arama kodu.

Mobile
data.folder.folderRecipientParties.mobileNumber string

Alıcının cep telefonu numarası.

İmza Türü
data.folder.folderRecipientParties.signerSignatureType string

İmzalayanın kullanacağı imza türü.

İzinler
data.folder.folderRecipientParties.contractPermissions string

Bu alıcıya verilen izinler.

İmzalama Sırası
data.folder.folderRecipientParties.partySequence integer

Bu alıcı için imzalama sırası.

İş Akışı Dizisi
data.folder.folderRecipientParties.workflowSignSequence integer

İş akışı imzalama sırası numarası.

Zarf Kimliği
data.folder.folderRecipientParties.envelopeId integer

Bu alıcıyla ilişkili zarf kimliği.

Alıcı Şirket Kimliği
data.folder.folderRecipientParties.partyCompanyId integer

Bu alıcının şirket kimliği.

Paylaşım Modu
data.folder.folderRecipientParties.sharingMode string

Bu alıcı için paylaşım modu.

Alıcı İmzalama URL'si
data.folder.folderRecipientParties.folderAccessURL string

Bu alıcının zarfa erişmesi ve zarfı imzalaması için URL.

Güvenlik Modu
data.folder.folderRecipientParties.securityMode string

Bu alıcının güvenlik modu.

Açıklamalar
data.folder.folderRecipientParties.extraComments string

Alıcı için ek açıklamalar.

Ad Değişikliğine İzin Ver
data.folder.folderRecipientParties.allowNameChange boolean

Alıcının adını güncelleştirip güncelleştiremeyeceği.

Ad Güncelleştirildi
data.folder.folderRecipientParties.signerNameUpdated boolean

İmzalayanın adını güncelleştirip güncelleştirmediği.

İmzalayan Kimlik Doğrulama Düzeyi
data.folder.folderRecipientParties.signerAuthenticationLevel string

İmzalayan için gereken kimlik doğrulama düzeyi.

Erişim Kodu
data.folder.folderRecipientParties.userDefinedAccessCode string

İmzalayan için özel erişim kodu.

İmza Kimliği
data.folder.folderRecipientParties.signatureId string

Uygulanan imzanın kimliği.

Rol
data.folder.folderRecipientParties.partyRole string

Bu alıcının imzalama iş akışındaki rolü.

Şirket Alanı
data.folder.folderRecipientParties.companyFieldValue string

Şirket adı alan değeri.

Başlık Alanı
data.folder.folderRecipientParties.titleFieldValue string

Başlık alanı değeri.

İmzalama Nedeni
data.folder.folderRecipientParties.reasonSigning string

İmzalama nedeni.

Ödeme Alanı Eklendi
data.folder.folderRecipientParties.payFieldAdded boolean

Ödeme alanının eklenip eklenmediği.

Alacaklı
data.folder.folderRecipientParties.payee boolean

Bu alıcının alacaklı olup olmadığı.

Yinelenen Ödeme
data.folder.folderRecipientParties.recurringFieldExist boolean

Yinelenen ödeme alanının mevcut olup olmadığı.

Yazdırma ve İmza Bitti
data.folder.folderRecipientParties.printAndSignCompleted boolean

Yazdırma ve imzalama işleminin tamamlanıp tamamlanmadığı.

İsteğe Bağlı İmzalayan
data.folder.folderRecipientParties.allowOptionalSigner boolean

Bu alıcının isteğe bağlı bir imzalayan olup olmadığı.

İsteğe Bağlı İmzalayanlar
data.folder.folderRecipientParties.optionalSigners array of integer

İsteğe bağlı imzalayan taraf kimlikleri.

Paid
data.folder.folderRecipientParties.paid boolean

Ödemenin tamamlanıp tamamlanmadığı.

Yazma Erişim URL'si
data.folder.folderAccessURLForAuthor string

Zarfa erişmek için zarf yazarının URL'si.

Taslak Erişim URL'si
data.folder.draftFolderAccessURL string

Zarfa taslak durumunda erişmek için URL.

Yönetim Kurulu İmzalama
data.folder.boardRoomSign boolean

Toplantı odası imzalama modunun etkinleştirilip etkinleştirilmediği.

Logo Ekle
data.folder.includeLogo boolean

Şirket logosunun e-postalara eklenip eklenmediği.

Düğme Arka Plan Rengi
data.folder.email_btnBgColor string

E-posta eylemi düğmesinin arka plan rengi.

Düğme Metin Rengi
data.folder.email_btnTxtColor string

E-posta eylem düğmesinin metin rengi.

E-posta Logosu
data.folder.emailTemplateLogo string

E-posta şablonunda kullanılan logo URL'si.

E-posta Şablonu Kimliği
data.folder.emailTemplateId integer

Kullanılan e-posta şablonunun kimliği.

E-posta Üst Bilgisi
data.folder.emailHeader string

Bildirim e-postalarındaki üst bilgi metni.

E-posta Alt Bilgisi
data.folder.emailFooter string

Bildirim e-postalarındaki alt bilgi metni.

Zamanlanmış Temizleme
data.folder.purgeFlag boolean

Zarfın temizleme için zamanlanıp zamanlanmadığı.

Başlangıç Tarihini Temizle
data.folder.purgeStartDate string

Temizleme zamanlamasının başlangıç tarihi.

Bitiş Tarihini Temizle
data.folder.purgeEndDate string

Temizleme zamanlamasının bitiş tarihi.

Toplu Kimlik
data.folder.bulkId integer

Varsa toplu gönderme işlemi kimliği.

İmza Sırasını Zorla
data.folder.enforceSignWorkflow boolean

Alıcıların tanımlı sırada oturum açması gerekip gerekmediği.

Geçerli İş Akışı Adımı
data.folder.currentWorkflowStep integer

İmzalama iş akışındaki geçerli adım.

İşlem Kaynağı
data.folder.transactionSource string

Bu işlemi başlatan kaynak sistem.

Düzenlenebilir
data.folder.editable boolean

Zarfın düzenlenebilir olup olmadığı.

In-Person İmzalama
data.folder.inPersonSignable boolean

Zarfın bizzat imzalamayı destekleyip desteklemediği.

Anımsatıcıları Geçersiz Kıl
data.folder.overrideAccountReminders boolean

Hesap düzeyi anımsatıcı ayarlarının geçersiz kılınıp kılınmayacağı.

TemsilciYi Geçersiz Kıl
data.folder.overrideAccountRecipientDelegation boolean

Hesap düzeyi temsilci ayarlarının geçersiz kılınıp kılınmayacağı.

Temsilci Seçmeye İzin Ver
data.folder.allowRecipientsToDelegate boolean

Alıcıların imzalamayı temsilci olarak kullanıp seçemeyeceği.

Kimlik
data.folder.envelopeId integer

Benzersiz zarf kimliği (folderId diğer adı).

İsim
data.folder.envelopeName string

Zarf adı (folderName diğer adı).

Kaynak Kimliği
data.folder.envelopeOriginatorId integer

Zarfı oluşturan kullanıcı kimliği.

Şirket Kimliği
data.folder.envelopeCompanyId integer

Zarfın sahibi olan şirket kimliği.

Date
data.folder.envelopeDate integer

Zarfın oluşturulduğu tarih (Milisaniye cinsinden Unix zaman damgası).

Paylaşılan Tarih
data.folder.envelopeSharedDate integer

Zarfın paylaşıldığı tarih (milisaniye cinsinden Unix zaman damgası).

Status
data.folder.envelopeStatus string

Zarfın geçerli durumu.

Sözleşme kimlikleri
data.folder.envelopeContractIds array of integer

Bu zarfla ilişkili sözleşme kimlikleri.

Grup İzinleri
data.folder.envelopePartyPermissions array of object

Alıcı izinleri listesi (Alıcılar ile aynı yapı).

Alıcı Kimliği
data.folder.envelopePartyPermissions.partyId integer

Alıcının benzersiz tanımlayıcısı.

Alıcı Kimliği
data.folder.envelopePartyPermissions.partyDetails.partyId integer
İlk İsim
data.folder.envelopePartyPermissions.partyDetails.firstName string
Soyadı
data.folder.envelopePartyPermissions.partyDetails.lastName string
E-posta
data.folder.envelopePartyPermissions.partyDetails.emailId string
Yer tutucu
data.folder.envelopePartyPermissions.partyDetails.placeholder boolean
Adres
data.folder.envelopePartyPermissions.partyDetails.address string
Oluşturulma Tarihi
data.folder.envelopePartyPermissions.partyDetails.dateCreated integer
E-postaları Geri Çevir
data.folder.envelopePartyPermissions.partyDetails.optOutEmails boolean
Benzersiz Kimlik
data.folder.envelopePartyPermissions.partyDetails.uniquePartyId string
Kimlik Doğrulama Düzeyi
data.folder.envelopePartyPermissions.partyDetails.authenticationLevel string
Parola Güncelleştirme Tarihi
data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate string
Parola Durumu
data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus boolean
Arama Kodu
data.folder.envelopePartyPermissions.dialingCode string
Mobile
data.folder.envelopePartyPermissions.mobileNumber string
İmza Türü
data.folder.envelopePartyPermissions.signerSignatureType string
İzinler
data.folder.envelopePartyPermissions.contractPermissions string
İmzalama Sırası
data.folder.envelopePartyPermissions.partySequence integer
İş Akışı Dizisi
data.folder.envelopePartyPermissions.workflowSignSequence integer
Zarf Kimliği
data.folder.envelopePartyPermissions.envelopeId integer
Alıcı Şirket Kimliği
data.folder.envelopePartyPermissions.partyCompanyId integer
Paylaşım Modu
data.folder.envelopePartyPermissions.sharingMode string
Alıcı İmzalama URL'si
data.folder.envelopePartyPermissions.folderAccessURL string
Güvenlik Modu
data.folder.envelopePartyPermissions.securityMode string
Açıklamalar
data.folder.envelopePartyPermissions.extraComments string
Ad Değişikliğine İzin Ver
data.folder.envelopePartyPermissions.allowNameChange boolean
Ad Güncelleştirildi
data.folder.envelopePartyPermissions.signerNameUpdated boolean
İmzalayan Kimlik Doğrulama Düzeyi
data.folder.envelopePartyPermissions.signerAuthenticationLevel string
Erişim Kodu
data.folder.envelopePartyPermissions.userDefinedAccessCode string
İmza Kimliği
data.folder.envelopePartyPermissions.signatureId string
Rol
data.folder.envelopePartyPermissions.partyRole string
Şirket Alanı
data.folder.envelopePartyPermissions.companyFieldValue string
Başlık Alanı
data.folder.envelopePartyPermissions.titleFieldValue string
İmzalama Nedeni
data.folder.envelopePartyPermissions.reasonSigning string
Ödeme Alanı Eklendi
data.folder.envelopePartyPermissions.payFieldAdded boolean
Alacaklı
data.folder.envelopePartyPermissions.payee boolean
Yinelenen Ödeme
data.folder.envelopePartyPermissions.recurringFieldExist boolean
Yazdırma ve İmza Bitti
data.folder.envelopePartyPermissions.printAndSignCompleted boolean
İsteğe Bağlı İmzalayan
data.folder.envelopePartyPermissions.allowOptionalSigner boolean
İsteğe Bağlı İmzalayanlar
data.folder.envelopePartyPermissions.optionalSigners array of integer
Paid
data.folder.envelopePartyPermissions.paid boolean
Kimlik Doğrulama Düzeyi
data.folder.envelopeAuthenticationLevel string

Zarf için gereken kimlik doğrulama düzeyi.

Tek İmzalayan Toplu
data.folder.allowSingleSignerInBulk boolean

Tek bir imzalayana toplu modda izin verilip verilmeyeceği.

File-Based Klasör Adı
data.folder.folderNameBasedOnFileNaming boolean
File-Based Belge Adı
data.folder.documentNameBasedOnFileNaming boolean
File-Based Sertifika Adı
data.folder.certificateNameBasedOnFileNaming boolean
Exec Öncesi Dosya Adlandırma
data.folder.enableFileNamingBeforeExecution boolean
Payee Eklendi
data.folder.payeeAddedd boolean
Self-Signing Etkin
data.folder.selfSignerEnabled boolean
Noter Etkin
data.folder.notaryEnabled boolean
Sınırlı Görünürlük
data.folder.limitedVisibilityFlag boolean
İmza Sonrası Görünürlük
data.folder.postSigningVisibility boolean
Islak İmza
data.folder.wetSignatureEnabled boolean
Birleştirme Etkin
data.folder.mergeEnabled boolean

ikili

Bu, 'ikili' temel veri türüdür.