Skip to navigation

Rules for Accessing Envelope Events

View as Markdown

API user specific rules

  • The envelope ID passed to the API must be valid.
  • The envelope ID passed to the API must be accessible by the API user.
  • The user and account must be configured properly by Docusign in order to enable this API.

Rules for Exceptions thrown by the EnvelopeAuditEvents API

  • Envelope_Does_Not_Exist – invalid envelope ID passed.
  • User_Lacks_Permissions - The user making the API calls must have permissions to export Authoritative Copy Documents.

Return XML for EnvelopeAuditEvents API

Below is a sample of the XML returned:

<DocusignEnvelopeEvents EnvelopeId="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" xmlns="">
<Event>
<logTime>2008-02-12T16:52:00.6430736-08:00</logTime>
<Source>Web</Source>
<UserName>User name here</UserName>
<Action>Registered</Action>
<Message>The envelope was created by SS UI and API</Message>
<EnvelopeStatus>Created</EnvelopeStatus>
<ClientIPAddress>127.0.0.1</ClientIPAddress>
<Information />
</Event>
<Event>
<logTime>2008-02-12T16:52:52.0519556-08:00</logTime>
<Source>Web</Source>
<UserName>The User</UserName>
<Action>Sent Invitations</Action>
<Message>The User sent an invitation to User email[the.user@docusign.com]</Message>
<EnvelopeStatus>Sent</EnvelopeStatus>
<ClientIPAddress>127.0.0.1</ClientIPAddress>
<Information>User email[the.user@docusign.com]</Information>
</Event>
</DocusignEnvelopeEvents>