UserSignatures: getImage

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.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

imageTypestring

Specificies the type of image. Valid values are:

  • signature_image
  • initials_image

signatureIdstring

The ID of the signature being accessed.

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

Optional Query Parameters
include_chromestring

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

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Users::getSignatureImage

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />