v1

latestSwagger 2.02026-07-134146194.6 MB
DocumentGeneration

Returns sender fields for an envelope.

Given an envelopeId, this method returns the sender fields found in that envelope's documents. After you retrieve the sender fields, use the DocumentGeneration::updateEnvelopeDocGenFormFields method to populate the fields.

If the specified envelope does not contain a document with sender fields, the method will return success (200) and an empty object ({}) in the response.

Next steps

  • Learn about document generation in the eSignature concepts guide.
  • Learn how to send an envelope with document generation in your preferred coding language.
get/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Response

Successful response.