Aracılığıyla paylaş

Doğrulandı

Özel belge imzalama işlemlerinin oluşturulmasını etkinleştirmek için Doğrulanmış API bağlayıcısı.

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

Hizmet 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)
İletişim
İsim Doğrulandı
URL https://verified.eu/en/#about-us
E-posta support@verified.eu
Bağlayıcı Meta Verileri
Publisher Crm - Konsulterna i Sverige AB
Web sitesi https://verified.eu/
Gizlilik ilkesi https://verified.eu/trust-center
Kategoriler İçerik ve Dosyalar; Verimli -lik

Doğrulandı, elektronik tanımlama ve dijital imzalama hizmet olarak yazılım sağlayıcısıdır. Bu bağlayıcı, Doğrulanmış API'sine tümleştirmeyi ve uygulamanızda basit ve sezgisel imzalama işlemleri oluşturmayı mümkün kılar.

Önkoşullar

Devam etmek için aşağıdakilere ihtiyacınız olacaktır:

Kimlik bilgilerini alma

Bu bağlayıcı Temel Kimlik Doğrulaması'nı kullanır. Kullanıcı, bağlantı oluştururken kullanıcı adı, parola ve şirket kimliği sunmalı. Kullanıcı adı ve parola, Doğrulanmış portalda oturum açmak için kullandığınızla aynıdır. Doğrulanmış portalda oturum açmanız gereken şirket kimliğini almak için, birkaç tane varsa doğru şirketi seçin ve URL'den şirket kimliğini kopyalayın.

Get started

Yaygın kullanım örneklerinden biri, bir imzalama işlemini başlatmak ve yönetmektir; örneğin, imzalanacak belgeleri Doğrulanmış'a göndermek ve imzalanan belgeleri düzenli aralıklarla geri almak için otomasyon ayarlamaktır. Doğrulanmış imzalama işlemini başlatmak için kullanılan yaygın eylemler şunlardır: Zarf oluştur - tanımlayıcı veya Zarf oluştur - varsayılan, Zarfa belge ekle, Belgeye dosya ekle, Zarfa alıcı ekle ve Zarf için yayımlama durumunu güncelleştir. Belgelerin Doğrulanmış durumunu denetlemek için kullanılan yaygın eylemler şunlardır: Kimlikle zarf al, Zarf kimliğine göre tüm belgeleri al, Belge kimliğine göre dosyaları al, Kimlikle dosya URL'sini al. Güvenlik belirteci oluştur eyleminin, aşağıdaki adımlarda kullanılacak bir güvenlik belirtecini almak için her zaman ilk adım olarak kullanıldığını unutmayın.

Bilinen Sorunlar ve Sınırlamalar

Şu anda aşağıdaki sınırlamalar bilinmektedir.

  • Her akışın başında, aşağıdaki her adımda yeniden kullanılacak bir kimlik doğrulama belirteci oluşturmak gerekir.
  • Belge eklemek için belirli bir URL'ye HTTP isteği göndermelisiniz.
  • Yeni Arama uç noktasını kullanmak için doğrulanmış Suppoert aracılığıyla hesap için etkinleştirilmesi gerekir.

FAQ

Belgeyi Doğrulandı'ya nasıl yükleyebilirim?

Gerçek bir belgeyi karşıya yüklemek için Doğrulanmış API'de bir dosya oluşturmanız ve belge karması doğrulanmış API'den yanıtlanan blob URL'sine yüklemeniz gerekir.

Zarf Al kimliği eylemini kullandıktan sonra zarfı nasıl tutarım?

Zarf oluşturan adımlar, zarfın tam yolu olan bir uid ile yanıt verir (örneğin: "/zarflar/ABCDE"). Diğer adımlar için kullanıcı arabiriminin yalnızca son bölümüne ihtiyaç duyulmaktadır ("ABCDE" örneğimizde gerçek zarf kimliğidir).

