EaserixDocs
DevelopersAPI referenceSignSigning

Signing session

The recipient's view of the document: metadata, a presigned file URL (final artifact once completed), all fields (own fields flagged "mine"), redacted co-recipients, and whether it is their turn. The first open records a "viewed" audit event. Unauthenticated — the token is the credential. IP rate-limited (60/min). When the recipient has an access code, the session is LOCKED until the X-Access-Code header carries the right code: the response is {locked: true, codeIncorrect, document: {name, status}, recipient: {name}} — 200 with no code supplied, 401 with a wrong one. All /public/signing action endpoints then require the same header (401 with {locked: true} otherwise).

View as Markdown
GET
/public/signing/{token}

Path Parameters

token*string

Header Parameters

X-Access-Code?string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/public/signing/string"
{  "document": {    "id": "string",    "name": "string",    "status": "string",    "pages": 0,    "message": "string",    "signingMode": "string",    "sentAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "voidedAt": "2019-08-24T14:15:22Z",    "url": "string"  },  "recipient": {    "id": "string",    "name": "string",    "email": "string",    "role": "string",    "status": "string",    "signedAt": "2019-08-24T14:15:22Z",    "declinedAt": "2019-08-24T14:15:22Z"  },  "recipients": [    {      "id": "string",      "name": "string",      "role": "string",      "status": "string",      "orderIndex": 0,      "signedAt": "2019-08-24T14:15:22Z",      "mine": true    }  ],  "fields": [    {      "id": "string",      "type": "signature",      "x": 0,      "y": 0,      "width": 0,      "height": 0,      "page": 0,      "required": true,      "label": "string",      "value": "string",      "recipientId": "string",      "mine": true    }  ],  "myTurn": true}