Developers
An API for every step of the agreement
Our own web app is built on the same REST API you use. Create envelopes, send from templates, track progress with webhooks and download sealed PDFs.
Quickstart
Send your first envelope
Create an API key under Settings → API keys, then:
1. Create a draft and upload a document
curl https://sign.nuronixai.in/api/v1/envelopes \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "Offer letter", "jurisdiction": "IN",
"documentType": "employment_offer"}'
curl https://sign.nuronixai.in/api/v1/envelopes/$ENVELOPE/documents \
-H "Authorization: Bearer $API_KEY" \
-F file=@offer.pdf2. Add a signer and a signature field, then send
curl -X PUT https://sign.nuronixai.in/api/v1/envelopes/$ENVELOPE/recipients \
-H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
-d '[{"name": "Priya Sharma", "email": "priya@example.com",
"role": "SIGNER", "routingOrder": 1, "locale": "hi"}]'
curl -X PUT https://sign.nuronixai.in/api/v1/envelopes/$ENVELOPE/fields \
-H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
-d '[{"documentId": "$DOC", "recipientId": "$RECIPIENT",
"type": "SIGNATURE", "page": 0,
"x": 0.1, "y": 0.8, "width": 0.3, "height": 0.06}]'
curl -X POST https://sign.nuronixai.in/api/v1/envelopes/$ENVELOPE/send \
-H "Authorization: Bearer $API_KEY"Field positions are fractions (0–1) of the page, measured from the top-left corner. page is zero-based. Field types: SIGNATURE, INITIALS, DATE_SIGNED, NAME, EMAIL, TEXT, CHECKBOX, NUMBER, DROPDOWN, RADIO, FORMULA, ATTACHMENT, PAYMENT (with amount in minor units and currency).
Reference
Endpoints
All endpoints live under https://sign.nuronixai.in/api/v1 and accept and return JSON unless noted.
Envelopes
status, search, limit, cursor.title, message, jurisdiction, documentType, routing, reminderDays, expiresAt.file, up to 25 MB). Office formats are converted to PDF.id to keep an existing recipient and their fields.details.problems if blocked.reason.?version=original).Templates
name, roleNames.recipients (one per role), send.rows, each creating and sending one envelope. Returns per-row results.Embedded signing & integrations
<iframe> on a site your organisation allows.target_url, event.Compliance & verification
jurisdiction and documentType.Errors
HTTP/1.1 422 Unprocessable Entity
{
"error": {
"code": "policy_violation",
"message": "This document cannot be sent under the selected compliance profile.",
"details": { "problems": ["Excluded by the First Schedule of the IT Act 2000."] }
}
}Webhooks
Get notified when things happen
Add endpoints under Settings → Webhooks. Deliveries are retried with exponential backoff for up to 8 attempts.
Events
- envelope.sent
- The envelope was sent to its first signers.
- recipient.viewed
- A signer opened their signing link.
- recipient.signed
- A signer finished signing.
- recipient.declined
- A signer declined; the envelope is closed.
- envelope.completed
- Everyone signed and the sealed documents are ready.
- envelope.voided
- The sender voided the envelope.
- envelope.expired
- The envelope passed its expiry date.
Verify the signature
Each request carries X-DocSign-Signature: t=<unix>,v1=<hex>, an HMAC-SHA256 of "t.body" with your endpoint secret. Reject requests older than a few minutes.
// Node.js
import { createHmac, timingSafeEqual } from 'node:crypto';
export function verify(rawBody, header, secret, toleranceSec = 300) {
const { t, v1 } = Object.fromEntries(
header.split(',').map((kv) => kv.split('=')),
);
if (Math.abs(Date.now() / 1000 - Number(t)) > toleranceSec) return false;
const expected = createHmac('sha256', secret)
.update(`${t}.${rawBody}`).digest('hex');
return timingSafeEqual(Buffer.from(v1, 'hex'), Buffer.from(expected, 'hex'));
}# Python
import hmac, hashlib, time
def verify(raw_body: bytes, header: str, secret: str, tolerance=300) -> bool:
parts = dict(kv.split("=", 1) for kv in header.split(","))
if abs(time.time() - int(parts["t"])) > tolerance:
return False
expected = hmac.new(secret.encode(), f"{parts['t']}.".encode() + raw_body,
hashlib.sha256).hexdigest()
return hmac.compare_digest(parts["v1"], expected)Tools
SDKs, OpenAPI and test mode
Node.js and Python SDKs
Typed clients with no dependencies, including webhook signature verification. Other languages can be generated from the OpenAPI spec.
OpenAPI 3.1
A machine-readable description of the API at /api/v1/openapi.json, for Postman, code generators and API gateways.
Test mode
Keys starting dsk_test_ create watermarked agreements that are not billed and work on every plan, so you can build before you buy.
Ready to get started?
Building an integration?
Tell us about your product and volumes, and we will help you get set up with embedded signing.
- Free 14-day trial
- No credit card required
- Cancel anytime