GET api/Signing/{signingRoomId}/Documents/{documentId}/Annotations/{documentAnnotationId}/Image

Returns an image of the document annotation associated to a document in the specified SigningRoom. The current signer user must have access to the SigningRoom that contains the document and it's document annotation.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
signingRoomId

The id of the SigningRoom.

integer

Required

documentId

The id of the document.

integer

Required

documentAnnotationId

The id of the document annotation.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The document annotation image.

ESignSystems.SmartSAFE.Models.Signing.DocumentAnnotationImageModel
NameDescriptionTypeAdditional information
PopulatedDate

Gets or sets the date and time that the annotation was populated.

date

Required

Image

Gets or sets the annotation image.

Collection of byte

Required

MimeType

Gets or sets the annotation image's mime type.

string

Required

Response Formats

application/json, text/json

Sample:
{
  "PopulatedDate": "2026-01-01T17:31:04.6294998-05:00",
  "Image": "QEA=",
  "MimeType": "sample string 2"
}

application/xml, text/xml

Sample:
<DocumentAnnotationImageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
  <Image>QEA=</Image>
  <MimeType>sample string 2</MimeType>
  <PopulatedDate>2026-01-01T17:31:04.6294998-05:00</PopulatedDate>
</DocumentAnnotationImageModel>