Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-13182655.4 KB
Contracts

Send a contract

Sends a draft contract to all participants for digital signing. The contract status transitions from draft to sent.

post/staffsign/contracts/{id}/send

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

UUID of the resource

Response

Contract sent successfully

idstring uuid
organizationIdstring uuid
jobPostingIdstring uuid nullable
contractTemplateIdstring uuid
contractTemplateNamestring nullable
contractTypestring

Localized contract type label

contractTypeKey'contract_type.employment'

Contract type identifier

statusstring

Localized status label

statusKey'contract_status.draft' | 'contract_status.sent' | 'contract_status.signed' | 'contract_status.expired' | 'contract_status.cancelled'

Contract status identifier

signatureLevelstring

Localized signature level label

signatureLevelKey'signature_level.aes' | 'signature_level.qes'

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

startDatestring date
endDatestring date nullable
compensationTypestring

Localized compensation type label

compensationTypeKey'compensation_type.hourly' | 'compensation_type.daily' | 'compensation_type.monthly' | 'compensation_type.one_time' | 'compensation_type.none'

Compensation billing frequency

compensationAmountstring

Compensation amount as a numeric string

compensationDescriptionstring nullable
locationstring nullable
employmentTypestring nullable

Localized employment type label

employmentTypeKey'employment_type.contractor' | 'employment_type.full_time' | 'employment_type.part_time' | 'employment_type.temporary' | 'employment_type.part_time_mini' | 'employment_type.student' | 'employment_type.training'

Type of employment

workDescriptionstring nullable
probationPeriodstring nullable
cancellationPeriodstring nullable
scheduleTypestring nullable

Localized schedule type label

scheduleTypeKey'schedule_type.daily' | 'schedule_type.weekly' | 'schedule_type.monthly' | 'schedule_type.flexible'

Working time schedule type

workingTimeDescriptionstring nullable
renderedContentstring

Full HTML content of the rendered contract

externalDocumentIdstring nullable

ID in the external signing provider (Paperless.io)

signedDocumentUrlstring uri nullable

URL to download the signed PDF document

auditTrailPdfUrlstring uri nullable

URL to download the audit trail PDF

sealedPdfUrlstring uri nullable

URL to download the sealed (long-term archived) PDF

expiresAtstring date-time nullable

Expiry timestamp of the signing request (Y-m-d H:i:s)

sentAtstring date-time nullable

Timestamp when the contract was sent for signing (Y-m-d H:i:s)

createdAtstring date-time

Creation timestamp (Y-m-d H:i:s)

autoDeliverSignedDocumentboolean

Whether the signed document is automatically delivered by email upon contract completion.

signedDocumentDeliveredAtstring date-time nullable

Timestamp when the signed document was delivered to participants. Null if not yet delivered.