Bunun nasıl yapıldığını gösteren bir örnek aşağıda verilmiştir

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

Belgeyi zarfa ekle eylemini kullandıktan sonra belge kimliğini nasıl alabilirim?

Belge oluşturan adımlar, üst bilgideki yeni belgenin Konumu ile yanıt verir. Konum, belgenin tam yoludur (örnek: "/api/envelopes/ABCDE/documents/FGHIJ"). Aşağıdaki adımlar için yalnızca belge kimliği (bizim örneğimizde: FGHIJ) gereklidir.

Bunun nasıl yapıldığını gösteren bir örnek aşağıda verilmiştir

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

Bir zarftan Flow Kimliğini nasıl alabilirim?

Bir zarfla ilgili bilgileri yüklediğinde ilgili akış yanıtın bir parçası olur (örnek: "/flow/default"). Yanıtta bu, akışın kimliği olarak adlandırılır, ancak başka bir adım (akış durumunu alma gibi) akış kimliğini sorduğunda yalnızca son bölüme ihtiyaç duyar.

Bunun nasıl yapıldığını gösteren bir örnek aşağıda verilmiştir

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

Yeni Arama eylemini nasıl kullanabilirim?

Yeni arama eylemini kullanabilmek için Doğrulanmış Kuruluşunuz için arama uç noktasının etkinleştirilmesi gerekir. Bunu yapmak için, sizin için uç noktayı etkinleştirebilmeleri için Kuruluş Kimliğinizi içeren doğrulanmış desteğe bir e-posta yazmanız gerekir.

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 Gerekli
kullanıcı adı securestring Bu API'nin kullanıcı adı Doğru
şifre securestring Bu API'nin parolası Doğru
Şirket Kimliği String Şirket kimliği Doğrulandı tarafından sağlanır. app.verified.eu oturum açarak URL'de bulunabilir Doğru

Azaltma Sınırları

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

Eylemler

Alıcıyı kimlikle güncelleştirme

Alıcıyı güncelleştirir.
Belge iptal durumunu ayarlama

Belirli bir belgenin durumunu durdurulacak şekilde ayarlar.
Belge kimliğine göre dosya alma

Belirli bir belgeye bağlı tüm dosyaları alır.
Belgeye dosya ekleme

Var olan bir belgeye dosya ekler.
Bildirim gönder

Belirli bir zarfın alıcılarına bildirim gönderir.
Güvenlik belirteci oluşturma

Doğrulanmış API'den kimlik doğrulama belirtecini alır.
İmza oluştur bağlantısı

bir imza bağlantısı oluşturur. Uygulama belirli bir akıştır ve belirli akışınız için eksik olabilir.
Kimlikle dosya URL'sini alma

Belirli bir dosyanın URL'sini alır.
Kimlikle zarf alma

Belirli bir zarfın ayrıntılarını alır.
Kimliğine göre belge alma

Belirli bir belgenin bilgilerini alır.
Kimliğine göre belgeyi silme

Belirli bir belgeyi siler.
Kimliğine göre dosya al

Belirli bir dosya hakkında bilgi alır.
Kimliğine göre tanımlayıcıyı alma

Belirli bir tanımlayıcının bilgilerini alır.
Kimliğine göre şirket alma

Belirli bir şirketin bilgilerini alır.
Kullanıcı ayarlarını alma

Belirli bir kullanıcının ayarlarını alır.
Kullanıcı bilgilerini alma

Oturum açmış durumdaki kullanıcının bilgilerini alır.
Tüm tanımlayıcıları alma

Geçerli şirkette bulunan tüm tanımlayıcıların listesini alır. Liste filtrelenebilir.
Tüm zarf alıcılarını alma

Belirli bir zarfın tüm alıcılarını alır.
Tüm zarflarda arama

Belirli bir filtreyle eşleşen tüm zarfları arayın.
Tüm zarfları sorgulama (Kullanım dışı)

