Template

Template - an entity that holds the structure of a document and serves for generating its copies.

signNow users cannot make a template without uploading a document first. They can generate (clone) a new instance of a document from it.

What can you do with templates?

When you create an invite using a template, recipients sign the instance of this template - a document. The instance can be customized specifically for the recipient, for example, prefilled with the account info. Templates can be shared within a team and edited only by the owner.

The template object

The template object in signNow is basically a document object whose template attribute is true.

https://docs.signnow.com/sn/ref/document/getdocumentdocumentid (example response, change template parameter to true)

Attributes
  • id string
    Unique identifier for the object.
  • user_id string
    Unique identifier of the document owner.
  • user_id string
    Unique identifier of the document owner.
  • document_name string
    The name of the document.
  • page_count string
    The number of pages in the document.
  • created string
    Unix timestamp for when the document was created.
  • updated string
    Unix timestamp for when the document was updated.
  • original_filename string
    The original name of the document upon uploading to signNow.
  • origin_document_id string
    The document ID if redirected from another source.
  • owner string
    Owner’s account email address
  • template boolean
    Whether this document is a template: true - yes, it is a template; false - no, it isn’t.
  • signatures array[object]
    Signature objects on the document: one signature - one object.
  • fields array[object]
    Fillable field objects in the document. Learn more in Fields
  • roles array[object]
    Signer roles. Every field must be assigned to a role. One signer - one role.
  • tags array[object]
    Text tags that represent fillable fields in the document. Learn more in Text tags
  • seals array[object]
    Seal objects in the document.
  • texts array[object]
    Contents of the fillable fields.
  • field_invites array[object]
    Invites to sign this document. Learn more in Invite
More attributes
  • thumbnail array[string]
  • inserts array[object]
  • checks array[object]
  • requests array[object]
  • notary_invites array[object]
  • attachments array[object]
  • version_time string
  • enumeration_options array[object]
  • routing_details array[object]
  • integrations array[object]
  • hyperlinks array[object]
  • radiobuttons array[object]
  • document_group_template_info array[string]
  • originator_organization_settings array[object]
  • document_group_info array[string]
  • settings array[booleans]
  • parent_id string
  • originator_logo string
  • pages array[object]
