...
Section | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UI ExampleThe following screenshot shows a sample configuration with three recipients and three documents:
After you set the recipients and the documents you see that the document visibility settings appear. There you can decide who should see a document and who should not. The following screenshot shows an overview of these settings: In this case the first recipient (customer) does not see the calculation, the second recipient (seller) does not see the terms and the third recipient (head of the department) can see all documents. On the designer page you can see that for example the customer can not see the document. Therefor, it is not possible to place elements for the customer on this page. The designer:
IntegrationSteps:
Upload DocumentFor this step you have to upload two to more documents for the document visibility. Send EnvelopeThe following lines of code show the configuration of the hidden documents:
Please see also a complete configuration here:
Expand | | ||||||||||||||||||||||
|
Code Block | ||||
---|---|---|---|---|
| ||||
<documentOptions>
<documentOption docRef="3">
<isHidden>false</isHidden>
</documentOption>
<documentOption docRef="1">
<isHidden>true</isHidden>
</documentOption>
<documentOption docRef="2">
<isHidden>false</isHidden>
</documentOption>
</documentOptions> |
Please see also a complete configuration here:
Expand | ||||
---|---|---|---|---|
| ||||
Code Block | | |||
|
Please see also a complete configuration here:
Note: This sample includes two recipients, the first recipient who can only view the first document, and the second recipient who can view both documents.
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Documents": [{ "FileId": "3c816859-06da-4223-b5ef-3b52a3af1c77", "DocumentNumber": 1 }, { "FileId": "92b37d56-cbe0-448e-9689-28daeeef07f3", "DocumentNumber": 2 } ], "Name": "Test", "Activities": [{ "Action": { "Sign": { "RecipientConfiguration": {<version>1.2.0.2</version> "ContactInformation": {<positionUnits>PdfUnits</positionUnits> <positionReferenceCorner>Lower_Left</positionReferenceCorner>
</signatureTemplate>
<senderInformation>
"Email": "johndoe@sample.com",<userInformation> <firstName>##NAME##</firstName>
"GivenName": "Jane",<lastName>##NAME##</lastName> <eMail>##EMAIL##</eMail>
</userInformation>"Surname": "Doe",</senderInformation> <receiverInformation>
<userInformation>
"LanguageCode": "EN"<firstName>##NAME##</firstName> <lastName>##NAME##</lastName>
},<eMail>##EMAIL##</eMail> </userInformation>
"PersonalMessage": "Please sign this<showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer> document asap!",</receiverInformation> <Agreements>
<text language=" enDisableEmail">Signature Disclosure Text</text> : false<text language="*">Signature Disclosure Text</text>
<heading language="en">Signature Disclosure Subject</heading>},<heading language="*">Signature Disclosure Subject</heading>
</Agreements>"Elements": {<pdfForms isEditingAllowed="1" />
<attachmentFields />
<TypewriterAnnotationTaskInfo />
"SequenceMode": "NoSequenceEnforced",<ViewerPreferences> <FinishWorkstepOnOpen>0</FinishWorkstepOnOpen> "Signatures": [{<SendVisibleArea allowedDomain="">0</SendVisibleArea>
</ViewerPreferences>
<Policy version="1.2.0.0">
"TaskConfiguration":<GeneralPolicies> {<AllowSaveDocument>1</AllowSaveDocument> <AllowSaveAuditTrail>1</AllowSaveAuditTrail> <AllowDownloadOfSignedP7MFiles>0</AllowDownloadOfSignedP7MFiles>"OrderDefinition": {<AllowRotatingPages>0</AllowRotatingPages> <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep> <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep> "OrderIndex": 0<AllowEmailDocument>1</AllowEmailDocument> <AllowPrintDocument>1</AllowPrintDocument>
<AllowFinishWorkstep>1</AllowFinishWorkstep>}<AllowRejectWorkstep>1</AllowRejectWorkstep> <AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
},<AllowUndoLastAction>1</AllowUndoLastAction> <AllowColorizePdfForms>0</AllowColorizePdfForms>
<AllowReloadOfFinishedWorkstep>1</AllowReloadOfFinishedWorkstep>
"Id": "ClickToSign one",<AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments> <AllowAdhocSignatures>0</AllowAdhocSignatures>
<AllowAdhocStampings>0</AllowAdhocStampings>
"Required": true,<AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations> <AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
<AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>"DocumentNumber": 1,<AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending> </GeneralPolicies>
<WorkstepTasks SequenceMode="NoSequenceEnforced">"DisplayName": "Sign here",<Task enabled="1" completed="0" required="0" id="ra" displayName="ra" DocRefNumber="2" type="ReadAgreement" finishPercentage="0" />
</WorkstepTasks>
"AllowedSignatureTypes": {<AdhocPolicies> <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
</AdhocPolicies>
<completedActions />"ClickToSign": {}<TaskTransactionIds /> <FeaturePolicies>
<UseCustomStampImprintConfiguration>1</UseCustomStampImprintConfiguration>},</FeaturePolicies> </Policy>
<resourceUris>
"FieldDefinition": {<delegationUri></delegationUri> </resourceUris>
<Navigation />
<timeCreated>2022-04-13T07:36:58.0017655Z</timeCreated>
<AuditingToolsConfiguration WriteAuditTrail=" 1Position"> : {<AuditTrailSignatureConfiguration> <SpcId>ltaLevelId_auditTrail</SpcId> <DocumentTimestamp enabled="PageNumber": 1"> ,<SpcId>ltaLevelId_auditTrail</SpcId> </DocumentTimestamp>
</AuditTrailSignatureConfiguration>
"X": 100,</AuditingToolsConfiguration> </workstepConfiguration>
<recipients>
<recipient>
<eMail>##EMAIL##</eMail>
<emailBodyExtra></emailBodyExtra>"Y": 200<firstName>##NAME##</firstName> <lastName>##NAME##</lastName>
<languageCode>en</languageCode>
},<disableEmail>false</disableEmail> <skipExternalDataValidation>false</skipExternalDataValidation>
<addAndroidAppLink>false</addAndroidAppLink>
<addIosAppLink>false</addIosAppLink>
"Size": {<addWindowsAppLink>false</addWindowsAppLink> <allowDelegation>true</allowDelegation>
<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
<authentications />
"Width": 100,<identifications />
</recipient>
</recipients>
</step>
<step>
<emailBodyExtra></emailBodyExtra>
<orderIndex>2</orderIndex>"Height": 70<recipientType>Signer</recipientType> <useDefaultAgreements>true</useDefaultAgreements>
<documentOptions>
<documentOption docRef="2">
<isHidden>true</isHidden>}</documentOption> <documentOption docRef="1">
<isHidden>false</isHidden>}</documentOption> </documentOptions>
<workstepConfiguration skipThirdPartyChecks="0">
<WorkstepLabel>test</WorkstepLabel>}<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent> <AbsoluteExpiryDate>2022-04-13T07:46:58.0797673Z</AbsoluteExpiryDate>
<WorkstepTimeToLiveInMinutes>43210</WorkstepTimeToLiveInMinutes>]<FinishAction /> <signatureTemplate>},<version>1.2.0.2</version> <positionUnits>PdfUnits</positionUnits> "SigningGroup": "firstSigner"<positionReferenceCorner>Lower_Left</positionReferenceCorner> }</signatureTemplate> <senderInformation>},<userInformation> "VisibilityOptions": [{<firstName>##NAME##</firstName> <lastName>##NAME##</lastName>"DocumentNumber": 2,<eMail>##EMAIL##</eMail> </userInformation>"IsHidden": true</senderInformation> <receiverInformation>}<userInformation> ] }, {<firstName>##NAME##</firstName> "Action": {<lastName>##NAME##</lastName> <eMail>##EMAIL##</eMail>"Sign": {</userInformation> <showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer> "RecipientConfiguration": {</receiverInformation> <Agreements>
"ContactInformation": {<text language="en">Signature Disclosure Text</text>
<text language="*">Signature Disclosure Text</text>
<heading language=" enEmail">Signature Disclosure Subject</heading> : "janedoe@sample.com",<heading language="*">Signature Disclosure Subject</heading>
</Agreements>
<pdfForms isEditingAllowed=" 1GivenName"/> : "Jane",<attachmentFields /> <TypewriterAnnotationTaskInfo />
<ViewerPreferences>"Surname": "Doe",<FinishWorkstepOnOpen>0</FinishWorkstepOnOpen> <SendVisibleArea allowedDomain="">0</SendVisibleArea>
</ViewerPreferences>"LanguageCode": "EN"<Policy version="1.2.0.0"> <GeneralPolicies>
},<AllowSaveDocument>1</AllowSaveDocument> <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
"PersonalMessage": "Please sign this<AllowDownloadOfSignedP7MFiles>0</AllowDownloadOfSignedP7MFiles> document asap!",<AllowRotatingPages>0</AllowRotatingPages> <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep> "DisableEmail": false<AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep> },<AllowEmailDocument>1</AllowEmailDocument> <AllowPrintDocument>1</AllowPrintDocument>"Elements": {<AllowFinishWorkstep>1</AllowFinishWorkstep> <AllowRejectWorkstep>1</AllowRejectWorkstep>
"SequenceMode": "NoSequenceEnforced",<AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation> <AllowUndoLastAction>1</AllowUndoLastAction>
"Signatures": [{<AllowColorizePdfForms>0</AllowColorizePdfForms> <AllowReloadOfFinishedWorkstep>1</AllowReloadOfFinishedWorkstep>
<AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>"TaskConfiguration": {<AllowAdhocSignatures>0</AllowAdhocSignatures> <AllowAdhocStampings>0</AllowAdhocStampings> <AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>"OrderDefinition": {<AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations> <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
<AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
"OrderIndex": 1</GeneralPolicies> <WorkstepTasks SequenceMode="NoSequenceEnforced">
<Task enabled="1" completed="0" required="0" id="ra" displayName="ra" DocRefNumber="1" type="ReadAgreement" finishPercentage="0" />}</WorkstepTasks> <AdhocPolicies>
<AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>},</AdhocPolicies> <completedActions />
<TaskTransactionIds />"Id": "clickToSign two",<FeaturePolicies> <UseCustomStampImprintConfiguration>1</UseCustomStampImprintConfiguration> "Required": true,</FeaturePolicies> </Policy>
<resourceUris>
<delegationUri></delegationUri>"DocumentNumber": 2,</resourceUris> <Navigation />
<timeCreated>2022-04-13T07:36:58.0877647Z</timeCreated>
<AuditingToolsConfiguration WriteAuditTrail="1">"DisplayName": "Sign here",<AuditTrailSignatureConfiguration> <SpcId>ltaLevelId_auditTrail</SpcId>
<DocumentTimestamp enabled="1">"AllowedSignatureTypes": {<SpcId>ltaLevelId_auditTrail</SpcId> </DocumentTimestamp> </AuditTrailSignatureConfiguration>
"ClickToSign": {}</AuditingToolsConfiguration> </workstepConfiguration>
<recipients>
<recipient>},<eMail>##EMAIL##</eMail> <emailBodyExtra></emailBodyExtra>
<firstName>##NAME##</firstName>
"FieldDefinition": {<lastName>##NAME##</lastName> <languageCode>en</languageCode>
<disableEmail>false</disableEmail>
<skipExternalDataValidation>false</skipExternalDataValidation>"Position": {<addAndroidAppLink>false</addAndroidAppLink> <addIosAppLink>false</addIosAppLink> <addWindowsAppLink>false</addWindowsAppLink>
<allowDelegation>true</allowDelegation>
"PageNumber": 1,<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep> <authentications />
<identifications />
</recipient>
"X": 100,</recipients> </step>
<step>
<emailBodyExtra></emailBodyExtra>
<orderIndex>3</orderIndex>
<recipientType>Cc</recipientType>
<useDefaultAgreements>false</useDefaultAgreements>"Y": 200<recipients> <recipient>
<eMail>##EMAIL##</eMail>
<emailBodyExtra></emailBodyExtra>
},<firstName>##NAME##</firstName> <lastName>##NAME##</lastName>
<languageCode>en</languageCode>
<disableEmail>false</disableEmail>"Size": {<skipExternalDataValidation>false</skipExternalDataValidation> <addAndroidAppLink>false</addAndroidAppLink> <addIosAppLink>false</addIosAppLink>
<addWindowsAppLink>false</addWindowsAppLink>"Width": 100,<allowDelegation>false</allowDelegation> <authentications />
<identifications />
</recipient>"Height": 70</recipients> </step>
<step>
<emailBodyExtra></emailBodyExtra>
<orderIndex>4</orderIndex>
<recipientType>Cc</recipientType>
<useDefaultAgreements>false</useDefaultAgreements>}<recipients> <recipient>
<eMail>##EMAIL##</eMail>
<emailBodyExtra></emailBodyExtra>}<firstName>Team</firstName> <lastName>Member 2</lastName>
}<languageCode>en</languageCode> <disableEmail>false</disableEmail>
<skipExternalDataValidation>false</skipExternalDataValidation>]<addAndroidAppLink>false</addAndroidAppLink> <addIosAppLink>false</addIosAppLink>},<addWindowsAppLink>false</addWindowsAppLink> <allowDelegation>false</allowDelegation>"SigningGroup": "secondSigner"<authentications />
}<identifications />
</recipient>}</recipients> }</step>
</steps>
<attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope>]
} |