Get InteractionSession for a document (human handoff)

Returns a Vortex InteractionSession for signing (ADR-004 / SEA-61). Agents show or open url, then poll this endpoint until status is not pending. Never forge the human signature. Requires documents:write to include url (signing link).

GET/documents/interaction

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Query parameters

idstringrequired

Document ID

Responses

200

idstringrequired

Stable session id (e.g. sign:{document_id})

kindstringrequired

Interaction kind (sign, approve, unlock, pay, …)

urlstring<uri> | null

Temporary human page; null if not available yet

statusstringrequired

Allowed:pendingcompletedcancelleddeclinedexpired

expires_atstring<date-time> | null

messagestringrequired

One-line instruction for the host/human

pollobjectrequired

Show properties

pathstringrequired

interval_msintegerrequired

resultobject

Show properties

document_idstring

document_statusstring

titlestring | null

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

404

Resource not found

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idquery*Document ID

Request

curl -X GET "https://api.seal.nyc/api/v1/documents/interaction?id=string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.seal.nyc/api/v1/documents/interaction?id=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.seal.nyc/api/v1/documents/interaction?id=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "string",
  "kind": "string",
  "url": "http://example.com",
  "status": "pending",
  "expires_at": "2019-08-24T14:15:22Z",
  "message": "string",
  "poll": {
    "path": "string",
    "interval_ms": 0
  },
  "result": {
    "document_id": "string",
    "document_status": "string",
    "title": "string"
  }
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "title": "Document not found"
}