sproof Sign (Önizleme)

PDF ve DOCX belgeleri için güvenli elektronik imza iş akışlarını otomatikleştirmek için sproof Sign kullanın. Kuruluşlar tek veya çok belgeli imza istekleri oluşturabilir veya hazırlayabilir, alıcıları ve imzalama rollerini atayabilir, belgeleri listeleyebilir ve izleyebilir, tamamlanmış PDF'leri indirebilir ve belgeleri silebilir. Sproof Sign hesabı, seçili eylemleri ve imza türlerini destekleyen bir plan ve geçerli bir API belirteci gereklidir.

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

Service Class Bölgeler
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 API Desteği
URL https://sproof.com
E-posta support@sproof.com
Bağlayıcı Meta Verileri
Publisher sproof GmbH
Web Sitesi https://www.sproof.com/en/sign/
Gizlilik ilkesi https://www.sproof.com/en/privacy-policy-app/
Kategoriler Verimli -lik; İçerik ve Dosyalar

sproof Sign

Genel bakış

sproof Sign, kuruluşların PDF ve DOCX belgeleri için elektronik imza iş akışlarını otomatikleştirmesini sağlar. Bağlayıcı tek belgeli imza istekleri veya çok belgeli zarflar oluşturabilir veya hazırlayabilir, alıcıları ve imza rollerini atayabilir, belgeleri listeleyebilir, istek durumunu alabilir, tamamlanmış belgeleri indirebilir ve belgeleri silebilir.

Bu sürümdeki güncelleştirmeler

  • Alıcıları davet etmeden taslak oluşturmak için İmza hazırlama isteği eklendi.
  • Belgeleri listelemek, filtrelemek, sıralamak ve aramak için Belgeleri al eklendi.
  • Mevcut bağlayıcı eylemlerde hataya neden olan değişiklikler yok.

Prerequisites

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

  • Bir sproof Sign hesabı.
  • API erişimi ve gerekli eylemler ve imza türleri için destek içeren bir dayanıklı İmza planı.
  • Geçerli bir sproof Sign API belirteci.

Kimlik Doğrulaması

Bağlayıcı API belirteci kimlik doğrulamasını kullanır. Hesabınızla ilişkilendirilmiş geçerli bir sproof Sign API belirteci girerek bir bağlantı oluşturun. Belirteci güvenli tutun ve iptal edilirse veya yeniden oluşturulursa değiştirin.

Desteklenen eylemler

  • İmza isteği oluşturma — Bir belge veya birden çok belge içeren bir zarf için istek oluşturur. Alıcılar, imzalama rolleri, imzalama sırası, imza konumları ve diğer davet ayarları yapılandırılabilir.
  • Yer tutucuları kullanarak imza isteği oluşturma — Karşıya yüklenen belgede depolanan yer tutucuları kullanarak bir istek oluşturur. Alıcı bilgileri ve imza konumları bu yer tutuculardan ayıklanır.
  • İmza isteği hazırlama — Alıcıları davet etmeden bir taslak imza isteği oluşturur. Döndürülen üye kimliği, belgeyi sproof Sign düzenleyicisinde açmak ve hazırlamak için kullanılabilir.
  • Belgeleri alma — Bağlı dayanıklı İmza hesabı için kullanılabilen belgeleri listeler. Sonucu daraltmak için sayfalandırma, filtreleme, sıralama ve arama seçenekleri kullanılabilir.
  • İstek durumunu alma — Üye kimliğini kullanarak imza isteğinin geçerli durumunu ve imzalama durumunu alır.
  • Belgeyi alma — Bir belgeyi ikili PDF olarak veya Base64 kodlu PDF olarak indirir.
  • Belgeyi silme — Sağlanan üye kimliğine, üyenin rolüne ve belgenin zarfa ait olup olmadığına bağlı olarak belgeyi siler veya üyenin erişimini kaldırır.

Bilinen sınırlamalar ve gereksinimler

  • Giriş belgeleri Base64 kodlu PDF veya DOCX içeriği olarak sağlanmalıdır.
  • Zarf en fazla 25 belge içerebilir.
  • Birden fazla belge gönderildiğinde zarf adı gereklidir.
  • Yer tutucu tabanlı istekler, karşıya yüklenen belgede doğru biçimlendirilmiş yer tutucular gerektirir.
  • Yer tutucu tabanlı istekler için, alıcılar ve imza konumları el ile girmek yerine belgeden alınır.
  • Kullanılabilir eylemler, imza türleri ve sağlayıcılar bağlı sproof Sign hesabına ve planına bağlıdır.
  • Belge silme davranışı, sağlanan üye kimliğinin gönderene mi yoksa alıcıya mı ait olduğuna ve belgenin bir zarfın parçası olup olmamasına bağlıdır.

Support

Bağlayıcı veya API desteği için adresine başvurun support@sproof.com.

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
Varsayılan Bağlantı oluşturmak için parametreler. Tüm bölgeler Paylaşılamaz

Temerrüt

Geçerli: Tüm bölgeler

Bağlantı oluşturmak için parametreler.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim Türü Description Zorunlu
token securestring "token" für diese API True

Eylemler

Belgeleri alma

Api belirteci sahibi (kimliği doğrulanmış kullanıcı) tarafından oluşturulan belgeleri, bu belgelerin kullanıcı arabirimi aracılığıyla mı yoksa API aracılığıyla mı oluşturulduğundan bağımsız olarak döndürür.

Aynı planın diğer üyeleri tarafından oluşturulan belgeler dahil değildir. Planınız için rol yönetimi etkinleştirildiğinde, her kullanıcının kendi API belirteci olabilir.
Belgeyi al

İmzalı belgeyi ikili veya Base64 kodlu dize olarak alın.
Belgeyi sil

Sağlanan memberId belgenin gönderene mi yoksa alıcıya mı ait olduğuna ve belgenin bir zarfın parçası olup olmadığına bağlı olarak, belgeyi siler veya üyenin bu belgeye erişimini kaldırır.

Zarftaki belgeler

Sorgu parametresinin all zarftaki belgeler için hiçbir etkisi yoktur.

Gönderen memberIdile:

  • Gönderen ve tüm alıcılar için tek bir belge silinir.
  • Belge zarftan kaldırılır.

Alıcı memberIdile:

  • Zarftaki tüm belgeler alıcı için kaldırılır.
  • Alıcı, alıcı için silinmiş olan tüm belgelerde olarak declined işaretlenir.
  • Belgeler, belgedeki diğer tüm üyeler için kullanılabilir durumda kalır.

Tek belgeler

Gönderen memberId ve all=trueile:

  • Belge gönderen ve tüm alıcılar için silinir.

Gönderen memberId ve all=falseile:

  • Belge yalnızca gönderen için silinir.
  • Belge, belgedeki diğer alıcılar için kullanılabilir durumda kalır.

Alıcı memberIdile:

  • Alıcı belgede olarak declined işaretlenir.
  • Belge, belgedeki diğer tüm üyeler için kullanılabilir durumda kalır.
İmza isteği oluşturma

Bu yeni imza oluşturma isteğidir. Tek bir belge daveti oluşturmaya ek olarak, artık davet gönderirken zarf oluşturmayı ve aynı anda birden çok belgeyi karşıya yüklemeyi destekliyor.
İmza isteğini hazırlama

