Website
Env:
Home/API Docs/eSign Requests
Target:https://eznotary.in/api/v1
API Module

eSign Requests

Create and manage standalone Aadhaar / OTP based electronic signature requests for agreements, NDAs, HR forms, and contracts.

6 Endpoints
API Key Authentication
Prefix:/esign-requests
POST/esign-requests
API Key Required

Create eSign Request

Creates a multi-signatory eSign request via multipart/form-data. Supports PDF attachments, signature placeholders, expiration windows, and SMS/email notifications.

URL:https://eznotary.in/api/v1/esign-requests
Request Parameters

Headers

HeaderTypeRequiredDescription
x-api-keystringRequiredTenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secretstringRequiredTenant API Secret key paired with your API key.

Request Body Parameters

Format: multipart/form-data
FieldTypeRequiredDescription
documents
array of files (binary)Required
Up to 10 PDF documents to be signed. Max 25MB each.
Example: agreement.pdf
signatories
array of objects (JSON string)Required
List of signatories with legal names, emails, and phone numbers.
↳fullName
stringRequired
Full name as per Aadhaar/PAN.
Example: Vikram Mehta
↳email
stringRequired
Email to send signing link.
Example: vikram.mehta@example.com
↳phone
stringRequired
Phone number for Aadhaar OTP authentication.
Example: 9876501234
↳dob
stringOptional
Date of birth (YYYY-MM-DD).
Example: 1988-06-20
type
enumOptional
Type of signature workflow.
Example: esign
Allowed:esignnotary
documentCategory
stringOptional
Category label (e.g. Agreement, Vendor Contract, NDA).
Example: Vendor Agreement
notes
stringOptional
Instructions displayed to signatories on the signing page.
Example: Please verify the bank account details on page 2 before signing.
expiresInDays
numberOptional
Number of days before the signing link expires (1-30).
Example: 7
cURL — Create eSign Request
curl -X POST "https://eznotary.in/api/v1/esign-requests" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -F "documents=@/path/to/agreement.pdf" \
  -F "type=esign" \
  -F "documentCategory=Vendor Agreement" \
  -F "notes=Please verify bank details before signing." \
  -F "expiresInDays=7" \
  -F 'signatories=[{"fullName":"Vikram Mehta","email":"vikram.mehta@example.com","phone":"9876501234"}]'
GET/esign-requests
API Key Required

List eSign Requests

Returns paginated eSign requests with status filters, search, and date ranges.

URL:https://eznotary.in/api/v1/esign-requests
Request Parameters

Headers

HeaderTypeRequiredDescription
x-api-keystringRequiredTenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secretstringRequiredTenant API Secret key paired with your API key.

Query Parameters

ParameterTypeRequiredDescriptionExample
pagenumberOptionalPage number1
limitnumberOptionalItems per page (max 100)10
statusstringOptionalFilter by status: pending, completed, cancelled, expiredpending
searchstringOptionalSearch by signatory name, email, or refIdVikram
cURL — List eSign Requests
curl -X GET "https://eznotary.in/api/v1/esign-requests" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"
GET/esign-requests/:id
API Key Required

Get eSign Request Details

Returns status for all signatories, document metadata, audit logs, and certificate details.

URL:https://eznotary.in/api/v1/esign-requests/:id
Request Parameters

Headers

HeaderTypeRequiredDescription
x-api-keystringRequiredTenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secretstringRequiredTenant API Secret key paired with your API key.

Path Parameters

ParameterTypeDescriptionExample
idstringeSign Request UUID or Ref ID (e.g. ESIGN-REQ-8812)ESIGN-REQ-8812
cURL — Get eSign Request Details
curl -X GET "https://eznotary.in/api/v1/esign-requests/:id" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"
POST/esign-requests/:id/resend
API Key Required

Resend Invitation

Re-dispatches the email and SMS notification containing the active signing URL to all signatories who have not yet signed.

URL:https://eznotary.in/api/v1/esign-requests/:id/resend
Request Parameters

Headers

HeaderTypeRequiredDescription
x-api-keystringRequiredTenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secretstringRequiredTenant API Secret key paired with your API key.

Path Parameters

ParameterTypeDescriptionExample
idstringeSign Request UUID or Ref IDESIGN-REQ-8812
cURL — Resend Invitation
curl -X POST "https://eznotary.in/api/v1/esign-requests/:id/resend" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"
DELETE/esign-requests/:id
API Key Required

Cancel eSign Request

Voids all active signing links and marks the request as cancelled. Signatories attempting to access the link will see a cancellation notice.

URL:https://eznotary.in/api/v1/esign-requests/:id
Request Parameters

Headers

HeaderTypeRequiredDescription
x-api-keystringRequiredTenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secretstringRequiredTenant API Secret key paired with your API key.

Path Parameters

ParameterTypeDescriptionExample
idstringeSign Request UUID or Ref IDESIGN-REQ-8812

Request Body Parameters

Format: application/json
FieldTypeRequiredDescription
reason
stringOptional
Cancellation reason recorded in audit log.
Example: Contract terms revised.
cURL — Cancel eSign Request
curl -X DELETE "https://eznotary.in/api/v1/esign-requests/:id" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Contract terms revised."
}'
GET/esign-requests/:id/download
API Key Required

Download Signed Document

Retrieves the finalized, signed PDF document together with the audit certificate trail.

URL:https://eznotary.in/api/v1/esign-requests/:id/download
Request Parameters

Headers

HeaderTypeRequiredDescription
x-api-keystringRequiredTenant API Key generated from the EZNotary B2B Developer Portal.
x-api-secretstringRequiredTenant API Secret key paired with your API key.

Path Parameters

ParameterTypeDescriptionExample
idstringeSign Request UUID or Ref IDESIGN-REQ-8812
cURL — Download Signed Document
curl -X GET "https://eznotary.in/api/v1/esign-requests/:id/download" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET"