API Documentation | Signaturely

Authentication

Authentication is made with your API Key which can be found in your account settings. You will have to add your API Key to every call you make to our API. This parameter is always required. We'll return an error if the key is either missing or invalid. Your API key is what identifies your account, so be sure to keep it secret! Please don’t share it with anyone outside of your organization.

Authorization: Api-Key {API_KEY}

Get user

This endpoints allows you to get information about your user account

GEThttps://api.signaturely.com/api/v1/user/by-api

Attributes

Attribute / parameter	Description	Type / values
`appSumoStatus`	AppSumo status	`"standard" \| "full"`
`avatarUrl`	Link on account avatar	`URL`
`email`	User's email	`string`
`id`	User's id	`UUID`
`name`	User's name	`string`
`status`	User's status	`"active" \| "freeze"`
`role`	User's role	`"owner" \| "admin" \| "user"`

Response

1{
2  "data": {
3    "appSumoStatus": "standard",
4    "avatarUrl": null,
5    "email": "user@example.example",
6    "id": "991a8353-ecb6-4bf1-9c23-b56b17a6cb9e",
7    "name": "username",
8    "status": "active",
9    "role": "owner"
10  }
11}

Create signing request

This endpoints allows you to create signing request for your documents

POSThttps://api.signaturely.com/api/v1/document_sign/api/request_by_template

Request example

1{
2  "title": "example document",
3  "message": "example message",
4  "signers": [
5    {
6      "role": "role1",
7      "name": "signer1",
8      "email": "signer1@example.example",
9      "fields": {
10        "customerPhone": "+79001101010",
11        "reason": "Due to personal purposes I need it",
12        "agreeAllTerms": true
13      }
14    }
15  ],
16  "testMode": true,
17  "templateId": "db0d6b70-35b3-4095-a742-776527b7c1f0"
18}

Body parameters

Attribute / parameter	Description	Type / values
`title`	Document title	`string`
`message`	Document message	`string`
`signers`Required	List of signers. For ordered documents must defined order. 'fields' is an optional dictionary with values for document fields with API tags. In our example there are three fields with API tags: "customerPhone" (textbox), "reason" (textbox), "agreeAllTerms" (checkbox)	`{ name: string, email: string, role: string, order: number, fields: Object }`
`isOrdered`	Document ordered flag	`boolean`
`templateId`	Template id	`UUID`
`testMode`	Test mode flag	`boolean`
`folderId`	Folder ID	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`codeAccess`	Access code for document	`string`
`createdAt`	-	`timestamp`
`deletedAt`	-	`timestamp`
`errorText`	Text of error	`string`
`fields`	Document fields	`Object`
`filesUploaded`	Uploaded flag	`boolean`
`id`	Document id	`UUID`
`isFromFormRequest`	Form request flag	`boolean`
`isOrdered`	Ordered flag	`boolean`
`message`	Document message	`string`
`originalFileName`	Original document filename	`string`
`originalFileUrl`	Link for original document file	`URL`
`parts`	Document parts	`Object`
`pdfFileKey`	Link for document pdf file	`URL`
`pdfMetadata`	metadata	`Object`
`recipients`	Array of recipient emails	`string[]`
`resultPdfFileKey`	-	`string`
`shareLink`	Link for share yout documents	`URL`
`signers`	List of signers	`Object`
`status`	Status of document	`"draft" \| "awaiting" \| "completed" "declined"`
`templateId`	Template ID	`UUID`
`testMode`	Test mode flag	`boolean`
`title`	Document title	`string`
`type`	Document type	`"me" \| "others" \| "me_and_other"`
`updatedAt`	Date of last update	`timestamp`

Response

1{
2  "codeAccess": null,
3  "createdAt": "2021-07-27T09:36:34.824Z",
4  "deletedAt": null,
5  "errorText": null,
6  "fields": [],
7  "filesUploaded": true,
8  "id": "2665605c-cf2d-461a-8003-50b60732a494",
9  "isFromFormRequest": false,
10  "isOrdered": false,
11  "message": null,
12  "originalFileName": null,
13  "originalFileUrl": null,
14  "parts": [],
15  "pdfFileKey": null,
16  "pdfMetadata": null,
17  "recipients": null,
18  "resultPdfFileKey": null,
19  "shareLink": null,
20  "signers": [
21    {
22      "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
23      "email": "signer@example.example",
24      "id": "929fe226-753b-4cd7-b5ae-b095ccad967b",
25      "isFinished": false,
26      "isPreparer": false,
27      "name": "anton1",
28      "order": 2,
29      "role": null,
30      "userId": "db0d6b70-35b3-4095-a742-776527b7c1f0",
31      "isReceivingReminders": true,
32      "isDeclined": false
33    }
34  ],
35  "status": "preparing",
36  "templateId": "db0d6b70-35b3-4095-a742-776527b7c1f0",
37  "testMode": false,
38  "title": "test doc auth",
39  "type": "others",
40  "updatedAt": "2021-07-27T09:37:38.316Z"
41}

Bulk send signature request based on template

Bulk Send Template will allow for users to generate a bulk series of signature requests based on a single signer template and CSV data.

POSThttps://api.signaturely.com/api/v1/document_sign/api/bulk_send

Request example

1{
2  "title": "example document",
3  "message": "example message",
4  "signers": [
5    {
6      "name": "signer1",
7      "email": "signer1@example.example"
8    },
9    {
10      "name": "signer2",
11      "email": "signer2@example.example"
12    }
13  ],
14  "testMode": true,
15  "templateId": "97066b2e-1853-4f3a-927c-2b61e454a58e"
16}

Body parameters

Attribute / parameter	Description	Type / values
`title`Required	Document title	`string`
`message`	Document message	`string`
`templateId`Required	Template's ID	`UUID`
`signers`Required	List of signers	`[ { name: string, email: string } ]`
`testMode`	Test mode flag	`boolean`
`folderId`	Folder ID	`UUID`

