Generate Contract API

introduction in the ever evolving landscape of modern business, efficiency and precision are paramount to streamline and expedite the process of creating contracts, we present the contract generation api – a powerful tool designed to seamlessly merge template based contract creation with dynamic data input this api empowers businesses to generate comprehensive and tailored contract documents effortlessly, all through a straightforward integration the contract generation api leverages the synergy between template ids and json data, enabling users to effortlessly populate predefined contract templates with specific information by inputting a designated template id and providing the requisite data in json format, the api orchestrates the merging of template elements and data fields the end result is a meticulously crafted contract, customized to reflect the unique requirements of each use case in this documentation, we will delve into the intricacies of integrating and utilizing the contract generation api from obtaining api credentials to formatting json data and implementing template ids, our comprehensive guide will equip developers, businesses, and legal professionals alike with the knowledge and tools to harness the full potential of this groundbreaking technology authentication api authentication is a crucial security process that ensures authorized access to an application programming interface (api) it involves validating the identity of users or systems seeking to interact with the api please use the access token shared with you by your assigned signzy's csm please set the value of the key authorization in the headers to the access token , while making an api call in this way, signzy's system will be able to authenticate you and you will be able to make a successful api call api details the details of the api can be found here sample curl pre production curl location 'https //api preproduction signzy app/api/v3/contract/generate' \\ \ header 'authorization ' \\ \ header 'content type application/json' \\ \ header 'x uniquereferenceid ' \\ \ data '{ "templateid" "64c0e0db4b7023d0a3cc8357", "urltype" "url", "jsondata" { "image1" "", "checkbox1" "true", "checkbox2" "false", "textfield1" "test1", "textfield2" "test2" } }' production curl location 'https //api signzy app/api/v3/contract/generate' \\ \ header 'authorization ' \\ \ header 'content type application/json' \\ \ header 'x uniquereferenceid ' \\ \ data '{ "templateid" "64c0e0db4b7023d0a3cc8357", "urltype" "url", "jsondata" { "image1" "", "checkbox1" "true", "checkbox2" "false", "textfield1" "test1", "textfield2" "test2" } }' input parameters header parameters key type m/o description x uniquereferenceid string optional unique reference id for each api request it needs to be generated at client's end and passed in api it can further be used in initiate contract query api to know the status of the api call 36 characters long, uuid number which has to be unique for example, 82541a35 d494 4fbb 97f3 e2323208986e body parameters key description type mandatory/optional templateid identifier for the template the template id that you would have received after uploading the template in cretae template api string mandatory urltype format of the output file that is expected the values can be url if url is passed, the output would be a url base64 if base64 is passed, the output would be in base64 string mandatory jsondata json data containing various fields, which were predefined for the template in create template api object mandatory sample response 200 { "status" "success", "statusdesp" "url generated successfully", "url" "", "x uniquereferenceid" "" } output parameters key description type status status of the operation string statusdesp description of the status string url generated url it can be in url or base64 formats depending on the input that was provided in the api call string x uniquereferenceid unique reference id for each api request it needs to be generated at client's end and passed in api it can further be used in initiate contract query api to know the status of the api call 36 characters long, uuid number which has to be unique for example, 82541a35 d494 4fbb 97f3 e2323208986e string sample errors 400 { "name" "error", "message" "invalid url extension", "reason" "validation error", "type" "bad request", "statuscode" 400 } 400 { "name" "error", "message" "error generating pdf from template", "reason" "input error", "type" "bad request", "statuscode" 400 } 401 { "message" "invalid authentication credentials" } 500 { "error" { "name" "error", "message" "internal server error", "reason" "internal server error", "type" "internal server error", "statuscode" 500 } } error parameters parameter type description name string in case of errors, it will have the value "error" it represents an error message string message for the error reason string reasons for the error type string type of error statuscode string status code of the error error codes error code error message explanation 400 bad request input parameter has a missing required parameter or invalid inputs 401 authorization failed authorization token is invalid 500 internal server error internal error at signzy, please write to us at help\@signzy com