Fair API Pricing
No Surprise Fees
Secure Your Document Distribution and Management with a Signority API Plan
Home
Getting Started
API Reference
Use Cases
Frequently Asked Questions
Updating and Sending a Document
PUT: /v1/documents/documents/{docID}/
Description
Changes the settings on a document and prepares it for sending to the invitee list
Format
JSON <multipart/related>
URL Parameters
None (Replace docID with the document’s ID)
Data Parameters
Field | Mandatory | Type | Description |
---|---|---|---|
title | No | String | The name of the document |
signingStatus | Yes | Integer | 52 : system will send the invitation out to the recipients. 51 : system will not send the invitation SIGNING_STATUS_DRAFT = 51 SIGNING_STATUS_IN_PROGRESS = 52 SIGNING_STATUS_COMPLETED = 53 SIGNING_STATUS_REJECTED = 54 (Must be changed to 52) |
folderId | No | Integer | Folder to place the document in |
documentType | No | Integer | DOCUMENT_TYPE_DOCUMENT = 5DOCUMENT_TYPE_TEMPLATE_LINK =Â 6 DOCUMENT_TYPE_REGULAR_TEMPLATE =Â 7 DOCUMENT_TYPE_BULK_TEMPLATE = 8 |
version | No | Integer | Optimistic locking version retrieved |
settings | No | JSONArray | Document to edit the settings of |
emailSubject | String | Text in the email subject | |
emailBody | String | Text written in the email body | |
Tags | No | JSONArray | List of Tags to be put in the document |
id | Integer | ID of the tag | |
pageId | Integer | Page that the tag is on | |
name | String | Name of the tag | |
groupName | String | Name of group (If applicable) | |
isMandatory | Boolean | Whether the field must be filled out | |
height | Integer | Number of pixels in height | |
invitationId | Integer | ID of the user it’s assigned to | |
left | Integer | Number of pixels from the left of the file | |
top | Integer | Number of pixels from the top of the file | |
type | Integer | Contact us for more information about it’s usage | |
width | Integer | Number of pixels in width | |
text | String | Text shown in text tag | |
image | String | Image source for image tag | |
style | JSONString | Contact us for usage | |
 Invitations | No | JSONArray | Array of new user objects |
