Versions Compared

Key

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

...

Code Block
languagejava
themeEclipse
{
    "Status": "InProgress",
    "SendDate": "20202023-0304-17T0803T07:2421:4713.62Z697Z",
    "ExpirationDate": "20202023-0405-14T0801T07:2421:47.62"13.6962336Z",
    "ValidityFromCreationInDays": 28,
    "ExpirationInSecondsAfterSending": 2419200,
    "Bulks": [
        {
            "Status": "InProgress",
            "Email": "",
            "LogDocumentId": "",
            "FinishedDocuments": [],
            "Steps": [
                {
                    "Id": "c211d5508d700260-25c52345-4f611234-94f91234-9eb5695685fd040618546ac8",
                    "FirstName": "##NAME##Jane",
                    "LastName": "##NAME##Doe",
                    "OrderIndex": 1,
                    "Email": "##EMAIL##jane.doe@sample.com",
                    "LanguageCode": "en",
                    "Status": "NotSigned",
                    "StatusReason": "",
                    "RecipientType": "Signer",
                    "OpenedDateWorkstepRedirectionUrl": "2020-03-17T08:24:59.383Zhttps://demo.esignanywhere.net/workstepredirector/sign?identifier=Bp~IrxSLSBnk9A1234LOsSiHpe6hO8mVHFu1234g80qCZJ9M1SxP12347kr33s0k~joCDCG6XAHeNA==",
                    "WorkstepRedirectionUrlAllowAccessFinishedWorkstep": "http://beta4.testlab.xyzmo.com/workstepredirector/sign?identifier=##RedirectionURL##"true,
                    "AllowAccessFinishedWorkstepIsParallel": false,
                    "AuthenticationWorkstepConfiguration": [{
                        {
     "WorkstepLabel": "Test",
                        "MethodSmallTextZoomFactorPercent": "Pin"100,
                            "ParameterFinishAction": "1234",{
                            "FiltersServerActions": [],
                        }
    "ClientActions": []
               ],
                    "IsParallel": false,
                    "WorkstepConfiguration": {
                        "WorkstepLabel": "test",
                        "SmallTextZoomFactorPercent": 100,
                        "FinishAction": {
                            "ServerActions": [
                                {
                                    "CallSynchronous": false,
                                    "Action": "http://beta4.testlab.xyzmo.com//workstepredirector/setfinishaction?wid=##WorkstepId##"
                                }
                            ],
                            "ClientActions": []
                        },
                        "ReceiverInformation": {
                            "UserInformation": {
                                "FirstName": "##NAME##",
                                "LastName": "##NAME##",
                                "EMail": "##EMAIL##"
                            },
                            "TransactionCodePushPluginData": []
                        },
                        "SenderInformation": {
                            "UserInformation": {
                                "FirstName": "##NAME##",
                                "LastName": "##NAME##",
                                "EMail": "##EMAIL##"
                            }
                        },
                        "TransactionCodeConfigurations": [
                            {
                                "Id": "otpSignatureSmsText",
                                "HashAlgorithmIdentifier": "Sha256",
                                "Texts": [
                                    
                                ]
                            }
                        ],
                        "SignatureConfigurations": [
                            {
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": false,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude"
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "timestampSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": false,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",
                                    "SignatureTimestampData": {
                                        "Uri": "https://timestamp.test.namirialtsp.com",
                                        "Username": "xyzmo",
                                        "Password": "xyzmo",
                                        "SignatureHashAlgorithm": "Sha256"
                                    }
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "padesSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": true,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "IncludeDss"
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "padesTimestampSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": true,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "IncludeDss",
                                    "SignatureTimestampData": {
                                        "Uri": "https://timestamp.test.namirialtsp.com",
                                        "Username": "xyzmo",
                                        "Password": "xyzmo",
                                        "SignatureHashAlgorithm": "Sha256"
                                    }
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "padesRemoteCertificateSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": true,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "IncludeDss"
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "padesRemoteCertificateTimestampSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": true,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "IncludeDss",
                                    "SignatureTimestampData": {
                                        "Uri": "https://timestamp.test.namirialtsp.com",
                                        "Username": "xyzmo",
                                        "Password": "xyzmo",
                                        "SignatureHashAlgorithm": "Sha256"
                                    }
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "automaticSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": false,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude"
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "automaticTimestampSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": false,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",
                                    "SignatureTimestampData": {
                                        "Uri": "https://timestamp.test.namirialtsp.com",
                                        "Username": "xyzmo",
                                        "Password": "xyzmo",
                                        "SignatureHashAlgorithm": "Sha256"
                                    }
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "swissComSigningId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": true,
                                    "IncludeSigningCertificateChain": false,
                                    "SigningCertificateRevocationInformationIncludeMode": "IncludeDss"
                                },
                                "PdfSignatureCryptographicData": {
                                    "SignatureHashAlgorithm": "Sha256",
                                    "SigningCertificateDescriptor": {
                                        "Identifier": "14527A6BCFA8B4D7D0183FCA6B735B1C246D14AE",
                                        "Type": "Sha1Thumbprint",
                                        "Csp": "Default"
                                    }
                                }
                            },
                            {
                                "SpcId": "tLevelId",
                                "PdfSignatureProperties": {
                                    "PdfAConformant": false,
                                    "PAdESPart4Compliant": true,
                                    "IncludeSigningCertificateChain": true,
                                    "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",
                                    "SignatureTimestampData": {
                },
                        "UriReceiverInformation": "https://timestamp.test.namirialtsp.com",{
                                        "Username"UserInformation": "xyzmo",
       {
                                 "PasswordFirstName": "xyzmoJane",
                                        "SignatureHashAlgorithmLastName": "Sha256Doe",
                                    }
  "EMail": "jane.doe@sample.com"
                              },
                            "TransactionCodePushPluginData": []
   "PdfSignatureCryptographicData": {
                    },
                "SignatureHashAlgorithm": "Sha256",
       "SenderInformation": {
                            "SigningCertificateDescriptorUserInformation": {
                                        "Identifier"FirstName": "14527a6bcfa8b4d7d0183fca6b735b1c246d14aeJane",
                                        "TypeLastName": "Sha1ThumbprintDoe",
                                        "CspEMail": "Default"
               john.doe@sample.com"
                     }
       }
                         },
                        "TransactionCodeConfigurations": [],
   }
                        "SignatureConfigurations": [],
                        "ViewerPreferences": {
                            "FinishWorkstepOnOpen": false,
                            "VisibleAreaOptions": {
                                "AllowedDomain": "*",
                                "Enabled": false
                            }
                        },
                        "ResourceUris": {
                            "SignatureImagesUri": "httphttps://beta4demo.testlabesignanywhere.xyzmo.comnet//Resource/SignatureImages/?link=1WStxYx9aVh2bKgPnnOoA2x56aVWCf/oMP6GirOkH5eOattOs60C8lVAATUnqhUHa"1Bp~IrxSLSB1234sSiHpe6hO8mVHFuA6lC1234V3RVuxhYT1XZYh"
                        },
                        "AuditingToolsConfiguration": {
                            "WriteAuditTrail": true
                        },
                        "Policy": {
                            "GeneralPolicies": {
                                "AllowSaveDocument": true,
                                "AllowSaveAuditTrail": true,
                                "AllowRotatingPages": false,
                                "AllowAppendFileToWorkstep": false,
                                "AllowAppendTaskToWorkstep": false,
                                "AllowEmailDocument": true,
                                "AllowEmailDocumentAllowPrintDocument": true,
                                "AllowPrintDocumentAllowFinishWorkstep": true,
                                "AllowFinishWorkstepAllowRejectWorkstep": true,
                                "AllowRejectWorkstepAllowRejectWorkstepDelegation": truefalse,
                                "AllowRejectWorkstepDelegationAllowUndoLastAction": falsetrue,
                                "AllowUndoLastActionAllowColorizePdfForms": false,
                                "AllowColorizePdfFormsAllowAdhocPdfAttachments": false,
                                "AllowAdhocPdfAttachmentsAllowAdhocSignatures": false,
                                "AllowAdhocSignaturesAllowAdhocStampings": false,
                                "AllowAdhocStampingsAllowAdhocFreeHandAnnotations": false,
                                "AllowAdhocFreeHandAnnotationsAllowAdhocTypewriterAnnotations": false,
                                "AllowAdhocTypewriterAnnotationsAllowAdhocPictureAnnotations": false,
                                "AllowAdhocPictureAnnotationsAllowAdhocPdfPageAppending": false,
                                "AllowAdhocPdfPageAppendingAllowReloadOfFinishedWorkstep": falsetrue
                            },
                            "WorkstepTasks": {
                                "PictureAnnotationMinResolution": 0,
                                "PictureAnnotationMaxResolution": 0,
                                "PictureAnnotationColorDepth": "Color16M",
                                "SequenceMode": "NoSequenceEnforced",
                                "PositionUnits": "PdfUnits",
                                "ReferenceCorner": "Lower_Left",
                                "Tasks": [
                                    {
                                        "Texts": [
                                            {
                                                "Language": "*en",
                                                "Value": "SignatureAgreement Disclosure Texttext"
                                            },
                                            {
                                                "Language": "en*",
                                                "Value": "SignatureAgreement Disclosure Texttext"
                                            }
                                        ],
                                        "Headings": [
                                            {
                                                "Language": "*en",
                                                "Value": "Signature DisclosureAgreement Subject"
                                            },
                                            {
                                                "Language": "en*",
                                                "Value": "SignatureAgreement Disclosure Subject"
                                            }
                                        ],
                                        "IsRequired": false,
                                        "Id": "ra",
                                        "DisplayName": "ra",
                                        "DocRefNumber": 1,
                                        "DiscriminatorType": "Agreements"
                                    },
                                    {
                                        "PositionPage": 1,
                                        "Position": {
                                            "PositionX": 63100.0,
                                            "PositionY": 603200.0
                                        },
                                        "Size": {
                                            "Height": 8070.0,
                                            "Width": 190100.0
                                        },
                                        "AdditionalParameters": [
                                            {
                                                "Key": "enabled",
                                                "Value": "1"
                                            },
                                            {
                                                "Key": "positioningcompleted",
                                                "Value": "onPage0"
                                            },
                                            {
                                                "Key": "req",
                                                "Value": "1"
                                            },
                                            {
                                                "Key": "fd",
                                                "Value": ""
                                            },
                                            {
                                                "Key": "fd_dateformat",

                                                "Value": "dd-MM-yyyy HH:mm:ss"
                                            },
                                  "Value": "dd-MM-yyyy HH:mm:ss"
        {
                                    },
            "Key": "fd_timezone",
                                {
                "Value": "datetimeutc"
                               "Key": "fd_timezone",
            }
                                    "Value": "datetimeutc"
   ],
                                         },"AllowedSignatureTypes": [
                                            {
                                                "KeyAllowedCapturingMethod": "spcIdClick2Sign",
                                                "ValueLy": "tLevelIddefault",
                                              }
   "Id": "03923516-4d2b-460a-9950-29bc24083cec",
                                          ],
      "DiscriminatorType": "SigTypeClick2Sign",
                                                "AllowedSignatureTypesPreferred": [
false,
                                                "StampImprintConfiguration": {
                                                    "AllowedCapturingMethodDisplayExtraInformation": "Click2Sign"true,
                                                "Id": "679dd763-6e25-4a68-929d-cb1ce13dac7e",
    "DisplayEmail": true,
                                                    "DiscriminatorTypeDisplayIp": "SigTypeClick2Sign"true,
                                                    "PreferredDisplayName": falsetrue,
                                                    "StampImprintConfigurationDisplaySignatureDate": {true,
                                                    "DisplayExtraInformationFontFamily": true "Times New Roman",
                                                    "DisplayEmailFontSize": true11.0,
                                                    "DisplayIpOverrideLegacyStampImprint": truefalse,
                                                    "DisplayNameDisplayTransactionId": truefalse,
                                                    "DisplaySignatureDateDisplayTransaktionToken": truefalse,
                                                    "FontFamilyDisplayPhoneNumber": "Times New Roman",false
                                                    "FontSize": 11.0
},
                                                 }"SignaturePluginConfigurationId": ""
                                            }
                                        ],
                                        "UseTimestamp": false,
                                        "IsRequired": true,
                                        "Id": "1#XyzmoDuplicateIdSeperator#Signature_a1e940eb-bcd5-2222-9777-f3570faedf3f1#XyzmoDuplicateIdSeperator#sample sig click2sign",
                                        "DisplayName": "Sign here",
                                        "DocRefNumber": 1,
                                        "DiscriminatorType": "Signature"
                                    }
                                ]
                            }
                        },
                        "Navigation": {
                            "HyperLinks": [],
                            "Links": [],
                            "LinkTargets": []
                        }
                    }
                },
                {
                    "Id": "ff4b740ef43354e4-f0a81234-4e691234-ad321234-54cae6104993f5a4cc9e0e9d",
                    "FirstName": "##NAME##John",
                    "LastName": "##NAME##Doe",
                    "OrderIndex": 2,
                    "Email": "##EMAIL##john.doe@sample.com",
                    "LanguageCode": "en",
                    "Status": "NotSigned",
                    "StatusReason": "",
                    "RecipientType": "Cc",
                    "WorkstepRedirectionUrl": "",
                    "AllowAccessFinishedWorkstep": falsetrue,
                    "IsParallel": false,
                    "WorkstepConfiguration": {
                        "SmallTextZoomFactorPercent": 100,
                        "ViewerPreferences": {},
                        "Policy": {
                            "GeneralPolicies": {
                                "AllowRotatingPages": true,
                                "AllowFinishWorkstep": true,
                                "AllowUndoLastAction": true
                            },
                            "WorkstepTasks": {
                                "PictureAnnotationMinResolution": 0,
                                "PictureAnnotationMaxResolution": 0,
                                "PictureAnnotationColorDepth": "Color16M",
                                "SequenceMode": "NoSequenceEnforced",
                                "PositionUnits": "PdfUnits",
                                "ReferenceCorner": "Lower_Left",
                                "Tasks": []
                            }
                        }
                    }
                }
            ]
        }
    ],
    "Documents": [
        {
            "PageSizesInPoints": [
                {
                    "Height": 792841.08,
                    "Width": 612595.02
                }
            ],
            "DocRefNumber": 1,
            "FileName": "testTest.pdf",
            "FormFields": []
        }
    ],
    "Id": "62ce2b28bb01a820-deb91234-40a01234-96561234-88609353494bb2d65b7492ed",
    "Bulk": "",
    "BasicOptions": {
        "Name": "testTest",
        "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#",
        "EnableReminders": true,
        "FirstReminderDayAmount": 5,
        "RecurrentReminderDayAmount": 3,
        "BeforeExpirationDayAmount": 3
    },
    "LockFormFieldsAtEnvelopeFinish": false
}


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<apiResult version="2.2.458.6616">
	<baseResult>ok</baseResult>
	<okInfo>
		<envelopeStatus>
			<id>13ad0518-xxxx-xxxx-xxxx-xxxxxxxxxxx</id>
			<name>eSignAnyWhere Tutorial</name>
			<status>Completed</status>
			<sendDate>2017-03-15T12:13:13.453Z</sendDate>
			<expirationDate>2017-03-17T12:13:13.453Z</expirationDate>
			<bulkRecipients>
				<bulkRecipient eMail="">
					<status>Completed</status>
					<recipients>
						<recipient>
							<orderIndex>1</orderIndex>
							<eMail>first.signer@email.com</eMail>
							<status>Signed</status>
							<signedDate>2017-03-15T12:13:42.717Z</signedDate>
							<recipientType>Signer</recipientType>
							<workstepRedirectionUrl/>
						</recipient>
						<recipient>
							<orderIndex>2</orderIndex>
							<eMail>cc@email.com</eMail>
							<status>NotSigned</status>
							<signedDate>2017-03-15T12:13:43.183Z</signedDate>
							<recipientType>Cc</recipientType>
							<workstepRedirectionUrl/>
						</recipient>
					</recipients>
					<completedDocuments>
						<logDocumentId>52cba71e-xxxx-xxxx-xxxx-xxxxxxxxxxx</logDocumentId>
						<completedDocument>
							<documentId>77851da5-xxxx-xxxx-xxxx-xxxxxxxxxxx</documentId>
							<fileName>eSignAnyWhere_Tutorial.pdf</fileName>
							<fields/>
						</completedDocument>
					</completedDocuments>
				</bulkRecipient>
			</bulkRecipients>
		</envelopeStatus>
	</okInfo>
</apiResult>


...