Alıcıları davet etmeden bir taslak imza isteği oluşturur. Belgeyi sproof Sign düzenleyicisinde açmak için döndürülen üye kimliğini kullanın.
İstek durumunu alma

İmza isteğinin durumunu alma. Belge JSON nesnesi veya hata döndürür. Parametre, belgedeki gönderi isteği tarafından döndürülür ve gönderenler e-postasıyla ilişkilendirilir.
Yer tutucuları kullanarak imza isteği oluşturma

Karşıya yüklenen belgede depolanan yer tutucuları kullanarak bir imza isteği oluşturur. Alıcılar ve imza konumları belgeden ayıklanır.

Belgeleri alma

İşlem Kimliği:
GetDocumentList

Api belirteci sahibi (kimliği doğrulanmış kullanıcı) tarafından oluşturulan belgeleri, bu belgelerin kullanıcı arabirimi aracılığıyla mı yoksa API aracılığıyla mı oluşturulduğundan bağımsız olarak döndürür.

Aynı planın diğer üyeleri tarafından oluşturulan belgeler dahil değildir. Planınız için rol yönetimi etkinleştirildiğinde, her kullanıcının kendi API belirteci olabilir.

Parametreler

Name Anahtar Gerekli Tür Description
Sayfa Başına Girdi sayısı
 perPage integer

Sayfa başına girdi sayısını belirtin.
Sayfa Numarası
 page integer

Sayfa numarasını belirtin.
Belge Filtresi
 view string

Belge filtresini belirtin.
Belgeleri Sırala
 sort string

Belge sıralama. Azalan sıralama için ":true" ifadesini ekleyin.
Arama Sorgusu
 query string

Çeşitli bilgiler için arama sorgusu.

Davranış:

  • Genel olarak büyük/küçük harfe duyarlı değil
  • Tek sözcük veya tırnak içine alınmış tümcecik ("Üç Aylık Rapor" gibi) alt dize eşleşmesi gerçekleştirir
  • Boşluklarla ayrılmış birden çok sözcüğün (örneğin üç aylık rapor Q1) tümünün alt dizeler (AND koşulu) olarak eşleşmesi gerekir
  • Aranan alanlar: belge adı, üye e-postaları, üye adı/soyadı, klasör adı
  • Joker karakterler/regex desteklenmez
  • İç arama dizini henüz güncelleştirilmediyse, yalnızca belge adı aranırsa
Etiket Filtresi
 labels string

Belgeleri etiket adına göre filtreleyin.
Oluşturma Tarihi:
 startDate date-time

Belirli bir createdAt tarih ve saatinden başlayan sonuçları UTC biçiminde filtreler (updatedAt tarafından filtrelenmez). Bir zaman aralığı tanımlamak için bu parametreyi 'endDate' ile birlikte kullanın.
Oluşturana Kadar
 endDate date-time

Belirli bir createdAt tarih ve saatiyle biten sonuçları UTC biçiminde filtreler (updatedAt tarafından filtrelenmez). Bir zaman aralığı tanımlamak için bu parametreyi 'startDate' ile birlikte kullanın.

Döndürülenler

Belge listesi işlemleri için yanıt nesnesi

Belge Listesi Yanıtı
_DocumentListResponse

Belgeyi al

İşlem Kimliği:
GetDocument

İmzalı belgeyi ikili veya Base64 kodlu dize olarak alın.

Parametreler

Name Anahtar Gerekli Tür Description
Üye Kimliği
 memberId True string

Üye Kimliği
İndirme biçimi
 format string

Yanıt biçimini belirtir. İkili PDF ve pdf Base64 kodlu yanıt için kullanınbase64. Örnek base64 yanıt: json { "base64": "JVBERi0xLjQKJe..." }

Döndürülenler

Name Yol Tür Description
base64
 base64 string

Base64 ile kodlanmış PDF içeriği

Belgeyi sil

İşlem Kimliği:
DeleteDocument

Sağlanan memberId belgenin gönderene mi yoksa alıcıya mı ait olduğuna ve belgenin bir zarfın parçası olup olmadığına bağlı olarak, belgeyi siler veya üyenin bu belgeye erişimini kaldırır.

Zarftaki belgeler

Sorgu parametresinin all zarftaki belgeler için hiçbir etkisi yoktur.

Gönderen memberIdile:

  • Gönderen ve tüm alıcılar için tek bir belge silinir.
  • Belge zarftan kaldırılır.

Alıcı memberIdile:

  • Zarftaki tüm belgeler alıcı için kaldırılır.
  • Alıcı, alıcı için silinmiş olan tüm belgelerde olarak declined işaretlenir.
  • Belgeler, belgedeki diğer tüm üyeler için kullanılabilir durumda kalır.

Tek belgeler

Gönderen memberId ve all=trueile:

  • Belge gönderen ve tüm alıcılar için silinir.

Gönderen memberId ve all=falseile:

  • Belge yalnızca gönderen için silinir.
  • Belge, belgedeki diğer alıcılar için kullanılabilir durumda kalır.

Alıcı memberIdile:

  • Alıcı belgede olarak declined işaretlenir.
  • Belge, belgedeki diğer tüm üyeler için kullanılabilir durumda kalır.

Parametreler

Name Anahtar Gerekli Tür Description
Üye Kimliği
 memberId True string

Üye Kimliği
Tüm alıcılar için sil
 all boolean

Yalnızca sağlanan memberId belge gönderene ait olduğunda tek belgeler için geçerlidir. olarak ayarlanırsa true, belge gönderen ve tüm alıcılar için silinir. olarak ayarlanırsa false, belge yalnızca gönderen için silinir ve diğer alıcılar için kullanılabilir durumda kalır. Bu parametre, zarftaki (varsayılan = true) veya sağlanan memberId bir alıcıya ait olduğunda belgeler için hiçbir etkiye sahip değildir.

Döndürülenler

response
DeleteDocumentResponse

İmza isteği oluşturma

İşlem Kimliği:
CreateSignatureRequest

Bu yeni imza oluşturma isteğidir. Tek bir belge daveti oluşturmaya ek olarak, artık davet gönderirken zarf oluşturmayı ve aynı anda birden çok belgeyi karşıya yüklemeyi destekliyor.

Parametreler

Name Anahtar Gerekli Tür Description
email
 email True string

Gönderenin e-postası. Planınızın bir üyesine ait olmalıdır.
firstName
 firstName True string

Gönderenin adı.
lastName
 lastName string

Gönderenin soyadı.
role
 role string

Gönderenin tüm belgelerdeki rolü.
email
 email string

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

Alıcının adı.
lastName
 lastName string

Alıcının soyadı.
doNotSendEmails
 doNotSendEmails boolean

Alıcıya true e-posta gönderilmez olarak ayarlanırsa.
customId
 customId string

Yalnızca davet sırasında alıcının e-posta adresi bilinmediğinde kullanılır. Bu yalnızca alıcıları davet ettiğinizde (yolları hazırlamak için değil) ve fastlane kullanmak istediğinizde çalışır. , customId davet göndermeden önce alıcı için önceden benzersiz bir imzalama bağlantısı oluşturmanıza olanak tanır. En az 70 karakterden oluşan benzersiz, alfasayısal bir dize olmalıdır.

Not: customId yalnızca bir belgenin alıcı bağlantısını oluşturmak için kullanılabilir. memberId yerine diğer istekler için kullanılamaz. URL oluşturma hakkında ayrıntılı bilgi için bkz. Özel Kimlikle belge açma
useFastlane
 useFastlane boolean

