Complete Contract API

10min

Introduction
In the dynamic landscape of contract management, the need for an agile and comprehensive solution to mark contracts as complete is paramount. Introducing the Complete Contract API, a robust tool designed to streamline the finalization process of contracts with efficiency and precision. This API serves as a pivotal asset for organizations seeking to enhance their contract lifecycle management by seamlessly marking contracts as complete with a simple input of the contract ID.
The Complete Contract API is engineered to be a user-friendly and adaptable solution that effortlessly integrates into existing systems, providing organizations with the ability to automate and expedite the finalization of contracts. By utilizing the unique contract ID, this API initiates the process of marking contracts as complete or cancelled, eliminating manual interventions and reducing the risk of oversight in the contract lifecycle.
In this introduction, we embark on an exploration of the capabilities and functionalities of the Complete Contract API. Subsequent sections will delve deeper into the features, implementation guidelines, and the transformative impact this API can have on optimizing contract management workflows. Join us as we unravel how the Complete Contract API empowers organizations to enhance efficiency, minimize errors, and fortify their contract management processes in the ever-evolving business landscape.
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/complete' \
--header 'Authorization: ************************' \
--header 'Content-Type: application/json' \
--data '{
    "contractId" : "************************",
    "changeStatus": ""
}'
curl --location 'https://api.signzy.app/api/v3/contract/complete' \
--header 'Authorization: ************************' \
--header 'Content-Type: application/json' \
--data '{
    "contractId" : "************************",
    "changeStatus": ""
}'
﻿
Input Parameters
Key
Description
Type
Mandatory/Optional
contractId
ID of the contract which needs to be marked completed
String
Mandatory
changeStatus
An optional key which can hold any of two values 
completed
cancelled
Where completed leads to the completion of the contract and cancelled leads to the cancellation of the contract. 
String
Optional
If the key is not passed then by default it will lead to the contract completion.
Sample Response
200
{
    "isSuccess": true
}
{
    "isSuccess": true
}
﻿
Output Parameters
Field Name
Description
Type
isSuccess
The status
String
Sample Errors
400
400
401
404
500
{
  "name": "error",
  "message": "Contract Expired",
  "reason": "Bad Request",
  "type": "Bad Request",
  "statusCode": 400
}
{
  "name": "error",
  "message": "Contract Expired",
  "reason": "Bad Request",
  "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
404
Not found
Signer ID is not found in the system
500
Internal Server Error
Internal error at Signzy, Please reach out to [email protected]
﻿

Key	Description	Type	Mandatory/Optional
contractId	ID of the contract which needs to be marked completed	String	Mandatory
changeStatus	An optional key which can hold any of two values completed cancelled Where completed leads to the completion of the contract and cancelled leads to the cancellation of the contract.	String	Optional If the key is not passed then by default it will lead to the contract completion.

Field Name	Description	Type
isSuccess	The status	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
404	Not found	Signer ID is not found in the system
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]

Updated 14 Oct 2024

Did this page help you?

Remind Signer API

Delete Contract API