Response

1{}

Get document list

This endpoints allows you to get list of your documents

GEThttps://api.signaturely.com/api/v1/documents

Query parameters

Attribute / parameter	Description	Type / values
`limit`Required	Number of items presented on page	`number`
`page`Required	Number of page	`number`
`type[]`	List of document types	`"me" \| "others" \| "me_and_other"`
`status[]`	List of document statuses	`"draft" \| "awaiting" \| "completed"`
`dateFrom`	-	`timestamp`
`dateTo`	-	`timestamp`
`orderingKey`	Sort by field with this name	`string`
`orderingDirection`	ascending or descending	`"ASC" \| "DESC"`
`searchTerm`	String for searching	`string`
`searchType`	Type of search	`"signers" \| "documents"`
`folderId`	Folder ID for search (null for root, ID for certain folder, undefined for everywhere)	`UUID \| "null"`

Attributes

Attribute / parameter	Description	Type / values
`codeAccess`	Access code for document	`string`
`createdAt`	-	`timestamp`
`deletedAt`	-	`timestamp`
`errorText`	Text of error	`string`
`fields`	Document fields	`Object`
`filesUploaded`	Uploaded flag	`boolean`
`id`	Document id	`UUID`
`isFromFormRequest`	Form request flag	`boolean`
`isOrdered`	Ordered flag	`boolean`
`message`	Document message	`string`
`originalFileName`	Original document filename	`string`
`originalFileUrl`	Link for original document file	`URL`
`parts`	Document parts	`Object`
`pdfFileKey`	Link for document pdf file	`URL`
`pdfMetadata`	metadata	`Object`
`recipients`	Array of recipient emails	`string[]`
`resultPdfFileKey`	-	`string`
`shareLink`	Link for share yout documents	`URL`
`signers`	List of signers	`Object`
`status`	Status of document	`"draft" \| "awaiting" \| "completed" "declined"`
`templateId`	Template ID	`UUID`
`testMode`	Test mode flag	`boolean`
`title`	Document title	`string`
`type`	Document type	`"me" \| "others" \| "me_and_other"`
`updatedAt`	Date of last update	`timestamp`
`folderId`	Document's folder ID	`UUID`
`itemCount`	Items count on the page	`number`
`totalItems`	Total count	`number`
`itemsPerPage`	Limit setting in request	`number`
`totalPages`	Total pages count	`number`
`currentPage`	Current page number	`number`

Response

1{
2  "data": [
3    {
4      "codeAccess": null,
5      "createdAt": "2021-07-27T09:36:34.824Z",
6      "deletedAt": null,
7      "errorText": null,
8      "fields": [
9        {
10          "checked": null,
11          "coordinateX": 77.3903732299805,
12          "coordinateY": 126.555679321289,
13          "createdAt": "2021-07-27T09:37:32.683Z",
14          "dateFormat": null,
15          "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
16          "fontFamily": null,
17          "fontSize": null,
18          "height": 25,
19          "id": "991a8353-ecb6-4bf1-9c23-b56b17a6cb9e",
20          "pageNumber": 1,
21          "required": true,
22          "requisiteId": null,
23          "signed": false,
24          "signerId": "d112370a-74b8-44de-84a5-ed124e9c174e",
25          "text": null,
26          "type": "sign",
27          "updatedAt": "2021-07-27T09:37:32.683Z"
28        }
29      ],
30      "filesUploaded": true,
31      "id": "2665605c-cf2d-461a-8003-50b60732a494",
32      "isFromFormRequest": false,
33      "isOrdered": false,
34      "message": null,
35      "originalFileName": null,
36      "originalFileUrl": null,
37      "parts": [
38        {
39          "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
40          "errorText": null,
41          "files": [
42            {
43              "fileKey": "fileKey",
44              "id": "fileId",
45              "order": 1
46            }
47          ],
48          "filesUploaded": true,
49          "id": "c5b60ea6-e6f0-4911-a6ba-f82d4b810301",
50          "order": 1,
51          "originalFileName": "test.pdf",
52          "originalFileUrl": "https://example.com/doc/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
53          "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
54          "pdfMetadata": {
55            "height": 842,
56            "layout": "portrait",
57            "mediaBox": [
58              0,
59              0,
60              595.25,
61              842
62            ],
63            "offsetX": 0,
64            "offsetY": 0,
65            "pageNumber": 1,
66            "rotate": 0,
67            "size": [
68              595.25,
69              842
70            ],
71            "width": 595.25
72          }
73        }
74      ],
75      "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
76      "pdfMetadata": {
77        "height": 842,
78        "layout": "portrait",
79        "mediaBox": [
80          0,
81          0,
82          595.25,
83          842
84        ],
85        "offsetX": 0,
86        "offsetY": 0,
87        "pageNumber": 1,
88        "rotate": 0,
89        "size": [
90          595.25,
91          842
92        ],
93        "width": 595.25
94      },
95      "recipients": null,
96      "resultPdfFileKey": null,
97      "shareLink": null,
98      "signers": [
99        {
100          "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
101          "email": "signer@example.example",
102          "id": "929fe226-753b-4cd7-b5ae-b095ccad967b",
103          "isFinished": false,
104          "isPreparer": false,
105          "name": "anton1",
106          "order": 2,
107          "role": null,
108          "userId": "db0d6b70-35b3-4095-a742-776527b7c1f0",
109          "isReceivingReminders": true,
110          "isDeclined": false
111        }
112      ],
113      "status": "awaiting",
114      "templateId": null,
115      "testMode": false,
116      "title": "test doc auth",
117      "type": "others",
118      "updatedAt": "2021-07-27T09:37:38.316Z",
119      "folderId": "55e4e9b7-18f6-4255-8059-451b55ae279d"
120    }
121  ]
122}

Get signer list

This endpoints allows you to get list of signers for your document

GEThttps://api.signaturely.com/api/v1/documents/:documentId/signers

Path parameters

Attribute / parameter	Description	Type / values
`documentId`Required	Id of the Document	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`id`	Signer's ID	`UUID`
`email`	Signer's email	`string`
`name`	Signer's name	`string`
`order`	Signing order	`number`
`role`	Signer's role	`string`

Response

1{
2  "data": [
3    {
4      "id": "db0d6b70-35b3-4095-a742-776527b7c1f0",
5      "name": "John Doe",
6      "order": 1,
7      "role": null,
8      "email": "john.doe@domain.ltd"
9    }
10  ]
11}

Get document file

Get Document File API call will return a PDF. If the Document completed, you will receive signed PDF, else you will receive source PDF.

GEThttps://api.signaturely.com/api/v1/document_sign/documents/:documentId/signed_download_url/api

Path parameters

Attribute / parameter	Description	Type / values
`documentId`Required	Document ID	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`result`	Link to the document file	`URL`

Response

1{
2  "result": "https://example.com/download/some_file.pdf"
3}

Get document activity

Get activity of the document

GEThttps://api.signaturely.com/api/v1/documents/:id/activities

Path parameters

Attribute / parameter	Description	Type / values
`id`Required	Id of the Document	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`id`	Link to the document view	`UUID`
`type`	Activity type	`"create" \| "update" \| "send" \| "view" \| "sign" \| "complete" \| "revert" \| "preparersign"`
`sourceIP`	IP address of activity	`IPv4 \| IPv6`
`signers`	List of signers	`[ { name: string, email: string } ]`
`documentId`	Document's ID	`UUID`
`createdAt`	Date of activity	`timestamp`

Response

1[
2  {
3    "id": "eca49a9d-a07c-4308-ab9b-dcf964e62582",
4    "type": "create",
5    "sourceIP": "::1",
6    "signers": null,
7    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
8    "createdAt": "2022-03-30T11:40:20.087Z"
9  },
10  {
11    "id": "4d3b96c0-b169-4a85-b1f6-ab8b260596b1",
12    "type": "send",
13    "sourceIP": "::1",
14    "signers": [
15      {
16        "name": "Maksim Lebedev",
17        "email": "maksim@domain.ltd"
18      }
19    ],
20    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
21    "createdAt": "2022-03-30T11:40:41.620Z"
22  },
23  {
24    "id": "881bd340-01a3-43fb-9b61-848750d79387",
25    "type": "view",
26    "sourceIP": "::1",
27    "signers": [
28      {
29        "name": "Maksim Lebedev",
30        "email": "maksim@domain.ltd"
31      }
32    ],
33    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
34    "createdAt": "2022-03-30T11:40:56.320Z"
35  },
36  {
37    "id": "fa482139-50c5-4a38-8edf-852c42eb732d",
38    "type": "sign",
39    "sourceIP": "::1",
40    "signers": [
41      {
42        "name": "Maksim Lebedev",
43        "email": "maksim@domain.ltd"
44      }
45    ],
46    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
47    "createdAt": "2022-03-30T11:41:29.875Z"
48  },
49  {
50    "id": "7f8635f3-036c-4702-93e0-639c8ece7a6f",
51    "type": "send",
52    "sourceIP": "::1",
53    "signers": [
54      {
55        "name": "Other Maksim",
56        "email": "john.doe@domain.ltd"
57      }
58    ],
59    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
60    "createdAt": "2022-03-30T11:41:36.423Z"
61  },
62  {
63    "id": "80b979bf-5726-4c1d-883c-b636af89d305",
64    "type": "view",
65    "sourceIP": "::1",
66    "signers": [
67      {
68        "name": "Other Maksim",
69        "email": "john.doe@domain.ltd"
70      }
71    ],
72    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
73    "createdAt": "2022-03-30T11:43:55.434Z"
74  },
75  {
76    "id": "387a6dc6-1d1a-4de4-8af2-493e5e31e528",
77    "type": "sign",
78    "sourceIP": "::1",
79    "signers": [
80      {
81        "name": "Other Maksim",
82        "email": "john.doe@domain.ltd"
83      }
84    ],
85    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
86    "createdAt": "2022-03-30T11:44:02.889Z"
87  },
88  {
89    "id": "a72b66ba-5c78-448d-8b0f-e9aee7635f25",
90    "type": "complete",
91    "sourceIP": null,
92    "signers": null,
93    "documentId": "cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc",
94    "createdAt": "2022-03-30T11:44:02.889Z"
95  }
96]

Get share link of the document

GEThttps://api.signaturely.com/api/v1/document_sign/documents/:id/share_url

Attribute / parameter	Description	Type / values
`id`Required	ID of the document	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`result`	Link to the document view	`URL`

1{
2  "result": "https://signaturely.com/documents/cb9d98ec-d1b9-4d7f-9c5a-78eb505a03fc/download?hash=%242a%2410%24Ej4so8aCJUxvt9BkbgYtou9ce28ZcfaWXyB4rP2gmkj13krGqlokq"
3}

Get recent document

This endpoints allows you to get your recent sended or completed document

GEThttps://api.signaturely.com/api/v1/api-integrations/recent_document?recentDocumentType=sent

Query parameters

Attribute / parameter	Description	Type / values
`recentDocumentType`Required		`"sent" \|\| "completed"`

Attributes

Attribute / parameter	Description	Type / values
`id`	Document ID	`UUID`
`title`	Document Title	`string`
`message`	Message for signers	`string`
`signers`	Array with information about signers	`Object[]`
`signers[].id`	Signer's ID (not equals to User ID)	`UUID`
`signers[].name`	Signer's name	`string`
`signers[].email`	Signer's email	`string`
`signers[].order`	Signing order	`number`
`signers[].isPreparer`	Signer is preparer	`boolean`
`signers[].role`	Signer role	`string`
`signers[].isReceivingReminders`	Is signer receiving reminders	`boolean`
`signers[].signLink`	Signing link	`URL`

Response

