Quick Start

Get your API keys

All API calls require authentication. To obtain an authentication token you will require a username, password, client id and secret (this was emailed to you).

Any request that doesn't include an API key will return an error.

You can generate an API key from your DMS Workspace E-Signature Dashboard at any time or by contacting us via email at [email protected]

Create Token

Create Token

Signature Flow

Example Request

Bellow you will find some example requests

Postman

POST: https://dmsworkspace-sso-pre.dmsworkspace.com/realms/dmsworkspace/protocol/openid-connect/token

Select x-www-form-urlencoded in the Body tab

Populate the client_id, client_secret, username, password and grant_type

Hit Send to get your Bearer Token 

Making your first request

Create a new document signature request

To initiate a document signature request, follow the steps below:

1. Ensure all documents intended for signing are uploaded through the file-manager endpoint. Keep the URLs of these documents handy.

2. Build payload request

3. Enter the details of the recipients who are required to sign the documents. This includes their names and email addresses.

4. Paste the URLs of the documents that were uploaded in step 1 into the designated field ('fields' array node from payload).

5. Customize any message or instructions you wish to include in the email that will be sent to recipients.

6. Submit the request.

Upon submission, an email will be automatically sent to all listed recipients, containing the documents for signing along with any instructions provided. Recipients will have the option to either sign the documents electronically or decline the request.

This straightforward process ensures a seamless experience for both the requester and the recipients, facilitating efficient document management and expedited turnaround times for necessary signatures.

Note that the files to be signed must be uploaded first via the file-manager endpoint and keep the urls, which you will need to specify on the signature request.

Below you can find information regarding on how to create a signature request

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: 1565

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdDate": "2025-12-14T09:12:17.639Z",
  "title": "Sample document",
  "signatureReason": "Signature reason",
  "saveSignedFileToOriginalPath": false,
  "requestedBy": "John Doe",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "expirationDate": "2025-12-14T09:12:17.639Z",
  "sentDate": "2025-12-14T09:12:17.639Z",
  "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-14T09:12:17.639Z",
      "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-14T09:12:17.639Z",
    "title": "Sample document",
    "signatureReason": "Signature reason",
    "saveSignedFileToOriginalPath": false,
    "requestedBy": "John Doe",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2025-12-14T09:12:17.639Z",
    "sentDate": "2025-12-14T09:12:17.639Z",
    "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-14T09:12:17.639Z",
        "ip": "text",
        "activity": "text",
        "remarks": "text",
        "action": "text",
        "documentActivityType": "REQUEST",
        "documentSignatureRequestId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}

Recipients to sign sent document (s)

Once you create the document signature request, an email will be sent by the system to all recipients, from there they will have a link to visualize the documents to be signed and they will have the option to sign or decline to do it. This process is automatically executed from our side.

Query existing document signature requests

To query existing document signature requests, you can find information bellow

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-14T09:12:17.639Z",
        "title": "Sample document",
        "signatureReason": "Signature reason",
        "saveSignedFileToOriginalPath": false,
        "requestedBy": "John Doe",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "expirationDate": "2025-12-14T09:12:17.639Z",
        "sentDate": "2025-12-14T09:12:17.639Z",
        "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-14T09:12:17.639Z",
            "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
  }
}

This feature allows you to keep track of all your signature requests efficiently, ensuring no document is left unsigned or unattended.