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 next screenshot shows the document after sending the configuration:

Image Removed Sent Envelope Image Added

With this configuration we can now add the settings which are mentioned above. First, lets start with the envelope configuration.

...

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"
Signature data configuration
Batch configuration

...

Signing

Automatic signing

Please see the following sample for an automatic signing action:

Code Block

title

language	java
theme	Eclipse		Recipient configuration

"RecipientConfiguration": {
            "ContactInformation{
	"Documents": {
              "Email[
		{
			"FileId": "string1234ddc4-1234-1234-1234-3af31c131234",
              "GivenName": "string",
              "Surname": "string",
              "PhoneNumber": "string",
              "LanguageCode": "AF"
            },

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"
              },

SMS-OTP

Code Block

language	java
theme	Eclipse
title	SMS-OTP

 "SmsOneTimePassword": {
                "PhoneNumber": "string"
              },

Swedish Bank Id

Code Block

language	java
theme	Eclipse
title	Swedish Bank Id

 "SwedishBankId": {
                "PersonalNumber": "string",
                "AllowAnyPersonalNumber": true
              },

...

			"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
title	OAuth2

  "OAuthAuthentications{
	"Documents": [
                {
                  "ProviderName": "string",
                  "Validations": [
                    {
                      "FieldReferenceId": "string",
                      "ExpectedValue": "string"
                    }
                  ]
                }
              ],

SAML

Code Block

language	java
theme	Eclipse
title	SAML

 "SamlAuthentications": [
                {
                  "ProviderName": "string",
                  "Validations": [
                    {
                      "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

		{
			"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
title	Textbox

{
    "TextBoxesDocuments": [
              {
                "ElementIdFileId": "stringa33f6f7d-1234-1234-1234-42cfbc3cad08",
                "RequiredDocumentNumber": true,1
        }
    ],
    "ValueName": "stringtest",
    "Activities": [
           "DocumentNumber": 0,
 {
               "ValidationAction": {
                  "TypeSignAsP7M": "None",{
                    "DateValidationConfigurationRecipientConfiguration": {
                        "FormatContactInformation": "string",
{
                      "Range      "Email": {
"john.doe@sample.com",
                            "FromGivenName": "stringJohn",
                            "ToSurname": "stringDoe",
                    }
        "LanguageCode": "EN"
         },
               },
   "NumberValidationConfiguration": {
                    "DecimalDigitsSendEmails": 0,true
                    "Symbol": "string"},
                    "SymbolLocationSignatureMethods": "Start",{
                        "GroupSeparatorLocalCertificate": "Comma"false,
                        "DecimalSeparatorDisposableCertificate": "Comma",{
                    "Range": {
                      "From"DocumentIssuingCountry": "stringAT",
                      "To      "IdentificationIssuingCountry": "stringAT",
                    }
        "IdentificationType": "DrivingLicense",
          },
                  "PhoneValidationConfigurationPhoneNumber": {
"+##PhoneNumber##",
                            "TypeDocumentType": "InternationalDriverLicense",
                  },
          "DocumentIssuedBy": "##Issuer##",
       "TimeValidationConfiguration": {
                    "FormatDocumentIssuedOn": "string2023-02-15",
                            "RangeDocumentExpiryDate": {
"2023-02-28",
                            "FromSerialNumber": "string##SerialNumber##",
                            "ToDocumentNumber": "string123"
                        }
                    },
                },    "SignAsP7MGroup": "1"
                "FieldDefinition": {
}
            }
       "ReadOnly": true, }
    ]
}

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": {
             "MaxLengthContactInformation": 0,{
                  "IsMultilineEmail": true"string",
                  "IsPasswordGivenName": true"string",
                  "IsFileSelectSurname": true"string",
                  "IsScrollAllowedPhoneNumber": true"string",
                  "IsCombinedLanguageCode": true,"AF"
            },

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   "TextFormat": {
                    "TextColorCode": "string",
                    "},

SMS-OTP

Code Block

language	java
theme	Eclipse
title	SMS-OTP

 "SmsOneTimePassword": {
FontSizeInPt": 0,
                    "FontNamePhoneNumber": "string",
              },

Swedish Bank Id

Code Block

language	java
theme	Eclipse
title	Swedish Bank Id

 "SwedishBankId": {
     "Bold": true,
                      "Italic"PersonalNumber": true"string",
                    "TextAlignAllowAnyPersonalNumber": "Left"
    true
              },

OAuth2

Code Block

language	java
theme	Eclipse
title	OAuth2

  "OAuthAuthentications": [

                  "Position": {
                    "PageNumberProviderName": 0"string",
                    "XValidations": 0,[
                    "Y": 0{
                  },
                  "Size"FieldReferenceId": {
"string",
                      "WidthExpectedValue": 0,"string"
                    "Height": 0}
                  }]
                },
              ],

SAML

Code Block

language	java
theme	Eclipse
title	SAML

  "TaskConfigurationSamlAuthentications": {[
                  "GroupedOrderDefinition": {
                    "GroupIdProviderName": "string",
                    "OrderIndexValidations": 0[
                  }
                }
  {
            }
            ],

Checkbox

Code Block

language	java
theme	Eclipse
title	Checkbox

"CheckBoxes"FieldReferenceId": ["string",
              {
                "ElementId"ExpectedValue": "string",
                "RequiredEvalPolicy": "None",
                "DocumentNumber": 0,}
                "Required": true,
                "IsChecked": true, ]
                "FieldDefinition": {}
                  "ExportValue": "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,
                  "Position"AllowAccessAfterFinish": {
     true,
               "PageNumberIncludedEmailAppLinks": 0,{
                    "X"Android": 0true,
                    "YiOS": 0
                  }true,
                  "SizeWindows": {true
                    "Width": 0,
      },
              "HeightAllowDelegation": 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": [
 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  },
                  "ValueNumberValidationConfiguration": "string",
{
                    "FieldDefinitionDecimalDigits": {0,
                    "TextFormatSymbol": {"string",
                    "TextColorSymbolLocation": "stringStart",
                    "FontSizeInPtGroupSeparator": 0"Comma",
                    "FontNameDecimalSeparator": "stringComma",
                    "BoldRange": true,{
                      "ItalicFrom": true"string",
                      "TextAlignTo": "Leftstring"
                    },
                  "Items": [},
                  "PhoneValidationConfiguration":  {
                      "ExportValueType": "stringInternational",
                      "DisplayValue": "string"
},
                  "TimeValidationConfiguration": {
   }
                  ]"Format": "string",
                    "IsEditableRange": true,
{
                      "ReadOnlyFrom": true"string",
                  "Position    "To": {"string"
                    "PageNumber": 0,
}
                  }
           "X": 0,
    },
                "YFieldDefinition": 0{
                  "ReadOnly": }true,
                  "SizeMaxLength": {0,
                    "WidthIsMultiline": 0true,
                    "HeightIsPassword": 0true,
                   }
"IsFileSelect": true,
                  "IsScrollAllowed": }true,
                  "TaskConfigurationIsCombined": {true,
                  "GroupedOrderDefinitionTextFormat": {
                    "GroupIdTextColor": "string",
                    "OrderIndexFontSizeInPt": 0,
                  }
  "FontName": "string",
              }
      "Bold": true,
       }
            ],

Radio button

Code Block

language	java
theme	Eclipse
title	Radio button

 "RadioButtonsItalic": [
        true,
      {
                "GroupNameTextAlign": "stringLeft",
                "DocumentNumber": 0  },
                  "IsSelectUnisonPosition": true,{
                    "RequiredPageNumber": true0,
                    "SelectedItemX": "string"0,
                    "FieldDefinitionsY": [0
                  {},
                    "ExportValueSize": "string",{
                    "IsCheckedWidth": true0,
                    "CheckBoxAppearanceHeight": true,0
                  }
           "ReadOnly": true,
    },
                "PositionTaskConfiguration": {
                      "PageNumberGroupedOrderDefinition": 0,{
                      "XGroupId": 0"string",
                      "YOrderIndex": 0
                    },
                }
    "Size": {
         }
            ],

Checkbox

Code Block

language	java
theme	Eclipse
title	Checkbox

"CheckBoxes "Width": 0,[
              {
        "Height": 0
       "ElementId": "string",
            }
      "RequiredEvalPolicy": "None",
            }    "DocumentNumber": 0,
                ]"Required": true,
                "GroupTaskConfigurationIsChecked": {true,
                  "GroupedOrderDefinitionFieldDefinition": {
                    "GroupIdExportValue": "string",
                    "OrderIndexPosition": 0{
                  }
  "PageNumber": 0,
             }
       "X": 0,
      }
             ],

