Guides
Guides
Start typing to search…

Create a document from a template and request signatures

Create a document from a template and request signatures.

📘

Creating a template before proceeding!

You will first need to login to sandbox.quicklysign.com (for test environment) or app.quicklysign.com (for live environment) and create a template.

Only once the template is setup will you be able to then use the api call to create a document from the template and send the document for signature.

Please contact [email protected] for more information.

Step 1:
Call POST /documents/<document_key>/create_new_document_from_template
(where the <document_key> is the key of the template you wish to copy).
This creates a new document from the template.

POST /v0/documents/<document_key>/new_document_from_template?access_token=<access_token> HTTP/1.1
Host: sandboxapi.quicklysign.com
Content-Type: application/json
Cache-Control: no-cache
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '' 'https://sandboxapi.quicklysign.com/v0/documents/<document_key>/new_document_from_template?access_token=<access_token>'
{
    "status": {
        "status_code": 200
    },
    "data": {
        "document": {
            "can_use_drawn_signature": true,
            "post_signing_url": "",
            "date_updated": 1444160703386.47,
            "can_use_uploaded_signature": true,
            "account_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
            "sequential_signing": true,
            "message": "",
            "serve_pdf_url": "https://sandboxapi.quicklysign.com/v0/documents/ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgO3biwoMogEHc2FuZGJveA/serve_pdf?access_token=APxXJqbp8RhG4GJQWyE0caADdx7kikithroUgGf0UGp",
            "subject": null,
            "team_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
            "final_blob": null,
            "image_blobs": [
                "AMIfv94YWvLvG2JmGI8AbZb79hgMrSol_qHZ3TUyIIKgLljXOm1VxDttBdw-PgBA6vj7E75NdksUti2Ci8KuY-nROxTC3lvnPstD3qp02C8Vhoqn0W620zF-jQTLj2ZbeVM3BH-jmgoraa02DLP0BHvhbUDutNIi9LvgqTdOXe90ZefPIaTNABjb0cDXoTNIDXeuzEzr07uefWcbEclbjIh5J_vbq5SO1yO0ehAtNvxT1FQvd1FikXnperZeIxDEwAOpnAGZCwYZQPBVDs-gEp774GC7SAI7Za9KhfhIBLAOHB5uHzSa_ipI0qNTuVnYpoJZVnV9aw_0"
            ],
            "created_by": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94",
            "filename": "cwc application-signed.pdf",
            "use_fallback_pdf_conversion": false,
            "document_name": "cwc application-signed.pdf",
            "exclude_created_by_from_final_mail": false,
            "status": "setup",
            "use_signing_wizard": true,
            "obfuscate_contact_info": false,
            "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgO3biwoMogEHc2FuZGJveA",
            "created_by_email": "[email protected]",
            "document_type": "document",
            "image_blob_serving_urls": [
                "http://lh3.googleusercontent.com/6FaMwoy1E1LTnERXIWkk5BCiQJwvpljbpsT95wyN14H6y1sXRLRy7ZiGzQxvQIgC2hagHefMVXhmdkfPOuyyLj44T-mH"
            ],
            "viewers": [
                "ahFzfnRoZW1hc3NpdmUtbGl2ZXI2CxIHQWNjb3VudBiAgICAmZmNCgwLEgRVc2VyGICAgICA5JEKDAsSC1VzZXJBY2NvdW50GAEMogEHc2FuZGJveA",
                "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94"
            ],
            "cc_recipients": [],
            "signatories": [
                {
                    "status": "setup",
                    "uuid": "437f46a2-e74a-54c5-b05d-bca575975f7e",
                    "date_updated": null,
                    "user_key": null,
                    "role": "applicant",
                    "email_send_count": 0,
                    "mobile_number": null,
                    "email": "",
                    "name": ""
                }
            ],
            "account_branding_theme_key": null,
            "can_use_typed_signature": true,
            "original_blob_type": "application/pdf",
            "date_created": 1444160703386.26,
            "original_blob": "AMIfv96AFVGXUqbNac2OMGG3tW_8DObZbiIbkZrK1nAgY-THUSPWgqaYlG8pDk4gaz3JHRjNJlz1Lmw7fRZaTa2oJhcFGTHVvmHUUA2rCJr7upLD6LMQPOzMeq5825i_mw7ij-pZBsy0oPUa7uOXYYSAdbINDzBPZN89QyNqdz8z_LsSZv0u648",
            "data_fields": [
                {
                    "custom_id": "applicant_signature",
                    "uuid": "d2b00b23-eb12-75f6-27b2-c82efb283d68",
                    "date_updated": 1444139488605.03,
                    "type": "signature",
                    "required": true,
                    "filename": null,
                    "height": 40,
                    "width": 150,
                    "blob": null,
                    "signatory_uuid": "437f46a2-e74a-54c5-b05d-bca575975f7e",
                    "x": 440.5,
                    "z": null,
                    "data": null,
                    "y": 908,
                    "description": null
                }
            ]
        }
    }
}

