Topolo Docs Topolo Platform
Open workspace

Sign

Worked requests, captured responses and recovery guidance for all twenty-four declared Sign organizer actions.

Execution sequence

Discover identity, action and granted resource; validate input; review effects and authorize the unchanged request; execute and perform exact follow-up reads. Recipient consent, notification delivery and agreement evidence require their own verification.

Action reference

  • Export Sign organization data: Export every Sign record and signing-document metadata entry the organization owns — envelopes, recipients, templates and audit trails — as one portable payload for a data portability request.
  • Erase organization data: Permanently erase all Sign records and signing-document objects for the organization after an explicit ERASE confirmation. Completed envelopes and their audit certificates go with it, so executed agreements lose their evidence.
  • Get Sign workspace metrics: Read bounded counts of retained envelopes, open sent/viewed envelopes and completed envelopes in the granted workspace. This widget does not report token-expiry proximity or a time-period count.
  • Get Sign identity and statuses: Read verified user and organization plus the supported template and envelope status values. Bootstrap does not return a workspace, effective permission projection or signing-token lifetime.
  • Archive empty Sign workspace: Confirm that the granted Sign workspace has no retained records, ask Auth to archive it and remove its local mirror after Auth acceptance. Success is HTTP 204 without a body.
  • List Sign envelopes: List signature envelopes in this workspace with their status, recipients and document, plus a status summary, so you can find the envelopeId every other envelope action needs.
  • Create envelope: Create a signature envelope as a DRAFT. Nothing is sent and no signer is contacted; the envelope stays editable until envelopes.send. Seed it from an active template, or supply the document, fields and recipients directly.
  • Get Sign envelope: Get one signature envelope with its document, field schema, recipients and their individual signing status, and the delivery record for every party message ($.envelope.deliveries: signing requests and completed copies, with Notify dispatch outcome).
  • Update envelope: Edit a draft envelope, replacing its recipients with the complete supplied list. Omitted recipients are cleared; sent or closed envelopes cannot be edited.
  • Get Sign audit certificate: Get the immutable audit certificate issued when an envelope completed: signer identities, capacities, consent and evidence hashes, the source and completed document SHA-256 and a hash chain over the audit trail, plus the certificate's own hash.
  • Send envelope: Freeze the source and fields, revoke previous unsigned links, issue new signing links and queue recipient notifications in routing order. Notify acceptance is distinct from actual recipient delivery.
  • Reissue signing link: Revoke an open unsigned recipient link, issue its replacement and queue a new request. Verify retained delivery and Notify dispatch state separately from link creation.
  • Void envelope: Void a signature envelope so its outstanding signing links stop working and no further signature can be collected. A completed envelope cannot be voided; voiding is the only way to retract one already sent.
  • List templates: List signature templates in this workspace with their status, signer roles and default subject and message.
  • Create template: Create a signature template: a reusable document, field schema, signer roles and default subject and message that envelopes can be seeded from. Only an active template can seed an envelope.
  • Get template: Get one signature template with its document, field schema, signer roles and defaults.
  • Update template: Update a signature template: its name, description, status, document, field schema, signer roles or defaults. Envelopes already created from it keep the terms they were created with.
  • Get Sign document metadata: Get metadata for an uploaded signing document: title, content type, size, original and signing-PDF SHA-256, version and predecessor, page count and page sizes, and upload provenance. The bytes are downloaded separately.
  • Upload signing document: Upload a PDF, PNG or JPEG as an immutable signing source. The bytes are validated, stored under their SHA-256 and never overwritten; images get a derived signing PDF, and a replacement becomes a new version.
  • Finalize completed envelope: Issue any missing completion artifact for a completed envelope: the flattened PDF and the audit certificate bound to its source and completed hashes. Idempotent; existing artifacts are never regenerated.
  • Download original Sign document: Read hash-verified original document bytes from the exact granted workspace. The SDK returns contentType, contentLength and contentBase64.
  • Download signing PDF: Read the hash-verified signing PDF derived from the retained source in the exact granted workspace. The SDK returns contentType, contentLength and contentBase64.
  • Download completed Sign agreement: Read the immutable completed PDF only after the exact envelope is completed and its retained artifact is ready. The SDK returns contentType, contentLength and contentBase64.
  • Download Sign certificate PDF: Read the retained audit certificate PDF only after the exact envelope is completed and its certificate artifact is ready. The SDK returns contentType, contentLength and contentBase64.

Evidence

Captured from the exported Sign Worker with the existing SQLite-backed D1 harness applying all core, envelope and audit migrations to one local database, in-memory R2 and synthetic Auth/workspace/archive/Notify transports. These examples prove local validation, persistence and artifact production. They do not prove separate deployed D1 topology, real recipient consent, provider delivery or a live signed agreement. All identities, signing links and documents are synthetic; replace identifiers through authorized discovery and never execute a fixture against a live organization. Binary download examples use the released SDK binary projection; tests Base64-decode and compare original bytes, lengths and server SHA-256 headers.