EnvelopeAppliance: getDocumentPage

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeAppliance
400

Error encountered.

errorDetails

SDK Method

Envelopes::getApplianceDocumentPage

Definitions

displayApplianceDocument

attachmentDescriptionstring

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentTypestring

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

externalDocumentIdstring

latestPDFIdstring

namestring

pagesinteger

An array of page objects.

displayApplianceDocumentPage

docPageCountTotalinteger

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentNamestring

extensionstring

height72DPIinteger

isAttachmentTypeboolean

pageinteger

pageIdstring

The unique id of the page.

typestring

width72DPIinteger

displayApplianceEnvelope

addDemoStampboolean

allowMultipleAttachmentsboolean

burnDefaultTabDataboolean

convertPdfFieldsboolean

Boolean that specifies whether to enable PDF form fields to get converted to DocuSign secure fields when the document is added or uploaded to an envelope.

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

envelopeTypestring

includeSigsBeforeCompleteboolean

isConcatModeboolean

isEnvelopeIDStampingEnabledboolean

pdfFormConversionFontScale100boolean

shouldFlattenboolean

showEnvelopeChangesboolean

signOnlineboolean

statusstring

The status of the item.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

displayAppliancePage

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

documentNamestring

externalDocumentIdstring

heightinteger

The height of the tab in pixels.

isFirstPageboolean

pageIdstring

The unique id of the page.

pageNointeger

pageStatusstring

pageTypestring

widthinteger

The width of the tab in pixels.

displayApplianceRecipient

cfrPart11boolean

companystring

The name of the user's company.

digitalSignatureBase64string

emailstring

fullNamestring

Reserved for DocuSign.

initialsBase64string

inPersonEmailstring

isNotaryboolean

notarySealBase64string

phoneNumberstring

recipientCompleteCountinteger

recipientGuidIdstring

recipientIdstring

A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

recipientStatusstring

recipientTypestring

The recipient type, as specified by the following values:

  • agent: Agent recipients can add name and email information for recipients that appear after the agent in routing order.
  • carbonCopy: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.
  • certifiedDelivery: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.
  • editor: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.
  • inPersonSigner: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.
  • intermediaries: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.
  • seal: Electronic seal recipients represent legal entities.
  • signer: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.
  • witness: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.

rowStatestring

signatureBase64string

signedboolean

signerApplyTabsboolean

signerAttachmentBase64string

userNamestring

The name of the user.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

EnvelopeAppliance
}} />