eSign Requests
Create and manage standalone Aadhaar / OTP based electronic signature requests for agreements, NDAs, HR forms, and contracts.
Create eSign Request
Creates a multi-signatory eSign request via multipart/form-data. Supports PDF attachments, signature placeholders, expiration windows, and SMS/email notifications.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |
Request Body Parameters
Format: multipart/form-data| Field | Type | Required | Description |
|---|---|---|---|
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 | string | Required | Full name as per Aadhaar/PAN. Example: Vikram Mehta |
↳email | string | Required | Email to send signing link. Example: vikram.mehta@example.com |
↳phone | string | Required | Phone number for Aadhaar OTP authentication. Example: 9876501234 |
↳dob | string | Optional | Date of birth (YYYY-MM-DD). Example: 1988-06-20 |
type | enum | Optional | Type of signature workflow. Example: esign Allowed:esignnotary |
documentCategory | string | Optional | Category label (e.g. Agreement, Vendor Contract, NDA). Example: Vendor Agreement |
notes | string | Optional | Instructions displayed to signatories on the signing page. Example: Please verify the bank account details on page 2 before signing. |
expiresInDays | number | Optional | Number of days before the signing link expires (1-30). Example: 7 |
List eSign Requests
Returns paginated eSign requests with status filters, search, and date ranges.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| page | number | Optional | Page number | 1 |
| limit | number | Optional | Items per page (max 100) | 10 |
| status | string | Optional | Filter by status: pending, completed, cancelled, expired | pending |
| search | string | Optional | Search by signatory name, email, or refId | Vikram |
Get eSign Request Details
Returns status for all signatories, document metadata, audit logs, and certificate details.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |
Path Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| id | string | eSign Request UUID or Ref ID (e.g. ESIGN-REQ-8812) | ESIGN-REQ-8812 |
Resend Invitation
Re-dispatches the email and SMS notification containing the active signing URL to all signatories who have not yet signed.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |
Path Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| id | string | eSign Request UUID or Ref ID | ESIGN-REQ-8812 |
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.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |
Path Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| id | string | eSign Request UUID or Ref ID | ESIGN-REQ-8812 |
Request Body Parameters
Format: application/json| Field | Type | Required | Description |
|---|---|---|---|
reason | string | Optional | Cancellation reason recorded in audit log. Example: Contract terms revised. |
Download Signed Document
Retrieves the finalized, signed PDF document together with the audit certificate trail.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |
Path Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| id | string | eSign Request UUID or Ref ID | ESIGN-REQ-8812 |