İmzalayan olarak true ayarlanırsa, davet e-postasında bir Fastlane bağlantısı alır.
phoneNumber
 phoneNumber string

Bu alıcının telefon numarası. Bu, SMS doğrulaması için kullanılır. (örneğin: +43 699 1234 1234).
privateMessage
 privateMessage string

Bu alıcı için özel bir ileti.
inPersonMode
 inPersonMode boolean

Bu seçenek etkinleştirildiğinde, imza isteğinin alıcısının belgeyi bizzat imzalaması gerekir ve e-posta gönderilmez. Bu mod yalnızca SES imza türü kullanılarak kullanılabilir
signatureTypes
 signatureTypes array of string

Bu alıcı için izin verilen imza türü. En fazla bir değer desteklenir. Seçenekler: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag
 tag string

Bu etiket, imzalama işlemi için kullanılacak kimlik sağlayıcısını belirler. Önceden tanımlanmış bir desteklenen sağlayıcı kümesi arasından seçim yapın.

Not1: Bazı sağlayıcılar yalnızca belirli signatureType'lar için kullanılabilir, örneğin onetimeqes"signatureType" : ["qualifiedPlusIdent"]

Not2: Varsayılan sağlayıcı olarak kullanıldığında sproof-qualified , alıcının etkin bir User+ lisansına sahip etkin bir dayanıklı hesaba sahip olması gerekir.
canChange
 canChange boolean

Davet edilen alıcının imza sağlayıcısını değiştirip değiştiremeyeceğini belirten Boole değeri
country
 country string

Varsayılan ülke, boşsa tümü olarak ayarlanırsa, sağlayıcı etiketi için hangi ülkelerin kullanılabilir olduğuyla ilgili bir hata döndürülür
dueDate
 dueDate YYYY-MM-DD

Belgenin imzalanabileceği tarih. Bu son tarih, davet e-postasında alıcıya görüntülenir ve panonun belge ayrıntıları bölümünde de görünür. İmzalama işlemini tamamlamak için bir son tarih görevi görür.
reminderInterval
 reminderInterval number

Anımsatıcı e-postaları arasındaki gün sayısını belirtir.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Anımsatıcıların gönderileceği tarih
inviteLanguage
 inviteLanguage string

Hesabı olmayan anonim kullanıcılara gönderilen e-postaların dilini belirtir. Hesabı olan kullanıcılar için, bunun yerine profillerinde seçtikleri dil kullanılır.
message
 message string

E-posta içindeki alıcılara gönderilen özel bir ileti.
konu
 subject string

Alıcılara gönderilen e-postanın konu satırı.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

True olarak ayarlanırsa, pdf belgedeki tüm alıcılara ek olarak gönderilir (5 MB'tan küçükse).
focusedSigningMode
 focusedSigningMode boolean

Bu seçenek etkinleştirildiğinde, imza isteğinin alıcısı belgeyi imzalama veya azaltmayla sınırlı olur ve sayfadan uzaklaşamaz.
allowForwarding
 allowForwarding boolean

Davetin iletilmesine izin verin.
collabSigningMode
 collabSigningMode object

Her anahtarın bir imzalama turunu temsil ettiği ve buna karşılık gelen değerin bu tur için işbirliğine dayalı imzalamanın etkinleştirilip etkinleştirilmediğini gösteren nesne. Değer true ise, belirtilen imzalama turunu tamamlamak ve bir sonraki tura geçmek için yalnızca bir imza gerekir. Örneğin, { '1': true }, '1' imzalama turunda yalnızca bir imzanın gerekli olduğu anlamına gelir.
usePlaceholders
 usePlaceholders boolean

Doğruysa, belge içinde depolanan metin yer tutucuları/formField'ler alıcıları davet etme için kullanılacaktır.
inPersonSigning
 inPersonSigning boolean

Doğru olduğunda, alıcı el ile imza çizmesi gereken bir açılır pencere alır
folderName
 folderName string

Verilirse, documentDataArray içindeki tüm belgeleri içeren bir zarf oluşturulur. (Birden fazla belge gönderilirse gereklidir)
callbackUrl
 callbackUrl string

Yeni imza oluşturulduğunda veya alıcı belgeyi reddettiyse, belge dahil olmak üzere bir POST isteği bu URL'ye gönderilir. Hata durumunda, isteğin yeniden denendiğinden emin olmak için bir yeniden deneme mekanizması uygulanır.
returnUrl
 returnUrl string

Belgeyi imzaladıktan sonra iade düğmesinin bağlantısı
returnBtnText
 returnBtnText string

Belgeyi imzaladıktan sonra dönüş düğmesinin metni
data
 data True string

Base64 biçimindeki belge (PDF veya DOCX) verileri.
mimetype
 mimetype string

Belge pdf değilse gerekli olan base64 kodlanmış veri PDF veya DOCX MIME türü
fileName
 fileName True string

Dosyanın adı
label
 label string

Belgeleri düzenlemek için gönderilebilen özel bir etiket.
sayfa
 page True integer

İlk sayfa 0 olacak şekilde, kutunun açık olduğu sayfanın sayısı.
Pagewidth
 pageWidth number

Sayfa genişliğini açıklayan herhangi bir tamsayı değeri. Sayı ne kadar büyükse, kutuyu x y alanına yerleştirirken duyarlık o kadar iyi olur. A4 sayfasında varsayılan değer olarak 478 değerimiz vardır.
pageHeight
 pageHeight number

Sayfa yüksekliğini açıklayan herhangi bir tamsayı değeri. Sayı ne kadar büyükse, kutuyu x y alanına yerleştirirken duyarlık o kadar iyi olur. A4 sayfasında, varsayılan değer olarak 676'mız vardır.
x
 x True float

Kutunun yatay konumunu sayfa genişliğinin yüzdesi olarak temsil eder. Çıkış noktası (0,0), sayfanın sol üst kısmındadır. 0,1 değeri, kutunun sayfa genişliğinin 10% soldan konumlandırılmış olduğu anlamına gelir.
y
 y True float

Sayfanın yüksekliğinin yüzdesi olarak kutunun dikey konumunu temsil eder. Çıkış noktası (0,0), sayfanın sol üst kısmındadır. 0,1 değeri, kutunun sayfa yüksekliğinin en üstünden 10% konumlandırılmış olduğu anlamına gelir.
width
 width True float

X ve y koordinatlarına benzer şekilde sayfa boyutlarına göre kutunun genişliği. PageWidth yüzdesini temsil eden bir float değeridir.
height
 height True float

X ve y koordinatlarına benzer şekilde sayfa boyutlarına göre kutunun yüksekliği. PageHeight yüzdesini temsil eden bir float değeridir.
kimlik
 id True string

Bu kutu için istediğiniz şekilde oluşturulan benzersiz bir kimlik.
label
 label string

Alanın adı gibi yer tutucu metin; örneğin, "Doğum Tarihi.".
value
 value string

Kutu için varsayılan değer. Null olabilir. Kutu 'chooseBox' türündeyse değer null veya seçeneklerde tanımlanan dizelerden biri olabilir.
fieldId
 fieldId string

Kullanıcı arabiriminde yapılandırılmış kararlı bir alan tanımlayıcısı. API istekleri aracılığıyla iş akışı formu alanlarını önceden doldurmak için kullanılır.
yalnızca okumalı
 readonly boolean

True olarak ayarlanırsa, davet edilen kişi bu kutunun değerini değiştiremez.
required
 required boolean

True olarak ayarlanırsa, davet edilen kişi bu kutuyu doldurmadan belgeyi imzalayamaz.
type
 type True string
çok satırlı
 multiline boolean

Birden çok satıra izin verilip verilmeyeceği.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Her radyo kutusu bir gruba atanabilir.
signatureTypes
 signatureTypes array of string

Bu belge için izin verilen imza türü, alıcı imza türü tarafından üzerine yazılabilir. En fazla bir değer desteklenir. Seçenekler: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId
 refId string

refId, karşıya yüklenen belgeye çapraz başvuru yapmak için kullanılan isteğe bağlı bir alandır. Sağlanırsa, belgeye özel bir başvuru tanımlayıcısı atamanıza olanak tanır. Bu tanımlayıcı, gelecekteki API yanıtlarında belge nesnesinin bir parçası olarak döndürülür. Bu, belgeleri bir dış sisteme veya iş akışına göre izlemek veya düzenlemek için yararlı olabilir.
language
 language string

Belge dili.
folderId
 folderId string

Belgelerin eklenmesi gereken klasörün kimliği. Bu yalnızca hem inviteData hem de folderName tanımlanmamışsa mümkündür.
isAttachment
 isAttachment boolean

isAttachment bu durumda gerekli değildir.
Alıcı ayrıntıları
 recipientDetails True object

Alıcı e-postası tarafından anahtarlanan alıcı ayrıntıları. Örnek: {""mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0,55,"y":0,80,"width":0,25,"height":0,08}]}}.
useFastlane
 useFastlane boolean

