...
Table of Contents | ||||
---|---|---|---|---|
|
Upload a file
First, you will need a PDF document which you want to upload.
...
For this call you need an authentication. For authentication, you’ll need an api token. You can find this information in Settings / Api Tokens and Apps. Note that all API methods require authentication. For more information about the authorization please have a look the API Reference Guide for SOAP or the Postman Guide for REST
Expand | ||
---|---|---|
| ||
After the authorization you need to BASE64 the PDF which you want to upload. If the call was successful you get a file Id which we will need for sending an envelope. |
...
Info | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Defining a MetaDataXML sets the value only if AdditionalClientWorkstepInformation is not already set via api. For example:
|
Expiration date
Note: The following information is valid for envelopes as well as for drafts: Settings for the relative time:
...
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
After adding the signature fields in the signature template you have to add these signatures in the workstep task section. Following lines of code shows an example configuration of a workstep task.
The Id in the code within the workstep Id must be the same as the Id of the signature field |
Disposable certificate
...
Info | ||
---|---|---|
| ||
Requires an update regarding (minor) changes in the API - difference between traditional and lean disposable |
...
title | Additional Scenario |
---|
...
SMS-OTP
Code Block | ||||
---|---|---|---|---|
| ||||
{ "SspFileIdsWorkstepTasks": [{ "##FILE_ID##" ], "SendEnvelopeDescription": { "NamePictureAnnotationMinResolution": "test"0, "EmailSubject": "Please sign the enclosed envelope", "EmailBodyPictureAnnotationMaxResolution": "Dear0, #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#", "DisplayedEmailSenderPictureAnnotationColorDepth": "Color16M", "EnableReminders": true, "FirstReminderDayAmountSequenceMode": 5"NoSequenceEnforced", "RecurrentReminderDayAmount": 3, "BeforeExpirationDayAmount": 3, "DaysUntilExpire": 28, "CallbackUrlPositionUnits": "PdfUnits", "StatusUpdateCallbackUrl "ReferenceCorner": "Lower_Left", "LockFormFieldsAtEnvelopeFinish": true, "StepsTasks": [ { "OrderIndex": 1, "RecipientsTexts": [ { "Email": "##EMAIL##",{ "FirstName": "##NAME##", "LastNameLanguage": "##NAME##en", "LanguageCode": "en", "EmailBodyExtraValue": "Signature Disclosure Text", "DisableEmail": false, }, "AddAndroidAppLink": false, "AddIosAppLink": false, { "AddWindowsAppLink": false, "AllowDelegationLanguage": false"*", "AllowAccessFinishedWorkstep": false, "SkipExternalDataValidationValue": false,"Signature Disclosure Text" "AuthenticationMethods": [], } "DisposableCertificateData": { "CountryResidence": "AT"], "IdentificationCountryHeadings": "AT",[ "IdentificationType": "PASSPORT", { "PhoneMobile": "##PHONENUMBER##", "DocumentTypeLanguage": "PASSen", "DocumentIssuedByValue": "NamirialSignature Disclosure Subject", "DocumentIssuedOn": "2020-07-07T00:00:00Z" }, "DocumentExpiryDate": "2020-07-29T00:00:00Z", { "SerialNumber": "1234", "DocumentNumberLanguage": "123*", "OverrideHolderInCaseOfMismatch": false "Value": "Signature Disclosure } Subject" } ], "EmailBodyExtra": "", "RecipientTypeIsRequired": "Signer"false, "WorkstepConfiguration": { "WorkstepLabelId": "testra", "SmallTextZoomFactorPercent": 100, "FinishActionDisplayName": {"ra", "ServerActions "DocRefNumber": []1, "ClientActionsDiscriminatorType": ["Agreements" { }, "RemoveDocumentFromRecentDocumentList": false, { "CallClientActionOnlyAfterSuccessfulSyncPositionPage": true1, "ClientNamePosition": { "SIGNificant SignAnywhere", "CloseAppPositionX": false52.0, "ActionPositionY": "https://www.esignanywhere.net/"586.0 } ]}, }, "ReceiverInformationSize": { "UserInformation": { "FirstNameHeight": "##NAME##"80.0, "LastName": "##NAME##", "Width": 190.0 "EMail": "##EMAIL##" }, "HolderInformation": "<recognitionType>PASS</recognitionType><documentIssuedOn>07/07/2020</documentIssuedOn><documentExpiryDate>29/07/2020</documentExpiryDate><documentIssuedBy>Namirial</documentIssuedBy><documentNumber>123</documentNumber><countryResidence>AT</countryResidence><firstName>##NAME##</firstName><lastName>##NAME##</lastName><email>##EMAIL##</email><phoneMobile>##PHONENUMBER##</phoneMobile><identificationType>PASSPORT</identificationType><identificationCountry>AT</identificationCountry><passport>1234</passport>", "TransactionCodePushPluginDataAdditionalParameters": [] }, "SenderInformation": { "UserInformation": { "FirstNameKey": "##NAME##enabled", "LastName": "##NAME##", "EMailValue": "##EMAIL##1" } }, "TransactionCodeConfigurations": [ { "IdKey": "smsAuthTransactionCodeIdcompleted", "HashAlgorithmIdentifier "Value": "Sha2560", "Texts": [ }, { { } ] "Key": "req", } ], "SignatureConfigurationsValue": [],"1" "ViewerPreferences": { }, "FinishWorkstepOnOpen": false, "VisibleAreaOptions": { "AllowedDomain "Key": "*isPhoneNumberRequired", "EnabledValue": false"0" } }, "ResourceUris": {}, "AuditingToolsConfiguration": { "WriteAuditTrail": false, "NotificationConfigurationKey": {} "trValidityInSeconds", }, "PolicyValue": {"60" "GeneralPolicies": { "AllowSaveDocument": true}, "AllowSaveAuditTrail": true, { "AllowRotatingPages": false, "AllowEmailDocumentKey": true"fd", "AllowPrintDocument": true, "Value": "" "AllowFinishWorkstep": true, "AllowRejectWorkstep": true}, "AllowRejectWorkstepDelegation": false, { "AllowUndoLastAction": true, "AllowAdhocPdfAttachmentsKey": false"fd_dateformat", "AllowAdhocSignatures": false, "Value": "dd-MM-yyyy HH:mm:ss" "AllowAdhocStampings": false, "AllowAdhocFreeHandAnnotations": false}, "AllowAdhocTypewriterAnnotations": false, { "AllowAdhocPictureAnnotations": false, "AllowAdhocPdfPageAppendingKey": false"fd_timezone", }, "WorkstepTasksValue": {"datetimeutc" "PictureAnnotationMinResolution": 0, } "PictureAnnotationMaxResolution": 0, ], "PictureAnnotationColorDepth": "Color16M", "SequenceModeAllowedSignatureTypes": "NoSequenceEnforced",[ "PositionUnits": "PdfUnits", { "ReferenceCornerTrModType": "Lower_LeftTransactionCodeSenderPlugin", "Tasks": [ "TrValidityInSeconds": 300, { "PositionPageTrConfId": 1"otpSignatureSmsText", "PositionIsPhoneNumberRequired": {false, "PositionXLy": 89.0"simpleTransactionCodeSms", "PositionYId": 575.0 "c787919a-b2fd-4849-8f97-98dee281da30", } "DiscriminatorType": "SigTypeTransactionCode", "SizePreferred": {false, "HeightStampImprintConfiguration": 80.0,{ "WidthDisplayExtraInformation": 190.0true, }, "DisplayEmail": true, "AdditionalParameters": [ "DisplayIp": true, { "KeyDisplayName": "enabled"true, "ValueDisplaySignatureDate": "1" true, "FontFamily": "Times New }Roman", { "FontSize": 11.0, "KeyOverrideLegacyStampImprint": "positioning"false, "ValueDisplayTransactionId": "onPage"true, } "DisplayTransaktionToken": true, { "DisplayPhoneNumber": true "Key": "req"}, "ValueSignaturePluginConfigurationId": "1ltaLevelId" }, { ], "KeyUseTimestamp": "fd"false, "ValueIsRequired": ""true, }"Id": "1#XyzmoDuplicateIdSeperator#Signature_e7ca3f6a-33fa-cdba-d696-1377fcad51c9", {"DisplayName": "", "KeyDocRefNumber": "fd_dateformat"1, "ValueDiscriminatorType": "dd-MM-yyyy HH:mm:ssSignature" }, ] }, |
Please also see a complete configuration below. Note that the phone number for the otp is in the recipient section!
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Name": "Test.pdf", "EmailSubject": "Please sign the enclosed envelope", "EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#", "KeyDisplayedEmailSender": "fd_timezone", "EnableReminders": true, "FirstReminderDayAmount": 5, "RecurrentReminderDayAmount": 3, "BeforeExpirationDayAmount": 3, "ExpirationInSecondsAfterSending": 2419200, "CallbackUrl": "", "ValueStatusUpdateCallbackUrl": "datetimeutc", "LockFormFieldsAtEnvelopeFinish": false, "Steps": [ { }"OrderIndex": 1, "Recipients": [ { "Email": "##email##", "KeyFirstName": "spcId##name##", "LastName": "##name##", "ValueLanguageCode": "padesSigningIden", "EmailBodyExtra": "", } "DisableEmail": false, ]"AddAndroidAppLink": false, "AddIosAppLink": false, "AllowedSignatureTypes": [ "AddWindowsAppLink": false, { "AllowDelegation": true, "AllowAccessFinishedWorkstep": false, "TrModTypeSkipExternalDataValidation": "RemoteSignatureDisposableCertificate"false, "AuthenticationMethods": [], "TrValidityInSecondsIdentificationMethods": 300[], "OtpData": { "LyPhoneMobile": "remoteCertificate##phonenumber##", } "TrConfIdIssueCertificate": "disposableCertificateEnrolAndSignSmsText",} ], "EmailBodyExtra": "", "TrConfIdRecipientType": "remoteCertificateSignSmsTextSigner", "WorkstepConfiguration": { "IsPhoneNumberRequiredWorkstepLabel": false"Test.pdf", "Id"SmallTextZoomFactorPercent": "180c4201-4146-4161-baf8-cb5a607eec62"100, "FinishAction": { "DiscriminatorTypeServerActions": "SigTypeTransactionCode"[], "PreferredClientActions": false,[] }, "StampImprintConfigurationReceiverInformation": { "UserInformation": { "DisplayExtraInformationFirstName": true"##name##", "LastName": "##name##", "DisplayEmailEMail": true,"##email##" }, "DisplayIpTransactionCodePushPluginData": true,[] }, "DisplayNameSenderInformation": true,{ "UserInformation": { "DisplaySignatureDateFirstName": true"##name##", "FontFamily"LastName": "Times New Roman##name##", "FontSizeEMail": 11.0"##email##" } }, "TransactionCodeConfigurations": [], }"SignatureConfigurations": [], ],"ViewerPreferences": { "UseTimestamp"FinishWorkstepOnOpen": false, "IsRequiredVisibleAreaOptions": true,{ "IdAllowedDomain": "1#XyzmoDuplicateIdSeperator#Signature_b58c192b-47c0-5339-cb18-4fe77c3d1812", "DisplayNameEnabled": "",false } "DocRefNumber": 1 }, "ResourceUris": { "DiscriminatorTypeDelegationUri": "Signature" }, "AuditingToolsConfiguration": { ] }"WriteAuditTrail": true }, "NavigationPolicy": { "HyperLinksGeneralPolicies": [],{ "LinksAllowSaveDocument": []true, "LinkTargetsAllowSaveAuditTrail": []true, } }"AllowRotatingPages": false, "DocumentOptionsAllowAppendFileToWorkstep": [false, { "AllowAppendTaskToWorkstep": false, "DocumentReferenceAllowEmailDocument": "1"true, "IsHiddenAllowPrintDocument": falsetrue, } "AllowFinishWorkstep": true, ], "UseDefaultAgreementsAllowRejectWorkstep": true, }, { "OrderIndexAllowRejectWorkstepDelegation": 2true, "Recipients": [ "AllowUndoLastAction": true, { "EmailAllowColorizePdfForms": "##EMAIL##"false, "FirstNameAllowAdhocPdfAttachments": "##NAME##"false, "LastNameAllowAdhocSignatures": "##NAME##"false, "LanguageCodeAllowAdhocStampings": "en"false, "EmailBodyExtraAllowAdhocFreeHandAnnotations": ""false, "DisableEmailAllowAdhocTypewriterAnnotations": false, "AddAndroidAppLinkAllowAdhocPictureAnnotations": false, "AddIosAppLinkAllowAdhocPdfPageAppending": false, "AddWindowsAppLinkAllowReloadOfFinishedWorkstep": false true }, "AllowDelegationWorkstepTasks": false,{ "SkipExternalDataValidationPictureAnnotationMinResolution": false0, "AuthenticationMethodsPictureAnnotationMaxResolution": []0, } "PictureAnnotationColorDepth": "Color16M", ], "EmailBodyExtraSequenceMode": "NoSequenceEnforced", "RecipientTypePositionUnits": "CcPdfUnits", "DocumentOptionsReferenceCorner": []"Lower_Left", "UseDefaultAgreements "Tasks": false[ } ], "AddFormFields": { "Forms": {} }, "OverrideFormFieldValues": { "Forms": {} }, "AttachSignedDocumentsToEnvelopeLogTexts": false } } | ||||
Expand | ||||
| ||||
Code Block | | |||
|
P7M Signers
Info |
---|
It is possible to define P7M signers in eSignAnyWhere (version 3.1+). This allows you to define at the end of a signing workflow to define signers with P7M. Due technical reasons it is not possible to add non-P7M signers after the first P7M signer. P7M is an advanced feature and must be enabled for you, so please contact your Namirial Sales |
The P7M signer can be defined in the recipient list (P7M Signer Type). The P7M signer has no assigned signature fields in the document, so you will not be able to assign signature fields, form fields or predefined fields for him or her.
When a workflow with a P7M signer is finished you will not receive a PDF document, but a signed P7M container with the PDF. Please see the next figure:
The workstepconfig must be extended with a invisibleSignature, Task and a document information:
Code Block | ||||
---|---|---|---|---|
| ||||
<signatureTemplate>
<InvisibleSig>
<id>pkcs1</id>
<TargetDocument>
<DocRefNumber>1</DocRefNumber>
<completed>0</completed>
</TargetDocument>
<TargetDocument>
<DocRefNumber>2</DocRefNumber>
<completed>0</completed>
</TargetDocument>
<TargetDocument>
<DocRefNumber>3</DocRefNumber>
<completed>0</completed>
</TargetDocument>
</InvisibleSig>
</signatureTemplate> |
Taskdefinition:
Code Block | ||||
---|---|---|---|---|
| ||||
<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks">
<Task enabled="1" completed="0" required="0" id="pkcs1" displayName="" DocRefNumber="1" type="SignPkcs7" finishPercentage="0" />
</WorkstepTasks>
EnvelopeDocumentInforamtion
<WorkStepInformation>
...
<EnvelopeInformation>
<EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="1" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
<EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="2" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
<EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="3" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
</EnvelopeInformation>
...
</WorkStepInformation> |
Automatic Remote Signature Recipient via API
"Navigation": {
"HyperLinks": [],
"Links": [],
"LinkTargets": []
}
},
"DocumentOptions": [
{
"DocumentReference": "1",
"IsHidden": false
}
],
"UseDefaultAgreements": true
},
{
"OrderIndex": 2,
"Recipients": [
{
"Email": "##email##",
"FirstName": "##name##",
"LastName": "##name##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": [],
"IdentificationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Cc",
"DocumentOptions": [],
"UseDefaultAgreements": false
}
],
"AddFormFields": {
"Forms": {}
},
"OverrideFormFieldValues": {
"Forms": {}
},
"AttachSignedDocumentsToEnvelopeLog": false
} |
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Disposable certificate
The disposable certificate signature is a signature variant using the Namirial Trust Service Provider services to issue a (typically qualified) electronic signing certificate on the fly during signing, on explicit request of the signer.
The implementation distinguishes between "traditional" (depracated) and "lean" (recommended) disposable certificate procedure based on the configuration in Settings - Organization.
Registration as Local Registration Authority (LRA) at Namirial is mandatory to perform the necessary identification steps in order to issue disposable certificates. The LRA ID, service password and service username need to be configured in Settings - Organization.
To issue a disposable certificate, the (future) certificate holder must be identified according to the regulations of the LRA contract upfront. The LRA Contract may contain clauses about how consent for issuing a certificate has to be requested, or delivered to the signer.
Please see the following sample configuration for a disposable certificate signature:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"SspFileIds": [
"##FILE_ID##"
],
"SendEnvelopeDescription": {
"Name": "test",
"EmailSubject": "Please sign the enclosed envelope",
"EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
"DisplayedEmailSender": "",
"EnableReminders": true,
"FirstReminderDayAmount": 5,
"RecurrentReminderDayAmount": 3,
"BeforeExpirationDayAmount": 3,
"DaysUntilExpire": 28,
"CallbackUrl": "",
"StatusUpdateCallbackUrl": "",
"LockFormFieldsAtEnvelopeFinish": true,
"Steps": [
{
"OrderIndex": 1,
"Recipients": [
{
"Email": "##EMAIL##",
"FirstName": "##NAME##",
"LastName": "##NAME##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"AllowAccessFinishedWorkstep": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": [],
"DisposableCertificateData": {
"CountryResidence": "AT",
"IdentificationCountry": "AT",
"IdentificationType": "PASSPORT",
"PhoneMobile": "##PHONENUMBER##",
"DocumentType": "PASS",
"DocumentIssuedBy": "Namirial",
"DocumentIssuedOn": "2020-07-07T00:00:00Z",
"DocumentExpiryDate": "2020-07-29T00:00:00Z",
"SerialNumber": "1234",
"DocumentNumber": "123",
"OverrideHolderInCaseOfMismatch": false
}
}
],
"EmailBodyExtra": "",
"RecipientType": "Signer",
"WorkstepConfiguration": {
"WorkstepLabel": "test",
"SmallTextZoomFactorPercent": 100,
"FinishAction": {
"ServerActions": [],
"ClientActions": [
{
"RemoveDocumentFromRecentDocumentList": false,
"CallClientActionOnlyAfterSuccessfulSync": true,
"ClientName": "SIGNificant SignAnywhere",
"CloseApp": false,
"Action": "https://www.esignanywhere.net/"
}
]
},
"ReceiverInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
},
"HolderInformation": "<recognitionType>PASS</recognitionType><documentIssuedOn>07/07/2020</documentIssuedOn><documentExpiryDate>29/07/2020</documentExpiryDate><documentIssuedBy>Namirial</documentIssuedBy><documentNumber>123</documentNumber><countryResidence>AT</countryResidence><firstName>##NAME##</firstName><lastName>##NAME##</lastName><email>##EMAIL##</email><phoneMobile>##PHONENUMBER##</phoneMobile><identificationType>PASSPORT</identificationType><identificationCountry>AT</identificationCountry><passport>1234</passport>",
"TransactionCodePushPluginData": []
},
"SenderInformation": {
"UserInformation": {
"FirstName": "##NAME##",
"LastName": "##NAME##",
"EMail": "##EMAIL##"
}
},
"TransactionCodeConfigurations": [
{
"Id": "smsAuthTransactionCodeId",
"HashAlgorithmIdentifier": "Sha256",
"Texts": [
{
}
]
}
],
"SignatureConfigurations": [],
"ViewerPreferences": {
"FinishWorkstepOnOpen": false,
"VisibleAreaOptions": {
"AllowedDomain": "*",
"Enabled": false
}
},
"ResourceUris": {},
"AuditingToolsConfiguration": {
"WriteAuditTrail": false,
"NotificationConfiguration": {}
},
"Policy": {
"GeneralPolicies": {
"AllowSaveDocument": true,
"AllowSaveAuditTrail": true,
"AllowRotatingPages": false,
"AllowEmailDocument": true,
"AllowPrintDocument": true,
"AllowFinishWorkstep": true,
"AllowRejectWorkstep": true,
"AllowRejectWorkstepDelegation": false,
"AllowUndoLastAction": true,
"AllowAdhocPdfAttachments": false,
"AllowAdhocSignatures": false,
"AllowAdhocStampings": false,
"AllowAdhocFreeHandAnnotations": false,
"AllowAdhocTypewriterAnnotations": false,
"AllowAdhocPictureAnnotations": false,
"AllowAdhocPdfPageAppending": false
},
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"PositionPage": 1,
"Position": {
"PositionX": 89.0,
"PositionY": 575.0
},
"Size": {
"Height": 80.0,
"Width": 190.0
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "positioning",
"Value": "onPage"
},
{
"Key": "req",
"Value": "1"
},
{
"Key": "fd",
"Value": ""
},
{
"Key": "fd_dateformat",
"Value": "dd-MM-yyyy HH:mm:ss"
},
{
"Key": "fd_timezone",
"Value": "datetimeutc"
},
{
"Key": "spcId",
"Value": "padesSigningId"
}
],
"AllowedSignatureTypes": [
{
"TrModType": "RemoteSignatureDisposableCertificate",
"TrValidityInSeconds": 300,
"Ly": "remoteCertificate",
"TrConfIdIssueCertificate": "disposableCertificateEnrolAndSignSmsText",
"TrConfId": "remoteCertificateSignSmsText",
"IsPhoneNumberRequired": false,
"Id": "180c4201-4146-4161-baf8-cb5a607eec62",
"DiscriminatorType": "SigTypeTransactionCode",
"Preferred": false,
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0
}
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_b58c192b-47c0-5339-cb18-4fe77c3d1812",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
},
"Navigation": {
"HyperLinks": [],
"Links": [],
"LinkTargets": []
}
},
"DocumentOptions": [
{
"DocumentReference": "1",
"IsHidden": false
}
],
"UseDefaultAgreements": true
},
{
"OrderIndex": 2,
"Recipients": [
{
"Email": "##EMAIL##",
"FirstName": "##NAME##",
"LastName": "##NAME##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Cc",
"DocumentOptions": [],
"UseDefaultAgreements": false
}
],
"AddFormFields": {
"Forms": {}
},
"OverrideFormFieldValues": {
"Forms": {}
},
"AttachSignedDocumentsToEnvelopeLog": false
}
} |
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Disposable certitifacate (Long-lived)
Info | ||
---|---|---|
| ||
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. When using this special type of Disposable Certificates, the procedure of the Opative Manual has to be followed; which is different for the case of Long-Lived Disposable. See Long-Lived Disposable in SSP documentation for more information. |
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 | ||||
---|---|---|---|---|
| ||||
{
"SspFileIds": [
"b4d753d1-1234-1234-ada4-b7a7975324c3"
],
"SendEnvelopeDescription": {
"Name": "test",
"EmailSubject": "Please sign the enclosed envelope",
"EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
"DisplayedEmailSender": "",
"EnableReminders": true,
"FirstReminderDayAmount": 5,
"RecurrentReminderDayAmount": 3,
"BeforeExpirationDayAmount": 3,
"ExpirationInSecondsAfterSending": 2419200,
"CallbackUrl": "",
"StatusUpdateCallbackUrl": "",
"LockFormFieldsAtEnvelopeFinish": false,
"Steps": [
{
"OrderIndex": 1,
"Recipients": [
{
"Email": "johndoe@sample.com",
"FirstName": "John",
"LastName": "Doe",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": true,
"AllowAccessFinishedWorkstep": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": [],
"IdentificationMethods": [],
"DisposableCertificateData": {
"CountryResidence": "AT",
"DocumentIssuingCountry": "",
"IdentificationCountry": "AT",
"IdentificationType": "PASSPORT",
"PhoneMobile": "##PhoneNumber##",
"DocumentType": "PASS",
"DocumentIssuedBy": "Namirial",
"DocumentIssuedOn": "2022-05-24T00:00:00Z",
"DocumentExpiryDate": "2022-06-07T00:00:00Z",
"SerialNumber": "##SerialNumber##",
"DocumentNumber": "##DocumentNumber##",
"OverrideHolderInCaseOfMismatch": false
}
}
],
"EmailBodyExtra": "",
"RecipientType": "Signer",
"WorkstepConfiguration": {
"WorkstepLabel": "test",
"SmallTextZoomFactorPercent": 100,
"FinishAction": {
"ServerActions": [],
"ClientActions": []
},
"ReceiverInformation": {
"UserInformation": {
"FirstName": "Jane",
"LastName": "Doe",
"EMail": "janedoe@sample.com"
},
"HolderInformation": "<recognitionType>PASS</recognitionType><documentIssuedOn>24/05/2022</documentIssuedOn><documentExpiryDate>07/06/2022</documentExpiryDate><documentIssuedBy>Namirial</documentIssuedBy><documentNumber>##DocumentNumber##</documentNumber><countryResidence>AT</countryResidence><firstName>John</firstName><lastName>Doe</lastName><email>johndoe@sample.com</email><phoneMobile>##PhoneNumber##</phoneMobile><identificationType>PASSPORT</identificationType><identificationCountry>AT</identificationCountry><passport>##Passport##</passport>",
"TransactionCodePushPluginData": []
},
"SenderInformation": {
"UserInformation": {
"FirstName": "John",
"LastName": "Doe",
"EMail": "johndoe@sample.com"
}
},
"TransactionCodeConfigurations": [],
"SignatureConfigurations": [],
"ViewerPreferences": {
"FinishWorkstepOnOpen": false,
"VisibleAreaOptions": {
"AllowedDomain": "",
"Enabled": false
}
},
"ResourceUris": {
"DelegationUri": "https://demo.esignanywhere.net/Resource/Delegate"
},
"AuditingToolsConfiguration": {
"WriteAuditTrail": true
},
"Policy": {
"GeneralPolicies": {
"AllowSaveDocument": false,
"AllowSaveAuditTrail": false,
"AllowRotatingPages": false,
"AllowAppendFileToWorkstep": false,
"AllowAppendTaskToWorkstep": false,
"AllowEmailDocument": true,
"AllowPrintDocument": true,
"AllowFinishWorkstep": true,
"AllowRejectWorkstep": true,
"AllowRejectWorkstepDelegation": true,
"AllowUndoLastAction": true,
"AllowColorizePdfForms": false,
"AllowAdhocPdfAttachments": false,
"AllowAdhocSignatures": false,
"AllowAdhocStampings": false,
"AllowAdhocFreeHandAnnotations": false,
"AllowAdhocTypewriterAnnotations": false,
"AllowAdhocPictureAnnotations": false,
"AllowAdhocPdfPageAppending": false,
"AllowReloadOfFinishedWorkstep": true
},
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"Texts": [
{
"Language": "en",
"Value": "Agreement text"
},
{
"Language": "*",
"Value": "Agreement text"
}
],
"Headings": [
{
"Language": "en",
"Value": "Agreement Subject"
},
{
"Language": "*",
"Value": "Agreement Subject"
}
],
"IsRequired": false,
"Id": "ra",
"DisplayName": "ra",
"DocRefNumber": 1,
"DiscriminatorType": "Agreements"
},
{
"PositionPage": 1,
"Position": {
"PositionX": 72.0,
"PositionY": 594.0
},
"Size": {
"Height": 80.0,
"Width": 190.0
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "completed",
"Value": "0"
},
{
"Key": "req",
"Value": "1"
},
{
"Key": "isPhoneNumberRequired",
"Value": "0"
},
{
"Key": "trValidityInSeconds",
"Value": "60"
},
{
"Key": "fd",
"Value": ""
},
{
"Key": "fd_dateformat",
"Value": "dd-MM-yyyy HH:mm:ss"
},
{
"Key": "fd_timezone",
"Value": "datetimeutc"
}
],
"AllowedSignatureTypes": [
{
"TrModType": "RemoteSignatureLongLivedDisposableCertificate",
"TrValidityInSeconds": 300,
"TrConfIdIssueCertificate": "disposableCertificateEnrolAndSignSmsText",
"TrConfId": "remoteCertificateSignSmsText",
"IsPhoneNumberRequired": false,
"Ly": "remoteCertificate",
"Id": "7392f37f-32f5-4f53-bade-d830ddb51fa2",
"DiscriminatorType": "SigTypeTransactionCode",
"Preferred": false,
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0,
"OverrideLegacyStampImprint": false,
"DisplayTransactionId": true,
"DisplayTransaktionToken": true,
"DisplayPhoneNumber": true
},
"SignaturePluginConfigurationId": "padesSigningId"
}
],
"UseTimestamp": false,
"IsRequired": true,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_4385a5b6-4615-2f23-3a1e-49e31af38dba",
"DisplayName": "",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
}
},
"Navigation": {
"HyperLinks": [],
"Links": [],
"LinkTargets": []
}
},
"DocumentOptions": [
{
"DocumentReference": "1",
"IsHidden": false
}
],
"UseDefaultAgreements": true
},
{
"OrderIndex": 2,
"Recipients": [
{
"Email": "johndoe@sample",
"FirstName": "John",
"LastName": "Doe",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": [],
"IdentificationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Cc",
"DocumentOptions": [],
"UseDefaultAgreements": false
}
],
"AddFormFields": {
"Forms": {}
},
"OverrideFormFieldValues": {
"Forms": {}
},
"AttachSignedDocumentsToEnvelopeLog": false
}
} |
After sending the envelope the receiver get the following after clicking the signature field to accept the general terms and conditions.:
The information about the LLD is also shown in the audit trail:
Please also note the following difference:
Difference in the certificate issued
A main difference is in the "certification policies" documented in the certificate:
"Normal" Disposable Certificate (Sample) | Long-Lived Disposable Certificate (Sample) |
---|---|
* Refers to Policy OID: 1.3.6.1.4.1.36203.1.1.6 | * Refers to Policy OID 1.3.6.1.4.1.36203.1.1.7 (Long-Lived Disposable) |
P7M Signers
Info |
---|
It is possible to define P7M signers in eSignAnyWhere. This allows you to define at the end of a signing workflow to define signers with P7M. Due technical reasons it is not possible to add non-P7M signers after the first P7M signer. P7M is an advanced feature and must be enabled for you, so please contact your Namirial Sales |
The P7M signer can be defined in the recipient list (P7M Signer Type). The P7M signer has no assigned signature fields in the document, so you will not be able to assign signature fields, form fields or predefined fields for him or her.
When a workflow with a P7M signer is finished you will not receive a PDF document, but a signed P7M container with the PDF. Please see the next figure:
The workstepconfig must be extended with a invisibleSignature, Task and a document information:
Code Block | ||||
---|---|---|---|---|
| ||||
<signatureTemplate>
<InvisibleSig>
<id>pkcs1</id>
<TargetDocument>
<DocRefNumber>1</DocRefNumber>
<completed>0</completed>
</TargetDocument>
<TargetDocument>
<DocRefNumber>2</DocRefNumber>
<completed>0</completed>
</TargetDocument>
<TargetDocument>
<DocRefNumber>3</DocRefNumber>
<completed>0</completed>
</TargetDocument>
</InvisibleSig>
</signatureTemplate> |
Taskdefinition:
Code Block | ||||
---|---|---|---|---|
| ||||
<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks">
<Task enabled="1" completed="0" required="0" id="pkcs1" displayName="" DocRefNumber="1" type="SignPkcs7" finishPercentage="0" />
</WorkstepTasks>
EnvelopeDocumentInforamtion
<WorkStepInformation>
...
<EnvelopeInformation>
<EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="1" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
<EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="2" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
<EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="3" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
</EnvelopeInformation>
...
</WorkStepInformation> |
Automatic Remote Signature Recipient via API
Via API you have to use a new recipient type (“Automatic”). Moreover the workstepConfiguration must contain information about the automatic remote signature. As additional option, you can use more than one profile for the workstep configuration at once via API. Note: this leads to a missing information in eSAW UI!
1) Envelope JSON with new recipient type “Automatic”
Code Block | ||||
---|---|---|---|---|
| ||||
"EmailBodyExtra": "",
"RecipientType": "Automatic",
"WorkstepConfiguration": { |
2) Workstep Configuration
2.1) Define Signature Field in WorkstepConfiguration
Code Block | ||||
---|---|---|---|---|
| ||||
"AllowedSignatureTypes": [
{
"TrModType": "RemoteSignature",
"SealingProfileId": "SEALING_PROFILE_IDENTIFIER_FROM_ORGANIZATION_SETTINGS",
"RenderingLanguage": "en",
"Ly": "test",
"Id": "##Id##",
"DiscriminatorType": "SigTypeAutomaticSignature",
"Preferred": false,
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0,
"OverrideLegacyStampImprint": false,
"DisplayTransactionId": true,
"DisplayTransaktionToken": true,
"DisplayPhoneNumber": true
}, |
2.3) Finalize Action in WorkstepConfiguration Policy
Code Block | ||||
---|---|---|---|---|
| ||||
"FinalizeActions": {
"FinalizeActionList": [
{
"SigId": "##SignatureId##",
"DiscriminatorType": "AutomaticSignature"
},
{
"DocRefNumbers": "*",
"SpcId": "ltaLevelId",
"DiscriminatorType": "Timestamp"
}
]
}
}, |
Please also see the following sample configuration:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"Name": "Test.pdf",
"EmailSubject": "Please sign the enclosed envelope",
"EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
"DisplayedEmailSender": "",
"EnableReminders": true,
"FirstReminderDayAmount": 5,
"RecurrentReminderDayAmount": 3,
"BeforeExpirationDayAmount": 3,
"ExpirationInSecondsAfterSending": 2419200,
"CallbackUrl": "",
"StatusUpdateCallbackUrl": "",
"LockFormFieldsAtEnvelopeFinish": false,
"Steps": [
{
"OrderIndex": 1,
"Recipients": [
{
"Email": "##Email##",
"FirstName": "##Name##",
"LastName": "##Name##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": true,
"AllowAccessFinishedWorkstep": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": [],
"IdentificationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Automatic",
"WorkstepConfiguration": {
"WorkstepLabel": "Test.pdf",
"SmallTextZoomFactorPercent": 100,
"FinishAction": {
"ServerActions": [],
"ClientActions": []
},
"ReceiverInformation": {
"UserInformation": {
"FirstName": "##Name##",
"LastName": "##Name##",
"EMail": "##Email##"
},
"TransactionCodePushPluginData": []
},
"SenderInformation": {
"UserInformation": {
"FirstName": "##Name##",
"LastName": "##Name##",
"EMail": "##Email##"
}
},
"TransactionCodeConfigurations": [],
"SignatureConfigurations": [],
"ViewerPreferences": {
"FinishWorkstepOnOpen": false,
"VisibleAreaOptions": {
"AllowedDomain": "",
"Enabled": false
}
},
"AuditingToolsConfiguration": {
"WriteAuditTrail": true
},
"Policy": {
"GeneralPolicies": {
"AllowSaveDocument": true,
"AllowSaveAuditTrail": true,
"AllowRotatingPages": false,
"AllowAppendFileToWorkstep": false,
"AllowAppendTaskToWorkstep": false,
"AllowEmailDocument": true,
"AllowPrintDocument": true,
"AllowFinishWorkstep": true,
"AllowRejectWorkstep": false,
"AllowRejectWorkstepDelegation": false,
"AllowUndoLastAction": true,
"AllowColorizePdfForms": false,
"AllowAdhocPdfAttachments": false,
"AllowAdhocSignatures": false,
"AllowAdhocStampings": false,
"AllowAdhocFreeHandAnnotations": false,
"AllowAdhocTypewriterAnnotations": false,
"AllowAdhocPictureAnnotations": false,
"AllowAdhocPdfPageAppending": false,
"AllowReloadOfFinishedWorkstep": true
},
"WorkstepTasks": {
"PictureAnnotationMinResolution": 0,
"PictureAnnotationMaxResolution": 0,
"PictureAnnotationColorDepth": "Color16M",
"SequenceMode": "NoSequenceEnforced",
"PositionUnits": "PdfUnits",
"ReferenceCorner": "Lower_Left",
"Tasks": [
{
"PositionPage": 1,
"Position": {
"PositionX": 56.0,
"PositionY": 589.0
},
"Size": {
"Height": 80.0,
"Width": 190.0
},
"AdditionalParameters": [
{
"Key": "enabled",
"Value": "1"
},
{
"Key": "completed",
"Value": "0"
},
{
"Key": "req",
"Value": "0"
},
{
"Key": "fd",
"Value": ""
},
{
"Key": "fd_dateformat",
"Value": "dd-MM-yyyy HH:mm:ss"
},
{
"Key": "fd_timezone",
"Value": "datetimeutc"
}
],
"AllowedSignatureTypes": [
{
"TrModType": "RemoteSignature",
"SealingProfileId": "##SealingProfileId##",
"RenderingLanguage": "en",
"Ly": "test",
"Id": "##Id##",
"DiscriminatorType": "SigTypeAutomaticSignature",
"Preferred": false,
"StampImprintConfiguration": {
"DisplayExtraInformation": true,
"DisplayEmail": true,
"DisplayIp": true,
"DisplayName": true,
"DisplaySignatureDate": true,
"FontFamily": "Times New Roman",
"FontSize": 11.0,
"OverrideLegacyStampImprint": false,
"DisplayTransactionId": true,
"DisplayTransaktionToken": true,
"DisplayPhoneNumber": true
},
"SignaturePluginConfigurationId": "ltaLevelId"
}
],
"UseTimestamp": false,
"IsRequired": false,
"Id": "##Id##",
"DocRefNumber": 1,
"DiscriminatorType": "Signature"
}
]
},
"FinalizeActions": {
"FinalizeActionList": [
{
"SigId": "##SignatureId##",
"DiscriminatorType": "AutomaticSignature"
},
{
"DocRefNumbers": "*",
"SpcId": "ltaLevelId",
"DiscriminatorType": "Timestamp"
}
]
}
},
"Navigation": {
"HyperLinks": [],
"Links": [],
"LinkTargets": []
}
},
"DocumentOptions": [
{
"DocumentReference": "1",
"IsHidden": false
}
],
"UseDefaultAgreements": true
},
{
"OrderIndex": 2,
"Recipients": [
{
"Email": "##Email##",
"FirstName": "##Name##",
"LastName": "##Name##",
"LanguageCode": "en",
"EmailBodyExtra": "",
"DisableEmail": false,
"AddAndroidAppLink": false,
"AddIosAppLink": false,
"AddWindowsAppLink": false,
"AllowDelegation": false,
"SkipExternalDataValidation": false,
"AuthenticationMethods": [],
"IdentificationMethods": []
}
],
"EmailBodyExtra": "",
"RecipientType": "Cc",
"DocumentOptions": [],
"UseDefaultAgreements": false
}
],
"AddFormFields": {
"Forms": {}
},
"OverrideFormFieldValues": {
"Forms": {}
},
"AttachSignedDocumentsToEnvelopeLog": false
} |
You can also find the same samples but for SOAP below:Via API you have to use a new recipient type (“Automatic”). Moreover the workstepConfiguration must contain information about the automatic remote signature. As additional option, you can use more than one profile for the workstep configuration at once via API. Note: this leads to a missing information in eSAW UI!
1) Envelope XML with new recipient type “Automatic”
...
Code Block | ||||
---|---|---|---|---|
| ||||
<Policy version="1.1.0.0"> <FinalizeActions> <AutomaticSignature sigId="GENERIC_SIG_IDENTIFIER" /> </FinalizeActions> </Policy> |
A-Trust
Info |
---|
Note: For the A-Trust signature configuration you need an A-Trust Signaturbox first. For more information please contact us. |
...
If you enter the phone number then the recipient can not enter another number. However, if you do not define a phone number then the recipient is free to choose a phone number of their choice.
BankID
In this section you can find the configuration for the bankID signature. First we have to upload a PDF. After uploading the document we can now send the document with the following workstep configuration to define the bankID signature:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Name": "test", "EmailSubject": "Please sign the enclosed envelope", "EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#", "DisplayedEmailSender": "##SENDER##", "EnableReminders": true, "FirstReminderDayAmount": 5, "RecurrentReminderDayAmount": 3, "BeforeExpirationDayAmount": 3, "DaysUntilExpire": 28, "CallbackUrl": "", "StatusUpdateCallbackUrl": "", "LockFormFieldsAtEnvelopeFinish": true, "Steps": [ { "OrderIndex": 1, "Recipients": [ { "Email": "##EMAIL##", "FirstName": "##NAME##", "LastName": "##NAME##", "LanguageCode": "en", "EmailBodyExtra": "", "DisableEmail": false, "AddAndroidAppLink": false, "AddIosAppLink": false, "AddWindowsAppLink": false, "AllowDelegation": false, "AllowAccessFinishedWorkstep": false, "SkipExternalDataValidation": false, "AuthenticationMethods": [] } ], "EmailBodyExtra": "", "RecipientType": "Signer", "WorkstepConfiguration": { "WorkstepLabel": "test", "SmallTextZoomFactorPercent": 100, "FinishAction": { "ServerActions": [], "ClientActions": [ { "RemoveDocumentFromRecentDocumentList": false, "CallClientActionOnlyAfterSuccessfulSync": true, "ClientName": "SIGNificant SignAnywhere", "CloseApp": false, "Action": "https://www.esignanywhere.net/" } ] }, "ReceiverInformation": { "UserInformation": { "FirstName": "##NAME##", "LastName": "##NAME##", "EMail": "##EMAIL##" }, "TransactionCodePushPluginData": [] }, "SenderInformation": { "UserInformation": { "FirstName": "##NAME##", "LastName": "##NAME##", "EMail": "##EMAIL##" } }, "TransactionCodeConfigurations": [ { "Id": "", "HashAlgorithmIdentifier": "Sha1", "Texts": [ { "Value": "Please sign the document" } ] }, { "Id": "otpSignatureSmsText", "HashAlgorithmIdentifier": "Sha256", "Texts": [ ] } ], "SignatureConfigurations": [], "ViewerPreferences": { "FinishWorkstepOnOpen": false, "VisibleAreaOptions": { "AllowedDomain": "*", "Enabled": false } }, "ResourceUris": {}, "AuditingToolsConfiguration": { "WriteAuditTrail": false, "NotificationConfiguration": {} }, "Policy": { "GeneralPolicies": { "AllowSaveDocument": true, "AllowSaveAuditTrail": true, "AllowRotatingPages": false, "AllowEmailDocument": true, "AllowPrintDocument": true, "AllowFinishWorkstep": true, "AllowRejectWorkstep": true, "AllowRejectWorkstepDelegation": false, "AllowUndoLastAction": true, "AllowAdhocPdfAttachments": false, "AllowAdhocSignatures": false, "AllowAdhocStampings": false, "AllowAdhocFreeHandAnnotations": false, "AllowAdhocTypewriterAnnotations": false, "AllowAdhocPictureAnnotations": false, "AllowAdhocPdfPageAppending": false }, "WorkstepTasks": { "PictureAnnotationMinResolution": 0, "PictureAnnotationMaxResolution": 0, "PictureAnnotationColorDepth": "Color16M", "SequenceMode": "SequenceOnlyRequiredTasks", "PositionUnits": "PdfUnits", "ReferenceCorner": "Lower_Left", "Tasks": [ { "PositionPage": 1, "Position": { "PositionX": 10.0, "PositionY": 10.0 }, "Size": { "Height": 50.0, "Width": 200.0 }, "AdditionalParameters": [ { "Key": "sigType", "Value": "TransactionCode" }, { "Key": "trModType", "Value": "BankIdSignature" }, { "Key": "trValidityInSeconds", "Value": "60" }, { "Key": "ly", "Value": "bankId" } ], "AllowedSignatureTypes": [], "UseTimestamp": false, "IsRequired": true, "Id": "1", "DisplayName": "SignField 1", "DocRefNumber": 1, "DiscriminatorType": "Signature" } ] } }, "Navigation": { "HyperLinks": [], "Links": [], "LinkTargets": [] } }, "DocumentOptions": [ { "DocumentReference": "1", "IsHidden": false } ], "UseDefaultAgreements": true }, { "OrderIndex": 2, "Recipients": [ { "Email": "##EMAIL##", "FirstName": "##NAME##", "LastName": "##NAME##", "LanguageCode": "en", "EmailBodyExtra": "", "DisableEmail": false, "AddAndroidAppLink": false, "AddIosAppLink": false, "AddWindowsAppLink": false, "AllowDelegation": false, "AllowAccessFinishedWorkstep": false, "SkipExternalDataValidation": false, "AuthenticationMethods": [] } ], "EmailBodyExtra": "", "RecipientType": "Cc", "DocumentOptions": [ { "DocumentReference": "1", "IsHidden": false } ], "UseDefaultAgreements": false } ], "AddFormFields": { "Forms": {} }, "OverrideFormFieldValues": { "Forms": {} }, "AttachSignedDocumentsToEnvelopeLog": false } |
...
Expand | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Generic Signing Plugin
In this section you can find the configuration for the generic signing plugin signature. First we have to upload a PDF. After uploading the document we can now send the document with the following workstep configuration to define the plugin signature:
...
Generic Signing Plugin (automatic)
In this section you can find the configuration for an automatic generic signing plugin signature. Please see the following workstep configuration for more information:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "SspFileIds": ["##SspFileId##"], "SendEnvelopeDescription": { "Name": "GenericSigningPluginForTests", "EmailSubject": "*GenericSigningPluginForTests*", "EmailBody": "*Please sign the document*", "Steps": [{ "OrderIndex": 1, "Recipients": [{ "Email": "##PlaceholderEmail##", "FirstName": "_PlaceHolderFirstName", "LastName": "_PlaceHolderLastName", "LanguageCode": "en", "DisableEmail": true, "AddAndroidAppLink": false, "AddIosAppLink": false, "AddWindowsAppLink": false, "AllowDelegation": false, "SkipExternalDataValidation": true }], "RecipientType": "Automatic", "WorkstepConfiguration": { "WorkstepLabel": "Automatic", "SkipThirdPartyChecks": false, "SmallTextZoomFactorPercent": 100, "WorkstepTimeToLiveInMinutes": 44650, "ViewerPreferences": { "FinishWorkstepOnOpen": false }, "Policy": { "WorkstepTasks": { "SequenceMode": "NoSequenceEnforced", "PositionUnits": "PdfUnits", "ReferenceCorner": "Lower_Left", "Tasks": [{ "DiscriminatorType": "Signature", "Id": "c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75", "DocRefNumber": 1, "PositionPage": 1, "Position": { "PositionX": 0.0, "PositionY": 0.0 }, "Size": { "Height": 80.0, "Width": 190.0 }, "AdditionalParameters": [{ "Key": "req", "Value": "1" }, { "Key": "positioning", "Value": "onPage" }, { "Key": "enabled", "Value": "1" }], "AllowedSignatureTypes": [{ "DiscriminatorType": "SigTypeAutomaticSignature", "Id": "SignFor_c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75", "GenericSigningPluginId": "GenericSigningPluginForTests", "SealingProfileId": "##SealingProfileId##" }] }] }, "FinalizeActions": { "FinalizeActionList": [{ "DiscriminatorType": "AutomaticSignature", "SigId": "c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75" }] } } } }] } } |
...
Generic Signing Plugin (Batch-Signature)
In this section you can find the configuration for a batch generic signing plugin signature. Please see the following workstep configuration for more information:
...
For all placeholder with the additional “*” you need either the sender information or the receiver information which are both explained in the section “sender and receiver information”.
Reading Tasks
...
With the reading task a recipient must confirm reading the document to have the evidence that he/she was reading it.
Generally there are 3 basic ways concerning the range of the reading task:
...
Code Block | ||||
---|---|---|---|---|
| ||||
"Tasks": [ { "PositionPage": 1, "AllPages": falsetrue, "AllDocuments": truefalse, "Position": { "PositionX": 50.0, "PositionY": 100.0 }, "Size": { "Height": 40.0, "Width": 400.0 }, "IsRequired": true, "Id": "847a3d4a-da2c-46f4-8c8c-a9edaa06c29b", "DisplayName": "your text for this task", "DocRefNumber": 1, "DiscriminatorType": "ReadingTask" }, { "PositionPage": 1, "Position": { "PositionX": 80.22857, "PositionY": 158.8629 }, "Size": { "Height": 68.57143, "Width": 171.4286 }, "AllowedSignatureTypes": [], "UseTimestamp": false, "IsRequired": true, "Id": "93cce567-ae5c-4e98-ac99-9f56ac034250", "DisplayName": "SignField 1", "DocRefNumber": 1, "DiscriminatorType": "Signature" } ] |
...