Sign in

v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB
Onboarding flow

Invite a worker to join Maqqie

Invite a worker to join Maqqie. If freelance properties are provided, the API will also create a freelance company for the worker. This is intended for company users to onboard workers.

post/public/onboarding/v1/invite-worker

Request body

emailAddressstring email required

The email address of the worker.

firstNamestring required

The first name of the worker.

gender'MALE' | 'FEMALE'

The gender of the worker.

initialsstring

The initials of the worker.

lastNamestring

The last name of the worker.

shouldNotifyWorkerOfAccountCreationboolean

Whether to send an invitation email and SMS to the worker.

mobileNumberstring required

The mobile number of the worker.

  • Must include a country code (e.g. +31 or 0031).
  • Must be a number that can exist in practice. Examples of numbers that cannot exist include phone numbers that are too long for their country or Dutch cell phone numbers starting with +3169.
  • The phone number type must be supported. This excludes phone numbers that are not suitable for the application's use cases, such as voicemail access numbers.
  • The phone number must be parsable. This means the format of the phone number is valid and can be be interpreted as a valid phone number.
citystring

The city where the worker resides.

dateOfBirthstring date

The date of birth of the worker.

houseNumberstring

The house number of the worker.

houseNumberAdditionstring

The house number addition of the worker.

ibanstring

The IBAN for worker payments.

nationality'DUTCH' | 'OTHER'

The nationality of the worker.

middleNamestring

The middle name of the worker.

paymentPeriod'FOUR_WEEKLY' | 'WEEKLY'

The payment period for the worker.

streetstring

The street where the worker resides.

wageTaxRebateboolean

Whether the worker wants to apply wage tax rebate.

zipstring required

The zip code of the worker.

freelanceChamberOfCommerceNumberstring

Chamber of Commerce number for freelance workers.

freelanceVatNumberstring

VAT number for freelance workers.

freelanceVatType'HIGH' | 'LOW' | 'SHIFTED' | 'NONE' | 'KOR'

VAT type for freelance workers.

Example request

{
  "emailAddress": "example@domain.com",
  "firstName": "John",
  "gender": "MALE",
  "initials": "J.D.",
  "lastName": "Doe",
  "shouldNotifyWorkerOfAccountCreation": true,
  "mobileNumber": "+31612345678",
  "city": "Amsterdam",
  "dateOfBirth": "1990-01-01",
  "houseNumber": "123",
  "houseNumberAddition": "A",
  "iban": "NL91ABNA0417164300",
  "nationality": "DUTCH",
  "middleName": "van",
  "paymentPeriod": "WEEKLY",
  "street": "Main Street",
  "wageTaxRebate": true,
  "zip": "1234AB",
  "freelanceChamberOfCommerceNumber": "62114395",
  "freelanceVatNumber": "NL001197903B02",
  "freelanceVatType": "HIGH"
}

Response

Successfully invited a worker

messagestring required

Success message.

workerIdstring uuid required

The external ID of the created worker.

Example response

{
  "message": "Worker invited successfully",
  "workerId": "0193df2c-d020-7860-b171-d9d915252704"
}