...
- envelope with hashed of document
- send notifications and recipient addresses
- authentication (PIN, SMS-OTP, etc.)
- reader’s IP addresses
- reader’s location
- date & time of actions
- actions on the document/envelope: page open & view, confirmations, form field edits, signatures and many more
The following sample shows the structure of the audit trail xml:
Code Block |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<AuditTrail Version="1" CreationDate="2018-10-01T13:07:21.2795797Z">
<EnvelopeId>[Envelope ID]</EnvelopeId>
<EnvelopeName>[Envelope Name]</EnvelopeName>
<EnvelopeStatus>[Envelope Status - possible values: Completed]</EnvelopeStatus> <!-- note: at the moment, the Audit Trail is only generated for completed envelopes -->
<EnvelopeCreationDate>[Create Date, e.g. 2018-10-01T13:05:10.927Z]</EnvelopeCreationDate>
<EnvelopeSendDate>[Send Date, e.g. 2018-10-01T13:06:21.13Z]</EnvelopeSendDate>
<EnvelopeExpirationDate>[Expiration Date, e.g. 2018-10-29T13:06:21.13Z]</EnvelopeExpirationDate>
<Sender>
<FirstName>[Sender First Name]</FirstName>
<LastName>[Sender Last Name]</LastName>
<EMail>[Sender E-Mail]</EMail>
</Sender>
<ElectronicDisclosures>
<!-- list of "Disclosure" elements (see below) -->
</ElectronicDisclosures>
<Recipients>
<!-- list of "Recipient" elements (see below) -->
</Recipients>
<Notifications>
<!-- list of "Notification" elements (see below) -->
</Notifications>
<SendFinishedDocuments>[true|false]</SendFinishedDocuments>
<PreventMailSending>[true|false]</PreventMailSending>
</AuditTrail> |
Electronic Disclosures
Code Block |
---|
|
<Disclosure Culture="[language ISO code, e.g. de, de-AT]">
<Subject>[Message Subject]</Subject>
<Text>[Message Body]</Text>
</Disclosure> |
Recipients
General
Code Block |
---|
|
<Recipient Id="[Recipient ID]" OrderIndex="[Recipient OrderIndex]" EMail="[Recipient E-Mail]" Deleted="[true|false]">
<FirstName>[Recipient FirstName]</FirstName>
<SealingProfileName />
<LastName>[Recipient LastName]</LastName>
<Type>[Recipient Type, possible values see below]</Type>
<FinishDate>[Finish Date, e.g. 2018-10-01T14:01:32.6354943Z]</FinishDate>
<Status>[Recipient Status, possible values see below]</Status>
<RejectReason>[Reject/Delegate reason]</RejectReason>
<WorkstepId>[Workstep ID]</WorkstepId>
<History>
<!-- list of "Entry" elements (see below) - info about previous changes of this recipients -->
</History>
<AuthenticationMethods>
<!-- list of "AuthenticationMethod" elements (see below) -->
</AuthenticationMethods>
<MailSubject>[Mail Message Subject]<MailSubject>
<MailContent>[Mail Message Content]<MailContent>
<DelegatorId>[OPTIONAL: Recipient ID of the delegator recipient]</DelegatorId>
<DelegateeId>[OPTIONAL: Recipient ID of the delegatee recipient]</DelegateeId>
<WorkStepInformation><!-- OPTIONAL: Workstep Information XML - details see below --></WorkStepInformation>
<auditTrail><!-- OPTIONAL: Workstep Audit Trail XML - details see below --></auditTrail>
<PreventMailSending>[true|false]</PreventMailSending>
</Recipient> |
Values for Type:
- Signer
- CC
- Acknowledge
- Pkcs7Signer
- Automatic
Values for Status
- NotSigned
- Signed
- Rejected
- Delegated
- DelegatedAutomated
History
Code Block |
---|
|
<Entry ValidFrom="[When was this recipient setting valid? e.g. 2018-10-01T14:00:41.54Z]" ValidTo="[When was this recipient setting valid? e.g. 9999-12-31T23:59:59.9999999Z]">
<FirstName>[FirstName]</FirstName>
<LastName>[LastName]</LastName>
<EMail>[E-Mail]</EMail>
<Modifications>
<!-- List of "Modification" elements -->
<Modification>[Modification]</Modification>
</Modifications>
</Entry> |
Values for Modification:
- RenameEmail
- RenameRecipientName
- RestartEnvelope
- RenameRecipientFirstName
- RenameRecipientLastName
- RenameRecipientMessage
- ChangeAuthenticationSms
- ChangeAuthenticationLive
- ChangeAuthenticationPin
- AddedAuthenticationSms
- AddedAuthenticationLive
- AddedAuthenticationPin
- RemovedAuthenticationSms
- RemovedAuthenticationLive
- RemovedAuthenticationPin
- ChangeRecipientCulture
- ChangedRecipientDisposableCertificateData
- ChangedRecipientRemoteSignatureData
- ChangeAuthenticationOAuth
- AddedAuthenticationOAuth
- RemovedAuthenticationOAuth
- RecipientDeleted
- ChangeAuthenticationSaml
- AddedAuthenticationSaml
- RemovedAuthenticationSaml
- ChangedRecipientOtpSignatureData
- ChangedRecipientPkcs7SignerData
- ChangedRecipientSwissComCertificateData
Authentication
<AuthenticationMethod>[Authentication Method]</AuthenticationMethod>
Values for AuthenticationMethod:
- Pin
- Sms
- WindowsLive
- CustomOAuthProvider
- CustomSamlProvider
Notifications
Code Block |
---|
|
<Notification Type="[Notification Type - possible values see below]" Added="[Added Date, e.g. 2018-10-01T14:01:32.6354943Z]" Sent="[Added Date, e.g. 2018-10-01T14:01:32.6354943Z]" Recipient="[OPTIONAL - Recipient ID">
<ExtraInformation />
</Notification> |
Values for Type
- SendSignNotificationToRecipient
- SendAcknowledgeNotificationToRecipient
- RecipientChanged
- EnvelopeFinished
- SendCcDocs
- SendCcDocsWithDownloadLink
- SendCcDocsNoLink
- SendCcDocsNoLinkWithDownloadLink
- EnvelopeParallelSigned
- DelegationAutomatic
- DelegationManual
- SendSignNotificationToRecipientWithDelegation,
- AutomatedDelegationNotification
How to define the signature of the recipient (Saw-Viewer)
...