1{
2  "id": "db0d6b70-35b3-4095-a742-776527b7c1f0",
3  "title": "example document 5",
4  "message": "example message",
5  "signers": [
6    {
7      "id": "97066b2e-1853-4f3a-927c-2b61e454a58e",
8      "name": "Me (Now)",
9      "email": "example@domain.ltd",
10      "order": -1,
11      "isPreparer": true,
12      "role": "Me (Now)",
13      "isReceivingReminders": true,
14      "signLink": null
15    },
16    {
17      "id": "52c93852-7824-4c31-93e7-26984fcf3301",
18      "name": "Maksim Lebedev 2",
19      "email": "example2@domain.ltd",
20      "order": 1,
21      "isPreparer": false,
22      "role": "User",
23      "isReceivingReminders": true,
24      "signLink": "https://example.com/sign/user2/some_file.pdf"
25    },
26    {
27      "id": "2665605c-cf2d-461a-8003-50b60732a494",
28      "name": "Maksim Lebedev",
29      "email": "example3@domain.ltd",
30      "order": 2,
31      "isPreparer": false,
32      "role": "Admin",
33      "isReceivingReminders": true,
34      "signLink": "https://example.com/sign/user3/some_file.pdf"
35    }
36  ]
37}

Rename document

PATCHhttps://api.signaturely.com/api/v1/documents/:id/rename

Request example

1{
2  "title": "New agreement"
3}

Path parameters

Attribute / parameter	Description	Type / values
`id`Required	Document ID	`UUID`

Body parameters

Attribute / parameter	Description	Type / values
`title`Required	The new title for your document	`string`

Attributes

Attribute / parameter	Description	Type / values
`codeAccess`	Access code for document	`string`
`createdAt`	-	`timestamp`
`deletedAt`	-	`timestamp`
`errorText`	Text of error	`string`
`fields`	Document fields	`Object`
`filesUploaded`	Uploaded flag	`boolean`
`id`	Document id	`UUID`
`isFromFormRequest`	Form request flag	`boolean`
`isOrdered`	Ordered flag	`boolean`
`message`	Document message	`string`
`originalFileName`	Original document filename	`string`
`originalFileUrl`	Link for original document file	`URL`
`parts`	Document parts	`Object`
`pdfFileKey`	Link for document pdf file	`URL`
`pdfMetadata`	metadata	`Object`
`recipients`	Array of recipient emails	`string[]`
`resultPdfFileKey`	-	`string`
`shareLink`	Link for share yout documents	`URL`
`signers`	List of signers	`Object`
`status`	Status of document	`"draft" \| "awaiting" \| "completed" "declined"`
`templateId`	Template ID	`UUID`
`testMode`	Test mode flag	`boolean`
`title`	Document title	`string`
`type`	Document type	`"me" \| "others" \| "me_and_other"`
`updatedAt`	Date of last update	`timestamp`

Response

1{
2  "codeAccess": null,
3  "createdAt": "2021-07-27T09:36:34.824Z",
4  "deletedAt": null,
5  "errorText": null,
6  "fields": [
7    {
8      "checked": null,
9      "coordinateX": 77.3903732299805,
10      "coordinateY": 126.555679321289,
11      "createdAt": "2021-07-27T09:37:32.683Z",
12      "dateFormat": null,
13      "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
14      "fontFamily": null,
15      "fontSize": null,
16      "height": 25,
17      "id": "991a8353-ecb6-4bf1-9c23-b56b17a6cb9e",
18      "pageNumber": 1,
19      "required": true,
20      "requisiteId": null,
21      "signed": false,
22      "signerId": "d112370a-74b8-44de-84a5-ed124e9c174e",
23      "text": null,
24      "type": "sign",
25      "updatedAt": "2021-07-27T09:37:32.683Z"
26    }
27  ],
28  "filesUploaded": true,
29  "id": "2665605c-cf2d-461a-8003-50b60732a494",
30  "isFromFormRequest": false,
31  "isOrdered": false,
32  "message": null,
33  "originalFileName": null,
34  "originalFileUrl": null,
35  "parts": [
36    {
37      "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
38      "errorText": null,
39      "files": [
40        {
41          "fileKey": "fileKey",
42          "id": "fileId",
43          "order": 1
44        }
45      ],
46      "filesUploaded": true,
47      "id": "c5b60ea6-e6f0-4911-a6ba-f82d4b810301",
48      "order": 1,
49      "originalFileName": "test.pdf",
50      "originalFileUrl": "https://example.com/doc/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
51      "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
52      "pdfMetadata": {
53        "height": 842,
54        "layout": "portrait",
55        "mediaBox": [
56          0,
57          0,
58          595.25,
59          842
60        ],
61        "offsetX": 0,
62        "offsetY": 0,
63        "pageNumber": 1,
64        "rotate": 0,
65        "size": [
66          595.25,
67          842
68        ],
69        "width": 595.25
70      }
71    }
72  ],
73  "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
74  "pdfMetadata": {
75    "height": 842,
76    "layout": "portrait",
77    "mediaBox": [
78      0,
79      0,
80      595.25,
81      842
82    ],
83    "offsetX": 0,
84    "offsetY": 0,
85    "pageNumber": 1,
86    "rotate": 0,
87    "size": [
88      595.25,
89      842
90    ],
91    "width": 595.25
92  },
93  "recipients": null,
94  "resultPdfFileKey": null,
95  "shareLink": null,
96  "signers": [
97    {
98      "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
99      "email": "signer@example.example",
100      "id": "929fe226-753b-4cd7-b5ae-b095ccad967b",
101      "isFinished": false,
102      "isPreparer": false,
103      "name": "anton1",
104      "order": 2,
105      "role": null,
106      "userId": "db0d6b70-35b3-4095-a742-776527b7c1f0",
107      "isReceivingReminders": true,
108      "isDeclined": false
109    }
110  ],
111  "status": "awaiting",
112  "templateId": null,
113  "testMode": false,
114  "title": "test doc auth",
115  "type": "others",
116  "updatedAt": "2021-07-27T09:37:38.316Z"
117}

Cancel signature request

Cancel Signature Request API call will allow users to cancel an active signature request (basically withdraw the document send).

PATCHhttps://api.signaturely.com/api/v1/documents/:documentId/revert

Path parameters

Attribute / parameter	Description	Type / values
`documentId`Required	Document ID	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`codeAccess`	Access code for document	`string`
`createdAt`	-	`timestamp`
`deletedAt`	-	`timestamp`
`errorText`	Text of error	`string`
`fields`	Document fields	`Object`
`filesUploaded`	Uploaded flag	`boolean`
`id`	Document id	`UUID`
`isFromFormRequest`	Form request flag	`boolean`
`isOrdered`	Ordered flag	`boolean`
`message`	Document message	`string`
`originalFileName`	Original document filename	`string`
`originalFileUrl`	Link for original document file	`URL`
`parts`	Document parts	`Object`
`pdfFileKey`	Link for document pdf file	`URL`
`pdfMetadata`	metadata	`Object`
`recipients`	Array of recipient emails	`string[]`
`resultPdfFileKey`	-	`string`
`shareLink`	Link for share yout documents	`URL`
`signers`	List of signers	`Object`
`status`	Status of document	`"draft" \| "awaiting" \| "completed" "declined"`
`templateId`	Template ID	`UUID`
`testMode`	Test mode flag	`boolean`
`title`	Document title	`string`
`type`	Document type	`"me" \| "others" \| "me_and_other"`
`updatedAt`	Date of last update	`timestamp`

Response

1{
2  "codeAccess": null,
3  "createdAt": "2021-07-27T09:36:34.824Z",
4  "deletedAt": null,
5  "errorText": null,
6  "fields": [
7    {
8      "checked": null,
9      "coordinateX": 77.3903732299805,
10      "coordinateY": 126.555679321289,
11      "createdAt": "2021-07-27T09:37:32.683Z",
12      "dateFormat": null,
13      "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
14      "fontFamily": null,
15      "fontSize": null,
16      "height": 25,
17      "id": "991a8353-ecb6-4bf1-9c23-b56b17a6cb9e",
18      "pageNumber": 1,
19      "required": true,
20      "requisiteId": null,
21      "signed": false,
22      "signerId": "d112370a-74b8-44de-84a5-ed124e9c174e",
23      "text": null,
24      "type": "sign",
25      "updatedAt": "2021-07-27T09:37:32.683Z"
26    }
27  ],
28  "filesUploaded": true,
29  "id": "2665605c-cf2d-461a-8003-50b60732a494",
30  "isFromFormRequest": false,
31  "isOrdered": false,
32  "message": null,
33  "originalFileName": null,
34  "originalFileUrl": null,
35  "parts": [
36    {
37      "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
38      "errorText": null,
39      "files": [
40        {
41          "fileKey": "fileKey",
42          "id": "fileId",
43          "order": 1
44        }
45      ],
46      "filesUploaded": true,
47      "id": "c5b60ea6-e6f0-4911-a6ba-f82d4b810301",
48      "order": 1,
49      "originalFileName": "test.pdf",
50      "originalFileUrl": "https://example.com/doc/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
51      "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
52      "pdfMetadata": {
53        "height": 842,
54        "layout": "portrait",
55        "mediaBox": [
56          0,
57          0,
58          595.25,
59          842
60        ],
61        "offsetX": 0,
62        "offsetY": 0,
63        "pageNumber": 1,
64        "rotate": 0,
65        "size": [
66          595.25,
67          842
68        ],
69        "width": 595.25
70      }
71    }
72  ],
73  "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
74  "pdfMetadata": {
75    "height": 842,
76    "layout": "portrait",
77    "mediaBox": [
78      0,
79      0,
80      595.25,
81      842
82    ],
83    "offsetX": 0,
84    "offsetY": 0,
85    "pageNumber": 1,
86    "rotate": 0,
87    "size": [
88      595.25,
89      842
90    ],
91    "width": 595.25
92  },
93  "recipients": null,
94  "resultPdfFileKey": null,
95  "shareLink": null,
96  "signers": [
97    {
98      "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
99      "email": "signer@example.example",
100      "id": "929fe226-753b-4cd7-b5ae-b095ccad967b",
101      "isFinished": false,
102      "isPreparer": false,
103      "name": "anton1",
104      "order": 2,
105      "role": null,
106      "userId": "db0d6b70-35b3-4095-a742-776527b7c1f0",
107      "isReceivingReminders": true,
108      "isDeclined": false
109    }
110  ],
111  "status": "awaiting",
112  "templateId": null,
113  "testMode": false,
114  "title": "test doc auth",
115  "type": "others",
116  "updatedAt": "2021-07-27T09:37:38.316Z"
117}

Send reminders

Send reminders to document's signers

POSThttps://api.signaturely.com/api/v1/document_sign/documents/:id/send_reminders

Request example

1{
2  "signersIds": [
3    "387a6dc6-1d1a-4de4-8af2-493e5e31e528",
4    "fa482139-50c5-4a38-8edf-852c42eb732d"
5  ]
6}

Path parameters

Attribute / parameter	Description	Type / values
`id`Required	Document ID	`UUID`

Body parameters

Attribute / parameter	Description	Type / values
`signersIds`Required	The array of signers' IDs	`UUID[]`

Delete document

The endpoint allows you to remove the document

DELETEhttps://api.signaturely.com/api/v1/documents

Request example

1{
2  "documentId": "1964b33b-f60b-4104-af30-505e730a9d18"
3}

Body parameters

Attribute / parameter	Description	Type / values
`documentId`Required	Document ID	`UUID`

Response

1{}

Share the document via email

POSThttps://api.signaturely.com/api/v1/document_sign/documents/:id/share

1{
2  "recipients": [
3    {
4      "email": "john.doe@domain.ltd"
5    }
6  ]
7}

