Get Sign Settings

Purpose

To get the sign settings of a contract.

Endpoints

GET /contracts/{contractApiName}/signinginfo

Request Details

Request URL

https://contracts.zoho.com/api/v1/contracts/{contractApiName}/signinginfo

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.contracts.READ, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to contract information
READ - Get sign settings information

Sample Request

Copiedcurl "https://contracts.zoho.com/api/v1/contracts/msa-with-zenith-dynamics/signinginfo"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

signActivitiesJSON Array
The array represents the list of sign settings involved in the contract signing process, including the status of the Zoho Sign Integration, reminder settings, sign paper type, days to complete signing, current signing cycle, and current signing status.

signServiceStatusnumber

Represents the current status of the Zoho Sign integration.

Value	Description
50	The Zoho Sign integration is active.
51	The Zoho Sign integration has been disconnected.
52	The contract document has been edited in Zoho Sign.
53	The ownership of the contract document has changed.
54	The Counterparty Representatives associated with the signing process have been deleted.
55	The Account Owner, Admin, or Contract Owner has stopped processing the counterparty representative's data.
56	The contract’s effective date has passed.
57	The Leegality integration has been disconnected. Applicable only to the India (zoho.in/contracts) data center for contracts with the contract type where the stamp paper is Digitized Stamp Paper.
61	The Sign Paper details have been removed from the associated contract type.
62	The e-Stamp has become invalid due to the signer's decline action.

reminderDaysnumber
Represents the number of days before the deadline to send reminders to signers.
signPapernumber
Represents the type of paper used for signing.
Value Description
0 White Paper
1 Digitized Stamp Paper
2 e-Stamp Paper
signServicenumber
Represents the unique ID of the e-Signature service used to sign the contract.
Value Description
100 Zoho Sign
300 Leegality
timelong
Represents the timestamp (in milliseconds) when the signing process was initiated.
daysToCompletenumber
Represents the total number of days allocated for signers to complete the signing process.
cycleNumbernumber
Represents the sequence number of the signing cycle, especially useful for tracking multiple signing rounds for the same contract.

statusnumber

Represents the current status of the signing process.

Value	Description
12	The signing process is currently in progress.
14	The signing process has been completed successfully.
34	The signing process was declined by one or more signers.
33	The signing process has been recalled by the Contract Owner.
10	The signing process has expired.
36	The signature process has not been initiated yet.
38	The signing process has expired and cannot be extended.

Sample Response

Copied{
    "signActivities": [
        {
            "signServiceStatus": 50,
            "reminderDays": 5,
            "allowedFeatures": 7,
            "signPaper": 0,
            "signService": 100,
            "time": 1755098973470,
            "daysToComplete": 15,
            "cycleNumber": 1,
            "status": 36
        }
    ]
}

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect. Specify a valid request URL.

Resolution: Provide a valid URL as mentioned in the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized. The client does not have contracts.contracts.READ scope.

Resolution: Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to create. The user does not have permission to create records.

Resolution: Contact the organization administrator to request the required access.

INTERNAL_ERRORHTTP 500

Internal Server Error.

Resolution: Unexpected and unhandled exception in the server. Try again later or contact the support team for assistance.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: Specify a valid request method as specified in the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to create module details.

Resolution: Contact the organization administrator to request the required access.

Value	Description
0	White Paper
1	Digitized Stamp Paper
2	e-Stamp Paper