Signature Request

https://dmsworkspace-gateway-backend-int.dmsworkspace.com/DMSWORKSPACE-ESIGNATURE-BACKEND/v1

post

Create entity

Authorizations

DMS_OAUTH_SECURITY_SCHEMA

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Available scopes:

• : OpenID Connect scope for add user roles to the access token

Body

application/json

Document sign request

idstring · uuidOptional

createdDatestring · date-timeOptional

Document signature request creation date

titlestringOptional

Document title

Example: Sample document

signatureReasonstringOptional

Signature reason

Example: Signature reason

saveSignedFileToOriginalPathbooleanOptional

Whether to save signed file to original path or not

Example: false

requestedBystringOptional

Name of the user who requested the signature

Example: John Doe

userIdstring · uuidOptional

User id of the user who requested the signature

Example: 123e4567-e89b-12d3-a456-426614174000

expirationDatestring · date-timeOptional

Expiration date of the signature request

sentDatestring · date-timeOptional

Send date of the signature request

alertOneDayBeforeExpirationbooleanOptional

Whether to alert one day before expiration or not

Example: false

autoReminderbooleanOptional

Whether to auto remind or not

Example: false

reminderFrequencyInDaysinteger · int32Optional

Reminder frequency in days. autoReminder flag must be true

Example: 3

maxAutoRemindersinteger · int32Optional

Max. auto reminders. autoReminder flag must be true

Example: 5

statusstring · enumOptional

Status of the document signature request

Example: DRAFTPossible values:

protectWithPasswordbooleanOptional

Whether to protect with password or not

Example: false

passwordstringOptional

Password for the document

Example: password

messageToAllRecipientsstringOptional

Message to all recipients

Example: Your document(s) are ready to be signed

tagsstring[]Optional

Tags for the document

Responses

200

OK

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

404

Not Found

*/*

post

/v1/signatures/request

HTTPcURLJavaScriptPython

POST /v1/signatures/request HTTP/1.1
Host: dmsworkspace-gateway-backend-int.dmsworkspace.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1732

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdDate": "2025-12-15T19:48:29.058Z",
  "title": "Sample document",
  "signatureReason": "Signature reason",
  "saveSignedFileToOriginalPath": false,
  "requestedBy": "John Doe",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "expirationDate": "2025-12-15T19:48:29.058Z",
  "sentDate": "2025-12-15T19:48:29.058Z",
  "alertOneDayBeforeExpiration": false,
  "autoReminder": false,
  "reminderFrequencyInDays": 3,
  "maxAutoReminders": 5,
  "status": "DRAFT",
  "protectWithPassword": false,
  "password": "password",
  "messageToAllRecipients": "Your document(s) are ready to be signed",
  "tags": [
    "text"
  ],
  "recipients": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
      "recipientName": "John Doe",
      "recipientAddress": "7900 NW 194 ST",
      "recipientPostalCode": "33015",
      "recipientLocality": "Miami",
      "recipientStateOrProvince": "Florida",
      "recipientCountry": "United States",
      "recipientEmail": "[email protected]",
      "languageIsoCode": "en",
      "device": "Desktop",
      "phone": "[phone]",
      "signatureCoordinates": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
          "x1": 1,
          "y1": 1,
          "x2": 1,
          "y2": 1
        }
      ],
      "role": "SIGNER",
      "status": "AWAITING_RECIPIENT_SIGNATURE",
      "deliveryMode": "EMAIL"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "documentName": "file.pdf",
      "documentType": "PDF",
      "originalFilePath": "https://storage.dmsworkspace.com/home/user/file.pdf",
      "size": 1024
    }
  ],
  "activities": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdDate": "2025-12-15T19:48:29.058Z",
      "ip": "text",
      "activity": "text",
      "remarks": "text",
      "action": "text",
      "documentActivityType": "REQUEST",
      "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "status": "text",
  "code": "text",
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdDate": "2025-12-15T19:48:29.058Z",
    "title": "Sample document",
    "signatureReason": "Signature reason",
    "saveSignedFileToOriginalPath": false,
    "requestedBy": "John Doe",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2025-12-15T19:48:29.058Z",
    "sentDate": "2025-12-15T19:48:29.058Z",
    "alertOneDayBeforeExpiration": false,
    "autoReminder": false,
    "reminderFrequencyInDays": 3,
    "maxAutoReminders": 5,
    "status": "DRAFT",
    "protectWithPassword": false,
    "password": "password",
    "messageToAllRecipients": "Your document(s) are ready to be signed",
    "tags": [
      "text"
    ],
    "recipients": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
        "recipientName": "John Doe",
        "recipientAddress": "7900 NW 194 ST",
        "recipientPostalCode": "33015",
        "recipientLocality": "Miami",
        "recipientStateOrProvince": "Florida",
        "recipientCountry": "United States",
        "recipientEmail": "[email protected]",
        "languageIsoCode": "en",
        "device": "Desktop",
        "phone": "[phone]",
        "signatureCoordinates": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
            "x1": 1,
            "y1": 1,
            "x2": 1,
            "y2": 1
          }
        ],
        "role": "SIGNER",
        "status": "AWAITING_RECIPIENT_SIGNATURE",
        "deliveryMode": "EMAIL"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "documentName": "file.pdf",
        "documentType": "PDF",
        "originalFilePath": "https://storage.dmsworkspace.com/home/user/file.pdf",
        "size": 1024
      }
    ],
    "activities": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdDate": "2025-12-15T19:48:29.058Z",
        "ip": "text",
        "activity": "text",
        "remarks": "text",
        "action": "text",
        "documentActivityType": "REQUEST",
        "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}

get

Get results paginated

Authorizations

DMS_OAUTH_SECURITY_SCHEMA

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Available scopes:

• : OpenID Connect scope for add user roles to the access token

Query parameters

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

404

Not Found

*/*

