Envelopes

Get an editable draft snapshot

Returns the canonical draft state: editor version, routing, signers, complete field geometry and configuration, detection metadata, invitation settings, expiry, and computed readiness. A sent envelope answers invalid_status. A cross-workspace id answers 404.

get/envelopes/{envelopeId}/draft

Request

Base URL: https://inkseal.net/api/v1
URL: https://inkseal.net/api/v1/envelopes/{envelopeId}/draft
Auth: HTTP bearer

Response

The canonical editable snapshot.

Example response

{
  "data": {
    "signers": [
      {
        "role": "signer"
      }
    ],
    "fields": [
      {
        "type": "signature",
        "assignee": {
          "signerId": "client"
        },
        "pageIndex": 4,
        "xRatio": 0.12,
        "yRatio": 0.71,
        "widthRatio": 0.28,
        "heightRatio": 0.06,
        "required": true,
        "label": "Effective date",
        "detectionSource": "agent",
        "detectionConfidence": 0.94,
        "detectionReason": "Signature line beneath \"Client signature\" on page 5"
      }
    ],
    "cc": [
      {
        "id": "Qm5tW8xZ1aB4cD7eF0gHj",
        "name": "Wren Watcher",
        "email": "wren@acme.test"
      }
    ],
    "creditCost": 5,
    "creditLines": [
      {
        "kind": "signer",
        "quantity": 3,
        "unitCredits": 1,
        "credits": 3
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.