Onboarding flow

Create a new worker

Changed on Sep 29, 2026

post/public/onboarding/v1/create-worker

Request

Base URL
https://api.maqqie.app (the document declares no server; this is the origin it was published from)
Auth
OAuth 2
Client credentials
Token URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token
TypeScript
https://skmtc.dev/maqqie/apis/maqqie-public-api/docs/public/onboarding/v1/create-worker/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

firstNamestring required

emailAddressstring email required

mobilePhoneNumberstring 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.

Example request

{
  "verificationDocumentDetails": {
    "nationality": "US",
    "identityDocument": {
      "documentNationality": "US"
    }
  },
  "address": {
    "houseNumber": 102,
    "houseNumberAddition": "B",
    "zipCode": "5652AA",
    "countryCode": "US"
  }
}

Response

Successfully created a worker

workerIdstring uuid

Changes

Sep 29, 2026f9510f3f4b22 Revision changes
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  the request's body type changed from no type to object
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to string for status
- info
  added the optional property to the response with the status
Sep 29, 20263352b56bb8fe Revision changes
- breaking
  the request's body type changed from object to no type
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response's body type changed from string to no type for status
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the optional property from the response with the status
- info
  response schema application/json enum value removed COUNTRY_ADDRESS_NOT_SUPPORTED
- info
  response schema application/json enum value removed EMAIL_ADDRESS_IN_USE
- info
  response schema application/json enum value removed INVALID_BSN
- info
  response schema application/json enum value removed INVALID_COUNTRY
- info
  response schema application/json enum value removed INVALID_DOCUMENT
- info
  response schema application/json enum value removed INVALID_EMAIL
- info
  response schema application/json enum value removed INVALID_HOUSE_NUMBER_ADDITION
- info
  response schema application/json enum value removed INVALID_IBAN
- info
  response schema application/json enum value removed INVALID_NATIONALITY
- info
  response schema application/json enum value removed INVALID_NON_EER_WORKER_AND_NATIONALITY_COMBINATION
- info
  response schema application/json enum value removed INVALID_PHONE_NUMBER
- info
  response schema application/json enum value removed INVALID_ZIP_CODE
- info
  response schema application/json enum value removed LEGAL_WORK_CATEGORY_NOT_SUPPORTED
- info
  response schema application/json enum value removed WORKER_ALREADY_HAS_AN_ACCOUNT

Operation history (8 revisions)