Belirli bir filtreyle eşleşen tüm zarfları sorgular. (Kullanım dışı)
Varsayılan tanımlayıcıyı alma

Zarflar için varsayılan tanımlayıcıyı alır.
Zarf ayarlarını güncelleştirme

Belirli bir zarfın Ayarlarını güncelleştirir.
Zarf iptal durumunu ayarlama

Belirli bir zarfın durumunu durdurulacak şekilde ayarlar.
Zarf için belirli bir alıcıyı alma

Belirli bir zarf için belirli bir alıcıyı alır.
Zarf için yayımlama durumunu güncelleştirme

Belirli bir zarfın yayımlama durumunu güncelleştirir.
Zarf kimliğine göre akış durumunu alma

Belirli bir zarfın geçerli akış durumunu alır.
Zarf kimliğine göre tüm belgeleri alma

Belirli bir zarfla ilgili tüm belgeleri alır.
Zarf oluştur - varsayılan

Varsayılan tanımlayıcıyı kullanarak yeni bir zarf oluşturur.
Zarf oluşturma - tanımlayıcı

Belirli bir tanımlayıcıyı temel alan bir zarf oluşturur.
Zarf çöp kutusu durumunu ayarlama

Belirli bir zarfın durumunu çöpe atılmış olarak ayarlar.
Zarfa alıcı ekleme

Belirli bir zarfa alıcı ekler.
Zarfa belge ekleme

Var olan bir zarfa yeni bir belge ekler.
Zarfı kimlikle silme

Belirli bir zarfı siler.
Şablondan Belge Oluştur

Önceden yapılandırılmış bir şablondan belge oluşturur.

Alıcıyı kimlikle güncelleştirme

İşlem Kimliği:
PutEnvelopesEnvelopeIdRecipientsRecipientId

Alıcıyı güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Alıcı Kimliği
 recipient-id True string

Söz konusu alıcıların kimliği
İlk İsim
 givenName True string
Soyadı
 familyName True string
Language
 language True string
İmzalama Yöntemi
 signingMethod True string
Bildirim Yöntemi
 notificationMethod string
E-posta
 email True string
Telefon
 telephone string

Biçim +<countryCode><telefon numarası olmalıdır>
Sipariş
 order integer
Eylem
 action True string

Alıcının yürütmesi gereken eylemin adı doğrulandı.
Etiket
 label True string

Alıcının rolü/eylemi için etiket
İsim
 name True string

Alıcı rolünün doğrulanmış adı
Secure
 secure boolean
SMS
 sms boolean
SSN (Türkçe)
 ssn string
Banka
 bank string

Belge iptal durumunu ayarlama

İşlem Kimliği:
PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Belirli bir belgenin durumunu durdurulacak şekilde ayarlar.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği

Belge kimliğine göre dosya alma

İşlem Kimliği:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Belirli bir belgeye bağlı tüm dosyaları alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği

Döndürülenler

response
array of File

Belgeye dosya ekleme

İşlem Kimliği:
PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Var olan bir belgeye dosya ekler.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği
İsim
 name True string
FileType
 fileType True string
Hash
 hash string

Döndürülenler

Dosya
File

Bildirim gönder

İşlem Kimliği:
PostEnvelopesEnvelopIdJobsSendNotification

Belirli bir zarfın alıcılarına bildirim gönderir.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Selamlama
 greeting string
Alıcı Kimliği
 id True string

Bildirimin gönderilmesi gereken alıcının kimliği.

Güvenlik belirteci oluşturma

İşlem Kimliği:
PostAuthenticate

Doğrulanmış API'den kimlik doğrulama belirtecini alır.

Parametreler

Name Anahtar Gerekli Tür Description
IP Kilidi olmadan
 withoutIpLock True integer

Doğrulanmış'ın IP Kilidi'nin (0, varsayılan) etkinleştirilip etkinleştirilmediği (1)

