Get signer details
Retrieve signer status and metadata for a specific Esign session.
Authorization
bearerAuth Bearer token authentication — paste your access token below.
In: header
Query Parameters
Esign session client ID (esign_...).
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/esign/details?client_id=esign_PsLIyRDIHAqyFWhZqhDT"{ "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 POST
Start an Esign session for one or more signers on an uploaded document. - `page` inside elements is zero-indexed: `0` is the first page. - Multiple elements can be added per signer on different pages. - `email_template_overrides` customizes invite email branding; when `company_name` is provided, default Surepass branding is hidden for white-label emails. - `stamp` optionally reserves e-stamps into the flow — either by search (`amount` + `state_code` + `article_id`, optionally narrowed by party names) or by explicit `stamp_instance_ids`. Reserved stamp PDFs are prefixed to the uploaded PDF before signing starts.
Download signed PDF GET
Download the final signed PDF after the Esign session completes.