Contract360 Workflow
Helper APIs

Pull Contract API

14min

Introduction

The Pull Contract API offers a streamlined way to retrieve comprehensive details about a contract using its unique Contract ID. This API provides real-time updates on signer statuses, including completion, pending signatures, and deletions. With this information, you can efficiently track the signing progress, manage signed and deleted signers, and gauge the overall contract completion status.

Key Features:

  • Retrieve contract details using Contract ID.
  • Track real-time signer statuses.
  • Monitor completed, pending, and deleted signers.
  • Get an overview of contract completion status.
  • Seamlessly integrate with existing systems.

The Pull Contract API simplifies contract management by providing actionable insights into signer activities and overall contract progress.

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


Input Parameters

Key

Description

Type

Mandatory/Optional

contractId

ID of the contract

String

Mandatory

base64EncodedOutput

If the final signed contract output file is required in Base64 format

Boolean

Optional

By default, it is false

If it is passed as true, the Final Signed Contract output file will be in base64 format

Sample Response

200
Base64 Output Format


Output Parameters

Field Name

Description

Type

contractId

Unique identifier for the contract.

String

initialSignerCount

Number of initial signers for the contract.

Number

signedSignerCount

Number of signers who have already signed the contract.

Number

deletedSignerCount

Number of signers who have been deleted from the contract.

Number

contractName

Name of the contract.

String

contractExecuterName

Name of the contract executor.

String

successRedirectUrl

URL to redirect after successful contract execution.

String

failureRedirectUrl

URL to redirect in case of contract execution failure.

String

callbackUrl

URL for callback upon contract completion.

String

signerCallbackUrl

URL for individual signer callbacks.

String

contractTtl

Time to live (in milliseconds) for the contract.

Number

initialContract

URL to the initial contract document.

String

initialContractHash

Initial hash of the contract.

String

finalSignedContract

Base64 to the final signed contract document.

String

finalSignedContractHash

Hash of the final signed contract.

String

isCompleted

Status indicating whether the contract is completed (true) or not (false).

Boolean

contractCompletionTime

Timestamp indicating when the contract was completed.

String

estamp

Electronic stamp details for the contract.

Object

signerdetail

Details of signers for the contract.

Array of Objects

deletedsignerdetail

Details of deleted signers from the contract.

Array of Objects

contractStatus

Current status of the contract. The contract status can be:

  • INITIATED
  • PENDING
  • COMPLETED
  • REJECTED
  • DELETED
  • CANCELLED
  • EXPIRED

Know more about contract status

String

customerMailList

List of email IDs which will receive the details.

Array of Strings

customerMailListVisibility

Consist customer mail list in cc or bcc that was passed.

String

eStamp:

Field Name

Description

Type

transactionId

Unique identifier for the eStamp transaction.

String

estampStatus

Status of the eStamp transaction.

String

transactionResult

Result details of the eStamp transaction.

Object

Transaction Result (within eStamp):

Field Name

Description

Type

challanNo

Challan number for the eStamp transaction.

String

challanSubNo

Sub-challan number for the eStamp transaction.

String

eStampedFile

URL to the eStamped contract document.

String

SignerDetail:

Field Name

Description

Type

signerName

Name of the signer.

String

signerGender

Gender of the signer.

String

signerYearOfBirth

Year of birth of the signer.

String

signerId

Unique identifier for the signer.

String

signatureType

Type of signature for the signer.

String

contractLastSignTime

Timestamp of the signer's last sign attempt.

String

status

Status of the signer (e.g. FAIL, PENDING, SUCCESS).

String

errorMessage

Error message related to the signer.

String

aadhaarStatus

Aadhaar status of the signer.

String

aadhaarErrorMessage

Error message related to Aadhaar verification.

String

matchScoreResult

Result of match score for the signer.

Object

signerIP

IP address of the signer.

String

noOfSuccessfulAttempts

Number of successful sign attempts by the signer.

Number

noOfFailureAttempts

Number of failed sign attempts by the signer.

Number

signerSignedContract

URL to the signer's signed contract document.

String

signerSignedContractHash

Hash of the signer's signed contract.

String

esignAttempts

Details of e-sign attempts by the signer.

Array of Objects

eSign Attempts:

Field Name

Description

Type

errorMessage

Error message, if any

String

aadhaarStatus

Aadhaar status

String

aadhaarErrorMessage

Error message related to Aadhaar

String

signerDscData

Object containing signer DSC data

Object

signerDscData.state

State information

String

signerDscData.pincode

Pincode information

String

signerDscData.dnQualifier

Distinguished Name qualifier

String

signerDscData.yob

Year of birth

String

signerDscData.gender

Gender

String

signerDscData.uidLastFourDigits

Last four digits of UID

String

signerDscData.x500UniqueIdentifier

X.500 unique identifier

String

signerDscData.aadhaarToken

Aadhaar token

String

signerDscData.pseudonym

Pseudonym

String

signerDscData.aadhaarType

Type of Aadhaar

String

signerDscData.country

Country

String

signerDscData.name

Name

String

Sample Errors

400
400
401
404
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

404

Not Found

Contract ID eneterd is not found in the database

500

Internal Server Error

Internal error at Signzy, Please reach out to [email protected]



Updated 01 Oct 2024
Doc contributor
Did this page help you?
PREVIOUS
Initiate Contract API
NEXT
Delete Signer API
Docs powered by Archbee