Döndürülenler

Name Yol Tür Description
Jeton
 token string

Erişim belirteci

İmza oluştur bağlantısı

İşlem Kimliği:
PostEnvelopesEnvelopeIdJobsGetSignLink

bir imza bağlantısı oluşturur. Uygulama belirli bir akıştır ve belirli akışınız için eksik olabilir.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Kimlik
 id string
Yeniden Yönlendir
 redirectTo uri

Kullanıcıyı imzadan sonra adresine yeniden yönlendirmek için tam URL.

Döndürülenler

Name Yol Tür Description
URL
 getSignLink.recipient.{recipient-id}.url string

Kimlikle dosya URL'sini alma

İşlem Kimliği:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Belirli bir dosyanın URL'sini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği
Dosya Kimliği
 file-id True string

Söz konusu Dosyanın Kimliği
Nesne Olarak
 asObject boolean

Yanıtın bir Nesne olup olmadığını tanımlar

Döndürülenler

Name Yol Tür Description
URL
 url string

Dosya URL'si

Kimlikle zarf alma

İşlem Kimliği:
GetEnvelopesEnvelopeId

Belirli bir zarfın ayrıntılarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği

Döndürülenler

Zarf
Envelope

Kimliğine göre belge alma

İşlem Kimliği:
GetEnvelopesEnvelopeIdDocumentsDocumentId

Belirli bir belgenin bilgilerini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği

Döndürülenler

Belge
Document

Kimliğine göre belgeyi silme

İşlem Kimliği:
DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Belirli bir belgeyi siler.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği

Kimliğine göre dosya al

İşlem Kimliği:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Belirli bir dosya hakkında bilgi alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği
Dosya Kimliği
 file-id True string

Söz konusu Dosyanın Kimliği

Döndürülenler

Dosya
File

Kimliğine göre tanımlayıcıyı alma

İşlem Kimliği:
GetEnvelopeDescriptorsEnvelopeDescriptorId

Belirli bir tanımlayıcının bilgilerini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Tanımlayıcı Kimliği
 envelope-descriptor-id True string

Zarf Tanımlayıcısının Kimliği

Döndürülenler

Tanımlayıcısı
Descriptor

Kimliğine göre şirket alma

İşlem Kimliği:
GetCompaniesCompanyId

Belirli bir şirketin bilgilerini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 company-id True string

Söz konusu şirketin kimliği

Döndürülenler

Şirket
Company

Kullanıcı ayarlarını alma

İşlem Kimliği:
GetCompaniesCompanyIdUsersUserIdSettings

Belirli bir kullanıcının ayarlarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 company-id True string

Söz konusu şirketin kimliği
Kullanıcı Kimliği
 user-id True string

Söz konusu kullanıcının kimliği

Döndürülenler

Body
Setting

Kullanıcı bilgilerini alma

İşlem Kimliği:
GetAuthUserinfo

Oturum açmış durumdaki kullanıcının bilgilerini alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç

Döndürülenler

Body
UserInfo

Tüm tanımlayıcıları alma

İşlem Kimliği:
GetEnvelopeDescriptors

Geçerli şirkette bulunan tüm tanımlayıcıların listesini alır. Liste filtrelenebilir.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Filtreler
 filters string

Altamount seçmek için sorguyu filtreleme

Döndürülenler

response
array of Descriptor

Tüm zarf alıcılarını alma

İşlem Kimliği:
GetEnvelopesEnvelopeIdRecipients

Belirli bir zarfın tüm alıcılarını alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği

Döndürülenler

response
array of Recipient

Tüm zarflarda arama

İşlem Kimliği:
GetSearchEnvelopes

Belirli bir filtreyle eşleşen tüm zarfları arayın.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Filtreler
 filters string

Altamount seçmek için sorguyu filtreleme
Kaynak
 from integer

Başlangıç tarihi
Sınır
 limit integer

