Skip to navigation

UserSignatures Resource

View as Markdown

The UserSignatures resource provides methods that allow you manage the initials and signature images for a user.

Methods supported

MethodDescription
createPOST /restapi/v2/accounts/{accountId}/users/{userId}/signatures
Adds user Signature and initials images to a Signature.
deleteDEL /restapi/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}
Removes removes signature information for the specified user.
deleteImageDEL /restapi/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
Deletes the user initials image or the user signature image for the specified user.
getGET /restapi/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}
Gets the user signature information for the specified user.
getImageGET /restapi/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
Retrieves the user initials image or the user signature image for the specified user.
listGET /restapi/v2/accounts/{accountId}/users/{userId}/signatures
Retrieves a list of user signature definitions for a specified user.
updatePUT /restapi/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}
Updates the user signature for a specified user.
updateImagePUT /restapi/v2/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}
Updates the user signature image or user initials image for the specified user.
updateListPUT /restapi/v2/accounts/{accountId}/users/{userId}/signatures
Adds/updates a user signature.

UserSignatures properties

PropertyTypeDescription
adoptedDateTimestringThe date and time the user adopted their signature.
createdDateTimestringIndicates the date and time the item was created.
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.
errorDetailserrorDetailsArray or errors.
externalIDstring
imageTypestring
initials150ImageIdstring
initialsImageUristringContains the URI for an endpoint that you can use to retrieve the initials image.
isDefaultstring
phoneticNamestring
signature150ImageIdstring
signatureFontstringThe 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”
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.
signatureImageUristringContains the URI for an endpoint that you can use to retrieve the signature image.
signatureInitialsstringThe initials associated with the signature.
signatureNamestringSpecifies the user signature name.
signatureTypestring
stampFormatstring
stampImageUristring
stampSizeMMstring
stampTypestring