Creating a syntax document and using it VIA the API
Walkthrough on creating a syntax document converted to base_64 and using it VIA the API
Creating a syntax document and using it VIA the API
{
"document_name": "Syntax API DEMO",
"document_type":"document",
"documents":
[
{
"document_creation_settings":
{
"base_64_document": "",
"extract_fields_by_tag": true
},
"document_name":"my test syntax form",
"data_fields": [
{
"custom_id": "","data": ""
},
{
"custom_id": "","data": ""
},
{
"custom_id": "","data": ""
},
{
"custom_id": "","data": ""
}
]
}
],
"signatories":[
{
"name":"",
"role": "",
"email":""
},
{
"name":"",
"role": "",
"email":""
}
]
}
{
"data": {
"document_pack": {
"cc_recipients": [],
"created_by_email": "[email protected]",
"created_by_external_user_code": null,
"custom_data": null,
"date_created": 1658497445386.921875,
"date_updated": 1658497445387.5161132812,
"document_pack_name": "",
"document_type": "document",
"documents": [
{
"custom_data": null,
"data_fields": [
{
"auto_assign_date": null,
"auto_fill": null,
"background_colour": null,
"blob": null,
"checkbox_group_id": null,
"continue_if_signer_question": null,
"custom_id": "employee_firstname",
"data": "Joe",
"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": "ad5857eb-1382-467a-a93f-ab26266ea1fa",
"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": "employee_surname",
"data": "Soap",
"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": "8450cc6c-957b-4c54-86de-61fc530a5dbc",
"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_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": "[email protected]",
"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": "7a5a27fb-c005-4909-b1fe-bcd14da97e9d"
},
{
"can_receive_signing_notifications": true,
"can_receive_viewing_notifications": true,
"date_updated": 1658497445387.2238769531,
"email": "[email protected]",
"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
}
}
Updated almost 2 years ago
What’s Next
Watch how to use create and use custom branding VIA the API