Sign in

v1

latestOpenAPI 3.0.32026-08-0645108163.2 KB
Onboarding flow

Create a new worker

post/public/onboarding/v1/create-worker

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