Inbound Requests

Get an inbound email request

One conversation in full: what the parser understood (intent), what it still needs (missingInformation), what was attached and whether each file was stored or refused, and the public ids of the document and envelope the request produced.

A request id belonging to another workspace answers exactly like an id that never existed, because a 403 would confirm it exists.

Costs both envelopes:read and account:read.

get/inbound-requests/{requestId}

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/inbound-requests/{requestId}
  • Auth: HTTP bearer

Response

The inbound request.

Example response

{
  "data": {
    "id": "Ib5qT8nW3vK7xR2mB9sYd",
    "state": "awaiting_approval",
    "error": null,
    "intent": {
      "signers": [
        {
          "name": "Dana Reyes",
          "email": "dana@acme.test",
          "order": 1
        }
      ],
      "signingOrder": "sequential",
      "subject": "Master Services Agreement",
      "message": null,
      "expiresInDays": 30,
      "attachmentIndex": 0,
      "notes": null
    },
    "missingInformation": [],
    "attachments": [
      {
        "filename": "msa.pdf",
        "contentType": "application/pdf",
        "size": 184213,
        "status": "stored",
        "refusedReason": null
      }
    ],
    "document": {
      "id": "Ku7bV2xQpL9mNr4sT1yZa"
    },
    "envelope": {
      "id": "Jd3kR8sVqW2nX5cY7bLmP"
    },
    "clarificationRoundTrips": 0,
    "createdAt": "2026-08-21T08:55:00.000Z",
    "updatedAt": "2026-08-21T08:56:12.000Z"
  }
}

Changes

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