Step 2:
Populate data_field.data values that should be pre-populated.
Update the email address of signatories.
The "data" property of the "data_field" object is the field that get's updated with any data you'd like pre-populated before signing.

"signatories": [
                {
                    "status": "setup",
                    "uuid": "437f46a2-e74a-54c5-b05d-bca575975f7e",
                    "date_updated": null,
                    "user_key": null,
                    "role": "applicant",
                    "email_send_count": 0,
                    "mobile_number": null,
                    "email": "",
                    "name": ""
                }
            ],
 
"data_fields": [
                {
                    "custom_id": "applicant_signature",
                    "uuid": "d2b00b23-eb12-75f6-27b2-c82efb283d68",
                    "date_updated": 1444139488605.03,
                    "type": "signature",
                    "required": true,
                    "filename": null,
                    "height": 40,
                    "width": 150,
                    "blob": null,
                    "signatory_uuid": "437f46a2-e74a-54c5-b05d-bca575975f7e",
                    "x": 440.5,
                    "z": null,
                    "data": null,
                    "y": 908,
                    "description": null
                }
            ]

Note: To update signatories, find them by role in the signatory array.
To update data_fields, you can find them by custom_id.

Step 3:
Call PUT /documents/<document_key>/request_signatures (where <document_key> is the key property of the newly created document (from step 1). This will send signature requests to the signatories to the email addresses specified in step 2.
The document status will be updated to "awaiting_signatures" and signature request will be sent.

PUT /v0/documents/ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA/request_signatures?access_token=<access_token> HTTP/1.1
Host: sandboxapi.quicklysign.com
Content-Type: application/json
Cache-Control: no-cache

{
      "can_use_drawn_signature": true,
      "post_signing_url": "",
      "date_updated": 1444165417464.71,
      "can_use_uploaded_signature": true,
      "account_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
      "sequential_signing": true,
      "message": "",
      "serve_pdf_url": "https://sandboxapi.quicklysign.com/v0/documents/ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA/serve_pdf?access_token=APxXJqbp8RhG4GJQWyE0caADdx7kikithroUgGf0UGp",
      "subject": null,
      "team_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
      "final_blob": null,
      "image_blobs": [
        "AMIfv97uvbimdOxAuxa9oUS-l_AMfppTKSpAgLqjO0T_cgmAODZSodtyv_axPF-jr4t3BypRe8cf4-O2OnGCOVNLHeXNRGaJqIZk8zeIyi1qCfqb7bMBxwelJlrZdTrm7jK8wOlO3qEtYPUpeXevP2PcLsrbTr7PB5-JegePP-xObApdljWmsc_M-_luDDDVO0GJ3D8itkRX7PQY2tzYcsRsreRFi1gTJieQhFC2wJ4PS_rk4fFWRCxsPW58gCQ0kKFMdaE0Ie9Ifglmp0DfE3KvEeBchIWTvj_tLkloTUbiHSMhxng-lpa_TYVkpqhZyuFqKRoErnV-"
      ],
      "created_by": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94",
      "filename": "Exampledocument.pdf",
      "use_fallback_pdf_conversion": false,
      "document_name": "Example document",
      "exclude_created_by_from_final_mail": false,
      "status": "setup",
      "use_signing_wizard": true,
      "obfuscate_contact_info": false,
      "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA",
      "created_by_email": "[email protected]",
      "document_type": "document",
      "image_blob_serving_urls": [
        "https://lh3.googleusercontent.com/J49U0N33Quo_OgQg-TloO1s5PO_h00jJpdcU6LggeZ7xZJfyFCik9jQrbp7IG7oQmGiTzL0wRI-ilWNS4VjI2iFWFzH5"
      ],
      "viewers": [
        "ahFzfnRoZW1hc3NpdmUtbGl2ZXI2CxIHQWNjb3VudBiAgICAmZmNCgwLEgRVc2VyGICAgICA5JEKDAsSC1VzZXJBY2NvdW50GAEMogEHc2FuZGJveA",
        "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94"
      ],
      "cc_recipients": [],
      "signatories": [
        {
          "status": "setup",
          "uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
          "date_updated": null,
          "user_key": null,
          "role": "Applicant",
          "email_send_count": 0,
          "mobile_number": null,
          "email": "[email protected]",
          "name": "Rob"
        }
      ],
      "account_branding_theme_key": null,
      "can_use_typed_signature": true,
      "original_blob_type": "application/pdf",
      "date_created": 1444165417464.55,
      "original_blob": "AMIfv978ojEEM2CFgZHHd0e_wJWCTZ4eqmjXjzwiCS5SEE-2KrKs5Pt-SWZzigonYInjUef0hKoKgRByNNf5RQLNTSR5Qf9bn6CHg8LNm0o3okXjXVlfuE8VdZ6w5gfJSXvMi-dFaCV59MYyifgJAaeNMgsRZhOTXuEvsGbxs3DX2oC4CFk38ng",
      "data_fields": [
        {
          "custom_id": null,
          "uuid": "22b43b61-312b-1bde-ec06-6f8d1c1a208d",
          "date_updated": 1444164548622.06,
          "type": "signature",
          "required": true,
          "filename": null,
          "height": 40,
          "width": 150,
          "blob": null,
          "signatory_uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
          "x": 241.5,
          "z": null,
          "data": "",
          "y": 440,
          "description": null
        },
        {
          "custom_id": null,
          "uuid": "875d15ea-c10b-fcd6-19f7-2022e73edc92",
          "date_updated": 1444164548622.09,
          "type": "text",
          "required": false,
          "filename": null,
          "height": 22,
          "width": 150,
          "blob": null,
          "signatory_uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
          "x": 98.5,
          "z": null,
          "data": "Predefined text",
          "y": 243,
          "description": null
        }
      ]
    }
curl -X PUT -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
      "can_use_drawn_signature": true,
      "post_signing_url": "",
      "date_updated": 1444165417464.71,
      "can_use_uploaded_signature": true,
      "account_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
      "sequential_signing": true,
      "message": "",
      "serve_pdf_url": "https://sandboxapi.quicklysign.com/v0/documents/ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA/serve_pdf?access_token=APxXJqbp8RhG4GJQWyE0caADdx7kikithroUgGf0UGp",
      "subject": null,
      "team_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
      "final_blob": null,
      "image_blobs": [
        "AMIfv97uvbimdOxAuxa9oUS-l_AMfppTKSpAgLqjO0T_cgmAODZSodtyv_axPF-jr4t3BypRe8cf4-O2OnGCOVNLHeXNRGaJqIZk8zeIyi1qCfqb7bMBxwelJlrZdTrm7jK8wOlO3qEtYPUpeXevP2PcLsrbTr7PB5-JegePP-xObApdljWmsc_M-_luDDDVO0GJ3D8itkRX7PQY2tzYcsRsreRFi1gTJieQhFC2wJ4PS_rk4fFWRCxsPW58gCQ0kKFMdaE0Ie9Ifglmp0DfE3KvEeBchIWTvj_tLkloTUbiHSMhxng-lpa_TYVkpqhZyuFqKRoErnV-"
      ],
      "created_by": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94",
      "filename": "Exampledocument.pdf",
      "use_fallback_pdf_conversion": false,
      "document_name": "Example document",
      "exclude_created_by_from_final_mail": false,
      "status": "setup",
      "use_signing_wizard": true,
      "obfuscate_contact_info": false,
      "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA",
      "created_by_email": "[email protected]",
      "document_type": "document",
      "image_blob_serving_urls": [
        "https://lh3.googleusercontent.com/J49U0N33Quo_OgQg-TloO1s5PO_h00jJpdcU6LggeZ7xZJfyFCik9jQrbp7IG7oQmGiTzL0wRI-ilWNS4VjI2iFWFzH5"
      ],
      "viewers": [
        "ahFzfnRoZW1hc3NpdmUtbGl2ZXI2CxIHQWNjb3VudBiAgICAmZmNCgwLEgRVc2VyGICAgICA5JEKDAsSC1VzZXJBY2NvdW50GAEMogEHc2FuZGJveA",
        "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94"
      ],
      "cc_recipients": [],
      "signatories": [
        {
          "status": "setup",
          "uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
          "date_updated": null,
          "user_key": null,
          "role": "Applicant",
          "email_send_count": 0,
          "mobile_number": null,
          "email": "[email protected]",
          "name": "Rob"
        }
      ],
      "account_branding_theme_key": null,
      "can_use_typed_signature": true,
      "original_blob_type": "application/pdf",
      "date_created": 1444165417464.55,
      "original_blob": "AMIfv978ojEEM2CFgZHHd0e_wJWCTZ4eqmjXjzwiCS5SEE-2KrKs5Pt-SWZzigonYInjUef0hKoKgRByNNf5RQLNTSR5Qf9bn6CHg8LNm0o3okXjXVlfuE8VdZ6w5gfJSXvMi-dFaCV59MYyifgJAaeNMgsRZhOTXuEvsGbxs3DX2oC4CFk38ng",
      "data_fields": [
        {
          "custom_id": null,
          "uuid": "22b43b61-312b-1bde-ec06-6f8d1c1a208d",
          "date_updated": 1444164548622.06,
          "type": "signature",
          "required": true,
          "filename": null,
          "height": 40,
          "width": 150,
          "blob": null,
          "signatory_uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
          "x": 241.5,
          "z": null,
          "data": "",
          "y": 440,
          "description": null
        },
        {
          "custom_id": null,
          "uuid": "875d15ea-c10b-fcd6-19f7-2022e73edc92",
          "date_updated": 1444164548622.09,
          "type": "text",
          "required": false,
          "filename": null,
          "height": 22,
          "width": 150,
          "blob": null,
          "signatory_uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
          "x": 98.5,
          "z": null,
          "data": "Predefined text",
          "y": 243,
          "description": null
        }
      ]
    }' 'https://sandboxapi.quicklysign.com/v0/documents/ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA/request_signatures?access_token=<access_token>'
{
    "status": {
        "status_code": 200
    },
    "data": {
        "document": {
            "can_use_drawn_signature": true,
            "post_signing_url": "",
            "date_updated": 1444165750701.4502,
            "can_use_uploaded_signature": true,
            "account_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
            "sequential_signing": true,
            "message": "",
            "serve_pdf_url": "https://sandboxapi.quicklysign.com/v0/documents/ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA/serve_pdf?access_token=APxXJqbp8RhG4GJQWyE0caADdx7kikithroUgGf0UGp",
            "subject": null,
            "team_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIUCxIHQWNjb3VudBiAgICAmZmNCgyiAQdzYW5kYm94",
            "final_blob": null,
            "image_blobs": [
                "AMIfv97uvbimdOxAuxa9oUS-l_AMfppTKSpAgLqjO0T_cgmAODZSodtyv_axPF-jr4t3BypRe8cf4-O2OnGCOVNLHeXNRGaJqIZk8zeIyi1qCfqb7bMBxwelJlrZdTrm7jK8wOlO3qEtYPUpeXevP2PcLsrbTr7PB5-JegePP-xObApdljWmsc_M-_luDDDVO0GJ3D8itkRX7PQY2tzYcsRsreRFi1gTJieQhFC2wJ4PS_rk4fFWRCxsPW58gCQ0kKFMdaE0Ie9Ifglmp0DfE3KvEeBchIWTvj_tLkloTUbiHSMhxng-lpa_TYVkpqhZyuFqKRoErnV-"
            ],
            "created_by": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94",
            "filename": "Exampledocument.pdf",
            "use_fallback_pdf_conversion": false,
            "document_name": "Example document",
            "exclude_created_by_from_final_mail": false,
            "status": "awaiting_signatures",
            "use_signing_wizard": true,
            "obfuscate_contact_info": false,
            "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIVCxIIRG9jdW1lbnQYgICAgJmDnAoMogEHc2FuZGJveA",
            "created_by_email": "[email protected]",
            "document_type": "document",
            "image_blob_serving_urls": [
                "https://lh3.googleusercontent.com/J49U0N33Quo_OgQg-TloO1s5PO_h00jJpdcU6LggeZ7xZJfyFCik9jQrbp7IG7oQmGiTzL0wRI-ilWNS4VjI2iFWFzH5"
            ],
            "viewers": [
                "ahFzfnRoZW1hc3NpdmUtbGl2ZXI2CxIHQWNjb3VudBiAgICAmZmNCgwLEgRVc2VyGICAgICA5JEKDAsSC1VzZXJBY2NvdW50GAEMogEHc2FuZGJveA",
                "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgICAgOSRCgyiAQdzYW5kYm94"
            ],
            "cc_recipients": [],
            "signatories": [
                {
                    "status": "setup",
                    "uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
                    "date_updated": null,
                    "user_key": null,
                    "role": "Applicant",
                    "email_send_count": 0,
                    "mobile_number": null,
                    "email": "[email protected]",
                    "name": "Rob"
                }
            ],
            "account_branding_theme_key": null,
            "can_use_typed_signature": true,
            "original_blob_type": "application/pdf",
            "date_created": 1444165417464.55,
            "original_blob": "AMIfv978ojEEM2CFgZHHd0e_wJWCTZ4eqmjXjzwiCS5SEE-2KrKs5Pt-SWZzigonYInjUef0hKoKgRByNNf5RQLNTSR5Qf9bn6CHg8LNm0o3okXjXVlfuE8VdZ6w5gfJSXvMi-dFaCV59MYyifgJAaeNMgsRZhOTXuEvsGbxs3DX2oC4CFk38ng",
            "data_fields": [
                {
                    "custom_id": null,
                    "uuid": "22b43b61-312b-1bde-ec06-6f8d1c1a208d",
                    "date_updated": 1444164548622.06,
                    "type": "signature",
                    "required": true,
                    "filename": null,
                    "height": 40,
                    "width": 150,
                    "blob": null,
                    "signatory_uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
                    "x": 241.5,
                    "z": null,
                    "data": null,
                    "y": 440,
                    "description": null
                },
                {
                    "custom_id": null,
                    "uuid": "875d15ea-c10b-fcd6-19f7-2022e73edc92",
                    "date_updated": 1444164548622.09,
                    "type": "text",
                    "required": false,
                    "filename": null,
                    "height": 22,
                    "width": 150,
                    "blob": null,
                    "signatory_uuid": "9c378cf5-3f46-ecca-7f0e-0e5d7d6cb9b8",
                    "x": 98.5,
                    "z": null,
                    "data": "Predefined text",
                    "y": 243,
                    "description": null
                }
            ]
        }
    }
}

Updated 6 months ago