Attribute / parameter	Description	Type / values
`id`Required	ID of the document	`UUID`

Body parameters

Attribute / parameter	Description	Type / values
`recipients`Required	Array of objects with email field	`[ { email: string } ]`

Get template file

Get Template File API call will return a PDF, a template previously created on your Signaturely account. The result will be an unedited PDF that the user originally uploaded.

GEThttps://api.signaturely.com/api/v1/document_sign/documents/:templateId/signed_download_url/api

Path parameters

Attribute / parameter	Description	Type / values
`templateId`Required	Template ID	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`result`	Link to the document view	`URL`

Response

1{
2  "result": "https://example.com/download/some_file.pdf"
3}

Delete template

The endpoint allows you to remove the template

DELETEhttps://api.signaturely.com/api/v1/documents/api/templates

Request example

1{
2  "templateId": "1964b33b-f60b-4104-af30-505e730a9d18"
3}

Body parameters

Attribute / parameter	Description	Type / values
`templateId`Required	Template ID	`UUID`

Response

1{}

List templates

This endpoints allows you to get list of your templates available in API

GEThttps://api.signaturely.com/api/v1/documents/api/templates

Query parameters

Attribute / parameter	Description	Type / values
`withTeammateTemplates`	List templates with teammates' templates	`boolean`
`limit`Required	Number of items presented on page	`number`
`page`Required	Number of page	`number`

Attributes

Attribute / parameter	Description	Type / values
`codeAccess`	Access code for document	`string`
`createdAt`	-	`timestamp`
`deletedAt`	-	`timestamp`
`errorText`	Text of error	`string`
`fields`	Document fields	`Object`
`filesUploaded`	Uploaded flag	`boolean`
`id`	Document id	`UUID`
`isFromFormRequest`	Form request flag	`boolean`
`isOrdered`	Ordered flag	`boolean`
`message`	Document message	`string`
`originalFileName`	Original document filename	`string`
`originalFileUrl`	Link for original document file	`URL`
`parts`	Document parts	`Object`
`pdfFileKey`	Link for document pdf file	`URL`
`pdfMetadata`	metadata	`Object`
`recipients`	Array of recipient emails	`string[]`
`resultPdfFileKey`	-	`string`
`shareLink`	Link for share yout documents	`URL`
`signers`	List of signers	`Object`
`status`	Status of document	`"draft" \| "awaiting" \| "completed" "declined"`
`templateId`	Template ID	`UUID`
`testMode`	Test mode flag	`boolean`
`title`	Document title	`string`
`type`	Document type	`"me" \| "others" \| "me_and_other"`
`updatedAt`	Date of last update	`timestamp`

Response

1{
2  "data": [
3    {
4      "codeAccess": null,
5      "createdAt": "2021-07-27T09:36:34.824Z",
6      "deletedAt": null,
7      "errorText": null,
8      "fields": [
9        {
10          "checked": null,
11          "coordinateX": 77.3903732299805,
12          "coordinateY": 126.555679321289,
13          "createdAt": "2021-07-27T09:37:32.683Z",
14          "dateFormat": null,
15          "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
16          "fontFamily": null,
17          "fontSize": null,
18          "height": 25,
19          "id": "991a8353-ecb6-4bf1-9c23-b56b17a6cb9e",
20          "pageNumber": 1,
21          "required": true,
22          "requisiteId": null,
23          "signed": false,
24          "signerId": "d112370a-74b8-44de-84a5-ed124e9c174e",
25          "text": null,
26          "type": "sign",
27          "updatedAt": "2021-07-27T09:37:32.683Z"
28        }
29      ],
30      "filesUploaded": true,
31      "id": "2665605c-cf2d-461a-8003-50b60732a494",
32      "isFromFormRequest": false,
33      "isOrdered": false,
34      "message": null,
35      "originalFileName": null,
36      "originalFileUrl": null,
37      "parts": [
38        {
39          "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
40          "errorText": null,
41          "files": [
42            {
43              "fileKey": "fileKey",
44              "id": "fileId",
45              "order": 1
46            }
47          ],
48          "filesUploaded": true,
49          "id": "c5b60ea6-e6f0-4911-a6ba-f82d4b810301",
50          "order": 1,
51          "originalFileName": "test.pdf",
52          "originalFileUrl": "https://example.com/doc/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
53          "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
54          "pdfMetadata": {
55            "height": 842,
56            "layout": "portrait",
57            "mediaBox": [
58              0,
59              0,
60              595.25,
61              842
62            ],
63            "offsetX": 0,
64            "offsetY": 0,
65            "pageNumber": 1,
66            "rotate": 0,
67            "size": [
68              595.25,
69              842
70            ],
71            "width": 595.25
72          }
73        }
74      ],
75      "pdfFileKey": "pdf/97066b2e-1853-4f3a-927c-2b61e454a58e/19e72610-980a-41ae-a2f3-3a7aeb095cb8.pdf",
76      "pdfMetadata": {
77        "height": 842,
78        "layout": "portrait",
79        "mediaBox": [
80          0,
81          0,
82          595.25,
83          842
84        ],
85        "offsetX": 0,
86        "offsetY": 0,
87        "pageNumber": 1,
88        "rotate": 0,
89        "size": [
90          595.25,
91          842
92        ],
93        "width": 595.25
94      },
95      "recipients": null,
96      "resultPdfFileKey": null,
97      "shareLink": null,
98      "signers": [
99        {
100          "documentId": "2665605c-cf2d-461a-8003-50b60732a494",
101          "email": "signer@example.example",
102          "id": "929fe226-753b-4cd7-b5ae-b095ccad967b",
103          "isFinished": false,
104          "isPreparer": false,
105          "name": "anton1",
106          "order": 2,
107          "role": null,
108          "userId": "db0d6b70-35b3-4095-a742-776527b7c1f0",
109          "isReceivingReminders": true,
110          "isDeclined": false
111        }
112      ],
113      "status": "awaiting",
114      "templateId": null,
115      "testMode": false,
116      "title": "test doc auth",
117      "type": "others",
118      "updatedAt": "2021-07-27T09:37:38.316Z"
119    }
120  ]
121}

