Retrieves a list of signature definitions for a user
This method retrieves the signature definitions for the user that you specify.
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 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".
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
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
The type of stamps to return. Valid values are:
signature: Returns information about signature images only. This is the default value.stamp: Returns information about eHanko and custom stamps only.- null
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/users/string/signatures"{ "userSignatures": [ { "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" } ]}Updates the user account settings for a specified user PUT
Updates the account settings list and email notification types for the specified user.
Adds user Signature and initials images to a Signature POST
Adds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user's `userId` and the user must be a member of the account. The rules and processes associated with this are: * If `Content-Type` is set to `application/json`, then the default behavior for creating a default signature image, based on the name and a Docusign font, is used. * If `Content-Type` is set to `multipart/form-data`, then the request must contain a first part with the user signature information, followed by parts that contain the images. For each Image part, the Content-Disposition header has a "filename" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. For example: `Content-Disposition: file; filename="Ron Test20121127083900"` If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call. The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary. If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.