GET
/
esignature
{
  "status": "IN_PROGRESS",
  "reference_id": 32,
  "verification_id": "ESTestVERID34",
  "document_id": 36,
  "signers": [
    {
      "name": "John Doe",
      "status": "SUCCESS",
      "is_notified": true
    },
    {
      "name": "Frank Kelvin",
      "status": "SIGN_IN_PROGRESS",
      "is_notified": true
    }
  ],
  "signed_doc_url": "SIGNED_DOC_URL"
}

Authorizations

x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Query Parameters

reference_id
integer
default:
54321

It is the unique ID created by Cashfree Payments that you receive in the response of Create E-Sign Request API. format: int64

verification_id
string
default:
ABC00123

It is the unique ID you create to identify the Create E-Sign Request API.

Response

200 - application/json

Success response for Get E-Sign Status

document_id
integer

It displays the unique ID created by Cashfree Payments to identify the uploaded document.

reference_id
integer

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

signed_doc_url
string

It displays the link of the signed document.

signers
object[]

It contains the details of the signer(s).

status
string

It displays the status of the e-signature. Possible values are: - IN_PROGRESS: Signing process is initiated. - SUCCESS: All the signers signed successfully. - EXPIRED: Signing window expired. - FAILURE: Error occured during signing the document.

verification_id
string

It displays the unique ID created by you to identify the API request.