Please also see the next figure for an overview of the envelope structure:

Image RemovedImage Added

For a basic guide of REST and the different API calls please also have a look at our Postman tutorial.

...

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 configuration you can define following settings:

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

...

Info

Please note that with api v6 the general policies are set as default:

Code Block

language	java
theme	Eclipse

"Documents": [{

                AllowAdhocFreeHandAnnotations

"FileId": "c5a229ae-1234-1234-b6e8-d4eb9fd7bcf5"

= false,

"DocumentNumber": 1

        AllowAdhocPdfAttachments = false,

}

],

"Name":

"Test",

"Activities": [{

 AllowAdhocPdfPageAppending = false,

"Action":

{

         AllowAdhocPictureAnnotations = false,

"Sign":

{

              AllowAdhocSignatures = false,

"RecipientConfiguration":

{

               AllowAdhocStampings = false,

"ContactInformation":

{

            AllowAdhocTypewriterAnnotations = false,

"Email":

"janedoe@sample.com",

     AllowEmailDocument = true,
                    AllowPrintDocument

"GivenName": "Jane"

= true,
                    AllowRejectWorkstep = true,

"Surname":

"Doe",

              AllowSaveAuditTrail = true,

"LanguageCode":

"EN"

       AllowSaveDocument = true,

}

     AllowUndoLastAction = false,

},

       AllowRotatingPages = false,

"Elements":

{

        AllowAppendFileToWorkstep = false,

"Signatures":

[{

     AllowAppendTasksToWorkstep = false,
                    AllowColorizePdfForms = false,

"TaskConfiguration":

{

                 AllowReloadOfFinishedWorkstep = true,

"OrderDefinition":

{

  AllowDownloadOfSignedP7MFiles

= true

"OrderIndex":

0

}

};

},

Via UI it is possible to change the following policies (settings can be found in organization settings → Policy for the document viewer for recipients):

Code Block

language	xml
theme	Eclipse

<GeneralPolicies>
  <AllowSaveDocument>1</AllowSaveDocument>
  <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
  <AllowUndoLastAction>1</AllowUndoLastAction>
  <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
</GeneralPolicies>

The configuration is the core of the envelope. Within the configuration you can define following settings:

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 the sample configuration which includes one action (ClickToSign):

Code Block

language	java
theme	Eclipse

{
    "Documents": [{
            "ElementIdFileId": "sample sig clicktosignc5a229ae-1234-1234-b6e8-d4eb9fd7bcf5",
            "DocumentNumber": 1
        }
    ],
    "RequiredName": true"Test",
    "Activities": [{
            "Action": {
                "DocumentNumberSign": {
1,                    "RecipientConfiguration": {
           "DisplayName": "Sign here",           "ContactInformation": {
                    "AllowedSignatureTypes": {       "Email": "janedoe@sample.com",
                            "ClickToSignGivenName": {"Jane",
                            "Surname": "Doe",
      }                      "LanguageCode": "EN"
         },               }
                 "FieldDefinition": {  },
                    "Elements": {
            "Position": {           "Signatures": [{
                            "PageNumber": 1,   "TaskConfiguration": {
                                    "XOrderDefinition": 100,{
                                        "YOrderIndex": 2000
                                    },
                                },
   "Size":  {                           "ElementId": "sample sig clicktosign",
          "Width": 100,                     "Required": true,
                  "Height": 70             "DocumentNumber": 1,
                      }          "DisplayName": "Sign here",
                      }          "AllowedSignatureTypes": {
                 }                   "ClickToSign": {
    ]                     },           }
         "SigningGroup": "firstSigner"                 }     },
       }         }     ] }

The next screenshot shows the document after sending the configuration:

Image Removed

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

language	java
theme	Eclipse

  "Name": "string",   "MetaData": "string",   "AddDocumentTimestampFieldDefinition": {
true,     "ShareWithTeam": true,   "LockFormFieldsOnFinish": 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": [       {         "ElementId": "string",         "DocumentNumberPosition": {
 0,         "Required": true,         "FileName": "string",         "DisplayIconType": "Paperclip",         "FieldDefinitionPageNumber": 1,
{            "Position": {             "PageNumber": 0,             "X": 0100,
            "Y": 0                 },           "SizeY": {200
            "Width": 0,             "Height": 0         },
 }         },         "TaskConfiguration": {           "OrderDefinition": {    "Size": {
       "OrderIndex": 0           }         }       }     ],

Link configuration

Code Block

language	java
theme	Eclipse
title	Link configuration

"LinkConfiguration": {"Width": 100,
       "HyperLinks": [         {           "ElementId": "string",           "UriHeight": "string",70
          "DocumentNumber": 0,           "FieldDefinition": {             "Position":}
{               "PageNumber": 0,               "X": 0, }
              "Y": 0             },
            "Size": {           ]
   "Width": 0,               "Height": 0 },
            }        "SigningGroup": "firstSigner"
 }         }      }
],       "DocumentLinks": [    }
    {    }
    ]
}

The next screenshot shows the document after sending the configuration:

Sent Envelope 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

language	java
theme	Eclipse

  "ElementIdName": "string",
       
  "DocumentNumberMetaData": 0"string",
          "LinkAnchor"AddDocumentTimestamp": {
      true,
     "ElementIdShareWithTeam": "string",
         true,
  "DocumentNumberLockFormFieldsOnFinish": 0,
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": [
      {
    "LinkDefinition": {   "ElementId": "string",
          "PositionDocumentNumber": {0,
        "Required": true,
        "PageNumberFileName": 0"string",
        "DisplayIconType": "Paperclip",
        "XFieldDefinition": 0,{
          "Position": {
            "YPageNumber": 0,
              },
 "X": 0,
            "SizeY": 0
{          },
      "Width": 0,   "Size": {
            "HeightWidth": 0,
            "Height": 0
}             }
          },
          "FieldDefinitionTaskConfiguration": {
            "PositionOrderDefinition": {

             "PageNumberOrderIndex": 0,
          }
    "X": 0,   }
      }
    "Y": 0],

Link configuration

Code Block

language	java
theme	Eclipse
title	Link configuration

"LinkConfiguration": {
      "HyperLinks": [
      },  {
          "SizeElementId": {
   "string",
          "WidthUri": 0,
   "string",
          "HeightDocumentNumber": 0,
            }"FieldDefinition": {
          }  "Position": {
     }       ]
    },

Reading confirmationImage Removed

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": [  "PageNumber": 0,
      {         "ElementIdX": "string"0,
        "Required": true,
        "DocumentNumberY": 0,
        "DisplayName": "string",   },
     "Definition": {
          "PositionSize": {
              "PageNumberWidth": 0,
              "XHeight": 0,
            "Y":}
0           },
          "Size": {}
      ],
      "WidthDocumentLinks": 0,[
        {
   "Height": 0      "ElementId": "string",
   }       "DocumentNumber": 0,
 },         "TaskConfigurationLinkAnchor": {
            "OrderDefinitionElementId": {"string",
            "OrderIndexDocumentNumber": 0,
          }  "LinkDefinition": {
     }       }     ],

