EaserixDocs
DevelopersAPI referenceSignDocuments

Document detail

One document with recipients (ordered) and fields.

View as Markdown
GET
/v1/documents/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/string"
{  "document": {    "id": "string",    "name": "string",    "url": "string",    "status": "string",    "created": "2019-08-24T14:15:22Z",    "modified": "2019-08-24T14:15:22Z",    "size": 0,    "pages": 0,    "templateId": "string",    "hasFile": true,    "hasFinalFile": true,    "files": [      {        "id": "string",        "name": "string",        "position": 0,        "size": 0,        "pages": 0,        "created": "2019-08-24T14:15:22Z",        "status": "ready",        "conversionError": "string"      }    ],    "signingMode": "string",    "message": "string",    "sentAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "voidedAt": "2019-08-24T14:15:22Z",    "voidReason": "string",    "declinedAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z",    "autoRemindDays": 0,    "lastRemindedAt": "2019-08-24T14:15:22Z",    "legalHold": true,    "scheduledPurgeAt": "2019-08-24T14:15:22Z",    "visibility": "string",    "ownerId": "string",    "requiresNotarization": true,    "notaryState": "string",    "recipients": [      {        "id": "string",        "name": "string",        "email": "string",        "role": "string",        "status": "string",        "orderIndex": 0,        "signedAt": "2019-08-24T14:15:22Z",        "viewedAt": "2019-08-24T14:15:22Z",        "declinedAt": "2019-08-24T14:15:22Z",        "declineReason": "string",        "hasAccessCode": true,        "verificationMethod": "none",        "signature": "string",        "isGroup": true,        "groupLabel": "string",        "signedByName": "string",        "signedByEmail": "string",        "members": [          {            "id": "string",            "name": "string",            "email": "string",            "viewedAt": "2019-08-24T14:15:22Z",            "declinedAt": "2019-08-24T14:15:22Z"          }        ],        "reassignedFromName": "string",        "reassignedFromEmail": "string",        "reassignReason": "string",        "reassignedAt": "2019-08-24T14:15:22Z"      }    ],    "fields": [      {        "id": "string",        "type": "signature",        "x": 0,        "y": 0,        "width": 0,        "height": 0,        "page": 0,        "required": true,        "label": "string",        "value": "string",        "recipientId": "string",        "fileId": "string",        "config": {}      }    ]  }}

Live file-conversion events (SSE) — deprecated alias of GET /v1/events

A Server-Sent Events stream telling the caller when a file they uploaded finishes converting to PDF (status "ready" or "failed"), replacing per-document polling. Scoped to the caller: only files on documents they own are reported, taken from the verified token. Frames carry ids and the new status only; re-read the document (GET /v1/documents/{id}) for the data. The stream emits `event: ready` once on connect (re-check any file you are waiting on — you may have missed an event while disconnected), then `event: conversion` with `{"documentId","fileId","status"}` as files settle, plus `: ping` heartbeat comments every 25s. The server ends the stream after 15 minutes; reconnect with a fresh token. Delivery is best-effort — keep a slow fallback poll of the document. Answers 503 when the server has no event listener; fall back to polling.

Update a document

Rename, share (visibility), or set notarization on a draft. Sending a status is rejected with 400 — lifecycle transitions go through /send and /void so they stay audited. requiresNotarization/notaryState are draft-only (409 otherwise); notaryState must be a two-letter US state.