Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format as 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/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}

Parameters

Parameter name Value Description
Path parameters
accountId string

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

imageType string

One of signature_image or initials_image.

signatureId string

The ID of the signature being accessed.

userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Optional query parameters
include_chrome string

Responses

image/gif

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Users::getSignatureImage

Definitions Expand All | Collapse All

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.