...
Please also see the next figure for an overview of the envelope structure:
Image Removed
Image Added
For a basic guide of REST and the different API calls please also have a look at our Postman tutorial.
...
The next screenshot shows the document after sending the configuration:
Image Removed
Image Added
With this configuration we can now add the settings which are mentioned above. First, lets start with the envelope configuration.
...
| Code Block |
|---|
|
{
"Documents": [
{
"FileId": "1234ddc4-1234-1234-1234-3af31c131234",
"DocumentNumber": 1
}
],
"Name": "Test.pdf",
"AddDocumentTimestamp": false,
"ShareWithTeam": true,
"LockFormFieldsOnFinish": false,
"Activities": [
{
"Action": {
"SignAutomatic": {
"ProfileId": "12347562-1234-1234-1234-5a43184d1234",
"RenderingLanguageCode": "EN",
"VisibleSignatures": [
{
"DocumentNumber": 1,
"UseExternalTimestampServer": false,
"FieldDefinition": {
"Position": {
"PageNumber": 1,
"X": 68.0,
"Y": 631.8
},
"Size": {
"Width": 190.0,
"Height": 80.0
}
}
}
]
}
},
"VisibilityOptions": [
{
"DocumentNumber": 1,
"IsHidden": false
}
]
}
],
"EmailConfiguration": {
"Subject": "Please sign the enclosed envelope",
"Message": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease
#PersonalMessage#
Please sign the envelope #EnvelopeName#\n\nEnvelope
Envelope will expire at #ExpirationDate#"
},
"ReminderConfiguration": {
"Enabled": true,
"FirstReminderInDays": 5,
"ReminderResendIntervalInDays": 3,
"BeforeExpirationInDays": 3
},
"ExpirationConfiguration": {
"ExpirationInSecondsAfterSending": 2419200
}
} |
...
| Code Block |
|---|
|
{
"Documents": [
{
"FileId": "264addc4-1234-1234-1234-3af31c13b3c2",
"DocumentNumber": 1
}
],
"Name": "Test.pdf",
"AddDocumentTimestamp": false,
"ShareWithTeam": true,
"LockFormFieldsOnFinish": false,
"Activities": [
{
"Action": {
"View": {
"RecipientConfiguration": {
"ContactInformation": {
"Email": "john.doe@sample.com",
"GivenName": "John",
"Surname": "Doe",
"LanguageCode": "EN"
},
"SendEmails": true,
"AllowAccessAfterFinish": true
},
"ViewingGroup": "1"
}
},
"VisibilityOptions": [
{
"DocumentNumber": 1,
"IsHidden": false
}
]
},
{
"Action": {
"SendCopy": {
"RecipientConfiguration": {
"ContactInformation": {
"Email": "jane.doe@sample.com",
"GivenName": "Jane",
"Surname": "Doe",
"LanguageCode": "EN"
}
},
"CopyingGroup": "2"
}
},
"VisibilityOptions": [
{
"DocumentNumber": 1,
"IsHidden": false
}
]
}
],
"EmailConfiguration": {
"Subject": "Please sign the enclosed envelope",
"Message": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease
#PersonalMessage#
Please sign the envelope #EnvelopeName#\n\nEnvelope
Envelope will expire at #ExpirationDate#"
},
"ReminderConfiguration": {
"Enabled": true,
"FirstReminderInDays": 5,
"ReminderResendIntervalInDays": 3,
"BeforeExpirationInDays": 3
},
"ExpirationConfiguration": {
"ExpirationInSecondsAfterSending": 2419200
}
} |
...
| Value | Description |
|---|
| intersects with field | The signature has to start within the signature field, signing must intersect with the field but the signer is allowed to leave the boundaries of the box while signingsignature field |
| within field | The signature must be completely within the boundaries of the signature field |
| on page | The signature can start anywhere on the page, even without intersecting with the signature field |
...
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | DataFields |
|---|
|
"DateFields": [
{
"ElementId": "string",
"DocumentNumber": 0,
"DateFormat": "string",
"FieldDefinition": {
"TextFormat": {
"TextColor": "string",
"FontSizeInPt": 0,
"FontName": "string",
"Bold": true,
"Italic": true,
"TextAlign": "Left"
},
"Position": {
"PageNumber": 0,
"X": 0,
"Y": 0
},
"Size": {
"Width": 0,
"Height": 0
}
}
}
]
}, |
Additional envelope information
Additionally to the envelope information you can find above in the section "envelope configuration" you can configure the following:
- Email configuration
- Reminder configuration
- Expiration configuration
- Callback configuration
- Agreement configuration
Email configuration
FinishActionConfiguration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Email Finish action configuration |
|---|
|
"EmailConfigurationFinishActionConfiguration": {
"Subject "SignAnyWhereViewer": "string",
{
"Body "RedirectUri": "string",
"SenderDisplayName": "string"
}, |
Reminder configuration
},
"SignificantClientSignatureCaptureForIos": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForAndroid": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"SignificantClientSignatureCaptureForWindows": {
"RemoveDocumentFromRecentDocumentList": true,
"CallClientActionOnlyAfterSuccessfulSync": true,
"CloseApp": true,
"RedirectUri": "string"
},
"KioskSdk": {
"RedirectUri": "string"
}
}, |
Additional envelope information
Additionally to the envelope information you can find above in the section "envelope configuration" you can configure the following:
- Email configuration
- Reminder configuration
- Expiration configuration
- Callback configuration
- Agreement configuration
Email configuration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Email configuration |
|---|
|
"EmailConfiguration": {
"Subject": "string",
"Body": "string",
"SenderDisplayName": "string"
}, |
Reminder configuration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Reminder configuration |
|---|
|
"ReminderConfiguration": {
"Enabled": true,
"FirstReminderInDays": 0,
"ReminderResendIntervalInDays": 0,
"BeforeExpirationInDays": 0
}, |
...
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Callback configuration |
|---|
|
"CallbackConfiguration": {
"CallbackUrl": "string",
"StatusUpdateCallbackUrl": "string",
"StepActionCallbackConfigurationActivityActionCallbackConfiguration": {
"Url": "string",
"ActionCallbackSelection": {
"ConfirmTransactionCode": true,
"DefaultEventType": true,
"AgreementAccepted": true,
"AgreementRejected": true,
"RequestPrepareAuthenticationInformationSuccess": true,
"PrepareAuthenticationSuccess": true,
"AuthenticationFailed": true,
"AuthenticationRejected": true,
"AuthenticationSuccess": true,
"ReAuthenticationFailed": true,
"AuditTrailRequested": true,
"AuditTrailXmlRequested": true,
"CalledPage": true,
"WhoIsInformation": true,
"DocumentDownloaded": true,
"FlattenedDocumentDownloaded": true,
"AddedAnnotation": true,
"AddedAttachment": true,
"AppendedDocument": true,
"FormsFilled": true,
"ConfirmReading": true,
"PageViewChanged": true,
"SendTransactionCode": true,
"PrepareSignWorkstepDocument": true,
"SignWorkstepDocument": true,
"UndoAction": true,
"WorkstepCreated": true,
"WorkstepFinished": true,
"WorkstepRejected": true,
"DisablePolicyAndValidityChecks": true,
"EnablePolicyAndValidityChecks": true,
"AppendFileToWorkstep": true,
"AppendTasksToWorkstep": true,
"SetOptionalDocumentState": true,
"PreparePayloadForBatch": true
}
}
}, |
...