The template object
                "id": "a09b26feeba7ce70228afe6290f4445700b6f349", 
              
                  "user_id": "890d13607d89a7b3f6e67a14757d02ec00cf5eae", 
              
                  "document_name": "pdf-test", 
              
                  "page_count": "1", 
              
                  "created": "1565787561", 
              
                  "updated": "1565858757", 
              
                  "original_filename": "pdf-test.pdf", 
              
                  "origin_document_id": null, 
              
                  "owner": "api@signnow.com", 
              
                  "template": true, 
              
                  "thumbnail": { 
              
                    "small": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=small", 
              
                    "medium": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=medium", 
              
                    "large": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large" 
              
                  }, 
              
                  "signatures": [ 
              
                    { 
              
                      "id": "2600e6cfbe65cfeb5624749fbe75b432c392c128", 
              
                      "user_id": "e9f673c1bc43f95d611295a7aa3ec425e433715f", 
              
                      "email": "guest_signer_585873482916@no.reply", 
              
                      "page_number": "0", 
              
                      "width": "56", 
              
                      "height": "21", 
              
                      "x": "70", 
              
                      "y": "362", 
              
                      "created": "1565858757", 
              
                      "data": "iVBORw0KGgoAAAANSUhEUgAAApoAAAD8CAYAAADXPgSRAAAgAElEQVR4Xu2dB9QsRZmG3zVHQETFHGANYM7ZVRcVc0YFw5pzjgiKETFn1hzWnBVzdk2romJERVCCoII5Yd7z7K1Z5vbt7qme6equ7nq/c/5zw99dXfVUzcw7VV/4F9lMwARMwARMwARMwARMIAGBf0nQpps0ARMwARMwARMwARMwAVloehGYgAmYgAmYgAmYgAkkIWChmQSrGzUBEzABEzABEzABE7DQ9BowARMwARMwARMwARNIQsBCMwlWN2oCJmACJmACJmACJmCh6TVgAiZgAiZgAiZgAiaQhICFZhKsbtQETMAETMAETMAETMBC02vABEzABEzABEzABEwgCQELzSRY3agJmIAJ"
              
                      } 
              
                    ], 
              
                    "seals": [], 
              
                    "texts": [], 
              
                    "checks": [], 
              
                    "inserts": [], 
              
                    "tags": [ 
              
                      { 
              
                        "type": "system", 
              
                        "name": "fields" 
              
                      } 
              
                    ], 
              
                    "fields": [ 
              
                      { 
              
                        "id": "d88e08ddbc12ee20f6830750787f8314f38938b4", 
              
                        "type": "signature", 
              
                        "role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca", 
              
                        "json_attributes": { 
              
                          "page_number": 0, 
              
                          "x": 70, 
              
                          "y": 362, 
              
                          "width": 83, 
              
                          "height": 21, 
              
                          "required": true, 
              
                          "name": "Signature_1" 
              
                        }, 
              
                        "role": "Signer 1", 
              
                        "originator": "api@signnow.com", 
              
                        "fulfiller": "guest_signer_585873482916@no.reply", 
              
                        "field_request_id": "c23790a9ad6a7cbc586f6b8d8a0c1f360097047c", 
              
                        "element_id": "2600e6cfbe65cfeb5624749fbe75b432c392c128", 
              
                        "field_request_canceled": null, 
              
                        "template_field_id": null, 
              
                        "field_id": "c23790a9ad6a7cbc586f6b8d8a0c1f360097047c" 
              
                      } 
              
                    ], 
              
                    "requests": [], 
              
                    "notary_invites": [], 
              
                    "roles": [ 
              
                      { 
              
                        "unique_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca", 
              
                        "signing_order": "1", 
              
                        "name": "Signer 1" 
              
                       } 
              
                      ], 
              
                    "field_invites": [ 
              
                      { 
              
                        "id": "372cf980e486bd977da68f7ea31da0f05dd01139", 
              
                        "status": "fulfilled", 
              
                        "is_document_locked": "0", 
              
                        "password_protected": "0", 
              
                        "password_type": "", 
              
                        "password_method": "", 
              
                        "reassign": "0", 
              
                        "pfrid": null, 
              
                        "pfrtype": null, 
              
                        "pfrmerchant_id": null, 
              
                        "pfrstatus": null, 
              
                        "pframount": null, 
              
                        "pfrpayment_transaction_id": null, 
              
                        "pfrcreated": null, 
              
                        "pfrmerchant_type": null, 
              
                        "pfrmerchant_account_name": null, 
              
                        "pfrcurrency_name": null, 
              
                        "pfrjson_attributes": null, 
              
                        "id_verification_required": "NO", 
              
                        "id_verified": "UNVERIFIED", 
              
                        "created": "1565858734", 
              
                        "email": "guest_signer_585873482916@no.reply", 
              
                        "role": "Signer 1", 
              
                        "reminder": "0", 
              
                        "updated": "1565858757", 
              
                        "expiration_time": "1568450734", 
              
                        "role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca", 
              
                        "electronic_consent_id": null, 
              
                        "stripe_ach_bank_account_verified": "0", 
              
                        "stripe_ach_bank_account_present": "0", 
              
                        "redirect_uri": null, 
              
                        "declined": [], 
              
                        "prefill_signature_name": null, 
              
                        "force_new_signature": null, 
              
                        "signing_instructions": null, 
              
                        "required_preset_signature_name": null, 
              
                        "decline_by_signature": null, 
              
                        "electronic_consent_required": 0, 
              
                        "payment_request": null 
              
                      } 
              
                    ], 
              
                  "version_time": "1565858757", 
              
                  "enumeration_options": [], 
              
                  "attachments": [], 
              
                  "routing_details": [ 
              
                    { 
              
                      "id": "983f2a230a808d9a7d92fd15ae2902d21441762a", 
              
                      "data": [ 
              
                        { 
              
                          "default_email": "", 
              
                          "inviter_role": false, 
              
                          "name": "Signer 1", 
              
                          "role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca", 
              
                          "signing_order": 1 
              
                        } 
              
                      ], 
              
                      "created": "1565858709", 
              
                      "updated": null, 
              
                      "cc": [], 
              
                      "cc_step": [], 
              
                      "invite_link_instructions": null 
              
                      } 
              
                    ], 
              
                  "integrations": [], 
              
                  "hyperlinks": [], 
              
                  "radiobuttons": [], 
              
                  "document_group_template_info": [], 
              
                  "originator_organization_settings": [ 
              
                    { 
              
                      "setting": "invite_completion_redirect_url", 
              
                      "value": "https://facebook.com" 
              
                    }, 
              
                    { 
              
                      "setting": "invite_decline_redirect_url", 
              
                      "value": "" 
              
                    }, 
              
                    { 
              
                      "setting": "required_preset_signature_name", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "require_email_subject", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "require_login_for_signing", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "logout_on_signing", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "front_end_session_length", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "add_signature_stamp_with_name", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "cfr_title_21_part_11", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "require_authentication_for_invites", 
              
                      "value": "0" 
              
                    }, 
              
                    { 
              
                      "setting": "document_guide", 
              
                      "value": "1" 
              
                    }, 
              
                    { 
              
                      "setting": "block_export_options_when_credit_card_validation_is_used", 
              
                      "value": "no" 
              
                    } 
              
                  ], 
              
                "document_group_info": { 
              
                  "document_group_id": null, 
              
                  "document_group_name": null, 
              
                  "invite_id": null, 
              
                  "invite_status": null, 
              
                  "doc_count_in_group": 0 
              
                  }, 
              
                "settings": { 
              
                  "no_document_attachment": false, 
              
                  "copy_export": false, 
              
                  "no_document_file_attachments": false, 
              
                  "no_user_signature_return": false, 
              
                  "mobileweb_option": false, 
              
                  "require_drawn_signatures": false, 
              
                  "org_allowed_team_admins": false, 
              
                  "cloud_auto_export": false, 
              
                  "digitally_sign_dowloaded_docs": false, 
              
                  "invite_completion_redirect_url": false, 
              
                  "invite_decline_redirect_url": false, 
              
                  "add_signature_stamp": false, 
              
                  "pending_invite_document_view_notification": false, 
              
                  "signing_link_document_download": false, 
              
                  "required_preset_signature_name": false, 
              
                  "cloud_export_with_history": false, 
              
                  "emailed_docs_include_history": false, 
              
                  "require_email_subject": false, 
              
                  "document_completion_retention_days": false, 
              
                  "enable_hyperlink_protection": false, 
              
                  "enable_advanced_threat_protection": false, 
              
                  "require_login_for_signing": false, 
              
                  "logout_on_signing": false, 
              
                  "audit_trail_completion_retention_days": false, 
              
                  "front_end_session_length": false, 
              
                  "email_admin_on_banned_login": false, 
              
                  "add_signature_stamp_with_name": false, 
              
                  "cfr_title_21_part_11": false, 
              
                  "unsuccessful_logout_attempts_allowed": false, 
              
                  "require_authentication_for_invites": false, 
              
                  "electronic_consent_required": false, 
              
                  "electronic_consent_text": false, 
              
                  "document_guide": false, 
              
                  "watermark_downloaded_document": false, 
              
                  "restrict_download": false, 
              
                  "disable_email_notifications": false, 
              
                  "upload_limit": false, 
              
                  "document_schema_extended": false, 
              
                  "invite_update_notifications_for_all_invites_at_invite_create": false, 
              
                  "enable_full_story_tracker": false, 
              
                  "document_attachment_only_for_signer": false, 
              
                  "sso-only-login": false, 
              
                  "block_export_options_when_credit_card_validation_is_used": false, 
              
                  "only_administrator_is_able_to_invite_to_the_team": false, 
              
                  "block_login_via_social_networks": false }, 
              
                  "parent_id": "c8fdb570bddbefab469a30a8cb4de4d96851cce3", 
              
                  "originator_logo": "", 
              
                  "pages": [ 
              
                    { 
              
                      "src": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large&page=0", 
              
                      "size": { 
              
                        "width": 612, 
              
                        "height": 792 
              
                      } 
              
                    } 
              
                  ] 
              
                }
              