Limit tutarı
Sırala
 sort string

Sıralama ölçütü

Döndürülenler

response
array of EnvelopeDescriptorString

Tüm zarfları sorgulama (Kullanım dışı)

İşlem Kimliği:
GetQueryEnvelopes

Belirli bir filtreyle eşleşen tüm zarfları sorgular. (Kullanım dışı)

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Filtreler
 filters string

Altamount seçmek için sorguyu filtreleme
Kaynak
 from integer

Başlangıç tarihi
Sınır
 limit integer

Limit tutarı
Sırala
 sort string

Sıralama ölçütü

Döndürülenler

response
array of EnvelopeDescriptorString

Varsayılan tanımlayıcıyı alma

İşlem Kimliği:
GetEnvelopeDescriptorsDefault

Zarflar için varsayılan tanımlayıcıyı alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Filtreler
 filters string

Altamount seçmek için sorguyu filtreleme

Döndürülenler

Tanımlayıcısı
Descriptor

Zarf ayarlarını güncelleştirme

İşlem Kimliği:
PutEnvelopesEnvelopeId

Belirli bir zarfın Ayarlarını güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Sıralı İmzalama
 sequentialSigning boolean
Selamlama
 greeting string
Süre Sonu
 expiration date

Şu biçimde tarih 2017-02-26T21:59:59.999Z
Otomatik Anımsatıcılar
 automaticReminders number

Süre dolmadan x gün önce

Zarf iptal durumunu ayarlama

İşlem Kimliği:
PutEnvelopesEnvelopeIdAbortStatus

Belirli bir zarfın durumunu durdurulacak şekilde ayarlar.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
yorum
 comment string

Zarf için belirli bir alıcıyı alma

İşlem Kimliği:
GetEnvelopesEnvelopeIdRecipientsRecipientId

Belirli bir zarf için belirli bir alıcıyı alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Alıcı Kimliği
 recipient-id True string

Söz konusu alıcıların kimliği

Döndürülenler

Recipient
Recipient

Zarf için yayımlama durumunu güncelleştirme

İşlem Kimliği:
PutEnvelopesEnvelopeIdPublishStatus

Belirli bir zarfın yayımlama durumunu güncelleştirir.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Yayımlanmış
 published True boolean

Zarf kimliğine göre akış durumunu alma

İşlem Kimliği:
GetFlowsFlowIdJobsEnvelopeId

Belirli bir zarfın geçerli akış durumunu alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Akış Kimliği
 flow-id True string

Söz konusu akışın kimliği

Döndürülenler

Name Yol Tür Description
Jeton
 token string

Zarf kimliğine göre tüm belgeleri alma

İşlem Kimliği:
GetEnvelopesEnvelopeIdDocuments

Belirli bir zarfla ilgili tüm belgeleri alır.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği

Döndürülenler

response
array of Document

Zarf oluştur - varsayılan

İşlem Kimliği:
PostEnvelopeDescriptorsDefaultEnvelopes

Varsayılan tanımlayıcıyı kullanarak yeni bir zarf oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
E-posta
 email string
İlk İsim
 givenName string
Soyadı
 familyName string
Otomatik Anımsatıcılar
 automaticReminders number
Süre Sonu
 expiration string
Hash
 hash string

Döndürülenler

Name Yol Tür Description
uid
 uid string

Zarf oluşturma - tanımlayıcı

İşlem Kimliği:
PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Belirli bir tanımlayıcıyı temel alan bir zarf oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Tanımlayıcı Kimliği
 envelope-descriptor-id True string

Zarf Tanımlayıcısının Kimliği
E-posta
 email string
İlk İsim
 givenName string
Soyadı
 familyName string
Otomatik Anımsatıcılar
 automaticReminders number
Süre Sonu
 expiration string
Hash
 hash string

Döndürülenler

Name Yol Tür Description
uid
 uid string

Zarf çöp kutusu durumunu ayarlama

