RequestEnvelope

The RequestEnvelope call returns an API Envelope object containing all the data of an envelope. The envelope must be owned by the API user.

// Create and send envelope as shown in linked code
DocuSignWeb.EnvelopeStatus status = <create and send envelope>;
// Call to request the envelope with the envelope's ID
DocuSignWeb.Envelope returnEnvelope = _apiClient.RequestEnvelope(status.EnvelopeID, false);
// Display information about the return envelope
Console.WriteLine("Return envelope has a subject of \"{0}\"", returnEnvelope.Subject);

The response to the RequestEnvelope call is:

Additional Errors for RequestEnvelope

In addition to the normal authentication check errors, the following error is also added.

• User_Lacks-Permissions – The user does not own have permission to access the envelope.
• Envelope_Does_Not_Exist – Invalid envelope ID passed.

Schema for RequestEnvelope

  <xs:element name="RequestEnvelope">
    <xs:complexType>
      <xs:all>
        <xs:element name="EnvelopeID" type="dsx:DSXId" />
        <xs:element name="IncludeDocumentBytes" type="xs:boolean" />
      </xs:all>
    </xs:complexType>
  </xs:element>