get

/v1/signatures/request

HTTPcURLJavaScriptPython

GET /v1/signatures/request?arg0=[object+Object] HTTP/1.1
Host: dmsworkspace-gateway-backend-int.dmsworkspace.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": "text",
  "code": "text",
  "message": "text",
  "data": {
    "totalPages": 1,
    "totalElements": 1,
    "pageable": {
      "pageNumber": 1,
      "pageSize": 1,
      "paged": true,
      "unpaged": true,
      "offset": 1,
      "sort": {
        "sorted": true,
        "unsorted": true,
        "empty": true
      }
    },
    "numberOfElements": 1,
    "size": 1,
    "content": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdDate": "2025-12-15T19:48:29.058Z",
        "title": "Sample document",
        "signatureReason": "Signature reason",
        "saveSignedFileToOriginalPath": false,
        "requestedBy": "John Doe",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "expirationDate": "2025-12-15T19:48:29.058Z",
        "sentDate": "2025-12-15T19:48:29.058Z",
        "alertOneDayBeforeExpiration": false,
        "autoReminder": false,
        "reminderFrequencyInDays": 3,
        "maxAutoReminders": 5,
        "status": "DRAFT",
        "protectWithPassword": false,
        "password": "password",
        "messageToAllRecipients": "Your document(s) are ready to be signed",
        "tags": [
          "text"
        ],
        "recipients": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
            "recipientName": "John Doe",
            "recipientAddress": "7900 NW 194 ST",
            "recipientPostalCode": "33015",
            "recipientLocality": "Miami",
            "recipientStateOrProvince": "Florida",
            "recipientCountry": "United States",
            "recipientEmail": "[email protected]",
            "languageIsoCode": "en",
            "device": "Desktop",
            "phone": "[phone]",
            "role": "SIGNER",
            "status": "AWAITING_RECIPIENT_SIGNATURE",
            "deliveryMode": "EMAIL"
          }
        ],
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "documentName": "file.pdf",
            "documentType": "PDF",
            "originalFilePath": "https://storage.dmsworkspace.com/home/user/file.pdf",
            "size": 1024
          }
        ],
        "activities": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdDate": "2025-12-15T19:48:29.058Z",
            "ip": "text",
            "activity": "text",
            "remarks": "text",
            "action": "text",
            "documentActivityType": "REQUEST",
            "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      }
    ],
    "number": 1,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "first": true,
    "last": true,
    "empty": true
  }
}

