Get the e-signature envelope

GET

https://api.cloudraker.com/v1/runs/:id/envelope

GET

/v1/runs/:id/envelope

curl https://api.cloudraker.com/v1/runs/id/envelope \
     -H "Authorization: Bearer <token>"

{
  "envelope": {
    "id": "string",
    "docName": "string",
    "docSha256": "string",
    "docSize": 1.1,
    "status": "pending",
    "signatureMode": "string",
    "language": "en",
    "message": "string",
    "error": "string",
    "outputFileId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "completedAt": "2024-01-15T09:30:00Z",
    "expiresAt": "2024-01-15T09:30:00Z"
  },
  "signers": [
    {
      "id": "string",
      "name": "string",
      "email": "string",
      "position": 1,
      "source": "install",
      "status": "pending",
      "emailVerifiedAt": "2024-01-15T09:30:00Z",
      "signedAt": "2024-01-15T09:30:00Z",
      "typedName": "string",
      "lastInvitedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "events": [
    {
      "id": "string",
      "type": "string",
      "actor": "string",
      "signerId": "string",
      "ip": "string",
      "occurredAt": "2024-01-15T09:30:00Z"
    }
  ],
  "cc": [
    {
      "name": "string",
      "email": "string"
    }
  ]
}

The sender’s view of a sign run — envelope status, the signer roster with per-signer state, any cc recipients, and the event trail.

Every sign response points here through envelopeUrl. Use it to answer “who still has to sign?”: each signers[] entry carries its own status, emailVerifiedAt and signedAt.

This never contains signing links. Those are bearer capabilities held only by the signers themselves — to get one to a signer, use POST /v1/runs/{id}/signers/{signerId}/resend.

Learn more: E-signature guide

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Get the e-signature envelope

envelopeobject

signerslist of objects

Ordered by signing position. Never carries a signing link.

eventslist of objects

cclist of objectsOptional

Informed-only recipients, emailed the sealed PDF on completion.

Errors

429

Too Many Requests Error