Envelopes: getRecipientSignature

Retrieves signature information for a signer or sign-in-person recipient.

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature

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

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.

Responses

CodeDescriptionReference
200

Successful response.

UserSignatures
400

Error encountered.

errorDetails

SDK Method

Envelopes::getRecipientSignature

Definitions

dateStampProperties

Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.

This property contains the following information about the central rectangle:

  • DateAreaX: The X axis position of the top-left corner.
  • DateAreaY: The Y axis position of the top-left corner.
  • DateAreaWidth: The width of the rectangle.
  • DateAreaHeight: The height of the rectangle.

dateAreaHeightstring

The height of the rectangle.

dateAreaWidthstring

The width of the rectangle.

dateAreaXstring

The X axis position of the top-left corner.

dateAreaYstring

The Y axis position of the top-left corner.

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.

UserSignatures

Users' signatures

adoptedDateTimestring

The UTC date and time when the user adopted the signature.

createdDateTimestring

The UTC date and time when the user created the signature.

customFieldstring

Serialized information about any custom eHanko stamps that have been ordered from an eHanko provider, including the order status, purchase order id, time created, and time modified.

dateStampPropertiesdateStampProperties

Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.

This property contains the following information about the central rectangle:

  • DateAreaX: The X axis position of the top-left corner.
  • DateAreaY: The Y axis position of the top-left corner.
  • DateAreaWidth: The width of the rectangle.
  • DateAreaHeight: The height of the rectangle.

disallowUserResizeStampstring

When set to true, users may not resize the stamp.

errorDetailserrorDetails

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

externalIDstring

An external ID for the signature or stamp.

Note: If a recipient uses a stamp instead of a signature, this is the stamp vendor's serial number for the stamp.

imageBase64string

A Base64-encoded representation of the signature image.

imageTypestring

The format of the signature image, such as:

  • GIF
  • PNG
  • JPG
  • PDF
  • BMP

initials150ImageIdstring

The ID of the user's initials image.

initialsImageUristring

The URI for retrieving the image of the user's initials.

isDefaultstring

Boolean that specifies whether the signature is the default signature for the user.

lastModifiedDateTimestring

The UTC date and time when the signature was last modified.

nrdsIdstring

The National Association of Realtors (NAR) membership ID for a user who is a realtor.

nrdsLastNamestring

The realtor's last name.

nrdsStatusstring

The realtor's NAR membership status. The value active verifies that the user is a current NAR member. Valid values are:

  • Active
  • Inactive
  • Terminate
  • Provisional
  • Deceased
  • Suspend
  • Unknown

phoneticNamestring

The phonetic spelling of the signatureName.

signature150ImageIdstring

The ID of the user's signature image.

signatureFontstring

The font type to use for the signature if the signature is not drawn. The following font types are supported:

  • 1_DocuSign
  • 2_DocuSign
  • 3_DocuSign
  • 4_DocuSign
  • 5_DocuSign
  • 6_DocuSign
  • 7_DocuSign
  • 8_DocuSign
  • Mistral
  • Rage Italic

signatureIdstring

The ID associated with the signature name. You can use this property in the URI in place of the signature name. This enables the use of special characters (such as "&", "<", and ">") in a signature name.

Note: When you update a signature, its signature ID might change. In that case you need to use signatureName to get the new signatureId.

signatureImageUristring

An endpoint URI that you can use to retrieve the user's signature image.

signatureInitialsstring

The initials associated with the signature.

signatureNamestring

Specifies the user's signature name.

signatureRightsstring

The rights that the user has to the signature. Valid values are:

  • none
  • read
  • admin

signatureTypestring

Specifies the type of signature. Possible values include:

  • RubberStamp: A DocuSign pre-formatted signature style. This is the default value.
  • Imported: A signature image that the user uploaded.
  • Drawn: A freehand drawing of the user's signature and initials.

stampFormatstring

The format of a stamp. Valid values are:

  • NameHanko: The stamp represents only the signer's name.
  • NameDateHanko: The stamp represents the signer's name and the date.

stampImageUristring

The URI for retrieving the image of the user's stamp.

stampSizeMMstring

The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.

stampTypestring

The type of stamp. Valid values are:

  • signature: A signature image. This is the default value.
  • stamp: A stamp image.
  • null

Examples

Generic JSON Response

Response
{
  "signatureId": "sample string 1",
  "stampType": "sample string 2",
  "phoneticName": "sample string 3",
  "imageType": "sample string 4",
  "externalID": "sample string 5",
  "stampSizeMM": "sample string 6",
  "stampFormat": "sample string 7",
  "dateStampProperties": {
    "dateAreaX": "sample string 1",
    "dateAreaY": "sample string 2",
    "dateAreaWidth": "sample string 3",
    "dateAreaHeight": "sample string 4"
  },
  "stampImageUri": "sample string 8",
  "signatureFont": "sample string 9",
  "signatureType": "sample string 10",
  "signatureName": "sample string 11",
  "signatureImageUri": "sample string 12",
  "signatureInitials": "sample string 13",
  "initialsImageUri": "sample string 14",
  "createdDateTime": "sample string 15",
  "adoptedDateTime": "sample string 16",
  "signature150ImageId": "sample string 17",
  "initials150ImageId": "sample string 18",
  "isDefault": "sample string 19",
  "errorDetails": {
    "errorCode": "sample string 1",
    "message": "sample string 2"
  }
}
Generic XML Response

Response
<userSignature xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <adoptedDateTime>sample string 16</adoptedDateTime>
  <createdDateTime>sample string 15</createdDateTime>
  <dateStampProperties>
    <dateAreaHeight>sample string 4</dateAreaHeight>
    <dateAreaWidth>sample string 3</dateAreaWidth>
    <dateAreaX>sample string 1</dateAreaX>
    <dateAreaY>sample string 2</dateAreaY>
  </dateStampProperties>
  <errorDetails>
    <errorCode>sample string 1</errorCode>
    <message>sample string 2</message>
  </errorDetails>
  <externalID>sample string 5</externalID>
  <imageType>sample string 4</imageType>
  <initials150ImageId>sample string 18</initials150ImageId>
  <initialsImageUri>sample string 14</initialsImageUri>
  <isDefault>sample string 19</isDefault>
  <phoneticName>sample string 3</phoneticName>
  <signature150ImageId>sample string 17</signature150ImageId>
  <signatureFont>sample string 9</signatureFont>
  <signatureId>sample string 1</signatureId>
  <signatureImageUri>sample string 12</signatureImageUri>
  <signatureInitials>sample string 13</signatureInitials>
  <signatureName>sample string 11</signatureName>
  <signatureType>sample string 10</signatureType>
  <stampFormat>sample string 7</stampFormat>
  <stampImageUri>sample string 8</stampImageUri>
  <stampSizeMM>sample string 6</stampSizeMM>
  <stampType>sample string 2</stampType>
</userSignature> 
}} />