List team members

List Team Members API call will return a list of all the actual team users in the Signaturely account, with their respective account types.

GEThttps://api.signaturely.com/api/v1/teams/members

Attributes

Attribute / parameter	Description	Type / values
`id`	Team's ID	`UUID`
`ownerId`	Team owner's ID	`UUID`
`owner`	Object represents an owner information	`{ id: UUID, email: string, name: string, role: "owner" }`
`members`	Team members	`[ { id: UUID, email: string, name: string, role: "user" \| "admin" } ]`

Response

1{
2  "id": "39fea8da-e1e7-4c82-b964-ec6e1a98b3db",
3  "ownerId": "1964b33b-f60b-4104-af30-505e730a9d18",
4  "owner": {
5    "id": "1964b33b-f60b-4104-af30-505e730a9d18",
6    "email": "john.doe@domain.ltd",
7    "name": "John Doe",
8    "role": "owner"
9  },
10  "members": [
11    {
12      "id": "c801cc9b-34b7-4099-a64d-bd1b12ebadf8",
13      "email": "example2@domain.ltd",
14      "name": "Joanna Doe",
15      "role": "admin"
16    },
17    {
18      "id": "d19c9167-4ee2-4dac-b966-e50ca15aad2e",
19      "email": "example3@domain.ltd",
20      "name": "James Doe",
21      "role": "user"
22    }
23  ]
24}

Add team member

Add Team Member API call will allow to add new team members directly via API.

POSThttps://api.signaturely.com/api/v1/add-teammates/with-role

Request example

1{
2  "members": [
3    {
4      "email": "example@domain.ltd",
5      "name": "John Doe",
6      "role": "user"
7    },
8    {
9      "email": "example2@domain.ltd",
10      "name": "Joanna Doe",
11      "role": "admin"
12    },
13    {
14      "email": "example3@domain.ltd",
15      "name": "James Doe"
16    }
17  ]
18}

Body parameters

Attribute / parameter	Description	Type / values
`members`Required	Information about members.	`[ { email: string, name: string, role?: "user" \| "admin" } ]`

Attributes

Attribute / parameter	Description	Type / values
`id`	Team member's ID	`—`
`email`	Team member's email	`—`
`name`	Team member's name	`—`
`role`	Team member's role	`—`

Response

1[
2  {
3    "id": "1964b33b-f60b-4104-af30-505e730a9d18",
4    "email": "john.doe@domain.ltd",
5    "name": "John Doe",
6    "role": "user"
7  },
8  {
9    "id": "c801cc9b-34b7-4099-a64d-bd1b12ebadf8",
10    "email": "example2@domain.ltd",
11    "name": "Joanna Doe",
12    "role": "admin"
13  },
14  {
15    "id": "d19c9167-4ee2-4dac-b966-e50ca15aad2e",
16    "email": "example3@domain.ltd",
17    "name": "James Doe",
18    "role": "user"
19  }
20]

Remove team members

Remove Team Members API call will allow to remove team members directly via API.

DELETEhttps://api.signaturely.com/api/v1/remove-teammates/email

Request example

1{
2  "emails": [
3    "example@domain.ltd"
4  ]
5}

Body parameters

Attribute / parameter	Description	Type / values
`emails`	The emails of members to remove	`string[]`

Change team member account type

Change Team Member Account Type API call will allow to change the account type of any user that is already a team member of your Signaturely account

PATCHhttps://api.signaturely.com/api/v1/teams/members/role

Request example

1{
2  "email": "john.doe@domain.ltd",
3  "role": "admin"
4}

Body parameters

Attribute / parameter	Description	Type / values
`email`Required		`string`
`role`Required		`"user" \| "admin"`

Attributes

Attribute / parameter	Description	Type / values
`appSumoStatus`	AppSumo status	`"standard" \| "full" \| null`
`avatarUrl`	Link on account avatar	`URL`
`email`	User's email	`string`
`id`	User's ID	`UUID`
`name`	User's name	`string`
`status`	User's status	`"active" \| "freeze"`
`role`	User's role	`"user" \| "admin"`

Response

1{
2  "appSumoStatus": null,
3  "avatarUrl": null,
4  "email": "john.doe@domain.ltd",
5  "id": "d112370a-74b8-44de-84a5-ed124e9c174e",
6  "name": "username",
7  "status": "active",
8  "role": "admin"
9}

Get folder list

This endpoints allows you to get list of your documents

GEThttps://api.signaturely.com/api/v1/api-integrations/folders

Query parameters

Attribute / parameter	Description	Type / values
`limit`Required	Number of items presented on page	`number`
`page`Required	Number of page	`number`
`folderId`	Start point of search (root if not present)	`UUID`
`orderingKey`	Order by certain field	`"title" \| "id" \| "foldersCount" \| "documentsCount"`
`orderingDirection`	Ascending or descending	`"ASC" \| "DESC"`

Attributes

Attribute / parameter	Description	Type / values
`id`	Folder's ID	`UUID`
`title`	Folder's title	`string`
`documentsCount`	Number of documents in folder	`number`
`foldersCount`	Number of folders within	`number`
`itemCount`	Items count on the page	`number`
`totalItems`	Total count	`number`
`itemsPerPage`	Limit setting in request	`number`
`totalPages`	Total pages count	`number`
`currentPage`	Current page number	`number`

Response

1{
2  "items": [
3    {
4      "id": "f8bd5c30-0724-49de-8e46-7793a41d1be3",
5      "title": "Folder 1",
6      "documentsCount": 30,
7      "foldersCount": 15
8    }
9  ],
10  "itemCount": 1,
11  "totalItems": 3,
12  "itemsPerPage": 1,
13  "totalPages": 3,
14  "currentPage": 1
15}

