drawn_signature_on_a_touchscreen_device:'Drawn signature on a touchscreen device',
sign_on_the_touchscreen:'Sign on the touchscreen',
approved:'Approved',
reviewed:'Reviewed',
other:'Other',
@ -120,7 +120,7 @@ const es = {
select_a_reason:'Selecciona una razón',
value_is_invalid:'El valor no es válido',
verification_code_is_invalid:'El código de verificación no es válido',
drawn_signature_on_a_touchscreen_device:'Firma dibujada en un dispositivo con pantalla táctil',
sign_on_the_touchscreen:'Firmar en pantalla táctil',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'Escanea el código QR con la aplicación de la cámara para abrir el formulario en el móvil y dibujar tu firma',
by_clicking_you_agree_to_the:'Al hacer clic en "{button}", usted acepta el',
electronic_signature_disclosure:'Divulgación de Firma Electrónica',
@ -221,7 +221,7 @@ const it = {
select_a_reason:'Seleziona una ragione',
value_is_invalid:'Il valore non è valido',
verification_code_is_invalid:'Il codice di verifica non è valido',
drawn_signature_on_a_touchscreen_device:'Firma disegnata su un dispositivo con schermo tattile',
sign_on_the_touchscreen:'Firma su schermo tattile',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:"Scansiona il codice QR con l'app della fotocamera per aprire il modulo sul cellulare e disegnare la tua firma",
by_clicking_you_agree_to_the:'Cliccando su "{button}", accetti il',
electronic_signature_disclosure:'Divulgazione della Firma Elettronica',
@ -316,7 +316,7 @@ const de = {
esignature_disclosure:'Hinweis zur eSignatur',
signature:'Unterschrift',
initials:'Initialen',
drawn_signature_on_a_touchscreen_device:'Auf einem Touchscreen-Gerät gezeichnete Unterschrift',
drawn_signature_on_a_touchscreen_device:'Signature dessinée sur un appareil à écran tactile',
sign_on_the_touchscreen:'Signer sur écran tactile',
approved:'Approuvé',
reviewed:'Révisé',
other:'Autre',
@ -524,7 +524,7 @@ const pl = {
select_a_reason:'Wybierz powód',
value_is_invalid:'Wartość jest nieprawidłowa',
verification_code_is_invalid:'Kod weryfikacyjny jest nieprawidłowy',
drawn_signature_on_a_touchscreen_device:'Podpis odręczny na urządzeniu z ekranem dotykowym',
sign_on_the_touchscreen:'Podpisz na ekranie dotykowym',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'Zeskanuj kod QR za pomocą aplikacji aparatu, aby otworzyć formularz na telefonie i narysować swój podpis',
by_clicking_you_agree_to_the:'Klikając na "{button}", zgadzasz się na',
verification_code_is_invalid:'Код підтвердження є неправильним',
drawn_signature_on_a_touchscreen_device:'Підпис на сенсорному пристрої',
sign_on_the_touchscreen:'Підписати на сенсорному екрані',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'Скануйте QR-код за допомогою програми камери, щоб відкрити форму на мобільному пристрої та намалювати свій підпис',
by_clicking_you_agree_to_the:'Натиснувши на "{button}", ви погоджуєтеся з',
verification_code_is_invalid:'Ověřovací kód je neplatný',
drawn_signature_on_a_touchscreen_device:'Namalovaný podpis na dotykovém zařízení',
sign_on_the_touchscreen:'Podepsat na dotykové obrazovce',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'Naskenujte QR kód pomocí aplikace fotoaparátu, abyste otevřeli formulář na mobilním zařízení a nakreslili svůj podpis',
by_clicking_you_agree_to_the:'Kliknutím na "{button}" souhlasíte s',
verification_code_is_invalid:'Código de verificação é inválido',
drawn_signature_on_a_touchscreen_device:'Assinatura desenhada em um dispositivo com tela sensível ao toque',
sign_on_the_touchscreen:'Assinar na tela sensível',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'Escaneie o código QR com o aplicativo da câmera para abrir o formulário no celular e desenhar sua assinatura',
by_clicking_you_agree_to_the:'Ao clicar em "{button}", você concorda com o',
electronic_signature_disclosure:'Divulgação de Assinatura Eletrônica',
@ -928,7 +928,7 @@ const he = {
select_a_reason:'בחר סיבה',
value_is_invalid:'ערך לא תקין',
verification_code_is_invalid:'קוד האימות אינו תקין',
drawn_signature_on_a_touchscreen_device:'חתימה שנוצרה במכשיר עם מסך מגע',
sign_on_the_touchscreen:'חתום על מסך המגע',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'סרוק את קוד ה-QR באמצעות אפליקציית המצלמה כדי לפתוח את הטופס במובייל ולצייר את החתימה שלך',
by_clicking_you_agree_to_the:'על ידי לחיצה על "{button}", אתה מסכים ל',
verification_code_is_invalid:'Verificatiecode is ongeldig',
drawn_signature_on_a_touchscreen_device:'Getekende handtekening op een apparaat met een touchscreen',
sign_on_the_touchscreen:'Onderteken op touchscreen',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'Scan de QR-code met de camera-app om het formulier op mobiel te openen en uw handtekening te tekenen',
by_clicking_you_agree_to_the:'Door op "{button}" te klikken, gaat u akkoord met de',
electronic_signature_disclosure:'Openbaarmaking van Elektronische Handtekening',
@ -1131,7 +1131,7 @@ const ar = {
value_is_invalid:'القيمة غير صالحة',
verification_code_is_invalid:'رمز التحقق غير صالح',
already_paid:'تم الدفع بالفعل',
drawn_signature_on_a_touchscreen_device:'توقيع مرسوم على جهاز بشاشة تعمل باللمس',
sign_on_the_touchscreen:'وقع على شاشة اللمس',
scan_the_qr_code_with_the_camera_app_to_open_the_form_on_mobile_and_draw_your_signature:'امسح رمز الاستجابة السريعة باستخدام تطبيق الكاميرا لفتح النموذج على الهاتف المحمول ورسم توقيعك',
by_clicking_you_agree_to_the:'بالنقر فوق "{button}"، أنت توافق على',
v-if="isTextSignature && format !== 'typed_or_upload' && format !== 'typed' && format !== 'upload'"
class="tooltip"
class="md:tooltip"
:data-tip="t('draw_signature')"
>
<a
@ -39,7 +39,7 @@
</span>
<span
v-else-if="withTypedSignature && format !== 'drawn_or_upload' && format !== 'typed_or_upload' && format !== 'typed' && format !== 'drawn' && format !== 'upload'"
you_requested_to_reset_your_password_use_the_link_below_to_continue:You requested to reset your password. Use the link below to continue
if_you_didnt_request_this_you_can_ignore_this_email:"If you didn't request this, please ignore this email."
your_password_wont_change_until_you_open_the_link_above_and_set_a_new_one:"Your password won't change until you open the link above and set a new one."
too_many_requests_try_again_later:Too many requests, try again later.
devise:
confirmations:
confirmed:Your email address has been successfully confirmed.
@ -1847,6 +1848,7 @@ es: &es
you_requested_to_reset_your_password_use_the_link_below_to_continue:Solicitaste restablecer tu contraseña. Usa el enlace a continuación para continuar.
if_you_didnt_request_this_you_can_ignore_this_email:"Si no solicitaste esto, puedes ignorar este correo electrónico."
your_password_wont_change_until_you_open_the_link_above_and_set_a_new_one:"Tu contraseña no cambiará hasta que abras el enlace anterior y establezcas una nueva."
too_many_requests_try_again_later:Demasiadas solicitudes. Intenta de nuevo más tarde.
devise:
confirmations:
confirmed:Tu dirección de correo electrónico ha sido confirmada correctamente.
@ -2819,6 +2821,7 @@ it: &it
you_requested_to_reset_your_password_use_the_link_below_to_continue:Hai richiesto di reimpostare la tua password. Usa il link qui sotto per continuare.
if_you_didnt_request_this_you_can_ignore_this_email:"Se non hai richiesto questo, puoi ignorare questa email."
your_password_wont_change_until_you_open_the_link_above_and_set_a_new_one:"La tua password non cambierà finché non apri il link sopra e ne imposti una nuova."
too_many_requests_try_again_later:Troppe richieste. Riprova più tardi.
devise:
confirmations:
confirmed:Il tuo indirizzo email è stato confermato con successo.
@ -3787,6 +3790,7 @@ fr: &fr
you_requested_to_reset_your_password_use_the_link_below_to_continue:Vous avez demandé à réinitialiser votre mot de passe. Utilisez le lien ci-dessous pour continuer.
if_you_didnt_request_this_you_can_ignore_this_email:"Si vous n'avez pas fait cette demande, veuillez ignorer cet e-mail."
your_password_wont_change_until_you_open_the_link_above_and_set_a_new_one:"Votre mot de passe ne changera pas tant que vous n’aurez pas ouvert le lien ci-dessus et défini un nouveau mot de passe."
too_many_requests_try_again_later:Trop de demandes. Réessayez plus tard.
devise:
confirmations:
confirmed:Votre adresse e-mail a été confirmée avec succès.
@ -4758,6 +4762,7 @@ pt: &pt
you_requested_to_reset_your_password_use_the_link_below_to_continue:Você solicitou a redefinição da sua senha. Use o link abaixo para continuar.
if_you_didnt_request_this_you_can_ignore_this_email:"Se você não solicitou isso, pode ignorar este e-mail."
your_password_wont_change_until_you_open_the_link_above_and_set_a_new_one:"Sua senha não será alterada até que você abra o link acima e defina uma nova."
too_many_requests_try_again_later:Muitas solicitações. Tente novamente mais tarde.
devise:
confirmations:
confirmed:Seu endereço de e-mail foi confirmado com sucesso.
@ -5729,6 +5734,7 @@ de: &de
you_requested_to_reset_your_password_use_the_link_below_to_continue:Sie haben angefordert, Ihr Passwort zurückzusetzen. Verwenden Sie den untenstehenden Link, um fortzufahren.
if_you_didnt_request_this_you_can_ignore_this_email:"Wenn Sie dies nicht angefordert haben, können Sie diese E-Mail ignorieren."
your_password_wont_change_until_you_open_the_link_above_and_set_a_new_one:"Ihr Passwort wird erst geändert, wenn Sie den obigen Link öffnen und ein neues festlegen."
too_many_requests_try_again_later:Zu viele Anfragen. Versuchen Sie es später erneut.
devise:
confirmations:
confirmed:Ihre E-Mail-Adresse wurde erfolgreich bestätigt.
@ -5938,6 +5944,7 @@ pl:
the_sender_has_requested_a_two_factor_authentication_via_one_time_password_sent_to_your_email_html:Nadawca zażądał uwierzytelniania dwuskładnikowego za pośrednictwem hasła jednorazowego wysłanego na Twój adres e-mail <b>%{email}</b>.
please_contact_the_requester_to_specify_your_email_for_two_factor_authentication:Skontaktuj się z nadawcą, aby podać swój adres e-mail do uwierzytelniania dwuskładnikowego.
rate_limit_exceeded:Przekroczono limit
too_many_requests_try_again_later:Zbyt wiele żądań. Spróbuj ponownie później.
uk:
require_phone_2fa_to_open:Вимагати двофакторну автентифікацію через телефон для відкриття
@ -6034,6 +6041,7 @@ uk:
the_sender_has_requested_a_two_factor_authentication_via_one_time_password_sent_to_your_email_html:Відправник запросив двофакторну автентифікацію за допомогою одноразового пароля, відправленого на вашу електронну пошту <b>%{email}</b>.
please_contact_the_requester_to_specify_your_email_for_two_factor_authentication:Будь ласка, зв'яжіться з відправником, щоб вказати вашу електронну пошту для двофакторної автентифікації.
require_phone_2fa_to_open:Vyžadovat otevření pomocí telefonního 2FA
@ -6130,6 +6138,7 @@ cs:
the_sender_has_requested_a_two_factor_authentication_via_one_time_password_sent_to_your_email_html:Odesílatel požádal o dvoufaktorové ověření pomocí jednorázového hesla odeslaného na vaši e-mailovou adresu <b>%{email}</b>.
please_contact_the_requester_to_specify_your_email_for_two_factor_authentication:Prosím kontaktujte odesílatele a uveďte svůj e-mail pro dvoufaktorové ověření.
rate_limit_exceeded:Překročena hranice
too_many_requests_try_again_later:Příliš mnoho požadavků. Zkuste to později.
he:
require_phone_2fa_to_open:דרוש אימות דו-שלבי באמצעות טלפון לפתיחה
@ -6226,6 +6235,7 @@ he:
the_sender_has_requested_a_two_factor_authentication_via_one_time_password_sent_to_your_email_html:השולח ביקש אימות דו-שלבי באמצעות סיסמה חד-פעמית שנשלחה לכתובת הדוא"ל שלך <b>%{email}</b>.
please_contact_the_requester_to_specify_your_email_for_two_factor_authentication:אנא פנה לשולח וציין את כתובת הדוא"ל שלך לאימות דו-שלבי.
rate_limit_exceeded:חריגה ממגבלת
too_many_requests_try_again_later:יותר מדי בקשות. נסה שוב מאוחר יותר.
nl:&nl
templates_that_require_email_or_phone_2fa_cannot_be_used_via_a_shared_link:Sjablonen waarvoor e-mail- of telefoon-2FA vereist is, kunnen niet via een gedeelde link worden gebruikt.
@ -7081,6 +7091,7 @@ nl: &nl
you_requested_to_reset_your_password_use_the_link_below_to_continue:Je hebt gevraagd je wachtwoord te resetten. Gebruik de onderstaande link om verder te gaan.
if_you_didnt_request_this_you_can_ignore_this_email:"Als je dit niet hebt aangevraagd, kun je deze e-mail negeren."
your_password_wont_change_until_you_open_the_link_above_and_set_a_new_one:"Je wachtwoord wordt niet gewijzigd totdat je de bovenstaande link opent en een nieuw wachtwoord instelt."
too_many_requests_try_again_later:Te veel verzoeken. Probeer het later opnieuw.
devise:
confirmations:
confirmed:Je e-mailadres is succesvol bevestigd.
@ -7290,6 +7301,7 @@ ar:
the_sender_has_requested_a_two_factor_authentication_via_one_time_password_sent_to_your_email_html:طلب المرسل المصادقة الثنائية عبر كلمة مرور لمرة واحدة مرسلة إلى عنوان بريدك الإلكتروني <b>%{email}</b>.
please_contact_the_requester_to_specify_your_email_for_two_factor_authentication:يرجى الاتصال بالمرسل لتحديد عنوان بريدك الإلكتروني للمصادقة الثنائية.
rate_limit_exceeded:تم تجاوز الحد المسموح به
too_many_requests_try_again_later:طلبات كثيرة جدًا. حاول مرة أخرى لاحقًا.
ko:
require_phone_2fa_to_open:휴대폰 2FA를 열 때 요구함
@ -7386,6 +7398,7 @@ ko:
the_sender_has_requested_a_two_factor_authentication_via_one_time_password_sent_to_your_email_html:발신자가 <b>%{email}</b> 이메일 주소로 전송된 일회용 비밀번호를 통해 2단계 인증을 요청했습니다.
please_contact_the_requester_to_specify_your_email_for_two_factor_authentication:2단계 인증을 위해 이메일 주소를 지정하려면 발신자에게 문의하세요.
rate_limit_exceeded:속도 제한 초과
too_many_requests_try_again_later:요청이 너무 많습니다. 나중에 다시 시도하세요.
"description": "Public URL of the document signing form. There are two types of URLs: <li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li>"
"description": "Public URL of the document signing form. There are two types of URLs: <ulclass=\"list-insidelist-disc\"><li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li></ul>"
"description": "Public URL of the document signing form. There are two types of URLs: <li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li>"
"description": "Public URL of the document signing form. There are two types of URLs: <ul class=\"list-insidelist-disc\"><li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li></ul>"
"description": "Public URL of the document signing form. There are two types of URLs: <li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li>"
"description": "Public URL of the document signing form. There are two types of URLs: <ulclass=\"list-insidelist-disc\"><li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li></ul>"
"description": "Public URL of the document signing form. There are two types of URLs: <li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li>"
"description": "Public URL of the document signing form. There are two types of URLs: <ulclass=\"list-insidelist-disc\"><li><code>/d/{slug}</code> - template form signing URL can be copied from the template page in the admin dashboard. Also template \"slug\" key can be obtained via the <code>/templates</code> API.</li><li><code>/s/{slug}</code> - individual signer URL. Signer \"slug\" key can be obtained via the <code>/submissions</code> API which is used to initiate signature requests for a template form with recipients.</li></ul>"
"description":"Horizontal alignment of the field text value."
@ -300,6 +305,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -714,7 +726,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -740,6 +753,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -763,6 +780,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -1782,6 +1806,11 @@
"description":"Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.",
"default":false
},
"require_email_2fa":{
"type":"boolean",
"description":"Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.",
"default":false
},
"message":{
"type":"object",
"properties":{
@ -1933,6 +1962,15 @@
],
"default":"black"
},
"background":{
"type":"string",
"description":"Field box background color.",
"enum":[
"black",
"white",
"blue"
]
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value.",
@ -1986,6 +2024,13 @@
}
],
"default":false
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
}
@ -2622,6 +2667,10 @@
"event_timestamp":{
"type":"string",
"description":"Date and time when the event was triggered."
},
"data":{
"type":"object",
"description":"Additional event details object."
}
}
}
@ -2733,7 +2782,8 @@
"id":1,
"submitter_id":2,
"event_type":"view_form",
"event_timestamp":"2023-12-14T15:47:24.566Z"
"event_timestamp":"2023-12-14T15:47:24.566Z",
"data":{}
}
],
"documents":[
@ -3318,7 +3368,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"role":{
@ -3471,6 +3522,15 @@
"description":"Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.",
"default":false
},
"require_email_2fa":{
"type":"boolean",
"description":"Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.",
"default":false
},
"invite_by":{
"type":"string",
"description":"Set the role name of the previous party that should invite this party via email."
},
"fields":{
"type":"array",
"description":"A list of configurations for document form fields.",
@ -3609,6 +3669,15 @@
],
"default":"black"
},
"background":{
"type":"string",
"description":"Field box background color.",
"enum":[
"black",
"white",
"blue"
]
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value.",
@ -3662,6 +3731,13 @@
}
],
"default":false
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
}
@ -3744,7 +3820,6 @@
"type":"object",
"required":[
"id",
"submission_id",
"uuid",
"email",
"slug",
@ -3833,6 +3908,53 @@
"awaiting"
]
},
"values":{
"type":"array",
"description":"An array of pre-filled values for the submitter.",
"items":{
"type":"object",
"required":[
"field",
"value"
],
"properties":{
"field":{
"type":"string",
"description":"Document template field name."
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array",
"items":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
}
]
}
}
],
"description":"Pre-filled value of the field."
}
}
}
},
"role":{
"type":"string",
"description":"The role of the submitter."
@ -3944,7 +4066,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -3970,6 +4093,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -3993,6 +4120,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -4040,27 +4174,6 @@
}
}
},
"documents":{
"type":"array",
"description":"List of documents attached to the one-off submission.",
"items":{
"type":"object",
"required":[
"attachment_uuid",
"name"
],
"properties":{
"attachment_uuid":{
"type":"string",
"description":"Unique indentifier of attached document to the one-off submission."
},
"name":{
"type":"string",
"description":"Name of the attached document to the one-off submission."
}
}
}
},
"expire_at":{
"type":"string",
"description":"Specify the expiration date and time after which the submission becomes unavailable for signature.",
@ -4158,7 +4271,7 @@
"Submissions"
],
"summary":"Create a submission from DOCX",
"description":"The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use <code>[[variable_name]]</code> text tags to define dynamic content variables in the document. See <a href=\"https://www.docuseal.com/examples/demo_template.docx\" target=\"_blank\" class=\"link font-bold\">https://www.docuseal.com/examples/demo_template.docx</a> for the specific text variable syntax, including dynamic content tables and list. You can also use the <code>{{signature}}</code> fillable field syntax to define fillable fields, as in a PDF.<br><b>Related Guides</b><br><a href=\"https://www.docuseal.com/guides/use-embedded-text-field-tags-in-the-pdf-to-create-a-fillable-form\" class=\"link\">Use embedded text field tags to create a fillable form</a>",
"description":"The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use <code>[[variable_name]]</code> text tags to define dynamic content variables in the document. See <a href=\"https://www.docuseal.com/examples/demo_template.docx\" target=\"_blank\" class=\"link font-bold\">https://www.docuseal.com/examples/demo_template.docx</a> for the specific text variable syntax, including dynamic content tables and list. You can also use the <code>{{signature}}</code> field syntax to define fillable fields, as in a PDF.<br><b>Related Guides</b><br><a href=\"https://www.docuseal.com/guides/use-dynamic-content-variables-in-docx-to-create-personalized-documents\" class=\"link\">Use dynamic content variables in DOCX to create personalized documents</a>",
"operationId":"createSubmissionFromDocx",
"parameters":[],
"requestBody":{
@ -4189,7 +4302,7 @@
},
"variables":{
"type":"object",
"description":"Dynamic content variables object",
"description":"Dynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.",
"example":{
"variable_name":"value"
}
@ -4327,6 +4440,15 @@
"description":"Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.",
"default":false
},
"require_email_2fa":{
"type":"boolean",
"description":"Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.",
"default":false
},
"invite_by":{
"type":"string",
"description":"Set the role name of the previous party that should invite this party via email."
},
"fields":{
"type":"array",
"description":"A list of configurations for document form fields.",
@ -4465,6 +4587,15 @@
],
"default":"black"
},
"background":{
"type":"string",
"description":"Field box background color.",
"enum":[
"black",
"white",
"blue"
]
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value.",
@ -4518,6 +4649,13 @@
}
],
"default":false
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
}
@ -4595,7 +4733,6 @@
"type":"object",
"required":[
"id",
"submission_id",
"uuid",
"email",
"slug",
@ -4684,6 +4821,53 @@
"awaiting"
]
},
"values":{
"type":"array",
"description":"An array of pre-filled values for the submitter.",
"items":{
"type":"object",
"required":[
"field",
"value"
],
"properties":{
"field":{
"type":"string",
"description":"Document template field name."
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array",
"items":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
}
]
}
}
],
"description":"Pre-filled value of the field."
}
}
}
},
"role":{
"type":"string",
"description":"The role of the submitter."
@ -4795,7 +4979,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -4821,6 +5006,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -4844,6 +5033,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -4891,27 +5087,6 @@
}
}
},
"documents":{
"type":"array",
"description":"List of documents attached to the one-off submission.",
"items":{
"type":"object",
"required":[
"attachment_uuid",
"name"
],
"properties":{
"attachment_uuid":{
"type":"string",
"description":"Unique indentifier of attached document to the one-off submission."
},
"name":{
"type":"string",
"description":"Name of the attached document to the one-off submission."
}
}
}
},
"expire_at":{
"type":"string",
"description":"Specify the expiration date and time after which the submission becomes unavailable for signature.",
@ -5198,6 +5373,15 @@
"description":"Set to `true` to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.",
"default":false
},
"require_email_2fa":{
"type":"boolean",
"description":"Set to `true` to require email 2FA verification via a one-time code sent to the email address in order to access the documents.",
"default":false
},
"invite_by":{
"type":"string",
"description":"Set the role name of the previous party that should invite this party via email."
},
"fields":{
"type":"array",
"description":"A list of configurations for document form fields.",
@ -5336,6 +5520,15 @@
],
"default":"black"
},
"background":{
"type":"string",
"description":"Field box background color.",
"enum":[
"black",
"white",
"blue"
]
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value.",
@ -5389,6 +5582,13 @@
}
],
"default":false
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
}
@ -5461,7 +5661,6 @@
"type":"object",
"required":[
"id",
"submission_id",
"uuid",
"email",
"slug",
@ -5550,6 +5749,53 @@
"awaiting"
]
},
"values":{
"type":"array",
"description":"An array of pre-filled values for the submitter.",
"items":{
"type":"object",
"required":[
"field",
"value"
],
"properties":{
"field":{
"type":"string",
"description":"Document template field name."
},
"value":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
},
{
"type":"array",
"items":{
"oneOf":[
{
"type":"string"
},
{
"type":"number"
},
{
"type":"boolean"
}
]
}
}
],
"description":"Pre-filled value of the field."
}
}
}
},
"role":{
"type":"string",
"description":"The role of the submitter."
@ -5661,7 +5907,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -5687,6 +5934,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -5710,6 +5961,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -5757,27 +6015,6 @@
}
}
},
"documents":{
"type":"array",
"description":"List of documents attached to the one-off submission.",
"items":{
"type":"object",
"required":[
"attachment_uuid",
"name"
],
"properties":{
"attachment_uuid":{
"type":"string",
"description":"Unique indentifier of attached document to the one-off submission."
},
"name":{
"type":"string",
"description":"Name of the attached document to the one-off submission."
}
}
}
},
"expire_at":{
"type":"string",
"description":"Specify the expiration date and time after which the submission becomes unavailable for signature.",
@ -6078,6 +6315,10 @@
"event_timestamp":{
"type":"string",
"description":"Date and time when the event was triggered."
},
"data":{
"type":"object",
"description":"Additional event details object."
}
}
}
@ -6185,7 +6426,8 @@
"id":12,
"submitter_id":7,
"event_type":"view_form",
"event_timestamp":"2023-12-14T15:47:17.351Z"
"event_timestamp":"2023-12-14T15:47:17.351Z",
"data":{}
}
],
"values":[
@ -6435,6 +6677,15 @@
],
"default":"black"
},
"background":{
"type":"string",
"description":"Field box background color.",
"enum":[
"black",
"white",
"blue"
]
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value.",
@ -6488,6 +6739,13 @@
}
],
"default":false
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
}
@ -6990,6 +7248,10 @@
"event_timestamp":{
"type":"string",
"description":"Date and time when the event was triggered."
},
"data":{
"type":"object",
"description":"Additional event details object."
}
}
}
@ -7126,7 +7388,8 @@
"id":12,
"submitter_id":7,
"event_type":"view_form",
"event_timestamp":"2023-12-14T15:48:17.351Z"
"event_timestamp":"2023-12-14T15:48:17.351Z",
"data":{}
}
],
"values":[
@ -7346,7 +7609,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -7372,6 +7636,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -7395,6 +7663,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -7793,7 +8068,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -7819,6 +8095,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -7842,6 +8122,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -8294,7 +8581,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -8320,6 +8608,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -8343,6 +8635,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -8674,7 +8973,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"role":{
@ -8812,6 +9112,15 @@
],
"default":"black"
},
"background":{
"type":"string",
"description":"Field box background color.",
"enum":[
"black",
"white",
"blue"
]
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value.",
@ -8865,6 +9174,13 @@
}
],
"default":false
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
}
@ -8989,7 +9305,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -9015,6 +9332,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -9038,6 +9359,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -9369,7 +9697,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"role":{
@ -9515,6 +9844,15 @@
],
"default":"black"
},
"background":{
"type":"string",
"description":"Field box background color.",
"enum":[
"black",
"white",
"blue"
]
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value.",
@ -9568,6 +9906,13 @@
}
],
"default":false
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
}
@ -9702,7 +10047,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -9728,6 +10074,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -9751,6 +10101,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
"type":"array",
"items":{
"type":"string"
}
}
}
},
@ -10169,7 +10526,8 @@
"stamp",
"payment",
"phone",
"verification"
"verification",
"strikethrough"
]
},
"required":{
@ -10195,6 +10553,10 @@
"type":"string",
"description":"Font color of the field value."
},
"background":{
"type":"string",
"description":"Field box background color."
},
"align":{
"type":"string",
"description":"Horizontal alignment of the field text value."
@ -10218,6 +10580,13 @@
"mask":{
"type":"boolean",
"description":"Indicates if the field is masked on the document."
},
"reasons":{
"description":"An array of signature reasons to choose from.",
Alex Turchyn
1 day ago
committed by
GitHub