v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB
Framework Agreement

Create a framework agreement and signing link

Create a framework agreement and a signing link, for the given worker. Once the agreement is signed, the FrameworkAgreementSignedEvent webhook is executed.

This endpoint is idempotent for retries: if an unsigned, non-expired framework agreement already exists for the worker and the requested isPayrollTaxReduction matches the worker's stored setting, the existing agreement and its signing link are returned instead of creating a new one. If the requested isPayrollTaxReduction differs (the worker changes their setting), the pending agreement - including its Stiply signing request - is cancelled and a new agreement reflecting the new setting is generated. A new agreement is likewise created when there is no pending agreement (e.g. the previous one expired or was already signed); any obsolete unsigned agreement is then replaced.

post/public/framework-agreement/v1/create-framework-agreement

Request body

workerIdstring uuid required

The unique id of the worker, as returned from the /create-worker endpoint.

isPayrollTaxReductionboolean required

true if the worker wants us to apply payroll tax reduction (Dutch: loonheffingskorting), false otherwise

Response

Successfully created the agreement

frameworkAgreementIdstring uuid required
signingUrlstring uri required

A URL to sign the framework agreement.

signingUrlExpirationTimestampstring date-time required

The timestamp (UTC) at which the signing URL will expire.