Listbox

Code Block

language	java
theme	Eclipse
title	Listbox

 "ListBoxesY": [0
              {
    },
                  "ElementIdSize": "string",
{
                    "DocumentNumberWidth": 0,
                    "RequiredHeight": true,0
                "PreSelectedItems": [  },
                  "stringReadOnly": true
                ]},
                "FieldDefinitionTaskConfiguration": {
                  "TextFormatGroupedOrderDefinition": {
                    "TextColorGroupId": "string",
                    "FontSizeInPtOrderIndex": 0,
                  }
  "FontName": "string",
              }
        "Bold": true,
     }
            ],

Combobox

Code Block

language	java
theme	Eclipse
title	Combobox

 "ComboBoxes   "Italic": true,[
                    "TextAlign": "Left"{
                  }"ElementId": "string",
                  "ItemsDocumentNumber": [0,
                    {
      "Required": true,
                "ExportValueValue": "string",
                      "DisplayValueFieldDefinition": "string"{
                    }"TextFormat": {
                  ],
                  "IsMultiSelect"TextColor": true"string",
                    "ReadOnlyFontSizeInPt": true0,
                    "PositionFontName": {"string",
                    "PageNumberBold": 0true,
                    "XItalic": 0true,
                    "YTextAlign": 0"Left"
                  },
                  "SizeItems": {[
                    "Width": 0,{
                      "HeightExportValue": 0"string",
                  }
    "DisplayValue": "string"
                    },
                "TaskConfiguration": {  ],
                  "GroupedOrderDefinitionIsEditable": {true,
                    "GroupIdReadOnly": "string"true,
                    "OrderIndexPosition": 0{
                     }"PageNumber": 0,
                }
    "X": 0,
         }
            ],

Signatures

Code Block

language	java
theme	Eclipse
title	Signature information

"Signatures"Y": [0
              {
    },
                  "ElementIdSize": "string",
{
                    "RequiredWidth": true0,
                    "DocumentNumberHeight": 0,
                "DisplayName": "string"  }
                },
                "FieldDescriptionTaskConfiguration": "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": {
{
                   "StampImprintDateConfigurationGroupedOrderDefinition": {
                    "UseLocalTimezoneGroupId": true"string",
                    "DateTimeFormatOrderIndex": "string"0
                  },
                }
  "UseExternalTimestampServer": true,
            }
        "BatchId": "string",
   ],

