Revoke a hosted acceptance link
POST/v1/click/acceptance-links/:id/revoke
Ends a link that is still live, now: the signer who opens it afterwards is told it is not usable. Use it when a link leaks, such as a forwarded email or a screenshot of its QR code. Answers the link, with status REVOKED and revokedAt.
- Idempotent. Revoking a link that is already revoked answers it again, unchanged, and
X-Idempotency-Keyis honoured. - Once answered, it stays answered. A link whose signer already accepted or declined answers 409
CLICK_ACCEPTANCE_LINK_COMPLETEDand keeps its outcome. - Your organization only. A link of another organization answers 404, the same as an ID that does not exist.
Request
Responses
- 200
- 404
- 409
- 503
The revoked link
Response Headers
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.
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>.
CLICK_ACCEPTANCE_LINK_NOT_FOUND: no acceptance link with this ID exists in your organization
Response Headers
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.
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>.
CLICK_ACCEPTANCE_LINK_COMPLETED: the signer already accepted or declined, so the link cannot be revoked
Response Headers
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.
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>.
Acceptance links are temporarily unavailable; nothing was revoked
Response Headers
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.
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>.