### Mail Settings Example Source: https://docs.quicklysign.com/docs/documents An example of how to configure mail settings for a document pack. ```json "mail_settings": { "exclude_created_by_from_final_mail": false, "include_attachments_in_final_mail": false, "message": "Custom email body message", "subject": "My First Document Pack", "reply_email": "support@example.com", "sender_name": "Example Name" } ``` -------------------------------- ### Example cURL for Creating Access Token Source: https://docs.quicklysign.com/docs/authentication Example cURL command to create an access token. ```curl curl -X POST https://sandboxapi.quicklysign.com/v1/access_tokens \ -H "Content-Type: application/json" \ -H "Cache-Control: no-cache" \ -d '{ "client_id": "", "client_secret": "", "api_key": "" }' ``` -------------------------------- ### Get User cURL Example Source: https://docs.quicklysign.com/docs/users Example cURL command to retrieve user information. ```curl curl -X GET https://sandboxapi.quicklysign.com/v1/users/self \ -H "Content-Type: application/json" \ -H "Cache-Control: no-cache" \ -H "access_token: " ``` -------------------------------- ### Example Response Source: https://docs.quicklysign.com/docs/use-cases This is an example of a response when a document is created from a template. ```json { "data": { "document_pack": { "cc_recipients": [], "created_by_email": "demo@quicklysign.com", "created_by_external_user_code": null, "custom_data": null, "date_created": 1658477978067.0620117188, "date_updated": 1658477978067.5710449219, "document_pack_name": "", "document_type": "document", "documents": [ { "custom_data": null, "data_fields": [ { "auto_assign_date": false, "auto_fill": false, "background_colour": null, "blob": null, "checkbox_group_id": null, "continue_if_signer_question": null, "custom_id": "employer_name", "data": "Joe Soaps Boss", "data_field_presentation": null, "date_updated": 1658477301350.0581054688, "description": null, "field_enabled_condition": null, "field_group_id": null, "filename": null, "height": 22.0, "mutually_exclusive": false, "options_as_csv": null, "required": false, "signatory_role": null, "signatory_uuid": "e4b0e520-0080-48b8-8912-e019809921c5", "tag_id": null, "type": "text", "uuid": "1d66b41c-07a3-2e7c-c14b-b9da177383a3", "width": 150.0, "x": 542.390625, "y": 27.1875 }, { "auto_assign_date": false, "auto_fill": false, "background_colour": null, "blob": null, "checkbox_group_id": null, "continue_if_signer_question": null, "custom_id": "employee_name", "data": "Joe Soap", "data_field_presentation": null, "date_updated": 1658477330352.7080078125, "description": null, "field_enabled_condition": null, "field_group_id": null, "filename": null, "height": 22.0, "mutually_exclusive": false, "options_as_csv": null, "required": false, "signatory_role": null, "signatory_uuid": "ea23affc-6f6a-4d75-ab3e-649ce834a734", "tag_id": null, "type": "text", "uuid": "2e02acd1-2a43-79b2-e14c-03ca4a938703", "width": 150.0, ``` -------------------------------- ### Create User cURL Example Source: https://docs.quicklysign.com/docs/users Example cURL command to create a new user. ```curl curl -X POST https://sandboxapi.quicklysign.com/v1/users \ -H "Content-Type: application/json" \ -H "Cache-Control: no-cache" \ -d '{ "client_id":"", "client_secret":"", "user":{ "name":"Joe", "last_name":"Soap", "email_address":"example@example.com", "mobile_number":"" } }' ``` -------------------------------- ### Create User Response Example Source: https://docs.quicklysign.com/docs/users Example JSON response after successfully creating a user. ```json { "status": { "status_code": 200 }, "data": { "user": { "key": "ahFzfmFjY291bnRzLXRlYW0tcHJvZCISCxIFVGVhbRiAgICf5LqVCgw", "name": "Joe", "last_name": "Soap", "email_address": "example@example.com", "mobile_number": "", "api_key": "ahFzfmFjY241bnRzLXYlYW0tcHJvFCISCxIFVGVhbRiAgICf5LqVCgw", "date_updated": 1400960715175 } } } ``` -------------------------------- ### Base URL Example Source: https://docs.quicklysign.com/docs/glossary The main website address that all API requests start with. ```text https://sandboxapi.quicklysign.com ``` -------------------------------- ### Example Response Source: https://docs.quicklysign.com/docs/use-cases Example JSON response when creating a document from a template. ```json { "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": "robertbcurtis@gmail.com", "document_type": "document", "image_blob_serving_urls": [ "http://lh3.googleusercontent.com/6FaMwoy1E1LTnERXIWkk5BCiQJwvpljbpsT95wyN14H6y1sXRLRy7ZiGzQxvQIgC2hagHefMVXhmdkfPOuyyLj44T-mH" ], "viewers": [ "ahFzfnRoZW1hc3NpdmUtbGl2ZX6CxIHQWNjb3VudBiAgICAmZmNCgwLEgRVc2VyGICAgICA5JEKDAsSC1VzZXJBY2NvdW50GAEMogEHc2FuZGJveA", "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, "page": 1, "top": 50, "left": 50 } ] } } } ``` -------------------------------- ### Create Access Token Response Example Source: https://docs.quicklysign.com/docs/authentication Example JSON response when an access token is successfully created. ```json { "data": { "access_token": "" }, "status": { "status_code": 200 } } ``` -------------------------------- ### Example Signing Settings Configuration Source: https://docs.quicklysign.com/docs/documents A JSON example detailing the various signing settings that can be applied to a document pack. ```json "signing_settings": { "attachments_visible_to_all_signers": true, "branding_key": null, "can_use_drawn_signature": true, "can_use_one_click_initial": true, "can_use_one_click_signature": true, "can_use_typed_signature": true, "can_use_uploaded_signature": true, "post_signing_url": "", "sequential_signing": true, "use_signing_wizard": true, "use_two_factor_authentication": true } ``` -------------------------------- ### Opening the standalone setup page with JavaScript Source: https://docs.quicklysign.com/docs/quicklysign-ui-to-set-up-a-document-from-your-application This code snippet demonstrates how to open the QuicklySign standalone setup page in a new window using JavaScript, including appending query parameters to customize the UI. ```javascript window.open("/standalone_v1?url=&show_action_button=true&name_visible=true&signatory_details_visible=true&settings_visible=true&user_defined_attributes_visible=true&tabs_visible=true&upload_new_document_enabled=true") ``` -------------------------------- ### Create Access Token Request Body Example Source: https://docs.quicklysign.com/docs/authentication Example JSON body for creating an access token. ```json { "client_id": "", "client_secret": "", "api_key": "" } ``` -------------------------------- ### Example Document Pack Configuration Source: https://docs.quicklysign.com/docs/documents A JSON example demonstrating the structure of a document pack, including document settings and signatory information. ```json { "document_pack_name": "Default Settings Example", "team_key": "", "documents": [ { "document_creation_settings": { "base_64_document": "", "use_workspace_default_document_settings": true }, "document_name": "Example Child Document" } ], "signatories": [ { "name": "Joe Soap", "email": "example@example.com", "role": "signer-1" } ] } ``` -------------------------------- ### Example JSON Data Structure Source: https://docs.quicklysign.com/docs/creating-a-syntax-document-and-using-it-via-the-api This JSON snippet shows an example data structure related to user roles and signing settings within the QuicklySign platform. ```json { "sms_send_count": 0, "status": "setup", "user_key": null, "uuid": "7a5a27fb-c005-4909-b1fe-bcd14da97e9d" }, { "can_receive_signing_notifications": true, "can_receive_viewing_notifications": true, "date_updated": 1658497445387.2238769531, "email": "joesoapsboss@quicklysign.com", "email_is_optional": false, "email_send_count": 0, "mobile_number": null, "name": "Joe Soaps Boss", "primary_communication_channel": "email", "role": "employer", "sms_send_count": 0, "status": "setup", "user_key": null, "uuid": "2f0f0828-1342-4c3d-a4d6-ef72b938c743" } ], "signatory_allocation_questions": [], "signing_settings": { "attachments_visible_to_all_signers": false, "branding_key": null, "can_use_drawn_signature": true, "can_use_one_click_initial": false, "can_use_one_click_signature": false, "can_use_typed_signature": true, "can_use_uploaded_signature": true, "communication_channel_configurable": false, "document_can_be_used_as_form": false, "email_is_optional_for_signing": false, "first_signer_has_multi_edit_role": false, "in_app_signing_page_url": null, "obfuscate_contact_info": false, "post_signing_url": "", "sequential_signing": true, "use_signing_wizard": true, "use_two_factor_authentication": false }, "status": "setup", "team_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXImCxIEVXNlchiAgKDSi-r-CwwLEgdBY2NvdW50IghQZXJzb25hbAyiAQdzYW5kYm94", "user_defined_attributes": [], "visible_to_organisation": false } }, "status": { "status_code": 200 } } ``` -------------------------------- ### Full Request Example Source: https://docs.quicklysign.com/docs/generating-an-access-token A complete example of the POST request to generate an access token, including headers and body. ```http POST /v1/access_tokens HTTP/1.1 Host: https://sandboxapi.quicklysign.com Content-Type: application/json Cache-Control: no-cache ``` ```curl curl https://base_url/v1/access_tokens \ -H "Content-Type: application/json" \ -H "Cache-Control: no-cache" \ -d '{ "client_id": "", "client_secret": "", "api_key": "" }' ``` -------------------------------- ### Get Event Hooks Example Response Source: https://docs.quicklysign.com/docs/logs Example JSON response for the Get Event Hooks endpoint. ```json { "data": { "event_hooks": [] }, "status": { "status_code": 200 } } ``` -------------------------------- ### Document Pack Name Example Source: https://docs.quicklysign.com/docs/documents Example JSON structure for setting the name of a document pack. ```json "document_pack_name": "my first document_pack" ``` -------------------------------- ### Create User Request Body Example Source: https://docs.quicklysign.com/docs/users Example JSON payload for creating a new user. ```json { "client_id": "", "client_secret": "", "user": { "name": "Joe", "last_name": "Soap", "email_address": "example@example.com", "mobile_number": "" } } ``` -------------------------------- ### Document Structure Example Source: https://docs.quicklysign.com/docs/creating-a-syntax-document-and-using-it-via-the-api An example of the JSON structure representing a document with fields, document name, and API URLs. ```json { "background_colour": null, "blob": null, "checkbox_group_id": null, "continue_if_signer_question": null, "custom_id": "employer_firstname", "data": "Jim", "data_field_presentation": null, "date_updated": null, "description": null, "field_enabled_condition": null, "field_group_id": null, "filename": null, "height": null, "mutually_exclusive": false, "options_as_csv": null, "required": null, "signatory_role": null, "signatory_uuid": null, "tag_id": null, "type": null, "uuid": "db86bf2d-1c65-4803-a238-006f042f9fa1", "width": null, "x": null, "y": null }, { "auto_assign_date": null, "auto_fill": null, "background_colour": null, "blob": null, "checkbox_group_id": null, "continue_if_signer_question": null, "custom_id": "employer_surname", "data": "The Boss", "data_field_presentation": null, "date_updated": null, "description": null, "field_enabled_condition": null, "field_group_id": null, "filename": null, "height": null, "mutually_exclusive": false, "options_as_csv": null, "required": null, "signatory_role": null, "signatory_uuid": null, "tag_id": null, "type": null, "uuid": "7b6eb2fd-190b-4748-918b-d0e37e583cd8", "width": null, "x": null, "y": null } ], "document_name": "my test syntax form", "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXI2CxIIRG9jdW1lbnQiKEV3MVFsaXFFeExZbjF2MTgyMjYyNmFiM2VfREpaUjB0dmJ6REVTR0UMogEHc2FuZGJveA", "serve_pdf_url": "https://sandboxapi.quicklysign.com/v1/document_packs/ahFzfnRoZW1hc3NpdmUtbGl2ZXI2CxIIRG9jdW1lbnQiKEV3MVFsaXFFeExZbjF2MTgyMjYyNmFiM2VfREpaUjB0dmJ6REVTR0UMogEHc2FuZGJveA/serve_pdf?access_token=xoZ7xX9eHb8l5jVW3OJ9PaWz1lg6bJshqJaPkEsCLUB", "temp_upload_url_10_min": "https://sandboxapi.quicklysign.com/_ah/upload/AMmfu6YuZdw6TgqT7s6CfTLHEEazcd7CUjJiJCmMQ-sF1vzCP4WEZxo9Ci2qUlf02wnDa1WcgYRiWZ5GisGVAF5gUJUbRlPfKrdId0SkHBKqsxHyOcmvyRPjBjAOcX_it71jGcdisSpYTBwGt6Eep9Yh37sYxeEx5qDZEOPWUV07JwcP6HJSLgFdwxDt6aaonKnVqa5qlZvNaaTv7KdxIrz4N81gsEsqTHRCLHVGfarMXruegvIHY8uS82vPobWZ6VHfMyHO2hRt6slTNsv2EpJNh5iHvTJTZTrnwTeXUaRRoCRiiCRfx80iTYJcElzlOUlfY5zIBFYN4cTxGb2EflMZtulx8SMeSWQJVi46kpg0Jq1-okkWFQLrX-22vao6nVLsS-kx7k5W_Pos7LDyHXRSBYxqAkTykQnpxmNlvb5771tV8fbenuZCFsap-AIsKZrBCHVK5ezFe_Kh6WXWQU9purW7ztcCDJ9HxMXXnPUy1arAMpziPOtPZYihJighzN7oYLnWhYyOFueti0pW8l6kIIr3jnXi4xW3fI3A_E5GRsUE-VV2sGM/ALBNUaYAAAAAYtqr_mKEfGj70x_G9yNAkk_rKCfmmw3B/" }, { "event_hooks": [], "external_id": "", "field_enabled_conditions": [], "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUV3MVFsaXFFeExZbjF2MTgyMjYyNmFiM2UMogEHc2FuZGJveA", "mail_settings": { "exclude_created_by_from_final_mail": false, "include_attachments_in_final_mail": true, "message": "", "subject": null }, "organisation_key": null, "signatories": [ { "can_receive_signing_notifications": true, "can_receive_viewing_notifications": true, "date_updated": 1658497445387.0959472656, "email": "joesoap@quicklysign.com", "email_is_optional": false, "email_send_count": 0, "mobile_number": null, "name": "Joe Soap", "primary_communication_channel": "email", "role": "employee" } ] } ] ``` -------------------------------- ### Example Log Entry Source: https://docs.quicklysign.com/docs/webhook-logs A detailed example of a single log entry, illustrating the fields and their typical values. ```json { "key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2ciQLEhdTdWJzY3JpcHRpb25DYWxsYmFja0xvZxiAgICAgMirCgw", "entity_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chULEghEb2N1bWVudBiAgICAgMDvCww", "callback_event": "signatory_updated", "log": "Calling callback url https://yourapp.com/callback.", "subscriber_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chgLEgtBcHBsaWNhdGlvbhiAgICAgICgCAw", "subscription_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chkLEgxTdWJzY3JpcHRpb24YgICAgIDI0woM", "date_created": 1750167875566.343, "date_updated": 1750167875566.346, "_id": "4565016290000896" } ``` -------------------------------- ### Example Response for Listing Webhook Callback Logs Source: https://docs.quicklysign.com/docs/webhook-logs An example JSON response when listing webhook callback logs, showing successful and in-progress delivery attempts. ```json { "status": { "status_code": 200 }, "data": { "webhook_callback_logs": [ { "key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2ciQLEhdTdWJzY3JpcHRpb25DYWxsYmFja0xvZxiAgICAgMirCgw", "entity_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chULEghEb2N1bWVudBiAgICAgMDvCww", "callback_event": "document_status_changed", "log": "Successful call to url https://yourapp.com/callback. Received 200 response", "subscriber_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chgLEgtBcHBsaWNhdGlvbhiAgICAgICgCAw", "subscription_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chkLEgxTdWJzY3JpcHRpb24YgICAgIDI0woM", "date_created": 1401652689892, "date_updated": 1401652689892 }, { "key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2ciQLEhdTdWJzY3JpcHRpb25DYWxsYmFja0xvZxiAgICAgMirCAw", "entity_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chULEghEb2N1bWVudBiAgICAgMDvCww", "callback_event": "document_status_changed", "log": "Calling callback url https://yourapp.com/callback.", "subscriber_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chgLEgtBcHBsaWNhdGlvbhiAgICAgICgCAw", "subscription_key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chkLEgxTdWJzY3JpcHRpb24YgICAgIDI0woM", "date_created": 1401652689860, "date_updated": 1401652689860 } ] } } ``` -------------------------------- ### Example API Response Source: https://docs.quicklysign.com/docs/creating-a-document-pack-using-an-existing-template This is an example of an API response when creating a document pack using an existing template. ```json { "document_pack": { "attachments": [], "created_by": { "date_updated": 1658477978067.1989746094, "email": "joesoap@quicklysign.com", "name": "Joe Soap", "uuid": "ea23affc-6f6a-4d75-ab3e-649ce834a734" }, "date_created": 1658477978067.1989746094, "date_updated": 1658477978067.1989746094, "description": "", "document_pack_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGXB1VEg0NXN1NmxqMG9rMTgyMjRmZDlmZmEMogEHc2FuZGJveA", "document_pack_template_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGXB1VEg0NXN1NmxqMG9rMTgyMjRmZDlmZmEMogEHc2FuZGJveA", "document_pack_template_name": "", "documents": [ { "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGXB1VEg0NXN1NmxqMG9rMTgyMjRmZDlmZmEMogEHc2FuZGJveA", "document_name": "", "document_upload_url": "https://sandboxapi.quicklysign.com/_ah/upload/AMmfu6b6_cUC_lIagM_cwzKTGkFfvyaosSMtXIz6TfieY7TSLmE0FSQCOVmuLo-nnBrFOMt4D2-PGNV9rAUmWIyHL_MEXAjm1rsephaPes_d-89XtaRmSbSdSx4UEUgA7tiiufr8B8vXhd0ifwAL-u-0ZbG2bF4zbO_zs5JycUUxwYUSgO8J_t6iNtnzE_1jqhllmFFXFfu4KGKq2LvxjO-4-hfBp9DibMtmGlKFKHyjMOkRbRzumBwRTg1KNGjqT5x0dRKiIwnx_QFARsWqnIpAzN5dZmRSVIj1uNi1fj4Dx2mciPyWpVbpxclTLwPGjwTsAp8B3ry4Y5Rgv4ZS7Z5xHsmUVzyPN9EkTqASEF6NUmuxF6V9kYa3MSth-pnclxKUxN66JAMBucXs2eFToAnvv6YpUmdjn99RsMp3kFD3rzpf4Nybqabx_uJr13YidYDyWUZD6XDwR0Ma9frA5ZenAXPPxrvGoALeSrg76-x7Xn3wbQ4mvD4pui0Xh9nLAh7ec3HfGroS2YP9gDtH5CoWb7FJYgMSdVKp8torNkc7T2OLiABdk4Q/ALBNUaYAAAAAYtpf89agF1XhkANwAUBaptUy2XC1Wbuy/" } ], "event_hooks": [], "external_id": "", "field_enabled_conditions": [], "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGXB1VEg0NXN1NmxqMG9rMTgyMjRmZDlmZmEMogEHc2FuZGJveA", "mail_settings": { "exclude_created_by_from_final_mail": false, "include_attachments_in_final_mail": true, "message": "", "subject": null }, "organisation_key": null, "signatories": [ { "can_receive_signing_notifications": true, "can_receive_viewing_notifications": true, "date_updated": 1658477978067.1989746094, "email": "joesoap@quicklysign.com", "email_is_optional": false, "email_send_count": 0, "mobile_number": null, "name": "Joe Soap", "primary_communication_channel": "email", "role": "employee", "sms_send_count": 0, "status": "setup", "user_key": null, "uuid": "ea23affc-6f6a-4d75-ab3e-649ce834a734" }, { "can_receive_signing_notifications": true, "can_receive_viewing_notifications": true, "date_updated": 1658477978067.3239746094, "email": "joesoapsboss@quicklysign.com", "email_is_optional": false, "email_send_count": 0, "mobile_number": null, "name": "Joe Soaps Boss", "primary_communication_channel": "email", "role": "employer", "sms_send_count": 0, "status": "setup", "user_key": null, "uuid": "e4b0e520-0080-48b8-8912-e019809921c5" } ], "signatory_allocation_questions": [], "signing_settings": { "attachments_visible_to_all_signers": false, "branding_key": null, "can_use_drawn_signature": true, "can_use_one_click_initial": false, "can_use_one_click_signature": false, "can_use_typed_signature": true, "can_use_uploaded_signature": true, "communication_channel_configurable": false, "document_can_be_used_as_form": false, "email_is_optional_for_signing": false, "first_signer_has_multi_edit_role": false, "in_app_signing_page_url": null, "obfuscate_contact_info": false, "post_signing_url": "", "sequential_signing": true, "use_signing_wizard": true, "use_two_factor_authentication": false }, "status": "setup", "team_key": "", "user_defined_attributes": [], "visible_to_organisation": false }, "status": { "status_code": 200 } } ``` -------------------------------- ### Update User Response Example Source: https://docs.quicklysign.com/docs/users Example JSON response after successfully updating a user. ```json { "status": { "status_code": 200 }, "data": { "user": { "key": "ahFzfmFjY291bnRzLXRlYW0tcHJvZCISCxIFVGVhbRiAgICf5LqVCgw", "name": "Joe", "last_name": "Soap123", "mobile_number": "", "email_address": "example@example.com", "date_updated": 1400961473637 } } } ``` -------------------------------- ### Example: Creating a Document Pack in a Specific Workspace Source: https://docs.quicklysign.com/docs/teams The `team_key` (or `workspace_key`) is used in API requests when you want to create a document within a specific workspace. This example shows how to include the workspace identifier in the request body when creating a document pack. ```json { "document_pack_name": "Example Document Pack", "team_key": "ahFzfmFjY291bnRzLXRlYW0tcHJvZCISCxIFVGVhbRiAgICf5LqVCgw", "documents": [ { "document_creation_settings": { "base_64_document": "{{base_64}}", "extract_fields_by_tag": true, ... }, "document_name": "ID document to be signed", "data_fields": [ { "custom_id": "client_name", "data": "Joe Soap" } ] } ], "signatories": [ ... ], ... } ``` -------------------------------- ### Create a Webhook Subscription - Response Body Example Source: https://docs.quicklysign.com/docs/webhooks-1 An example JSON object for the response body after successfully creating a webhook subscription. ```json { "status": { "status_code": 200 }, "data": { "webhook": { "key": "ahNkZXZ-cXVpY2tseXNpZ24tZGV2chkLEgxTdWJzY3JpcHRpb24YgICAgIDwiwoM", "entity_key": "ahFzfnF1aWNrbHlzaWduLWRldnInCxIIRG9jdW1lbnQiGWY2VDNXNW9DejVnQWJnMTgyYjYwMDQyZTAM", "callback": "https://yourapp.com/callback", "date_created": 1401645889795, "date_updated": 1401645889795 } } } ``` -------------------------------- ### Create a Webhook Subscription - Request Body Example Source: https://docs.quicklysign.com/docs/webhooks-1 An example JSON object for the request body when creating a webhook subscription. ```json { "client_secret": "{{client_secret}}", "client_id": "{{client_id}}", "webhook": { "entity_key": "ahFzfnF1aWNrbHlzaWduLWRldnInCxIIRG9jdW1lbnQiGWY2VDNXNW9DejVnQWJnMTgyYjYwMDQyZTAM", "callback": "https://yourapp.com/callback" } } ``` -------------------------------- ### Endpoint Example Source: https://docs.quicklysign.com/docs/glossary The full URL you send a request to. ```text https://sandboxapi.quicklysign.com/v1/document_packs ``` -------------------------------- ### Initial Field Example Source: https://docs.quicklysign.com/docs/data-fields JSON configuration for an initial data field. ```json { "type": "initial", "required": true, "signatory_uuid": "1f3f1524-5929-fc6f-2374-64ca2c3d54ac", "x": 50, "y": 50, "width": 150, "height": 40 } ``` -------------------------------- ### Get All Document Packs Source: https://docs.quicklysign.com/docs/documents Retrieves a list of all document packs. ```http GET /v1/document_packs ``` ```http https://sandboxapi.quicklysign.com/v1/document_packs ``` -------------------------------- ### Example Response (Signing URL) Source: https://docs.quicklysign.com/docs/creating-your-first-document-pack The JSON response containing the signing link when `generate_signing_url` is true. ```json { "signing_link": "your_signing_link" } ``` -------------------------------- ### Example Response for Get Teams Source: https://docs.quicklysign.com/docs/teams The response includes a list of team objects containing key and name. ```json { "data": { "teams": [ { "key": "ahFzfmFjY291bnRzLXRlYW0tcHJvZCISCxIFVGVhbRiAgICf5LqVCgw", "name": "Operations Team" }, { "key": "ahFzfmFjY291bnRzLXRlYW0tc2FsZXMSCxIFVGVhbRiAgICfl9vLCgw", "name": "Sales Workspace" } ] }, "status": { "status_code": 200 } } ``` -------------------------------- ### Update User cURL Example Source: https://docs.quicklysign.com/docs/users Example cURL command to update a user. ```curl curl -X PUT https://sandboxapi.quicklysign.com/v1/users/self \ -H "Content-Type: application/json" \ -H "Cache-Control: no-cache" \ -H "access_token: " \ -d '{ "name": "Joe", "last_name": "Soap123", "mobile_number": "" }' ``` -------------------------------- ### Error Handling Example Source: https://docs.quicklysign.com/docs/rest-principles An example of an error response structure, indicating a bad request. ```json { "status": { "status_code": 400, "errors": [{"code": "invalid_field", "message": "Field X is required"}] } } ``` -------------------------------- ### Example Document Logs Response Source: https://docs.quicklysign.com/docs/logs This is an example of the JSON response received when querying the document logs endpoint. ```json { "data": { "document_logs": [ { "_id": 5730162692325376, "date_created": 1659513665796.916015625, "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA", "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJCCxILRG9jdW1lbnRMb2ciGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMCxILRG9jdW1lbnRMb2cYgICgvtfxlgoMogEHc2FuZGJveA", "log_type": "pdf_generation_info", "messages": [ "enqueuing child documents for pdf creation" ] }, { "_id": 6715648239992832, "date_created": 1659513665747.5532226562, "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA", "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJCCxILRG9jdW1lbnRMb2ciGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMCxILRG9jdW1lbnRMb2cYgICgnov79gsMogEHc2FuZGJveA", "log_type": "pdf_generation_info", "messages": [ "Attempting to create final pdf" ] }, { "_id": 5082482966265856, "date_created": 1659513094676.701171875, "document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA", "key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJCCxILRG9jdW1lbnRMb2ciGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMCxILRG9jdW1lbnRMb2cYgICgvtzPgwkMogEHc2FuZGJveA", "log_type": "check_ready_for_signatures", "messages": [] } ] }, "status": { "status_code": 200 } } ``` -------------------------------- ### CC Recipients Example Source: https://docs.quicklysign.com/docs/documents Example JSON structure for configuring CC recipients for a document pack. ```json "cc_recipients": [ { "email": "examplecc@example.com", "mobile_number": "+27000000000", "name": "Joe Soaps Brother", "can_track_progress": false } ] ``` -------------------------------- ### Update User Request Body Example Source: https://docs.quicklysign.com/docs/users Example JSON payload for updating an existing user. ```json { "name": "Joe", "last_name": "Soap123", "mobile_number": "" } ``` -------------------------------- ### Quick Curl Example Source: https://docs.quicklysign.com/docs/audit-trails A cURL command to fetch audit trail data from the QuicklySign API. ```bash curl -X GET "https://sandboxapi.quicklysign.com/v1/audit_trail/agF3kLm9PqR2sT8uVwXyZaBcDeFgHiJkLmNoPqRsTuVwXyZaBcDeFgHiJkLmNoPqRsTuVwXyZa" \ -H "Authorization: Bearer YOUR_API_KEY" ```