This sample case guides you through the structure of a configuration of the workstep. Generally the following steps are necessary to test the workstep configuration.:
- Upload a file
- Create a workstep configuration
- Send an envelope
Please also see the next figure for an overview of the envelope structure:
Image Added
For a basic guide of REST and the different API calls please also have a look at our Postman tutorial.
Upload a file
First, you will need a PDF document which you want to upload.
For REST you need You can upload a file with the following URL:
https://demo.esignanywhere.net/Api/
...
v6/
...
file/
...
For SOAP you need the API call UploadTemporarySspFile_v1
For this call you need an authentication. For authentication, you’ll need an api token. You can find this information in Settings / Api Tokens and Apps. Note that all API methods require authentication. For more information about the authorization please have a look the API Reference Guide for SOAP or the Postman Guide for REST
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
After the authorization you need to BASE64 the PDF which you want to upload. If the call was successful you get a file Id which we will need for sending an envelope. |
Workstep configuration
...
upload
The result of the API call is the FileId which will be needed for the sending call.
Configuration
The configuration is the core of the envelope. Within the workstep configuration you can define following settings:
- AdditionalClientWorkstepInformation
- Viewer preferences
- Policy
- Sender and receiver information
- Workstep tasks
- Signature template
- Authentication
- PdfForms
Empty workstep
...
- Envelope configuration
- Name
- Meta data
- Document time stamp etc.
- Unassigned elements
- Textboxes
- Radio buttons
- signatures etc.
- Activities
- Action
- Sign
- Recipient configuration
- Authentication configuration
- View
- Recipient configuration
- Authentication configuration
- Sign automatic etc.
- SignAsP7M
- Visibility options
- Email configuration
- Reminder configuration
- Expiration configuration
- Callback configuration
- Agreement configuration
Starting configuration
Lets start with a nearly empty configuration first. Then fill it step by step with the settings above. In the next collapse you can find an empty workstep (change ##EMAIL## to the email-address and ”NAME## to the name of the recipient you want to send the envelopethe sample configuration which includes one action (ClickToSign):
| Code Block |
|---|
|
{
"SspFileIdsDocuments": [{
"##FileId##"
],
"SendEnvelopeDescription": {
"NameFileId": "testc5a229ae-1234-1234-b6e8-d4eb9fd7bcf5",
"EmailSubject": "Please sign the enclosed envelope",
"EmailBodyDocumentNumber": 1
"Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
"DisplayedEmailSender }
],
"Name": "Test",
"EnableRemindersActivities": true,[{
"FirstReminderDayAmount": 5,
"RecurrentReminderDayAmountAction": 3,{
"BeforeExpirationDayAmount": 3,
"DaysUntilExpire": 28,
"CallbackUrl": "",
"StatusUpdateCallbackUrl": "",
"Steps": [
"Sign": {
{
"OrderIndex": 1,
"RecipientsRecipientConfiguration": [{
{
"EmailContactInformation": "##EMAIL##",{
"FirstName": "##NAME##",
"LastNameEmail": "##NAME##janedoe@sample.com",
"LanguageCode": "en",
"EmailBodyExtraGivenName": "Jane",
"DisableEmail": false,
"AddAndroidAppLinkSurname": false"Doe",
"AddIosAppLink": false,
"AddWindowsAppLinkLanguageCode": false,"EN"
"AllowDelegation": true,
"SkipExternalDataValidation": false,
}
"AuthenticationMethods": []
}
]},
"EmailBodyExtra": "",
"RecipientType": "Signer",
"WorkstepConfigurationElements": {
"WorkstepLabel": "test",
"SmallTextZoomFactorPercent": 100,
"FinishActionSignatures": [{
"ServerActions": [],
"ClientActions": []
},
"TaskConfiguration": {
"TransactionCodePushPluginData": [],
"TransactionCodeConfigurationsOrderDefinition": [{
{
}
],
"SignatureConfigurations": [],
"ViewerPreferencesOrderIndex": {0
"FinishWorkstepOnOpen": false,
"VisibleAreaOptions": {
"AllowedDomain": "*", }
"Enabled": false
}
},
"Policy": {
"WorkstepTasksId": {
"sample sig clicktosign",
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolutionRequired": 0true,
"PictureAnnotationColorDepth": "Color16M",
"SequenceModeDocumentNumber": "NoSequenceEnforced"1,
"PositionUnits": "PdfUnits",
"ReferenceCornerDisplayName": "Lower_LeftSign here",
"Tasks": []
}
}
"AllowedSignatureTypes": {
},
"DocumentOptions": [
{
"DocumentReferenceClickToSign": "1",{
"IsHidden": false
}
],
"UseDefaultAgreements": true
},
{
"OrderIndex": 2,
"Recipients": [
{},
"Email": "##EMAIL##",
"FirstName": "##NAME##",
"LastNameFieldDefinition": "##NAME##",{
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmailPosition": false,{
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegationPageNumber": false1,
"SkipExternalDataValidation": false,
"AuthenticationMethods": []
}
],
"EmailBodyExtraX": ""100,
"RecipientType": "Cc",
"DocumentOptions": [],
"UseDefaultAgreements": false
}
],
"AddFormFields": {
"Forms": {}
},
"OverrideFormFieldValuesY": {200
"Forms": {}
},
"AttachSignedDocumentsToEnvelopeLog": false
}
} |
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
| Code Block |
|---|
|
|
<envelope>
<name>eSignAnyWhere
Tutorial</name>
<eMailSubject>Document
of
eSignAnyWhere
Tutorial</eMailSubject>
<eMailBody>Dear
#RecipientFirstName#!
Please
sign
this
tutorial
document.</eMailBody>
<enableReminders>True</enableReminders>
<firstReminderDayAmount>1</firstReminderDayAmount>},
<recurrentReminderDayAmount>1</recurrentReminderDayAmount>
<beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
<daysUntilExpire>2</daysUntilExpire>
<!--
callback
to
your
backend
system
on
a
completed
envelope
<callbackUrl>http://172.16.17.78:57550/default.aspx?EnvelopeId=##EnvelopeId##&myParamForMe=1234</callbackUrl>
-->
<callbackUrl
/>
"Size":
<steps>{
<step>
<emailBodyExtra
/>
<orderIndex>1</orderIndex>
<recipientType>Signer</recipientType>
"Width": 100,
<recipients>
<recipient>
<languageCode>en</languageCode>
"Height": 70
<eMail>##EMAIL##</eMail>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
}
</recipient>
</recipients> }
<workstepConfiguration>
<WorkstepLabel
/>
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
<WorkstepTimeToLiveInMinutes>11520</WorkstepTimeToLiveInMinutes>
<FinishAction
/>}
<ViewerPreferences>
</ViewerPreferences>
<signatureTemplate>
</signatureTemplate>
<Policy
version="1.1.0.0">
<GeneralPolicies> ]
</GeneralPolicies>
<WorkstepTasks
SequenceMode="SequenceOnlyRequiredTasks"
originalSequenceMode="SequenceOnlyRequiredTasks"> },
</WorkstepTasks>
</Policy>
<TransactionCodeConfigurations>
<TransactionCodeConfiguration trConfId="">"SigningGroup": "firstSigner"
}
</TransactionCodeConfiguration>
</TransactionCodeConfigurations>
</workstepConfiguration> }
</step>}
</steps>
</envelope>
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
The highlighted text in the SOAP tab is the workstep configuration. Everything around the text is the envelope description. This description is used to define for example the recipients who should get the envelope. In this case the envelope description contains one recipient. |
...
Image Removed
With this empty workstep configuration we can now add the settings which are mentioned above. First, let us start with the viewer preferences.
Prepare envelope
...
The next screenshot shows the document after sending the configuration:
Image Added
With this configuration we can now add the settings which are mentioned above. First, lets start with the envelope configuration.
Envelope configuration
You can place the general policies directly below the following row:
| Code Block |
|---|
|
{
"SspFileIdsName": [
"##FileId##string"
],
"AdHocWorkstepConfigurationMetaData": {
"WorkstepLabel": "string",
"SmallTextZoomFactorPercentAddDocumentTimestamp": 0true,
"WorkstepTimeToLiveInMinutesShareWithTeam": 0true,
"FinishActionLockFormFieldsOnFinish": {
"ClientActions": [
{
"RemoveDocumentFromRecentDocumentList": true,
true, |
Unassigned elements
This section contains all elements which were not assigned to a specific recipient. This results for example from adding so called sig-string to the document. For example, the SIGNificant Server Platform, analyzes PDF documents and searches for so-called 'sig-strings'. When found, a signature field is inserted exactly on this position of the document.
Such elements could be:
- PDF form fields
- Textboxes, Checkboxes, Comoboxes, Radio buttons, Listboxes
- Signatures
- Predefined field elements
Attachments
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Attachments |
|---|
|
"Attachments": [
{
"CallClientActionOnlyAfterSuccessfulSync "ElementId": true"string",
"ClientNameDocumentNumber": "string"0,
"CloseAppRequired": true,
"ActionFileName": "string",
}
]"DisplayIconType": "Paperclip",
},
"NoSequenceEnforcedFieldDefinition": true,{
"SigTemplate": {
"SizePosition": {
"HeightPageNumber": 0,
"WidthX": 0,
},
"AllowedSignatureTypesY": [0
},
]
},
"ParseFormFieldsSize": {
"MapRequiredFieldsToRequiredTaskWidth": true0,
"FormsGrouping": "PerPage",
"ReturnSimplifiedConfigHeight": true,0
"AddKeepExistingValueFlag": true,
}
"ParseFormField": true
},
"AdhocPoliciesTaskConfiguration": {
"AllowModificationsAfterSignatureOrderDefinition": true{
},
"ViewerPreferencesOrderIndex": {0
"ShowPageNavigationBar": true, }
"ShowThumbnails": true, }
"SkipFinishConfirmDialog}
], |
Link configuration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Link configuration |
|---|
|
"LinkConfiguration": true,{
"SkipDocumentDialogHyperLinks": true,[
"ShowImagesInFullWidth": true,
{
"DisableGeolocationElementId": true"string",
"ShowDocumentDownloadDialogAfterAutomaticFinishUri": true"string",
"AttachmentsMaxFileSizeDocumentNumber": 0,
"SkipPreviewImageOnDisposableCertificateFieldDefinition": true,{
"LoadCustomJs": true,
"AllowCustomButtonsPosition": true,{
"GuidingBehavior": "GuideOnlyRequiredTasks",
"FormFieldsGuidingBehaviorPageNumber": "AllowSubmitAlways"0,
"ShowVersionNumber": true,
"EnableWarningPopupOnLeaveX": true0,
"WarningPopupDisplayAfter": "FillOrSignField",
"FinishWorkstepOnOpenY": true,0
"AutoFinishAfterRequiredTasksDone": true,
"GuidingBehaviorOnFinishedTask": "NoMove"},
"SkipThankYouDialog": true,
"NativeAppsUrlSchemeSize": "string",{
"DocumentViewingMode": "EndlessPaperAllDocuments",
"ThumbnailModeWidth": "ShowAllPages"0,
"ShowTopBar": true,
"DisplayRejectButtonInTopBarHeight": true,0
"MultipleSignatureTypesAndBatchSigningSettings": {
}
"IsUseBatchSigningCheckedByDefault": true,
}
"IsRememberSignatureTypeCheckedByDefault": true,
}
"IsRememberBatchSigningDecisionCheckedByDefault": true],
"SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossibleDocumentLinks": true[
},
{
"VisibleAreaOptionsElementId": {"string",
"AllowedDomainDocumentNumber": "string"0,
"EnabledLinkAnchor": true{
},
"ShowStartGuidingHintElementId": true"string",
"ShowStatusBar "DocumentNumber": true0,
"ShowZoomButtons": true,
"ShowNoGeolocationWarningLinkDefinition": true,{
"AutoStartGuiding": true,
"ShowPageGapPosition": true,{
"ShowPageNavigationButtons": true,
"ShowFinishPossibleHintPageNumber": true0,
"SkipRejectConfirmDialog": true
},
"SignatureConfigurationsX": [0,
{
"SpcIdY": "string",0
"PdfSignatureProperties": {
},
"PdfAConformant": true,
"PAdESPart4CompliantSize": true,{
"IncludeSigningCertificateChain": true,
"SigningCertificateRevocationInformationIncludeModeWidth": "DoNotInclude"0,
"SignatureTimestampData": {
"UriHeight": "string",0
"Username": "string", }
"Password": "string",}
"SignatureHashAlgorithm": "Sha1"},
"AuthenticationCertifiateDescriptorFieldDefinition": {
"IdentifierPosition": "string",{
"TypePageNumber": "string"0,
}
}
"X": 0,
},
"PdfSignatureCryptographicDataY": {0
"SignatureHashAlgorithm": "Sha1" },
"SigningCertificateDescriptorSize": {
"IdentifierWidth": "string"0,
"TypeHeight": "Sha1Thumbprint",0
"Csp": "Default"}
}
},
"CertificateFilter": {]
"KeyUsages":}, |
Reading confirmation
Image Added
With the reading task a recipient must confirm reading the document to have the evidence that he/she was reading it.
Generally there are 3 basic ways concerning the range of the reading task:
- Reading task for an area
- Reading task for one page
- Reading task for the document
Area read confirmation
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Area read confirmation |
|---|
|
"AreaReadConfirmations": [
{
"ElementId": "string",
]"Required": true,
"ThumbPrintsDocumentNumber": [0,
"DisplayName": "string",
],"Definition": {
"RootThumbPrintsPosition": [{
"stringPageNumber": 0,
]
}"X": 0,
}
],
"SigStringParsingConfigurationY": {0
"SigStringsForParsings": [
{},
"StartPatternSize": "string",{
"EndPatternWidth": "string"0,
"ClearSigStringHeight": true,0
"SearchEntireWordOnly": true}
},
"TaskConfiguration": ]{
},
"GeneralPoliciesOrderDefinition": {
"AllowSaveDocument "OrderIndex": true,0
"AllowSaveAuditTrail": true, }
"AllowRotatingPages": true,
}
}
"AllowAppendFileToWorkstep], |
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Page read confirmation |
|---|
|
"PageReadConfirmations": true,[
{
"AllowAppendTaskToWorkstep": true,
"AllowEmailDocumentElementId": true"string",
"AllowPrintDocumentRequired": true,
"AllowFinishWorkstepDocumentNumber": true0,
"AllowRejectWorkstepDisplayName": true"string",
"AllowRejectWorkstepDelegationPageNumber": true0,
"AllowUndoLastActionTaskConfiguration": true,{
"AllowColorizePdfFormsOrderDefinition": true,{
"AllowAdhocPdfAttachments "OrderIndex": true,0
"AllowAdhocSignatures": true, }
"AllowAdhocStampings": true, }
"AllowAdhocFreeHandAnnotations}
], |
Document read confirmation
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Document read confirmation |
|---|
|
"DocumentConfirmationReadConfirmation": true,{
"AllowAdhocTypewriterAnnotationsElementId": true"string",
"AllowAdhocPictureAnnotationsRequired": true,
"AllowAdhocPdfPageAppendingDisplayName": true"string",
"AllowReloadOfFinishedWorkstepTaskConfiguration": true{
},
"FinalizeActionsOrderDefinition": {
"FinalizeActionListOrderIndex": [0
}
]}
},
"TransactionCodeConfigurations": [
{
"Id": "string",
"HashAlgoritmIdentifier": "Sha1",
"Texts |
Activities
This is the main part of the envelope configuration. The section activities can include one to many actions.
Action
Please note that additionally to the elements below you can add a visibility option to either show all documents to the recipient or just selected once:
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Visibility option |
|---|
|
"VisibilityOptions": [
{
"LanguageDocumentNumber": "string"0,
"ValueIsHidden": "string"true
}
]
}
]
},
"PrepareSendEnvelopeStepsDescriptor": {
"ClearFieldMarkupString": true
}
} |
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
| Code Block |
|---|
|
|
<AdhocWorkstepConfiguration>
<WorkstepLabel /> ]
Those actions include the recipients of the envelope as well as the tasks for those recipients (signing, viewing etc.)
One action can either include one of the following tasks:
- Automatic signing
- Signing
- Document viewing
- P7M signing
Lets have a detailed look into the signing task.
The signing task includes the following information:
- Recipient configuration
- Personal message (optional)
- Authentication
- Access code
- SMS OTP
- Swedish bankId
- OAuth
- SAML
- Elements
- same elements available as documented in the section "unassigned elements"
- Policy configuration
- Signature data configuration
- Batch configuration
Recipient configuration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Recipient configuration |
|---|
|
| Code Block |
|---|
|
<envelope>
<name>eSignAnyWhere Tutorial</name>
<eMailSubject>Document of eSignAnyWhere Tutorial</eMailSubject>
<eMailBody>Dear #RecipientFirstName#! Please sign this tutorial document.</eMailBody>
<enableReminders>True</enableReminders>
<firstReminderDayAmount>1</firstReminderDayAmount>
<recurrentReminderDayAmount>1</recurrentReminderDayAmount>
<beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
<daysUntilExpire>2</daysUntilExpire>
<!-- callback to your backend system on a completed envelope
<callbackUrl>http://172.16.17.78:57550/default.aspx?EnvelopeId=##EnvelopeId##&myParamForMe=1234</callbackUrl>
-->
<callbackUrl />
<steps>
<step>
<emailBodyExtra />
<orderIndex>1</orderIndex>
<recipientType>Signer</recipientType>
<recipients>
<recipient>
<languageCode>en</languageCode>
<eMail>##EMAIL##</eMail>
<firstName>Alice</firstName>
<lastName>Somename</lastName>
<authentications>
<authentication>
<method>Pin</method>
<parameter>1234</parameter>
</authentication>
</authentications>
</recipient>
</recipients>
<workstepConfiguration>
<WorkstepLabel />
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
<WorkstepTimeToLiveInMinutes>11520</WorkstepTimeToLiveInMinutes>
<FinishAction />
<ViewerPreferences>
</ViewerPreferences>
<signatureTemplate>
</signatureTemplate>
<Policy version="1.1.0.0">
<GeneralPolicies>
</GeneralPolicies>
<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
</WorkstepTasks>
</Policy>
<TransactionCodeConfigurations>
<TransactionCodeConfiguration trConfId="">
</TransactionCodeConfiguration>
</TransactionCodeConfigurations>
</workstepConfiguration>
</step>
</steps>
</envelope>
|
PdfForms
The following list shows you all different form fields which can be placed on the document:
- Textfield
- Radiobutton
- Checkbox
- Listbox
- Combobox
The next tabs you can find the configurations of these form fields. Beginning with the configuration of the section “PdfForms”.
| Info |
|---|
There are two configurations to do: This applies to all form fields. |
Textfield
| Code Block |
|---|
|
"Forms": [
{
"Id": "TextBox_3daf9a88-bf45-70af-99d0-c077bcb48245",
"PositionPage": 1,
"DocRefNumber": 1,
"Position": {
"PositionX": 77.0,
"PositionY": 590.0
},
"Size": {
"Height": 20.0,
"Width": 124.0
},
"DiscriminatorType": "TextBox"
}
],
"IsRequired": false,
"Id": "f390ebd3-4b9c-4554-ab61-4d1234bad681",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "FormGroup"
},
|
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<textBox id="TextBox_044431e0-c75b-ea8a-0a6b-b2a82a3b7a67">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>70</positionX>
<positionY>579</positionY>
<width>124</width>
<height>20</height>
</textBox>
|
Radiobutton
| Code Block |
|---|
|
{
"RadioButtonGroupId": "RadioButton_942fca6a-5e0e-7694-b858-b5ded711ed0b",
"Id": "0",
"PositionPage": 1,
"DocRefNumber": 1,
"Position": {
"PositionX": 77.0,
"PositionY": 553.0
},
"Size": {
"Height": 20.0,
"Width": 20.0
},
"DiscriminatorType": "RadioButton"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<radioButton id="RadioButton_2b853f33-ed5c-7e39-7865-41056a90ca13#XyzmoIndexSeparator#0">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>66</positionX>
<positionY>544</positionY>
<width>20</width>
<height>20</height>
</radioButton>
|
Checkbox
| Code Block |
|---|
|
{
"IsRequired": false,
"RequiredEvalPolicy": "None",
"Id": "CheckBox_41371eaf-6e1a-0d9a-58a9-0705fd8d08d1",
"PositionPage": 1,
"DocRefNumber": 1,
"Position": {
"PositionX": 77.0,
"PositionY": 520.0
},
"Size": {
"Height": 20.0,
"Width": 20.0
},
"DiscriminatorType": "CheckBox"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<checkBox id="CheckBox_6f1fde0e-9338-f34b-6fe2-05d27ff632b9">
<requiredEvalPolicy>None</requiredEvalPolicy>
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>69</positionX>
<positionY>511</positionY>
<width>20</width>
<height>20</height>
</checkBox>
|
Listbox
| Code Block |
|---|
|
{
"Items": [],
"Id": "ListBox_d51c4e55-2497-8ab4-f2c8-6f60ac6a2cfd",
"PositionPage": 1,
"DocRefNumber": 1,
"Position": {
"PositionX": 79.0,
"PositionY": 475.0
},
"Size": {
"Height": 30.0,
"Width": 150.0
},
"DiscriminatorType": "ListBox"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<listBox id="ListBox_1c2a2627-5262-2fb0-d937-5e0f947031a4">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>69</positionX>
<positionY>464</positionY>
<width>150</width>
<height>30</height>
</listBox>
|
Listbox (Multiselect)
In the workstep configuration you can also define to select multiple items in the listbox. To define a multiselect of items you have to have at least two items in the listbox and you have to activate multiselect for this listbox. Please see the configurations below for more information:
Here you can find the configuration to enable multiselect for the listbox:
| Code Block |
|---|
|
"IsMultiselect": true, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<isMultiSelect>1</isMultiSelect> |
Below you can find a complete configuration with three items in the listbox and the enabled multiselect.
| Code Block |
|---|
|
{
"SspFileIds": [
"##FILE-ID##"
],
"SendEnvelopeDescription": {
"Name": "test",
"EmailSubject": "Please sign the enclosed envelope",
"EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
"DisplayedEmailSender": "",
"EnableReminders": true,
"FirstReminderDayAmount": 5,
"RecurrentReminderDayAmount": 3,
"BeforeExpirationDayAmount": 3,
"DaysUntilExpire": 28,
"CallbackUrl": "",
"StatusUpdateCallbackUrl": "",
"LockFormFieldsAtEnvelopeFinish": true,
"Steps": [
{
"OrderIndex": 1,
"Recipients": [
{
"Email": "##EMAIL##",
"FirstName": "##NAME##",
"LastName": "##NAME##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"AllowAccessFinishedWorkstep": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Signer",
"WorkstepConfiguration": {
"WorkstepLabel": "test",
"SmallTextZoomFactorPercent": 100,
"FinishAction": {
"ServerActions": [],
"ClientActions": [
{
"RemoveDocumentFromRecentDocumentList": false,
"CallClientActionOnlyAfterSuccessfulSync": true,
"ClientName": "SIGNificant SignAnywhere",
"CloseApp": false,
"Action": "https://www.esignanywhere.net/"
}
]
},
"ReceiverInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
},
"TransactionCodePushPluginData": []
},
"SenderInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
}
},
"TransactionCodeConfigurations": [
{
"Id": "smsAuthTransactionCodeId",
"HashAlgorithmIdentifier": "Sha256",
"Texts": [
]
}
],
"SignatureConfigurations": [],
"ViewerPreferences": {
"FinishWorkstepOnOpen": false,
"VisibleAreaOptions": {
"AllowedDomain": "*",
"Enabled": false
}
},
"ResourceUris": {},
"AuditingToolsConfiguration": {
"WriteAuditTrail": false,
"NotificationConfiguration": {}
},
"Policy": {
"GeneralPolicies": {
"AllowSaveDocument": true,
"AllowSaveAuditTrail": true,
"AllowRotatingPages": false,
"AllowEmailDocument": true,
"AllowPrintDocument": true,
"AllowFinishWorkstep": true,
"AllowRejectWorkstep": true,
"AllowRejectWorkstepDelegation": false,
"AllowUndoLastAction": true,
"AllowAdhocPdfAttachments": false,
"AllowAdhocSignatures": false,
"AllowAdhocStampings": false,
"AllowAdhocFreeHandAnnotations": false,
"AllowAdhocTypewriterAnnotations": false,
"AllowAdhocPictureAnnotations": false,
"AllowAdhocPdfPageAppending": false
},
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"Forms": [
{
"Items": [],
"IsRequired": false,
"Id": "ListBox_ef1ae2c5-8c83-2aab-b9eb-56624e33bcb8",
"PositionPage": 1,
"DocRefNumber": 1,
"Position": {
"PositionX": 60.0,
"PositionY": 655.0
},
"Size": {
"Height": 30.0,
"Width": 150.0
},
"DiscriminatorType": "ListBox"
}
],
"IsRequired": false,
"Id": "8ab43761-8310-4331-8c47-b3b9c5886146",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "FormGroup"
}
]
}
},
"Navigation": {
"HyperLinks": [],
"Links": [],
"LinkTargets": []
}
},
"DocumentOptions": [
{
"DocumentReference": "1",
"IsHidden": false
}
],
"UseDefaultAgreements": true
},
{
"OrderIndex": 2,
"Recipients": [
{
"Email": "##EMAIL##",
"FirstName": "##NAME##",
"LastName": "##NAME##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Cc",
"DocumentOptions": [],
"UseDefaultAgreements": false
}
],
"AddFormFields": {
"Forms": {
"1": [
{
"Items": [
{
"ExportValue": "option1",
"DisplayValue": "option1",
"IsSelected": true
},
{
"ExportValue": "option2",
"DisplayValue": "option2",
"IsSelected": true
},
{
"ExportValue": "option3",
"DisplayValue": "option3",
"IsSelected": false
}
],
"TextColor": "",
"IsMultiselect": true,
"FontSize": 11.0,
"FontName": "Times New Roman",
"Bold": false,
"Italic": false,
"TextAlign": "Left",
"Name": "ListBox_ef1ae2c5-8c83-2aab-b9eb-56624e33bcb8",
"ReadOnly": false,
"Required": false,
"X": 60.0,
"Y": 655.0,
"Width": 150.0,
"Height": 30.0,
"Page": 1,
"DiscriminatorType": "AddListBoxFormFieldDescriptor"
}
]
}
},
"OverrideFormFieldValues": {
"Forms": {}
},
"AttachSignedDocumentsToEnvelopeLog": false
}
} |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<envelope>
<name>test</name>
<eMailSubject>Please sign the enclosed envelope</eMailSubject>
<eMailBody>Dear #RecipientFirstName# #RecipientLastName#
#PersonalMessage#
Please sign the envelope #EnvelopeName#
Envelope will expire at #ExpirationDate#</eMailBody>
<enableReminders>true</enableReminders>
<firstReminderDayAmount>5</firstReminderDayAmount>
<recurrentReminderDayAmount>3</recurrentReminderDayAmount>
<beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
<daysUntilExpire>28</daysUntilExpire>
<callbackUrl></callbackUrl>
<statusUpdateCallbackUrl></statusUpdateCallbackUrl>
<lockFormFieldsAtEnvelopeFinish>true</lockFormFieldsAtEnvelopeFinish>
<displayedEmailSender></displayedEmailSender>
<steps>
<step>
<emailBodyExtra></emailBodyExtra>
<orderIndex>1</orderIndex>
<recipientType>Signer</recipientType>
<useDefaultAgreements>true</useDefaultAgreements>
<documentOptions>
<documentOption docRef="1">
<isHidden>false</isHidden>
</documentOption>
</documentOptions>
<workstepConfiguration skipThirdPartyChecks="0">
<WorkstepLabel>test</WorkstepLabel>
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
<WorkstepTimeToLiveInMinutes>44650</WorkstepTimeToLiveInMinutes>
<AbsoluteExpiryDate>2020-07-17T07:15:28.9549326Z</AbsoluteExpiryDate>
<FinishAction>
<ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
</FinishAction>
<ViewerPreferences>
<SendVisibleArea allowedDomain="*">0</SendVisibleArea>
<FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
</ViewerPreferences>
<Policy version="1.1.0.0">
<AdhocPolicies>
<AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
</AdhocPolicies>
<GeneralPolicies>
<AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
<AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
<AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
<AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
<AllowAdhocSignatures>0</AllowAdhocSignatures>
<AllowAdhocStampings>0</AllowAdhocStampings>
<AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
<AllowEmailDocument>1</AllowEmailDocument>
<AllowFinishWorkstep>1</AllowFinishWorkstep>
<AllowPrintDocument>1</AllowPrintDocument>
<AllowRejectWorkstep>1</AllowRejectWorkstep>
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
<AllowSaveDocument>1</AllowSaveDocument>
<AllowUndoLastAction>1</AllowUndoLastAction>
<AllowRotatingPages>0</AllowRotatingPages>
<AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
</GeneralPolicies>
<WorkstepTasks originalSequenceMode="NoSequenceEnforced" SequenceMode="NoSequenceEnforced">
<Task id="411581f7-5d5b-4443-8aec-43027d1f703c" DocRefNumber="1" enabled="1" completed="0" type="FillFormsGroup" required="0" displayName="" />
</WorkstepTasks>
</Policy>
<Navigation />
<timeCreated>2020-07-17T07:05:28.9236813Z</timeCreated>
<TransactionCodeConfigurations>
<TransactionCodeConfiguration trConfId="smsAuthTransactionCodeId">
</TransactionCodeConfiguration>
</TransactionCodeConfigurations>
<receiverInformation>
<userInformation>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<eMail>##EMAIL##</eMail>
</userInformation>
<showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
</receiverInformation>
<senderInformation>
<userInformation>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<eMail>##EMAIL##</eMail>
</userInformation>
</senderInformation>
<pdfForms isEditingAllowed="0">
<pdfFormsGroup id="411581f7-5d5b-4443-8aec-43027d1f703c">
<listBox id="ListBox_ef1ae2c5-8c83-2aab-b9eb-56624e33bcb8">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>60</positionX>
<positionY>655</positionY>
<width>150</width>
<height>30</height>
</listBox>
</pdfFormsGroup>
</pdfForms>
<TypewriterAnnotationTaskInfo />
<attachmentFields />
<signatureTemplate>
<version>1.2.0.2</version>
<positionReferenceCorner>Lower_Left</positionReferenceCorner>
<positionUnits>PdfUnits</positionUnits>
</signatureTemplate>
<AuditingToolsConfiguration WriteAuditTrail="0">
<NotificationConfiguration />
</AuditingToolsConfiguration>
<resourceUris />
</workstepConfiguration>
<recipients>
<recipient>
<eMail>##EMAIL##</eMail>
<emailBodyExtra></emailBodyExtra>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<languageCode>en</languageCode>
<disableEmail>false</disableEmail>
<skipExternalDataValidation>false</skipExternalDataValidation>
<addAndroidAppLink>false</addAndroidAppLink>
<addIosAppLink>false</addIosAppLink>
<addWindowsAppLink>false</addWindowsAppLink>
<allowDelegation>false</allowDelegation>
<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
<authentications />
</recipient>
</recipients>
</step>
<step>
<emailBodyExtra></emailBodyExtra>
<orderIndex>2</orderIndex>
<recipientType>Cc</recipientType>
<useDefaultAgreements>false</useDefaultAgreements>
<recipients>
<recipient>
<eMail>##EMAIL##</eMail>
<emailBodyExtra></emailBodyExtra>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<languageCode>en</languageCode>
<disableEmail>false</disableEmail>
<skipExternalDataValidation>false</skipExternalDataValidation>
<addAndroidAppLink>false</addAndroidAppLink>
<addIosAppLink>false</addIosAppLink>
<addWindowsAppLink>false</addWindowsAppLink>
<allowDelegation>false</allowDelegation>
<authentications />
</recipient>
</recipients>
</step>
</steps>
<addFormFields>
<document docRef="1">
<listBox name="ListBox_ef1ae2c5-8c83-2aab-b9eb-56624e33bcb8" readOnly="false" required="false" x="60" y="655" width="150" height="30" page="1">
<isMultiSelect>1</isMultiSelect>
<fontSettings>
<textColor></textColor>
<fontName>Times New Roman</fontName>
<fontSize>11</fontSize>
<fontStyleBold>false</fontStyleBold>
<fontStyleItalic>false</fontStyleItalic>
<textAlign>Left</textAlign>
</fontSettings>
<item>
<item exportValue="option1" displayValue="option1" isSelected="true" />
<item exportValue="option2" displayValue="option2" isSelected="true" />
<item exportValue="option3" displayValue="option3" isSelected="false" />
</item>
</listBox>
</document>
</addFormFields>
<attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope> |
Combobox
| Code Block |
|---|
|
{
"IsRequired": false,
"Items": [],
"Id": "ComboBox_67a8d39f-3a49-65e0-0d5d-88ac97b387ea",
"PositionPage": 1,
"DocRefNumber": 1,
"Position": {
"PositionX": 79.0,
"PositionY": 424.0
},
"Size": {
"Height": 30.0,
"Width": 150.0
},
"DiscriminatorType": "ComboBox"
} |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<comboBox id="ComboBox_3247b8f7-620e-a1bc-4e0d-53ae0e019921">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>69</positionX>
<positionY>416</positionY>
<width>150</width>
<height>30</height>
</comboBox> |
After the configuration of the section “PdfForms” you can add these form fields in the section “addFormFields”.
AddFormFields
Textfield:
| Code Block |
|---|
|
{
"Value": "",
"MaxLength": -1,
"IsMultiline": false,
"IsPassword": false,
"IsComb": false,
"TextColor": "0, 0, 0",
"FontSize": 11.0,
"FontName": "Times New Roman",
"Bold": false,
"Italic": false,
"TextAlign": "Left",
"Name": "TextBox_3daf9a88-bf45-70af-99d0-c077bcb48245",
"ReadOnly": false,
"Required": false,
"X": 77.0,
"Y": 590.92,
"Width": 124.0,
"Height": 20.0,
"Page": 1,
"DiscriminatorType": "AddTextBoxFormFieldDescriptor"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<textBox name="TextBox_044431e0-c75b-ea8a-0a6b-b2a82a3b7a67" readOnly="false" required="false" x="70" y="579.92" width="124" height="20" page="1">
<fontSettings>
<textColor>#000000</textColor>
<fontName>Times New Roman</fontName>
<fontSize>11</fontSize>
<fontStyleBold>false</fontStyleBold>
<fontStyleItalic>false</fontStyleItalic>
<textAlign>Left</textAlign>
</fontSettings>
<value />
<maxLength>-1</maxLength>
<isMultiLine>false</isMultiLine>
<isPassword>false</isPassword>
<isComb>false</isComb>
</textBox> |
Radiobutton:
| Code Block |
|---|
|
{
"ExportValue": "1b6c204b-0642-5566-f526-a725e16737a5",
"IsChecked": false,
"Name": "RadioButton_18d57bcd-6a82-ebde-a2ab-c4557a720bfe",
"ReadOnly": false,
"Required": false,
"X": 77.0,
"Y": 550.92,
"Width": 20.0,
"Height": 20.0,
"Page": 1,
"DiscriminatorType": "AddRadioButtonFormFieldDescriptor"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<radioButton name="RadioButton_2b853f33-ed5c-7e39-7865-41056a90ca13" readOnly="false" required="false" x="66" y="544.92" width="20" height="20" page="1">
<exportValue>83427540-42b2-f71b-cbac-06752da7534b</exportValue>
<isChecked>false</isChecked>
</radioButton> |
Checkbox:
| Code Block |
|---|
|
{
"IsChecked": true,
"Name": "CheckBox_e5ba8ea4-8c39-324f-0170-a83dd3fb3aeb",
"ReadOnly": false,
"Required": false,
"X": 79.0,
"Y": 516.92,
"Width": 20.0,
"Height": 20.0,
"Page": 1,
"DiscriminatorType": "AddCheckBoxFormFieldDescriptor"
} |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<checkBox name="CheckBox_6f1fde0e-9338-f34b-6fe2-05d27ff632b9" readOnly="false" required="false" x="69" y="511.92" width="20" height="20" page="1">
<isChecked>true</isChecked>
</checkBox> |
Listbox:
| Code Block |
|---|
|
{
"Items": [],
"TextColor": "",
"FontSize": 11.0,
"FontName": "Times New Roman",
"Bold": false,
"Italic": false,
"TextAlign": "Left",
"Name": "ListBox_e4076d02-c636-0138-fe54-03d19fe10a7d",
"ReadOnly": false,
"Required": false,
"X": 79.0,
"Y": 468.92,
"Width": 150.0,
"Height": 30.0,
"Page": 1,
"DiscriminatorType": "AddListBoxFormFieldDescriptor"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<listBox name="ListBox_1c2a2627-5262-2fb0-d937-5e0f947031a4" readOnly="false" required="false" x="69" y="464.92" width="150" height="30" page="1">
<fontSettings>
<textColor></textColor>
<fontName>Times New Roman</fontName>
<fontSize>11</fontSize>
<fontStyleBold>false</fontStyleBold>
<fontStyleItalic>false</fontStyleItalic>
<textAlign>Left</textAlign>
</fontSettings>
</listBox> |
Combobox:
| Code Block |
|---|
|
{
"Value": "",
"Items": [],
"TextColor": "",
"FontSize": 11.0,
"FontName": "Times New Roman",
"Bold": false,
"Italic": false,
"TextAlign": "Left",
"Name": "ComboBox_6936c368-b465-6355-0367-bdfe042c8ec7",
"ReadOnly": false,
"Required": false,
"X": 79.0,
"Y": 418.92,
"Width": 150.0,
"Height": 30.0,
"Page": 1,
"DiscriminatorType": "AddComboBoxFormFieldDescriptor"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<comboBox name="ComboBox_3247b8f7-620e-a1bc-4e0d-53ae0e019921" readOnly="false" required="false" x="69" y="416.92" width="150" height="30" page="1">
<fontSettings>
<textColor></textColor>
<fontName>Times New Roman</fontName>
<fontSize>11</fontSize>
<fontStyleBold>false</fontStyleBold>
<fontStyleItalic>false</fontStyleItalic>
<textAlign>Left</textAlign>
</fontSettings>
<value />
</comboBox> |
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
Please do not forget to add a workstep task for the form fields. |
TypeWriterAnnotation
The following lines of code show you how to write the configuration. First, you have to define the task:
| Code Block |
|---|
|
"Tasks": [
{
"PageNumber": 1,
"TextAlign": "Left",
"Position": {
"PositionX": 76.0,
"PositionY": 664.0
},
"DefaultText": "##ReceiverEmail##",
"TextFormat": "",
"DefaultTextType": "Email",
"FontSettings": {
"Id": "f238fef7-87db-400c-91ed-7d58d7d76652",
"TextColor": {
"A": 255,
"R": 0,
"G": 0,
"B": 0
},
"Name": "Times New Roman",
"Size": 11.0,
"IsBold": false,
"IsItalic": false
},
"IsEditablePosition": false,
"IsEditableDefaultText": false,
"IsEditableFontSettings": false,
"IsRequired": false,
"Id": "ed6db64d-98fc-497b-be30-ee2a2a2b6f7c",
"DocRefNumber": 1,
"DiscriminatorType": "TypewriterAnnotation"
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<TypewriterAnnotationTaskInfo>
<typewriterAnnotationGroup id="cc4923e4-6e0a-42a8-be6a-bdd0fa3d2cd4">
<predefinedTypewriterAnnotationRef refId="269da6f9-9778-4064-8c99-cad42caa2a21" />
</typewriterAnnotationGroup>
<fontSettings id="c64ae844-a7ce-4ebb-9773-5f6b8d980f92">
<fontName>Times New Roman</fontName>
<fontSize>11</fontSize>
<fontStyleBold>0</fontStyleBold>
<fontStyleItalic>0</fontStyleItalic>
<textColor>
<A>255</A>
<R>0</R>
<G>0</G>
<B>0</B>
</textColor>
</fontSettings>
<typewriterAnnotation id="269da6f9-9778-4064-8c99-cad42caa2a21" completed="false">
<DefaultText editable="0" type="DateTime" textFormat="dd/MM/yyyy">##ClientTime##</DefaultText>
<DocRefNumber>1</DocRefNumber>
<pageNumber>1</pageNumber>
<textAlign>Left</textAlign>
<fontSettingsReference id="c64ae844-a7ce-4ebb-9773-5f6b8d980f92" editable="0" />
<Position positionX="270" positionY="439" editable="0" />
</typewriterAnnotation>
</TypewriterAnnotationTaskInfo> |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
Add the task to the configuration like the following example shows:
| Code Block |
|---|
|
<Task type="AddTypewriterAnnotation" DocRefNumber="1" id="cc4923e4-6e0a-42a8-be6a-bdd0fa3d2cd4" internalCompleted="0" displayName="" /> |
Instead of “Email” in the REST example or “DateTime” in the SOAP example you can place the following placeholders:
...
For all placeholder with the additional “*” you need either the sender information or the receiver information which are both explained in the section “sender and receiver information”.
Reading Tasks
With the reading task a recipient must confirm reading the document to have the evidence that he/she was reading it.
Generally there are 3 basic ways concerning the range of the reading task:
- Reading task for one page
- Reading task for all pages
- Reading task for a section
Reading task for one page
Note: The reading task must be the first task and it must be required!)
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
Place the reading task within the following tag:
| Code Block |
|---|
|
<WorkstepTasks>##ReadingTask##</WorkstepTasks> |
Add the following lines of code within the workstep configuration:
| Code Block |
|---|
|
"Tasks": [
{
"PositionPage": 1,
"AllPages": false,
"AllDocuments": false,
"IsRequired": true,
"Id": "847a3d4a-da2c-46f4-8c8c-a9edaa06c29b",
"DisplayName": "your text for this task",
"DocRefNumber": 1,
"DiscriminatorType": "ReadingTask"
},
{
"PositionPage": 1,
"Position": {
"PositionX": 80.22857,
"PositionY": 158.8629
},
"Size": {
"Height": 68.57143,
"Width": 171.4286
},
"AllowedSignatureTypes": [],
"UseTimestamp": false,
"IsRequired": true,
"Id": "93cce567-ae5c-4e98-ac99-9f56ac034250",
"DisplayName": "SignField 1",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
] |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<ReadingTaskInfo positionUnit="PdfUnits" positionReferenceCorner="Upper_Left">
<ReadingTask id="847a3d4a-da2c-46f4-8c8c-a9edaa06c29b" pageNumber="1" DocRefNumber="1" AllPages="0" AllDocuments="0">
</ReadingTask>
</ReadingTaskInfo> |
After adding the reading task within the workstep configuration you can send the document. The result should look like the following:
Image Removed
...
Reading task for all pages
The following lines of code shows you the reading task configuration for all pages:
| Code Block |
|---|
|
"Tasks": [
{
"PositionPage": 1,
"AllPages": false,
"AllDocuments": true,
"Position": { "PositionX": 50.0,
"PositionY": 100.0
},
"Size": {
"Height": 40.0,
"Width": 400.0
},
"IsRequired": true,
"Id": "847a3d4a-da2c-46f4-8c8c-a9edaa06c29b",
"DisplayName": "your text for this task",
"DocRefNumber": 1,
"DiscriminatorType": "ReadingTask"
},
{
"PositionPage": 1,
"Position": {
"PositionX": 80.22857,
"PositionY": 158.8629
},
"Size": {
"Height": 68.57143,
"Width": 171.4286
},
"AllowedSignatureTypes": [],
"UseTimestamp": false,
"IsRequired": true,
"Id": "93cce567-ae5c-4e98-ac99-9f56ac034250",
"DisplayName": "SignField 1",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
] |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<ReadingTaskInfo positionUnit="PdfUnits" positionReferenceCorner="Upper_Left">
<ReadingTask id="847a3d4a-da2c-46f4-8c8c-a9edaa06c29b" pageNumber="1" DocRefNumber="1" AllPages="0" AllDocuments="1">
</ReadingTask>
</ReadingTaskInfo> |
The result should look like the following screenshot:
Image Removed
Reading task for a section
The following lines of code shows you how to configure the reading task for a section:
| Code Block |
|---|
|
"Tasks": [
{
"PositionPage": 1,
"AllPages": false,
"AllDocuments": false,
"Position": {
"PositionX": 50.0,
"PositionY": 100.0
},
"Size": {
"Height": 40.0,
"Width": 400.0
},
"IsRequired": true,
"Id": "847a3d4a-da2c-46f4-8c8c-a9edaa06c29b",
"DisplayName": "your text for this task",
"DocRefNumber": 1,
"DiscriminatorType": "ReadingTask"
},
{
"PositionPage": 1,
"Position": {
"PositionX": 80.22857,
"PositionY": 158.8629
},
"Size": {
"Height": 68.57143,
"Width": 171.4286
},
"AllowedSignatureTypes": [],
"UseTimestamp": false,
"IsRequired": true,
"Id": "93cce567-ae5c-4e98-ac99-9f56ac034250",
"DisplayName": "SignField 1",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
] |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<ReadingTaskInfo positionUnit="PdfUnits" positionReferenceCorner="Upper_Left">
<ReadingTask id="847a3d4a-da2c-46f4-8c8c-a9edaa06c29b" pageNumber="1" DocRefNumber="1" AllPages="0" AllDocuments="0">
<Position positionX="50" positionY="100" width="400" height="40" />
</ReadingTask>
</ReadingTaskInfo> |
Image Removed
In the next section you can find a complete workstep configuration with one signature field, one recipient and a reading confirmation for a section:
| Code Block |
|---|
|
{
"SspFileIds": [
"##FILEID##"
],
"SendEnvelopeDescription": {
"Name": "eSignAnyWhere Tutorial",
"EmailSubject": "Document of eSignAnyWhere Tutorial",
"EmailBody": "Dear #RecipientFirstName#! Please sign this tutorial document.",
"DisplayedEmailSender": "",
"EnableReminders": true,
"FirstReminderDayAmount": 1,
"RecurrentReminderDayAmount": 1,
"BeforeExpirationDayAmount": 1,
"DaysUntilExpire": 2,
"CallbackUrl": "",
"StatusUpdateCallbackUrl": "",
"LockFormFieldsAtEnvelopeFinish": true,
"Steps": [
{
"OrderIndex": 1,
"Recipients": [
{
"Email": "##EMAIL##",
"FirstName": "##NAME##",
"LastName": "##NAME##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"AllowAccessFinishedWorkstep": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Signer",
"WorkstepConfiguration": {
"WorkstepLabel": "",
"SmallTextZoomFactorPercent": 100,
"FinishAction": {
"ServerActions": [],
"ClientActions": []
},
"ReceiverInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
},
"TransactionCodePushPluginData": []
},
"SenderInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
}
},
"TransactionCodeConfigurations": [
{
}
],
"SignatureConfigurations": [],
"ViewerPreferences": {},
"Policy": {
"GeneralPolicies": {
"AllowSaveDocument": true,
"AllowSaveAuditTrail": true,
"AllowRotatingPages": true,
"AllowFinishWorkstep": true,
"AllowUndoLastAction": true
},
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "SequenceOnlyRequiredTasks",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Upper_Left",
"Tasks": [
{
"PositionPage": 1,
"AllPages": false,
"AllDocuments": false,
"Position": {
"PositionX": 50.0,
"PositionY": 100.0
},
"Size": {
"Height": 40.0,
"Width": 400.0
},
"IsRequired": true,
"Id": "847a3d4a-da2c-46f4-8c8c-a9edaa06c29b",
"DisplayName": "your text for this task",
"DocRefNumber": 1,
"DiscriminatorType": "ReadingTask"
},
{
"PositionPage": 1,
"Position": {
"PositionX": 80.22857,
"PositionY": 158.8629
},
"Size": {
"Height": 68.57143,
"Width": 171.4286
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "completed",
"Value": "0"
},
{
"Key": "sigType",
"Value": "Picture"
},
{
"Key": "positioning",
"Value": "onPage"
},
{
"Key": "allowedCapturingMethods",
"Value": "Click2Sign"
}
],
"AllowedSignatureTypes": [],
"UseTimestamp": false,
"IsRequired": true,
"Id": "93cce567-ae5c-4e98-ac99-9f56ac034250",
"DisplayName": "SignField 1",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
}
},
"DocumentOptions": [
{
"DocumentReference": "1",
"IsHidden": false
}
],
"UseDefaultAgreements": true
},
{
"OrderIndex": 2,
"Recipients": [
{
"Email": "##EMAIL##",
"FirstName": "Charly",
"LastName": "Randomname",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"AllowAccessFinishedWorkstep": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Cc",
"DocumentOptions": [
{
"DocumentReference": "1",
"IsHidden": false
}
],
"UseDefaultAgreements": true
}
],
"AddFormFields": {
"Forms": {}
},
"OverrideFormFieldValues": {
"Forms": {}
},
"AttachSignedDocumentsToEnvelopeLog": false
}
} |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<envelope>
<name>eSignAnyWhere Tutorial</name>
<eMailSubject>Document of eSignAnyWhere Tutorial</eMailSubject>
<eMailBody>Dear #RecipientFirstName#! Please sign this tutorial document.</eMailBody>
<enableReminders>True</enableReminders>
<firstReminderDayAmount>1</firstReminderDayAmount>
<recurrentReminderDayAmount>1</recurrentReminderDayAmount>
<beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
<daysUntilExpire>2</daysUntilExpire>
<!-- callback to your backend system on a completed envelope
<callbackUrl>http://172.16.17.78:57550/default.aspx?EnvelopeId=##EnvelopeId##&myParamForMe=1234</callbackUrl>
-->
<callbackUrl />
<steps>
<step>
<emailBodyExtra />
<orderIndex>1</orderIndex>
<recipientType>Signer</recipientType>
<recipients>
<recipient>
<languageCode>en</languageCode>
<eMail>##EMAIL##</eMail>
<firstName>Alice</firstName>
<lastName>Somename</lastName>
</recipient>
</recipients>
<workstepConfiguration>
<WorkstepLabel />
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
<WorkstepTimeToLiveInMinutes>11520</WorkstepTimeToLiveInMinutes>
<FinishAction />
<signatureTemplate>
<version>1.2.0.2</version>
<positionUnits>PdfUnits</positionUnits>
<positionReferenceCorner>Lower_Left</positionReferenceCorner>
<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
<positionPage>1</positionPage>
<DocRefNumber>1</DocRefNumber>
<positionX>80.22857</positionX>
<positionY>158.8629</positionY>
<width>171.4286</width>
<height>68.57143</height>
<param name="enabled">1</param>
<param name="completed">0</param>
<param name="sigType">Picture</param>
<param name="positioning">onPage</param>
<param name="allowedCapturingMethods">Click2Sign</param>
</sig>
</signatureTemplate>
<Policy version="1.1.0.0">
<GeneralPolicies>
<AllowSaveDocument>1</AllowSaveDocument>
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
</GeneralPolicies>
<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
<Task enabled="1" completed="0" required="1" id="847a3d4a-da2c-46f4-8c8c-a9edaa06c29b" displayName="your text for this task" DocRefNumber="1" type="ConfirmReading" />
<Task enabled="1" completed="0" required="1" id="93cce567-ae5c-4e98-ac99-9f56ac034250" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" />
</WorkstepTasks>
</Policy>
<TransactionCodeConfigurations>
<TransactionCodeConfiguration trConfId="">
<Message>Please sign the document with the transactionId {tId} with the code: {Token}</Message>
<hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
</TransactionCodeConfiguration>
<TransactionCodeConfiguration trConfId="Trans1">
<Message>Please accept the transactionId {tId} with the code: {Token}</Message>
<hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
</TransactionCodeConfiguration>
</TransactionCodeConfigurations>
<ReadingTaskInfo positionUnit="PdfUnits" positionReferenceCorner="Upper_Left">
<ReadingTask id="847a3d4a-da2c-46f4-8c8c-a9edaa06c29b" pageNumber="1" DocRefNumber="1" AllPages="0" AllDocuments="0">
<Position positionX="50" positionY="100" width="400" height="40" />
</ReadingTask>
</ReadingTaskInfo>
</workstepConfiguration>
</step>
<step>
<emailBodyExtra />
<orderIndex>2</orderIndex>
<recipientType>CC</recipientType>
<recipients>
<recipient>
<languageCode>en</languageCode>
<eMail>##EMAIL##</eMail>
<firstName>Charly</firstName>
<lastName>Randomname</lastName>
</recipient>
</recipients>
</step>
</steps>
</envelope> |
Sending envelope
After you have added all form fields and signatures you can send the envelope to recipients. Therefore, add the file Id and the workstep configuration to the REST call basicURL/envelope/send or in SOAP to the API call SendEnvelope_v1 and send the envelope to the recipients.
Get the envelope
After sending the envelope you can call the api call (basicURL/envelope{envelopeId}) in REST and GetEnvelopeById_v1 in SOAP.
For this api call you just need the envelopeId. After finishing the api call you get all information about the envelope. The next section shows you a sample response.
| Code Block |
|---|
|
"RecipientConfiguration": {
"ContactInformation": {
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent> <WorkstepTimeToLiveInMinutes>10</WorkstepTimeToLiveInMinutes>
<FinishAction />
<NoSequenceEnforced>0</NoSequenceEnforced>
<SigTemplate>
<width>50.5</width>
<height>100.5</height>
</SigTemplate>
<ParseFormFields mapRequiredFieldsToRequiredTask=" 1Email": formsGrouping=" PerPagestring" returnSimplifiedConfig="0" addKeepExistingValueFlag="0">1</ParseFormFields>
<AdhocPolicies>
<AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
</AdhocPolicies>
<PictureAnnotationConfigurationDefaults>
<MinResolution>100</MinResolution>
<MaxResolution>300</MaxResolution>
<ColorDepth>Color16M</ColorDepth>
</PictureAnnotationConfigurationDefaults>
<signaturePluginConfiguration>
<PdfSignatureProperties_V1>
<PdfAConformant>0</PdfAConformant> <PAdESPart4Compliant>0</PAdESPart4Compliant> <IncludeSigningCertificateChain>0</IncludeSigningCertificateChain> <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
</PdfSignatureProperties_V1>
<PdfSignatureCryptographicData_V1> <SignatureHashAlgorithm>Sha1</SignatureHashAlgorithm>
<SigningCertificateDescriptor> <Identifier>DDED02DC192573B722E8C027F0E47E63152EB822</Identifier>
<Type>Sha1Thumbprint</Type>
<Csp>Default</Csp>
</SigningCertificateDescriptor>
</PdfSignatureCryptographicData_V1>
</signaturePluginConfiguration>
<SigStringParsingConfiguration>
<SigStringsForParsing>
<StartPattern>`sig</StartPattern>
<EndPattern>`</EndPattern>
<ClearSigString>1</ClearSigString>
<SearchEntireWordOnly>1</SearchEntireWordOnly>
</SigStringsForParsing>
</SigStringParsingConfiguration>
<GeneralPolicies>
<AllowSaveDocument>1</AllowSaveDocument> <AllowSaveAuditTrail>0</AllowSaveAuditTrail> <AllowRotatingPages>1</AllowRotatingPages> <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep> <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep> <AllowEmailDocument>0</AllowEmailDocument> <AllowPrintDocument>0</AllowPrintDocument> <AllowFinishWorkstep>1</AllowFinishWorkstep> <AllowRejectWorkstep>1</AllowRejectWorkstep> <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation> <AllowUndoLastAction>1</AllowUndoLastAction> <AllowColorizePdfForms>0</AllowColorizePdfForms> <AllowAdhocPdfAttachments>1</AllowAdhocPdfAttachments> <AllowAdhocSignatures>1</AllowAdhocSignatures> <AllowAdhocStampings>1</AllowAdhocStampings> <AllowAdhocFreeHandAnnotations>1</AllowAdhocFreeHandAnnotations> <AllowAdhocTypewriterAnnotations>1</AllowAdhocTypewriterAnnotations> <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations> <AllowAdhocPdfPageAppending>1</AllowAdhocPdfPageAppending>
</GeneralPolicies>
</AdhocWorkstepConfiguration> |
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
For the api call in SOAP you also need the following configuration:
| Code Block |
|---|
|
<prepareSendEnvelopeStepsDescriptor>
<clearFieldMarkupString>1</clearFieldMarkupString>
</prepareSendEnvelopeStepsDescriptor> |
In REST you already have this configuration:
| Code Block |
|---|
|
"PrepareSendEnvelopeStepsDescriptor": {
"ClearFieldMarkupString": true
} |
AdditionalClientWorkstepInformation
This field is used to provide additional information. Note: Must be written in XML form. See the code below:
| Code Block |
|---|
|
"AdditionalClientWorkstepInformation": "<test id='test'>Information</test>" |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<AdditionalClientWorkstepInformation><test id="test">Information<test></AdditionalClientWorkstepInformation> |
Viewer preferences
Following lines of code show some viewer preferences configurations:
| Code Block |
|---|
|
"ViewerPreferences": {
"ShowPageNavigationButtons": true,
"ShowThumbnails": true,
"SkipFinishConfirmDialog": true,
"SkipDocumentDialog": true,
"ShowImagesInFullWidth": true,
"DisableGeolocation": true,
"ShowDocumentDownloadDialogAfterAutomaticFinish": true,
"SkipPreviewImageOnDisposableCertificate": true,
"LoadCustomJs": true,
"AllowCustomButtons": true,
"ShowVersionNumber": true,
"EnableWarningPopupOnLeave": true,
"FinishWorkstepOnOpen": true,
"AutoFinishAfterRequiredTasksDone": true,
"SkipThankYouDialog": true,
"ShowTopBar": true,
"DisplayRejectButtonInTopBar": true,
"ShowStartGuidingHint": true,
"ShowStatusBar": true,
"ShowZoomButtons": true,
"ShowNoGeolocationWarning": true,
"AutoStartGuiding": true,
"ShowPageGap": true,
"ShowPageNavigationButtons": true,
"ShowFinishPossibleHint": true,
"SkipRejectConfirmDialog": true,
"BatchSigningDisableNextButtonUntilDialogScrolledToBottom": true
} |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<ViewerPreferences>
<ShowThumbnails>1</ShowThumbnails>
<ShowStatusBar>1</ShowStatusBar>
<ShowTopBar>1</ShowTopBar>
<FinishWorkstepOnOpen>1</FinishWorkstepOnOpen>
<BatchSigningDisableNextButtonUntilDialogScrolledToBottom>1</BatchSigningDisableNextButtonUntilDialogScrolledToBottom>
<GuidingBehavior>GuideRequiredAndOptionalTasks</GuidingBehavior>
<BatchSigningType>Basic</BatchSigningType>
<FormFieldsGuidingBehavior>AllowSubmitAlways</FormFieldsGuidingBehavior>
<GuidingBehaviorOnFinishedTask>MoveToNext</GuidingBehaviorOnFinishedTask>
<SkipPreviewImageOnDisposableCertificate>1</SkipPreviewImageOnDisposableCertificate>
<ShowPageNavigationButtons>1</ShowPageNavigationButtons>
<ShowZoomButtons>1</ShowZoomButtons>
<ShowPageGap>1</ShowPageGap>
<SkipFinishConfirmDialog>1</SkipFinishConfirmDialog>
<SkipRejectConfirmDialog>1</SkipRejectConfirmDialog>
<SkipDocumentDialog>1</SkipDocumentDialog>
<ShowImagesInFullWidth>1</ShowImagesInFullWidth>
<DisableGeolocation>1</DisableGeolocation>
<ShowNoGeolocationWarning>1</ShowNoGeolocationWarning>
<ShowDocumentDownloadDialogAfterAutomaticFinish>1</ShowDocumentDownloadDialogAfterAutomaticFinish>
<AllowCustomButtons>1</AllowCustomButtons>
<AutoFinishAfterRequiredTasksDone>1</AutoFinishAfterRequiredTasksDone>
<DisplayRejectButtonInTopBar>1</DisplayRejectButtonInTopBar>
<TriggerBankIdDesktopApp>1</TriggerBankIdDesktopApp>
<AutoStartGuiding>1</AutoStartGuiding>
<EnableWarningPopupOnLeave>1</EnableWarningPopupOnLeave>
<WarningPopupDisplayAfter>FillOrSignField</WarningPopupDisplayAfter>
<DocumentViewingMode>EndlessPaperAllDocuments</DocumentViewingMode>
<SendVisibleArea allowedDomain="*">1</SendVisibleArea>
</ViewerPreferences> |
Policy
The following list shows the policy configurations:
Note: With the value “1” you enable the policy and with the value “0” you disable the policy. In the following list all policies are enabled.
| Code Block |
|---|
|
"Policy": {
"GeneralPolicies": {
"AllowSaveDocument": true,
"AllowSaveAuditTrail": true,
"AllowRotatingPages": true,
"AllowAppendFileToWorkstep": true,
"AllowAppendTaskToWorkstep": true,
"AllowEmailDocument": true,
"AllowPrintDocument": true,
"AllowFinishWorkstep": true,
"AllowRejectWorkstep": true,
"AllowRejectWorkstepDelegation": true,
"AllowUndoLastAction": true,
"AllowColorizePdfForms": true,
"AllowAdhocPdfAttachments": true,
"AllowAdhocSignatures": true,
"AllowAdhocStampings": true,
"AllowAdhocFreeHandAnnotations": true,
"AllowAdhocTypewriterAnnotations": true,
"AllowAdhocPictureAnnotations": true,
"AllowAdhocPdfPageAppending": true,
"AllowReloadOfFinishedWorkstep": true,
}
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<GeneralPolicies>
<AllowSaveDocument>1</AllowSaveDocument>
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
<AllowRotatingPages>1</AllowRotatingPages>
<AllowAppendFileToWorkstep>1</AllowAppendFileToWorkstep>
<AllowAppendTasksToWorkstep>1</AllowAppendTasksToWorkstep>
<AllowEmailDocument>1</AllowEmailDocument>
<AllowPrintDocument>1</AllowPrintDocument>
<AllowFinishWorkstep>1</AllowFinishWorkstep>
<AllowRejectWorkstep>1</AllowRejectWorkstep>
<AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
<AllowUndoLastAction>1</AllowUndoLastAction>
<AllowColorizePdfForms>1</AllowColorizePdfForms>
<AllowReloadOfFinishedWorkstep>1</AllowReloadOfFinishedWorkstep>
<AllowAdhocPdfAttachments>1</AllowAdhocPdfAttachments>
<AllowAdhocSignatures>1</AllowAdhocSignatures>
<AllowAdhocStampings>1</AllowAdhocStampings>
<AllowAdhocFreeHandAnnotations>1</AllowAdhocFreeHandAnnotations>
<AllowAdhocTypewriterAnnotations>1</AllowAdhocTypewriterAnnotations>
<AllowAdhocPictureAnnotations>1</AllowAdhocPictureAnnotations>
<AllowAdhocPdfPageAppending>1</AllowAdhocPdfPageAppending>
</GeneralPolicies> |
...
Image Removed
...
As you can see on the right screenshot the recipient of the envelope can now print the document as well as reject the envelope and more.
Client Actions
In this section you can define client actions. For detailed information please have a look at the configuration below.
| Code Block |
|---|
|
"ClientActions": [
{
"RemoveDocumentFromRecentDocumentList": false,
"CallClientActionOnlyAfterSuccessfulSync": true,
"ClientName": "SIGNificant SignAnywhere",
"CloseApp": false,
"Action": "https://www.esignanywhere.net/"
}
]
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<FinishAction>
<ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
</FinishAction> |
Sender and receiver information
Sender information:
| Code Block |
|---|
|
"SenderInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
}
},
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<senderInformation>
<userInformation>
<firstName>FIRSTNAME</firstName>
<lastName>LASTNAME</lastName>
<eMail>##EMAIL##</eMail>
</userInformation>
</senderInformation> |
Receiver information:
| Code Block |
|---|
|
"ReceiverInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
}
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<receiverInformation>
<userInformation>
<firstName>FIRSTNAME</firstName>
<lastName>LASTNAME</lastName>
<eMail>##EMAIL##</eMail>
</userInformation>
<showNamirialDisposableDisclaimer>0</showNamirialDisposableDisclaimer>
</receiverInformation> |
Workstep task
Every task you add to the envelope you have to add also in the section Tasks in REST and in the following section if you create the envelope with SOAP: <WorkstepTasks>##TASK##</WorkstepTasks>. Furthermore you have to define the signature in the section signature template (only in SOAP):
Signatures
Note: In the StampImprintConfiguration you can define which data should be displayed after signing. So you could set, for example, that the IP address and the name should not be displayed after signing. Please see the next sample for a configuration in which all data is displayed. This is followed by a configuration in which only the date, the transaction token and the transaction id should be displayed.
| Info |
|---|
This sample was carried out with an SMS-OTP signature. With such a signature type, in addition to the name, IP address etc., the transaction token and telephone number can be displayed or hidden too. Note: If you want to hide all data just set the following variable false:
"DisplayExtraInformation”: false, |
| Code Block |
|---|
|
"AllowedSignatureTypes": [
{
"TrModType": "TransactionCodeSenderPlugin",
"TrValidityInSeconds": 300,
"Ly": "simpleTransactionCodeSms",
"TrConfId": "otpSignatureSmsText",
"IsPhoneNumberRequired": false,
"Id": "cee105ae-f407-42f9-993c-6b664055f5fb",
"DiscriminatorType": "SigTypeTransactionCode",
"Preferred": false,
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"OverrideLegacyStampImprint": true,
"DisplayTransactionId":true,
"DisplayTransaktionToken":true,
"DisplayPhoneNumber":true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0
}
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_0d123383-e054-81ec-0b17-96c4e7b955b3",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<AllowedSignatureTypes>
<sigType id="3dd00265-9101-4b90-b2ac-330fa8f2180a" type="TransactionCode">
<trModType>TransactionCodeSenderPlugin</trModType>
<trConfId>otpSignatureSmsText</trConfId>
<trValidityInSeconds>300</trValidityInSeconds>
<ly>simpleTransactionCodeSms</ly>
<phonenumber>##phonenumber##</phonenumber>
<StampImprintConfiguration>
<DisplayExtraInformation>1</DisplayExtraInformation>
<OverrideLegacyStampImprint>1</OverrideLegacyStampImprint> <DisplayTransactionId>1</DisplayTransactionId>
<DisplayTransaktionToken>1</DisplayTransaktionToken>
<DisplayPhoneNumber>1</DisplayPhoneNumber>
<DisplayEmail>1</DisplayEmail>
<DisplayIp>1</DisplayIp>
<DisplayName>1</DisplayName>
<DisplaySignatureDate>1</DisplaySignatureDate>
<FontFamily>Times New Roman</FontFamily>
<FontSize>11</FontSize>
</StampImprintConfiguration>
</sigType>
</AllowedSignatureTypes> |
...
Image Removed
| Code Block |
|---|
|
"AllowedSignatureTypes": [
{
"TrModType": "TransactionCodeSenderPlugin",
"TrValidityInSeconds": 300,
"Ly": "simpleTransactionCodeSms",
"TrConfId": "otpSignatureSmsText",
"IsPhoneNumberRequired": false,
"Id": "cee105ae-f407-42f9-993c-6b664055f5fb",
"DiscriminatorType": "SigTypeTransactionCode",
"Preferred": false,
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": false,
"OverrideLegacyStampImprint": false,
"DisplayTransactionId":true,
"DisplayTransaktionToken":true,
"DisplayPhoneNumber":false,
"DisplayIp": false,
"DisplayName": false,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0
}
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_0d123383-e054-81ec-0b17-96c4e7b955b3",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<AllowedSignatureTypes>
<sigType id="3dd00265-9101-4b90-b2ac-330fa8f2180a" type="TransactionCode">
<trModType>TransactionCodeSenderPlugin</trModType>
<trConfId>otpSignatureSmsText</trConfId>
<trValidityInSeconds>300</trValidityInSeconds>
<ly>simpleTransactionCodeSms</ly>
<phonenumber>##phonenumber##</phonenumber>
<StampImprintConfiguration>
<DisplayExtraInformation>1</DisplayExtraInformation>
<OverrideLegacyStampImprint>0</OverrideLegacyStampImprint>
<DisplayTransactionId>1</DisplayTransactionId>
<DisplayTransaktionToken>1</DisplayTransaktionToken>
<DisplayPhoneNumber>0</DisplayPhoneNumber>
<DisplayEmail>0</DisplayEmail>
<DisplayIp>0</DisplayIp>
<DisplayName>0</DisplayName>
<DisplaySignatureDate>1</DisplaySignatureDate>
<FontFamily>Times New Roman</FontFamily>
<FontSize>11</FontSize>
</StampImprintConfiguration>
</sigType>
</AllowedSignatureTypes> |
...
Image Removed
Click2Sign
This is the simplest signature type, the signer has just to click on the signature field to sing it.
| Code Block |
|---|
|
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"PositionPage": 1,
"Position": {
"PositionX": 69.0,
"PositionY": 529.92
},
"Size": {
"Height": 80.0,
"Width": 190.0
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "positioning",
"Value": "onPage"
},
{
"Key": "req",
"Value": "1"
},
{
"Key": "fd",
"Value": ""
},
{
"Key": "fd_dateformat",
"Value": "dd-MM-yyyy HH:mm:ss"
},
{
"Key": "fd_timezone",
"Value": "datetimeutc"
}
],
"AllowedSignatureTypes": [
{
"AllowedCapturingMethod": "Click2Sign",
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0
},
"Id": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
"DiscriminatorType": "SigTypeClick2Sign",
"Preferred": true
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
}
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
<positionPage>1</positionPage>
<DocRefNumber>1</DocRefNumber>
<positionX>80.22857</positionX>
<positionY>158.8629</positionY>
<width>171.4286</width>
<height>68.57143</height>
<param name="enabled">1</param>
<param name="completed">0</param>
<param name="sigType">Picture</param>
<param name="positioning">onPage</param>
<param name="allowedCapturingMethods">Click2Sign</param>
</sig> |
Draw2Sign
This type allows the signer to draw a signature by mouse, finger or pen. Just an image of the signature is created and embedded into the document.
| Code Block |
|---|
|
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"PositionPage": 1,
"Position": {
"PositionX": 69.0,
"PositionY": 529.92
},
"Size": {
"Height": 80.0,
"Width": 190.0
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "positioning",
"Value": "onPage"
},
{
"Key": "req",
"Value": "1"
},
{
"Key": "fd",
"Value": ""
},
{
"Key": "fd_dateformat",
"Value": "dd-MM-yyyy HH:mm:ss"
},
{
"Key": "fd_timezone",
"Value": "datetimeutc"
}
],
"AllowedSignatureTypes": [
{
"AllowedCapturingMethod": "Draw2Sign",
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0
},
"Id": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
"DiscriminatorType": "SigTypeDraw2Sign",
"Preferred": true
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
}
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
<positionPage>1</positionPage>
<DocRefNumber>1</DocRefNumber>
<positionX>80.22857</positionX>
<positionY>158.8629</positionY>
<width>171.4286</width>
<height>68.57143</height>
<param name="enabled">1</param>
<param name="completed">0</param>
<param name="sigType">Picture</param>
<param name="positioning">onPage</param>
<param name="allowedCapturingMethods">Draw2Sign</param>
</sig> |
Type2Sign
With this type of signature the signer has to type in his/her name to sign the signature field.
| Code Block |
|---|
|
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"PositionPage": 1,
"Position": {
"PositionX": 69.0,
"PositionY": 529.92
},
"Size": {
"Height": 80.0,
"Width": 190.0
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "positioning",
"Value": "onPage"
},
{
"Key": "req",
"Value": "1"
},
{
"Key": "fd",
"Value": ""
},
{
"Key": "fd_dateformat",
"Value": "dd-MM-yyyy HH:mm:ss"
},
{
"Key": "fd_timezone",
"Value": "datetimeutc"
}
],
"AllowedSignatureTypes": [
{
"AllowedCapturingMethod": "Type2Sign",
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0
},
"Id": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
"DiscriminatorType": "SigTypeType2Sign",
"Preferred": true
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
}
},
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
<positionPage>1</positionPage>
<DocRefNumber>1</DocRefNumber>
<positionX>80.22857</positionX>
<positionY>158.8629</positionY>
<width>171.4286</width>
<height>68.57143</height>
<param name="enabled">1</param>
<param name="completed">0</param>
<param name="sigType">Picture</param>
<param name="positioning">onPage</param>
<param name="allowedCapturingMethods">Type2Sign</param>
</sig> |
Biometric
| Code Block |
|---|
|
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"PositionPage": 1,
"Position": {
"PositionX": 67.0,
"PositionY": 521.92
},
"Size": {
"Height": 80.0,
"Width": 190.0
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "positioning",
"Value": "intersectsWithField"
},
{
"Key": "req",
"Value": "1"
},
{
"Key": "fd",
"Value": ""
},
{
"Key": "fd_dateformat",
"Value": "dd-MM-yyyy HH:mm:ss"
},
{
"Key": "fd_timezone",
"Value": "datetimeutc"
}
],
"AllowedSignatureTypes": [
{
"IsBio": false,
"AllowSkipBiometricVerification": false,
"AllowBiometricStoringOnly": false,
"SignedResponseWithoutBioData": false,
"Id": "6fa90b47-847f-47b1-b73a-9c3802aa077d",
"DiscriminatorType": "SigTypeBiometricSignature",
"Preferred": true
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_532f40e1-0583-8285-fc50-c2a76dc2fa44",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
}
}, |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
<positionPage>1</positionPage>
<DocRefNumber>1</DocRefNumber>
<positionX>80.22857</positionX>
<positionY>158.8629</positionY>
<width>171.4286</width>
<height>68.57143</height>
<param name="enabled">1</param>
<param name="completed">0</param>
<param name="positioning">onPage</param>
<AllowedSignatureTypes>
<sigType id="672d210e-9aa1-41b5-bb24-2e1b4b079f61" type="BiometricSignature">
<bio>0</bio>
</sigType>
</AllowedSignatureTypes>
</sig> |
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
After adding the signature fields in the signature template you have to add these signatures in the workstep task section. Following lines of code shows an example configuration of a workstep task. | Code Block |
|---|
| <WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
<Task enabled="1" completed="0" required="1" id="93cce567-ae5c-4e98-ac99-9f56ac034250" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" />
</WorkstepTasks>
|
The Id in the code within the workstep Id must be the same as the Id of the signature field |
Authentication
You can add different authentications for the recipient to ensure that only the one who has the code/phone number can open the envelope. Following list shows the different authentications:
In the next two collapses you can find the configuration for the Pin-authentication and for the SMS-authentication:
Pin-authentication
| Code Block |
|---|
|
{
"Method": "Pin",
"Parameter": "1234"
} |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<authentications>
<authentication>
<method>Pin</method>
<parameter>1234</parameter>
</authentication>
</authentications>
|
SMS-authentication
| Code Block |
|---|
|
{
"Method": "Sms",
"Parameter": "+0123456789"
} |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
| Code Block |
|---|
|
<authentications>
<authentication>
<method>Sms</method>
<parameter>+0123456789</parameter>
</authentication>
</authentications>
|
You have to place the authentication in the section “recipient”. You can find a workstep configuration with an authentication in the next section:
| Code Block |
|---|
|
"Steps": [
{
"OrderIndex": 1,
"Recipients": [
{
"Email": "##EMAIL##",
"FirstName": "##NAME##",
"LastName": "##NAME##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": [
{
"Method": "Pin",
"Parameter": "1234"
}
]
}
], |
...
| title | Alternative: SOAP implementation (deprecated) |
|---|
{
"Status": "InProgress",
"Email": "",
"LogDocumentId": "",
"FinishedDocuments": [],
"Steps": [
{
"Id": "b3df7533-c3d4-4041-a9a8-16039025dc02",
"FirstName": "##NAME##",
"LastName": "##NAME##",
"OrderIndex": 1,
"Email": "##EMAIL##",
"LanguageCode": "en",
"Status": "NotSigned",
"StatusReason": "",
"RecipientType": "Signer",
"WorkstepRedirectionUrl": "https://demo.xyzmo.com/workstepredirector/sign?identifier=##RedirectionURL##",
"AllowAccessFinishedWorkstep": false,
"Authentication": [
{
"Method": "Pin",
"Parameter": "1234",
"Filters": []
}
],
"IsParallel": false,
"WorkstepConfiguration": {
"WorkstepLabel": "test",
"SmallTextZoomFactorPercent": 100,
"FinishAction": {
"ServerActions": [
{
"CallSynchronous": false,
"Action": "https://demo.xyzmo.com/workstepredirector/setfinishaction?wid=##WorkstepId##"
}
],
"ClientActions": [
{
"RemoveDocumentFromRecentDocumentList": false,
"CallClientActionOnlyAfterSuccessfulSync": true,
"ClientName": "SIGNificant SignAnywhere",
"CloseApp": false,
"Action": "https://www.esignanywhere.net/"
}
]
},
"ReceiverInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
},
"TransactionCodePushPluginData": []
},
"SenderInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
}
},
"TransactionCodeConfigurations": [
{
"Id": "otpSignatureSmsText",
"HashAlgorithmIdentifier": "Sha256",
"Texts": [
]
}
],
"SignatureConfigurations": [
{
"PdfSignatureProperties": {
"PdfAConformant": false,
"PAdESPart4Compliant": false,
"IncludeSigningCertificateChain": false,
"SigningCertificateRevocationInformationIncludeMode": "DoNotInclude"
},
"PdfSignatureCryptographicData": {
"SignatureHashAlgorithm": "Sha256",
"SigningCertificateDescriptor": {
"Identifier": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae",
"Type": "Sha1Thumbprint",
"Csp": "Default"
}
}
},
{
"SpcId": "timestampSigningId",
"PdfSignatureProperties": {
"PdfAConformant": false,
"PAdESPart4Compliant": false,
"IncludeSigningCertificateChain": false,
"SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",
"SignatureTimestampData": {
"Uri": "https://timestamp.test.namirialtsp.com",
"Username": "xyzmo",
"Password": "xyzmo",
"SignatureHashAlgorithm": "Sha256"
}
},
"PdfSignatureCryptographicData": {
"SignatureHashAlgorithm": "Sha256",
"SigningCertificateDescriptor": {
"Identifier": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae",
"Type": "Sha1Thumbprint",
"Csp": "Default"
}
}
},
{
"SpcId": "padesSigningId",
"PdfSignatureProperties": {
"PdfAConformant": false,
"PAdESPart4Compliant": true,
"IncludeSigningCertificateChain": false,
"SigningCertificateRevocationInformationIncludeMode": "IncludeDss"
},
"PdfSignatureCryptographicData": {
"SignatureHashAlgorithm": "Sha256",
"SigningCertificateDescriptor": {
"Identifier": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae",
"Type": "Sha1Thumbprint",
"Csp": "Default"
}
}
},
{
"SpcId": "padesTimestampSigningId",
"PdfSignatureProperties": {
"PdfAConformant": false,
"PAdESPart4Compliant": true,
"IncludeSigningCertificateChain": false,
"SigningCertificateRevocationInformationIncludeMode": "IncludeDss",
"SignatureTimestampData": {
"Uri": "https://timestamp.test.namirialtsp.com",
"Username": "xyzmo",
"Password": "xyzmo",
"SignatureHashAlgorithm": "Sha256"
}
},
"PdfSignatureCryptographicData": {
"SignatureHashAlgorithm": "Sha256",
"SigningCertificateDescriptor": {
"Identifier": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae",
"Type": "Sha1Thumbprint",
"Csp": "Default"
}
}
},
{
"SpcId": "padesRemoteCertificateSigningId",
"PdfSignatureProperties": {
"PdfAConformant": false,
"PAdESPart4Compliant": true,
"IncludeSigningCertificateChain": false,
"SigningCertificateRevocationInformationIncludeMode": "IncludeDss"
},
"PdfSignatureCryptographicData": {
"SignatureHashAlgorithm": "Sha256",
"SigningCertificateDescriptor": {
"Identifier": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae",
"Type": "Sha1Thumbprint",
"Csp": "Default"
}
}
},
{
"SpcId": "padesRemoteCertificateTimestampSigningId",
"PdfSignatureProperties": {
"PdfAConformant": false,
"PAdESPart4Compliant": true,
"IncludeSigningCertificateChain": false,
"SigningCertificateRevocationInformationIncludeMode": "IncludeDss",
"SignatureTimestampData": {
"Uri": "https://timestamp.test.namirialtsp.com",
"Username": "xyzmo",
"Password": "xyzmo",
"SignatureHashAlgorithm": "Sha256"
}
},
"PdfSignatureCryptographicData": {
"SignatureHashAlgorithm": "Sha256",
"SigningCertificateDescriptor": {
"Identifier": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae",
"Type": "Sha1Thumbprint",
"Csp": "Default"
}
}
},
{
"SpcId": "automaticSigningId",
,
"GivenName": "string",
"PdfSignaturePropertiesSurname": {
"string",
"PdfAConformant"PhoneNumber": false"string",
"PAdESPart4Compliant"LanguageCode": false,"AF"
"IncludeSigningCertificateChain": false,
"SigningCertificateRevocationInformationIncludeMode": "DoNotInclude"}, |
Personal message
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Personal message |
|---|
|
"PersonalMessage": "string",
|
Authentication
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Authentication |
|---|
|
"AuthenticationConfiguration": { |
Within this section you can place the different authentication methods:
Access code
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Access code |
|---|
|
"AccessCode": {
"Code": "string"
},
"PdfSignatureCryptographicData |
SMS-OTP
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | SMS-OTP |
|---|
|
"SmsOneTimePassword": {
"SignatureHashAlgorithm"PhoneNumber": "Sha256string",
"SigningCertificateDescriptor}, |
Swedish Bank Id
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Swedish Bank Id |
|---|
|
"SwedishBankId": {
"Identifier"PersonalNumber": "14527a6bcfa8b4d7d0183fca6b735b1c246d14aestring",
"AllowAnyPersonalNumber": true
}, |
OAuth2
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | OAuth2 |
|---|
|
"TypeOAuthAuthentications": "Sha1Thumbprint",
[
{
"CspProviderName": "Defaultstring",
"Validations": [
}
{
"FieldReferenceId": "string",
}
"ExpectedValue": "string"
},
}
{]
}
"SpcId], |
SAML
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | SAML |
|---|
|
"SamlAuthentications": "automaticTimestampSigningId",[
{
"PdfSignaturePropertiesProviderName": {"string",
"Validations": [
"PdfAConformant": false, {
"FieldReferenceId": "string",
"PAdESPart4Compliant": false,
"ExpectedValue": "string"
}
"IncludeSigningCertificateChain": false,
]
}
"SigningCertificateRevocationInformationIncludeMode": "DoNotInclude"] |
Additionally to the those configuration referring the recipient also following settings are available. This setting include to disable the email and allowing the recipient to access the envelope again after it has been completed and closed. Furthermore, it is possible to include app links in the email and allowing delegation:
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Additional recipient configuration |
|---|
|
"DisableEmail": true,
"AllowAccessAfterFinish": true,
"SignatureTimestampData"IncludedEmailAppLinks": {
"Android": true,
"Uri"iOS": "https://timestamp.test.namirialtsp.com"true,
"Windows": true
},
"Username": "xyzmo",AllowDelegation": true |
Elements
In this section you can add elements for the recipient which (if they are set required) must be finished in order to finish the envelope.
PDF Forms
Textbox
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Textbox |
|---|
|
"TextBoxes": [
{
"PasswordElementId": "xyzmostring",
"Required": true,
"SignatureHashAlgorithm"Value": "Sha256string",
"DocumentNumber": 0,
"Validation": {
}
"Type": "None",
},
"DateValidationConfiguration": {
"Format": "string",
"PdfSignatureCryptographicData": {
"Range": {
"SignatureHashAlgorithmFrom": "Sha256string",
"To": "string"
"SigningCertificateDescriptor": {
}
},
"IdentifierNumberValidationConfiguration": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae",{
"DecimalDigits": 0,
"TypeSymbol": "Sha1Thumbprintstring",
"SymbolLocation": "Start",
"CspGroupSeparator": "DefaultComma",
"DecimalSeparator": "Comma",
}
"Range": {
}"From": "string",
},"To": "string"
}
{
},
"SpcIdPhoneValidationConfiguration": "swissComSigningId",
{
"PdfSignaturePropertiesType": {"International"
},
"PdfAConformantTimeValidationConfiguration": false,{
"Format": "string",
"PAdESPart4Compliant": true,
"Range": {
"From": "string",
"IncludeSigningCertificateChain": false,
"To": "string"
"SigningCertificateRevocationInformationIncludeMode": "IncludeDss"
}
}
},
"FieldDefinition": {
"PdfSignatureCryptographicDataReadOnly": {true,
"MaxLength": 0,
"SignatureHashAlgorithmIsMultiline": "Sha256"true,
"IsPassword": true,
"SigningCertificateDescriptorIsFileSelect": {true,
"IsScrollAllowed": true,
"IdentifierIsCombined": "14527a6bcfa8b4d7d0183fca6b735b1c246d14ae"true,
"TextFormat": {
"TypeTextColor": "Sha1Thumbprintstring",
"FontSizeInPt": 0,
"CspFontName": "Defaultstring",
"Bold": true,
}
"Italic": true,
"TextAlign": "Left"
}
},
}
"Position": {
"PageNumber": ]0,
"ViewerPreferencesX": {0,
"Y": 0
"FinishWorkstepOnOpen": false,
},
"VisibleAreaOptionsSize": {
"AllowedDomain"Width": "*"0,
"Enabled"Height": false0
}
}
},
},
"TaskConfiguration": {
"ResourceUrisGroupedOrderDefinition": {
"SignatureImagesUriGroupId": "https://demo.xyzmo.com/Resource/SignatureImages/?link=1NB8ErluKvwtK3g7VVj4PvoPlDStEIYcIkbMequyIb2k2OMxZGqFHgVK2vy8WtBzP"
string",
"OrderIndex": 0
},
}
"Policy": {
}
}
"GeneralPolicies], |
Checkbox
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Checkbox |
|---|
|
"CheckBoxes": {[
{
"AllowSaveDocumentElementId": true"string",
"RequiredEvalPolicy": "None",
"AllowSaveAuditTrailDocumentNumber": true0,
"Required": true,
"AllowRotatingPagesIsChecked": falsetrue,
"FieldDefinition": {
"AllowAppendFileToWorkstepExportValue": false"string",
"Position": {
"AllowAppendTaskToWorkstep": false,
"PageNumber": 0,
"AllowEmailDocumentX": true0,
"Y": 0
"AllowPrintDocument": true,
},
"Size": {
"AllowFinishWorkstep": true,
"Width": 0,
"AllowRejectWorkstepHeight": true,0
},
"AllowRejectWorkstepDelegationReadOnly": true,
},
"AllowUndoLastAction": true,
TaskConfiguration": {
"GroupedOrderDefinition": {
"AllowColorizePdfForms": false,
"GroupId": "string",
"AllowAdhocPdfAttachmentsOrderIndex": false,0
}
"AllowAdhocSignatures": false, }
}
"AllowAdhocStampings], |
Combobox
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Combobox |
|---|
|
"ComboBoxes": false,[
{
"AllowAdhocFreeHandAnnotationsElementId": false"string",
"DocumentNumber": 0,
"AllowAdhocTypewriterAnnotationsRequired": falsetrue,
"Value": "string",
"AllowAdhocPictureAnnotationsFieldDefinition": false,{
"TextFormat": {
"AllowAdhocPdfPageAppending": false
"TextColor": "string",
"FontSizeInPt": }0,
"FontName": "string",
"WorkstepTasks": {
"Bold": true,
"PictureAnnotationMinResolutionItalic": 0true,
"TextAlign": "Left"
"PictureAnnotationMaxResolution": 0,
},
"Items": [
"PictureAnnotationColorDepth": "Color16M",
{
"SequenceModeExportValue": "NoSequenceEnforcedstring",
"DisplayValue": "string"
"PositionUnits": "PdfUnits",
}
],
"ReferenceCorner": "Lower_Left",
"IsEditable": true,
"TasksReadOnly": [true,
"Position": {
{ "PageNumber": 0,
"X": 0,
"PositionPageY": 1,0
},
"PositionSize": {
"Width": 0,
"PositionXHeight": 65.0,
}
},
"PositionYTaskConfiguration": 602.0{
"GroupedOrderDefinition": {
}"GroupId": "string",
"OrderIndex": 0
"Size": {}
}
}
], |
Radio button
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Radio button |
|---|
|
"HeightRadioButtons": 80.0,[
{
"GroupName": "string",
"WidthDocumentNumber": 190.0,
"IsSelectUnison": true,
"ToggleToOff": true,
}"Required": true,
"SelectedItem": "string",
"FieldDefinitions": [
"AdditionalParameters": [
{
"ExportValue": "string",
{
"IsChecked": true,
"CheckBoxAppearance": true,
"KeyReadOnly": "enabled"true,
"Position": {
"ValuePageNumber": "1"0,
"X": 0,
},
"Y": 0
},
"Size": {
"Width": 0,
"KeyHeight": "positioning",0
}
}
"Value": "onPage"
],
"GroupTaskConfiguration": {
},"GroupedOrderDefinition": {
"GroupId": "string",
{"OrderIndex": 0
}
}
"Key": "req",}
], |
Listbox
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Listbox |
|---|
|
"ListBoxes": [
{
"ValueElementId": "1string",
"DocumentNumber": 0,
"Required": true,
},
"PreSelectedItems": [
"string"
],
{
"FieldDefinition": {
"TextFormat": {
"KeyTextColor": "fdstring",
"FontSizeInPt": 0,
"FontName": "string",
"Value": ""
"Bold": true,
"Italic": true,
},
"TextAlign": "Left"
},
{
"Items": [
{
"KeyExportValue": "fd_dateformatstring",
"DisplayValue": "string"
}
"Value": "dd-MM-yyyy HH:mm:ss"
],
"IsMultiSelect": true,
},
"ReadOnly": true,
"Position": {
{"PageNumber": 0,
"X": 0,
"Y": 0
"Key": "fd_timezone",
},
"Size": {
"ValueWidth": "datetimeutc"0,
"Height": 0
}
}
},
"TaskConfiguration": {
],"GroupedOrderDefinition": {
"GroupId": "string",
"AllowedSignatureTypesOrderIndex": [0
}
}
{
}
], |
Signatures
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Signature information |
|---|
|
"Signatures": [
{
"AllowedCapturingMethodId": "Click2Signstring",
"Required": true,
"DocumentNumber": 0,
"IdDisplayName": "5d8de01a-b924-4d87-98c9-cc45909c0b4bstring",
"FieldDescription": "string",
"AllowedSignatureTypes": { |
Before you add the signatures please add the following in the section "Signatures" . [ in order to set the order of the recipients (required) and to set the timestamp (optional):
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | TaskConfiguration |
|---|
|
"TaskConfiguration": {
"DiscriminatorTypeStampImprintDateConfiguration": "SigTypeClick2Sign",{
"UseLocalTimezone": true,
"PreferredDateTimeFormat": false,"string"
},
"StampImprintConfiguration"UseExternalTimestampServer": {
true,
"DisplayExtraInformation"BatchId": true"string",
"OrderDefinition": {
"DisplayEmailOrderIndex": true,0
}
"DisplayIp": true,
} |
In the "AllowedSignatureTypes" you can place the following available signature types:
| Info |
|---|
Please note: The following configurations for the signature types do not include the field definition. Please add the following code to the choosen signature type in order to place the signature field on the document. | Code Block |
|---|
| language | java |
|---|
| title | Field definition |
|---|
| "FieldDefinition": {
"Position": {
|
"DisplayNametrue"DisplaySignatureDate":true,
"FontFamily"TimesNewRoman",
"FontSize
|
ClickToSign
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | ClickToSign |
|---|
|
"ClickToSign": 11.0{
"UseExternalSignatureImage": "Optional",
"Preferred": true,
}
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
}
"DisplayEmail": true,
"DisplayTransactionId": ]true,
"DisplayTransactionToken": true,
"UseTimestampDisplayPhoneNumber": falsetrue,
"UseCustomStampImprint": true,
"IsRequiredDisplayIp": true,
"DisplayName": true,
"IdDisplaySignatureDate": "1#XyzmoDuplicateIdSeperator#Signature_a9cd7f4f-6c7d-ff20-dc3f-dea0a4638bd4",
true,
"FontName": "string",
"DisplayNameFontSizeInPt": "",0
}
"DocRefNumber}, |
DrawToSign
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | DrawToSign |
|---|
|
"DrawToSign": 1,{
"UseExternalSignatureImage": "Optional",
"DiscriminatorTypePreferred": "Signature"true,
"StampImprintConfiguration": {
},
"DisplayExtraInformation": true,
"DisplayEmail": true,
{
"DisplayTransactionId": true,
"FormsDisplayTransactionToken": [true,
"DisplayPhoneNumber": true,
{
"UseCustomStampImprint": true,
"DisplayIp": true,
"IsScrollAllowedDisplayName": falsetrue,
"DisplaySignatureDate": true,
"IsCombFontName": false"string",
"FontSizeInPt": 0
}
"MaxLength": 0,
}, |
TypeToSign
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | TypeToSign |
|---|
|
"TypeToSign": {
"UseExternalSignatureImage": "Optional",
"IsMultiLinePreferred": falsetrue,
"StampImprintConfiguration": {
"IsPasswordDisplayExtraInformation": falsetrue,
"DisplayEmail": true,
"IsFileSelectDisplayTransactionId": falsetrue,
"DisplayTransactionToken": true,
"IsRequiredDisplayPhoneNumber": falsetrue,
"UseCustomStampImprint": true,
"IdDisplayIp": "TextBox_4e277dde-23c4-8a81-103a-f84abd798a8a"true,
"DisplayName": true,
"PositionPageDisplaySignatureDate": 1true,
"FontName": "string",
"DocRefNumberFontSizeInPt": 1,0
}
}, |
LocalCertificate
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | LocalCertificate |
|---|
|
"LocalCertificate": {
"Position": {
"EnforcePreferredHashAlgorithm": true,
"PreferredHashAlgorithm": "Sha256",
"PositionXUseExternalSignatureImage": 71.0"Optional",
"Preferred": true,
"StampImprintConfiguration": {
"PositionY": 558.0
"DisplayExtraInformation": true,
"DisplayEmail": true,
},
"DisplayTransactionId": true,
"DisplayTransactionToken": true,
"Size": {
"DisplayPhoneNumber": true,
"UseCustomStampImprint": true,
"HeightDisplayIp": 20.0true,
"DisplayName": true,
"DisplaySignatureDate": true,
"Width": 126.0
"FontName": "string",
"FontSizeInPt": 0
},
}
}, |
DisposableCertificate
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | DisposableCertificate |
|---|
|
"DisposableCertificate": {
"IsHiddenIsLongLived": false,
"ValidityInSeconds": 0,
"ExportValueUseExternalSignatureImage": "Optional",
"Preferred": true,
"DescriptionStampImprintConfiguration": "",{
"DisplayExtraInformation": true,
"KeepExistingValueDisplayEmail": true,
"DisplayTransactionId": true,
"DiscriminatorTypeDisplayTransactionToken": "TextBox"true,
"DisplayPhoneNumber": true,
}
"UseCustomStampImprint": true,
"DisplayIp": true,
] "DisplayName": true,
"DisplaySignatureDate": true,
"IsRequiredFontName": false"string",
"FontSizeInPt": 0
}
"Id": "73df5772-d204-40ca-908e-34d43891bc01",
}, |
DisposableCertificate (Long-Lived)
Beside the disposable certificate, the solution can use a specific procedure called "Long-Lived Disposable" for scenarios where the signature becomes a valid qualified signature after signing. This can be useful where the identification is confirmed/approved after signing of the document.
| Info |
|---|
Please note the following: It is not allowed to download the document or the audit trail for a long-lived disposable. Therefore, the policies must be set correctly (<AllowSaveDocument>0</AllowSaveDocument> and <AllowSaveAuditTrail>0</AllowSaveAuditTrail>) |
General description
The Long-Lived Disposable Certificate (LLD) is a special variant of a Disposable certificate.
The main difference to the disposable certificate is, that it is not being activated immediately, but after the signatures have been applied. LLD are always active, no need to activate them.
Please see the following sample configuration for LLD:
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | DisposableCertificate (Long-Lived) |
|---|
|
"DisposableCertificate": {
"DisplayNameIsLongLived": ""true,
"DocRefNumberValidityInSeconds": 10,
"DiscriminatorType"UseExternalSignatureImage": "FormGroupOptional",
"Preferred": true,
}
"StampImprintConfiguration": {
]"DisplayExtraInformation": true,
}"DisplayEmail": true,
}"DisplayTransactionId": true,
"NavigationDisplayTransactionToken": {true,
"HyperLinksDisplayPhoneNumber": []true,
"Links"UseCustomStampImprint": []true,
"LinkTargetsDisplayIp": []true,
}"DisplayName": true,
}
}"DisplaySignatureDate": true,
{
"Id"FontName": "68b7605b-8403-40ee-896e-e896be5459fcstring",
"FirstNameFontSizeInPt": "##NAME##",0
"LastName": "##NAME##",}
"OrderIndex}, |
SwissComOnDemand
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | SwissComOnDemand |
|---|
|
"SwissComOnDemand": 2,{
"EmailValidityInSeconds": "##EMAIL##"0,
"LanguageCodePreferred": "en"true,
"StatusStampImprintConfiguration": "NotSigned",{
"StatusReasonDisplayExtraInformation": ""true,
"RecipientTypeDisplayEmail": "Cc"true,
"WorkstepRedirectionUrlDisplayTransactionId": ""true,
"AllowAccessFinishedWorkstepDisplayTransactionToken": falsetrue,
"IsParallelDisplayPhoneNumber": falsetrue,
"WorkstepConfigurationUseCustomStampImprint": {true,
"SmallTextZoomFactorPercentDisplayIp": 100true,
"ViewerPreferencesDisplayName": {}true,
"PolicyDisplaySignatureDate": {true,
"GeneralPolicies"FontName": {"string",
"FontSizeInPt": 0
"AllowRotatingPages": true,
}
"AllowFinishWorkstep}, |
ATrustCertificate
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | ATrustCertificate |
|---|
|
"ATrustCertificate": true,{
"TemplateId": "string",
"AllowUndoLastAction": true
"Preferred": true,
},
"StampImprintConfiguration": {
"WorkstepTasksDisplayExtraInformation": {
true,
"DisplayEmail": true,
"PictureAnnotationMinResolution": 0,
"DisplayTransactionId": true,
"PictureAnnotationMaxResolutionDisplayTransactionToken": 0true,
"DisplayPhoneNumber": true,
"PictureAnnotationColorDepth": "Color16M",
"UseCustomStampImprint": true,
"SequenceModeDisplayIp": "NoSequenceEnforced"true,
"DisplayName": true,
"PositionUnits": "PdfUnits",
"DisplaySignatureDate": true,
"ReferenceCornerFontName": "Lower_Leftstring",
"FontSizeInPt": 0
"Tasks": []
}
}}, |
Biometric
Please note the following available values for the "SignaturePositioning":
| Value | Description |
|---|
| intersects with field | The signature has to start within the signature field, but the signer is allowed to leave the boundaries of the box while signing |
| 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 | Biometric |
|---|
|
"Biometric": {
"BiometricVerification": true,
}
}"AllowBiometricStoringOnly": true,
}
"StoreSignedResponseWithoutBioData": true,
]
}
],
"DocumentsAllowSkipBiometricVerification": [true,
{
"PageSizesInPointsBiometricServerUserId": ["string",
{ "SignaturePositioning": "WithinField",
"HeightPreferred": 792.0true,
"WidthStampImprintConfiguration": 612.0{
}
"DisplayExtraInformation": true,
],
"DocRefNumberDisplayEmail": 1true,
"FileName": "Test.pdf",
"FormFieldsDisplayTransactionId": [true,
{
"DisplayTransactionToken": true,
"NameDisplayPhoneNumber": "TextBox_4e277dde-23c4-8a81-103a-f84abd798a8a"true,
"ValuesUseCustomStampImprint": [true,
{
"DisplayIp": true,
"KeyDisplayName": ""true,
"ValueDisplaySignatureDate": ""true,
}
"FontName": "string",
]
"FontSizeInPt": 0
}
]}
}
],
"Id": "b94e4d2a-9901-48d5-8896-effd2cc17a96",
}, |
RemoteCertificate
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | RemoteCertificate |
|---|
|
"RemoteCertificate": {
"Bulk": "",
"BasicOptions": {
"NameValidityInSeconds": "test"0,
"EmailSubject": "Please sign the enclosed envelope",
"EmailBodyUseExternalSignatureImage": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
Optional",
"EnableRemindersPreferred": true,
"FirstReminderDayAmount": 5,
"RecurrentReminderDayAmount": 3,
"BeforeExpirationDayAmountStampImprintConfiguration": 3{
}
} |
| Expand |
|---|
| title | Alternative: SOAP implementation (deprecated) |
|---|
|
| Code Block |
|---|
|
|
<baseResult>ok</baseResult>
<okInfo>
<envelopeStatus>
<name>eSignAnyWhere
Tutorial</name>
"DisplayExtraInformation": true,
<eMailSubject>Document
of
eSignAnyWhere
Tutorial</eMailSubject>
<eMailBody>Dear
#RecipientFirstName#!
Please
sign
this
tutorial
document.</eMailBody>
<enableReminders>true</enableReminders>"DisplayEmail": true,
<firstReminderDayAmount>1</firstReminderDayAmount>
<recurrentReminderDayAmount>1</recurrentReminderDayAmount>
<beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
<id>3385b0cd-29d0-4849-b6a5-06b7c39abc1f</id>"DisplayTransactionId": true,
<bulk></bulk>
<status>InProgress</status>
<sendDate>2020-04-10T11:31:55.967Z</sendDate>
<expirationDate>2020-04-12T11:31:55.967Z</expirationDate>"DisplayTransactionToken": true,
<daysUntilExpire
/>
<bulkRecipients>
<bulkRecipient
eMail="DisplayPhoneNumber"
id="">
: true,
<status>InProgress</status>
<recipients>"UseCustomStampImprint": true,
<recipient>
"DisplayIp": true,
<id>08b584bf-2c61-44a2-90e4-b62527d7542b</id>
<orderIndex>1</orderIndex>
"DisplayName": true,
<firstName>Alice</firstName>
<lastName>Somename</lastName>"DisplaySignatureDate": true,
<eMail>##EMAIL##</eMail>
"FontName": "string",
<languageCode>en</languageCode>
<status>NotSigned</status>
"FontSizeInPt": 0
<signedDate></signedDate>
}
<openedDate></openedDate>
<recipientType>Signer</recipientType>},
OneTimePassword
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | OneTimePassword |
|---|
|
"OneTimePassword": {
<isParallel>false</isParallel>
"ValidityInSeconds": 0,
<workstepRedirectionUrl>https://demo.xyzmo.com/workstepredirector/sign?identifier=##WorkstepRedirection##</workstepRedirectionUrl>
<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>"UseExternalSignatureImage": "Optional",
<authentication>
"Preferred": true,
<method>Pin</method>
"StampImprintConfiguration": {
<parameter>1234</parameter>
</authentication>
"DisplayExtraInformation": true,
<workstepConfiguration>
"DisplayEmail": true,
<WorkstepLabel />
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
"DisplayTransactionId": true,
<WorkstepTimeToLiveInMinutes>11520</WorkstepTimeToLiveInMinutes>
"DisplayTransactionToken": true,
<FinishAction>
<ServerAction callSynchronous=" 0DisplayPhoneNumber" >https://demo.xyzmo.com/workstepredirector/setfinishaction?wid=##WorkstepId##</ServerAction>: true,
</FinishAction>
"UseCustomStampImprint": true,
<signatureTemplate>
"DisplayIp": true,
<version>1.2.0.2</version>
<positionUnits>PdfUnits</positionUnits>
"DisplayName": true,
<positionReferenceCorner>Lower_Left</positionReferenceCorner>
"DisplaySignatureDate": true,
<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
"FontName": "string",
<positionPage>1</positionPage>"FontSizeInPt": 0
<DocRefNumber>1</DocRefNumber>}
}, |
SwedishBankId
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | SwedishBankId |
|---|
|
<positionX>80.22857</positionX>"SwedishBankId": {
<positionY>158.8629</positionY>"Preferred": true,
<width>171.4286</width>"StampImprintConfiguration": {
<height>68.57143</height> "DisplayExtraInformation": true,
<param name=" enabled">1</param>DisplayEmail": true,
<param name=" completed">0</param>
DisplayTransactionId": true,
<param name=" sigType">Picture</param>DisplayTransactionToken": true,
<param name=" positioning">onPage</param>
DisplayPhoneNumber": true,
<param name=" allowedCapturingMethods">Click2Sign</param>UseCustomStampImprint": true,
</sig>
"DisplayIp": true,
</signatureTemplate>
"DisplayName": true,
<Policy version="1.1.0.0">
<GeneralPolicies>
"DisplaySignatureDate": true,
<AllowSaveDocument>1</AllowSaveDocument>
"FontName": "string",
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
"FontSizeInPt": 0
</GeneralPolicies>
}
<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
}, |
SignaturePlugins
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | SignaturePlugins |
|---|
|
"SignaturePlugins": [
<Task enabled="1" completed="0" required="1" id="93cce567-ae5c-4e98-ac99-9f56ac034250" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" /> {
</WorkstepTasks>
"PluginId": "string",
</Policy>
"Preferred": true,
<TransactionCodeConfigurations>
<TransactionCodeConfiguration trConfId="StampImprintConfiguration" >: {
"DisplayExtraInformation": true,
</TransactionCodeConfiguration>
"DisplayEmail": true,
</TransactionCodeConfigurations>
<receiverInformation>
"DisplayTransactionId": true,
<userInformation>
"DisplayTransactionToken": true,
<firstName>Alice</firstName>
"DisplayPhoneNumber": true,
<lastName>Somename</lastName>
<eMail>##EMAIL##</eMail>
"UseCustomStampImprint": true,
</userInformation>
"DisplayIp": true,
<showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
</receiverInformation>
"DisplayName": true,
<senderInformation>
"DisplaySignatureDate": true,
<userInformation>
"FontName": "string",
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>"FontSizeInPt": 0
<eMail>##EMAIL##</eMail>
}
</userInformation>
}
</senderInformation> ] |
Predefined Field Elements
You can also add predefined elements to the document. Please see the following configurations:
Textfields
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Textfields |
|---|
|
"TextFields": [
<signaturePluginConfiguration>{
<PdfSignatureProperties_V1>"ElementId": "string",
<PdfAConformant>false</PdfAConformant>"DocumentNumber": 0,
<PAdESPart4Compliant>false</PAdESPart4Compliant>"Value": "string",
"FieldDefinition": {
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
<SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>"TextFormat": {
</PdfSignatureProperties_V1>
"TextColor": "string",
<PdfSignatureCryptographicData_V1>
"FontSizeInPt": 0,
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
<SigningCertificateDescriptor>"FontName": "string",
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier> "Bold": true,
<Type>Sha1Thumbprint</Type>"Italic": true,
<Csp>Default</Csp> "TextAlign": "Left"
</SigningCertificateDescriptor>},
</PdfSignatureCryptographicData_V1>
"Position": {
</signaturePluginConfiguration>
"PageNumber": 0,
<signaturePluginConfiguration spcId="timestampSigningId">
"X": 0,
<PdfSignatureProperties_V1>
<PdfAConformant>false</PdfAConformant>"Y": 0
<PAdESPart4Compliant>false</PAdESPart4Compliant>},
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
"Size": {
<SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>"Width": 0,
<SignatureTimestampData>
"Height": 0
<Password>xyzmo</Password> }
}
<SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>
}
<Uri>https://timestamp.test.namirialtsp.com</Uri>
], |
EmailFields
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | EmailFields |
|---|
|
"EmailFields": [
<UserName>xyzmo</UserName>{
</SignatureTimestampData>"ElementId": "string",
</PdfSignatureProperties_V1>"DocumentNumber": 0,
<PdfSignatureCryptographicData_V1>"FieldDefinition": {
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>"TextFormat": {
<SigningCertificateDescriptor> "TextColor": "string",
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier> "FontSizeInPt": 0,
<Type>Sha1Thumbprint</Type> "FontName": "string",
<Csp>Default</Csp>"Bold": true,
</SigningCertificateDescriptor>
"Italic": true,
</PdfSignatureCryptographicData_V1>
"TextAlign": "Left"
</signaturePluginConfiguration>
},
<signaturePluginConfiguration spcId="padesSigningId">
"Position": {
<PdfSignatureProperties_V1>
<PdfAConformant>false</PdfAConformant>"PageNumber": 0,
<PAdESPart4Compliant>true</PAdESPart4Compliant>
"X": 0,
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
"Y": 0
<SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
},
</PdfSignatureProperties_V1>
"Size": {
<PdfSignatureCryptographicData_V1>
"Width": 0,
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
"Height": 0
<SigningCertificateDescriptor>
}
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
}
<Type>Sha1Thumbprint</Type>
}
<Csp>Default</Csp>], |
InitialsFields
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | InitialsFields |
|---|
|
"InitialsFields": [
{
</SigningCertificateDescriptor>
"ElementId": "string",
</PdfSignatureCryptographicData_V1>
</signaturePluginConfiguration>
"DocumentNumber": 0,
<signaturePluginConfiguration spcId=" padesTimestampSigningId">IncludeMiddleNameInitials": true,
<PdfSignatureProperties_V1>
"FieldDefinition": {
<PdfAConformant>false</PdfAConformant>"TextFormat": {
<PAdESPart4Compliant>true</PAdESPart4Compliant>
"TextColor": "string",
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
"FontSizeInPt": 0,
<SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
"FontName": "string",
<SignatureTimestampData>
"Bold": true,
<Password>xyzmo</Password>
<SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>"Italic": true,
<Uri>https://timestamp.test.namirialtsp.com</Uri>"TextAlign": "Left"
},
<UserName>xyzmo</UserName>
</SignatureTimestampData>"Position": {
</PdfSignatureProperties_V1>
"PageNumber": 0,
<PdfSignatureCryptographicData_V1>
"X": 0,
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
<SigningCertificateDescriptor>"Y": 0
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>},
<Type>Sha1Thumbprint</Type>"Size": {
<Csp>Default</Csp>"Width": 0,
</SigningCertificateDescriptor>
"Height": 0
</PdfSignatureCryptographicData_V1>
}
</signaturePluginConfiguration>
}
<signaturePluginConfiguration spcId="padesRemoteCertificateSigningId">
}
<PdfSignatureProperties_V1>
], |
GivenNameFields
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | GivenNameFields |
|---|
|
"GivenNameFields": [
<PdfAConformant>false</PdfAConformant>{
<PAdESPart4Compliant>true</PAdESPart4Compliant>"ElementId": "string",
"DocumentNumber": 0,
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
"FieldDefinition": {
<SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
</PdfSignatureProperties_V1>"TextFormat": {
<PdfSignatureCryptographicData_V1>
"TextColor": "string",
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
"FontSizeInPt": 0,
<SigningCertificateDescriptor>
"FontName": "string",
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
"Bold": true,
<Type>Sha1Thumbprint</Type>
"Italic": true,
<Csp>Default</Csp>
"TextAlign": "Left"
</SigningCertificateDescriptor>
},
</PdfSignatureCryptographicData_V1>
</signaturePluginConfiguration>
"Position": {
<signaturePluginConfiguration spcId="padesRemoteCertificateTimestampSigningId">
"PageNumber": 0,
<PdfSignatureProperties_V1>"X": 0,
<PdfAConformant>false</PdfAConformant> "Y": 0
<PAdESPart4Compliant>true</PAdESPart4Compliant>},
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
"Size": {
<SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode> "Width": 0,
<SignatureTimestampData>
"Height": 0
<Password>xyzmo</Password>}
}
<SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>
}
<Uri>https://timestamp.test.namirialtsp.com</Uri>
], |
SurnameFields
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | SurnameFields |
|---|
|
"SurnameFields": [
<UserName>xyzmo</UserName>{
</SignatureTimestampData>"ElementId": "string",
</PdfSignatureProperties_V1>"DocumentNumber": 0,
<PdfSignatureCryptographicData_V1> "FieldDefinition": {
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>"TextFormat": {
<SigningCertificateDescriptor> "TextColor": "string",
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>"FontSizeInPt": 0,
<Type>Sha1Thumbprint</Type>
"FontName": "string",
<Csp>Default</Csp>"Bold": true,
</SigningCertificateDescriptor>
"Italic": true,
</PdfSignatureCryptographicData_V1>
"TextAlign": "Left"
</signaturePluginConfiguration>
},
<signaturePluginConfiguration spcId="automaticSigningId">
"Position": {
<PdfSignatureProperties_V1>
<PdfAConformant>false</PdfAConformant>"PageNumber": 0,
<PAdESPart4Compliant>false</PAdESPart4Compliant>
"X": 0,
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
"Y": 0
<SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
},
</PdfSignatureProperties_V1>
"Size": {
<PdfSignatureCryptographicData_V1>
"Width": 0,
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
"Height": 0
<SigningCertificateDescriptor>
}
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
}
<Type>Sha1Thumbprint</Type>
}
<Csp>Default</Csp>], |
FullNameFields
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | FullNameFields |
|---|
|
"FullNameFields": [
{
</SigningCertificateDescriptor>
"ElementId": "string",
</PdfSignatureCryptographicData_V1>
</signaturePluginConfiguration>"DocumentNumber": 0,
<signaturePluginConfiguration spcId=" automaticTimestampSigningIdFieldDefinition" >: {
<PdfSignatureProperties_V1> "TextFormat": {
<PdfAConformant>false</PdfAConformant>
"TextColor": "string",
<PAdESPart4Compliant>false</PAdESPart4Compliant>
"FontSizeInPt": 0,
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
"FontName": "string",
<SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
"Bold": true,
<SignatureTimestampData>
"Italic": true,
<Password>xyzmo</Password>
"TextAlign": "Left"
<SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>
},
<Uri>https://timestamp.test.namirialtsp.com</Uri>
"Position": {
<UserName>xyzmo</UserName>
"PageNumber": 0,
</SignatureTimestampData>
"X": 0,
</PdfSignatureProperties_V1>
<PdfSignatureCryptographicData_V1>"Y": 0
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>},
<SigningCertificateDescriptor>"Size": {
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>"Width": 0,
<Type>Sha1Thumbprint</Type>"Height": 0
}
<Csp>Default</Csp>
}
</SigningCertificateDescriptor>
}
</PdfSignatureCryptographicData_V1>
], |
DataFields
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | DataFields |
|---|
|
</signaturePluginConfiguration>"DateFields": [
<signaturePluginConfiguration spcId="swissComSigningId">
{
<PdfSignatureProperties_V1>"ElementId": "string",
<PdfAConformant>false</PdfAConformant>"DocumentNumber": 0,
<PAdESPart4Compliant>true</PAdESPart4Compliant>"DateFormat": "string",
"FieldDefinition": {
<IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
<SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>"TextFormat": {
</PdfSignatureProperties_V1>
"TextColor": "string",
<PdfSignatureCryptographicData_V1>
"FontSizeInPt": 0,
<SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
"FontName": "string",
<SigningCertificateDescriptor>
"Bold": true,
<Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
"Italic": true,
<Type>Sha1Thumbprint</Type>
<Csp>Default</Csp>"TextAlign": "Left"
</SigningCertificateDescriptor>},
</PdfSignatureCryptographicData_V1>
"Position": {
</signaturePluginConfiguration>
"PageNumber": 0,
<resourceUris>
<signatureImagesUri>https://demo.xyzmo.com/Resource/SignatureImages/?link=1bc6ZS1MTOv~59DsLiDB/0fnb410yo661GUEpJ~NEDVSuJB1fjy~09vjn6TBfRpOe</signatureImagesUri>
"X": 0,
</resourceUris>
"Y": 0
</workstepConfiguration>
</recipient>},
<recipient>
"Size": {
<id>55cabc5f-8138-46f9-8b7e-3018d8838e2f</id>
<orderIndex>2</orderIndex>"Width": 0,
<firstName>Charly</firstName>
"Height": 0
<lastName>Randomname</lastName>
<eMail>##EMAIL##</eMail>}
<languageCode>en</languageCode> }
<status>NotSigned</status> }
<signedDate></signedDate>]
}, |
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 |
|---|
|
<openedDate></openedDate>"EmailConfiguration": {
"Subject": "string",
"Body": "string",
<recipientType>Cc</recipientType>
"SenderDisplayName": "string"
}, |
Reminder configuration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Reminder configuration |
|---|
|
"ReminderConfiguration": {
<isParallel>false</isParallel>"Enabled": true,
"FirstReminderInDays": 0,
<workstepRedirectionUrl></workstepRedirectionUrl>"ReminderResendIntervalInDays": 0,
"BeforeExpirationInDays": <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
<workstepConfiguration skipThirdPartyChecks="0">
<WorkstepLabel />
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
<WorkstepTimeToLiveInMinutes>43200</WorkstepTimeToLiveInMinutes>
<PictureAnnotationTaskInfo>
<MinResolution>0</MinResolution>
<MaxResolution>0</MaxResolution>
<ColorDepth>Color16M</ColorDepth>
</PictureAnnotationTaskInfo>0
}, |
Expiration configuration 
Image Added
Note: The following information is valid for envelopes as well as for drafts: Settings for the relative time:
- Envelope expiry as relative time, provided in seconds (or milliseconds) after sending the envelope
- Envelope expiry as relative time, in days after sending the envelope
Settings for the absolute time:
- Envelope expiry as absolute time, as timestamp in GMT (with Z in the timestamp text) or optional with defined timezone
Please note the following: Defining no option will lead to usage of the default value of 28 days. Moreover, if you configure an absolute expiry time which is already in the past at time of sending the envelope, an error message will be returned. For the draft, it is required to have both options - store absolute or relative time. For the envelopes, only an absolute timestamp is required to be set and considered while being in progress.
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Expiration configuration |
|---|
|
"ExpirationConfiguration": {
"ExpirationInSeconds": 0,
"ExpirationDate": "string"
} |
Callback configuration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Callback configuration |
|---|
|
"CallbackConfiguration": {
"CallbackUrl": "string",
"StatusUpdateCallbackUrl": "string",
"StepActionCallbackConfiguration": {
"Url": "string",
<Policy version="1.1.0.0">"ActionCallbackSelection": {
"ConfirmTransactionCode": true,
<GeneralPolicies>"DefaultEventType": true,
"AgreementAccepted": true,
<AllowRotatingPages>1</AllowRotatingPages>"AgreementRejected": true,
"RequestPrepareAuthenticationInformationSuccess": true,
<AllowFinishWorkstep>1</AllowFinishWorkstep>"PrepareAuthenticationSuccess": true,
"AuthenticationFailed": true,
<AllowUndoLastAction>1</AllowUndoLastAction>"AuthenticationRejected": true,
"AuthenticationSuccess": true,
</GeneralPolicies>"ReAuthenticationFailed": true,
"AuditTrailRequested": true,
<WorkstepTasks SequenceMode=" NoSequenceEnforcedAuditTrailXmlRequested": />true,
"CalledPage": true,
</Policy>
"WhoIsInformation": true,
"DocumentDownloaded": true,
<timeCreated />
"FlattenedDocumentDownloaded": true,
<TransactionCodeConfigurations />
"AddedAnnotation": true,
"AddedAttachment": true,
<ViewerPreferences />"AppendedDocument": true,
"FormsFilled": true,
</workstepConfiguration>
"ConfirmReading": true,
</recipient>"PageViewChanged": true,
</recipients>"SendTransactionCode": true,
<completedDocuments>"PrepareSignWorkstepDocument": true,
"SignWorkstepDocument": true,
<logDocumentId></logDocumentId>
"UndoAction": true,
<logXmlDocumentId></logXmlDocumentId>
"WorkstepCreated": true,
</completedDocuments>
"WorkstepFinished": true,
</bulkRecipient>
"WorkstepRejected": true,
</bulkRecipients>
<documents>"DisablePolicyAndValidityChecks": true,
<document>"EnablePolicyAndValidityChecks": true,
<fileName>eSignAnyWhere_Tutorial.pdf</fileName>"AppendFileToWorkstep": true,
<docRefNumber>1</docRefNumber>"AppendTasksToWorkstep": true,
<fields />"SetOptionalDocumentState": true,
<pages>"PreparePayloadForBatch": true
}
<page>
}
}, |
Agreement configuration
| Code Block |
|---|
| language | java |
|---|
| theme | Eclipse |
|---|
| title | Agreement configuration |
|---|
|
"AgreementConfiguration": {
"UseOrganizationAgreementSettings": true,
"Translations": [
<width>612</width>
{
<height>792</height>"LanguageCode": "AF",
</page>"Text": "string",
</pages>"Header": "string",
</document>"IsDefault": true
</documents>}
</envelopeStatus>]
</okInfo> |
Download the document(s)
With the following URI you can download the documents: basicURL/envelope/downloadCompletedDocument/{documentId} in REST and DownloadCompletedDocument_v1 in SOAP.
| Info |
|---|
You can only download the documents if the envelope is finished (Status: “Completed”). In the section before (getenvelope) you can see that the envelope has the Status: “In Progress”. After finishing the envelope you should see that the status changed to completed. |
You can download the following documents:
- LogDocument
- LogXmlDocument
- FlowDocument
...
Sending envelope
After you have added all form fields and signatures you can send the envelope to the recipients. Therefor, add the file Id you received from the file/upload call and add the configuration. Then you can send the envelope with the envelope/send call.
