Envelopes

Get an envelope

Full envelope detail, including every signer with its routing position, its lifecycle timestamps, and the fields assigned to it with their fill state.

This is the poll target after a send: watch status until it leaves sending. completedPdfHash is the SHA-256 of the executed PDF and is null until the envelope completes.

An envelope in another workspace answers 404, the same as an unknown id.

get/envelopes/{envelopeId}

Request

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

Response

The envelope, its document, its signers with fields, and computed send readiness.

Example response

{
  "data": {
    "id": "Jd3kR8sVqW2nX5cY7bLmP",
    "status": "pending",
    "subject": "Master Services Agreement",
    "message": "Please review and sign by Friday.",
    "signingOrder": "sequential",
    "emailVerification": true,
    "document": {
      "id": "Ku7bV2xQpL9mNr4sT1yZa",
      "filename": "master-services-agreement.pdf"
    },
    "signers": [
      {
        "id": "Sg2wY6nT4qV8mR1xK9bDz",
        "name": "Dana Reyes",
        "email": "dana@acme.test",
        "role": "signer",
        "status": "sent",
        "order": 1,
        "viewedAt": "2026-08-21T10:02:11.000Z",
        "fields": [
          {
            "id": "Fd4tK9nW2vR7xB1sQ6mYe",
            "type": "signature",
            "required": true,
            "pageIndex": 4
          }
        ]
      }
    ],
    "sentAt": "2026-08-21T09:20:44.000Z",
    "expiresAt": "2026-09-20T09:19:58.000Z",
    "createdAt": "2026-08-21T09:19:58.000Z",
    "pendingApproval": {
      "id": "Ap7kR2sVqW9nX4cY1bLmP",
      "requestedBy": "intake-bot@ops.example.com"
    },
    "activeStep": 1,
    "steps": [
      {
        "step": 1,
        "status": "active",
        "signers": [
          "Jd3kR8sVqW2nX5cY7bLmP"
        ]
      }
    ],
    "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.