İşlem Kimliği:
PutEnvelopesEnvelopeIdTrashStatus

Belirli bir zarfın durumunu çöpe atılmış olarak ayarlar.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Comment
 comment string

Zarfa alıcı ekleme

İşlem Kimliği:
PostEnvelopesEnvelopeIdRecipients

Belirli bir zarfa alıcı ekler.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
İlk İsim
 givenName True string
Soyadı
 familyName True string
Language
 language True string
İmzalama Yöntemi
 signingMethod True string
Bildirim Yöntemi
 notificationMethod string
E-posta
 email True string
Telefon
 telephone string

Biçim +<countryCode><telefon numarası olmalıdır>
Sipariş
 order integer
Eylem
 action True string

Alıcının yürütmesi gereken eylemin adı doğrulandı.
Etiket
 label True string

Alıcının rolü/eylemi için etiket
İsim
 name True string

Alıcı rolünün doğrulanmış adı
Secure
 secure boolean
SMS
 sms boolean
SSN (Türkçe)
 ssn string
Banka
 bank string

Zarfa belge ekleme

İşlem Kimliği:
PostEnvelopesEnvelopeIdDocuments

Var olan bir zarfa yeni bir belge ekler.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Hash
 hash integer
İsim
 name True string
Kaynak
 source string

Zarfı kimlikle silme

İşlem Kimliği:
DeleteEnvelopesEnvelopeId

Belirli bir zarfı siler.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği

Şablondan Belge Oluştur

İşlem Kimliği:
PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Önceden yapılandırılmış bir şablondan belge oluşturur.

Parametreler

Name Anahtar Gerekli Tür Description
Jeton
 token True string

'Güvenlik belirteci oluştur' eyleminden alınan belirteç
Şirket Kimliği
 x-namespace string

Eylem için kullanılması gereken şirket kimliği. Biçim/şirketler/<şirket kimliği>. Ayarlanmadıysa, varsayılan olarak bağlantı şirket kimliğini kullanır.
Zarf Kimliği
 envelope-id True string

Söz konusu zarfın kimliği
Belge Kimliği
 document-id True string

Söz konusu belgenin kimliği
Şablon Kimliği
 template-id True string

Kullanılması gereken şablonun kimliği
object

Tanımlar

Setting

Name Yol Tür Description
Global
 global string
İmza Dili
 preferences.signatoryLanguage string
Selamlama
 preferences.greeting string
İmzalama Yöntemi
 preferences.signingMethod string
Anımsatıcı Uzaklığı
 preferences.reminderOffset string

Kullanıcı Bilgisi

Name Yol Tür Description
İlk İsim
 givenName string
Soyadı
 familyName string
E-posta
 email string
Language
 metadata.language string
Eksik Parola
 missingPassword boolean
Etkin
 isEnabled boolean
Namespace
 namespace string
Etkinleştirildi
 enabled boolean
UID
 uid string
Kimlik
 id string
Görevler
 roles array of Role
Validated
 validated boolean

Şirket

Name Yol Tür Description
İsim
 name string
Kayıt Defteri Numarası
 regNumber string
Oluşturuldu
 created string
Değiştirildi
 modified string
Adres
 address string
City
 city string
Posta Kodu
 zipCode string
Logo
 logo string
Country
 country string
Uıd
 uid string
Kimlik
 id string

Recipient

Name Yol Tür Description
UID
 uid string

Alıcı KULLANıCı Arabirimi
Namespace
 namespace string

Alıcı Ad Alanı
Oluşturuldu
 created string

Alıcı Oluşturuldu
Rol
 role RoleActionString
Soyadı
 familyName string

Alıcı Soyadı
İlk İsim
 givenName string

Alıcı Üst Adı
Language
 language string

Alıcı Dili
E-posta
 email string

Alıcı E-postası
İmzalama Yöntemi
 signingMethod string

