Generate Contract API

11min

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
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"
    }
}'
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": ""
}
{
    "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
400
401
500
{
    "name": "error",
    "message": "Invalid URL extension",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
{
    "name": "error",
    "message": "Invalid URL extension",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
﻿
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 [email protected]
﻿

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

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

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

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 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 [email protected]

Updated 29 May 2024

Did this page help you?

Delete Template API

Initiate Contract API