POST
/
esignature
{
  "status": "SUCCESS",
  "verification_id": "ABC00123",
  "reference_id": 33,
  "document_id": 36,
  "signing_link": "SIGNING_LINK"
}

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.

Body

application/json

Find the request parameters to add the details of the document and signer(s)

auth_type
enum<string>
required

It is the type of authentication to be used for signature.

Available options:
AADHAAR
document_id
integer
default:
36
required

It is the unique ID received in the Upload Document for E-Sign API response.

expiry_in_days
string
default:
2
required

It is the expiry of the signing link for each signer in days. The maximum allowed time is 15 days.

notification_modes
enum<string>[]
required

It is how you want to notify the signee about the e-sign details.

Available options:
email
signers
object[]
required

It should contain the details of the signer(s).

verification_id
string
default:
ABC00123
required

It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

redirect_url
string
default:
REDIRECT_PAGE_URL

It is the URL that you need to provide that takes the user to after completing the e-sign journey. It will contain the verification_id that can be used to get the status of the verification.

Response

200 - application/json

Success response for Create E-Sign RequestR

document_id
integer

It displays the unique ID created by Cashfree Payments to identify the document. You receive this ID in the response of Upload Document For E-Sign API.

reference_id
integer

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

It displays the link to proceed with the e-signature of the document for the first signer.

status
string

It displays the status of the API request. Possible values are: - SUCCESS: Successfully initiated request for e-signature.

verification_id
string

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