Send a legal document for acceptance
Mints a public click-to-accept link (optionally passcode-protected and/or expiring) for a generated document and marks the document sent — content is immutable from this point. With `send_email: true` the link is also emailed to `recipient_email` via the member's connected mailbox or the provider fallback. Returns the one-time token and share path. Requires a first-party session.
Mints a public click-to-accept link (optionally passcode-protected and/or expiring) for a generated document and marks the document sent — content is immutable from this point. With send_email: true the link is also emailed to recipient_email via the member's connected mailbox or the provider fallback. Returns the one-time token and share path. Requires a first-party session.
Authorization
bearerAuth legal_documents:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: legal_documents:update
Path Parameters
Query Parameters
Preview this operation without committing it. When true, the request is authenticated, scoped, and validated, but no side effect runs — no write, no idempotency claim, no audit event, no outbound delivery. The response is HTTP 200 with an X-Dry-Run: true header and a body of { "dry_run": true }, plus an effect object describing what the real call would change when this operation can resolve one.
Header Parameters
Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Mint a public click-to-accept link for a generated legal document, optionally emailing it to the signer.
Response Body
application/json
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "dry_run": true, "effect": { "summary": "string", "count": 0, "targets": [ { "type": "string", "id": "string", "label": "string" } ], "amount": { "minor": -9007199254740991, "currency": "str" }, "details": { "property1": "string", "property2": "string" }, "irreversible": true }}{ "id": "string", "document_id": "string", "recipient_name": "string", "recipient_email": "string", "expires_at": "string", "revoked_at": "string", "has_passcode": true, "sent_at": "string", "first_viewed_at": "string", "last_viewed_at": "string", "view_count": -9007199254740991, "accepted_at": "string", "accepted_name": "string", "accepted_pdf_sha256": "string", "created_at": "string", "token": "string", "share_path": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}Get the frozen PDF POST
Returns a short-lived signed download URL for the document's frozen PDF (generated once; integrity-pinned by `pdf_sha256`). 409 until the document has been generated.
List a legal document's share links GET
Lists the click-to-accept links minted for a document, newest first, with view history and acceptance evidence (accepted name, time, and PDF hash).