Create template

Creates a template by flattening an existing document.

Parameters
  • document_id required
    ID of the document which is the source of a template
  • document_name required
    The new template name
Returns

Returns a new template ID.

POST /template
                  
                    curl 
                    -X POST
                     \
                  
                
                  
                      https://api.signnow.com/template
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                  
                
                  
                      -H
                     'Content-Type: 
                     application/json'
                     \
                  
                
                  
                      -d
                     '{
                  
                
                  
                           "document_id":
                     "{{document_id}}",
                  
                
                  
                           "document_name":
                     "my_template"
                  
                
                  
                          }'
                  
                
Response
                  { 
                
                    "id": "ce97706ea19b42c19aced4a6ac353153e86c09f1" 
                
                  }
                

Create document out of template

Creates a new document copy out of template.

Parameters
  • template_id required
    ID of the template which is the source of a document
  • document_name required
    Name of a new document
Returns

Returns a new document ID.

POST /template/{{document_id}}/copy
                  
                    curl 
                    -X POST
                     \
                  
                
                  
                      https://api-eval.signnow.com/template/{{template_id}}/copy
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                     \
                  
                
                  
                      -H
                     'content-type:
                     application/json'
                     \
                  
                
                  
                      -d
                     '{
                  
                
                  
                           "document_name":
                     "doc_from_template" 
                  
                
                  
                          },
                  
                
