Docusign · Schema

Envelope

Contains the properties of an envelope.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name	Type	Description
envelopeId	string	The unique identifier of the envelope.
envelopeUri	string	The URI for retrieving the envelope.
status	string	Current status of the envelope.
statusChangedDateTime	string	The date and time the status last changed.
emailSubject	string	The subject line of the envelope email.
emailBlurb	string	The body text of the envelope email.
createdDateTime	string	The date and time the envelope was created.
sentDateTime	string	The date and time the envelope was sent.
deliveredDateTime	string	The date and time the envelope was delivered.
completedDateTime	string	The date and time the envelope was completed.
voidedDateTime	string	The date and time the envelope was voided.
voidedReason	string	The reason the envelope was voided.
declinedDateTime	string	The date and time the envelope was declined.
documents	array
purgeState	string	Purge state of the envelope.
brandId	string	The ID of the brand applied to the envelope.
certificateUri	string	URI for retrieving the certificate of completion.
isSignatureProviderEnvelope	string	Whether this envelope uses a signature provider.
signingLocation	string	The signing location. Valid values are inPerson and online.
expireEnabled	string	Whether the envelope expiration is enabled.
expireDateTime	string	The date and time the envelope expires.
expireAfter	string	Number of days after which the envelope expires.
autoNavigation	string	Whether auto-navigation is enabled for recipients.
anySigner	string	Reserved for DocuSign use.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Envelope",
  "type": "object",
  "description": "Contains the properties of an envelope.",
  "properties": {
    "envelopeId": {
      "type": "string",
      "description": "The unique identifier of the envelope."
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope."
    },
    "status": {
      "type": "string",
      "description": "Current status of the envelope."
    },
    "statusChangedDateTime": {
      "type": "string",
      "description": "The date and time the status last changed."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the envelope email."
    },
    "emailBlurb": {
      "type": "string",
      "description": "The body text of the envelope email."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The date and time the envelope was created."
    },
    "sentDateTime": {
      "type": "string",
      "description": "The date and time the envelope was sent."
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time the envelope was delivered."
    },
    "completedDateTime": {
      "type": "string",
      "description": "The date and time the envelope was completed."
    },
    "voidedDateTime": {
      "type": "string",
      "description": "The date and time the envelope was voided."
    },
    "voidedReason": {
      "type": "string",
      "description": "The reason the envelope was voided."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the envelope was declined."
    },
    "documents": {
      "type": "array"
    },
    "purgeState": {
      "type": "string",
      "description": "Purge state of the envelope."
    },
    "brandId": {
      "type": "string",
      "description": "The ID of the brand applied to the envelope."
    },
    "certificateUri": {
      "type": "string",
      "description": "URI for retrieving the certificate of completion."
    },
    "isSignatureProviderEnvelope": {
      "type": "string",
      "description": "Whether this envelope uses a signature provider."
    },
    "signingLocation": {
      "type": "string",
      "description": "The signing location. Valid values are inPerson and online."
    },
    "expireEnabled": {
      "type": "string",
      "description": "Whether the envelope expiration is enabled."
    },
    "expireDateTime": {
      "type": "string",
      "description": "The date and time the envelope expires."
    },
    "expireAfter": {
      "type": "string",
      "description": "Number of days after which the envelope expires."
    },
    "autoNavigation": {
      "type": "string",
      "description": "Whether auto-navigation is enabled for recipients."
    },
    "anySigner": {
      "type": "string",
      "description": "Reserved for DocuSign use."
    }
  }
}