get

Get by id

Authorizations

DMS_OAUTH_SECURITY_SCHEMA

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Available scopes:

• : OpenID Connect scope for add user roles to the access token

Path parameters

idstring · uuidRequired

Responses

200

OK

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

404

Not Found

*/*

get

/v1/signatures/request/{id}

HTTPcURLJavaScriptPython

GET /v1/signatures/request/{id} HTTP/1.1
Host: dmsworkspace-gateway-backend-int.dmsworkspace.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": "text",
  "code": "text",
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdDate": "2025-12-15T19:48:29.058Z",
    "title": "Sample document",
    "signatureReason": "Signature reason",
    "saveSignedFileToOriginalPath": false,
    "requestedBy": "John Doe",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2025-12-15T19:48:29.058Z",
    "sentDate": "2025-12-15T19:48:29.058Z",
    "alertOneDayBeforeExpiration": false,
    "autoReminder": false,
    "reminderFrequencyInDays": 3,
    "maxAutoReminders": 5,
    "status": "DRAFT",
    "protectWithPassword": false,
    "password": "password",
    "messageToAllRecipients": "Your document(s) are ready to be signed",
    "tags": [
      "text"
    ],
    "recipients": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
        "recipientName": "John Doe",
        "recipientAddress": "7900 NW 194 ST",
        "recipientPostalCode": "33015",
        "recipientLocality": "Miami",
        "recipientStateOrProvince": "Florida",
        "recipientCountry": "United States",
        "recipientEmail": "[email protected]",
        "languageIsoCode": "en",
        "device": "Desktop",
        "phone": "[phone]",
        "role": "SIGNER",
        "status": "AWAITING_RECIPIENT_SIGNATURE",
        "deliveryMode": "EMAIL"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "documentName": "file.pdf",
        "documentType": "PDF",
        "originalFilePath": "https://storage.dmsworkspace.com/home/user/file.pdf",
        "size": 1024
      }
    ],
    "activities": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdDate": "2025-12-15T19:48:29.058Z",
        "ip": "text",
        "activity": "text",
        "remarks": "text",
        "action": "text",
        "documentActivityType": "REQUEST",
        "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}

put

Update entity

Authorizations

DMS_OAUTH_SECURITY_SCHEMA

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Available scopes:

• : OpenID Connect scope for add user roles to the access token

Path parameters

idstring · uuidRequired

Body

application/json

Document sign request

idstring · uuidOptional

createdDatestring · date-timeOptional

Document signature request creation date

titlestringOptional

Document title

Example: Sample document

signatureReasonstringOptional

Signature reason

Example: Signature reason

saveSignedFileToOriginalPathbooleanOptional

Whether to save signed file to original path or not

Example: false

requestedBystringOptional

Name of the user who requested the signature

Example: John Doe

userIdstring · uuidOptional

User id of the user who requested the signature

Example: 123e4567-e89b-12d3-a456-426614174000

expirationDatestring · date-timeOptional

Expiration date of the signature request

sentDatestring · date-timeOptional

Send date of the signature request

alertOneDayBeforeExpirationbooleanOptional

Whether to alert one day before expiration or not

Example: false

autoReminderbooleanOptional

Whether to auto remind or not

Example: false

reminderFrequencyInDaysinteger · int32Optional

Reminder frequency in days. autoReminder flag must be true

Example: 3

maxAutoRemindersinteger · int32Optional

Max. auto reminders. autoReminder flag must be true

Example: 5

statusstring · enumOptional

Status of the document signature request

Example: DRAFTPossible values:

protectWithPasswordbooleanOptional

Whether to protect with password or not

Example: false

passwordstringOptional

Password for the document

Example: password

messageToAllRecipientsstringOptional

Message to all recipients

Example: Your document(s) are ready to be signed

tagsstring[]Optional

Tags for the document

Responses

200

OK

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

404

Not Found

*/*