Radio button

Code Block

language	java
theme	Eclipse
title	Radio button

 "RadioButtons": [
             "OrderDefinition": {
                    "OrderIndexGroupName": 0"string",
                  }"DocumentNumber": 0,
                }

In the "AllowedSignatureTypes" you can place the following available signature types:

"FieldDefinition": {

"IsSelectUnison": true,

Position

Required":

{

true,

PageNumber

SelectedItem":

0

"string",

X

FieldDefinitions":

0,

[
                  {

"Y":

0

}

"ExportValue": "string",
                    "

Size

IsChecked":

{

true,
                    "

Width

CheckBoxAppearance":

0

true,
                    "

Height

ReadOnly":

0

true,

}

  "Position": {

},

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": {
                    "UseExternalSignatureImage"PageNumber": "Optional"0,
                      "PreferredX": true0,
                      "StampImprintConfigurationY": {0
                      "DisplayExtraInformation": true},
                      "DisplayEmailSize": true,{
                      "DisplayTransactionIdWidth": true0,
                      "DisplayTransactionTokenHeight": true,0
                    }
    "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": {[
              {
          "UseExternalSignatureImage      "ElementId": "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,
                      "DisplayTransactionId""ReadOnly": true,
                      "DisplayTransactionTokenPosition": true,{
                      "DisplayPhoneNumberPageNumber": 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": {
                    "EnforcePreferredHashAlgorithmTaskConfiguration": true,{
                    "PreferredHashAlgorithmGroupedOrderDefinition": "Sha256",{
                    "UseExternalSignatureImageGroupId": "Optionalstring",
                    "PreferredOrderIndex": true,0
                    "StampImprintConfiguration": {}
                      "DisplayExtraInformation": true,}
                      "DisplayEmail": true,}
              ],

Signatures

Code Block

language	java
theme	Eclipse
title	Signature information

"Signatures": [
        "DisplayTransactionId": true,
      {
                "DisplayTransactionTokenElementId": true"string",
                      "DisplayPhoneNumberRequired": true,
                "DocumentNumber": 0,
        "UseCustomStampImprint": true,
        "DisplayName": "string",
                "DisplayIpFieldDescription": true"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": {
                   "DisplayNameStampImprintDateConfiguration": true,{
                      "DisplaySignatureDateUseLocalTimezone": true,
                      "FontNameDateTimeFormat": "string"
                  },
                  "UseExternalTimestampServer": true,
                  "BatchId": "string",
     "FontSizeInPt             "OrderDefinition": 0{
                    "OrderIndex": }0
                  },

...

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": {
                    "PageNumber": 0,
                    "X": 0,
                    "Y": 0
                  },
                  "Size": {
                    "Width": 0,
                    "Height": 0
                  }
                },

ClickToSign

Code Block

language	java
theme	Eclipse
title	ClickToSign

"ClickToSign": {
                    "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
                    }
                  },

DrawToSign

Code Block

language	java
theme	Eclipse
title	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
                    }
                  },

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": falsetrue,
                    "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
                    }
                  },

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.