İmzalayan olarak true ayarlanırsa, davet e-postasında bir Fastlane bağlantısı alır.
fastlaneProfileId
 fastlaneProfileId uuid

Bu belgeyle birlikte kullanılması gereken Fastlane profilini belirtin. (useFastlane true olarak ayarlanmalıdır).

Döndürülenler

Body
EnvelopeResponse

İmza isteğini hazırlama

İşlem Kimliği:
PrepareSignatureRequest

Alıcıları davet etmeden bir taslak imza isteği oluşturur. Belgeyi sproof Sign düzenleyicisinde açmak için döndürülen üye kimliğini kullanın.

Parametreler

Name Anahtar Gerekli Tür Description
email
 email True string

Gönderenin e-postası. Planınızın bir üyesine ait olmalıdır.
firstName
 firstName True string

Gönderenin adı.
lastName
 lastName string

Gönderenin soyadı.
role
 role string

Gönderenin tüm belgelerdeki rolü.
email
 email string

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

Alıcının adı.
lastName
 lastName string

Alıcının soyadı.
doNotSendEmails
 doNotSendEmails boolean

Alıcıya true e-posta gönderilmez olarak ayarlanırsa.
customId
 customId string

Yalnızca davet sırasında alıcının e-posta adresi bilinmediğinde kullanılır. Bu yalnızca alıcıları davet ettiğinizde (yolları hazırlamak için değil) ve fastlane kullanmak istediğinizde çalışır. , customId davet göndermeden önce alıcı için önceden benzersiz bir imzalama bağlantısı oluşturmanıza olanak tanır. En az 70 karakterden oluşan benzersiz, alfasayısal bir dize olmalıdır.

Not: customId yalnızca bir belgenin alıcı bağlantısını oluşturmak için kullanılabilir. memberId yerine diğer istekler için kullanılamaz. URL oluşturma hakkında ayrıntılı bilgi için bkz. Özel Kimlikle belge açma
useFastlane
 useFastlane boolean

İmzalayan olarak true ayarlanırsa, davet e-postasında bir Fastlane bağlantısı alır.
phoneNumber
 phoneNumber string

Bu alıcının telefon numarası. Bu, SMS doğrulaması için kullanılır. (örneğin: +43 699 1234 1234).
privateMessage
 privateMessage string

Bu alıcı için özel bir ileti.
inPersonMode
 inPersonMode boolean

Bu seçenek etkinleştirildiğinde, imza isteğinin alıcısının belgeyi bizzat imzalaması gerekir ve e-posta gönderilmez. Bu mod yalnızca SES imza türü kullanılarak kullanılabilir
signatureTypes
 signatureTypes array of string

Bu alıcı için izin verilen imza türü. En fazla bir değer desteklenir. Seçenekler: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag
 tag string

Bu etiket, imzalama işlemi için kullanılacak kimlik sağlayıcısını belirler. Önceden tanımlanmış bir desteklenen sağlayıcı kümesi arasından seçim yapın.

Not1: Bazı sağlayıcılar yalnızca belirli signatureType'lar için kullanılabilir, örneğin onetimeqes"signatureType" : ["qualifiedPlusIdent"]

Not2: Varsayılan sağlayıcı olarak kullanıldığında sproof-qualified , alıcının etkin bir User+ lisansına sahip etkin bir dayanıklı hesaba sahip olması gerekir.
canChange
 canChange boolean

Davet edilen alıcının imza sağlayıcısını değiştirip değiştiremeyeceğini belirten Boole değeri
country
 country string

Varsayılan ülke, boşsa tümü olarak ayarlanırsa, sağlayıcı etiketi için hangi ülkelerin kullanılabilir olduğuyla ilgili bir hata döndürülür
dueDate
 dueDate YYYY-MM-DD

Belgenin imzalanabileceği tarih. Bu son tarih, davet e-postasında alıcıya görüntülenir ve panonun belge ayrıntıları bölümünde de görünür. İmzalama işlemini tamamlamak için bir son tarih görevi görür.
reminderInterval
 reminderInterval number

Anımsatıcı e-postaları arasındaki gün sayısını belirtir.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Anımsatıcıların gönderileceği tarih
inviteLanguage
 inviteLanguage string

Hesabı olmayan anonim kullanıcılara gönderilen e-postaların dilini belirtir. Hesabı olan kullanıcılar için, bunun yerine profillerinde seçtikleri dil kullanılır.
message
 message string

E-posta içindeki alıcılara gönderilen özel bir ileti.
konu
 subject string

Alıcılara gönderilen e-postanın konu satırı.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

