v1

latestOpenAPI 3.0.3Proprietary2026-07-13182655.4 KB

Contracts

Preview a contract

Renders a contract preview without persisting any data. Use this to validate placeholder data and inspect the rendered contract content before creation.

post/staffsign/contracts/preview

Request body

contractTemplateIdstring uuid required

UUID of the contract template to use

contractType'contract_type.employment'

Contract type identifier

signatureLevel'signature_level.aes' | 'signature_level.qes' required

Digital signature level. aes = Advanced Electronic Signature. qes = Qualified Electronic Signature (requires identity verification).

additionalTermsobject nullable

Additional custom terms as key-value pairs (used as template placeholder data)

sendImmediatelyboolean

If true, the contract is sent for signing immediately after creation. If false, it remains as a draft.

autoDeliverSignedDocumentboolean

If true (default), the signed document is automatically delivered by email to all participants once all have signed. Set to false to trigger delivery manually via POST /staffsign/contracts/{id}/deliver.

Example request

{
  "terms": {
    "startDate": "2026-06-01",
    "compensationAmount": "2500"
  },
  "workingTime": {
    "dailySchedule": [
      {
        "startTime": "09:00",
        "endTime": "17:00"
      }
    ]
  }
}

Response

Contract preview

renderedContentstring

Rendered HTML content of the contract

canBeSentboolean

Whether all required placeholders are filled and the contract can be sent

missingPlaceholdersstring[]

List of placeholder names that are missing values

requiresIdentificationboolean

Whether the recipient requires identity verification (QES only)

requiresOrganizationIdentificationboolean

Whether the organization signer requires identity verification (QES only)