POST api/Signing/Documents/SignDocument

Signs the document using the specified signing information. The current signer user must have access to the SigningRoom that contains the document and must have sign privileges on the document.

Request Information

URI Parameters

None.

Body Parameters

The document signing information.

ESignSystems.SmartSAFE.Models.Signing.SignDocumentModel

Name	Description	Type	Additional information
DocumentId	Gets or sets the document identifier.	integer	Required
Annotations	Gets or sets the annotations on the document.	Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.Tagging.AnnotationModel	None.
SigningRoomId	Gets or sets the SigningRoom identifier.	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "DocumentId": 1,
  "Annotations": [
    {
      "PopulatedDate": "2026-01-01T17:28:19.0658003-05:00",
      "AnnotationValue": "sample string 1",
      "DocumentAnnotationId": 1,
      "DocumentSignerId": 1,
      "DocumentId": 1,
      "ParticipantId": 1,
      "ParticipantOrderId": 1,
      "XOffset": 2.1,
      "YOffset": 3.1,
      "AnnotationTypeId": 4,
      "AnnotationType": "sample string 5",
      "DisplayValue": "sample string 6",
      "Width": 7.1,
      "Height": 8.1,
      "Optional": true,
      "PageNumber": 10,
      "MaxAnnotationTextLength": 1,
      "AnnotationTextFontSize": 1,
      "Deleted": true,
      "FittextValue": 12.1,
      "AnnotationGroupName": "sample string 13",
      "SignatureReferenceId": "sample string 14"
    },
    {
      "PopulatedDate": "2026-01-01T17:28:19.0658003-05:00",
      "AnnotationValue": "sample string 1",
      "DocumentAnnotationId": 1,
      "DocumentSignerId": 1,
      "DocumentId": 1,
      "ParticipantId": 1,
      "ParticipantOrderId": 1,
      "XOffset": 2.1,
      "YOffset": 3.1,
      "AnnotationTypeId": 4,
      "AnnotationType": "sample string 5",
      "DisplayValue": "sample string 6",
      "Width": 7.1,
      "Height": 8.1,
      "Optional": true,
      "PageNumber": 10,
      "MaxAnnotationTextLength": 1,
      "AnnotationTextFontSize": 1,
      "Deleted": true,
      "FittextValue": 12.1,
      "AnnotationGroupName": "sample string 13",
      "SignatureReferenceId": "sample string 14"
    }
  ],
  "SigningRoomId": 2
}

application/xml, text/xml

Sample:

<SignDocumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.Signing">
  <Annotations xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager.Tagging">
    <d2p1:AnnotationModel>
      <d2p1:AnnotationGroupName>sample string 13</d2p1:AnnotationGroupName>
      <d2p1:AnnotationTextFontSize>1</d2p1:AnnotationTextFontSize>
      <d2p1:AnnotationType>sample string 5</d2p1:AnnotationType>
      <d2p1:AnnotationTypeId>4</d2p1:AnnotationTypeId>
      <d2p1:Deleted>true</d2p1:Deleted>
      <d2p1:DisplayValue>sample string 6</d2p1:DisplayValue>
      <d2p1:DocumentAnnotationId>1</d2p1:DocumentAnnotationId>
      <d2p1:DocumentId>1</d2p1:DocumentId>
      <d2p1:DocumentSignerId>1</d2p1:DocumentSignerId>
      <d2p1:FittextValue>12.1</d2p1:FittextValue>
      <d2p1:Height>8.1</d2p1:Height>
      <d2p1:MaxAnnotationTextLength>1</d2p1:MaxAnnotationTextLength>
      <d2p1:Optional>true</d2p1:Optional>
      <d2p1:PageNumber>10</d2p1:PageNumber>
      <d2p1:ParticipantId>1</d2p1:ParticipantId>
      <d2p1:ParticipantOrderId>1</d2p1:ParticipantOrderId>
      <d2p1:SignatureReferenceId>sample string 14</d2p1:SignatureReferenceId>
      <d2p1:Width>7.1</d2p1:Width>
      <d2p1:XOffset>2.1</d2p1:XOffset>
      <d2p1:YOffset>3.1</d2p1:YOffset>
      <d2p1:AnnotationValue>sample string 1</d2p1:AnnotationValue>
      <d2p1:PopulatedDate>2026-01-01T17:28:19.0658003-05:00</d2p1:PopulatedDate>
    </d2p1:AnnotationModel>
    <d2p1:AnnotationModel>
      <d2p1:AnnotationGroupName>sample string 13</d2p1:AnnotationGroupName>
      <d2p1:AnnotationTextFontSize>1</d2p1:AnnotationTextFontSize>
      <d2p1:AnnotationType>sample string 5</d2p1:AnnotationType>
      <d2p1:AnnotationTypeId>4</d2p1:AnnotationTypeId>
      <d2p1:Deleted>true</d2p1:Deleted>
      <d2p1:DisplayValue>sample string 6</d2p1:DisplayValue>
      <d2p1:DocumentAnnotationId>1</d2p1:DocumentAnnotationId>
      <d2p1:DocumentId>1</d2p1:DocumentId>
      <d2p1:DocumentSignerId>1</d2p1:DocumentSignerId>
      <d2p1:FittextValue>12.1</d2p1:FittextValue>
      <d2p1:Height>8.1</d2p1:Height>
      <d2p1:MaxAnnotationTextLength>1</d2p1:MaxAnnotationTextLength>
      <d2p1:Optional>true</d2p1:Optional>
      <d2p1:PageNumber>10</d2p1:PageNumber>
      <d2p1:ParticipantId>1</d2p1:ParticipantId>
      <d2p1:ParticipantOrderId>1</d2p1:ParticipantOrderId>
      <d2p1:SignatureReferenceId>sample string 14</d2p1:SignatureReferenceId>
      <d2p1:Width>7.1</d2p1:Width>
      <d2p1:XOffset>2.1</d2p1:XOffset>
      <d2p1:YOffset>3.1</d2p1:YOffset>
      <d2p1:AnnotationValue>sample string 1</d2p1:AnnotationValue>
      <d2p1:PopulatedDate>2026-01-01T17:28:19.0658003-05:00</d2p1:PopulatedDate>
    </d2p1:AnnotationModel>
  </Annotations>
  <DocumentId>1</DocumentId>
  <SigningRoomId>2</SigningRoomId>
</SignDocumentModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the operation.

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.