...

},

SwissComOnDemand

Code Block

language	java
theme	Eclipse
title	DisposableCertificate (Long-Lived)	SwissComOnDemand

"SwissComOnDemand": {
                    "ValidityInSeconds": 0,
                    "Preferred": true,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
  "DisposableCertificate": {
                    "IsLongLivedDisplayEmail": true,
                      "ValidityInSecondsDisplayTransactionId": 0true,
                      "UseExternalSignatureImageDisplayTransactionToken": "Optional"true,
                      "PreferredDisplayPhoneNumber": true,
                      "StampImprintConfigurationUseCustomStampImprint": {true,
                      "DisplayExtraInformationDisplayIp": true,
                      "DisplayEmailDisplayName": true,
                      "DisplayTransactionIdDisplaySignatureDate": true,
                      "DisplayTransactionTokenFontName": true"string",
                      "DisplayPhoneNumberFontSizeInPt": true,0
                    }
                  },

ATrustCertificate

Code Block

language	java
theme	Eclipse
title	ATrustCertificate

 "ATrustCertificate "UseCustomStampImprint": true,{
                    "TemplateId": "string",
  "DisplayIp                  "Preferred": true,
                      "DisplayNameStampImprintConfiguration": true,{
                      "DisplaySignatureDateDisplayExtraInformation": true,
                      "FontNameDisplayEmail": "string"true,
                      "FontSizeInPtDisplayTransactionId": 0true,
                    }  "DisplayTransactionToken": true,
                  },

SwissComOnDemand

Code Block

language	java
theme	Eclipse
title	SwissComOnDemand

"SwissComOnDemand     "DisplayPhoneNumber": {true,
                      "ValidityInSecondsUseCustomStampImprint": 0true,
                      "PreferredDisplayIp": true,
                      "StampImprintConfigurationDisplayName": {true,
                      "DisplayExtraInformationDisplaySignatureDate": true,
                      "DisplayEmailFontName": true"string",
                      "DisplayTransactionIdFontSizeInPt": true,0
                    }
                  },

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": {
"DisplayTransactionToken": true,
                      "DisplayPhoneNumberBiometricVerification": true,
                      "UseCustomStampImprintAllowBiometricStoringOnly": true,
                      "DisplayIpStoreSignedResponseWithoutBioData": true,
                      "DisplayNameAllowSkipBiometricVerification": true,
                      "DisplaySignatureDateBiometricServerUserId": true"string",
                      "FontNameSignaturePositioning": "stringWithinField",
                      "FontSizeInPtPreferred": 0
     true,
               }
                  },

ATrustCertificate

Code Block

language	java
theme	Eclipse
title	ATrustCertificate

 "ATrustCertificate"StampImprintConfiguration": {
                      "TemplateIdDisplayExtraInformation": "string"true,
                      "PreferredDisplayEmail": true,
                      "StampImprintConfigurationDisplayTransactionId": {true,
                      "DisplayExtraInformationDisplayTransactionToken": true,
                      "DisplayEmailDisplayPhoneNumber": true,
                      "DisplayTransactionIdUseCustomStampImprint": true,
                      "DisplayTransactionTokenDisplayIp": true,
                      "DisplayPhoneNumberDisplayName": true,
                      "UseCustomStampImprintDisplaySignatureDate": true,
                      "DisplayIpFontName": true"string",
                      "DisplayNameFontSizeInPt": true,0
                      "DisplaySignatureDate": true,}
                  },

RemoteCertificate

Code Block

