Surepass
Webhooks

Esign events

Suresign sends this request when an Esign session completes or fails. Verify Suresign-Signature against the raw request body before you parse the JSON.

Return any 2xx status to accept the delivery. Suresign can send the same delivery more than once. Use Suresign-Webhook-Id or client_id as the idempotency key.

Header Parameters

Suresign-Webhook-Id*string

Stable delivery ID. Use this value as an idempotency key.

Suresign-Signature*string

t is the Unix timestamp. v1 is a 64-character lowercase hexadecimal HMAC-SHA256 signature. Verify v1 against {timestamp}.{raw_request_body}.

User-Agent*string

Suresign webhook user agent.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

attempt*integer

Delivery attempt number. The first attempt is 1.

Range1 <= value
client_id*string

Stable delivery ID. The ID starts with webhook_.

esign_client_id*string

Related Esign session ID. The ID starts with esign_.

event_type*string

Event type that triggered the webhook delivery.

Value in

  • "esign_completed"
  • "esign_failed"
org_id*string

Organization that owns the Esign session.

data*

Esign session and its current state.

Response Body

Example Requests

POST/esign-event

Download stamp PDF GET

Get the vendor-provided download URL for a completed stamp PDF. PDF bytes are not streamed through the API — the response contains a short-lived signed URL. Pass the stamp **instance** ID (`stamps[].stamp_id` from order-status or list), not the order ID.

Signer events Webhook

Suresign sends this request when a signer completes signing or fails. Verify `Suresign-Signature` against the raw request body before you parse the JSON. Return any `2xx` status to accept the delivery. Suresign can send the same delivery more than once. Use `Suresign-Webhook-Id` or `client_id` as the idempotency key.