True olarak ayarlanırsa, pdf belgedeki tüm alıcılara ek olarak gönderilir (5 MB'tan küçükse).
focusedSigningMode
 focusedSigningMode boolean

Bu seçenek etkinleştirildiğinde, imza isteğinin alıcısı belgeyi imzalama veya azaltmayla sınırlı olur ve sayfadan uzaklaşamaz.
allowForwarding
 allowForwarding boolean

Davetin iletilmesine izin verin.
collabSigningMode
 collabSigningMode object

Her anahtarın bir imzalama turunu temsil ettiği ve buna karşılık gelen değerin bu tur için işbirliğine dayalı imzalamanın etkinleştirilip etkinleştirilmediğini gösteren nesne. Değer true ise, belirtilen imzalama turunu tamamlamak ve bir sonraki tura geçmek için yalnızca bir imza gerekir. Örneğin, { '1': true }, '1' imzalama turunda yalnızca bir imzanın gerekli olduğu anlamına gelir.
usePlaceholders
 usePlaceholders boolean

Doğruysa, belge içinde depolanan metin yer tutucuları/formField'ler alıcıları davet etme için kullanılacaktır.
inPersonSigning
 inPersonSigning boolean

Doğru olduğunda, alıcı el ile imza çizmesi gereken bir açılır pencere alır
folderName
 folderName string

Verilirse, documentDataArray içindeki tüm belgeleri içeren bir zarf oluşturulur. (Birden fazla belge gönderilirse gereklidir)
callbackUrl
 callbackUrl string

Yeni imza oluşturulduğunda veya alıcı belgeyi reddettiyse, belge dahil olmak üzere bir POST isteği bu URL'ye gönderilir. Hata durumunda, isteğin yeniden denendiğinden emin olmak için bir yeniden deneme mekanizması uygulanır.
returnUrl
 returnUrl string

Belgeyi imzaladıktan sonra iade düğmesinin bağlantısı
returnBtnText
 returnBtnText string

Belgeyi imzaladıktan sonra dönüş düğmesinin metni
data
 data True string

Base64 biçimindeki belge (PDF veya DOCX) verileri.
mimetype
 mimetype string

Belge pdf değilse gerekli olan base64 kodlanmış veri PDF veya DOCX MIME türü
fileName
 fileName True string

Dosyanın adı
label
 label string

Belgeleri düzenlemek için gönderilebilen özel bir etiket.
sayfa
 page True integer

İlk sayfa 0 olacak şekilde, kutunun açık olduğu sayfanın sayısı.
Pagewidth
 pageWidth number

Sayfa genişliğini açıklayan herhangi bir tamsayı değeri. Sayı ne kadar büyükse, kutuyu x y alanına yerleştirirken duyarlık o kadar iyi olur. A4 sayfasında varsayılan değer olarak 478 değerimiz vardır.
pageHeight
 pageHeight number

Sayfa yüksekliğini açıklayan herhangi bir tamsayı değeri. Sayı ne kadar büyükse, kutuyu x y alanına yerleştirirken duyarlık o kadar iyi olur. A4 sayfasında, varsayılan değer olarak 676'mız vardır.
x
 x True float

Kutunun yatay konumunu sayfa genişliğinin yüzdesi olarak temsil eder. Çıkış noktası (0,0), sayfanın sol üst kısmındadır. 0,1 değeri, kutunun sayfa genişliğinin 10% soldan konumlandırılmış olduğu anlamına gelir.
y
 y True float

Sayfanın yüksekliğinin yüzdesi olarak kutunun dikey konumunu temsil eder. Çıkış noktası (0,0), sayfanın sol üst kısmındadır. 0,1 değeri, kutunun sayfa yüksekliğinin en üstünden 10% konumlandırılmış olduğu anlamına gelir.
width
 width True float

X ve y koordinatlarına benzer şekilde sayfa boyutlarına göre kutunun genişliği. PageWidth yüzdesini temsil eden bir float değeridir.
height
 height True float

X ve y koordinatlarına benzer şekilde sayfa boyutlarına göre kutunun yüksekliği. PageHeight yüzdesini temsil eden bir float değeridir.
kimlik
 id True string

Bu kutu için istediğiniz şekilde oluşturulan benzersiz bir kimlik.
label
 label string

Alanın adı gibi yer tutucu metin; örneğin, "Doğum Tarihi.".
value
 value string

Kutu için varsayılan değer. Null olabilir. Kutu 'chooseBox' türündeyse değer null veya seçeneklerde tanımlanan dizelerden biri olabilir.
fieldId
 fieldId string

Kullanıcı arabiriminde yapılandırılmış kararlı bir alan tanımlayıcısı. API istekleri aracılığıyla iş akışı formu alanlarını önceden doldurmak için kullanılır.
yalnızca okumalı
 readonly boolean

True olarak ayarlanırsa, davet edilen kişi bu kutunun değerini değiştiremez.
required
 required boolean

True olarak ayarlanırsa, davet edilen kişi bu kutuyu doldurmadan belgeyi imzalayamaz.
type
 type True string
çok satırlı
 multiline boolean

Birden çok satıra izin verilip verilmeyeceği.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Her radyo kutusu bir gruba atanabilir.
signatureTypes
 signatureTypes array of string

Bu belge için izin verilen imza türü, alıcı imza türü tarafından üzerine yazılabilir. En fazla bir değer desteklenir. Seçenekler: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId
 refId string

refId, karşıya yüklenen belgeye çapraz başvuru yapmak için kullanılan isteğe bağlı bir alandır. Sağlanırsa, belgeye özel bir başvuru tanımlayıcısı atamanıza olanak tanır. Bu tanımlayıcı, gelecekteki API yanıtlarında belge nesnesinin bir parçası olarak döndürülür. Bu, belgeleri bir dış sisteme veya iş akışına göre izlemek veya düzenlemek için yararlı olabilir.
language
 language string

Belge dili.
folderId
 folderId string

Belgelerin eklenmesi gereken klasörün kimliği. Bu yalnızca hem inviteData hem de folderName tanımlanmamışsa mümkündür.
isAttachment
 isAttachment boolean

isAttachment bu durumda gerekli değildir.
Alıcı ayrıntıları
 recipientDetails True object

Alıcı e-postası tarafından anahtarlanan alıcı ayrıntıları. Örnek: {""mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0,55,"y":0,80,"width":0,25,"height":0,08}]}}.
useFastlane
 useFastlane boolean

İmzalayan olarak true ayarlanırsa, davet e-postasında bir Fastlane bağlantısı alır.
fastlaneProfileId
 fastlaneProfileId uuid

Bu belgeyle birlikte kullanılması gereken Fastlane profilini belirtin. (useFastlane true olarak ayarlanmalıdır).

Döndürülenler

Body
PrepareSignatureRequestResponse

İstek durumunu alma

İşlem Kimliği:
GetSignatureStatus

İmza isteğinin durumunu alma. Belge JSON nesnesi veya hata döndürür. Parametre, belgedeki gönderi isteği tarafından döndürülür ve gönderenler e-postasıyla ilişkilendirilir.

Parametreler

Name Anahtar Gerekli Tür Description
Üye Kimliği
 memberId True string

Üye Kimliği

Döndürülenler

Body
DocumentStatusForFlow

Yer tutucuları kullanarak imza isteği oluşturma

İşlem Kimliği:
CreateSignatureRequestUsingPlaceholders

Karşıya yüklenen belgede depolanan yer tutucuları kullanarak bir imza isteği oluşturur. Alıcılar ve imza konumları belgeden ayıklanır.

Parametreler

Name Anahtar Gerekli Tür Description
email
 email True string

Gönderenin e-postası. Planınızın bir üyesine ait olmalıdır.
firstName
 firstName True string

Gönderenin adı.
lastName
 lastName string

Gönderenin soyadı.
role
 role string

Gönderenin tüm belgelerdeki rolü.
email
 email string

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

Alıcının adı.
lastName
 lastName string

Alıcının soyadı.
doNotSendEmails
 doNotSendEmails boolean

Alıcıya true e-posta gönderilmez olarak ayarlanırsa.
customId
 customId string

Yalnızca davet sırasında alıcının e-posta adresi bilinmediğinde kullanılır. Bu yalnızca alıcıları davet ettiğinizde (yolları hazırlamak için değil) ve fastlane kullanmak istediğinizde çalışır. , customId davet göndermeden önce alıcı için önceden benzersiz bir imzalama bağlantısı oluşturmanıza olanak tanır. En az 70 karakterden oluşan benzersiz, alfasayısal bir dize olmalıdır.

