Get the e-signature envelope for a sign-document run

GET

/spaces/:spaceId/runs/:runId/envelope

GET

/spaces/:spaceId/runs/:runId/envelope

$ curl https://api.cloudraker.com/spaces/spaceId/runs/runId/envelope \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "envelope": {
3     "id": "env_9f8b7c6d5a4e3f21",
4     "runId": "run_1234567890abcdef",
5     "docName": "Purchase_Agreement_2024.pdf",
6     "docSha256": "3a7bd3e2360a3d5f8b9c1e2d4f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a",
7     "docSize": 254312.5,
8     "status": "pending",
9     "signatureMode": "sequential",
10     "message": "Please review and sign the document at your earliest convenience.",
11     "error": null,
12     "outputFileId": null,
13     "createdAt": "2024-04-10T14:22:00Z",
14     "completedAt": null,
15     "expiresAt": "2024-05-10T14:22:00Z"
16   },
17   "signers": [
18     {
19       "id": "signer_001",
20       "name": "Alice Johnson",
21       "email": "[email protected]",
22       "position": 1,
23       "source": "run",
24       "status": "pending",
25       "emailVerifiedAt": "2024-04-10T14:25:00Z",
26       "signedAt": null,
27       "typedName": null,
28       "lastInvitedAt": "2024-04-10T14:22:00Z"
29     },
30     {
31       "id": "signer_002",
32       "name": "Bob Smith",
33       "email": "[email protected]",
34       "position": 2,
35       "source": "run",
36       "status": "pending",
37       "emailVerifiedAt": null,
38       "signedAt": null,
39       "typedName": null,
40       "lastInvitedAt": "2024-04-10T14:22:00Z"
41     }
42   ],
43   "events": [
44     {
45       "id": "evt_1001",
46       "type": "envelope_created",
47       "actor": "system",
48       "signerId": null,
49       "ip": null,
50       "occurredAt": "2024-04-10T14:22:00Z",
51       "data": {}
52     },
53     {
54       "id": "evt_1002",
55       "type": "signer_invited",
56       "actor": "system",
57       "signerId": "signer_001",
58       "ip": null,
59       "occurredAt": "2024-04-10T14:22:05Z",
60       "data": {}
61     },
62     {
63       "id": "evt_1003",
64       "type": "signer_email_verified",
65       "actor": "Alice Johnson",
66       "signerId": "signer_001",
67       "ip": "198.51.100.23",
68       "occurredAt": "2024-04-10T14:25:00Z",
69       "data": {}
70     }
71   ]
72 }

The sender’s view of a sign-document run: the envelope (status, document, mode), the signer roster with per-signer status (pending/signed, email-verified and signed timestamps), and the full audit trail. Requires space:read (denied → 404). Returns 404 for a run of any other action. Never contains signer signing links — those are bearer capabilities held only by the signers.

The sender's view of a `sign-document` run: the envelope (status, document, mode), the signer roster with per-signer status (`pending`/`signed`, email-verified and signed timestamps), and the full audit trail. Requires `space:read` (denied → 404). Returns 404 for a run of any other action. **Never contains signer signing links** — those are bearer capabilities held only by the signers.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

runIdstringRequired

Response

The envelope, its signer roster and its audit trail.

envelopeobject

signerslist of objects

Ordered by signing position. Never carries a signing link.

eventslist of objects