EnvelopeAppliance: getApplianceInfo

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.

The envelope's GUID.

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

An array of page objects.

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.

The unique id of the page.

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.

The envelope's GUID.

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

The status of the item.

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.

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.

The height of the tab in pixels.

The unique id of the page.

The width of the tab in pixels.

The name of the user's company.

Reserved for DocuSign.

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.

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.

The name of the user.

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

The code associated with the error condition.

A brief message describing the error condition.