You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/API-docs/opensign.yaml
+64-1Lines changed: 64 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -289,7 +289,7 @@ paths:
289
289
content:
290
290
application/json:
291
291
schema:
292
-
$ref: '#/components/schemas/createdocument_body'
292
+
$ref: '#/components/schemas/draftdocument_body'
293
293
required: true
294
294
responses:
295
295
"200":
@@ -1543,9 +1543,72 @@ components:
1543
1543
type: boolean
1544
1544
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
1545
1545
example: false
1546
+
draftdocument_body:
1547
+
required:
1548
+
- file
1549
+
- title
1550
+
type: object
1551
+
properties:
1552
+
file:
1553
+
type: string
1554
+
format: base64
1555
+
example: base64 encoded pdf
1556
+
title:
1557
+
type: string
1558
+
format: string
1559
+
example: sample document
1560
+
description:
1561
+
type: string
1562
+
format: string
1563
+
example: sample Description
1564
+
note:
1565
+
type: string
1566
+
format: string
1567
+
example: sample Note
1568
+
timeToCompleteDays:
1569
+
type: number
1570
+
description: time to complete days is used to calculate expiry date of your document
description: "This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used. \n"
1583
+
example: true
1584
+
email_subject:
1585
+
type: string
1586
+
description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
1587
+
example: ""
1588
+
email_body:
1589
+
type: string
1590
+
description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."
1591
+
example: ""
1592
+
sendInOrder:
1593
+
type: boolean
1594
+
description: "If set to 'true', only the first signer will receive the signature request email initially. Emails to subsequent signers will be triggered sequentially, with each sent only after the previous signer has completed their signing. By default, sendInOrder is set to 'true'."
1595
+
example: true
1596
+
enableOTP:
1597
+
type: boolean
1598
+
description: "true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."
1599
+
example: false
1600
+
enableTour:
1601
+
type: boolean
1602
+
description: "true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."
1603
+
example: false
1604
+
email_sender_name:
1605
+
type: string
1606
+
description: name or email of the person or organization on the behalf of which you are sending the mail.
0 commit comments