Page read confirmation

Code Block

language	java
theme	Eclipse
title	Page read confirmation

"PageReadConfirmations"Position": [{
       {         "ElementIdPageNumber": "string"0,
        "Required        "X": true0,
        "DocumentNumber        "Y": 0,
         "DisplayName": "string",    },
    "PageNumber": 0,         "TaskConfigurationSize": {
                "OrderDefinitionWidth": 0,
   {             "OrderIndexHeight": 0
              }
            }
          },
    ],

Document read confirmation

Code Block

language	java
theme	Eclipse
title	Document read confirmation

 "DocumentConfirmationReadConfirmation      "FieldDefinition": {
            "ElementIdPosition": "string",{
      "Required": true,       "DisplayNamePageNumber": "string"0,
      "TaskConfiguration": {         "OrderDefinitionX": {0,
              "OrderIndexY": 0
            },
      }     }

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": [
    "Size": {
    {           "DocumentNumberWidth": 0,
          "IsHidden": true   "Height": 0
    }       ]

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
- Contact information
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

"RecipientConfiguration": { }
          }
 "ContactInformation": {      }
      ]
 "Email": "string",   },

Reading confirmationImage 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": [
      {
        "GivenNameElementId": "string",
        "Required": true,
     "Surname   "DocumentNumber": 0,
        "DisplayName": "string",
        "Definition": {
          "PhoneNumberPosition": "string",
 {
            "LanguageCodePageNumber": 0,
"AF"            "X": },

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": {0,
            "Y": 0
          },
          "CodeSize": {
  "string"
          "Width": 0,
             },

SMS-OTP

Code Block

language	java
theme	Eclipse
title	SMS-OTP

 "SmsOneTimePassword": {"Height": 0
          }
      "PhoneNumber": "string"  },
        "TaskConfiguration": {
     },

Swedish Bank Id

Code Block

language	java
theme	Eclipse
title	Swedish Bank Id

 "SwedishBankId     "OrderDefinition": {
   
            "PersonalNumberOrderIndex": "string",0
          }
     "AllowAnyPersonalNumber": true   }
      }
    }],

...

Page read confirmation

Code Block

language	java
theme	Eclipse
title	OAuth2Page read confirmation

  "OAuthAuthenticationsPageReadConfirmations": [
      {
         {"ElementId": "string",
        "Required": true,
        "ProviderNameDocumentNumber": "string"0,
        "DisplayName": "string",
        "ValidationsPageNumber": [0,
        "TaskConfiguration": {
          "OrderDefinition": {
            "OrderIndex": 0
        "FieldReferenceId": "string", }
        }
      }
    ],

Document read confirmation

Code Block

language	java
theme	Eclipse
title	Document read confirmation

 "ExpectedValueDocumentConfirmationReadConfirmation": "string"{
      "ElementId": "string",
      "Required": true,
    }  "DisplayName": "string",
      "TaskConfiguration": {
        ]"OrderDefinition": {
          "OrderIndex": 0
     }   }
      }
    ],

