Signing API

Server-orchestrated hash, PDF, and XML signing endpoints.

Platform Values

The platform field tells SecureSign which product flow to use for end-user signing:

Value	Product	Behavior
`mobile_browser`	Mobile App	Returns `deepLink` for `securesign://sign`
`desktop_software`	Desktop Software	Returns `deepLink` for `securesign://sign` (opens Desktop Software on desktop OS)
`desktop_agent`	Desktop Software	Legacy alias for `desktop_software`

POST /sign/hash

Initiate hash signing. For end-user token signing, returns a deep link or Desktop Software instruction.

curl -X POST https://api.securesign.toolsbots.com/v1/sign/hash \
  -H 'Authorization: Bearer ss_live_abc123xyz' \
  -H 'Content-Type: application/json' \
  -d '{"hashBase64":"qT6d3x8K...","hashAlgo":"SHA256","platform":"mobile_browser","callbackUrl":"https://portal.example.gov.in/callback"}'

const { deepLink, requestId } = await fetch('https://api.securesign.toolsbots.com/v1/sign/hash', {
  method: 'POST',
  headers: { Authorization: 'Bearer ss_live_abc123xyz', 'Content-Type': 'application/json' },
  body: JSON.stringify({ hashBase64, hashAlgo: 'SHA256', platform: 'mobile_browser', callbackUrl })
}).then(r => r.json());

$result = $client->post('/sign/hash', [
  'hashBase64' => $hash,
  'hashAlgo' => 'SHA256',
  'platform' => 'desktop_software',
  'callbackUrl' => 'https://portal.example.gov.in/callback'
]);

Response (mobile and desktop):

{"success":true,"requestId":"a1b2c3d4","deepLink":"securesign://sign?requestId=a1b2c3d4&...","expiresAt":"2026-06-22T10:45:00Z"}

POST /sign/pdf

Sign a PDF with optional visible appearance. Pass appearance when visible: true — see Signature Customization for all fields, templates, and examples.

Request:

{"pdfBase64":"JVBERi0x...","visible":true,"page":1,"position":{"x":72,"y":120,"width":240,"height":90},"appearance":{"templateId":"gov_portal","signerName":"Rajesh Kumar","designation":"Director","showDateTime":true,"showSerial":true,"logoBase64":"...","qrContent":"https://verify.example.gov.in/abc123"},"callbackUrl":"https://portal.example.gov.in/callback"}

Response:

{"success":true,"signedPdfBase64":"JVBERi0x...","signatureField":"Signature1"}

POST /sign/xml

Request:

{"xmlContent":"<Invoice>...</Invoice>","signatureType":"enveloped","callbackUrl":"https://portal.example.gov.in/callback"}

Response:

{"success":true,"signedXml":"<Invoice>...<ds:Signature>...</ds:Signature></Invoice>"}

POST /sign/batch

Sign multiple hashes in one user PIN session.

{"items":[{"requestId":"r1","hashBase64":"..."},{"requestId":"r2","hashBase64":"..."}],"callbackUrl":"https://portal.example.gov.in/callback"}