Not: customId yalnızca bir belgenin alıcı bağlantısını oluşturmak için kullanılabilir. memberId yerine diğer istekler için kullanılamaz. URL oluşturma hakkında ayrıntılı bilgi için bkz. Özel Kimlikle belge açma
useFastlane
 useFastlane boolean

İmzalayan olarak true ayarlanırsa, davet e-postasında bir Fastlane bağlantısı alır.
phoneNumber
 phoneNumber string

Bu alıcının telefon numarası. Bu, SMS doğrulaması için kullanılır. (örneğin: +43 699 1234 1234).
privateMessage
 privateMessage string

Bu alıcı için özel bir ileti.
inPersonMode
 inPersonMode boolean

Bu seçenek etkinleştirildiğinde, imza isteğinin alıcısının belgeyi bizzat imzalaması gerekir ve e-posta gönderilmez. Bu mod yalnızca SES imza türü kullanılarak kullanılabilir
signatureTypes
 signatureTypes array of string

Bu alıcı için izin verilen imza türü. En fazla bir değer desteklenir. Seçenekler: 'advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'
tag
 tag string

Bu etiket, imzalama işlemi için kullanılacak kimlik sağlayıcısını belirler. Önceden tanımlanmış bir desteklenen sağlayıcı kümesi arasından seçim yapın.

Not1: Bazı sağlayıcılar yalnızca belirli signatureType'lar için kullanılabilir, örneğin onetimeqes"signatureType" : ["qualifiedPlusIdent"]

Not2: Varsayılan sağlayıcı olarak kullanıldığında sproof-qualified , alıcının etkin bir User+ lisansına sahip etkin bir dayanıklı hesaba sahip olması gerekir.
canChange
 canChange boolean

Davet edilen alıcının imza sağlayıcısını değiştirip değiştiremeyeceğini belirten Boole değeri
country
 country string

Varsayılan ülke, boşsa tümü olarak ayarlanırsa, sağlayıcı etiketi için hangi ülkelerin kullanılabilir olduğuyla ilgili bir hata döndürülür
dueDate
 dueDate YYYY-MM-DD

Belgenin imzalanabileceği tarih. Bu son tarih, davet e-postasında alıcıya görüntülenir ve panonun belge ayrıntıları bölümünde de görünür. İmzalama işlemini tamamlamak için bir son tarih görevi görür.
reminderInterval
 reminderInterval number

Anımsatıcı e-postaları arasındaki gün sayısını belirtir.
startSendingReminders
 startSendingReminders YYYY-MM-DD HH:MM

Anımsatıcıların gönderileceği tarih
inviteLanguage
 inviteLanguage string

Hesabı olmayan anonim kullanıcılara gönderilen e-postaların dilini belirtir. Hesabı olan kullanıcılar için, bunun yerine profillerinde seçtikleri dil kullanılır.
message
 message string

E-posta içindeki alıcılara gönderilen özel bir ileti.
konu
 subject string

Alıcılara gönderilen e-postanın konu satırı.
sendOutFinishedPdf
 sendOutFinishedPdf boolean