Alıcı İmzalama Methid
Bildirim Yöntemi
 notificationMethod string
Sipariş
 order integer

Alıcı Siparişi
Kimlik
 id string

Alıcı Kimliği
Değiştirildi
 modified string

Alıcı Değiştirildi
Bildirilir
 notified boolean
Tamamlandı
 completed boolean
demandAttachment
 demandAttachment boolean
SSN (Türkçe)
 ssn string
Banka
 bank string
Secure
 secure boolean
SMS
 sms boolean
Telefon
 telephone string
Imza
 signatures object
Notifications
 notifications array of Notification

Rol

Name Yol Tür Description
Türü
 action.type string
yöntemler
 action.methods array of string
Etiket
 label string

Etiket
Num. Max
 numMax integer

Num. Max
Num. Dakika
 numMin integer

Num. Dakika
Rol Adı
 roleName string

RoleActionString

Name Yol Tür Description
Eylem
 action ActionString

Eylem
Etiket
 label string

Etiket
Num. Max
 numMax integer

Num. Max
Num. Dakika
 numMin integer

Num. Dakika
Rol Adı
 roleName string

ActionString

Eylem

Eylem

Eylem
string

Zarf

Name Yol Tür Description
Kimlik
 id string

Zarf Kimliği
UID
 uid string

Zarf UiD
Namespace
 namespace string

Zarf Ad Alanı
Sürüm
 version integer

Zarf Sürümü
Yayımlanmış
 published boolean

Zarf Yayımlandı
Complete
 completed boolean

Zarf Tamamlandı
İptal edildi
 aborted boolean

Zarf Fildişi
Çöpe
 trashed boolean

Zarf Çöpe Atıldı
Sıralı İmzalama
 sequentialSigning boolean
Otmatik Anımsatıcılar
 automaticReminders integer
Oluşturuldu
 created string

Zarf Oluşturuldu
Değiştirildi
 modified string

Zarf Değiştirildi
Süresi doldu
 expired boolean

Zarf süresi doldu
Flow
 flow Flow
Tanımlayıcısı
 descriptor Descriptor
Person
 sender Person
Documents
 documents array of Document
Alıcı
 recipients array of Recipient
Etiketler
 tags array of object
Sahipleri
 owners array of Person

EnvelopeDescriptorString

Name Yol Tür Description
Kimlik
 id string

Zarf Kimliği
UID
 uid string

Zarf UiD
Namespace
 namespace string

Zarf Ad Alanı
Sürüm
 version integer

Zarf Sürümü
Yayımlanmış
 published boolean

Zarf Yayımlandı
Complete
 completed boolean

Zarf Tamamlandı
İptal edildi
 aborted boolean

Zarf Fildişi
Çöpe
 trashed boolean

Zarf Çöpe Atıldı
Sıralı İmzalama
 sequentialSigning boolean
Otmatik Anımsatıcılar
 automaticReminders integer
Oluşturuldu
 created string

Zarf Oluşturuldu
Değiştirildi
 modified string

Zarf Değiştirildi
Süresi doldu
 expired boolean

Zarf süresi doldu
Flow
 flow Flow
Tanımlayıcısı
 descriptor string

Zarf tanımlayıcısı
Person
 sender Person
Documents
 documents array of Document
Alıcı
 recipients array of Recipient
Etiketler
 tags array of object
Sahipleri
 owners array of Person

Dosya

Name Yol Tür Description
Kimlik
 id string

Dosya Kimliği
URL
 url string

Dosya URL'si
İsim
 name string

Dosya Adı
Mime Türü
 mimeType string
Dosya Türü
 fileType string
Depolama Yolu
 storagePath string
Karşıya Yükleme:
 uploadedAt string
Oluşturuldu
 created string

Dosya Oluşturuldu
Sahipleri
 owners array of object
UID
 owners.uid string

Dosya Sahibi UID
Kimlik
 owners._id string