...

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	SAMLVisibility option

 "SamlAuthenticationsVisibilityOptions": [
    
           {
                  "ProviderName"DocumentNumber": "string",
  0,
               "ValidationsIsHidden": [true
        }
           {
                      "FieldReferenceId": "string",
                      "ExpectedValue": "string"
                    }
                  ]
                }
              ]

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,
            "IncludedEmailAppLinks": {
              "Android": true,
              "iOS": true,
              "Windows": true
            },
            "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": [
              {
                "ElementId": "string",
                "Required": true,
                "Value": "string",
                "DocumentNumber": 0,
                "Validation": {
                  "Type": "None",
                  "DateValidationConfiguration": {
       ]

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
Document viewing
P7M signing
Signing

Automatic signing

Please see the following sample for an automatic signing action:

Code Block

language	java
theme	Eclipse

{
	"Documents": [
		{
			"FileId": "1234ddc4-1234-1234-1234-3af31c131234",
			"DocumentNumber": 1
		}
	],
	"Name": "Test.pdf",
	"AddDocumentTimestamp": false,
	"ShareWithTeam": true,
	"LockFormFieldsOnFinish": false,
	"Activities": [
		{
			"Action": {
				"SignAutomatic": {
					"ProfileId": "12347562-1234-1234-1234-5a43184d1234",
					"RenderingLanguageCode": "EN",
					"VisibleSignatures": [
						{
							"DocumentNumber": 1,
							"UseExternalTimestampServer": false,
							"FieldDefinition": {
								"Position": {
									"PageNumber": 1,
									"X": 68.0,
									"Y": 631.8
								},
								"Size": {
									"Width": 190.0,
									"Height": 80.0
								}
							}
						}
					]
				}
			},
			"VisibilityOptions": [
				{
					"DocumentNumber": 1,
					"IsHidden": false
				}
			]
		}
	],
	"EmailConfiguration": {
		"Subject": "Please sign the enclosed envelope",
		"Message": "Dear #RecipientFirstName# #RecipientLastName#

#PersonalMessage#

Please sign the envelope #EnvelopeName#

Envelope will expire at #ExpirationDate#"
	},
	"ReminderConfiguration": {
		"Enabled": true,
		"FirstReminderInDays": 5,
		"ReminderResendIntervalInDays": 3,
		"BeforeExpirationInDays": 3
	},
	"ExpirationConfiguration": {
		"ExpirationInSecondsAfterSending": 2419200
	}
}

Document viewing

Please see the following sample for a document viewing action:

Code Block

language	java
theme	Eclipse

{
	"Documents": [
		{
			"FileId": "264addc4-1234-1234-1234-3af31c13b3c2",
			"DocumentNumber": 1
		}
	],
	"Name": "Test.pdf",
	"AddDocumentTimestamp": false,
	"ShareWithTeam": true,
	"LockFormFieldsOnFinish": false,
	"Activities": [
		{
			"Action": {
				"View": {
					"RecipientConfiguration": {
						"ContactInformation": {
							"Email": "john.doe@sample.com",
							"GivenName": "John",
							"Surname": "Doe",
							"LanguageCode": "EN"
						},
						"SendEmails": true,
						"AllowAccessAfterFinish": true
					},
					"ViewingGroup": "1"
				}
			},
			"VisibilityOptions": [
				{
					"DocumentNumber": 1,
					"IsHidden": false
				}
			]
		},
		{
			"Action": {
				"SendCopy": {
					"RecipientConfiguration": {
						"ContactInformation": {
							"Email": "jane.doe@sample.com",
							"GivenName": "Jane",
							"Surname": "Doe",
							"LanguageCode": "EN"
						}
					},
					"CopyingGroup": "2"
				}
			},
			"VisibilityOptions": [
				{
					"DocumentNumber": 1,
					"IsHidden": false
				}
			]
		}
	],
	"EmailConfiguration": {
		"Subject": "Please sign the enclosed envelope",
		"Message": "Dear #RecipientFirstName# #RecipientLastName#

#PersonalMessage#

Please sign the envelope #EnvelopeName#

Envelope will expire at #ExpirationDate#"
	},
	"ReminderConfiguration": {
		"Enabled": true,
		"FirstReminderInDays": 5,
		"ReminderResendIntervalInDays": 3,
		"BeforeExpirationInDays": 3
	},
	"ExpirationConfiguration": {
		"ExpirationInSecondsAfterSending": 2419200
	}
}

P7M signing

Please see the following sample for a P7M signing action (for more information please also see Using P7M (PKCS7) signature type):

Code Block

language	java
theme	Eclipse

{
    "Documents": [
        {
            "FormatFileId": "stringa33f6f7d-1234-1234-1234-42cfbc3cad08",
                    "Range"DocumentNumber": 1
{        }
    ],
    "Name": "test",
    "FromActivities": "string",[
        {
             "ToAction": "string"{
                "SignAsP7M": {
  }                  "RecipientConfiguration": {
     },                   "NumberValidationConfigurationContactInformation": {
                    "DecimalDigits        "Email": 0,"john.doe@sample.com",
                            "SymbolGivenName": "stringJohn",
                    "SymbolLocation        "Surname": "StartDoe",
                            "GroupSeparatorLanguageCode": "CommaEN",
                       "DecimalSeparator": "Comma" },
                        "RangeSendEmails": {true
                      "From": "string",
 },
                    "ToSignatureMethods": "string"{
                    }    "LocalCertificate": false,
             },           "DisposableCertificate": {
      "PhoneValidationConfiguration": {                     "TypeDocumentIssuingCountry": "InternationalAT",
                  },            "IdentificationIssuingCountry": "AT",
      "TimeValidationConfiguration": {                     "FormatIdentificationType": "stringDrivingLicense",
                    "Range": {       "PhoneNumber": "+##PhoneNumber##",
              "From": "string",                       "To"DocumentType": "stringDriverLicense",
                    }        "DocumentIssuedBy": "##Issuer##",
         }                 },    "DocumentIssuedOn": "2023-02-15",
            "FieldDefinition": {                   "ReadOnlyDocumentExpiryDate": true"2023-02-28",
                  "MaxLength": 0,                   "IsMultiline"SerialNumber": true"##SerialNumber##",
                  "IsPassword": true,         "DocumentNumber": "123"
        "IsFileSelect": true,               }
   "IsScrollAllowed": true,                   "IsCombined": true,},
                    "TextFormatSignAsP7MGroup": {"1"
                  }
 "TextColor": "string",          }
        }
 "FontSizeInPt": 0,  ]
}

Signing

Lets have a detailed look into the signing task.

The signing task includes the following information:

Recipient configuration
- Contact information
Personal message (optional)
Authentication
- Access code
- SMS OTP
- Swedish bankId
- OAuth
- SAML
Elements
- same elements available as documented in the section "unassigned elements"
Signature data configuration
Batch configuration

Recipient configuration

Code Block

language	java
theme	Eclipse
title	Recipient configuration

"RecipientConfiguration": {
                "FontNameContactInformation": "string",
    {
               "BoldEmail": true,
  "string",
                 "ItalicGivenName": true,
     "string",
              "TextAlignSurname": "Leftstring",
                  },
   "PhoneNumber": "string",
              "PositionLanguageCode": {"AF"
                    "PageNumber": 0,
                    "X": 0,
  },

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": {
                 "YCode": 0
  "string"
               },

SMS-OTP

Code Block

language	java
theme	Eclipse
title	SMS-OTP

 "SmsOneTimePassword": {
                "SizePhoneNumber": {"string"
                    "Width": 0,
   },

Swedish Bank Id

Code Block

language	java
theme	Eclipse
title	Swedish Bank Id

 "SwedishBankId": {
                "PersonalNumber": "string",
                "HeightAllowAnyPersonalNumber": 0true
              },

OAuth2

Code Block

language	java
theme	Eclipse
title	OAuth2

  "OAuthAuthentications": [
 }               {
 },                 "TaskConfigurationProviderName": {"string",
                  "GroupedOrderDefinitionValidations": [
                    {
                      "GroupIdFieldReferenceId": "string",
                      "OrderIndexExpectedValue": "string"
0                    }
                }  ]
                }
              ],

...

SAML

Code Block

language	java
theme	Eclipse
title	CheckboxSAML

 "CheckBoxesSamlAuthentications": [
                {
                  "ElementIdProviderName": "string",
                  "RequiredEvalPolicyValidations": "None",[
                "DocumentNumber": 0,   {
             "Required": true,        "FieldReferenceId": "string",
       "IsChecked": true,                 "FieldDefinitionExpectedValue": {"string"
                  "ExportValue": "string", }
                 "Position": {]
                }
   "PageNumber": 0,          ]

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,
            "XAllowAccessAfterFinish": 0true,
            "IncludedEmailAppLinks": {
       "Y": 0      "Android": true,
           },   "iOS": true,
              "SizeWindows": {true
            },
       "Width": 0,    "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": [
             "Height": 0 {
                 },
 "ElementId": "string",
                "ReadOnlyRequired": true,
                }"Value": "string",
                "TaskConfigurationDocumentNumber": {0,
                  "GroupedOrderDefinitionValidation": {
 
                  "GroupIdType": "stringNone",
 
                  "OrderIndexDateValidationConfiguration": {
 0                   }
"Format": "string",
               }     "Range": {
        }             ],

Combobox

Code Block

language	java
theme	Eclipse
title	Combobox

 "ComboBoxesFrom": ["string",
              {                 "ElementId"To": "string",
                "DocumentNumber": 0,   }
             "Required": true,                 "Value": "string",},
                  "FieldDefinitionNumberValidationConfiguration": {
                    "TextFormatDecimalDigits": {0,
                    "TextColorSymbol": "string",
                    "FontSizeInPtSymbolLocation": 0"Start",
                    "FontNameGroupSeparator": "stringComma",
                    "BoldDecimalSeparator": true"Comma",
                    "ItalicRange": {
true,                      "TextAlignFrom": "Leftstring",
                  },    "To": "string"
             "Items": [      }
              {    },
                  "ExportValuePhoneValidationConfiguration": "string",
 {
                    "DisplayValueType": "stringInternational"
                  },
 }                 "TimeValidationConfiguration": {
],                    "IsEditableFormat": true"string",
                    "ReadOnlyRange": {
   true,                   "PositionFrom": "string",
 {                     "PageNumberTo": 0,"string"
                    "X": 0,}
                  }
  "Y": 0                   },
                  "SizeFieldDefinition": {
                    "WidthReadOnly": 0true,
                    "HeightMaxLength": 0,
                  }
     "IsMultiline": true,
          },                 "TaskConfiguration"IsPassword": {true,
                  "GroupedOrderDefinitionIsFileSelect": {
 true,
                  "GroupIdIsScrollAllowed": "string"true,
                    "OrderIndexIsCombined": 0true,
                  }"TextFormat": {
               }     "TextColor": "string",
        }             ],

