Complete Contract API

Introduction

Client can choose to complete the contract from Signzy system once the contract is signed by atleast one signer in sequential signing and atleast one required signer in parallel signing. Parameters contactId and customerId are used to identify the contract to be completed.

How to call the API

You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.

API Input Guidelines

Need to pass follow information: 1. Contract ID 2. Customer ID

Sample Curl

Preproduction

Production

curl --location --request POST 'https://contracting-preproduction.signzy.tech/api/contractdetails/completeContract' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth-token>' \
--data-raw '{
    "contractId": "..contractId..",
    "customerId": "..customer-id.."
}'

curl --location --request POST 'https://contracting.signzy.tech/api/contractdetails/completeContract' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth-token>' \
--data-raw '{
    "contractId": "..contractId..",
    "customerId": "..customer-id.."
}'

Input Parameters

PARAMETERS	DESCRIPTION	REQUIRED/OPTIONAL
contractId	Unique Id of the contract	Required
customerId	Unique Id of the customer	Required

Sample Response

{
    "status": "FAIL",
    "statusCode": 101,
    "message": "Contract is already completed"
}

Response Parameter

PARAMETERS	DESCRIPTION
status	SUCCESS/FAIL depending on the status of the API
statusCode	status code for the API
message	Message containing information about the API's status

Sample Error

{
    "type": "Error",
    "status": 404,
    "message": "Contract not found.",
    "statusCode": 404
}

Error Parameter

PARAMETER NAME	DESCRIPTION
statusCode	Request Status code from Signzy
status	the status of the error
message	the error message
type	type of the error

Error Codes

CODE	DESCRIPTION	INTERPRETATION
400	Bad Request	Input Parameter has a missing required parameter or not a valid one.
404	Not Found	The contractId given was not found
401	Authorization Failed	Authorization token is invalid.
500	Internal Server Error	Internal error at Signzy, please contact support.

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].