Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
UserSignatures

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

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.

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

Path parameters

accountIdstring required

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

imageTypestring required

Specificies the type of image. Valid values:

  • stamp_image
  • signature_image
  • initials_image
signatureIdstring required

The ID of the account stamp.

userIdstring required

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

include_chromestring

When true, the chrome (or frame containing the added line and identifier) is included with the signature image.

Response

Successful response.