|
POST /Documents |
Scroll |
This method is called from the Workflow when executing a "Send for Signing" task.
It uploads the document to the eSignature provider and returns a document id from the provider.
Request
Sample body:
{
"subject": "Email subject",
"template": "456",
"context": "",
"setSigningOrder": false,
"recipients": [
{
"signerproperty": "value"
}
],
"additionalSettings": {
"sampleSetting": "settingValue"
},
"templateFields": {
"1234": "text for the template field"
},
"filesToSign": [
{
"originalName": "filename.pdf",
"fileBase64": "<base64 encoded file content>"
}
],
"notificationUrl": "http://localhost:5000/CustomSigning/",
"tenant": ""
}
Parameter Name |
Type |
Description |
subject |
String |
From the "Subject" field in the Workflow Task. Usually used to set the subject of the email sent from the eSignature provider to the signatory. |
template |
String |
The id of the template from the eSignature provider selected in the Workflow Task. It can be empty. |
context |
String |
The context setting of the Workflow Task. This has to be added to the document in order for the Therefore™ Content Connector to make use of the context. It can be empty. Some eSignature providers may not have a feature to use this. |
setSigningOrder |
Boolean |
Defines whether the signatories set in recipients have to sign in the specified order or not. Some eSignature providers may not support this. |
additionalSettings |
List of key/value pairs |
Defined in the response of <Root>. |
templateFields |
List of key/value pairs |
The keys are the template field ids returned by /Templates/{TemplateID}. The values are content for the fields. |
filesToSign |
List of Objects |
Each object represents a file for signing. Some providers might not support uploading of multiple files for one signing process. |
originalName |
String |
The file name of the file to be uploaded. |
fileBase64 |
String |
The base64 encoded content of the file to be uploaded. |
notificationUrl |
String |
The URL of the service. This is from the "eSignature Service Base URL" setting in Designer. Can be used for setting up the push notification if the eSignature provider supports to set it when uploading a document. |
tenant |
String |
The tenant name in the Therefore™ system. To be used with the notification Url for push notifications. |
Response
Sample body:
{
"id": "2345"
}
Parameter Name |
Type |
Description |
id |
String |
The document id from the provider of the document uploaded. This will be saved in the Therefore™ database. |