Response
                  {
                
                   "id": "ce97706ea19b42c19aced4a6ac353153e86c09f1", 
                
                   "document_name": "doc_from_template" 
                
                  }
                

Bulk invite

Creates a bulk invite job and sends email invites.

Bulk invite - an invite sent to multiple signers in one job queue.

Requirements:

  • A .csv file. with a list of signers’ email addresses
  • A template of the document you’d like to have signed

When you send a Bulk invite to 10 signers, signNow generates document(s) from one template and sends them for signature according to the list of Signers and their roles in a .csv file. The signed documents return into a designated folder in your signNow account.

The signers list has to follow this format:

Signer 1|test@signnow.com,pdf_0_test

  • Signer 1 - the Signer’s role
  • test@signnow.com, - Signer’s email address
  • pdf_0_test - the name of the document for signature

Also, get the folder ID where to receive the signed copies. To find a folder ID, make a GET /user/folder request and search through the list of all folders in the user’s account.

Parameters
  • file required
    Path to the .CSV file with list of email addresses
  • folder_id required
    Unique id of the folder to store signed documents
  • client_timestamp optional
    description
  • document_name optional
    Prefix for each document name
  • subject optional
    Сustom email subject
  • email_message optional
    Сustom email message
Returns

Returns status of the bulk sending.

POST /template/{{document_id}}/bulkinvite
                  
                    curl 
                    -X POST
                     \
                  
                
                  
                      https://api.signnow.com/template/{{document_id}}/bulkinvite’
                     \
                  
                
                  
                      -H
                     'Authorization:
                     Bearer {{access_token}}'
                     \
                  
                
                  
                      -F
                     'file=
                    @/path/to/file'
                     \
                  
                
                  
                      -F
                     'client_timestamp=
                    {{timestamp}}'
                     \
                  
                
                  
                      -F
                     'document_name=
                    1 signer'
                     \
                  
                
                  
                      -F
                     'folder_id=
                    {{folder_id}}'
                     \
                  
                
                  
                      -F
                     'subject=
                    Bulk Invite subject 1 signer'
                     \
                  
                
                  
                      -F
                     'email_message=
                    Bulk invite message 1 sign'r’
                     \
                  
                
Response
                  {
                
                   "status": "job queued" 
                
                  }