Skip to main content
POST
Send document for signing

Authorizations

Authorization
string
header
required

OAuth 2.0 access token for a connected application. Limited to the scopes granted at consent.

Headers

authorization
string
required

Bearer token for API authentication

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

Body

application/json

Body

Send document for signing. If you lack permission to send directly, provide an approverId to submit for approval instead.

customMessage
string

Optional custom message to include in the signing invitation. Supports newline characters (\n) for line breaks. Available template variables (use {{variableName}} syntax): {{firstName}}, {{lastName}}, {{fullName}}, {{recipientFirstName}}, {{recipientLastName}}, {{recipientFullName}}, {{recipientEmail}}, {{recipientPhone}}, {{recipientCompanyName}}, {{recipientCompanyRole}}, {{recipientCompanyOrgNumber}}, {{recipientRole}}, {{senderFirstName}}, {{senderLastName}}, {{senderFullName}}, {{senderEmail}}, {{senderCompanyName}}, {{documentName}}, {{documentId}}, {{documentValue}}, {{documentCreatedDate}}, {{expirationDate}}, {{signUrl}}. Custom fields are available as {{custom.}} using the slugified field name (e.g. "Avtalsdatum (demo)" becomes {{custom.avtalsdatum-demo}}); secured fields are excluded.

approverId
string

User ID of the approver. Required if you do not have SEND_WITHOUT_APPROVAL permission. Use GET /api/v1/approvers to list eligible approvers.

Response

200

id
string
required

Unique document identifier

name
string
required

Document name/title

status
string
required

Document status: DRAFT, SENDING, PENDING, COMPLETED, EXPIRED, CANCELLED, or IMPORTED

createdAt
string<date-time>
required

Date and time when the document was created

updatedAt
string<date-time>
required

Date and time when the document was last updated

externalId
string | null

Your external reference ID for this document

expiresAt
string<date-time> | null

Date and time when the document expires

documentMeta
object | null

Document metadata including subject, message, signing order, etc.

completedAt
string<date-time> | null

Date and time when all signers completed signing