Radio button

Code Block

language	java
theme	Eclipse
title	Radio button

 "RadioButtons": [
         "FontSizeInPt": 0,
    {                 "GroupNameFontName": "string",
                    "DocumentNumberBold": 0true,
                    "IsSelectUnisonItalic": true,
                    "RequiredTextAlign": true,"Left"
                "SelectedItem": "string"  },
                  "FieldDefinitionsPosition": [
                  {
                    "ExportValuePageNumber": "string"0,
                    "IsCheckedX": true0,
                    "CheckBoxAppearanceY": true,0
                    "ReadOnly": true,
},
                   "PositionSize": {
                      "PageNumberWidth": 0,
 
                    "XHeight": 0,
                  }
          "Y": 0     },
               }, "TaskConfiguration": {
                  "SizeGroupedOrderDefinition": {
                      "WidthGroupId": 0"string",
                      "HeightOrderIndex": 0
                  }
 }               }
   }           }
     ],       ],

Checkbox

Code Block

language	java
theme	Eclipse
title	Checkbox

"CheckBoxes": [
          "GroupTaskConfiguration":  {  {
                "GroupedOrderDefinitionElementId": {
"string",
                   "GroupIdRequiredEvalPolicy": "stringNone",
                    "OrderIndex""DocumentNumber": 0,
                "Required": true,
}                 }"IsChecked": true,
              }
            ],

Listbox

Code Block

language	java
theme	Eclipse
title	Listbox

 "ListBoxesFieldDefinition": [
{
             {                 "ElementId"ExportValue": "string",
                  "DocumentNumberPosition": 0, {
                    "RequiredPageNumber": true0,
                    "PreSelectedItemsX": 0,
 [                   "stringY": 0
               ]   },
                  "FieldDefinitionSize": {
                    "TextFormatWidth": {0,
                    "TextColorHeight": "string",0
                    "FontSizeInPt": 0},
                    "FontNameReadOnly": "string",true
                },
   "Bold": true,            "TaskConfiguration": {
       "Italic": true,          "GroupedOrderDefinition": {
         "TextAlign": "Left"          "GroupId": "string",
       },             "OrderIndex": 0
    "Items": [             }
       {         }
             "ExportValue": "string", }
            ],

Combobox

Code Block

language	java
theme	Eclipse
title	Combobox

 "ComboBoxes": [
       "DisplayValue": "string"      {
              }  "ElementId": "string",
               ], "DocumentNumber": 0,
                "IsMultiSelectRequired": true,
                  "ReadOnlyValue": true"string",
                  "PositionFieldDefinition": {
 
                  "PageNumberTextFormat": 0,{
                    "XTextColor": 0"string",
                    "YFontSizeInPt": 0,
                  }  "FontName": "string",
                    "SizeBold": {true,
                    "WidthItalic": 0true,
                    "HeightTextAlign": 0"Left"
                  },
                },  "Items": [
             "TaskConfiguration":        {
                      "GroupedOrderDefinitionExportValue": "string",
{                      "GroupIdDisplayValue": "string",
                    "OrderIndex": 0}
                  ],
  }                 }"IsEditable": true,
              }    "ReadOnly": true,
       ],

Signatures

Code Block

language	java
theme	Eclipse
title	Signature information

"Signatures": [          "Position": {
   {                 "ElementIdPageNumber": "string"0,
                    "RequiredX": true0,
                    "DocumentNumberY": 0
                  },
                  "DisplayNameSize": "string",{
                    "FieldDescriptionWidth": "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": {0,
                    "Height": 0
                  }
           "StampImprintDateConfiguration": {    },
                "UseLocalTimezoneTaskConfiguration": true,
 {
                  "DateTimeFormatGroupedOrderDefinition": "string"{
                     }"GroupId": "string",
                    "UseExternalTimestampServerOrderIndex": true,0
                  "BatchId": "string",}
                }
  "OrderDefinition": {           }
         "OrderIndex": 0  ],

Radio button

Code Block

language	java
theme	Eclipse
title	Radio button

 "RadioButtons": [
              }{
                }

...

"FieldDefinition": {

GroupName": "string",
                "DocumentNumber": 0,

"Position":

{

       "IsSelectUnison": true,
                "

PageNumber

Required":

0

true,

X

SelectedItem":

0,

"string",

Y

FieldDefinitions": [

0

},

Size

ExportValue":

{

"string",
                    "

Width

IsChecked":

0

true,
                    "

Height

CheckBoxAppearance":

0

 true,
                    "ReadOnly": true,

}

},

Info

Code Block

language	java
theme	Eclipse
title	ClickToSign

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

ClickToSign

"ClickToSign""Position": {
                      "UseExternalSignatureImagePageNumber": "Optional"0,
                      "PreferredX": true0,
                      "StampImprintConfigurationY": {0
                      "DisplayExtraInformation": true,
 },
                    "DisplayEmailSize": true,{
                      "DisplayTransactionIdWidth": true0,
                      "DisplayTransactionTokenHeight": 0
true,                    }
   "DisplayPhoneNumber": true,               }
         "UseCustomStampImprint": true,      ],
                "DisplayIpGroupTaskConfiguration": true,
  {
                   "DisplayNameGroupedOrderDefinition": true,{
                      "DisplaySignatureDateGroupId": true"string",
                      "FontNameOrderIndex": "string",0
                  }
   "FontSizeInPt": 0            }
        }      }
            }],

...

Listbox

Code Block

