API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · sign_envelopes

Sign Envelope Schema

Schema-ID
sign_envelope
Collection
sign_envelopes
Permissions
  • Lesensign_envelope_view
  • Anlegensign_envelope_create
  • Ändernsign_envelope_edit
  • Löschensign_envelope_delete

Felder

Sign Envelope Schema

sign_envelopes4 Permissions

Electronic signature envelope — a document sent to one or more signers

titlestringerforderlich

Display name of the envelope

1–255 Zeichen
messagestringoptional

Optional message shown to all signers

max 5000 Zeichennullable
documentIduuiderforderlich

DMS document ID of the PDF to be signed

templateIduuidoptional

Optional sign template used to pre-populate fields

nullable
signersobject[]optional
Default: []read-only
namestringerforderlich
1–255 Zeichen
emailemailerforderlich
max 255 Zeichen
signerIndexintegererforderlich
≥ 0
rolestringoptional

E.g. "Geschäftsführer"

max 100 Zeichennullable
messagestringoptional
max 2000 Zeichennullable
verificationMethodstringoptional
Werte
EMAIL_LINKSMS_OTPEMAIL_OTPIN_PERSON
Default: "EMAIL_LINK"
phoneNumberstringoptional

Required when verificationMethod = SMS_OTP

max 30 Zeichennullable
fieldsobject[]optional
Default: []
fieldIduuidoptional
typestringerforderlich
Werte
SIGNATUREINITIALSTEXTDATECHECKBOXSTAMP
signerIndexintegererforderlich
≥ 0
pageintegererforderlich
≥ 1
xnumbererforderlich
0 – 1
ynumbererforderlich
0 – 1
widthnumbererforderlich
0 – 1
heightnumbererforderlich
0 – 1
requiredbooleanoptional
Default: true
labelstringoptional
max 255 Zeichennullable
placeholderstringoptional
max 255 Zeichennullable
defaultValuestringoptional
max 1000 Zeichennullable
optionsstring[]optional

Dropdown options (for TEXT fields rendered as select)

nullable
characterLimitintegeroptional
≥ 1nullable
dateFormatstringoptional
max 50 Zeichennullable
groupstringoptional

Group name — one checkbox in a group must be checked

max 100 Zeichennullable
ccRecipientsobject[]optional

Receive a copy of the completed document

Default: []
namestringerforderlich
1–255 Zeichen
emailemailerforderlich
max 255 Zeichen
signingOrderstringoptional

SEQUENTIAL = in order; PARALLEL = all at once; MIXED = grouped

Werte
PARALLELSEQUENTIALMIXED
Default: "PARALLEL"
signingGroupsobject[]optional

For MIXED signing order: groups of signers that sign in parallel within the group, sequential between groups

nullable
groupIndexintegererforderlich
≥ 0
signerIndicesinteger[]erforderlich
min 1 Items
expiresAtdatetimeoptional

ISO 8601 expiry — envelope is voided after this date

nullable
reminderIntervalDaysintegeroptional

Send reminder emails every N days until signed

1 – 30nullable
linkedEntityTypestringoptional

Schema ID of linked entity (e.g. "contract", "avv")

max 100 Zeichennullable
linkedEntityIduuidoptional

ID of the linked entity

nullable
allowDeclinebooleanoptional

Whether signers are allowed to decline signing

Default: true
requireSignatureReasonbooleanoptional

Prompt signers to enter a reason/declaration with their signature

Default: false
bulkSendIduuidoptional

Groups envelopes from a bulk send operation

nullable
attachSignedPdfbooleanoptional

Attach the signed PDF to the completion email. Set by CreateEnvelopeDialog and read by the SEND_COMPLETION_NOTICE handler. Declared here because the schema is `additionalProperties: false` — it worked only because POST /sign/envelopes does not AJV-validate its body yet, so adding body validation would have silently dropped the flag (ADR 0348 §9).

Default: true

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/sign_envelopes — Liste, paginiert + filterbar
  • GET /api/v1/sign_envelopes/<id> — Einzelne Entity
  • POST /api/v1/sign_envelopes — Anlegen
  • PATCH /api/v1/sign_envelopes/<id> — Teil-Update
  • DELETE /api/v1/sign_envelopes/<id> — Soft-Delete
  • GET /api/v1/sign_envelopes/<id>/timeline — Audit + Aktivitäten

Suche