Retrieves general information about the envelope lock.

If the call is made by the locked by user and the request has the same integrator key as original, then the X-DocuSign-Edit header and additional lock information is included in the response. This allows users to recover a lost editing session token and the X-DocuSign-Edit header.

Request

HTTP request

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeLocks
400

Error encountered.

errorDetails

SDK Method

Envelopes::getLock

Definitions

errorDetails
userInfo
EnvelopeLocks

Examples

Generic JSON Response
Generic XML Response