put

/v1/signatures/request/{id}

HTTPcURLJavaScriptPython

PUT /v1/signatures/request/{id} HTTP/1.1
Host: dmsworkspace-gateway-backend-int.dmsworkspace.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1565

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdDate": "2025-12-15T19:48:29.058Z",
  "title": "Sample document",
  "signatureReason": "Signature reason",
  "saveSignedFileToOriginalPath": false,
  "requestedBy": "John Doe",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "expirationDate": "2025-12-15T19:48:29.058Z",
  "sentDate": "2025-12-15T19:48:29.058Z",
  "alertOneDayBeforeExpiration": false,
  "autoReminder": false,
  "reminderFrequencyInDays": 3,
  "maxAutoReminders": 5,
  "status": "DRAFT",
  "protectWithPassword": false,
  "password": "password",
  "messageToAllRecipients": "Your document(s) are ready to be signed",
  "tags": [
    "text"
  ],
  "recipients": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
      "recipientName": "John Doe",
      "recipientAddress": "7900 NW 194 ST",
      "recipientPostalCode": "33015",
      "recipientLocality": "Miami",
      "recipientStateOrProvince": "Florida",
      "recipientCountry": "United States",
      "recipientEmail": "[email protected]",
      "languageIsoCode": "en",
      "device": "Desktop",
      "phone": "[phone]",
      "role": "SIGNER",
      "status": "AWAITING_RECIPIENT_SIGNATURE",
      "deliveryMode": "EMAIL"
    }
  ],
  "files": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "documentName": "file.pdf",
      "documentType": "PDF",
      "originalFilePath": "https://storage.dmsworkspace.com/home/user/file.pdf",
      "size": 1024
    }
  ],
  "activities": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdDate": "2025-12-15T19:48:29.058Z",
      "ip": "text",
      "activity": "text",
      "remarks": "text",
      "action": "text",
      "documentActivityType": "REQUEST",
      "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

{
  "status": "text",
  "code": "text",
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdDate": "2025-12-15T19:48:29.058Z",
    "title": "Sample document",
    "signatureReason": "Signature reason",
    "saveSignedFileToOriginalPath": false,
    "requestedBy": "John Doe",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2025-12-15T19:48:29.058Z",
    "sentDate": "2025-12-15T19:48:29.058Z",
    "alertOneDayBeforeExpiration": false,
    "autoReminder": false,
    "reminderFrequencyInDays": 3,
    "maxAutoReminders": 5,
    "status": "DRAFT",
    "protectWithPassword": false,
    "password": "password",
    "messageToAllRecipients": "Your document(s) are ready to be signed",
    "tags": [
      "text"
    ],
    "recipients": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000",
        "recipientName": "John Doe",
        "recipientAddress": "7900 NW 194 ST",
        "recipientPostalCode": "33015",
        "recipientLocality": "Miami",
        "recipientStateOrProvince": "Florida",
        "recipientCountry": "United States",
        "recipientEmail": "[email protected]",
        "languageIsoCode": "en",
        "device": "Desktop",
        "phone": "[phone]",
        "role": "SIGNER",
        "status": "AWAITING_RECIPIENT_SIGNATURE",
        "deliveryMode": "EMAIL"
      }
    ],
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "documentName": "file.pdf",
        "documentType": "PDF",
        "originalFilePath": "https://storage.dmsworkspace.com/home/user/file.pdf",
        "size": 1024
      }
    ],
    "activities": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdDate": "2025-12-15T19:48:29.058Z",
        "ip": "text",
        "activity": "text",
        "remarks": "text",
        "action": "text",
        "documentActivityType": "REQUEST",
        "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}