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"{ "data": { "user_id": "user_kmJytYATMawoorDzWrUQ", "client_id": "esign_PsLIyRDIHAqyFWhZqhDT", "created_at": "2025-05-13T12:06:01.344000", "sign_type": "aadhaar", "file_id": "file_ugSBmcbzETuPjUqQLyts", "allow_download": true, "expiry_seconds": 7200, "status": "completed", "signer_idx": 1, "signers": [ { "signer_id": "signer_vxgTyyOxYDhkhsIKQtda", "full_name": "Test1", "email": "test1@example.com", "status": "completed", "aadhaar_cert_details": { "name": "Test Signer", "country": "IN", "state": "Delhi", "pin_code": "110001", "aadhaar": "0000", "year_of_birth": "1990", "gender": "M" }, "name_match": { "enforce": true, "prefill_name": "Test1", "signer_name": "Test Signer", "score": 31.25, "status": "completed" }, "face_match": { "enforce": true, "ref_file_id": "file_faceReferenceImage", "live_file_id": "file_faceLiveImage", "match_threshold": 80, "max_attempts": 5, "liveness_score": 0.93, "match_score": 87 }, "positions": { "1": [ { "x": 100, "y": 200 } ] } } ] }, "status_code": 200, "message": "Success", "success": true}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.