Versions Compared

Old Version 33

changes.mady.by.user Christoph Bimminger

Saved on

compared with

New Version Current

changes.mady.by.user Manuel Gierlinger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejava
themeEclipse
titleSignature information
"Signatures": [
              {
                "ElementId": "string",
                "Required": true,
                "DocumentNumber": 0,
                "DisplayName": "string",
                "FieldDescription": "string",
 				"AllowedSignatureTypes": {
TaskConfiguration

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

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

Code Block
languagejava
themeEclipse
titleTaskConfiguration
"TaskConfiguration": {
                  "StampImprintDateConfiguration": {
                    "UseLocalTimezone": true,
                    "DateTimeFormat": "string"
                  },
                  "UseExternalTimestampServer": true,
                  "BatchIdBatchGroup": "string",
                  "OrderDefinition": {
                    "OrderIndex": 0
                  }
                }

...

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

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

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

Referring to the identification type the following values are available:

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

*All disposable document data fields

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

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

Referring to the document type the following values are available:

  • IdentityCard
  • DriverLicense
  • Passport
  • ResidencePermit
  • NationalElectronicIdentityCard
  • TemporaryResidencePermit
  • EmbassyDocument
DisposableCertificate (Long-Lived)

...

ValueDescription
intersects with fieldThe signature has to start within the signature field, signing must intersect with the field but the signer is allowed to leave the boundaries of the box while signingsignature field
within fieldThe signature must be completely within the boundaries of the signature field
on pageThe signature can start anywhere on the page, even without intersecting with the signature field

...

Code Block
languagejava
themeEclipse
titleCallback 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
      }
    }
  },

...