language	java
theme	Eclipse
title	RemoteCertificate

"RemoteCertificate    "FontName": "string",
  {
                    "FontSizeInPtValidityInSeconds": 0,
                    }
                  },

Biometric

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

...

Code Block

language	java
theme	Eclipse
title	Biometric

"Biometric": {"UseExternalSignatureImage": "Optional",
                    "BiometricVerificationPreferred": true,
                    "AllowBiometricStoringOnlyStampImprintConfiguration": true,{
                      "StoreSignedResponseWithoutBioDataDisplayExtraInformation": true,
                      "AllowSkipBiometricVerificationDisplayEmail": true,
                      "BiometricServerUserIdDisplayTransactionId": "string"true,
                      "SignaturePositioningDisplayTransactionToken": "WithinField",
true,
                      "PreferredDisplayPhoneNumber": true,
                      "StampImprintConfigurationUseCustomStampImprint": {true,
                      "DisplayExtraInformationDisplayIp": true,
                      "DisplayEmailDisplayName": true,
                      "DisplayTransactionIdDisplaySignatureDate": true,
                      "DisplayTransactionTokenFontName": true"string",
                      "DisplayPhoneNumberFontSizeInPt": true,
0
                    }
                  },

OneTimePassword

Code Block

language	java
theme	Eclipse
title	OneTimePassword

"OneTimePassword"UseCustomStampImprint": true,{
                      "DisplayIpValidityInSeconds": true0,
                      "DisplayNameUseExternalSignatureImage": true"Optional",
                      "DisplaySignatureDatePreferred": true,
                      "FontNameStampImprintConfiguration": "string",{
                      "FontSizeInPtDisplayExtraInformation": 0true,
                    }
  "DisplayEmail": true,
                     },

RemoteCertificate

Code Block

language	java
theme	Eclipse
title	RemoteCertificate

"RemoteCertificate "DisplayTransactionId": {true,
                      "ValidityInSecondsDisplayTransactionToken": 0true,
                      "UseExternalSignatureImageDisplayPhoneNumber": "Optional"true,
                      "PreferredUseCustomStampImprint": true,
                      "StampImprintConfigurationDisplayIp": {true,
                      "DisplayExtraInformationDisplayName": true,
                      "DisplayEmailDisplaySignatureDate": true,
                      "DisplayTransactionIdFontName": true"string",
                      "DisplayTransactionTokenFontSizeInPt": true,0
                      "DisplayPhoneNumber": true,}
                  },

SwedishBankId

Code Block

language	java
theme	Eclipse
title	SwedishBankId

 "SwedishBankId    "UseCustomStampImprint": true,{
                      "DisplayIpPreferred": true,
                      "DisplayNameStampImprintConfiguration": true,{
                      "DisplaySignatureDateDisplayExtraInformation": true,
                      "FontNameDisplayEmail": "string"true,
                      "FontSizeInPtDisplayTransactionId": 0true,
                      } "DisplayTransactionToken": true,
                  },

OneTimePassword

Code Block

language	java
theme	Eclipse
title	OneTimePassword

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

SignaturePlugins

Code Block

language	java
theme	Eclipse
title	SignaturePlugins

"SignaturePlugins"DisplayTransactionToken": true,[
                      "DisplayPhoneNumber": true,{
                      "UseCustomStampImprintPluginId": true"string",
                      "DisplayIpPreferred": true,
                      "DisplayNameStampImprintConfiguration": true,{
                        "DisplaySignatureDateDisplayExtraInformation": true,
                        "FontNameDisplayEmail": "string"true,
                        "FontSizeInPtDisplayTransactionId": 0true,
                    }
            "DisplayTransactionToken": true,
      },

SwedishBankId

Code Block

language	java
theme	Eclipse
title	SwedishBankId

 "SwedishBankId": {
                    "PreferredDisplayPhoneNumber": true,
                        "StampImprintConfigurationUseCustomStampImprint": {true,
                        "DisplayExtraInformationDisplayIp": true,
                        "DisplayEmailDisplayName": true,
                        "DisplayTransactionIdDisplaySignatureDate": true,
                        "DisplayTransactionTokenFontName": true"string",
                        "DisplayPhoneNumberFontSizeInPt": true,0
                      "UseCustomStampImprint": true,
       }
               "DisplayIp": true,
    }
                  "DisplayName]

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": true,[
                      "DisplaySignatureDate": true,
 {
                     "FontNameElementId": "string",
                      "FontSizeInPtDocumentNumber": 0,
                    }"Value": "string",
                  },