True olarak ayarlanırsa, pdf belgedeki tüm alıcılara ek olarak gönderilir (5 MB'tan küçükse).
focusedSigningMode
 focusedSigningMode boolean

Bu seçenek etkinleştirildiğinde, imza isteğinin alıcısı belgeyi imzalama veya azaltmayla sınırlı olur ve sayfadan uzaklaşamaz.
allowForwarding
 allowForwarding boolean

Davetin iletilmesine izin verin.
collabSigningMode
 collabSigningMode object

Her anahtarın bir imzalama turunu temsil ettiği ve buna karşılık gelen değerin bu tur için işbirliğine dayalı imzalamanın etkinleştirilip etkinleştirilmediğini gösteren nesne. Değer true ise, belirtilen imzalama turunu tamamlamak ve bir sonraki tura geçmek için yalnızca bir imza gerekir. Örneğin, { '1': true }, '1' imzalama turunda yalnızca bir imzanın gerekli olduğu anlamına gelir.
inPersonSigning
 inPersonSigning boolean

Doğru olduğunda, alıcı el ile imza çizmesi gereken bir açılır pencere alır
folderName
 folderName string

Verilirse, documentDataArray içindeki tüm belgeleri içeren bir zarf oluşturulur. (Birden fazla belge gönderilirse gereklidir)
callbackUrl
 callbackUrl string

Yeni imza oluşturulduğunda veya alıcı belgeyi reddettiyse, belge dahil olmak üzere bir POST isteği bu URL'ye gönderilir. Hata durumunda, isteğin yeniden denendiğinden emin olmak için bir yeniden deneme mekanizması uygulanır.
returnUrl
 returnUrl string

Belgeyi imzaladıktan sonra iade düğmesinin bağlantısı
returnBtnText
 returnBtnText string

Belgeyi imzaladıktan sonra dönüş düğmesinin metni
data
 data True string

Base64 biçimindeki belge (PDF veya DOCX) verileri.
mimetype
 mimetype string

Belge pdf değilse gerekli olan base64 kodlanmış veri PDF veya DOCX MIME türü
fileName
 fileName True string

Dosyanın adı
label
 label string

Belgeleri düzenlemek için gönderilebilen özel bir etiket.
sayfa
 page True integer

İlk sayfa 0 olacak şekilde, kutunun açık olduğu sayfanın sayısı.
Pagewidth
 pageWidth number

Sayfa genişliğini açıklayan herhangi bir tamsayı değeri. Sayı ne kadar büyükse, kutuyu x y alanına yerleştirirken duyarlık o kadar iyi olur. A4 sayfasında varsayılan değer olarak 478 değerimiz vardır.
pageHeight
 pageHeight number

Sayfa yüksekliğini açıklayan herhangi bir tamsayı değeri. Sayı ne kadar büyükse, kutuyu x y alanına yerleştirirken duyarlık o kadar iyi olur. A4 sayfasında, varsayılan değer olarak 676'mız vardır.
x
 x True float

Kutunun yatay konumunu sayfa genişliğinin yüzdesi olarak temsil eder. Çıkış noktası (0,0), sayfanın sol üst kısmındadır. 0,1 değeri, kutunun sayfa genişliğinin 10% soldan konumlandırılmış olduğu anlamına gelir.
y
 y True float

Sayfanın yüksekliğinin yüzdesi olarak kutunun dikey konumunu temsil eder. Çıkış noktası (0,0), sayfanın sol üst kısmındadır. 0,1 değeri, kutunun sayfa yüksekliğinin en üstünden 10% konumlandırılmış olduğu anlamına gelir.
width
 width True float

X ve y koordinatlarına benzer şekilde sayfa boyutlarına göre kutunun genişliği. PageWidth yüzdesini temsil eden bir float değeridir.
height
 height True float

X ve y koordinatlarına benzer şekilde sayfa boyutlarına göre kutunun yüksekliği. PageHeight yüzdesini temsil eden bir float değeridir.
kimlik
 id True string

Bu kutu için istediğiniz şekilde oluşturulan benzersiz bir kimlik.
label
 label string

Alanın adı gibi yer tutucu metin; örneğin, "Doğum Tarihi.".
value
 value string

Kutu için varsayılan değer. Null olabilir. Kutu 'chooseBox' türündeyse değer null veya seçeneklerde tanımlanan dizelerden biri olabilir.
fieldId
 fieldId string

Kullanıcı arabiriminde yapılandırılmış kararlı bir alan tanımlayıcısı. API istekleri aracılığıyla iş akışı formu alanlarını önceden doldurmak için kullanılır.
yalnızca okumalı
 readonly boolean

True olarak ayarlanırsa, davet edilen kişi bu kutunun değerini değiştiremez.
required
 required boolean

True olarak ayarlanırsa, davet edilen kişi bu kutuyu doldurmadan belgeyi imzalayamaz.
type
 type True string
çok satırlı
 multiline boolean

Birden çok satıra izin verilip verilmeyeceği.
displayValue
 displayValue True string
exportValue
 exportValue True string
group
 group number

Her radyo kutusu bir gruba atanabilir.
signatureTypes
 signatureTypes array of string

Bu belge için izin verilen imza türü, alıcı imza türü tarafından üzerine yazılabilir. En fazla bir değer desteklenir. Seçenekler: 'advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'
refId
 refId string

refId, karşıya yüklenen belgeye çapraz başvuru yapmak için kullanılan isteğe bağlı bir alandır. Sağlanırsa, belgeye özel bir başvuru tanımlayıcısı atamanıza olanak tanır. Bu tanımlayıcı, gelecekteki API yanıtlarında belge nesnesinin bir parçası olarak döndürülür. Bu, belgeleri bir dış sisteme veya iş akışına göre izlemek veya düzenlemek için yararlı olabilir.
language
 language string

Belge dili.
folderId
 folderId string

Belgelerin eklenmesi gereken klasörün kimliği. Bu yalnızca hem inviteData hem de folderName tanımlanmamışsa mümkündür.
isAttachment
 isAttachment boolean

isAttachment bu durumda gerekli değildir.
useFastlane
 useFastlane boolean

İmzalayan olarak true ayarlanırsa, davet e-postasında bir Fastlane bağlantısı alır.
fastlaneProfileId
 fastlaneProfileId uuid

Bu belgeyle birlikte kullanılması gereken Fastlane profilini belirtin. (useFastlane true olarak ayarlanmalıdır).

Döndürülenler

Body
EnvelopeResponse

Tanımlar

DeleteDocumentResponse

Belge Yanıtlarını Sil
string

_DocumentListResponse

Belge listesi işlemleri için yanıt nesnesi

Name Yol Tür Description
data
 data array of _Document

Belge listesi
Sayfalandırma Nesnesi
 pagination _PaginationObject

_PaginationObject

Name Yol Tür Description
toplam
 total integer

Görünümdeki toplam öğe sayısı (örn. belgeler) (örn. allDocuments)
lastPage
 lastPage integer

Son sayfanın numarası
perPage
 perPage integer

Sayfa başına belge sayısı
currentPage
 currentPage integer

Geçerli sayfanın sayısı
to
 to integer

Son belgenin dizini

_Document

Name Yol Tür Description
name
 name string

Belge adı
kimlik
 id string

Belge Kimliği
updatedAt
 updatedAt date

Son belge güncelleştirme tarihi
createdAt
 createdAt date

Belge oluşturma tarihi
signaturesTypes
 signaturesTypes array of string

Bu alıcı için izin verilen imza türlerinin üzerine alıcı imza türleri yazılabilir. Seçenekler: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']
callbackUrl
 callbackUrl string

Yeni bir imza oluşturulduğunda belgeyi içeren bir gönderi isteği bu Url'ye gönderilir
returnUrl
 returnUrl string

Belgeyi imzaladıktan sonra iade düğmesinin bağlantısı
returnBtnText
 returnBtnText string

Belgeyi imzaladıktan sonra dönüş düğmesinin metni
inPersonSigning
 inPersonSigning boolean
signingRound
 signingRound number
state
 state string

Belgenin geçerli durumu. Olası değerler şunlardır: taslak, beklemede, reddedildi, tamamlandı, ek, el ile Gönderme, el ile Tamamlandı
üye
 member

Genellikle belgenin sahibidir, ancak getSignatureStatus kullanırsanız, üye istekte kimliği sağlanan kişi olur
members
 members array of DocumentListMember

Davet edilen kişilerin listesi
Kutu -larını
 boxes array of DocumentListResponseBox

Yanıta özgü ek alanlara sahip imza konumu verileri. cardStyle, pageWidth ve pageHeight alanları isteğe bağlıdır ve tüm API yanıtlarında mevcut olmayabilir.
refId
 refId string
allSignersSigned
 allSignersSigned boolean
allMembersSigned
 allMembersSigned boolean
focusedSigningMode
 focusedSigningMode boolean

DocumentListResponseBox

Name Yol Tür Description
kimlik
 id string
fieldId
 fieldId string

Form alanlarını önceden doldurmak için kullanılan yapılandırılmış Alan Kimliği. Hiçbir Alan Kimliği yapılandırılmamışsa null döndürür.
type
 type string
value
 value

Kutu alanının değeri. Kutu türüne bağlı olarak bir dize (boş dize dahil), boole veya null olabilir.
label
 label string
readOnly
 readOnly boolean

DocumentListMember

Name Yol Tür Description
kimlik
 id string

Üye kimliği, belgeyi sproof Sign düzenleyicisinde açmak için kullanılabilir. Daha ayrıntılı bir açıklamaya buradan ulaşabilirsiniz
email
 email string

Belge sahibinin e-postası
firstName
 firstName string

Belge sahibinin adı
lastName
 lastName string

Belge sahibinin soyadı
lastActivityAt
 lastActivityAt date-time

Son etkinliğin tarih ve saati (ISO 8601 tarih saat dizesi)
createdAt
 createdAt date-time

Belge yükleme tarihi ve saati (ISO 8601 tarih saat dizesi)
Imzalı
 signed boolean

Belgenin sahibi tarafından imzalanıp imzalanmadığını gösterir
Yönetici
 isAdmin boolean

Üyenin Yönetici durumuna sahip olup olmadığını gösterir
isSigner
 isSigner boolean

Üyenin imzalayan olup olmadığını gösterir
isApprover
 isApprover boolean

Üyenin onaylayan olup olmadığını gösterir
isViewer
 isViewer boolean

Üyenin görüntüleyici olup olmadığını gösterir
approvedAt
 approvedAt date-time

Yalnızca isApprover doğruysa. Üyenin onaylandığı tarih ve saat (ISO 8601 tarih saat dizesi)
viewedAt
 viewedAt date-time

Yalnızca isViewer doğruysa. Üyenin belgeyi görüntülendiği tarih ve saat (ISO 8601 tarih saat dizesi)
signaturePosition
 signaturePosition

Bu üyenin imza konumları. İstekte gönderilen öğelere bağlı olarak, tek bir konum nesnesi veya konum nesneleri dizisi bekleyebilirsiniz.
signedAt
 signedAt date-time

İmzanın tarih ve saati (ISO 8601 tarih saat dizesi)
signingOrder
 signingOrder number

Bu üyenin imzalaması gereken sıra
declinedAt
 declinedAt date-time

Üyenin reddettigi tarih ve saat (ISO 8601 tarih saat dizesi)
Imza
 signatures array of object

İmza dizisi
signatureType
 signatures.signatureType string

İmza türü (örn. aes_sproof)
signedAt
 signatures.signedAt date-time

İmzanın uygulandığı zaman damgası (ISO 8601 tarih saat dizesi)

PrepareSignatureRequestResponse

Name Yol Tür Description
folderId
 folderId string
folderName
 folderName string
belgeler
 documents array of object
kimlik
 documents.id string
name
 documents.name string
language
 documents.language string
members
 documents.members array of

Bu bir imza isteği hazırlama yanıtı olduğundan, üyeler dizisi boş olur. Bunun nedeni üyelerin henüz davet edilmemesidir.
üye
 documents.member MemberResponseSchema

MemberResponseSchema

Name Yol Tür Description
kimlik
 id string
documentId
 documentId string
email
 email string
firstName
 firstName string
lastName
 lastName string
Yönetici
 isAdmin boolean
createdAt
 createdAt date-time

Üyenin oluşturulduğu tarih ve saat (ISO 8601 tarih saat dizesi)
sentDeleteNotificationAt
 sentDeleteNotificationAt date-time

Silme bildiriminin gönderildiği tarih ve saat (ISO 8601 tarih saat dizesi)
manuallyLastEmailSent
 manuallyLastEmailSent date-time

Son el ile e-postanın gönderildiği tarih ve saat (ISO 8601 tarih saat dizesi)
signaturePosition
 signaturePosition MemberSignaturePositionResponse

Yanıta özgü ek alanlara sahip imza konumu verileri. cardStyle, pageWidth ve pageHeight alanları isteğe bağlıdır ve tüm API yanıtlarında mevcut olmayabilir.
doNotSendEmails
 doNotSendEmails boolean
declinedAt
 declinedAt date-time

Üyenin reddettigi tarih ve saat (ISO 8601 tarih saat dizesi)
signingOrder
 signingOrder number
Ondemand
 onDemand string
recipientId
 recipientId string
signatureTypes
 signatureTypes array of string
signatureTypesActive
 signatureTypesActive boolean
privateMessage
 privateMessage string
customId
 customId string
useFastlane
 useFastlane boolean
role
 role string
approvedAt
 approvedAt date-time

Üyenin onaylandığı tarih ve saat (ISO 8601 tarih saat dizesi)
doğrulamaYapılandırma
 verificationConfig
phoneNumber
 phoneNumber string
Imza
 signatures array of string
Kutu -larını
 boxes array of DocumentResponseBox

Bu üyeye atanan form alanı kutuları.
signedAt
 signedAt date-time

Üyenin imzalı olduğu tarih ve saat (ISO 8601 tarih saat dizesi)

DocumentResponseBox

Name Yol Tür Description
kimlik
 id string
fieldId
 fieldId string

Form alanlarını önceden doldurmak için kullanılan yapılandırılmış Alan Kimliği. Hiçbir Alan Kimliği yapılandırılmamışsa null döndürür.
type
 type string
value
 value string

Kutu alanının değeri. Kutu türüne bağlı olarak bir dize (boş dize dahil), boole veya null olabilir.
label
 label string
readOnly
 readOnly boolean

MemberSignaturePositionResponse

Yanıta özgü ek alanlara sahip imza konumu verileri. cardStyle, pageWidth ve pageHeight alanları isteğe bağlıdır ve tüm API yanıtlarında mevcut olmayabilir.

Name Yol Tür Description
Items
 SignaturePositionResponse

Yanıta özgü ek alanlara sahip imza konumu verileri. cardStyle, pageWidth ve pageHeight alanları isteğe bağlıdır ve tüm API yanıtlarında mevcut olmayabilir.

SignaturePositionResponse

Yanıta özgü ek alanlara sahip imza konumu verileri. cardStyle, pageWidth ve pageHeight alanları isteğe bağlıdır ve tüm API yanıtlarında mevcut olmayabilir.

Name Yol Tür Description
sayfa
 page integer

Sayfa numarası, 0 ile başlar.
x
 x number

İmzaların sol üst konumunun x koordinatı
y
 y number

İmzaların sol üst konumunun y koordinatı
width
 width number

İmzanın genişliği.
height
 height number

İmzanın yüksekliği.
cardStyle
 cardStyle string

İmza kartının görsel stili. Bu alan isteğe bağlıdır ve tüm yanıtlarda döndürülmeyebilir.
Pagewidth
 pageWidth number

Sayfanın piksel cinsinden genişliği. Bu alan isteğe bağlıdır ve tüm yanıtlarda döndürülmeyebilir.
pageHeight
 pageHeight number

Sayfanın piksel cinsinden yüksekliği. Bu alan isteğe bağlıdır ve tüm yanıtlarda döndürülmeyebilir.

ZarfResponse

Name Yol Tür Description
folderId
 folderId string
folderName
 folderName string
belgeler
 documents array of object
kimlik
 documents.id string
name
 documents.name string
language
 documents.language string
startSendingReminders
 documents.startSendingReminders date-time

Anımsatıcıların gönderilmeye başladığı tarih ve saat (ISO 8601 tarih saat dizesi)
sendReminder
 documents.sendReminder boolean
reminderSent
 documents.reminderSent boolean
reminderInterval
 documents.reminderInterval number
createdAt
 documents.createdAt date-time

Belgenin oluşturulduğu tarih ve saat (ISO 8601 tarih saat dizesi)
callbackUrl
 documents.callbackUrl string
returnUrl
 documents.returnUrl string
returnBtnText
 documents.returnBtnText string
inPersonSigning
 documents.inPersonSigning boolean
signingRound
 documents.signingRound number
isTemplate
 documents.isTemplate boolean
templateId
 documents.templateId string
linkId
 documents.linkId string
linkExpiresAt
 documents.linkExpiresAt string
derivedFromLink
 documents.derivedFromLink boolean
state
 documents.state string
complianceLevel
 documents.complianceLevel string
allowForwarding
 documents.allowForwarding boolean
linkExpires
 documents.linkExpires boolean
setDueDate
 documents.setDueDate boolean
dueDate
 documents.dueDate date-time

Belgenin son tarihi (ISO 8601 tarih saat dizesi)
focusedSigningMode
 documents.focusedSigningMode boolean
linkMaxSignaturesEnabled
 documents.linkMaxSignaturesEnabled boolean
linkMaxSignatures
 documents.linkMaxSignatures number
fastlaneProfileId
 documents.fastlaneProfileId string
refId
 documents.refId string
sendOutFinishedPdf
 documents.sendOutFinishedPdf boolean
signatureTypes
 documents.signatureTypes array of string
members
 documents.members array of MemberResponseSchema
üye
 documents.member MemberResponseSchema
Kutu -larını
 documents.boxes array of DocumentResponseBox

Belgede form alanları varsa, belirli bir alıcıya atanmamış genel form alanı kutuları döndürülür. Alıcılara atanan alanlar members[n].boxes içinde döndürülür.
Gecik -miş
 documents.overdue boolean

DocumentStatusForFlow

Name Yol Tür Description
kimlik
 id string
name
 name string
state
 state string

Belgenin geçerli durumu. Olası değerler şunlardır: taslak, beklemede, reddedildi, tamamlandı, ek, el ile Gönderme, el ile Tamamlandı
createdAt
 createdAt date
updatedAt
 updatedAt date
allSignersSigned
 allSignersSigned boolean
allMembersSigned
 allMembersSigned boolean
focusedSigningMode
 focusedSigningMode boolean