Dosya Sahibi Kimliği
Namespace
 namespace string
UID
 uid string

Dosya UID

Flow

Name Yol Tür Description
Kimlik
 id string

Akış Kimliği
İsim
 name string

Akış Adı

Tanımlayıcısı

Name Yol Tür Description
İsim
 name string

Tanımlayıcı Adı
Sürüm
 version integer

Tanımlayıcı Sürümü
UID
 uid string

Tanımlayıcı UID
Silindi
 deleted boolean

Tanımlayıcı Deletd
Public
 public boolean

Açıklayıcı Genel
Süresi doldu
 expired boolean

Tanımlayıcının Süresi Doldu
Kimlik
 id string

Tanımlayıcı Kimliği
Mandatory
 mandatory boolean

Tanımlayıcı Zorunlu
Etiket
 label string

Tanımlayıcı Etiketi
Türü
 type string

Tanımlayıcı Türü
Görevler
 roles array of Role
Sahipleri
 owners array of Person
Flow
 flow Flow
defaultValues
 defaultValues DefaultValues

defaultValues
Instances
 instances array of object

Person

Name Yol Tür Description
UID
 uid string

Kişi Kullanıcı Arabirimi
İlk İsim
 givenName string

Kişi Adı
Soyadı
 familyName string

Kişi Soyadı
E-posta
 email string

Kişi E-postası
Language
 language string

Kişi Dili
Sipariş
 order integer

Kişi Siparişi

Belge

Name Yol Tür Description
Etiket
 label string

Belge Etiketi
Türü
 type string

Belge Türü
Hash
 hash integer

Belge Karması
Num. Max
 numMax integer

Belge Numarası. Max
Num. Dakika
 numMin integer

Belge Numarası. Dakika
UID
 uid string

Belge UID
Namespace
 namespace string

Belge Ad Alanı
Kaynak
 source string

Belge Kaynağı
Oluşturuldu
 created string

Belge Oluşturuldu
İsim
 name string

Belge Adı
Kimlik
 id string

Belge Kimliği
Değiştirildi
 modified string

Belge Değiştirildi
Reddedildi
 rejected boolean

Belge Reddedildi
Imzalı
 signed boolean

belge imzalı
Çöpe
 trashed boolean

Belge Çöp Kutusuna Eklendi
İptal edildi
 aborted boolean

Belge Durduruldu
Sürüm
 version integer

Belge Sürümü
attachments
 attachments array of Attachment
Flow
 flow Flow
roles
 roles array of Role
Template
 template Template
Tanımlayıcısı
 descriptor Descriptor
Imza
 signatures array of Signature

Attachment

Name Yol Tür Description
Etiket
 label string

Ek Etiketi
Num. Max
 numMax integer

Ek Numarası. Max
Num. Dakika
 numMin integer

Ek Numarası.Dk
Hash
 hash integer

Ek Karması

Template

Name Yol Tür Description
Türü
 type string

Şablon Türü
HTML
 html string
PDFHTML
 pdfHtml string
Kimlik
 id string
UID
 uid string
Namespace
 namespace string
Sürüm
 version integer
Oluşturuldu
 created string
Değiştirildi
 modified string
Değiştirildi
 published boolean
Tamamlandı
 completed boolean
İptal edildi
 aborted boolean

Signature

Name Yol Tür Description
Kimlik
 id string
Başlangıç
 origin string
İlk İsim
 givenName string

İlk İsim
Soyadı
 familyName string

Soyadı
E-posta
 email string

E-posta
IP
 ip string
Date
 date string
Statü
 status string
Comment
 comment string

DefaultValues

defaultValues

Name Yol Tür Description
Person
 signer Person
Person
 reviewer Person

Notification

Name Yol Tür Description
Kimlik
 id string
UID
 uid string
Namespace
 namespace string
Statü
 status string
Sipariş
 order integer
Ayrıntılar
 details object
Date
 date string