language	java
theme	Eclipse
title	DrawToSignListbox

 "DrawToSignListBoxes": { [
              {
                "UseExternalSignatureImageElementId": "Optionalstring",
   
                "PreferredDocumentNumber": true0,
 
                  "StampImprintConfigurationRequired": {true,
                 "PreSelectedItems": [
   "DisplayExtraInformation": true,              "string"
        "DisplayEmail": true,       ],
                "DisplayTransactionIdFieldDefinition": true,
   {
                  "DisplayTransactionTokenTextFormat": true,
{
                     "DisplayPhoneNumberTextColor": true"string",

                     "UseCustomStampImprintFontSizeInPt": true0,
                      "DisplayIpFontName": true"string",
                      "DisplayNameBold": true,
                      "DisplaySignatureDateItalic": true,
 
                    "FontNameTextAlign": "stringLeft",
                  },
   "FontSizeInPt": 0              "Items": [
     }               {
   },

TypeToSign

Code Block

language	java
theme	Eclipse
title	TypeToSign

 "TypeToSign": {
                    "UseExternalSignatureImageExportValue": "Optionalstring",
                      "PreferredDisplayValue": true,"string"
                    "StampImprintConfiguration":}
{                       "DisplayExtraInformation": true,
  ],
                   "DisplayEmailIsMultiSelect": true,
 
                    "DisplayTransactionIdReadOnly": true,
                  "Position": {
  "DisplayTransactionToken": true,                       "DisplayPhoneNumber"PageNumber": true0,

                     "UseCustomStampImprintX": true0,
                      "DisplayIpY": true,0
                      "DisplayName": true,
   },
                  "DisplaySignatureDateSize": true,{
                      "FontNameWidth": "string"0,

                     "FontSizeInPtHeight": 0
                    }
                  },

LocalCertificate

Code Block

language	java
theme	Eclipse
title	LocalCertificate

"LocalCertificate": {                     "EnforcePreferredHashAlgorithm"TaskConfiguration": true,
{
                   "PreferredHashAlgorithmGroupedOrderDefinition": "Sha256",{
                    "UseExternalSignatureImageGroupId": "Optionalstring",
                    "PreferredOrderIndex": true,0
                  }
 "StampImprintConfiguration": {              }
        "DisplayExtraInformation": true,      }
            ],

Signatures

Code Block

language	java
theme	Eclipse
title	Signature information

"Signatures": [
    "DisplayEmail": true,         {
                "DisplayTransactionIdElementId": true"string",
                      "DisplayTransactionToken"Required": true,
                      "DisplayPhoneNumber"DocumentNumber": true0,
    
                 "UseCustomStampImprintDisplayName": true"string",
                "FieldDescription": "string",
    "DisplayIp": true,
				"AllowedSignatureTypes": {

TaskConfiguration

Before you add the signatures please add the following in the section "Signatures" . [ in order to set the order of the recipients (required), to set the timestamp (optional)

and to set the a batchgroup (optional) Image Added:

Code Block

language	java
theme	Eclipse
title	TaskConfiguration

"TaskConfiguration": {
                     "DisplayNameStampImprintDateConfiguration": true,
 {
                    "DisplaySignatureDateUseLocalTimezone": true,
 
                    "FontNameDateTimeFormat": "string",
                   },
  "FontSizeInPt": 0               "UseExternalTimestampServer": true,
    }                   },

DisposableCertificate

Code Block

language	java
theme	Eclipse
title	DisposableCertificate

"DisposableCertificate": {
"BatchGroup": "string",
                   "IsLongLivedOrderDefinition": false,{
                    "ValidityInSecondsOrderIndex": 0,
                  }
 "UseExternalSignatureImage": "Optional",                     "Preferred": 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": {
                  "

StampImprintConfiguration

Position": {

DisplayExtraInformation

PageNumber":

true

0,

DisplayEmail

X":

true

0,

DisplayTransactionId

Y":

true,

0
                  },

"DisplayTransactionToken":

true,

              "Size": {

"DisplayPhoneNumber

            "Width":

true,

0,
                    "Height": 0
                  }

"UseCustomStampImprint": true,

},

ClickToSign

Code Block

language	java
theme	Eclipse
title	ClickToSign

"ClickToSign": {
                    "UseExternalSignatureImage": "Optional",
                    "DisplayIpPreferred": true,
 
                    "DisplayNameStampImprintConfiguration": true,{
                      "DisplaySignatureDateDisplayExtraInformation": true,
                      "FontNameDisplayEmail": "string"true,
                      "FontSizeInPtDisplayTransactionId": 0 true,
                      "DisplayTransactionToken": true,
    }                  "DisplayPhoneNumber": },

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:

true,
                      "UseCustomStampImprint": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontName": "string",
                      "FontSizeInPt": 0
                    }
                  },

DrawToSign

"DisposableCertificate": {

Code Block

language	java
theme	Eclipse
title	DisposableCertificate (Long-Lived)

DrawToSign

 "DrawToSign": {
                    "UseExternalSignatureImage": "Optional",
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayTransactionId": true,
                      "DisplayTransactionToken": true,
                      "DisplayPhoneNumber": true,
                      "UseCustomStampImprint": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontName": "string",
                      "FontSizeInPt": 0
                    }
                  },

TypeToSign

Code Block

language	java
theme	Eclipse
title	TypeToSign

 "TypeToSign": {
                    "UseExternalSignatureImage": "Optional",
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayTransactionId": true,
                      "DisplayTransactionToken": true,
                      "DisplayPhoneNumber": true,
                      "UseCustomStampImprint": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontName": "string",
                      "FontSizeInPt": 0
                    }
                  },

LocalCertificate

Code Block

language	java
theme	Eclipse
title	LocalCertificate

 "LocalCertificate": {
                    "EnforcePreferredHashAlgorithm": true,
                    "PreferredHashAlgorithm": "Sha256",
                    "UseExternalSignatureImage": "Optional",
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayTransactionId": true,
                      "DisplayTransactionToken": true,
                      "DisplayPhoneNumber": true,
                      "UseCustomStampImprint": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontName": "string",
                      "FontSizeInPt": 0
                    }
                  },

DisposableCertificate

Code Block

language	java
theme	Eclipse
title	DisposableCertificate

"DisposableCertificate": {
                    "IsLongLived": false,
                    "ValidityInSeconds": 0,
                    "UseExternalSignatureImage": "Optional",
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayTransactionId": true,
                      "DisplayTransactionToken": true,
                      "DisplayPhoneNumber": true,
                      "UseCustomStampImprint": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontName": "string",
                      "FontSizeInPt": 0
                    }
                  },

Additionally to the signature type configuration the signature data configuration is needed. Please see the following sample:

Code Block

language	java
theme	Eclipse
title	DisposableCertificate

"SignatureDataConfiguration": {
    "DisposableCertificate": {
        "DocumentIssuingCountry": "AT",
        "IdentificationIssuingCountry": "AT",
        "IdentificationType": "AML",
        "PhoneNumber": "+...",
        "DocumentType": "Passport",
        "DocumentIssuedOn": "2024-09-10",
        "DocumentExpiryDate": "2024-09-24",
        "SerialNumber": "...",
        "DocumentNumber": "..."
    }
},

Referring to the identification type the following values are available:

None
ForeignTaxCode
PersonalNumber
Passport
NationalIdentityCard
ItalianTaxCode
NoSerialNumber
DrivingLicense
ResidencePermit
TemporaryResidencePermit
EmbassyDocument
AML*

*All disposable document data fields

Document Type
Document Number
Document Issued On
Document Issued By
Document Expiry Date and Document Issuing Country

are optional. However, if any one of the document fields is provided, then all of them must be completed, with the exception of Document Issued By, which remains optional in all cases.

Referring to the document type the following values are available:

IdentityCard
DriverLicense
Passport
ResidencePermit
NationalElectronicIdentityCard
TemporaryResidencePermit
EmbassyDocument

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": {
                    "IsLongLived": true,
                    "ValidityInSeconds": 0,
                    "UseExternalSignatureImage": "Optional",
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayTransactionId": true,
                      "DisplayTransactionToken": true,
                      "DisplayPhoneNumber": true,
                      "UseCustomStampImprint": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontName": "string",
                      "FontSizeInPt": 0
                    }
                  },

