Embed session ended or expired
The single-use embed URL was opened a second time, after its ten minutes, or for a document that has moved on.
| Problem type | /problems/embed-session-expired |
|---|---|
| HTTP status | 410 |
| Emitted by | Signing page |
| Title values | This signing session has ended or expired |
| Trigger |
Signing page:
an embed session (the single-use URL from `POST …/embed-session`, D88(c)) opened a second time, after its ten minutes, or for a document that moved on; the host page hears `error` with this slug and mints a fresh session
|
What happened
The signing page was opened from an embed session URL (the embed_url returned by POST /v1/documents/{doc_id}/recipients/{recipient_id}/embed-session) that no longer works. The response is HTTP 410, and the ceremony shows the recipient a plain “this signing session has ended” state instead of the document.
What it means
An embed session works once, within ten minutes of being minted. This slug means one of three things: the URL was already opened (a page reload, a second tab, a cached render), the ten minutes passed before the page loaded, or the document changed state between the mint and the open (it was signed, declined, withdrawn or expired). It is never a problem with the recipient’s own link: the session is a wrapper around it, and the ceremony behind it is untouched.
What to do next
For an integration: mint a fresh session on every page render and never store or reuse an embed_url. Your page receives a postMessage error event with slug: "embed-session-expired" from the frame; treat it as “render again”. If sessions expire on first load, check that the mint happens at render time rather than at build or cache time. For a recipient: go back to the page you came from and open it again.
Problem body
Every error the API returns is an RFC 9457 problem document with media type
application/problem+json. The type member is the
stable identifier to switch on; docs_url is this page.
{
"type": "/problems/embed-session-expired",
"title": "This signing session has ended or expired",
"status": 410,
"instance": "/v1/...",
"docs_url": "https://staging.signenvoy-docs-b4g.pages.dev/errors/embed-session-expired"
}