SignRequest (wersja zapoznawcza)
SignRequest to bezpieczne i prawnie wiążące narzędzie do podpisywania podpisów elektronicznych, które umożliwia Tobie i partnerom szybkie podpisywanie kontraktów i innych dokumentów bez konieczności drukowania, podpisywania i skanowania.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| tech-support@signrequest.com |
| Metadane łącznika | |
|---|---|
| Publisher | SignRequest B.V. |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
|
Wysyłanie znaku |
Tworzy i wysyła nowy element SignRequest. |
Wysyłanie znakuWyślij żądanie
Tworzy i wysyła nowy element SignRequest.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Automatyczne usuwanie dni
|
auto_delete_days | integer |
Liczba dni, po których ukończony dokument (podpisany/anulowany/odrzucony) zostanie automatycznie usunięty |
|
|
Automatyczne wygasanie dni
|
auto_expire_days | integer |
Liczba dni, po których dokument nieukończony zostanie automatycznie wygasł |
|
|
Wyłączanie załączników
|
disable_attachments | boolean |
Wyłączanie przekazywania/dodawania załączników |
|
|
Wyłączanie sprawdzania łańcucha bloków
|
disable_blockchain_proof | boolean |
Wyłącza przechowywanie skrótów sprawdzania sygnatury czasowej w integracji łańcucha bloków. |
|
|
Wyłącz datę
|
disable_date | boolean |
Wyłączanie dodawania dat |
|
|
Wyłączanie wiadomości e-mail
|
disable_emails | boolean |
Wyłącz wszystkie wiadomości e-mail ze stanem signRequest, a także wiadomość e-mail zawierającą podpisane dokumenty |
|
|
Wyłącz tekst
|
disable_text | boolean |
Wyłączanie dodawania tekstu |
|
|
Wyłączanie podpisów tekstowych
|
disable_text_signatures | boolean |
Wyłączanie użycia podpisów generowanych przez wpisanie (tekst) |
|
|
Wyłączanie przekazywania podpisów
|
disable_upload_signatures | boolean |
Wyłączanie użycia przekazanych podpisów (obrazów) |
|
|
Dokument
|
document | uri | ||
|
Adres URL wywołania zwrotnego zdarzeń
|
events_callback_url | uri |
Adres URL, pod którym mają być odbierane wywołania zwrotne zdarzeń dla tego dokumentu |
|
|
Identyfikator zewnętrzny
|
external_id | string |
Identyfikator używany do odwołowania się do dokumentu w systemie zewnętrznym |
|
|
File
|
file | uri |
Tymczasowy adres URL oryginalnego pliku, wygasa w ciągu pięciu minut |
|
|
Plik z zawartości
|
file_from_content | byte |
Zawartość dokumentu zakodowanego w formacie Base64 |
|
|
Plik z nazwy zawartości
|
file_from_content_name | string |
Nazwa pliku, w tym rozszerzenie. Wymagane w przypadku używania polecenia |
|
|
Plik z adresu URL
|
file_from_url | uri |
Publicznie dostępny adres URL dokumentu do pobrania przez element SignRequest |
|
|
Z adresu e-mail
|
from_email |
Wiadomość e-mail użytkownika wysyłającego element SignRequest (musi być zweryfikowaną pocztą e-mail) |
||
|
Z nazwy e-mail
|
from_email_name | string |
Nazwa, która ma być używana w nagłówku |
|
|
Identyfikator frontonu
|
frontend_id | string |
Wspólny klucz tajny używany w połączeniu z klientem SignRequest-js w celu udzielenia użytkownikowi dostępu do dokumentu, który nie jest członkiem zespołu dokumentu |
|
|
Trwa przygotowywanie
|
is_being_prepared | boolean |
Poproś nadawcę elementu SignRequest o przygotowanie dokumentu przed wysłaniem żądania, zobacz: przygotowanie przy użyciu interfejsu internetowego |
|
|
Message
|
message | string |
Wiadomość do uwzględnienia w wiadomości e-mail SignRequest może zawierać następujące tagi HTML: |
|
|
Name
|
name | string |
Domyślnie nazwa pliku, w tym rozszerzenie |
|
|
Wartość pola wyboru Prefill Tags (Wstępne wypełnianie tagów)
|
checkbox_value | boolean | ||
|
Wartość daty wstępnego wypełniania tagów
|
date_value | date | ||
|
Identyfikator zewnętrzny tagów wstępnych
|
external_id | string | ||
|
Wstępne wypełnianie tekstu tagów
|
text | string | ||
|
Adres URL przygotowywania
|
prepare_url | uri | ||
|
Adres URL przekierowania
|
redirect_url | uri |
Adres URL, pod którym element SignRequest będzie przekierowywany do momentu podpisania dokumentu |
|
|
Odrzucono adres URL przekierowania
|
redirect_url_declined | uri |
Adres URL, pod którym element SignRequest będzie przekierowywany do momentu odrzucenia dokumentu |
|
|
Nazwa wymaganego załącznika
|
name | True | string | |
|
Identyfikator Uuid wymaganego załącznika
|
uuid | string | ||
|
Wysyłanie przypomnień
|
send_reminders | boolean |
Automatyczne przypomnienie osoby podpisujących w celu podpisania dokumentu, zobacz: automatyczne przypomnienia |
|
|
Podpisywanie po dokumencie
|
after_document | uri | ||
|
Osoba podpisjąca zatwierdza tylko
|
approve_only | boolean |
Wymagaj od użytkownika zatwierdzenia dokumentu (bez dodawania podpisu), zobacz: Zatwierdzanie tylko |
|
|
File
|
file | uri | ||
|
Nazwa wymaganego załącznika
|
name | True | string | |
|
Identyfikator Uuid wymaganego załącznika
|
uuid | string | ||
|
Name
|
name | string |
Domyślnie nazwa pliku |
|
|
Uuid
|
uuid | string | ||
|
Odrzucono podpisywania
|
declined | boolean | ||
|
Użytkownik podpisuje odrzucone
|
declined_on | date-time | ||
|
Nazwa wyświetlana osoby podpisającego
|
display_name | string | ||
|
Pobrany użytkownik podpisy
|
downloaded | boolean | ||
|
Adres e-mail sygnatariusza
|
True | |||
|
Wyświetlanie wiadomości e-mail użytkownika
|
email_viewed | boolean | ||
|
Adres e-mail zalogowanego
|
emailed | boolean | ||
|
Adres URL osadzania logowania
|
embed_url | uri | ||
|
Identyfikator użytkownika osadzania adresu URL logowania
|
embed_url_user_id | string | ||
|
Imię i nazwisko osoby podpisającego
|
first_name | string | ||
|
Język wymuśniający znakatora
|
force_language | boolean | ||
|
Użytkownik podpisjący przesłany dalej
|
forwarded | boolean | ||
|
Użytkownik podpisy przekazany dalej
|
forwarded_on | date-time | ||
|
Przyczyna przekazywania dalej przez sygnatariusza
|
forwarded_reason | string | ||
|
Użytkownik podpisy przesłany dalej do wiadomości e-mail
|
forwarded_to_email | |||
|
Osoba do logowania
|
in_person | boolean |
W przypadku użycia w połączeniu z adresem URL osadzania w nadawcy po podpisaniu nadawcy zostaną one przekierowane do następnego |
|
|
Wartość pola wyboru
|
checkbox_value | boolean | ||
|
Wartość daty
|
date_value | date | ||
|
Identyfikator zewnętrzny
|
external_id | string | ||
|
Indeks strony
|
page_index | True | integer | |
|
Identyfikator uuid symbolu zastępczego
|
placeholder_uuid | string | ||
|
Tekst
|
text | string | ||
|
Typ
|
type | string | ||
|
Język podpisywania
|
language | string | ||
|
Nazwisko osoby podpisającego
|
last_name | string | ||
|
Wiadomość dotycząca logowania
|
message | string | ||
|
Użytkownik podpisy musi podpisać
|
needs_to_sign | boolean |
Jeśli |
|
|
Tylko powiadomienie o podpisie
|
notify_only | boolean |
Wysyłanie powiadomień o dokumencie i kopii podpisanego dokumentu i dziennika podpisywania, ale nie wymaga od nich podjęcia żadnej akcji, zobacz: Powiadom tylko |
|
|
Kolejność podpisywania
|
order | integer | ||
|
Hasło użytkownika podpisywania
|
password | string |
Wymagaj od użytkownika wprowadzenia tego hasła przed podpisaniem dokumentu. To pole jest tylko do zapisu. |
|
|
Adres URL przekierowania logowania
|
redirect_url | uri | ||
|
Odrzucono adres URL przekierowania użytkownika
|
redirect_url_declined | uri | ||
|
Podpisany podpis
|
signed | boolean | ||
|
Zalogowany użytkownik
|
signed_on | date-time | ||
|
Osoba podpisjąca używa sygnatury tylko do zatwierdzania
|
use_stamp_for_approve_only | boolean |
Umieszczenie sygnatury zatwierdzenia w dokumencie, gdy osoba podpisjąca zatwierdzi dokument |
|
|
Signer Verify Bank Account
|
verify_bank_account | string | ||
|
Signer Verify Phone Number
|
verify_phone_number | string | ||
|
Wyświetlony użytkownik podpisy
|
viewed | boolean | ||
|
Zespół
|
subdomain | string | ||
|
Temat
|
subject | string |
Temat wiadomości e-mail SignRequest |
|
|
Template
|
template | uri | ||
|
Zablokowano weryfikację wiadomości SMS
|
text_message_verification_locked | boolean |
Jeśli jest wymagana weryfikacja wiadomości SMS, zanim podpisjący będzie mógł zobaczyć dokument |
|
|
URL
|
url | uri | ||
|
Uuid
|
uuid | string | ||
|
Kto
|
who | string |
|
Zwraca
Wyzwalacze
| Gdy stan dokumentu ulegnie zmianie |
Wyzwala, gdy stan dokumentu signRequest zmieni się. |
Gdy stan dokumentu ulegnie zmianie
Wyzwala, gdy stan dokumentu signRequest zmieni się.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Created
|
created | date-time | ||
|
Typ zdarzenia
|
event_type | True | string | |
|
Name
|
name | string |
Opcjonalna nazwa do łatwego identyfikowania elementów webhook, dla których jest używany |
|
|
Zespół
|
subdomain | string | ||
|
Nazwa zespołu
|
name | string | ||
|
Poddomena zespołu
|
subdomain | uri | ||
|
Adres URL zespołu
|
url | uri | ||
|
URL
|
url | uri | ||
|
Uuid
|
uuid | string |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dokument
|
document | Document |
Definicje
Dokument
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Używany interfejs API dokumentów
|
api_used | boolean |
Wskazuje, czy dokument został utworzony przy użyciu interfejsu API |
|
attachments
|
attachments | array of DocumentAttachment | |
|
Automatyczne usuwanie dokumentu po
|
auto_delete_after | date-time |
Data i godzina obliczana przy użyciu |
|
Dni automatycznego usuwania dokumentu
|
auto_delete_days | integer |
Liczba dni, po których ukończony dokument (podpisany/anulowany/odrzucony) zostanie automatycznie usunięty |
|
Automatyczne wygasanie dokumentu po
|
auto_expire_after | date-time |
Data i godzina obliczana przy użyciu |
|
Automatyczne wygasanie dokumentu w dniach
|
auto_expire_days | integer |
Liczba dni, po których dokument nieukończony zostanie automatycznie wygasł |
|
Adres URL wywołania zwrotnego zdarzeń dokumentu
|
events_callback_url | uri |
Adres URL, pod którym mają być odbierane wywołania zwrotne zdarzeń dla tego dokumentu |
|
Identyfikator zewnętrzny dokumentu
|
external_id | string |
Identyfikator używany do odwołowania się do dokumentu w systemie zewnętrznym |
|
Plik dokumentu
|
file | uri |
Tymczasowy adres URL oryginalnego pliku, wygasa w ciągu pięciu minut |
|
Plik dokumentu jako plik PDF
|
file_as_pdf | uri |
Tymczasowy adres URL oryginalnego pliku w formacie PDF wygasa w ciągu pięciu minut |
|
Plik dokumentu z zawartości
|
file_from_content | string |
Zawartość dokumentu zakodowanego w formacie Base64 |
|
Plik dokumentu z nazwy zawartości
|
file_from_content_name | string |
Nazwa pliku, w tym rozszerzenie. Wymagane w przypadku używania polecenia |
|
Plik z sf
|
file_from_sf | FileFromSf | |
|
Plik dokumentu z adresu URL
|
file_from_url | uri |
Publicznie dostępny adres URL dokumentu do pobrania przez element SignRequest |
|
Identyfikator frontonu dokumentu
|
frontend_id | string |
Wspólny klucz tajny używany w połączeniu z klientem SignRequest-js w celu udzielenia użytkownikowi dostępu do dokumentu, który nie jest członkiem zespołu dokumentu |
|
Nazwa dokumentu
|
name | string |
Domyślnie nazwa pliku, w tym rozszerzenie |
|
Dokument PDF
|
uri |
Tymczasowy adres URL podpisanego dokumentu w formacie PDF wygasa w ciągu pięciu minut |
|
|
prefill_tags
|
prefill_tags | array of InlinePrefillTags |
Wstępne wypełnianie danych wejściowych identyfikatora, zobacz wstępne wypełnianie tagów |
|
Przetwarzanie dokumentów
|
processing | boolean |
Wskazuje, czy zmiana dokumentu jest przetwarzana, a plik PDF może być nieaktualny. Zaleca się poczekanie na zakończenie przetwarzania przed pobraniem pliku PDF. Elementy webhook nie są wysyłane do momentu ukończenia przetwarzania. |
|
Piaskownica dokumentu
|
sandbox | boolean |
Wskazuje, czy dokument został utworzony jako część zespołu piaskownicy |
|
Skrót zabezpieczeń dokumentu
|
security_hash | string |
Skrót SHA256 zawartości PDF |
|
Plik PDF dziennika podpisywania
|
signing_log.pdf | uri |
Tymczasowy adres URL dziennika podpisywania, wygasa w ciągu pięciu minut |
|
Skrót zabezpieczeń dziennika podpisywania
|
signing_log.security_hash | string |
Skrót SHA256 zawartości PDF |
|
Signrequest — wyłączanie załączników
|
signrequest.disable_attachments | boolean |
Wyłączanie przekazywania/dodawania załączników |
|
Signrequest — wyłączanie weryfikacji łańcucha bloków
|
signrequest.disable_blockchain_proof | boolean |
Wyłącza przechowywanie skrótów sprawdzania sygnatury czasowej w integracji łańcucha bloków. |
|
Signrequest — wyłącz datę
|
signrequest.disable_date | boolean |
Wyłączanie dodawania dat |
|
Signrequest — wyłączanie wiadomości e-mail
|
signrequest.disable_emails | boolean |
Wyłącz wszystkie wiadomości e-mail ze stanem signRequest, a także wiadomość e-mail zawierającą podpisane dokumenty |
|
Signrequest Disable Text
|
signrequest.disable_text | boolean |
Wyłączanie dodawania tekstu |
|
Signrequest — wyłączanie podpisów tekstowych
|
signrequest.disable_text_signatures | boolean |
Wyłączanie użycia podpisów generowanych przez wpisanie (tekst) |
|
Signrequest — wyłączanie przekazywania podpisów
|
signrequest.disable_upload_signatures | boolean |
Wyłączanie użycia przekazanych podpisów (obrazów) |
|
Signrequest From Email
|
signrequest.from_email |
Wiadomość e-mail użytkownika wysyłającego element SignRequest (musi być zweryfikowaną pocztą e-mail) |
|
|
Signrequest z nazwy poczty e-mail
|
signrequest.from_email_name | string |
Nazwa, która ma być używana w nagłówku |
|
Signrequest jest przygotowywany
|
signrequest.is_being_prepared | boolean |
Poproś nadawcę elementu SignRequest o przygotowanie dokumentu przed wysłaniem żądania, zobacz: przygotowanie przy użyciu interfejsu internetowego |
|
Komunikat signrequest
|
signrequest.message | string |
Wiadomość do uwzględnienia w wiadomości e-mail SignRequest może zawierać następujące tagi HTML: |
|
Adres URL przygotowywania aplikacji Signrequest
|
signrequest.prepare_url | uri | |
|
Adres URL przekierowania elementu Signrequest
|
signrequest.redirect_url | uri |
Adres URL, pod którym element SignRequest będzie przekierowywany do momentu podpisania dokumentu |
|
Odrzucono adres URL przekierowania signrequest
|
signrequest.redirect_url_declined | uri |
Adres URL, pod którym element SignRequest będzie przekierowywany do momentu odrzucenia dokumentu |
|
required_attachments
|
signrequest.required_attachments | array of RequiredAttachment | |
|
Wysyłanie przypomnień dotyczących funkcji Signrequest
|
signrequest.send_reminders | boolean |
Automatyczne przypomnienie osoby podpisujących w celu podpisania dokumentu, zobacz: automatyczne przypomnienia |
|
Sygnatariuszy
|
signrequest.signers | array of Signer | |
|
Temat signrequest
|
signrequest.subject | string |
Temat wiadomości e-mail SignRequest |
|
Zablokowano weryfikację wiadomości SMS signrequest
|
signrequest.text_message_verification_locked | boolean |
Jeśli jest wymagana weryfikacja wiadomości SMS, zanim podpisjący będzie mógł zobaczyć dokument |
|
Signrequest Uuid
|
signrequest.uuid | string | |
|
Signrequest, kto
|
signrequest.who | string |
|
|
Stan dokumentu
|
status | string |
|
|
Nazwa zespołu
|
team.name | string | |
|
Poddomena zespołu
|
team.subdomain | uri | |
|
Adres URL zespołu
|
team.url | uri | |
|
Szablon dokumentu
|
template | uri | |
|
Adres URL dokumentu
|
url | uri | |
|
User
|
user | User | |
|
Identyfikator Uuid dokumentu
|
uuid | string |
DocumentAttachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dokument załącznika dokumentu
|
document | uri | |
|
Plik załącznika dokumentu
|
file | uri |
Tymczasowy adres URL załącznika dokumentu, wygasa w ciągu pięciu minut |
|
Plik załącznika dokumentu z zawartości
|
file_from_content | string |
Zawartość dokumentu zakodowanego w formacie Base64 |
|
Plik załącznika dokumentu z nazwy zawartości
|
file_from_content_name | string |
Nazwa pliku, w tym rozszerzenie. Wymagane w przypadku używania polecenia |
|
Plik załącznika dokumentu z adresu URL
|
file_from_url | uri |
Publicznie dostępny adres URL dokumentu do pobrania przez element SignRequest |
|
Nazwa załącznika dokumentu
|
name | string |
Domyślnie nazwa pliku, w tym rozszerzenie |
|
Adres URL załącznika dokumentu
|
url | uri | |
|
Identyfikator Uuid załącznika dokumentu
|
uuid | string |
FileFromSf
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator obiektu
|
object_id | string | |
|
Typ obiektu
|
object_type | string | |
|
Uid
|
uid | string |
InlinePrefillTags
Wstępne wypełnianie danych wejściowych identyfikatora, zobacz wstępne wypełnianie tagów
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość pola wyboru Prefill Tags (Wstępne wypełnianie tagów)
|
checkbox_value | boolean | |
|
Wartość daty wstępnego wypełniania tagów
|
date_value | date | |
|
Identyfikator zewnętrzny tagów wstępnych
|
external_id | string | |
|
Wstępne wypełnianie tekstu tagów
|
text | string |
RequiredAttachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa wymaganego załącznika
|
name | string | |
|
Identyfikator Uuid wymaganego załącznika
|
uuid | string |
SignRequestQuickCreate
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Automatyczne usuwanie dni
|
auto_delete_days | integer |
Liczba dni, po których ukończony dokument (podpisany/anulowany/odrzucony) zostanie automatycznie usunięty |
|
Automatyczne wygasanie dni
|
auto_expire_days | integer |
Liczba dni, po których dokument nieukończony zostanie automatycznie wygasł |
|
Wyłączanie załączników
|
disable_attachments | boolean |
Wyłączanie przekazywania/dodawania załączników |
|
Wyłączanie sprawdzania łańcucha bloków
|
disable_blockchain_proof | boolean |
Wyłącza przechowywanie skrótów sprawdzania sygnatury czasowej w integracji łańcucha bloków. |
|
Wyłącz datę
|
disable_date | boolean |
Wyłączanie dodawania dat |
|
Wyłączanie wiadomości e-mail
|
disable_emails | boolean |
Wyłącz wszystkie wiadomości e-mail ze stanem signRequest, a także wiadomość e-mail zawierającą podpisane dokumenty |
|
Wyłącz tekst
|
disable_text | boolean |
Wyłączanie dodawania tekstu |
|
Wyłączanie podpisów tekstowych
|
disable_text_signatures | boolean |
Wyłączanie użycia podpisów generowanych przez wpisanie (tekst) |
|
Wyłączanie przekazywania podpisów
|
disable_upload_signatures | boolean |
Wyłączanie użycia przekazanych podpisów (obrazów) |
|
Dokument
|
document | uri | |
|
Adres URL wywołania zwrotnego zdarzeń
|
events_callback_url | uri |
Adres URL, pod którym mają być odbierane wywołania zwrotne zdarzeń dla tego dokumentu |
|
Identyfikator zewnętrzny
|
external_id | string |
Identyfikator używany do odwołowania się do dokumentu w systemie zewnętrznym |
|
File
|
file | uri |
Tymczasowy adres URL oryginalnego pliku, wygasa w ciągu pięciu minut |
|
Plik z zawartości
|
file_from_content | byte |
Zawartość dokumentu zakodowanego w formacie Base64 |
|
Plik z nazwy zawartości
|
file_from_content_name | string |
Nazwa pliku, w tym rozszerzenie. Wymagane w przypadku używania polecenia |
|
Plik z adresu URL
|
file_from_url | uri |
Publicznie dostępny adres URL dokumentu do pobrania przez element SignRequest |
|
Z adresu e-mail
|
from_email |
Wiadomość e-mail użytkownika wysyłającego element SignRequest (musi być zweryfikowaną pocztą e-mail) |
|
|
Z nazwy e-mail
|
from_email_name | string |
Nazwa, która ma być używana w nagłówku |
|
Identyfikator frontonu
|
frontend_id | string |
Wspólny klucz tajny używany w połączeniu z klientem SignRequest-js w celu udzielenia użytkownikowi dostępu do dokumentu, który nie jest członkiem zespołu dokumentu |
|
Trwa przygotowywanie
|
is_being_prepared | boolean |
Poproś nadawcę elementu SignRequest o przygotowanie dokumentu przed wysłaniem żądania, zobacz: przygotowanie przy użyciu interfejsu internetowego |
|
Message
|
message | string |
Wiadomość do uwzględnienia w wiadomości e-mail SignRequest może zawierać następujące tagi HTML: |
|
Name
|
name | string |
Domyślnie nazwa pliku, w tym rozszerzenie |
|
prefill_tags
|
prefill_tags | array of InlinePrefillTags |
Wstępne wypełnianie danych wejściowych identyfikatora, zobacz wstępne wypełnianie tagów |
|
Adres URL przygotowywania
|
prepare_url | uri | |
|
Adres URL przekierowania
|
redirect_url | uri |
Adres URL, pod którym element SignRequest będzie przekierowywany do momentu podpisania dokumentu |
|
Odrzucono adres URL przekierowania
|
redirect_url_declined | uri |
Adres URL, pod którym element SignRequest będzie przekierowywany do momentu odrzucenia dokumentu |
|
required_attachments
|
required_attachments | array of RequiredAttachment |
Załączniki wymagane do przekazania przez osoby podpisujące |
|
Wysyłanie przypomnień
|
send_reminders | boolean |
Automatyczne przypomnienie osoby podpisujących w celu podpisania dokumentu, zobacz: automatyczne przypomnienia |
|
Sygnatariuszy
|
signers | array of Signer | |
|
Zespół
|
subdomain | string | |
|
Temat
|
subject | string |
Temat wiadomości e-mail SignRequest |
|
Template
|
template | uri | |
|
Zablokowano weryfikację wiadomości SMS
|
text_message_verification_locked | boolean |
Jeśli jest wymagana weryfikacja wiadomości SMS, zanim podpisjący będzie mógł zobaczyć dokument |
|
URL
|
url | uri | |
|
Uuid
|
uuid | string | |
|
Kto
|
who | string |
|
Osoby podpisującej
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Podpisywanie po dokumencie
|
after_document | uri | |
|
Osoba podpisjąca zatwierdza tylko
|
approve_only | boolean |
Wymagaj od użytkownika zatwierdzenia dokumentu (bez dodawania podpisu), zobacz: Zatwierdzanie tylko |
|
attachments
|
attachments | array of SignerAttachment | |
|
Odrzucono podpisywania
|
declined | boolean | |
|
Użytkownik podpisuje odrzucone
|
declined_on | date-time | |
|
Nazwa wyświetlana osoby podpisającego
|
display_name | string | |
|
Pobrany użytkownik podpisy
|
downloaded | boolean | |
|
Adres e-mail sygnatariusza
|
|||
|
Wyświetlanie wiadomości e-mail użytkownika
|
email_viewed | boolean | |
|
Adres e-mail zalogowanego
|
emailed | boolean | |
|
Adres URL osadzania logowania
|
embed_url | uri | |
|
Identyfikator użytkownika osadzania adresu URL logowania
|
embed_url_user_id | string | |
|
Imię i nazwisko osoby podpisającego
|
first_name | string | |
|
Język wymuśniający znakatora
|
force_language | boolean | |
|
Użytkownik podpisjący przesłany dalej
|
forwarded | boolean | |
|
Użytkownik podpisy przekazany dalej
|
forwarded_on | date-time | |
|
Przyczyna przekazywania dalej przez sygnatariusza
|
forwarded_reason | string | |
|
Użytkownik podpisy przesłany dalej do wiadomości e-mail
|
forwarded_to_email | ||
|
Osoba do logowania
|
in_person | boolean |
W przypadku użycia w połączeniu z adresem URL osadzania w nadawcy po podpisaniu nadawcy zostaną one przekierowane do następnego |
|
Wejścia
|
inputs | array of SignerInputs | |
|
Język podpisywania
|
language | string | |
|
Nazwisko osoby podpisającego
|
last_name | string | |
|
Wiadomość dotycząca logowania
|
message | string | |
|
Użytkownik podpisy musi podpisać
|
needs_to_sign | boolean |
Jeśli |
|
Tylko powiadomienie o podpisie
|
notify_only | boolean |
Wysyłanie powiadomień o dokumencie i kopii podpisanego dokumentu i dziennika podpisywania, ale nie wymaga od nich podjęcia żadnej akcji, zobacz: Powiadom tylko |
|
Kolejność podpisywania
|
order | integer | |
|
Hasło użytkownika podpisywania
|
password | string |
Wymagaj od użytkownika wprowadzenia tego hasła przed podpisaniem dokumentu. To pole jest tylko do zapisu. |
|
Adres URL przekierowania logowania
|
redirect_url | uri | |
|
Odrzucono adres URL przekierowania użytkownika
|
redirect_url_declined | uri | |
|
Podpisany podpis
|
signed | boolean | |
|
Zalogowany użytkownik
|
signed_on | date-time | |
|
Osoba podpisjąca używa sygnatury tylko do zatwierdzania
|
use_stamp_for_approve_only | boolean |
Umieszczenie sygnatury zatwierdzenia w dokumencie, gdy osoba podpisjąca zatwierdzi dokument |
|
Signer Verify Bank Account
|
verify_bank_account | string | |
|
Signer Verify Phone Number
|
verify_phone_number | string | |
|
Wyświetlony użytkownik podpisy
|
viewed | boolean |
SignerAttachment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
File
|
file | uri | |
|
for_attachment
|
for_attachment | RequiredAttachment | |
|
Name
|
name | string |
Domyślnie nazwa pliku |
|
Uuid
|
uuid | string |
SignerInputs
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wartość pola wyboru
|
checkbox_value | boolean | |
|
Wartość daty
|
date_value | date | |
|
Identyfikator zewnętrzny
|
external_id | string | |
|
Indeks strony
|
page_index | integer | |
|
Identyfikator uuid symbolu zastępczego
|
placeholder_uuid | string | |
|
Tekst
|
text | string | |
|
Typ
|
type | string |
User
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa wyświetlana użytkownika
|
display_name | string | |
|
Adres e-mail użytkownika
|
|||
|
Imię użytkownika
|
first_name | string | |
|
Nazwisko użytkownika
|
last_name | string |