Skip to main content

Mint a hosted acceptance link for a signer

POST 
/v1/click/deployments/:deploymentId/acceptance-links

Creates a per-signer link to a page Propper hosts, where the signer reads the agreement this deployment serves. Send the signer to url.

  • The secret is in url only. The part after # is a one-time secret: it is returned in this response only, never stored (Propper keeps its hash) and never logged. Treat the URL like a password until the signer opens it. This operation does not honour X-Idempotency-Key, so the secret is never kept for a replay: a retry mints a new link.
  • One live link per signer. Minting for the same deployment and signerRef revokes that signer’s earlier links that are still live.
  • Lifetime. One hour by default (expiresInSeconds), seven days at most.
  • Static agreements only. A deployment whose template is of another type answers 422 CLICK_HOSTED_TYPE_UNSUPPORTED.
  • Return URL. Checked when minting and stored with the link: https only, no credentials, at most 2048 bytes, on the deployment’s domain. The redirect back is not proof of an outcome: read the link’s status to confirm it.
  • signerRef is your own opaque identifier for the signer, such as your user id. Do not put an email address or a name in it.

Request​

Responses​

The link, with the signer’s URL. Sent with Cache-Control: no-store.

Response Headers
    X-Request-Id

    Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.

    traceparent

    W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.