v1

latestOpenAPI 3.0.32026-08-06134961.9 KB

Onboarding flow

Create a new worker

post/public/onboarding/v1/create-worker

Request body

Example request

{
  "workerDetails": {
    "firstName": "firstName",
    "lastName": "lastName",
    "emailAddress": "emailAddress",
    "verificationDocumentDetails": {
      "idCheckDate": "2000-01-23",
      "placeOfBirth": "placeOfBirth",
      "identityDocument": {
        "bsnDocument": "bsnDocument",
        "documentExpiryDate": "2000-01-23",
        "documentNationality": "US",
        "documentType": null,
        "documentNumber": "documentNumber",
        "base64DocumentBack": "base64DocumentBack",
        "base64DocumentFront": "base64DocumentFront"
      },
      "identificationBy": "identificationBy",
      "gender": "Male",
      "nationality": "US",
      "initials": "initials",
      "dateOfBirth": "2000-01-23",
      "BSN": "BSN",
      "firstNameFormal": "firstNameFormal"
    },
    "address": {
      "zipCode": "zipCode",
      "country": "US",
      "city": "city",
      "street": "street",
      "houseNumber": "houseNumber",
      "houseNumberAddition": "houseNumberAddition"
    },
    "mobileNumber": "mobileNumber",
    "middleName": "middleName",
    "paymentDetails": {
      "IBAN": "IBAN"
    }
  }
}

Response

Successfully created a worker

workerIdstring uuid

Example response

{
  "workerId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}