EnvelopeAppliance: getPdfBlob

Request

HTTP request

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

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.

displayAppliancePdf
400

Error encountered.

errorDetails

SDK Method

Envelopes::getAppliancePdfBlob

Definitions

displayAppliancePdf

attachmentInfodisplayApplianceSignerAttachment

docNamestring

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.

latestPdfstring

latestPDFIdstring

originalPdfstring

originalPDFIdstring

pageCountinteger

An integer value specifying the number of document pages in the template.

pdfTypestring

displayApplianceSignerAttachment

attachmentDescriptionstring

attachmentTabIdstring

If this document is an attachment to another document in the envelope, this is the id of the attachment tab it is associated with on the other document.

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.

envelopeIdstring

The envelope's GUID.

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

pageCountinteger

An integer value specifying the number of document pages in the template.

pageIdstring

The unique id of the page.

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.

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.

}} />