eSign SDK v1.0.0 - API Reference Card¶

Quick Reference for All API Endpoints

Base URL: http://localhost:8080/api/java/esign

Authentication Modes¶

Mode	Description	Method
`online-aadhaar-otp`	OTP Authentication	OTP sent to mobile
`online-aadhaar-bio`	Biometric (Fingerprint)	Fingerprint scan
`online-aadhaar-iris`	Iris Authentication	Iris scan
`online-aadhaar-face`	Face Authentication	Face scan
`capricorn-ekyc-account`	eKYC Authentication	Pre-verified identity

Configuration Endpoints¶

Set eSign Mode¶

POST /set-mode
Body: {"mode": "2.1" | "3.2"}
Response: {"success": true, "mode": "2.1", "modeName": "OTP-based Signing"}

Get Configuration¶

GET /config
Response: {"success": true, "config": {...}}

Reset Session¶

POST /reset
Response: {"success": true, "message": "Session reset successfully"}

Signing Workflow Endpoints¶

Step 1: Upload PDF¶

POST /step1/upload
Content-Type: multipart/form-data
Body: file=@document.pdf
Response: {"success": true, "step": 1, "fileName": "...", "documentId": "..."}

Step 2: Set Signer Details¶

POST /step2/signer-details
Body: {
  "signerName": "John Doe",
  "docInfo": "Contract",
  "pageSelection": "all",
  "x1": 350, "y1": 50, "x2": 550, "y2": 120,
  "lockType": "n"
}
Response: {"success": true, "step": 2, "lockMode": "🔓 No Lock"}

Step 3-8: Signing Process¶

POST /step3/generate-hash
POST /step4/convert-hex
POST /step5/generate-txn
POST /step6/construct-xml
POST /step7/sign-xml
POST /step8/generate-esp-form

Step 9: Embed Signature¶

POST /step9/embed-signature
Body: {"outputFileName": "signed.pdf"}
Response: {"success": true, "step": 9, "signedPdfPath": "..."}

Signing Options Reference¶

Option	Values	Default	Description
`cood`	`x1,y1,x2,y2` or `custom`	`350,50,550,120`	Signature position
`pagenum`	`1`, `all`, `1-3`, `first`, `last`, `custom`	`1`	Pages to sign
`reason`	String	`Digital Signature`	Signing reason
`location`	String	`India`	Signing location
`customtext`	String	-	Custom text in signature
`greenticked`	`y` / `n`	`y`	Show green checkmark
`dateformat`	Date pattern	`dd-MMM-yyyy hh:mm a`	Date format
`lockpdf`	`n` / `y` / `cf` / `cfa` / `ym`	`n`	PDF lock mode
`signaturePositions`	Array	-	Multi-location positions
`searchbytext`	String	-	Global search-by-text mode
`boxsize`	`width,height`	-	Required in search-by-text
`boxposition`	`top`/`bottom`/`left`/`right`/`on`	-	Required in search-by-text

Multi-Location Signing¶

Different positions on different pages:

{
  "signerName": "John Doe",
  "docInfo": "Contract",
  "signatureMode": "multi",
  "signaturePositions": [
    { "pages": "first", "cood": "50,50,200,120" },
    { "pages": "2,3", "cood": "200,400,400,470" },
    { "pages": "last", "cood": "400,50,550,120" }
  ],
  "lockType": "n"
}

Field	Values
`pages`	`"first"`, `"last"`, `"all"`, `"1"`, `"1-3"`, `"1,3,5"`
`cood`	`"x1,y1,x2,y2"`

PDF Lock Modes¶

Value	Mode	Description
`n`	No Lock	Allow additional signatures (default)
`y`	Certified (No Changes)	Fully locked, no modifications
`cf`	Certified (Form Filling)	Only form fields editable
`cfa`	Certified (Form + Annotations)	Forms and comments allowed
`ym`	Signature Lock Dictionary	Lock via PdfSigLockDictionary

Date Format Patterns¶

Pattern Characters¶