SwissComOnDemand

Code Block

language	java
theme	Eclipse
title	SwissComOnDemand

"SwissComOnDemand": {
                    "ValidityInSeconds": 0,
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayTransactionId": true,
                      "IsLongLivedDisplayTransactionToken": true,
                      "ValidityInSecondsDisplayPhoneNumber": 0true,
                      "UseExternalSignatureImageUseCustomStampImprint": "Optional"true,
                      "PreferredDisplayIp": true,
                      "StampImprintConfigurationDisplayName": {true,
                      "DisplayExtraInformationDisplaySignatureDate": true,
                      "DisplayEmailFontName": true"string",
                      "DisplayTransactionIdFontSizeInPt": true,
 0
                    }
                  },

ATrustCertificate

Code Block

language	java
theme	Eclipse
title	ATrustCertificate

 "ATrustCertificate": {
                    "DisplayTransactionTokenTemplateId": true"string",
                    "Preferred": true,
"DisplayPhoneNumber                    "StampImprintConfiguration": true,{
                      "UseCustomStampImprintDisplayExtraInformation": true,
                      "DisplayIpDisplayEmail": true,
                      "DisplayNameDisplayTransactionId": true,
                      "DisplaySignatureDateDisplayTransactionToken": true,
                      "FontName": "string"DisplayPhoneNumber": true,
                      "FontSizeInPtUseCustomStampImprint": 0true,
                      "DisplayIp": true,
   }                   },

SwissComOnDemand

Code Block

language	java
theme	Eclipse
title	SwissComOnDemand

"SwissComOnDemand": {"DisplayName": true,
                      "ValidityInSecondsDisplaySignatureDate": 0true,
                      "PreferredFontName": true"string",
                      "StampImprintConfigurationFontSizeInPt": {0
                    }
 "DisplayExtraInformation": true,                       "DisplayEmail": true,},

Biometric

Please note the following available values for the "SignaturePositioning":

Value	Description
intersects with field	The signing must intersect with the field but the signer is allowed to leave the boundaries of the signature field
within field	The signature must be completely within the boundaries of the signature field
on page	The signature can start anywhere on the page, even without intersecting with the signature field

Code Block

language	java
theme	Eclipse
title	Biometric

"Biometric": {
                      "DisplayTransactionIdBiometricVerification": true,
                      "DisplayTransactionTokenAllowBiometricStoringOnly": true,
                      "DisplayPhoneNumberStoreSignedResponseWithoutBioData": true,

                     "UseCustomStampImprintAllowSkipBiometricVerification": true,
 
                    "DisplayIpBiometricServerUserId": true"string",
 
                    "DisplayNameSignaturePositioning": true"WithinField",
                      "DisplaySignatureDatePreferred": true,
 
                    "FontNameStampImprintConfiguration": "string",{
                      "FontSizeInPtDisplayExtraInformation": 0
                    }
                  },

ATrustCertificate

Code Block

language	java
theme	Eclipse
title	ATrustCertificate

 "ATrustCertificate": {true,
                      "TemplateIdDisplayEmail": "string",
                    "Preferred": true,true,
                      "StampImprintConfigurationDisplayTransactionId": {true,
                      "DisplayExtraInformationDisplayTransactionToken": true,
                      "DisplayEmailDisplayPhoneNumber": true,
                      "DisplayTransactionIdUseCustomStampImprint": true,
                      "DisplayTransactionTokenDisplayIp": true,
                      "DisplayPhoneNumberDisplayName": true,
                      "UseCustomStampImprintDisplaySignatureDate": true,
                      "DisplayIpFontName": true"string",
                      "DisplayNameFontSizeInPt": true,0
                    }
 "DisplaySignatureDate": true,                       "FontName": "string",},

RemoteCertificate

Code Block

language	java
theme	Eclipse
title	RemoteCertificate

"RemoteCertificate": {
                      "FontSizeInPtValidityInSeconds": 0,
                    } "UseExternalSignatureImage": "Optional",
                    },

Biometric

Please note the following available values for the "SignaturePositioning":

...

Code Block

language	java
theme	Eclipse
title	Biometric

"Biometric"Preferred": true,
                    "StampImprintConfiguration": {
                      "BiometricVerificationDisplayExtraInformation": true,
                      "AllowBiometricStoringOnlyDisplayEmail": true,
                      "StoreSignedResponseWithoutBioDataDisplayTransactionId": true,
                      "AllowSkipBiometricVerificationDisplayTransactionToken": true,
                      "BiometricServerUserIdDisplayPhoneNumber": true,
         "string",             "UseCustomStampImprint": true,
                      "SignaturePositioningDisplayIp": "WithinField"true,
                      "PreferredDisplayName": true,
                      "StampImprintConfigurationDisplaySignatureDate": {true,
                      "DisplayExtraInformationFontName": true"string",
                      "DisplayEmailFontSizeInPt": true,0
                    }
                   "DisplayTransactionId},

OneTimePassword

Code Block

language	java
theme	Eclipse
title	OneTimePassword

"OneTimePassword": true,{
                      "DisplayTransactionTokenValidityInSeconds": true0,
                      "DisplayPhoneNumberUseExternalSignatureImage": true"Optional",
                      "UseCustomStampImprintPreferred": true,
 
                    "DisplayIpStampImprintConfiguration": true,{
                      "DisplayNameDisplayExtraInformation": true,
                      "DisplaySignatureDateDisplayEmail": true,
                      "FontNameDisplayTransactionId": "string"true,
                      "FontSizeInPtDisplayTransactionToken": 0true,
                    }                   },

RemoteCertificate

Code Block

language	java
theme	Eclipse
title	RemoteCertificate

"RemoteCertificate"DisplayPhoneNumber": {true,
                      "ValidityInSecondsUseCustomStampImprint": 0true,
                      "UseExternalSignatureImageDisplayIp": "Optional"true,
                      "PreferredDisplayName": true,
                      "StampImprintConfigurationDisplaySignatureDate": {true,
                      "DisplayExtraInformationFontName": true"string",
                      "DisplayEmailFontSizeInPt": true,0
                    }
 "DisplayTransactionId": true,                       "DisplayTransactionToken": true,
 },

SwedishBankId

Code Block

language	java
theme	Eclipse
title	SwedishBankId

 "SwedishBankId": {
                    "DisplayPhoneNumberPreferred": true,

                     "UseCustomStampImprintStampImprintConfiguration": true,{
                      "DisplayIpDisplayExtraInformation": true,
                      "DisplayNameDisplayEmail": true,
                      "DisplaySignatureDateDisplayTransactionId": true,
                      "FontNameDisplayTransactionToken": "string"true,
                      "FontSizeInPtDisplayPhoneNumber": 0
                true,
   }                   },

OneTimePassword

Code Block

language	java
theme	Eclipse
title	OneTimePassword

"OneTimePassword": {"UseCustomStampImprint": true,
                      "ValidityInSecondsDisplayIp": 0true,
                      "UseExternalSignatureImageDisplayName": "Optional"true,
                      "PreferredDisplaySignatureDate": true,
                      "StampImprintConfigurationFontName": {"string",
                      "DisplayExtraInformationFontSizeInPt": true,0
                    }
 "DisplayEmail": true,                       "DisplayTransactionId},

SignaturePlugins

Code Block

language	java
theme	Eclipse
title	SignaturePlugins

"SignaturePlugins": true,[
                      "DisplayTransactionToken": true,{
                      "DisplayPhoneNumberPluginId": true"string",
                      "UseCustomStampImprintPreferred": true,
                      "DisplayIp": true,StampImprintConfiguration": {
                        "DisplayNameDisplayExtraInformation": true,
                        "DisplaySignatureDateDisplayEmail": true,
                        "FontNameDisplayTransactionId": "string"true,
                        "FontSizeInPtDisplayTransactionToken": 0true,
                    }               "DisplayPhoneNumber": true,
   },

SwedishBankId

Code Block

language	java
theme	Eclipse
title	SwedishBankId

 "SwedishBankId": {
                    "PreferredUseCustomStampImprint": true,
                        "StampImprintConfigurationDisplayIp": true,
{                        "DisplayExtraInformationDisplayName": true,
                        "DisplayEmailDisplaySignatureDate": true,
                        "DisplayTransactionIdFontName": true"string",
                        "DisplayTransactionTokenFontSizeInPt": true, 0
                      }
   "DisplayPhoneNumber": true,                 }
       "UseCustomStampImprint": true,          ]

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": [
           "DisplayIp": true,    {
                  "DisplayNameElementId": true,
  "string",
                   "DisplaySignatureDateDocumentNumber": true0,
   
                  "FontNameValue": "string",
   
                  "FontSizeInPtFieldDefinition": 0{
                    }"TextFormat": {
                 },

SignaturePlugins

Code Block

language	java
theme	Eclipse
title	SignaturePlugins

"SignaturePlugins": [         "TextColor": "string",
           {                       "PluginId"FontSizeInPt": "string"0,
                      "PreferredFontName": true"string",
                      "StampImprintConfigurationBold": {
true,
                       "DisplayExtraInformationItalic": true,
 
                      "DisplayEmailTextAlign": true,"Left"
                        "DisplayTransactionId": true,
 },
                      "DisplayTransactionTokenPosition": true,
 {
                      "DisplayPhoneNumberPageNumber": true0,
 
                      "UseCustomStampImprintX": true0,

                       "DisplayIpY": true,
   0
                    "DisplayName": true},
                        "DisplaySignatureDateSize": true,{
                        "FontNameWidth": "string"0,
 
                      "FontSizeInPtHeight": 0
                    }
         }         }
            }    }
              ],

Predefined Field Elements

You can also add predefined elements to the document. Please see the following configurations:

Textfields

EmailFields

Code Block

language	java
theme	Eclipse
title	TextfieldsEmailFields

 "TextFieldsEmailFields": [
                {
                  "ElementId": "string",
                  "DocumentNumber": 0,

                 "Value": "string",
                  "FieldDefinition": {
                    "TextFormat": {
                      "TextColor": "string",
                      "FontSizeInPt": 0,
                      "FontName": "string",
                      "Bold": true,
                      "Italic": true,
                      "TextAlign": "Left"
                    },
                    "Position": {
                      "PageNumber": 0,
                      "X": 0,
                      "Y": 0
                    },
                    "Size": {
                      "Width": 0,
                      "Height": 0
                    }
                  }
                }
              ],

...

InitialsFields

Code Block

language	java
theme	Eclipse
title	EmailFieldsInitialsFields

 "EmailFieldsInitialsFields": [
                {
                  "ElementId": "string",
                  "DocumentNumber": 0,
                  "IncludeMiddleNameInitials": true,
                  "FieldDefinition": {
                    "TextFormat": {
                      "TextColor": "string",
                      "FontSizeInPt": 0,
                      "FontName": "string",
                      "Bold": true,
                      "Italic": true,
                      "TextAlign": "Left"
                    },
                    "Position": {
                      "PageNumber": 0,
                      "X": 0,
                      "Y": 0
                    },
                    "Size": {
                      "Width": 0,
                      "Height": 0
                    }
                  }
                }
              ],

...

GivenNameFields

Code Block

language	java
theme	Eclipse
title	InitialsFieldsGivenNameFields

 "InitialsFieldsGivenNameFields": [
                {
                  "ElementId": "string",
                  "DocumentNumber": 0,
                  "IncludeMiddleNameInitialsDocumentNumber": true0,
                  "FieldDefinition": {
                    "TextFormat": {
                      "TextColor": "string",
                      "FontSizeInPt": 0,
                      "FontName": "string",
                      "Bold": true,
                      "Italic": true,
                      "TextAlign": "Left"
                    },
                    "Position": {
                      "PageNumber": 0,
                      "X": 0,
                      "Y": 0
                    },
                    "Size": {
                      "Width": 0,
                      "Height": 0
                    }
                  }
                }
              ],

...

SurnameFields

Code Block