Response
Response returns a response containing the information of the updated document or an error response
Response Parameters
Field | Mandatory | Type | Description |
---|---|---|---|
id | Yes | Integer | ID of the document |
title | Yes | String | Name of the document |
senderName | Yes | String | The name shown in the invitation and on UI |
senderEmail | Yes | String | The email address shown in the invitation email |
signingStatus | Yes | Integer | The current status of document * when creating or updating a document, if signingStatus = 52, system will send the invitation out to the recipients. SIGNING_STATUS_DRAFT = 51 SIGNING_STATUS_IN_PROGRESS = 52 SIGNING_STATUS_COMPLETED = 53 SIGNING_STATUS_REJECTED = 54 |
createdTime | No | Integer | Time that the document was created |
lastModifiedTime | No | Integer | Time of the last modification |
documentSentTime | No | String | ‘YYYY-MM-DD HH:MM:SS.m Year, Month, Day, Hour, Minute, Second, Millisecond |
userId | No | Integer | The owner of the account which is used to send this document out. |
documentType | Yes | Integer | DOCUMENT_TYPE_DOCUMENT = 5 DOCUMENT_TYPE_TEMPLATE_LINK = 6 DOCUMENT_TYPE_REGULAR_TEMPLATE = 7 DOCUMENT_TYPE_BULK_TEMPLATE = 8 |
documentSetting | No | JSONObject | The general settings of the document |
invitations | No | JSONArray | The recipients list |
Files | No | JSONArray | Usually don’t need to parse this part of data! Include: Files, pages and tags information |
histories | No | JSONArray | Audit trail |
EXAMPLE REQUEST / RESPONSE (Python)
Request: data = { "document": { "signingStatus": 51 } } requests.put('https://sign.signority.com/api/v1/documents/{doc_id}', data, auth=(apiKey, '')) Response: {'document': {'DocumentRoot': '/var/signority_doc1', Â Â Â Â Â Â Â 'GUID': '8ec1f45a-bdf7-4972-8716-35919d12c768', Â Â Â Â Â Â Â 'PKIEnabled': False, Â Â Â Â Â Â Â 'createdTime': 1590593250000, Â Â Â Â Â Â Â 'documentSentTime': 'Wed May 27 11:27:32 EDT 2020', Â Â Â Â Â Â Â 'documentSetting': {'EmailBody': '', Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'EmailSubject': 'Python User 27 has ' Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'sent you the ' Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'document API Test ' Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'document 001 (11)', Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'EnableIndicatorManuallyFilledAddress': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'ExpireDaysAfterSent': 180, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'LastReminderDaysBeforeExpire': 3, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'LastReminderEmailHasBeenSent': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'MaxReminderEmailCount': 5, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationExpiredDocEmailEnabled': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationFinalEmailWithAttachmentEmailEnabled': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationFinalEmailWithAttachmentToAllRecipientsEnabled': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationFinalEmailWithPDFDownloadLinkToAllRecipientsEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationFinalEmailWithPDFDownloadLinkToSenderEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationNoFinalEmailToRecipientsEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationNoFinalEmailToSenderEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationRecipientSignDocEmailEnabled': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationRecipientViewDocEmailEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'NotificationReminderEmailEnabled': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'PKIEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'ReminderEmailIntervalDays': 3, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'TemplateLinkCaseNumberEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'TemplateLinkPreAuthorizedCodeEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'TemplateNewlyDocShareToTeamEnabled': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'documentId': 27445, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'enablePageViewEvidence': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideButtonChangeSigner': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideButtonDownload': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideButtonHelp': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideButtonReject': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideButtonSave': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideButtonStatus': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideButtonThumbnail': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideSigningButtonDrawingSignature': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideSigningButtonTypeSignature': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hideSigningButtonUploadSignature': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'id': 27317, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'languageCode': 550, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'notificationFinalEmailWithAttachmentToAllRecipientsEnabled': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'postBackSuccess': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'templateLinkClientDataDisplayEnable': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'templateLinkClientDataRequired': False}, Â Â Â Â Â Â Â 'documentType': 5, Â Â Â Â Â Â Â 'files': [{'id': 28404, Â Â Â Â Â Â Â Â Â Â Â Â 'name': 'blank', Â Â Â Â Â Â Â Â Â Â Â Â 'pages': [{'height': 792, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'id': 173542, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'sequence': 1, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'tags': [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'width': 612}], Â Â Â Â Â Â Â Â Â Â Â Â 'sequence': 1, Â Â Â Â Â Â Â Â Â Â Â Â 'type': 151}, Â Â Â Â Â Â Â Â Â Â Â Â {'id': 28405, Â Â Â Â Â Â Â Â Â Â Â Â 'name': 'blank', Â Â Â Â Â Â Â Â Â Â Â Â 'pages': [{'height': 792, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'id': 173543, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'sequence': 1, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'tags': [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'width': 612}], Â Â Â Â Â Â Â Â Â Â Â Â 'sequence': 1, Â Â Â Â Â Â Â Â Â Â Â Â 'type': 151}], Â Â Â Â Â Â Â 'histories': [{'action': 'Document created by', Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'actionId': 352, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'dateTime': 1590593250000, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'documentID': 27445, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'email': 'pythonuser27@mail.com', Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'id': 62431, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'ip': '174.119.17.176', Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'name': 'Python User 27'}, Â Â Â Â Â Â Â Â Â Â Â Â Â Â {'action': 'Document sent by', Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'actionId': 353, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'dateTime': 1590593252069, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'documentID': 27445, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'email': 'pythonuser27@mail.com', Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'id': 62432, Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'ip': '174.119.17.176', Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'name': 'Python User 27'}], Â Â Â Â Â Â Â 'hsmDigitalSignEnabled': False, Â Â Â Â Â Â Â 'id': 27445, Â Â Â Â Â Â Â 'invitations': [{'EnableIndicatorManuallyFilledAddress': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'GUID': '247a4b17-d871-47b5-b365-1439f84efee3', Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'ReminderEmailCount': 0, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'actionType': 15, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'authentications': [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'canSignTags': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hostedSignerCanSignTags': True, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'hostedSigners': [], Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'id': 33157, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'invitationEmailBounced': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'isBulkSigner': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'lastReminderSent': False, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'recipientEmail': 'pythonrecip@mail.com', Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'recipientName': 'Python Recipient', Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'sequence': 1, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'status': 61, Â Â Â Â Â Â Â Â Â Â Â Â Â Â Â 'witnesses': []}], Â Â Â Â Â Â Â 'isOverlayForNewDocFileUpload': False, Â Â Â Â Â Â Â 'isPublished': False, Â Â Â Â Â Â Â 'lastModifiedTime': 1590593252042, Â Â Â Â Â Â Â 'senderEmail': 'pythonuser27@mail.com', Â Â Â Â Â Â Â 'senderName': 'Python User 27', Â Â Â Â Â Â Â 'sharedToTeam': False, Â Â Â Â Â Â Â 'signingStatus': 52, Â Â Â Â Â Â Â 'templateLinkClientDataDisplayEnable': False, Â Â Â Â Â Â Â 'title': 'API Test document 001 (11)', Â Â Â Â Â Â Â 'userId': 1354, Â Â Â Â Â Â Â 'version': 4}, 'success': True}