Skip to navigation
Docusign eSignature REST APIAccounts

AccountSignatures Resource

View as Markdown

In certain countries, stamps are used to certify documents. This resource provides methods to manage stamps available in your account.

To use these endpoints, your account must have Managed Stamps enabled. Contact your Docusign account manager for more information.

Methods supported

MethodDescription
createAccountSignaturesPOST /restapi/v2.1/accounts/{accountId}/signatures
Adds or updates one or more account stamps.
deleteAccountSignatureDEL /restapi/v2.1/accounts/{accountId}/signatures/{signatureId}
Deletes an account stamp.
deleteAccountSignatureImageDEL /restapi/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
Deletes the image for a stamp.
getAccountSignatureGET /restapi/v2.1/accounts/{accountId}/signatures/{signatureId}
Returns information about the specified stamp.
getAccountSignatureImageGET /restapi/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
Returns the image for an account stamp.
getAccountSignaturesGET /restapi/v2.1/accounts/{accountId}/signatures
Returns a list of stamps available in the account.
updateAccountSignaturePUT /restapi/v2.1/accounts/{accountId}/signatures
Updates an account stamp.
updateAccountSignatureByIdPUT /restapi/v2.1/accounts/{accountId}/signatures/{signatureId}
Updates an account stamp by ID.
updateAccountSignatureImagePUT /restapi/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
Sets a signature image, initials, or stamp.

AccountSignatures properties

PropertyTypeDescription
adoptedDateTimestringThe UTC date and time when the user adopted the signature.
createdDateTimestringThe UTC DateTime when the item was created.
customFieldstring
dateStampPropertiesdateStampPropertiesSpecifies 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.
disallowUserResizeStampstringWhen true, users may not resize the stamp.
errorDetailserrorDetailsThis object describes errors that occur. It is only valid for responses and ignored in requests.
externalIDstringOptionally specify an external identifier for the user’s signature.
imageBase64string
imageTypestringSpecificies the type of image. Valid values:
  • stamp_image
  • signature_image
  • initials_image
initials150ImageIdstringThe ID of the user’s initials image.
initialsImageUristringThe URI for retrieving the image of the user’s initials.
isDefaultstringBoolean that specifies whether the signature is the default signature for the user.
lastModifiedDateTimestringThe date and time that the item was last modified.
nrdsIdstringThe National Association of Realtors (NAR) membership ID for a user who is a realtor.
nrdsLastNamestringThe realtor’s last name.
nrdsStatusstringThe 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
phoneticNamestringThe phonetic spelling of the signatureName.
signature150ImageIdstringThe ID of the user’s signature image.
signatureFontstringThe font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not enums.
  • "1_DocuSign"
  • "2_DocuSign"
  • "3_DocuSign"
  • "4_DocuSign"
  • "5_DocuSign"
  • "6_DocuSign"
  • "7_DocuSign"
  • "8_DocuSign"
  • "Mistral"
  • "Rage Italic"
signatureGroupsarray
signatureIdstringSpecifies 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.
signatureImageUristringAn endpoint URI that you can use to retrieve the user’s signature image.
signatureInitialsstringSpecifies the user’s signature in initials format.
signatureNamestringSpecifies the user’s signature name.
signatureRightsstringThe rights that the user has to the signature. Valid values are:
  • none
  • read
  • admin
signatureTypestringSpecifies the type of signature.
signatureUsersarray
stampFormatstringThe 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.
stampImageUristringThe URI for retrieving the image of the user’s stamp.
stampSizeMMstringThe physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
stampTypestringThe type of stamp. Valid values are:
  • signature: A signature image. This is the default value.
  • stamp: A stamp image.
  • null
statusstringIndicates the envelope status. Valid values are:
  • sent - The envelope is sent to the recipients.
  • created - The envelope is saved as a draft and can be modified and sent later.