Initialize Esign from template

Start an Esign session using a previously saved template. The template contributes file_id, signer elements, and signer defaults; the request contributes top-level Esign options plus runtime signer data in the same order as the template's signers array.

Runtime signer count must match the template signer count.
element_values overrides template element values at runtime by template field_id; position and type still come from the template.
Template signer defaults are merged with runtime signer input before the normal initialize-esign validation flow runs.
full_name should be supplied, reason must be supplied unless saved in the template, and at least one of email or mobile must be present.
This endpoint creates a real Esign flow, just like initialize-esign.

Authorization

bearerAuth

AuthorizationBearer <token>

Bearer token authentication — paste your access token below.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

template_id*string

Template ID returned by POST /api/v1/templates/save.

sign_type?SignType

aadhaar — OTP-based Aadhaar Esign. suresign — auto-signing by Surepass. pfx — PFX-certificate signing (requires pfx_id).

Value in

"aadhaar"
"suresign"
"pfx"

auth_mode?integer

Authentication mode for the signing session.

max_retry?integer

Maximum signing retries.

folder?string

Folder name to organize the session under.

allow_download?boolean

Allow downloading the signed document.

expiry_seconds?integer

Optional. Min 3600 (1 hour), max 2592000 (30 days).

Range3600 <= value <= 2592000

redirect_url?string

URL the signer is redirected to after completing the Esign.

backend?string

Signing backend to use.

stamp?

Optional e-stamping configuration. Use either the amount-based reservation flow (amount + state_code + article_id, required together) or pass pre-reserved stamp_instance_ids.

email_template_overrides?

Optional invite email branding overrides. When company_name is provided, the default Surepass logo and branding are hidden, allowing white-label emails.

signers*array<>

Count must match the template signer count, in the same order.

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/esign/initialize-from-template" \  -H "Content-Type: application/json" \  -d '{    "template_id": "template_xxx",    "sign_type": "suresign",    "auth_mode": 1,    "folder": "HR",    "allow_download": true,    "expiry_seconds": 7200,    "redirect_url": "https://example.com/esign/complete",    "email_template_overrides": {      "company_name": "Acme Corp"    },    "signers": [      {        "full_name": "Employer A",        "email": "employer@example.com",        "reason": "Employer sign",        "face_ref_file_id": "file_faceReferenceImage",        "notification": {          "invite": true,          "completion": true,          "whatsapp": true        },        "element_values": {          "field_xxx": "INV-1001",          "field_yyy": "now"        }      },      {        "full_name": "Employee B",        "email": "employee@example.com",        "reason": "Employee sign",        "name_match": true,        "element_values": {          "field_zzz": "Employee B"        }      }    ]  }'

{  "status_code": 0,  "message": "string",  "success": true,  "data": {    "actor_id": "string",    "actor_type": "user",    "allow_download": true,    "archived": true,    "auth_mode": [      1    ],    "backend": "nsdl",    "client_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "current_pdf_file_id": "string",    "email_template_overrides": {      "company_name": "string",      "legal_name": "string",      "support_email": "string"    },    "expiry_seconds": 0,    "file_id": "string",    "filename": "string",    "folder": "string",    "max_retry": 0,    "redirect_url": "http://example.com",    "sender": "string",    "sign_type": "aadhaar",    "signers": [      {        "signer_id": "string",        "eligible": true,        "invite_url": "http://example.com",        "token": "string",        "sign_type": "aadhaar",        "auth_mode": [          1        ],        "max_retry": 0,        "pfx_id": "string",        "full_name": "string",        "email": "user@example.com",        "country_code": "string",        "mobile": "string",        "verify_email": true,        "verify_mobile": true,        "reason": "string",        "accept_virtual_sign": true,        "status": "pending",        "elements": [          {            "field_id": "string",            "x": 0,            "y": 0,            "page": 0,            "type": "signature",            "alignment": "left",            "width": 0,            "height": 0,            "allow_wet_signature": true,            "font_size": 0,            "format": "string",            "value": "string"          }        ],        "aadhaar_cert_details": {          "name": "string",          "country": "string",          "state": "string",          "pin_code": "string",          "aadhaar": "string",          "year_of_birth": "string",          "gender": "string"        },        "verify_location": true,        "location_source": "device",        "enforce_geofence": true,        "latitude": 0,        "longitude": 0,        "radius": 0,        "name_match": {          "enforce": true,          "prefill_name": "string",          "signer_name": "string",          "score": 0,          "status": "pending"        },        "face_match": {          "enforce": true,          "ref_file_id": "string",          "live_file_id": "string",          "match_threshold": 0,          "max_attempts": 0,          "liveness_score": 0,          "match_score": 0        },        "notification": {          "invite": true,          "completion": true,          "whatsapp": true        }      }    ],    "status": "pending"  }}

Initialize Esign from template

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`