Skip to content
Embed API
/
API Reference
/
/
Start signing session

Start signing session

Request

Start an existing signing session. This moves the session status from pending to started. Starting a session locks its files (no files can be added or removed) and allows participants to access the signing flow via their links. Queued invitations are sent when the session starts. If the session is not in pending state, the endpoint returns 409 Conflict.

Security
APIKey
Path
session_idstring, (uuid)required

The UUID of the signing session.

Example:0196ae5b-2e9d-729f-aba5-fa4db6f881fd
Headers
Acceptstringrequired

Specify the response format.

Value:"application/json"
curl -i -X POST \
  https://api.embed.docue.com/sign/sessions/0196ae5b-2e9d-729f-aba5-fa4db6f881fd/start \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>'

Responses

Successfully started the signing session.

Bodyapplication/json
dataobject(SigningSessionData)required

Response body. Null when there is nothing to return.

metaobjectrequired
Response
{
  "data": {
    "id": "0196ae5b-2e9d-729f-aba5-fa4db6f881fd",
    "status": "started",
    "document_name": "Employment Agreement",
    "document_author": "HR Department",
    "external_id": "deal-42",
    "expires_at": "2026-03-31T10:30:00.000Z",
    "ui_domain": null,
    "email_from": null,
    "signature_position": "inline",
    "files": [ … ],
    "participants": [ … ]
  },
  "meta": {
    "status": { … }
  }
}