Upload Document For E-Sign

Use this API to upload the document before creating the request for E-Sign. The document ID received in the response of this API is required to create the request for E-Sign.

POST /esignature/document

Upload Document For E-Sign

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/verification/esignature/document \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --form document='@example-file'

200

SUCCESS

{
  "status": "SUCCESS",
  "document_id": 21637861
}

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

multipart/form-data

Find the request parameters to upload the document.

document · file · required

Upload the document that requires an e-sign. Allowed file type - PDF. Max file size allowed - 10MB.

Response

200

application/json

Success response for uploading the document for e-signature.

status · string

It displays the status of the API request. Possible values are: - SUCCESS: File uploaded successfully.

Example:

"SUCCESS"

document_id · integer

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

Example:

14125