Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
User Signatures

Updates the user signature for a specified user

PUT
/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}

Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.

Note: This will also create a default signature for the user when one does not exist.

The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.

The signatureId parameter accepts a signature ID. Docusign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example encode "Bob Smith" as "Bob%20Smith".

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

signatureId*string

The ID of the account stamp.

userId*string

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.

Query Parameters

close_existing_signature?string

When true, closes the current signature.

Request Body

application/json

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.
disallowUserResizeStamp?string

When true, users may not resize the stamp.

externalID?string

Optionally specify an external identifier for the user's signature.

imageType?string

Specificies the type of image. Valid values:

  • stamp_image
  • signature_image
  • initials_image
isDefault?string

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

nrdsId?string

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

nrdsLastName?string

The realtor's last name.

phoneticName?string

The phonetic spelling of the signatureName.

signatureFont?string

The 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"
signatureId?string

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.

signatureInitials?string

Specifies the user's signature in initials format.

signatureName?string

Specifies the user's signature name.

signatureType?string

Specifies the type of signature.

stampFormat?string

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.
stampSizeMM?string

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

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/users/string/signatures/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "adoptedDateTime": "string",  "createdDateTime": "string",  "customField": "string",  "dateStampProperties": {    "dateAreaHeight": "string",    "dateAreaWidth": "string",    "dateAreaX": "string",    "dateAreaY": "string"  },  "disallowUserResizeStamp": "string",  "errorDetails": {    "errorCode": "string",    "message": "string"  },  "externalID": "string",  "imageBase64": "string",  "imageType": "string",  "initials150ImageId": "string",  "initialsImageUri": "string",  "isDefault": "string",  "lastModifiedDateTime": "string",  "nrdsId": "string",  "nrdsLastName": "string",  "nrdsStatus": "string",  "phoneticName": "string",  "signature150ImageId": "string",  "signatureFont": "string",  "signatureId": "string",  "signatureImageUri": "string",  "signatureInitials": "string",  "signatureName": "string",  "signatureRights": "string",  "signatureType": "string",  "stampFormat": "string",  "stampImageUri": "string",  "stampSizeMM": "string",  "stampType": "string",  "status": "string"}

Removes removes signature information for the specified user DELETE

Removes the signature information for the user. The userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".

Retrieves the user initials image or the user signature image for the specified user GET

Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith". **Note:** Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.