Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeLocks

Gets envelope lock information.

Retrieves general information about an envelope lock.

The user requesting the information must be the same user who locked the envelope.

You can use this method to recover the lock information, including the lockToken, for a locked envelope. The X-DocuSign-Edit header is included in the response.

See EnvelopeLocks: create for a description of the X-DocuSign-Edit header.

Related topics

get/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock

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.