Create E-Sign Request

Use this API to add the details of the document and signer(s) to initiate e-sign verification.

Authorizations

x-client-id · string · header · required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret · string · header · required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-cf-signature · string

Send the signature if two-factor authentication is selected as Public Key. More details

Body

application/json

Find the request parameters to add the details of the document and signer

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.

Example:

"ABC00123"

document_id · integer · default: 36 · required

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

Example:

36

notification_modes · enum<string>[] · required

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

Possible values:

• ["email"]: An email with the signing link will be sent to the signer's email address.
• []: No communication will be triggered to the signer. Note: For this option, the request must contain only one signer.

Show child attributes

Example:

["email"]

auth_type · enum<string> · required

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

Available options:

AADHAAR

Example:

"AADHAAR"

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.

Example:

"2"

signers · object[] · required

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

Show child attributes

Example:

[
  {
    "name": "John Doe",
    "email": "[e-mail]",
    "phone": "9999999999",
    "sequence": 1,
    "aadhaar_last_four_digit": "6789",
    "sign_positions": [
      {
        "page": 1,
        "top_left_x_coordinate": 100,
        "bottom_right_x_coordinate": 200,
        "top_left_y_coordinate": 180,
        "bottom_right_y_coordinate": 120
      },
      {
        "page": 2,
        "top_left_x_coordinate": 100,
        "bottom_right_x_coordinate": 200,
        "top_left_y_coordinate": 180,
        "bottom_right_y_coordinate": 120
      }
    ]
  }
]

capture_location · boolean · default: false

It is an option to capture the location of the signer. If enabled, the signer will be requested to give their location permission.

Example:

false

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.

Example:

"REDIRECT_PAGE_URL"

Response

200

application/json

Success response for creating an e-signature request

status · string

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

Example:

"SUCCESS"

verification_id · string

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

Example:

"ABC00123"

reference_id · integer

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

Example:

33

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.

Example:

36

signing_link · string

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

Example:

"SIGNING_LINK"