Sign in

v1

latestOpenAPI 3.0.32026-08-06134961.9 KB
Onboarding flow

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.

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

Request body

workerIdstring uuid

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

isPayrollTaxReductionboolean

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

payrollTaxReductionStartDatestring date

The date from which the payroll tax reduction should be applied. Required if isPayrollTaxReduction is true, ignored otherwise.

Example request

{
  "workerId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "payrollTaxReductionStartDate": "2000-01-23",
  "isPayrollTaxReduction": true
}

Response

Successfully created the agreement

signingUrlstring uri

A URL to the web UI (Stiply) that shows the agreement to the worker and allows them to e-sign it.

signingUrlExpirationTimestampstring date-time

The timestamp (UTC) at which the signing URL will expire. When browsing to the URL after this timestamp, the web UI (Stiply) will show an error page.

Example response

{
  "signingUrlExpirationTimestamp": "2000-01-23T04:56:07.000+00:00",
  "signingUrl": "https://openapi-generator.tech"
}