language	java
theme	Eclipse
title	GivenNameFieldsSurnameFields

 "GivenNameFieldsSurnameFields": [
                {
                  "ElementId": "string",
                  "DocumentNumber": 0,
                  "FieldDefinition": {
                    "TextFormat": {
                      "TextColor": "string",
                      "FontSizeInPt": 0,
                      "FontName": "string",
                      "Bold": true,
                      "Italic": true,
                      "TextAlign": "Left"
                    },
                    "Position": {
                      "PageNumber": 0,
                      "X": 0,
                      "Y": 0
                    },
                    "Size": {
                      "Width": 0,
                      "Height": 0
                    }
                  }
                }
              ],

...

FullNameFields

Code Block

language	java
theme	Eclipse
title	SurnameFieldsFullNameFields

"SurnameFieldsFullNameFields": [
                {
                  "ElementId": "string",
                  "DocumentNumber": 0,
                  "FieldDefinition": {
                    "TextFormat": {
                      "TextColor": "string",
                      "FontSizeInPt": 0,
                      "FontName": "string",
                      "Bold": true,
                      "Italic": true,
                      "TextAlign": "Left"
                    },
                    "Position": {
                      "PageNumber": 0,
                      "X": 0,
                      "Y": 0
                    },
                    "Size": {
                      "Width": 0,
                      "Height": 0
                    }
                  }
                }
              ],

...

DataFields

Code Block

language	java
theme	Eclipse
title	FullNameFieldsDataFields

 "FullNameFieldsDateFields": [
                {
                  "ElementId": "string",
                  "DocumentNumber": 0,
                  "FieldDefinitionDateFormat": {
                    "TextFormat": {
"string",
                     "TextColorFieldDefinition": "string",{
                      "FontSizeInPtTextFormat": 0,{
                      "FontNameTextColor": "string",
                      "BoldFontSizeInPt": true0,
                      "ItalicFontName": true,                       "TextAlign": "Left"
                    },
                    "Position": {"string",
                      "PageNumberBold": 0true,
                      "XItalic": 0true,
                      "YTextAlign": 0"Left"
                    },
                    "SizePosition": {
                      "WidthPageNumber": 0,
                      "HeightX": 0,
                    }  "Y":  0
              }         },
       }               ],

DataFields

Code Block

language	java
theme	Eclipse
title	DataFields

 "DateFieldsSize": [{
                {         "Width": 0,
         "ElementId": "string",                   "DocumentNumber"Height": 0,
                  "DateFormat": "string", }
                 "FieldDefinition": {}
                }
   "TextFormat": {          ]
            "TextColor": "string",
                 },

FinishActionConfiguration

Code Block

language	java
theme	Eclipse
title	Finish action configuration

"FinishActionConfiguration": {
    "FontSizeInPt": 0,        "SignAnyWhereViewer": {
              "FontNameRedirectUri": "string",
            },
            "BoldSignificantClientSignatureCaptureForIos": true,{
              "RemoveDocumentFromRecentDocumentList": true,
      "Italic": true,       "CallClientActionOnlyAfterSuccessfulSync": true,
              "TextAlignCloseApp": "Left"true,
              "RedirectUri": "string"
    },        },
            "PositionSignificantClientSignatureCaptureForAndroid": {
                      "PageNumber"RemoveDocumentFromRecentDocumentList": 0,
     true,
                "XCallClientActionOnlyAfterSuccessfulSync": 0true,
 
                    "Y"CloseApp": 0true,
              "RedirectUri": "string"
    },        },
            "SizeSignificantClientSignatureCaptureForWindows": {
              "RemoveDocumentFromRecentDocumentList": true,
      "Width": 0,       "CallClientActionOnlyAfterSuccessfulSync": true,
              "HeightCloseApp": 0true,
              "RedirectUri": "string"
    }        },
          }  "KioskSdk": {
             } "RedirectUri": "string"
            ]}
            },

Additional envelope information

...

Code Block

language	java
theme	Eclipse
title	Callback configuration

 "CallbackConfiguration": {
    "CallbackUrl": "string",
    "StatusUpdateCallbackUrl": "string",
    "StepActionCallbackConfigurationActivityActionCallbackConfiguration": {
      "Url": "string",
      "ActionCallbackSelection": {
        "ConfirmTransactionCode": true,
        "DefaultEventType": true,
        "AgreementAccepted": true,
        "AgreementRejected": true,
        "RequestPrepareAuthenticationInformationSuccess": true,
        "PrepareAuthenticationSuccess": true,
        "AuthenticationFailed": true,
        "AuthenticationRejected": true,
        "AuthenticationSuccess": true,
        "ReAuthenticationFailed": true,
        "AuditTrailRequested": true,
        "AuditTrailXmlRequested": true,
        "CalledPage": true,
        "WhoIsInformation": true,
        "DocumentDownloaded": true,
        "FlattenedDocumentDownloaded": true,
        "AddedAnnotation": true,
        "AddedAttachment": true,
        "AppendedDocument": true,
        "FormsFilled": true,
        "ConfirmReading": true,
        "PageViewChanged": true,
        "SendTransactionCode": true,
        "PrepareSignWorkstepDocument": true,
        "SignWorkstepDocument": true,
        "UndoAction": true,
        "WorkstepCreated": true,
        "WorkstepFinished": true,
        "WorkstepRejected": true,
        "DisablePolicyAndValidityChecks": true,
        "EnablePolicyAndValidityChecks": true,
        "AppendFileToWorkstep": true,
        "AppendTasksToWorkstep": true,
        "SetOptionalDocumentState": true,
        "PreparePayloadForBatch": true
      }
    }
  },

...

Page Comparison

Versions Compared

Old Version 27

New Version Current

Key

Image RemovedImage Added

Configuration

Starting configuration

Starting configuration

Envelope configuration

Unassigned elements

Attachments

Link configuration

Envelope configuration

Unassigned elements

Attachments

Link configuration

Reading confirmationImage Removed

Area read confirmation

Page read confirmation

Document read confirmation

Activities

Action

Recipient configuration

Reading confirmationImage Added

Area read confirmation

Personal message

Authentication

Access code

SMS-OTP

Swedish Bank Id

Page read confirmation

Document read confirmation

Activities

Action

Elements

PDF Forms

Textbox

Automatic signing

Document viewing

P7M signing

Signing

Recipient configuration

Personal message

Authentication

Access code

SMS-OTP

Swedish Bank Id

OAuth2

SAML

Elements

PDF Forms

Textbox

Combobox

Radio button

Checkbox

Listbox

Combobox

Signatures

Radio button

ClickToSign

Listbox

TypeToSign

LocalCertificate

Signatures

TaskConfiguration

DisposableCertificate

ClickToSign

DisposableCertificate (Long-Lived)

DrawToSign

TypeToSign

LocalCertificate

DisposableCertificate

DisposableCertificate (Long-Lived)

SwissComOnDemand

ATrustCertificate

SwissComOnDemand

Biometric

ATrustCertificate

RemoteCertificate