Get folder

Get folder information via API call.

GEThttps://api.signaturely.com/api/v1/api-integrations/folders/:id

Path parameters

Attribute / parameter	Description	Type / values
`id`Required	Folder's ID ('null' for root)	`UUID \| null`

Attributes

Attribute / parameter	Description	Type / values
`id`	Folder's ID	`UUID`
`title`	Folder's title	`string`
`parentId`	Parent Folder ID (null if root)	`UUID`
`documentsCount`	Number of documents in folder	`number`
`foldersCount`	Number of folders within	`number`

Response

1{
2  "id": "f8bd5c30-0724-49de-8e46-7793a41d1be3",
3  "title": "Awesome Title",
4  "parentId": "9e3c8438-1615-4786-913e-777005f1cd88",
5  "documentsCount": 10,
6  "foldersCount": 20
7}

Create folder

Create folder for documents via API call.

POSThttps://api.signaturely.com/api/v1/api-integrations/folders

Request example

1{
2  "title": "Awesome Title",
3  "parentId": "9e3c8438-1615-4786-913e-777005f1cd88"
4}

Body parameters

Attribute / parameter	Description	Type / values
`title`Required	New folder's title	`string`
`parentId`	Parent Folder ID (if not defined, then parent id will be null)	`UUID`

Attributes

Attribute / parameter	Description	Type / values
`id`	Folder's ID	`UUID`
`title`	Folder's title	`string`
`parentId`	Parent Folder ID (null if root)	`UUID`
`documentsCount`	Number of documents in folder	`number`
`foldersCount`	Number of folders within	`number`

Response

1{
2  "id": "f8bd5c30-0724-49de-8e46-7793a41d1be3",
3  "title": "Awesome Title",
4  "parentId": "9e3c8438-1615-4786-913e-777005f1cd88",
5  "documentsCount": 0,
6  "foldersCount": 0
7}

Rename folder

Rename folder via API call.

PATCHhttps://api.signaturely.com/api/v1/api-integrations/folders/:id

Request example

1{
2  "title": "Awesome Title 2"
3}

Path parameters

Attribute / parameter	Description	Type / values
`id`Required	Folder's ID	`UUID`

Body parameters

Attribute / parameter	Description	Type / values
`title`Required	Folder's new title	`string`

Attributes

Attribute / parameter	Description	Type / values
`id`	Folder's ID	`UUID`
`title`	Folder's title	`string`
`parentId`	Parent Folder ID (null if root)	`UUID`
`documentsCount`	Number of documents in folder	`number`
`foldersCount`	Number of folders within	`number`

Response

1{
2  "id": "f8bd5c30-0724-49de-8e46-7793a41d1be3",
3  "title": "Awesome Title 2",
4  "parentId": "9e3c8438-1615-4786-913e-777005f1cd88",
5  "documentsCount": 10,
6  "foldersCount": 20
7}

Move entities to folder

Move documents or folders into specific folder.

PATCHhttps://api.signaturely.com/api/v1/api-integrations/folders/move

Request example

1{
2  "parentId": "55e4e9b7-18f6-4255-8059-451b55ae279d",
3  "entityIds": [
4    "d3093a6c-4164-4c4b-b3f7-344857a8ebc6",
5    "b3abff61-0780-4e59-a97d-0ac07ef1ca2a",
6    "dcc5c488-6e8d-4a5e-9f13-2ecc6deb2443"
7  ]
8}

Body parameters

Attribute / parameter	Description	Type / values
`parentId`	Folder's ID ('null' for root)	`UUID \| null`
`entityIds`Required	IDs of folders/documents that you want to move	`UUID[]`

Response

1{}

Webhook

This endpoints allows you to subscribe on webhook events

POSThttps://api.signaturely.com/api/v1/hooks/subscribe

1{
2  "hookUrl": "https://mydomain.com/webhook",
3  "webhookEvents": [
4    "document_sent",
5    "document_completed"
6  ]
7}

Attribute / parameter	Description	Type / values
`hookUrl`Required	URL to subscribe	`URL`
`webhookEvents[]`Required	List of subscribing webhook events	`"document_sent" \| "document_completed"`

Attributes

Attribute / parameter	Description	Type / values
`id`	Webhook's ID	`UUID`
`webhookEvents[]`	List of subscribed events	`"document_sent" \| "document_completed"`
`hookUrl`	Subscribed webhook url	`URL`
`userId`	User's ID	`UUID`
`createdAt`	Webhook creation date	`Date`

1{
2  "data": {
3    "id": "b073d479-99d8-4c9b-a4b5-e18111d69055",
4    "webhookEvents": [
5      "document_sent",
6      "document_completed"
7    ],
8    "hookUrl": "https://mydomain.com/webhook",
9    "userId": "9e185f18-de27-487f-9a87-df9d1f5b8d34",
10    "createdAt": "Thu Sep 10 2026"
11  }
12}

Unsubscribe

This endpoints allows you to unsubscribe from webhook events

DELETEhttps://api.signaturely.com/api/v1/hooks/unsubscribe/:id

Path parameters

Attribute / parameter	Description	Type / values
`id`Required	ID of unsubscribing webhook	`UUID`

Signaturely API documentation

Attributes

Body parameters

Attributes

Body parameters

Query parameters

Attributes

Path parameters

Attributes

Path parameters

Attributes

Path parameters

Attributes

Path parameters

Attributes

Query parameters

Attributes

Path parameters

Body parameters

Attributes

Path parameters

Attributes

Path parameters

Body parameters

Body parameters

Path parameters

Body parameters

Path parameters

Attributes

Body parameters

Query parameters

Attributes

Attributes

Body parameters

Attributes

Body parameters

Body parameters

Attributes

Query parameters

Attributes

Path parameters

Attributes

Body parameters

Attributes

Path parameters

Body parameters

Attributes

Body parameters

Subscribe

Body parameters

Attributes

Unsubscribe

Path parameters