Envelopes: getRecipientSignature

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

Request

HTTP request

GET /v2/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. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

recipientIdstring

The recipientId used when the envelope or template was created.

Responses

CodeDescriptionReference
200

Successful response.

UserSignatures
400

Error encountered.

errorDetails

SDK Method

Envelopes::getRecipientSignature

Definitions

dateStampProperties

dateAreaHeightstring

dateAreaWidthstring

dateAreaXstring

dateAreaYstring

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

UserSignatures

Users' signatures

adoptedDateTimestring

The date and time the user adopted their signature.

createdDateTimestring

Indicates the date and time the item was created.

dateStampPropertiesdateStampProperties

errorDetailserrorDetails

externalIDstring

imageTypestring

One of signature_image or initials_image.

initials150ImageIdstring

initialsImageUristring

Contains the URI for an endpoint that you can use to retrieve the initials image.

isDefaultstring

phoneticNamestring

signature150ImageIdstring

signatureFontstring

The font type for the signature, if the signature is not drawn. The supported font types are:

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

signatureIdstring

Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the signatureName property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.

signatureImageUristring

Contains the URI for an endpoint that you can use to retrieve the signature image.

signatureInitialsstring

The initials associated with the signature.

signatureNamestring

Specifies the user signature name.

signatureTypestring

stampFormatstring

stampImageUristring

stampSizeMMstring

stampTypestring

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> 
}} />