SignaturePlugins

Code Block

language	java
theme	Eclipse
title	SignaturePlugins

"SignaturePlugins"FieldDefinition": [{
                    "TextFormat": {
                      "PluginIdTextColor": "string",
                      "PreferredFontSizeInPt": true0,
                      "StampImprintConfigurationFontName": {"string",
                        "DisplayExtraInformationBold": true,
                        "DisplayEmailItalic": true,
                      "TextAlign":  "DisplayTransactionId": true,
Left"
                    },
                    "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",
                  "ElementIdDocumentNumber": "string"0,
                  "DocumentNumberIncludeMiddleNameInitials": 0true,
                  "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,
                  "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
                    }
                  }
                }
              ],

...

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
                    }
                  }
                }
              ],

FullNameFields

Code Block

language	java
theme	Eclipse
title	FullNameFields

"FullNameFields": [0
                {
    }
              "ElementId": "string",
   }
               "DocumentNumber": 0, }
              ],

DataFields

Code Block

language	java
theme	Eclipse
title	DataFields

 "DateFields    "FieldDefinition": {[
                    "TextFormat": {
                      "TextColorElementId": "string",
                      "FontSizeInPtDocumentNumber": 0,
                      "FontNameDateFormat": "string",
                      "BoldFieldDefinition": true,{
                      "ItalicTextFormat": true,{
                      "TextAlignTextColor": "Leftstring",
                    }  "FontSizeInPt": 0,
                      "PositionFontName": {"string",
                      "PageNumberBold": 0true,
                      "XItalic": 0true,
                      "YTextAlign": 0"Left"
                    },
                    "SizePosition": {
                      "Width": 0,
                      "HeightPageNumber": 0,
                    }
  "X": 0,
               }
       "Y": 0
         }
           },
   ],

DataFields

Code Block

language	java
theme	Eclipse
title	DataFields

 "DateFields": [
               "Size": {
                      "ElementIdWidth": "string"0,
                      "DocumentNumberHeight": 0,
                   "DateFormat": "string", }
                  "FieldDefinition": {}
                }
    "TextFormat": {
         ]
            },

FinishActionConfiguration

Code Block

language	java
theme	Eclipse
title	Finish action configuration

"FinishActionConfiguration "TextColor": "string",{
            "SignAnyWhereViewer": {
              "FontSizeInPtRedirectUri": 0,"string"
            },
            "FontNameSignificantClientSignatureCaptureForIos": "string",
        {
              "BoldRemoveDocumentFromRecentDocumentList": true,
                      "Italic"CallClientActionOnlyAfterSuccessfulSync": true,
                      "TextAlignCloseApp": "Left"true,
              "RedirectUri": "string"
     },
       },
             "PositionSignificantClientSignatureCaptureForAndroid": {
                      "PageNumber"RemoveDocumentFromRecentDocumentList": 0true,
                      "X"CallClientActionOnlyAfterSuccessfulSync": 0true,
                      "YCloseApp": 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 tree

Page History

Versions Compared

Old Version 29

New Version Current

Key

Image RemovedImage Added

Automatic signing

Personal message

Authentication

Access code

SMS-OTP

Swedish Bank Id

Document viewing

SAML

Elements

PDF Forms

Textbox

P7M signing

Signing

Recipient configuration

Personal message

Authentication

Access code

SMS-OTP

Swedish Bank Id

OAuth2

SAML

Checkbox

Elements

PDF Forms

Textbox

Combobox

Radio button

Checkbox

Listbox

Combobox

Signatures

Radio button

ClickToSign

Listbox

TypeToSign

LocalCertificate

Signatures

ClickToSign

DrawToSign

TypeToSign

LocalCertificate

DisposableCertificate

DisposableCertificate (Long-Lived)

DisposableCertificate (Long-Lived)

SwissComOnDemand

ATrustCertificate

SwissComOnDemand

Biometric

ATrustCertificate

RemoteCertificate

Biometric

OneTimePassword

RemoteCertificate

SwedishBankId

OneTimePassword

SignaturePlugins

SwedishBankId

Predefined Field Elements

Textfields

SignaturePlugins

Predefined Field Elements

Textfields

EmailFields

InitialsFields

GivenNameFields

SurnameFields

FullNameFields

FullNameFields

DataFields

DataFields

FinishActionConfiguration

Additional envelope information