Fair API Pricing

    No Surprise Fees

    Secure Your Document Distribution and Management with a Signority API Plan

    Home
    Home
    Quick Navigation
    Getting Started
    Getting Started
    Quick Start
    Testing
    Authentication
    Charging and Rate Limits
    API Reference
    API Reference
    Callbacks
    Constants
    Examples
    Examples
    Integration Examples
    Sample Code
    Anchor Tags
    Use Cases
    Use Cases
    Frequently Asked Questions
    Frequently Asked Questions
    Further Support

    Bulk Sign Using a Template

    POST:  /v1/templates/use/{docID}/

    Description
    Send out the bulk sign template to the list of invitees

     

    Format
    JSON <multipart/related>

     

    URL Parameters
    None (Replace docID with the document’s ID)

     

    Data Parameters

    Field Mandatory Type Description
    callback No String ID of the tag
    Invitations Yes JSONArray Array of invitee objects
    recipientName String Name of the recipient
    recipientEmail String Email of the recipient
    user_name String The user’s name
    user_tele String The user’s phone number
    user_add String The user’s address
    user_code String The user’s code

    Response
    Response returns a response containing the information of the document that was sent

     

    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
    invitations Yes JSONArray Array of user objects

    EXAMPLE REQUEST / RESPONSE (Python)
    Request:
data =
{
  "callback": "",
  "invitations": [
    {
      "recipientName": "API TEST USER01",
      "recipientEmail": "postman01@mail.com",
      "user_name": "Postman User 1",
      "user_tel": "1234567890",
      "user_add": "780-2300 St Laurent Street",
      "user_code": "ST20200521"
    },
    {
      "recipientName": "API TEST USER02",
      "recipientEmail": "postman02@mail.com",
      "user_name": "Postman User 2",
      "user_tel": "0987654321",
      "user_add": "780-2300 St Laurent Street",
      "user_code": "ST20200522"
    }
  ]}
requests.post('https://sign.signority.com/api/v1/template/use/{doc_id}', data, auth=(apiKey, ''))
Response:
{
    'documents':
        {
            'DocumentRoot': '/var/signority_doc1',
            'GUID': '9b9a3eac-76da-42a4-ae18-6765111b0777',
            'PKIEnabled': False,
            'createdTime': 1590762143000,
            'documentSentTime': '2020-05-29 10:22:23.0',
            'documentSetting':
                {
                    'EmailBody': '',
                    'EmailSubject': 'Python User 27 has sent you the document API Test document 001 (5)',
                    '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': 27788,
                    'enablePageViewEvidence': False,
                    'hideButtonChangeSigner': False,
                    'hideButtonDownload': False,
                    'hideButtonHelp': False,
                    'hideButtonReject': False,
                    'hideButtonSave': False,
                    'hideButtonStatus': False,
                    'hideButtonThumbnail': False,
                    'hideSigningButtonDrawingSignature': False,
                    'hideSigningButtonTypeSignature': False,
                    'hideSigningButtonUploadSignature': False,
                    'id': 27660,
                    'languageCode': 550,
                    'notificationFinalEmailWithAttachmentToAllRecipientsEnabled': True,
                    'postBackSuccess': False,
                    'templateLinkClientDataDisplayEnable': False,
                    'templateLinkClientDataRequired': False
                },
            'documentType': 8,
            'files': [
                {
                    'id': 28756,
                    'name': 'blank',
                    'pages': [
                        {
                            'height': 792,
                            'id': 173895,
                            'sequence': 1,
                            'tags': [],
                            'width': 612
                        }
                    ],
                    'sequence': 1,
                    'type': 151
                }
            ],
            'histories': [
                {
                    'action': 'Document created by',
                    'actionId': 352,
                    'dateTime': 1590762143000,
                    'documentID': 27788,
                    'email': 'pythonuser27@mail.com',
                    'id': 62852,
                    'ip': '0.0.0.0',
                    'name': 'Python User 27'
                }
            ],
            'hsmDigitalSignEnabled': False,
            'id': 27788,
            'invitations': [
                {
                    'EnableIndicatorManuallyFilledAddress': True,
                    'GUID': 'c5f1ca62-3500-410e-9546-3006136a7154',
                    'ReminderEmailCount': 0,
                    'actionType': 15,
                    'authentications': [],
                    'canSignTags': True,
                    'hostedSignerCanSignTags': True,
                    'hostedSigners': [],
                    'id': 33535,
                    'invitationEmailBounced': False,
                    'isBulkSigner': False,
                    'lastReminderSent': False,
                    'recipientEmail': 'pythonrecip@mail.com',
                    'recipientName': 'Python Recipient',
                    'sequence': 1,
                    'status': 60,
                    'witnesses': []
                }
            ],
            'isPublished': False,
            'lastModifiedTime': 1590762145000,
            'senderEmail': 'pythonuser27@mail.com',
            'senderName': 'Python User 27',
            'sharedToTeam': False,
            'signingStatus': 51,
            'templateLinkClientDataDisplayEnable': False,
            'title': 'API Test document 001 (5)',
            'userId': 1354,
            'version': 4
        }
}