Symbol	Meaning	Example
`yyyy`	4-digit year	`2025`
`yy`	2-digit year	`25`
`MMMM`	Full month	`January`
`MMM`	Short month	`Jan`
`MM`	2-digit month	`01`
`dd`	2-digit day	`05`
`d`	Day	`5`
`EEEE`	Full day name	`Monday`
`EEE`	Short day	`Mon`
`HH`	24-hour (00-23)	`14`
`hh`	12-hour (01-12)	`02`
`mm`	Minutes	`30`
`ss`	Seconds	`45`
`a`	AM/PM	`PM`
`z`	Timezone	`IST`

Common Formats¶

Format	Output
`dd-MMM-yyyy hh:mm a`	`05-Jan-2025 02:30 PM`
`dd/MM/yyyy HH:mm:ss`	`05/01/2025 14:30:45`
`yyyy-MM-dd HH:mm:ss`	`2025-01-05 14:30:45`
`MMMM dd, yyyy`	`January 05, 2025`
`dd MMMM yyyy`	`05 January 2025`
`EEE, dd MMM yyyy`	`Mon, 05 Jan 2025`
`EEEE, MMMM dd, yyyy`	`Monday, January 05, 2025`
`dd.MM.yyyy`	`05.01.2025`
`MM/dd/yyyy`	`01/05/2025`

Regional Formats¶

Region	Format	Output
India	`dd-MMM-yyyy hh:mm a`	`05-Jan-2025 02:30 PM`
US	`MM/dd/yyyy hh:mm a`	`01/05/2025 02:30 PM`
UK	`dd/MM/yyyy HH:mm`	`05/01/2025 14:30`
Europe	`dd.MM.yyyy HH:mm`	`05.01.2025 14:30`
ISO	`yyyy-MM-dd'T'HH:mm:ss`	`2025-01-05T14:30:45`

With Literal Text¶

Format	Output
`'Signed on' dd-MMM-yyyy`	`Signed on 05-Jan-2025`
`dd-MMM-yyyy 'at' hh:mm a`	`05-Jan-2025 at 02:30 PM`

Complete Workflow Example¶

# Set mode
curl -X POST http://localhost:8080/api/java/esign/set-mode \
  -H "Content-Type: application/json" \
  -d '{"mode":"2.1"}'

# Upload PDF
curl -X POST http://localhost:8080/api/java/esign/step1/upload \
  -F "file=@document.pdf"

# Set signer details with all options
curl -X POST http://localhost:8080/api/java/esign/step2/signer-details \
  -H "Content-Type: application/json" \
  -d '{
    "signerName":"John Doe",
    "docInfo":"Contract",
    "pageSelection":"all",
    "lockType":"y"
  }'

# Execute steps 3-8
curl -X POST http://localhost:8080/api/java/esign/step3/generate-hash
curl -X POST http://localhost:8080/api/java/esign/step4/convert-hex
curl -X POST http://localhost:8080/api/java/esign/step5/generate-txn
curl -X POST http://localhost:8080/api/java/esign/step6/construct-xml
curl -X POST http://localhost:8080/api/java/esign/step7/sign-xml
curl -X POST http://localhost:8080/api/java/esign/step8/generate-esp-form

# After ESP signing, embed signature
curl -X POST http://localhost:8080/api/java/esign/step9/embed-signature \
  -H "Content-Type: application/json" \
  -d '{"outputFileName":"signed.pdf"}'

eSign Mode Differences¶

Feature	eSign 2.1	eSign 3.2
Auth Modes	OTP, Bio, Iris, Face	eKYC
Callback	`/esp-response`	`/3.2/getdocs/` + `/3.2/callback/`
Document URL	Not required	Required (public URL)
Response	Synchronous	Asynchronous

Quick Tips¶

Set mode first (/set-mode)
Follow steps in order (1 → 2 → 3 → ... → 9)
Use same session for all steps
Use lockType y for final documents
Use lockType n for multi-signer workflows
OTP mode for remote signing
Bio/Iris/Face modes for in-person signing

Support¶

Full Documentation: esign-api-guide.md
Quick Start: quick-start-guide.md
Email: support@esign.network
Website: https://www.esign.network