__INITIALS__
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info
Parameter Name | Value | Description |
---|---|---|
Path Parameters | ||
accountId | string | The external account number (int) or account ID GUID. |
envelopeId | string | The envelope's GUID. Example: |
Code | Description | Reference |
---|---|---|
200 | Successful response. | EnvelopeAppliance |
400 | Error encountered. | errorDetails |
attachmentDescription | string | |
documentId | string | The |
documentType | string | |
envelopeId | string | The envelope's GUID. Example: |
externalDocumentId | string | |
latestPDFId | string | |
name | string | |
pages | integer | An array of page objects. |
docPageCountTotal | integer | |
documentId | string | The |
documentName | string | |
extension | string | |
height72DPI | integer | |
isAttachmentType | boolean | |
page | integer | |
pageId | string | The unique id of the page. |
type | string | |
width72DPI | integer |
addDemoStamp | boolean | |
allowMultipleAttachments | boolean | |
burnDefaultTabData | boolean | |
convertPdfFields | boolean | 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. |
envelopeId | string | The envelope's GUID. Example: |
envelopeType | string | |
includeSigsBeforeComplete | boolean | |
isConcatMode | boolean | |
isEnvelopeIDStampingEnabled | boolean | |
pdfFormConversionFontScale100 | boolean | |
shouldFlatten | boolean | |
showEnvelopeChanges | boolean | |
signOnline | boolean | |
status | string | The status of the item. |
userId | string | 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, |
documentId | string | The |
documentName | string | |
externalDocumentId | string | |
height | integer | The height of the tab in pixels. |
isFirstPage | boolean | |
pageId | string | The unique id of the page. |
pageNo | integer | |
pageStatus | string | |
pageType | string | |
width | integer | The width of the tab in pixels. |
cfrPart11 | boolean | |
company | string | The name of the user's company. |
digitalSignatureBase64 | string | |
email | string | |
fullName | string | Reserved for DocuSign. |
initialsBase64 | string | |
inPersonEmail | string | |
isNotary | boolean | |
notarySealBase64 | string | |
phoneNumber | string | |
recipientCompleteCount | integer | |
recipientGuidId | string | |
recipientId | string | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
recipientStatus | string | |
recipientType | string | The recipient type, as specified by the following values:
|
rowState | string | |
signatureBase64 | string | |
signed | boolean | |
signerApplyTabs | boolean | |
signerAttachmentBase64 | string | |
userName | string | The name of the user. |
This object describes errors that occur. It is only valid for responses and ignored in requests. | ||
errorCode | string | The code associated with the error condition. |
message | string | A brief message describing the error condition. |
documentData | [displayApplianceDocument] | |
documentPages | [displayApplianceDocumentPage] | |
envelopeData | displayApplianceEnvelope | |
pageData | [displayAppliancePage] | |
recipientData | [displayApplianceRecipient] |